pure-x11 0.0.9 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d50a871d744420a3fc90c8ca3cff7defb5d4917bce297469502c94e64ae12790
-  data.tar.gz: e17c0019823b08847fca5b33b35f2d618bde521fd3e86bf5a5168eb68807383a
+  metadata.gz: a54ae04997fddd16eaeea021a1b8141649b94c01fc4da4172395432fb119b768
+  data.tar.gz: 67a426e9ecd3befd4e4d33c74a63a2504b1aff720c6a871cdf69c9900637b7eb
 SHA512:
-  metadata.gz: 36892209167f3aea6ccc68309e64f0e45f56e036ce8a547ffab37460f2169902429d6d1b4f11b7156d64a45151a155a7a46df693b2db86203ba75c9b99fe41ff
-  data.tar.gz: 6c7d7c83efef12e9e9303526cf2b92b5d40ad4e7d726af5a5fe59117f1396a171d8d79e452b7a5ede941d2d1bf0fcef05b7e60fc0cfd180b7f7dce95b5c0289c
+  metadata.gz: 4c71571ad6cb34be6d9aa6d60871bba90efcc29931829035c93a11f7de9fa45741e4851179b03bf00ba2eff7aad26f2362c1323f35bf2f3f34eb2f787ca0a3f4
+  data.tar.gz: 3b727bf9aa3be18791b50178a64766626655ce8c48f743333e142fe3b2cece7c4ecbb65a78e77dd54ea7c5ebb11959493ffcd1e265d247acc34e63a423ede4c8

data/CLAUDE.md

@@ -0,0 +1,47 @@
+# Ruby X11 Development Guidelines
+
+## Build Commands
+- Install dependencies: `bundle install`
+- Run all tests: `rake test`
+- Run single test: `ruby test/specific_test.rb`
+
+## Code Style
+- Indentation: 2 spaces
+- Naming: snake_case for methods/variables, CamelCase for classes
+- Constants: ALL_CAPS or CamelCase (matching X11 protocol names)
+- Methods: One-line with `=` for simple methods (Ruby 3 syntax)
+- Error handling: Custom X11 error hierarchy (X11::BasicError, etc.)
+- Imports: require_relative for internal files, require for gems
+
+## Organization
+- Core functionality in lib/X11.rb
+- Components in lib/X11/ directory
+- Protocol definitions using DSL in form.rb
+- Test files in test/ directory with _test.rb suffix
+
+## Testing
+- Uses Minitest::Spec syntax: `_(object).must_equal expected`
+- Tests require helper.rb which sets up the environment
+- Mock objects for testing sockets/connections
+
+## Documentation
+- Comments for complex logic
+- Reference X11 protocol documentation when implementing specs
+
+## Adding X11 Protocol Requests
+1. Define request form in lib/X11/form.rb:
+   ```ruby
+   class XRenderFreePicture < BaseForm
+     field :req_type, Uint8
+     field :render_req_type, Uint8, value: 7
+     field :request_length, Uint16, value: 2
+     field :picture, Uint32
+   end
+   ```
+2. Add helper method in lib/X11/display.rb:
+   ```ruby
+   def render_free_picture(picture)
+     write_request(Form::XRenderFreePicture.new(render_opcode, picture))
+   end
+   ```
+3. Update X11::VERSION in lib/X11/version.rb after adding new functionality

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pure-x11 (0.0.8)
+    pure-x11 (0.0.12)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -9,6 +9,16 @@ upstread everything.
 This library is based off of Mathieu Bouchard's work on his RubyX11 project,
 and Richard Ramsdens excellent start on Ruby-X11.
 
+Current known use (all mine...):
+
+ * [RubyWM](https://github.com/vidarh/rubywm) - Pure Ruby window manager
+ * [Skrift-X11](https://github.com/vidarh/skrift-x11) - X11 integration for pure Ruby Truetype font rendering
+ * Rebar - not yet published wm toolbar
+ * RubyTerm (name TBD) - not yet published version of Ruby terminal
+
+If you're thinking of using pure-x11, drop me a note and I'll start being more
+cautious about breaking changes ;)
+
 Contributors
 ------------
 

data/example/query_pointer.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+require_relative '../lib/X11'
+
+display = X11::Display.new
+root = display.screens.first.root
+
+# Create a simple window
+window = display.create_window(
+  100, 100, 400, 300,
+  depth: 24,
+  values: { X11::Form::CWBackPixel => 0xFFFFFF }
+)
+
+# Select input events (pointer motion)
+display.select_input(window, X11::Form::PointerMotionMask)
+
+# Map the window (make it visible)
+display.map_window(window)
+
+# Wait for window to be visible
+sleep(0.5)
+
+puts "Window created. Moving your mouse over the window will display coordinates."
+puts "Press Ctrl+C to exit."
+
+# Main event loop
+display.run do |event|
+  case event
+  when X11::Form::MotionNotify
+    # Query pointer position relative to window
+    pointer = display.query_pointer(window)
+    puts "Pointer position:"
+    puts "  Window: (#{pointer.win_x}, #{pointer.win_y})"
+    puts "  Root:   (#{pointer.root_x}, #{pointer.root_y})"
+    puts "  Child:  #{pointer.child == 0 ? 'None' : pointer.child}"
+    puts "  Mask:   #{pointer.mask.to_s(16)}"
+    puts "  Same screen: #{pointer.same_screen}"
+    puts "--------------------"
+  end
+end

data/example/query_pointer_simple.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+require_relative '../lib/X11'
+
+# Create display connection
+display = X11::Display.new
+
+# Get root window of first screen
+root = display.screens.first.root
+
+puts "Move your mouse around and watch the coordinates update."
+puts "Press Ctrl+C to exit."
+
+# Loop and query pointer position every 0.1 seconds
+loop do
+  pointer = display.query_pointer(root)
+  
+  system("clear") # Clear terminal
+  puts "Pointer position relative to root window:"
+  puts "  Root coordinates: (#{pointer.root_x}, #{pointer.root_y})"
+  puts "  Window under pointer: #{pointer.child == 0 ? 'None' : pointer.child}"
+  puts "  Button/modifier mask: #{pointer.mask.to_s(16)}"
+  puts "  Same screen: #{pointer.same_screen}"
+  
+  sleep(0.1)
+end

data/lib/X11/display.rb

@@ -541,6 +541,10 @@ module X11
     def create_pixmap(depth, drawable, w,h)
       new_id.tap{|pid| write_request(Form::CreatePixmap.new(depth, pid, drawable, w,h)) }
     end
+    
+    def free_pixmap(pixmap)
+      write_request(Form::FreePixmap.new(pixmap))
+    end
 
     # XRender
 
@@ -651,6 +655,14 @@ module X11
       write_request(Form::XRenderCreateSolidFill.new(render_opcode,fill,color))
       fill
     end
+    
+    def render_free_picture(picture)
+      write_request(Form::XRenderFreePicture.new(render_opcode, picture))
+    end
+    
+    def query_pointer(window)
+      write_sync(Form::QueryPointer.new(window), Form::QueryPointerReply)
+    end
 
     private
 

data/lib/X11/form.rb

@@ -215,6 +215,10 @@ module X11
     ## X11 Packet Defintions
     ##
 
+    class Reply < BaseForm
+      field :reply, Uint8
+    end
+
     class ClientHandshake < BaseForm
       field :byte_order, Uint8
       unused 1
@@ -458,6 +462,27 @@ module X11
       field :request_length, Uint16, value: 2
       field :window, Window
     end
+    
+    class QueryPointer < BaseForm
+      field :opcode, Uint8, value: 38
+      unused 1
+      field :request_length, Uint16, value: 2
+      field :window, Window
+    end
+    
+    class QueryPointerReply < Reply
+      field :same_screen, Bool
+      field :sequence_number, Uint16
+      field :reply_length, Uint32
+      field :root, Window
+      field :child, Window
+      field :root_x, Int16
+      field :root_y, Int16
+      field :win_x, Int16
+      field :win_y, Int16
+      field :mask, Uint16
+      unused 6
+    end
 
     class ChangeSaveSet < BaseForm
       field :opcode, Uint8, value: 6
@@ -553,10 +578,6 @@ module X11
       field :name, String8, :string
     end
 
-    class Reply < BaseForm
-      field :reply, Uint8
-    end
-
     class InternAtomReply < Reply
       unused 1
       field :sequence_number, Uint16
@@ -694,6 +715,13 @@ module X11
       field :width, Uint16
       field :height, Uint16
     end
+    
+    class FreePixmap < BaseForm
+      field :opcode, Uint8, value: 54
+      unused 1
+      field :request_length, Uint16, value: 2
+      field :pixmap, Pixmap
+    end
 
     class Str < BaseForm
       field :name, Uint8, :length, value: ->(str) { str.name.length }
@@ -875,18 +903,18 @@ module X11
     # FIXME: Events have quite a bit of redundancy, but unfortunately
     # BaseForm can't handle subclassing well.
 
-    Shift = 0x001
-    Lock  = 0x002
-    Control = 0x004
-    Mod1 = 0x008
-    Mod2 = 0x010
-    Mod3 = 0x0020
-    Mod4 = 0x0040
-    Mod5 = 0x0080
-    Button1 = 0x100
-    Button2 = 0x200
-    Button3 = 0x400
-    Button4 = 0x800
+    Shift   = 0x0001
+    Lock    = 0x0002
+    Control = 0x0004
+    Mod1    = 0x0008
+    Mod2    = 0x0010
+    Mod3    = 0x0020
+    Mod4    = 0x0040
+    Mod5    = 0x0080
+    Button1 = 0x0100
+    Button2 = 0x0200
+    Button3 = 0x0400
+    Button4 = 0x0800
     Button5 = 0x1000
 
     class Event < BaseForm
@@ -1217,5 +1245,12 @@ module X11
        field :fill, Uint32
        field :color, XRenderColor
      end
+
+     class XRenderFreePicture < BaseForm
+       field :req_type, Uint8
+       field :render_req_type, Uint8, value: 7
+       field :request_length, Uint16, value: 2
+       field :picture, Uint32
+     end
   end
 end

data/lib/X11/version.rb

@@ -1,3 +1,3 @@
 module X11
-  VERSION = "0.0.9"
+  VERSION = "0.0.12"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pure-x11
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.12
 platform: ruby
 authors:
 - Vidar Hokstad
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-26 00:00:00.000000000 Z
+date: 2025-04-05 00:00:00.000000000 Z
 dependencies: []
 description: Pure Ruby X11 bindings
 email:
@@ -19,6 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CLAUDE.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -27,6 +28,8 @@ files:
 - docs/protocol.pdf
 - example/client_message.rb
 - example/genie.png
+- example/query_pointer.rb
+- example/query_pointer_simple.rb
 - example/test.rb
 - lib/X11.rb
 - lib/X11/auth.rb