gnu.x11.extension.DPMS Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of escher Show documentation
Escher is a collection of libraries for X Window System written purely in Java.
The newest version!
package gnu.x11.extension;

import gnu.x11.RequestOutputStream;
import gnu.x11.ResponseInputStream;


/**
 * Display Power Management Signaling Extension. The specification can be
 * found here (protocol).
 * 
 */
public class DPMS extends Extension {
  public static final String [] MINOR_OPCODE_STRINGS = {
    "GetVersion",               // 0
    "Capable",                  // 1
    "GetTimeouts",              // 2
    "SetTimeouts",              // 3
    "Enable",                   // 4
    "Disable",                  // 5
    "ForceLevel",               // 6
    "Info"                      // 7
  };


  public static final int CLIENT_MAJOR_VERSION = 1;
  public static final int CLIENT_MINOR_VERSION = 1;


  public int server_major_version, server_minor_version;


  // dpms opcode 0 - get version
  /**
   * @see DPMSQueryExtension
   */
  public DPMS (gnu.x11.Display display) throws NotFoundException {  
    super (display, "DPMS", MINOR_OPCODE_STRINGS); 

    // check version before any other operations
    RequestOutputStream o = display.out;
    synchronized (o) {
      o.begin_request (major_opcode, 0, 2);
      o.write_int16 (CLIENT_MAJOR_VERSION);
      o.write_int16 (CLIENT_MINOR_VERSION);

      ResponseInputStream i = display.in;
      synchronized (i) {
        i.read_reply (o);
        i.skip (8);
        server_major_version = i.read_int16 ();
        server_minor_version = i.read_int16 ();
        i.skip (20);
      }
    }
  }
  
  
  // dpms opcode 1 - capable
  /**
   * Determine whether or not the currently running server's devices are
   * capable of DPMS operations. There is a bug in all servers based on X
   * Consortium sample implementation up to R6.5 (including XFree86 4.0.1
   * or earlier): the sequence number of the reply is incorrect, causing a
   * "reply out of order" error.
   *
   * @see DPMSCapable
   */
  public boolean capable () {
    boolean capable;
    RequestOutputStream o = display.out;
    synchronized (o) {
      o.begin_request (major_opcode, 1, 1);
      ResponseInputStream i = display.in;
      synchronized (i) {
        i.skip (8);
        capable = i.read_bool ();
        i.skip (23);
      }
    }
    return capable;
  }

  
  /** Reply of {@link #timeouts()} */
  public static class TimeoutsInfo {

    public int standby;
    public int suspend;
    public int off;
    TimeoutsInfo (ResponseInputStream i) {
      standby = i.read_int16 ();
      suspend = i.read_int16 ();
      off = i.read_int16 ();
    }

    public String toString () {
      return "#TimeoutsReply"
        + "\n  standby: " + standby
        + "\n  suspend: " + suspend
        + "\n  off: " + off;
    }
  }
  
  
  // dpms opcode 2 - get timeouts
  /**
   * @see DPMSGetTimeouts
   */
  public TimeoutsInfo timeouts () {
    TimeoutsInfo info;
    RequestOutputStream o = display.out;
    synchronized (o) {
      o.begin_request (major_opcode, 2, 1);
      ResponseInputStream i = display.in;
      synchronized (i) {
        i.skip (8);
        info = new TimeoutsInfo(i);
        i.skip (18);
      }
    }
    return info;
  }


  // dpms opcode 3 - set timeouts
  /**
   * @see DPMSSetTimeouts
   */
  public void set_timeouts (int standby, int suspend, int off) {

    RequestOutputStream o = display.out;
    synchronized (o) {
      o.begin_request (major_opcode, 3, 3);
      o.write_int16 (standby);
      o.write_int16 (suspend);
      o.write_int16 (off);
      o.skip (2);
      o.send ();
    }
  }


  // dpms opcode 4 - enable
  /**
   * @see DPMSEnable
   */
  public void enable () {
    RequestOutputStream o = display.out;
    synchronized (o) {
      o.begin_request (major_opcode, 4, 1);
      o.send ();
    }
  }


  // dpms opcode 5 - disable
  /**
   * @see DPMSDisable
   */
  public void disable () {
    RequestOutputStream o = display.out;
    synchronized (o) {
      o.begin_request (major_opcode, 5, 1);
      o.send ();
    }
  }


  public static final int ON = 0;
  public static final int STAND_BY = 1;
  public static final int SUSPEND = 2;
  public static final int OFF = 3;


  public static final String [] LEVEL_STRINGS
    = {"on", "stand-by", "suspend", "off"};


  // dpms opcode 6 - force level
  /**
   * @param level valid:
   * {@link #ON},
   * {@link #STAND_BY},
   * {@link #SUSPEND},
   * {@link #OFF}
   *
   * @see DPMSForceLevel
   */
  public void force_level (int level) {
    RequestOutputStream o = display.out;
    synchronized (o) {
      o.begin_request (major_opcode, 6, 2);
      o.write_int16 (level);
      o.send ();
    }
  }


  /** Reply of {@link #info()} */
  public static class Info {

    /**
     * One of: {@link #ON}, {@link #STAND_BY}, {@link #SUSPEND}, {@link #OFF}.
     */
    public int power_level;
    boolean state;

    Info (ResponseInputStream i) {
      power_level = i.read_int16 ();
      state = i.read_bool ();
    } 

    public String toString () {
      return "#InfoReply"
        + "\n  state: " + state
        + "\n  level: " + LEVEL_STRINGS [power_level];
    }
  }


  // dpms opcode 7 - info
  /**
   * @see DPMSInfo
   */
  public Info info () {
    Info info;
    RequestOutputStream o = display.out;
    synchronized (o) {
      o.begin_request (major_opcode, 7, 1);
      ResponseInputStream i = display.in;
      synchronized (i) {
        i.read_reply (o);
        i.skip (8);
        info = new Info (i);
        i.skip (21);
      }
    }
    return info;
  }


  public String more_string () {
    return "\n  client-version: " 
      + CLIENT_MAJOR_VERSION + "." + CLIENT_MINOR_VERSION
      + "\n  server-version: "
      + server_major_version + "." + server_minor_version;
  }
}