libx11 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c49e109fc312f647725083299111726a4b292933
-  data.tar.gz: 7b2ac5739d3882da1e39c27fabb740c85fac86e8
+  metadata.gz: 854819b1ec364d4bbfcb3df95e7e7b33ef05cc8e
+  data.tar.gz: b375827e9805d96cd316cd4e51306e52fb3fd61d
 SHA512:
-  metadata.gz: 52182f830e5d16b2aae4502a3a20e606fef47728fcb8891cac63404f16876c4cda6599b48b714d54afa3022ac4ca715de839bdefd6e01f85762c2d260249d2d6
-  data.tar.gz: 9ae4c30c81d5c0f0aeea07033779a2a30d7899e843c7235ae06457dac0fa4e03e55d0cccb8e11261259dd7eb62291d8633877601b9484fab5be7cdeccf915495
+  metadata.gz: 9e08a4440c2dce4a1e00923181ebb039070d6883b0413d244cea19f88b926c32d80883f211875f2fe9337d527b6f6eca9e74cba44c0ecc1b9f982816bd704fa3
+  data.tar.gz: 9fe9991a6b16c20d734feadf30d7c81f97598d27da732b887bf0806273c0b909b57163486dde20860707860bbd41de7e2ae58b64d3e23ddbcf5ad6185f82e9f3

data/bin/generate-constants

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+
+target = ARGV[0]
+abort "'#{target}' does not exist" unless File.exist?(target)
+
+source = File.read(target).split("\n")[109..714].join("\n")
+source = source.gsub(%r[key/button], 'key button')
+parts  = source.split("\n\n")
+
+class ConstGenerator
+  def initialize(parts)
+    @parts = parts
+    @entities = []
+  end
+
+  def write
+    @parts.each do |part|
+      inject_part(part)
+    end
+    source = <<~PREFIX + @entities.join("\n\n") + "\n" + <<~SUFFIX
+      module LibX11
+        module X
+    PREFIX
+        end
+      end
+    SUFFIX
+    File.write('lib/libx11/x.rb', source)
+  end
+
+  private
+
+  def inject_part(part)
+    entity = convert_part(part)
+    @entities << entity.gsub(/^/, ' ' * 4)
+  end
+
+  def convert_part(part)
+    part = part.strip
+    case part
+    when %r[\A/\*+ ?\n.*\n \*+/\z]m
+      part.gsub(/^../, '#').sub(/\/\z/, '')
+    when %r[\A/\* .+ \*/\z]m
+      part.gsub(/^/, '# ')
+    when %r[\A#ifndef None\n.+\n#endif\z]m
+      _, line = part.match(%r[\A#ifndef None\n(.+)\n#endif\z]m).to_a
+      convert_line(line)
+    when %r[\A#define[ \t]]
+      part = part.gsub(%r{/\*([^/]+)\*/}m) { '/*' + $1.gsub("\n", '').gsub("\t", '') + '*/' }
+      part.split("\n").map { |line| convert_line(line) }.join("\n")
+    when %r[\A/\*[^/]+\*/\n#define]
+      _, comment, rest = part.match(%r[\A(/\*[^/]+\*/)\n(#define.+)\z]m).to_a
+      "#{comment.gsub(/^/, '# ')}\n#{rest.split("\n").map {|l| convert_line(l)}.join("\n")}"
+    else
+      abort "Unprocessible entity:\n'#{part}'"
+    end
+  end
+
+  def convert_line(line)
+    case line
+    when %r{\A#define [^ ]+ +[^ \t]+\t/\* [^/]+ \*/\z}
+      _, const, spaces, value, comment = line.match(%r{\A#define ([^ ]+)( +)([^ \t]+)\t/\* ([^/]+) \*/\z}).to_a
+      "#{const}#{spaces}= #{convert_value(value)} # #{comment}"
+    when %r{\A#define [^ ]+\t+[^ ]+ *\z}
+      _, const, spaces, value = line.match(%r{\A#define ([^ ]+)(\t+)([^ ]+) *\z}).to_a
+      "#{const}#{spaces.gsub("\t", '  ')}= #{convert_value(value)}"
+    when %r{\A#define[\t ][^ \t]+[\t ]+[^\t ]+[\t ]+/\*[^/]+\*/\z}
+      _, const, spaces, value, comment = line.match(%r{\A#define[\t ]([^ \t]+)([\t ]+)([^\t ]+)[\t ]+/\*([^/]+)\*/\z}).to_a
+      "#{const}#{spaces.gsub("\t", '    ')}= #{convert_value(value)} # #{comment}"
+    when %r{\A[\t ]+\z}
+      "\n"
+    when %r{\A/\* .+ \*/\z}
+      _, comment = line.match(%r{\A/\* (.+) \*/\z}).to_a
+      "# #{comment}"
+    when %r{\A/\*\*.+\*\*/\z}
+      _, comment = line.match(%r{\A/\*(\*.+\*)\*/\z}).to_a
+      "# #{comment}"
+    when %r{\A#define [^ ]+( +)[^ ]+\z}
+      _, const, spaces, value = line.match(%r{\A#define ([^ ]+)( +)([^ ]+)\z}).to_a
+      "#{const}#{spaces}= #{convert_value(value)}"
+    else
+      abort "Unprocessible line:\n#{line.inspect}"
+    end
+  end
+
+  def convert_value(value)
+    value.gsub('0L', '0').gsub('1L', '1').gsub('(int)', '')
+  end
+end
+
+ConstGenerator.new(parts).write

data/bin/generate-functions

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'strscan'
+require_relative 'typesym'
+
+target = ARGV[0]
+abort "'#{target}' does not exist" unless File.exist?(target)
+
+source = File.read(target)
+decls  = source.scan(/extern [^\n]+ [^ ]+ ?\([^\(\)]+\);/m)
+
+class FFIGenerator
+  BLOCKING_FUNCTIONS = %w[XSync XNextEvent]
+
+  def initialize(decls)
+    @decls = decls
+  end
+
+  def print_ffi
+    @decls.each do |decl|
+      puts ffi_by_decl(decl)
+    end
+  end
+
+  private
+
+  def preprocess(decl)
+    decl.gsub(/#if NeedWidePrototypes\n[^\n]+\n#else\n([^\n]+)\n#endif\n/m, '\1' << "\n")
+  end
+
+  def ffi_by_decl(decl)
+    if decl == 'extern Bool XSupportsLocale (void);'
+      return 'attach_function :XSupportsLocale, [], :bool'
+    end
+
+    definition, *params = preprocess(decl).split("\n")
+    params.delete_at(-1)
+    _, type, _, func = definition.match(/\Aextern ((unsigned )?[^ ]+ \**)([^ ]+) ?\(\z/).to_a
+
+    param_syms = params.map { |param| typesym(param_to_type(param))}
+    param_syms = [] if param_syms == [':void']
+
+    ffi = "attach_function :#{func}, [#{param_syms.join(', ')}], #{typesym(type.strip)}"
+    ffi.concat(', blocking: true') if BLOCKING_FUNCTIONS.include?(func)
+    ffi
+  rescue => e
+    puts
+    puts e.backtrace.join("\n")
+    abort "Failed to parse!:\n\n#{decl}\n\n#{e.message}"
+  end
+
+  def typesym(type)
+    Typesym.typesym(type)
+  end
+
+  def param_to_type(param)
+    s = StringScanner.new(param)
+    s.scan(/ +/)
+    s.scan_until(/(,|\/\*|\z)/).sub(/(,|\/\*)/, '').sub(/ ?_Xconst ?/, '').strip
+  end
+end
+
+FFIGenerator.new(decls).print_ffi

data/bin/generate-structs

@@ -0,0 +1,103 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'active_support'
+require 'active_support/core_ext'
+require_relative 'typesym'
+
+target = ARGV[0]
+abort "'#{target}' does not exist" unless File.exist?(target)
+
+source  = File.read(target)
+structs = source.scan(/typedef struct {[^{}]+} [^ ]+;/m)
+
+class FFIWriter
+  def initialize(structs)
+    @structs = structs
+  end
+
+  def write_ffis
+    @structs.each do |struct|
+      write_ffi(struct)
+    end
+  end
+
+  private
+
+  def write_ffi(struct)
+    str = drop_comments(struct)
+    str = preprocess(str)
+    _, params, name = str.match(%r[typedef struct {([^{}]+)} ([^ ;]+);]m).to_a
+
+    result = source_prefix(name) + source_body(params) + source_suffix
+    File.write("lib/libx11/xlib/#{name.underscore}.rb", result)
+  end
+
+  def source_prefix(name)
+    <<~PREFIX
+      module LibX11
+        module Xlib
+          class #{name} < FFI::Struct
+            layout(
+    PREFIX
+  end
+
+  def source_body(params)
+    params = params.gsub(%r[/\*[^/]+\*/]m, '')
+    lines = params.strip.split("\n").map(&:strip)
+    lines = expand_multiple_vars(lines).reject(&:empty?)
+    layouts = lines.map do |line|
+      line = line.gsub(/\t/, ' ')
+      if line =~ /\[\d+\]/
+        _, type, var, num = line.match(/\A([^ ]+) ([^\*\[]+)\[(\d+)\]/).to_a
+        [":#{var}", "[:#{type}, #{num}]"]
+      else
+        _, type, var = line.match(/\A(.+ \**)([^ *]+);/).to_a
+        [":#{var}", Typesym.typesym(type.strip)]
+      end
+    end
+    build_layout(layouts)
+  end
+
+  def source_suffix
+    <<~SUFFIX
+            )
+          end
+        end
+      end
+    SUFFIX
+  end
+
+  def expand_multiple_vars(lines)
+    [].tap do |result|
+      lines.each do |line|
+        if line =~ /, /
+          first, *rest = line.split(', ')
+          _, type, var = first.match(/\A(.+ \**)([^ *]+)\z/).to_a
+          [var, *rest].each do |name|
+            result << "#{type}#{name.sub(/;\z/, '')};"
+          end
+        else
+          result << line
+        end
+      end
+    end
+  end
+
+  def drop_comments(str)
+    str.gsub(%r[/\*[^/\*]+\*/], '')
+  end
+
+  def build_layout(layouts)
+    max = layouts.map(&:first).map(&:length).max
+    layouts.map do |var, type|
+      "#{' ' * 8}#{var},#{' ' * (max - var.length)} #{type},"
+    end.join("\n").concat("\n")
+  end
+
+  def preprocess(str)
+    str.gsub(/#if defined\(__cplusplus\) \|\| defined\(c_plusplus\)\n[^\n]+\n#else\n([^\n]+)\n#endif\n/m, '\1' << "\n")
+  end
+end
+
+FFIWriter.new(structs).write_ffis

data/bin/typesym.rb

@@ -0,0 +1,50 @@
+module Typesym
+  def self.typesym(type)
+    type = type.gsub(/ +\*\z/, '*').gsub(/ +\*\*\z/, '**')
+    case type
+    when 'Display*', 'XKeyEvent*', 'XEvent*', 'XMappingEvent*',
+      'XGenericEventCookie*', 'Depth*', 'XFontProp*'
+      type.sub(/ ?\*\z/, '').concat('.ptr')
+    when 'XFontStruct*', 'XTimeCoord*', 'XModifierKeymap*', 'Visual*', 'XImage*',
+      'XColor*', 'XGCValues*', 'XSetWindowAttributes*', 'XHostAddress*', 'Screen*',
+      'XExtCodes*', 'XExtData*', 'XPixmapFormatValues*', 'XWindowChanges*',
+      'XKeyboardControl*', 'XArc*', 'XChar2b*', 'XPoint*', 'XRectangle*', 'XSegment*',
+      'XTextItem*', 'XTextItem16*', 'XKeyboardState*', 'XWindowAttributes*',
+      'XCharStruct*', 'XOM', 'XOC', 'XFontSet', 'XFontSetExtents*',
+      'XmbTextItem*', 'XwcTextItem*', 'XIM', 'XIC', 'XKeyPressedEvent*', 'XOrientation*',
+      'XIMStyle*'
+      ':pointer'
+    when 'XID', 'Window', 'Time', 'KeyCode', 'int', 'Status', 'Drawable', 'void', 'Atom',
+      'KeySym', 'Colormap', 'Pixmap', 'Cursor', 'Font', 'GC', 'GContext', 'long',
+      'VisualID', 'XPointer', 'XIDProc', 'XConnectionWatchProc', 'XErrorHandler',
+      'XIOErrorHandler', 'char', 'short', 'XOrientation', 'XIMProc', 'XICProc'
+      ":#{type}"
+    when 'char*', 'const char*'
+      ':string'
+    when 'int*', 'Atom*', 'char**', 'Colormap*', 'XFontStruct**', 'Bool*', 'KeySym*',
+      'char **', 'XExtData**', 'Atom**', 'char***', 'Window**', 'Window*', 'struct _XExtData**',
+      'unsigned long*', 'unsigned char*', 'void*', 'unsigned int*', 'unsigned char**', 'Pixmap*',
+      'struct _XrmHashBucketRec*', 'XFontStruct***', 'wchar_t*', 'Status*', 'int**', 'wchar_t', 'char [32]',
+      'KeyCode*'
+      ':pointer'
+    when 'unsigned int'
+      ':uint'
+    when 'unsigned long'
+      ':ulong'
+    when 'unsigned short'
+      ':ushort'
+    when 'Bool'
+      ':bool'
+    when 'unsigned char', 'unsigned'
+      ':uchar'
+    when 'XEDataObject'
+      'XEDataObject.by_value'
+    when 'struct _XDisplay*'
+      'Display.ptr'
+    when 'XRectangle', 'XCharStruct'
+      type
+    else
+      raise "Unprocessible type name: '#{type}'"
+    end
+  end
+end

data/example/window_manager.rb

@@ -10,17 +10,15 @@ class XServer
 
   def self.bind_events(display, window, event_mask)
     wm_detected = false
-    LibX11::Xlib.XSetErrorHandler(
-      FFI::Function.new(:int, [LibX11::Xlib::Display.ptr, LibX11::Xlib::XErrorEvent.ptr]) do |display, error|
-        if error[:error_code] == LibX11::X::BadAccess
-          wm_detected = true
-        end
-        0
+    LibX11::Xlib.XSetErrorHandler -> (display, error) do
+      if error[:error_code] == LibX11::X::BadAccess
+        wm_detected = true
       end
-    )
+      0
+    end
 
     LibX11::Xlib.XSelectInput(display, window, event_mask)
-    LibX11::Xlib.XSync(display, 0)
+    LibX11::Xlib.XSync(display, false)
 
     if wm_detected
       abort 'Another window manager detected!'
@@ -40,12 +38,10 @@ XServer.with_connection do |display|
     LibX11::X::SubstructureNotifyMask,
   )
 
-  LibX11::Xlib.XSetErrorHandler(
-    FFI::Function.new(:int, [LibX11::Xlib::Display.ptr, LibX11::Xlib::XErrorEvent.ptr]) do |display, error|
-      $stderr.puts "Error detected: (error_code=#{error[:error_code]})"
-      0
-    end
-  )
+  LibX11::Xlib.XSetErrorHandler -> (display, error) do
+    $stderr.puts "Error detected: (error_code=#{error[:error_code]})"
+    0
+  end
 
   loop do
     event = LibX11::Xlib::XEvent.new

data/lib/libx11/version.rb

@@ -1,3 +1,3 @@
 module LibX11
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/libx11/x.rb

@@ -4,145 +4,586 @@ module LibX11
     # RESERVED RESOURCE AND CONSTANT DEFINITIONS
     #****************************************************************
 
-    None            = 0 # universal null resource or null atom
-    ParentRelative  = 1 # background pixmap in CreateWindow and ChangeWindowAttributes
-    CopyFromParent  = 0 # border pixmap in CreateWindow and ChangeWindowAttributes special
-                        # VisualID and special window class passed to CreateWindow
-    PointerWindow   = 0 # destination window in SendEvent
-    InputFocus      = 1 # destination window in SendEvent
-    PointerRoot     = 1 # focus window in SetInputFocus
-    AnyPropertyType = 0 # special Atom, passed to GetProperty
-    AnyKey          = 0 # special Key Code, passed to GrabKey
-    AnyButton       = 0 # special Button Code, passed to GrabButton
-    AllTemporary    = 0 # special Resource ID passed to KillClient
-    CurrentTime     = 0 # special Time
-    NoSymbol        = 0 # special KeySym
-
-    #***************************************************************
+    None                 = 0 # universal null resource or null atom
+
+    ParentRelative       = 1 # background pixmap in CreateWindow    and ChangeWindowAttributes
+
+    CopyFromParent       = 0 # border pixmap in CreateWindow       and ChangeWindowAttributes   special VisualID and special window       class passed to CreateWindow
+
+    PointerWindow        = 0 # destination window in SendEvent
+    InputFocus           = 1 # destination window in SendEvent
+
+    PointerRoot          = 1 # focus window in SetInputFocus
+
+    AnyPropertyType      = 0 # special Atom, passed to GetProperty
+
+    AnyKey		     = 0 # special Key Code, passed to GrabKey
+
+    AnyButton            = 0 # special Button Code, passed to GrabButton
+
+    AllTemporary         = 0 # special Resource ID passed to KillClient
+
+    CurrentTime          = 0 # special Time
+
+    NoSymbol	     = 0 # special KeySym
+
+    #****************************************************************
     # EVENT DEFINITIONS
-    #***************************************************************
-
-    # Input Event Masks. Used as event-mask window attribute and as arguments
-    # to Grab requests.  Not to be confused with event names.
-
-    NoEventMask              = 0
-    KeyPressMask             = (1<<0)
-    KeyReleaseMask           = (1<<1)
-    ButtonPressMask          = (1<<2)
-    ButtonReleaseMask        = (1<<3)
-    EnterWindowMask          = (1<<4)
-    LeaveWindowMask          = (1<<5)
-    PointerMotionMask        = (1<<6)
-    PointerMotionHintMask    = (1<<7)
-    Button1MotionMask        = (1<<8)
-    Button2MotionMask        = (1<<9)
-    Button3MotionMask        = (1<<10)
-    Button4MotionMask        = (1<<11)
-    Button5MotionMask        = (1<<12)
-    ButtonMotionMask         = (1<<13)
-    KeymapStateMask          = (1<<14)
-    ExposureMask             = (1<<15)
-    VisibilityChangeMask     = (1<<16)
-    StructureNotifyMask      = (1<<17)
-    ResizeRedirectMask       = (1<<18)
-    SubstructureNotifyMask   = (1<<19)
-    SubstructureRedirectMask = (1<<20)
-    FocusChangeMask          = (1<<21)
-    PropertyChangeMask       = (1<<22)
-    ColormapChangeMask       = (1<<23)
-    OwnerGrabButtonMask      = (1<<24)
-
-    # Event names.  Used in "type" field in XEvent structures.  Not to be
+    #****************************************************************
+
+    # /* Input Event Masks. Used as event-mask window attribute and as arguments
+    #    to Grab requests.  Not to be confused with event names.  */
+
+    NoEventMask		  = 0
+    KeyPressMask		  = (1<<0)
+    KeyReleaseMask		  = (1<<1)
+    ButtonPressMask		  = (1<<2)
+    ButtonReleaseMask	  = (1<<3)
+    EnterWindowMask		  = (1<<4)
+    LeaveWindowMask		  = (1<<5)
+    PointerMotionMask	  = (1<<6)
+    PointerMotionHintMask	  = (1<<7)
+    Button1MotionMask	  = (1<<8)
+    Button2MotionMask	  = (1<<9)
+    Button3MotionMask	  = (1<<10)
+    Button4MotionMask	  = (1<<11)
+    Button5MotionMask	  = (1<<12)
+    ButtonMotionMask	  = (1<<13)
+    KeymapStateMask		  = (1<<14)
+    ExposureMask		  = (1<<15)
+    VisibilityChangeMask	  = (1<<16)
+    StructureNotifyMask	  = (1<<17)
+    ResizeRedirectMask	  = (1<<18)
+    SubstructureNotifyMask	  = (1<<19)
+    SubstructureRedirectMask  = (1<<20)
+    FocusChangeMask		  = (1<<21)
+    PropertyChangeMask	  = (1<<22)
+    ColormapChangeMask	  = (1<<23)
+    OwnerGrabButtonMask	  = (1<<24)
+
+    # /* Event names.  Used in "type" field in XEvent structures.  Not to be
     # confused with event masks above.  They start from 2 because 0 and 1
-    # are reserved in the protocol for errors and replies.
-
-    KeyPress         = 2
-    KeyRelease       = 3
-    ButtonPress      = 4
-    ButtonRelease    = 5
-    MotionNotify     = 6
-    EnterNotify      = 7
-    LeaveNotify      = 8
-    FocusIn          = 9
-    FocusOut         = 10
-    KeymapNotify     = 11
-    Expose           = 12
-    GraphicsExpose   = 13
-    NoExpose         = 14
-    VisibilityNotify = 15
-    CreateNotify     = 16
-    DestroyNotify    = 17
-    UnmapNotify      = 18
-    MapNotify        = 19
-    MapRequest       = 20
-    ReparentNotify   = 21
-    ConfigureNotify  = 22
-    ConfigureRequest = 23
-    GravityNotify    = 24
-    ResizeRequest    = 25
-    CirculateNotify  = 26
-    CirculateRequest = 27
-    PropertyNotify   = 28
-    SelectionClear   = 29
-    SelectionRequest = 30
-    SelectionNotify  = 31
-    ColormapNotify   = 32
-    ClientMessage    = 33
-    MappingNotify    = 34
-    GenericEvent     = 35
-    LASTEvent        = 36
-
-    # Key masks. Used as modifiers to GrabButton and GrabKey, results of QueryPointer,
-    # state in various key-, mouse-, and button-related events.
-
-    ShiftMask   = (1<<0)
-    LockMask    = (1<<1)
-    ControlMask = (1<<2)
-    Mod1Mask    = (1<<3)
-    Mod2Mask    = (1<<4)
-    Mod3Mask    = (1<<5)
-    Mod4Mask    = (1<<6)
-    Mod5Mask    = (1<<7)
-
-    # button masks.  Used in same manner as Key masks above. Not to be confused
-    # with button names below.
-
-    Button1Mask = (1<<8)
-    Button2Mask = (1<<9)
-    Button3Mask = (1<<10)
-    Button4Mask = (1<<11)
-    Button5Mask = (1<<12)
-    AnyModifier = (1<<15)
-
-    # GrabPointer, GrabButton, GrabKeyboard, GrabKey Modes
-
-    GrabModeSync  = 0
-    GrabModeAsync = 1
+    # are reserved in the protocol for errors and replies. */
+
+    KeyPress	  = 2
+    KeyRelease	  = 3
+    ButtonPress	  = 4
+    ButtonRelease	  = 5
+    MotionNotify	  = 6
+    EnterNotify	  = 7
+    LeaveNotify	  = 8
+    FocusIn		  = 9
+    FocusOut	  = 10
+    KeymapNotify	  = 11
+    Expose		  = 12
+    GraphicsExpose	  = 13
+    NoExpose	  = 14
+    VisibilityNotify  = 15
+    CreateNotify	  = 16
+    DestroyNotify	  = 17
+    UnmapNotify	  = 18
+    MapNotify	  = 19
+    MapRequest	  = 20
+    ReparentNotify	  = 21
+    ConfigureNotify	  = 22
+    ConfigureRequest  = 23
+    GravityNotify	  = 24
+    ResizeRequest	  = 25
+    CirculateNotify	  = 26
+    CirculateRequest  = 27
+    PropertyNotify	  = 28
+    SelectionClear	  = 29
+    SelectionRequest  = 30
+    SelectionNotify	  = 31
+    ColormapNotify	  = 32
+    ClientMessage	  = 33
+    MappingNotify	  = 34
+    GenericEvent	  = 35
+    LASTEvent        = 36 #  must be bigger than any event #
+
+    # /* Key masks. Used as modifiers to GrabButton and GrabKey, results of QueryPointer,
+    #    state in various key-, mouse-, and button-related events. */
+
+    ShiftMask	  = (1<<0)
+    LockMask	  = (1<<1)
+    ControlMask	  = (1<<2)
+    Mod1Mask	  = (1<<3)
+    Mod2Mask	  = (1<<4)
+    Mod3Mask	  = (1<<5)
+    Mod4Mask	  = (1<<6)
+    Mod5Mask	  = (1<<7)
+
+    # /* modifier names.  Used to build a SetModifierMapping request or
+    #    to read a GetModifierMapping request.  These correspond to the
+    #    masks defined above. */
+    ShiftMapIndex	  = 0
+    LockMapIndex	  = 1
+    ControlMapIndex	  = 2
+    Mod1MapIndex	  = 3
+    Mod2MapIndex	  = 4
+    Mod3MapIndex	  = 5
+    Mod4MapIndex	  = 6
+    Mod5MapIndex	  = 7
+
+    # /* button masks.  Used in same manner as Key masks above. Not to be confused
+    #    with button names below. */
+
+    Button1Mask	  = (1<<8)
+    Button2Mask	  = (1<<9)
+    Button3Mask	  = (1<<10)
+    Button4Mask	  = (1<<11)
+    Button5Mask	  = (1<<12)
+
+    AnyModifier        = (1<<15) #  used in GrabButton, GrabKey
+
+    # /* button names. Used as arguments to GrabButton and as detail in ButtonPress
+    #    and ButtonRelease events.  Not to be confused with button masks above.
+    #    Note that 0 is already defined above as "AnyButton".  */
+
+    Button1		  = 1
+    Button2		  = 2
+    Button3		  = 3
+    Button4		  = 4
+    Button5		  = 5
+
+    # /* Notify modes */
+
+    NotifyNormal	  = 0
+    NotifyGrab	  = 1
+    NotifyUngrab	  = 2
+    NotifyWhileGrabbed  = 3
+
+    NotifyHint        = 1 #  for MotionNotify events
+
+
+    # Notify detail
+
+    NotifyAncestor	  = 0
+    NotifyVirtual	  = 1
+    NotifyInferior	  = 2
+    NotifyNonlinear	  = 3
+    NotifyNonlinearVirtual  = 4
+    NotifyPointer	  = 5
+    NotifyPointerRoot  = 6
+    NotifyDetailNone  = 7
+
+    # /* Visibility notify */
+
+    VisibilityUnobscured	  = 0
+    VisibilityPartiallyObscured  = 1
+    VisibilityFullyObscured	  = 2
+
+    # /* Circulation request */
+
+    PlaceOnTop	  = 0
+    PlaceOnBottom	  = 1
+
+    # /* protocol families */
+
+    FamilyInternet        = 0 #  IPv4
+    FamilyDECnet	  = 1
+    FamilyChaos	  = 2
+    FamilyInternet6        = 6 #  IPv6
+
+    # /* authentication families not tied to a specific protocol */
+    FamilyServerInterpreted = 5
+
+    # /* Property notification */
+
+    PropertyNewValue  = 0
+    PropertyDelete	  = 1
+
+    # /* Color Map notification */
+
+    ColormapUninstalled  = 0
+    ColormapInstalled  = 1
+
+    # /* GrabPointer, GrabButton, GrabKeyboard, GrabKey Modes */
+
+    GrabModeSync	  = 0
+    GrabModeAsync	  = 1
+
+    # /* GrabPointer, GrabKeyboard reply status */
+
+    GrabSuccess	  = 0
+    AlreadyGrabbed	  = 1
+    GrabInvalidTime	  = 2
+    GrabNotViewable	  = 3
+    GrabFrozen	  = 4
+
+    # /* AllowEvents modes */
+
+    AsyncPointer	  = 0
+    SyncPointer	  = 1
+    ReplayPointer	  = 2
+    AsyncKeyboard	  = 3
+    SyncKeyboard	  = 4
+    ReplayKeyboard	  = 5
+    AsyncBoth	  = 6
+    SyncBoth	  = 7
+
+    # /* Used in SetInputFocus, GetInputFocus */
+
+    RevertToNone	  = None
+    RevertToPointerRoot  = PointerRoot
+    RevertToParent	  = 2
 
     #****************************************************************
     # ERROR CODES
     #****************************************************************
 
-    Success           = 0
-    BadRequest        = 1
-    BadValue          = 2
-    BadWindow         = 3
-    BadPixmap         = 4
-    BadAtom           = 5
-    BadCursor         = 6
-    BadFont           = 7
-    BadMatch          = 8
-    BadDrawable       = 9
-    BadAccess         = 10
-    BadAlloc          = 11
-    BadColor          = 12
-    BadGC             = 13
-    BadIDChoice       = 14
-    BadName           = 15
-    BadLength         = 16
-    BadImplementation = 17
-
-    FirstExtensionError = 128
+    Success		   = 0 # everything's okay
+    BadRequest	   = 1 # bad request code
+    BadValue	   = 2 # int parameter out of range
+    BadWindow	   = 3 # parameter not a Window
+    BadPixmap	   = 4 # parameter not a Pixmap
+    BadAtom		   = 5 # parameter not an Atom
+    BadCursor	   = 6 # parameter not a Cursor
+    BadFont		   = 7 # parameter not a Font
+    BadMatch	   = 8 # parameter mismatch
+    BadDrawable	   = 9 # parameter not a Pixmap or Window
+    BadAccess      = 10 #  depending on context: - key button already grabbed - attempt to free an illegal    cmap entry - attempt to store into a read-only    color map entry. - attempt to modify the access control   list from other than the local host.
+    BadAlloc	  = 11 # insufficient resources
+    BadColor	  = 12 # no such colormap
+    BadGC		  = 13 # parameter not a GC
+    BadIDChoice	  = 14 # choice not in range or already used
+    BadName		  = 15 # font or color name doesn't exist
+    BadLength	  = 16 # Request length incorrect
+    BadImplementation = 17 # server is defective
+
+    FirstExtensionError  = 128
     LastExtensionError  = 255
+
+    #****************************************************************
+    # WINDOW DEFINITIONS
+    #****************************************************************
+
+    # /* Window classes used by CreateWindow */
+    # /* Note that CopyFromParent is already defined as 0 above */
+
+    InputOutput	  = 1
+    InputOnly	  = 2
+
+    # /* Window attributes for CreateWindow and ChangeWindowAttributes */
+
+    CWBackPixmap	  = (1<<0)
+    CWBackPixel	  = (1<<1)
+    CWBorderPixmap	  = (1<<2)
+    CWBorderPixel           = (1<<3)
+    CWBitGravity	  = (1<<4)
+    CWWinGravity	  = (1<<5)
+    CWBackingStore          = (1<<6)
+    CWBackingPlanes	        = (1<<7)
+    CWBackingPixel	        = (1<<8)
+    CWOverrideRedirect  = (1<<9)
+    CWSaveUnder	  = (1<<10)
+    CWEventMask	  = (1<<11)
+    CWDontPropagate	        = (1<<12)
+    CWColormap	  = (1<<13)
+    CWCursor	        = (1<<14)
+
+    # /* ConfigureWindow structure */
+
+    CWX		  = (1<<0)
+    CWY		  = (1<<1)
+    CWWidth		  = (1<<2)
+    CWHeight	  = (1<<3)
+    CWBorderWidth	  = (1<<4)
+    CWSibling	  = (1<<5)
+    CWStackMode	  = (1<<6)
+
+    # /* Bit Gravity */
+
+    ForgetGravity	  = 0
+    NorthWestGravity  = 1
+    NorthGravity	  = 2
+    NorthEastGravity  = 3
+    WestGravity	  = 4
+    CenterGravity	  = 5
+    EastGravity	  = 6
+    SouthWestGravity  = 7
+    SouthGravity	  = 8
+    SouthEastGravity  = 9
+    StaticGravity	  = 10
+
+    # /* Window gravity + bit gravity above */
+
+    UnmapGravity	  = 0
+
+    # /* Used in CreateWindow for backing-store hint */
+
+    NotUseful               = 0
+    WhenMapped              = 1
+    Always                  = 2
+
+    # /* Used in GetWindowAttributes reply */
+
+    IsUnmapped	  = 0
+    IsUnviewable	  = 1
+    IsViewable	  = 2
+
+    # /* Used in ChangeSaveSet */
+
+    SetModeInsert           = 0
+    SetModeDelete           = 1
+
+    # /* Used in ChangeCloseDownMode */
+
+    DestroyAll              = 0
+    RetainPermanent         = 1
+    RetainTemporary         = 2
+
+    # /* Window stacking method (in configureWindow) */
+
+    Above                   = 0
+    Below                   = 1
+    TopIf                   = 2
+    BottomIf                = 3
+    Opposite                = 4
+
+    # /* Circulation direction */
+
+    RaiseLowest             = 0
+    LowerHighest            = 1
+
+    # /* Property modes */
+
+    PropModeReplace         = 0
+    PropModePrepend         = 1
+    PropModeAppend          = 2
+
+    #****************************************************************
+    # GRAPHICS DEFINITIONS
+    #****************************************************************
+
+    # /* graphics functions, as in GC.alu */
+
+    GXclear            = 0x0 #  0
+    GXand            = 0x1 #  src AND dst
+    GXandReverse        = 0x2 #  src AND NOT dst
+    GXcopy            = 0x3 #  src
+    GXandInverted        = 0x4 #  NOT src AND dst
+    GXnoop            = 0x5 #  dst
+    GXxor            = 0x6 #  src XOR dst
+    GXor            = 0x7 #  src OR dst
+    GXnor            = 0x8 #  NOT src AND NOT dst
+    GXequiv            = 0x9 #  NOT src XOR dst
+    GXinvert        = 0xa #  NOT dst
+    GXorReverse        = 0xb #  src OR NOT dst
+    GXcopyInverted        = 0xc #  NOT src
+    GXorInverted        = 0xd #  NOT src OR dst
+    GXnand            = 0xe #  NOT src OR NOT dst
+    GXset            = 0xf #  1
+
+    # /* LineStyle */
+
+    LineSolid	  = 0
+    LineOnOffDash	  = 1
+    LineDoubleDash	  = 2
+
+    # /* capStyle */
+
+    CapNotLast	  = 0
+    CapButt		  = 1
+    CapRound	  = 2
+    CapProjecting	  = 3
+
+    # /* joinStyle */
+
+    JoinMiter	  = 0
+    JoinRound	  = 1
+    JoinBevel	  = 2
+
+    # /* fillStyle */
+
+    FillSolid	  = 0
+    FillTiled	  = 1
+    FillStippled	  = 2
+    FillOpaqueStippled  = 3
+
+    # /* fillRule */
+
+    EvenOddRule	  = 0
+    WindingRule	  = 1
+
+    # /* subwindow mode */
+
+    ClipByChildren	  = 0
+    IncludeInferiors  = 1
+
+    # /* SetClipRectangles ordering */
+
+    Unsorted	  = 0
+    YSorted		  = 1
+    YXSorted	  = 2
+    YXBanded	  = 3
+
+    # /* CoordinateMode for drawing routines */
+
+    CoordModeOrigin        = 0 #  relative to the origin
+    CoordModePrevious       = 1 # relative to previous point
+
+    # /* Polygon shapes */
+
+    Complex            = 0 #  paths may intersect
+    Nonconvex        = 1 #  no paths intersect, but not convex
+    Convex            = 2 #  wholly convex
+
+    # /* Arc modes for PolyFillArc */
+
+    ArcChord        = 0 #  join endpoints of arc
+    ArcPieSlice        = 1 #  join endpoints to center of arc
+
+    # /* GC components: masks used in CreateGC, CopyGC, ChangeGC, OR'ed into
+    #    GC.stateChanges */
+
+    GCFunction              = (1<<0)
+    GCPlaneMask             = (1<<1)
+    GCForeground            = (1<<2)
+    GCBackground            = (1<<3)
+    GCLineWidth             = (1<<4)
+    GCLineStyle             = (1<<5)
+    GCCapStyle              = (1<<6)
+    GCJoinStyle	  = (1<<7)
+    GCFillStyle	  = (1<<8)
+    GCFillRule	  = (1<<9)
+    GCTile		  = (1<<10)
+    GCStipple	  = (1<<11)
+    GCTileStipXOrigin  = (1<<12)
+    GCTileStipYOrigin  = (1<<13)
+    GCFont = 			(1<<14)
+    GCSubwindowMode	  = (1<<15)
+    GCGraphicsExposures     = (1<<16)
+    GCClipXOrigin	  = (1<<17)
+    GCClipYOrigin	  = (1<<18)
+    GCClipMask	  = (1<<19)
+    GCDashOffset	  = (1<<20)
+    GCDashList	  = (1<<21)
+    GCArcMode	  = (1<<22)
+
+    GCLastBit	  = 22
+    # **************************************************************** * FONTS  ****************************************************************
+
+    # /* used in QueryFont -- draw direction */
+
+    FontLeftToRight	  = 0
+    FontRightToLeft	  = 1
+
+    FontChange	  = 255
+
+    #****************************************************************
+    #  IMAGING
+    #****************************************************************
+
+    # /* ImageFormat -- PutImage, GetImage */
+
+    XYBitmap        = 0 #  depth 1, XYFormat
+    XYPixmap        = 1 #  depth == drawable depth
+    ZPixmap            = 2 #  depth == drawable depth
+
+    #****************************************************************
+    #  COLOR MAP STUFF
+    #****************************************************************
+
+    # /* For CreateColormap */
+
+    AllocNone        = 0 #  create map with no entries
+    AllocAll        = 1 #  allocate entire map writeable
+
+    # /* Flags used in StoreNamedColor, StoreColors */
+
+    DoRed		  = (1<<0)
+    DoGreen		  = (1<<1)
+    DoBlue		  = (1<<2)
+
+    #****************************************************************
+    # CURSOR STUFF
+    #****************************************************************
+
+    # /* QueryBestSize Class */
+
+    CursorShape        = 0 #  largest size that can be displayed
+    TileShape        = 1 #  size tiled fastest
+    StippleShape        = 2 #  size stippled fastest
+
+    #****************************************************************
+    # KEYBOARD/POINTER STUFF
+    #****************************************************************
+
+    AutoRepeatModeOff  = 0
+    AutoRepeatModeOn  = 1
+    AutoRepeatModeDefault  = 2
+
+    LedModeOff	  = 0
+    LedModeOn	  = 1
+
+    # /* masks for ChangeKeyboardControl */
+
+    KBKeyClickPercent  = (1<<0)
+    KBBellPercent	  = (1<<1)
+    KBBellPitch	  = (1<<2)
+    KBBellDuration	  = (1<<3)
+    KBLed		  = (1<<4)
+    KBLedMode	  = (1<<5)
+    KBKey		  = (1<<6)
+    KBAutoRepeatMode  = (1<<7)
+
+    MappingSuccess     = 	0
+    MappingBusy        = 	1
+    MappingFailed	  = 2
+
+    MappingModifier	  = 0
+    MappingKeyboard	  = 1
+    MappingPointer	  = 2
+
+    #****************************************************************
+    # SCREEN SAVER STUFF
+    #****************************************************************
+
+    DontPreferBlanking  = 0
+    PreferBlanking	  = 1
+    DefaultBlanking	  = 2
+
+    DisableScreenSaver  = 0
+    DisableScreenInterval  = 0
+
+    DontAllowExposures  = 0
+    AllowExposures	  = 1
+    DefaultExposures  = 2
+
+    # /* for ForceScreenSaver */
+
+    ScreenSaverReset = 0
+    ScreenSaverActive = 1
+
+    #****************************************************************
+    # HOSTS AND CONNECTIONS
+    #****************************************************************
+
+    # /* for ChangeHosts */
+
+    HostInsert	  = 0
+    HostDelete	  = 1
+
+    # /* for ChangeAccessControl */
+
+    EnableAccess	  = 1
+    DisableAccess	  = 0
+
+    # /* Display classes  used in opening the connection
+    #  * Note that the statically allocated ones are even numbered and the
+    #  * dynamically changeable ones are odd numbered */
+
+    StaticGray	  = 0
+    GrayScale	  = 1
+    StaticColor	  = 2
+    PseudoColor	  = 3
+    TrueColor	  = 4
+    DirectColor	  = 5
+
+    # /* Byte order  used in imageByteOrder and bitmapBitOrder */
+
+    LSBFirst	  = 0
+    MSBFirst	  = 1
   end
 end