pure-x11 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 927c52f35913e7d8bc466563bb5d238919c4a43d6a9f9fb1be8a6df4735cc5fb
-  data.tar.gz: 3b92ed556881c32486ed189c9de27fdd373988379118fefdbd6f40ff6268c0e7
+  metadata.gz: 37b5a813f478de65ecb12e89bafd332ef219baabac729a1baf29cf016d055347
+  data.tar.gz: 357ef8cd392bad30e9c2d8a7b6771c5c4fd1dd68f3e77da1544cf93f22df14f0
 SHA512:
-  metadata.gz: 580ab719f597acaecfa467389f26526dc50c1d25cacb14dbda9d63f61e3cb63f3665fd010408fc093501893a229a4b6a6f314734f6cf35786c58d965d0ec51cd
-  data.tar.gz: 211b56d642b773c29769e9620c746a657596b6314e1d5a89487ace79bf29c6f01f4675ec2456a8668b8723912b2c81f2c95309dcdaf9eac459682150b884f726
+  metadata.gz: 81d50a93f9df23fe424f4dd62fe10fa09f840ab16eccb5de4d83b0d2f681b3cdb8fc9416e2b818f230399276974cac7455f38bfa1fe66c55968f70fc5c1661bb
+  data.tar.gz: 00bc7b7851c843a92988c23feacba461e6b9e1c2ef1f27b025c363f452f759492a30d4c1ff5d8117ba6bb4940eaebb19234c5fef9012d6cf8339a2ee143bf875

data/example/client_message.rb

@@ -0,0 +1,13 @@
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'X11'
+
+display = X11::Display.new
+
+display.client_message(
+  mask: X11::Form::SubstructureNotifyMask | X11::Form::SubstructureRedirectMask,
+  type: :_NET_CURRENT_DESKTOP,
+  data: ARGV.shift.to_i
+)
+

data/lib/X11/auth.rb

@@ -11,14 +11,14 @@ module X11
     AUTHENTICATE = 2
 
     ADDRESS_TYPES = {
-      256 => :Local,
+      0     => :Internet,
+      1     => :DECnet,
+      2     => :Chaos,
+      252   => :LocalHost,
+      253   => :Krb5Principal,
+      254   => :Netname,
+      256   => :Local,
       65535 => :Wild,
-      254 => :Netname,
-      253 => :Krb5Principal,
-      252 => :LocalHost,
-      0 => :Internet,
-      1 => :DECnet,
-      2 => :Chaos
     }
 
     AuthInfo = Struct.new :family, :address, :display, :auth_name, :auth_data
@@ -52,18 +52,15 @@ module X11
 
     # returns one entry from Xauthority file
     def read
-      auth_info = [] << ADDRESS_TYPES[ @file.read(2).unpack('n').first ]
+      auth_info = [] << ADDRESS_TYPES[ @file.read(2).unpack1('n') ]
 
       4.times do
-        length = @file.read(2).unpack('n').first
+        length = @file.read(2).unpack1('n')
         auth_info << @file.read(length)
       end
       AuthInfo[*auth_info]
     end
 
-    def reset
-      @file.seek(0, IO::SEEK_SET)
-    end
-
+    def reset = @file.seek(0, IO::SEEK_SET)
   end
 end

data/lib/X11/display.rb

@@ -17,6 +17,8 @@ module X11
       host, display_id, screen_id = $1, $2, $3
       family = nil
 
+      @debug = ENV["PUREX_DEBUG"].to_s.strip == "true"
+      
       if host.empty?
         @socket = UNIXSocket.new("/tmp/.X11-unix/X#{display_id}")
         family = :Local
@@ -26,22 +28,27 @@ module X11
         family = :Internet
       end
 
-      # FIXME
-      authorize(host, family, display_id) rescue nil
+      authorize(host, family, display_id)
 
       @requestseq = 1
-      @queue = []
-
-      @extensions = {}
+      @rqueue = Queue.new       # Read but not returned events
+      @wqueue = Queue.new
+      @extensions = {}  # Known extensions
+      @atoms = {}       # Interned atoms
 
-      # Interned atoms
-      @atoms = {}
+      start_io
     end
 
     def event_handler= block
       @event_handler= block
     end
 
+    def flush
+      while !@wqueue.empty?
+        sleep(0.01)
+      end
+    end
+
     def display_info
       @internal
     end
@@ -67,8 +74,15 @@ module X11
 
     def read_error data
       error = Form::Error.from_packet(StringIO.new(data))
+      # FIXME: Maybe make this configurable, as it means potentially
+      # keeping along really heavy requests. or alternative purge them
+      # more aggressively also when there are no errors, as otherwise
+      # the growth might be unbounded
+      error.request = @requests[error.sequence_number]
+      @requests.keys.find_all{|s| s <= error.sequence_number}.each do |s|
+        @requests.delete(s)
+      end
       STDERR.puts "ERROR: #{error.inspect}"
-      raise error.inspect
       error
     end
 
@@ -126,22 +140,24 @@ module X11
     end
 
     def read_full_packet(len = 32)
-      data = @socket.read_nonblock(32)
+      data = @socket.read(32)
       return nil if data.nil?
       while data.length < 32
         IO.select([@socket],nil,nil,0.001)
         data.concat(@socket.read_nonblock(32 - data.length))
       end
       return data
-    rescue IO::WaitReadable
-      return nil
     end
 
-    def read_packet timeout=5.0
-      IO.select([@socket],nil,nil, timeout)
+    def read_packet
       data = read_full_packet(32)
       return nil if data.nil?
 
+      # FIXME: Make it configurable.
+      @requests.keys.find_all{|s| s <= @requestseq - 50}.each do |s|
+        @requests.delete(s)
+      end
+
       # FIXME: What is bit 8 for? Synthentic?
       type = data.unpack("C").first & 0x7f
       case type
@@ -153,57 +169,100 @@ module X11
       end
     end
 
-    def write_raw_packet(pkt)
-      @requestseq += 1
-      @socket.write(pkt)
-    end
-    
     def write_packet(*args)
       pkt = args.join
       pkt[2..3] = u16(pkt.length/4)
-      write_raw_packet(pkt)
+      @wqueue << [nil,nil,pkt]
     end
     
     def write_request ob
-      data = ob.to_packet if ob.respond_to?(:to_packet)
+      data = ob.to_packet(self) if ob.respond_to?(:to_packet)
       raise "BAD LENGTH for #{ob.inspect} (#{ob.request_length.to_i*4} ! #{data.size} " if ob.request_length && ob.request_length.to_i*4 != data.size
-      write_raw_packet(data)
-    end
-
-    def write_sync(data, reply=nil)
-      seq = @requestseq
-      write_request(data)
-      pkt = next_reply(seq)
-      return nil if !pkt
-      return pkt if pkt.is_a?(X11::Form::Error)
-      pp reply
+      STDERR.puts "write_req: #{ob.inspect}" if @debug
+      @wqueue << [ob,nil,data]
+    end
+
+    def write_sync(ob, reply=nil)
+      data = ob.to_packet(self) if ob.respond_to?(:to_packet)
+      q = Queue.new
+      @wqueue << [ob,q,data]
+      STDERR.puts "write_sync_req: #{ob.inspect}" if @debug
+      pkt = q.shift
+      STDERR.puts "write_sync_rep: #{pkt.inspect}" if @debug
+      raise(pkt) if pkt.is_a?(X11::Form::Error)
+      return pkt if !pkt.is_a?(String)
       reply ? reply.from_packet(StringIO.new(pkt)) : pkt
     end
 
-    def peek_packet
-      !@queue.empty?
-    end
+    def peek_packet = !@rqueue.empty?
+    def next_packet = @rqueue.shift
 
-    def next_packet
-      @queue.shift || read_packet
-    end
+    def close  = @rqueue.close
+      
+    def start_io
+      @replies ||= {}
+      @requests ||= {}
+      # Read thread.
+      # FIXME: Drop the select.
+      rt = Thread.new do
+        while pkt = read_packet
+          #STDERR.puts "read: #{pkt.inspect}"
+          if !pkt
+            sleep 0.1
+          elsif pkt.is_a?(String)
+            # This is a reply. We need the sequence number.
+            #
+            seq = pkt.unpack1("@2S")
+            STDERR.puts "  - seq= #{seq}" if @debug
+            STDERR.puts @replies.inspect if @debug
+            if @replies[seq]
+              q = @replies.delete(seq)
+              STDERR.puts "  - reply to #{q}" if @debug
+              q << pkt
+            end
+          elsif pkt.is_a?(X11::Form::Error)
+            if @replies[pkt.sequence_number]
+              q = @replies.delete(pkt.sequence_number)
+              q << pkt
+            else
+              @rqueue << pkt
+            end
+          else
+            @rqueue << pkt
+          end
+        end
+        @rqueue.close
+        @replies.values.each(&:close)
+      end
 
-    def next_reply(errseq)
-      # FIXME: This is totally broken
-      while pkt = read_packet
-        if pkt.is_a?(String)
-          return pkt
-        elsif pkt.is_a?(X11::Form::Error) && pkt.sequence_number == errseq
-          return pkt
-        else
-          @queue.push(pkt)
+      # Write thread
+      wt = Thread.new do
+        while msg = @wqueue.shift
+          ob, q, data = *msg
+          @requests[@requestseq] = ob
+          @replies[@requestseq] = q if q
+          @requestseq = (@requestseq + 1) % 65536
+          @socket.write(data)
         end
       end
+
+      at_exit do
+        flush
+        @rqueue.close
+        @wqueue.close
+        # We kill this because it may be stuck in a read
+        # we'll never care about
+        Thread.kill(rt)
+        
+        # We wait for this to finish because otherwise we may
+        # lose side-effects
+        wt.join
+      end
     end
- 
+    
     def run
       loop do
-        pkt = read_packet
+        pkt = next_packet
         return if !pkt
         yield(pkt)
       end
@@ -214,13 +273,15 @@ module X11
         d.depth == depth }.visuals.find{|v| v.qlass = qlass }
     end
 
+    def default_root = screens.first.root
+      
     # Requests
     def create_window(x,y,w,h,
       values: {},
       depth: 32, parent: nil, border_width: 0, wclass: X11::Form::InputOutput, visual: nil
     )
       wid = new_id
-      parent ||= screens.first.root
+      parent ||= default_root
 
       if visual.nil?
         visual = find_visual(0, depth).visual_id
@@ -255,6 +316,12 @@ module X11
 
     def atom(name)
       return name if name.is_a?(Integer) # Allow atom(atom_integer_or_symbol)
+      begin
+        return Form::Atoms.const_get(name.to_sym) if Form::Atoms.const_defined?(name.to_sym)
+      rescue
+        # const_defined? will throw if name isn't a valid constant name, but
+        # that's fine
+      end
       name = name.to_sym
       intern_atom(false, name) if !@atoms[name]
       @atoms[name]
@@ -343,7 +410,10 @@ module X11
     def u8(*args)  = args.pack("c*")
     def u16(*args) = args.pack("v*")
     def u32(*args) = args.pack("V*")
-    def atom_enum(val) = open_enum(val, {cardinal: Form::CardinalAtom, atom: Form::AtomAtom, window: Form::WindowAtom})
+    def atom_enum(val)
+      open_enum(val, {cardinal: Form::CardinalAtom, atom: Form::AtomAtom, window: Form::WindowAtom}) || atom(val)
+    end
+    
     def window(*args)
       args.each {|a| raise "Window expected" if a.nil? }
       u32(*args)
@@ -354,7 +424,7 @@ module X11
     def set_input_focus(revert_to, focus, time=:now)
       # FIXME: This is an experiment.
       # Upside: Simpler. Downside: Doesn't work server-side.
-      # 
+      # Probably a bad idea.
       revert_to = open_enum(revert_to, {none: 0, pointer_root: 1, parent: 2})
       focus     = open_enum(focus,     {none: 0, pointer_root: 1 })
       time      = open_enum(time,      {current_time: 0, now: 0})
@@ -394,9 +464,8 @@ module X11
     def configure_window(window, x: nil, y: nil, width: nil, height: nil,
       border_width: nil, sibling: nil, stack_mode: nil)
 
-      mask = 0
       values = []
-
+      mask  = 0
       mask |= set_value(values, 0x001, x)
       mask |= set_value(values, 0x002, y)
       mask |= set_value(values, 0x004, width)
@@ -419,7 +488,9 @@ module X11
     end
 
 
-    def create_gc(window, foreground: nil, background: nil)
+    def create_gc(window, foreground: nil, background: nil,
+      graphics_exposures: nil
+    )
       mask = 0
       args = []
 
@@ -428,12 +499,27 @@ module X11
       # https://tronche.com/gui/x/xlib/GC/manipulating.html#XGCValues
       mask |= set_value(args, 0x04, foreground)
       mask |= set_value(args, 0x08, background)
+      mask |= set_value(args, 0x10000, graphics_exposures)
       
       gc = new_id
       write_request(X11::Form::CreateGC.new(gc, window, mask, args))
       gc
     end
 
+    def send_event(...) = write_request(Form::SendEvent.new(...))
+    def client_message(window: default_root, type: :ClientMessage, format: 32, destination: default_root, mask: 0, data: [], propagate: true)
+      f = {8 => "C20", 16 => "S10", 32 => "L5"}[format]
+      p f
+      data = (Array(data).map{|item|atom(item)} +[0]*20).pack(f)
+      event = Form::ClientMessage.new(
+        format, 0, window, atom(type), data
+      )
+      event.code =33
+      pp event
+        
+      send_event(propagate, destination, mask, event)
+    end
+      
     def put_image(*args)   = write_request(X11::Form::PutImage.new(*args))
     def clear_area(*args)  = write_request(X11::Form::ClearArea.new(*args))
     def copy_area(*args)   = write_request(X11::Form::CopyArea.new(*args))
@@ -499,19 +585,19 @@ module X11
         end
       when :rgb24
         @rgb24 ||= formats.formats.find do |f|
-          f.type         == 1 &&
+          f.type         == 1  &&
           f.depth        == 24 &&
           f.direct.red   == 16 &&
-          f.direct.green == 8 &&
+          f.direct.green == 8  &&
           f.direct.blue  == 0
         end
       when :argb24
         @argb24 ||= formats.formats.find do |f|
-          f.type         == 1 &&
+          f.type         == 1  &&
           f.depth        == 32 &&
           f.direct.alpha == 24 &&
           f.direct.red   == 16 &&
-          f.direct.green == 8 &&
+          f.direct.green == 8  &&
           f.direct.blue  == 0
         end
       else
@@ -570,7 +656,6 @@ module X11
         auth_name = ""
         auth_data = ""
       end
-      p [auth_name, auth_data]
 
       handshake = Form::ClientHandshake.new(
         Protocol::BYTE_ORDER,
@@ -580,7 +665,7 @@ module X11
         auth_data
       )
 
-      @socket.write(handshake.to_packet)
+      @socket.write(handshake.to_packet(self))
 
       data = @socket.read(1)
       raise AuthorizationError, "Failed to read response from server" if !data

data/lib/X11/form.rb

@@ -44,7 +44,7 @@ module X11
         end
       end
 
-      def to_packet
+      def to_packet(dpy)
         # fetch class level instance variable holding defined fields
         structs = self.class.structs
 
@@ -64,10 +64,10 @@ module X11
             #p [s,value]
 
             if value.is_a?(BaseForm)
-              v = value.to_packet
+              v = value.to_packet(dpy)
             else
               #p [s,value]
-              v = s.type_klass.pack(value)
+              v = s.type_klass.pack(value, dpy)
             end
             #p v
             v
@@ -77,15 +77,15 @@ module X11
           when :length, :format_length
             #p [s,value]
             #p [value.size]
-            s.type_klass.pack(value.size)
+            s.type_klass.pack(value.size, dpy)
           when :string
-            s.type_klass.pack(value)
+            s.type_klass.pack(value, dpy)
           when :list
             Array(value).collect do |obj|
               if obj.is_a?(BaseForm)
-                obj.to_packet
+                obj.to_packet(dpy)
               else
-                s.type_klass.pack(obj)
+                s.type_klass.pack(obj, dpy)
               end
             end
           end
@@ -184,6 +184,29 @@ module X11
       end
     end
 
+    # # Predefined constants, that can be used in the form of symbols
+    
+    module Atoms
+      PRIMARY   = 1
+      SECONDARY = 2
+      ARC = 3
+      ATOM = 4
+      BITMAP = 5
+      CARDINAL = 6
+      COLORMAP = 7
+      CURSOR = 8
+      #...
+      STRING = 31
+      VISUALID = 32
+      WINDOW = 33
+      WM_COMMAND = 34
+      WM_HINTS = 35
+    end
+
+    PointerWindow = 0
+    InputFocus = 1
+    
+    # FIXME: Deprecated in favour of the Constants module
     AtomAtom=4
     CardinalAtom=6
     WindowAtom=33
@@ -286,6 +309,9 @@ module X11
       field :minor_opcode, Uint16
       field :major_opcode, Uint8
       unused 21
+
+      # The original request
+      attr_accessor :request
     end
 
     # XRender structures
@@ -329,8 +355,9 @@ module X11
       field :colormap, Colormap
     end
     
-    # Requests
+    # # Requests
 
+    # Constants, p112 onwards
     CopyFromParent = 0
     InputOutput    = 1
     InputOnly      = 2
@@ -358,12 +385,17 @@ module X11
     PointerMotionMask      = 0x000040
     PointerMotionHintMask  = 0x000080
     Button1MotionMask      = 0x000100
+    # 0x200 .. 0x40000; page 113
     ExposureMask           = 0x008000
+    VisibilityChangeMask   = 0x010000
     StructureNotifyMask    = 0x020000
+    ResizeRedirectMask     = 0x040000
     SubstructureNotifyMask = 0x080000
     SubstructureRedirectMask=0x100000
     FocusChangeMask        = 0x200000
     PropertyChangeMask     = 0x400000
+    ColormapChangeMask     = 0x800000
+    OwnerGrabButtonMask    = 0x100000
 
     class CreateWindow < BaseForm
       field :opcode, Uint8, value: 1
@@ -592,6 +624,15 @@ module X11
       field :value, String8, :string
     end
 
+    class SendEvent < BaseForm
+      field :opcode, Uint8, value: 25
+      field :propagate, Bool
+      field :request_length, Uint16, value: 11
+      field :destination, Window
+      field :event_mask, Uint32
+      field :event, Uint32 # FIXME: This is wrong, and will break on parsing.
+    end
+    
     class GrabButton < BaseForm
       field :opcode, Uint8, value: 28
       field :owner_events, Bool
@@ -678,6 +719,7 @@ module X11
     ForegroundMask = 0x04
     BackgroundMask = 0x08
     FontMask = 0x4000
+    GraphicsExposures = 0x10000
 
     class CreateGC < BaseForm
       field :opcode, Uint8, value: 55
@@ -1002,6 +1044,7 @@ module X11
       unused 1
       field :sequence_number, Uint16
       field :event, Window
+      field :window, Window
       field :above_sibling, Window
       field :x, Int16
       field :y, Int16

data/lib/X11/protocol.rb

@@ -1,14 +1,12 @@
 module X11
   module Protocol
-    # endiness of your machine
+    # endianess of your machine
     BYTE_ORDER = case [1].pack("L")
-      when "\0\0\0\1"
-        "B".ord
-      when "\1\0\0\0"
-        "l".ord
+      when "\0\0\0\1" then "B".ord
+      when "\1\0\0\0" then "l".ord
       else
         raise ByteOrderError.new "Cannot determine byte order"
-    end
+      end
 
     MAJOR = 11
     MINOR = 0

data/lib/X11/screen.rb

@@ -7,25 +7,11 @@ module X11
       @internal = data
     end
 
-    def root
-      @internal.root
-    end
-
-    def root_depth
-      @internal.root_depth
-    end
-
-    def root_visual
-      @internal.root_visual
-    end
-
-    def width
-      @internal.width_in_pixels
-    end
-
-    def height
-      @internal.height_in_pixels
-    end
+    def root        = @internal.root
+    def root_depth  = @internal.root_depth
+    def root_visual = @internal.root_visual
+    def width       = @internal.width_in_pixels
+    def height      = @internal.height_in_pixels
 
     def to_s
       "#<X11::Screen(#{id}) width=#{width} height=#{height}>"

data/lib/X11/type.rb

@@ -11,7 +11,7 @@ module X11
 
       def self.config(d,b) = (@directive, @bytesize = d,b)
         
-      def self.pack(x)
+      def self.pack(x, dpy)
         if x.is_a?(Symbol)
           if (t = X11::Form.const_get(x)) && t.is_a?(Numeric)
             x = t
@@ -27,7 +27,6 @@ module X11
       def self.from_packet(sock) = unpack(sock.read(size))
     end
     
-    # Primitive Types
     class Int8   < BaseType; config("c",1); end
     class Int16  < BaseType; config("s",2); end
     class Int32  < BaseType; config("l",4); end
@@ -36,16 +35,14 @@ module X11
     class Uint32 < BaseType; config("L",4); end
     
     class Message
-      def self.pack(x)   = x.b
-      def self.unpack(x) = x.b
-      def self.size      = 20
+      def self.pack(x,dpy) = x.b
+      def self.unpack(x)   = x.b
+      def self.size        = 20
       def self.from_packet(sock) = sock.read(2).b
     end
 
     class String8
-      def self.pack(x)
-        x.b + "\x00"*(-x.length & 3)
-      end
+      def self.pack(x, dpy) = (x.b + "\x00"*(-x.length & 3))
 
       def self.unpack(socket, size)
         raise "Expected size for String8" if size.nil?
@@ -57,7 +54,7 @@ module X11
     end
 
     class String16
-      def self.pack(x)
+      def self.pack(x, dpy)
         x.encode("UTF-16BE").b + "\x00\x00"*(-x.length & 1)
       end
 
@@ -71,13 +68,13 @@ module X11
 
 
     class String8Unpadded
-      def self.pack(x) = x
+      def self.pack(x,dpy) = x
       def self.unpack(socket, size) = socket.read(size)
     end
       
     class Bool
-      def self.pack(x)     = (x ? "\x01" : "\x00")
-      def self.unpack(str) = (str[0] == "\x01")
+      def self.pack(x, dpy) = (x ? "\x01" : "\x00")
+      def self.unpack(str)  = (str[0] == "\x01")
       def self.size = 1
     end
     
@@ -96,10 +93,16 @@ module X11
     Colormap     = Uint32
     Drawable     = Uint32
     Fontable     = Uint32
-    Atom         = Uint32
     VisualID     = Uint32
     Mask         = Uint32
     Timestamp    = Uint32
     Keysym       = Uint32
+
+    class Atom
+      def self.pack(x,dpy) = [dpy.atom(x)].pack("L")
+      def self.unpack(x)   = x.nil? ? nil : x.unpack1("L")
+      def self.size = 4
+      def self.from_packet(sock) = unpack(sock.read(size))
+    end
   end
 end

data/lib/X11/version.rb

@@ -1,3 +1,3 @@
 module X11
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pure-x11
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Vidar Hokstad
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-28 00:00:00.000000000 Z
+date: 2024-01-11 00:00:00.000000000 Z
 dependencies: []
 description: Pure Ruby X11 bindings
 email:
@@ -25,6 +25,7 @@ files:
 - README.md
 - Rakefile
 - docs/protocol.pdf
+- example/client_message.rb
 - example/genie.png
 - example/test.rb
 - lib/X11.rb