pure-x11 0.0.7 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37b5a813f478de65ecb12e89bafd332ef219baabac729a1baf29cf016d055347
-  data.tar.gz: 357ef8cd392bad30e9c2d8a7b6771c5c4fd1dd68f3e77da1544cf93f22df14f0
+  metadata.gz: b0aef4dac032e7cc033a474d8b3f19920c2dd18e55a98cdf08329c0dcb9f360e
+  data.tar.gz: 346955046f31e2e53a61183ddcd9d19db11dab82c9de8b9ea04c92b9f4900e93
 SHA512:
-  metadata.gz: 81d50a93f9df23fe424f4dd62fe10fa09f840ab16eccb5de4d83b0d2f681b3cdb8fc9416e2b818f230399276974cac7455f38bfa1fe66c55968f70fc5c1661bb
-  data.tar.gz: 00bc7b7851c843a92988c23feacba461e6b9e1c2ef1f27b025c363f452f759492a30d4c1ff5d8117ba6bb4940eaebb19234c5fef9012d6cf8339a2ee143bf875
+  metadata.gz: 417b477de5a70c6e0e568e218f007544823e1986c7969bd666bf4a8c9382c2af349ac745c693f3b9fe07aeccc9119fadda5daa6b0dfad6bb388218dc6af2ba03
+  data.tar.gz: 153aacfb1fa54955eb14d6b186a65868a803f486c88d55b483a55097b81d545fab3888ebaff3332c1fa0d964d71293a49a08654d6fef71ed7501ab6926028185

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.6)
+    pure-x11 (0.0.8)
 
 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/test.rb

@@ -14,7 +14,7 @@ dpy = display = X11::Display.new
 screen = dpy.screens.first
 root = screen.root
 
-wid = dpy.create_window(
+window = X11::Window.create(dpy, 
   0, 0, # x,y
   1000, 600, # w,h
   # FIXME: WTH isn't depth: 32 working here?
@@ -32,17 +32,18 @@ wid = dpy.create_window(
 #dpy.next_packet
 #exit(0)
 
-def set_window_opacity(dpy, wid, opacity)
-  dpy.change_property(
+
+def set_window_opacity(window, opacity)
+  window.change_property(
     :replace,
-    wid, "_NET_WM_WINDOW_OPACITY",
+    "_NET_WM_WINDOW_OPACITY",
     :cardinal, 32,
     [(0xffffffff * opacity).to_i].pack("V").unpack("C*")
   )
 end
 
 
-set_window_opacity(dpy, wid, 0.8)
+set_window_opacity(window, 0.8)
 
 #p dpy.display_info
 
@@ -87,11 +88,11 @@ def lookup_keysym(dpy,  event)
 end
 
 puts "Mapping"
-dpy.map_window(wid)
+window.map
 
-$gc = gc = dpy.create_gc(wid, foreground: 0xff0000)
-$gc2 = dpy.create_gc(wid,foreground: 0xffffff, background: 0x444444)
-$gc3 = dpy.create_gc(wid)
+$gc = gc = window.create_gc(foreground: 0xff0000)
+$gc2 = window.create_gc(foreground: 0xffffff, background: 0x444444)
+$gc3 = window.create_gc
 
 
 puts "Main loop"
@@ -123,7 +124,7 @@ $sft = SFT.new($f)
 $sft.x_scale = 15
 $sft.y_scale = 15
 $glyphcache = {}
-def render_glyph(display, wid, x,y, ch)
+def render_glyph(window, x,y, ch)
   gid = $sft.lookup(ch.ord)
   mtx = $sft.gmetrics(gid)
   data = $glyphcache[gid]
@@ -135,45 +136,45 @@ def render_glyph(display, wid, x,y, ch)
  #   p img
     data = img.pixels.map {|px|
       "\0\0"+px.chr+"\0" #+ "\0\0\0"
-    }.join.force_encoding("ASCII-8BIT")
+    }.join.b
     $glyphcache[gid] = data
   end
   depth = 24
 #  p data
 #p img
 #  p ch
- display.put_image(
-    :ZPixmap, wid, $gc2,
+   window.put_image(
+    :ZPixmap, $gc2,
     mtx.min_width,mtx.min_height,
     x, y - mtx.y_offset, 0, depth, data
   )
   mtx.advance_width
 end
 
-def render_str(display, wid, x,y, str)
+def render_str(window, x,y, str)
   str.each_byte do |ch|
-    off = render_glyph(display, wid, x, y, ch.chr)
+    off = render_glyph(window, x, y, ch.chr)
     x+= off
   end
 end
 
-def redraw(dpy, wid, gc)
-  dpy.poly_fill_rectangle(wid, gc, [20,20, 60, 80])
-  dpy.clear_area(false, wid, 30, 30, 5, 5)
-  dpy.image_text16(wid, $gc2, 30, 70, "ΑΒΓΔΕΖΗΘΙΚΛΜΝΞΟΠΡΣΤΥΦΧΨΩ")
+def redraw(window, gc)
+  window.poly_fill_rectangle(gc, [20,20, 60, 80])
+  window.clear_area(false, 30, 30, 5, 5)
+  window.image_text16($gc2, 30, 70, "ΑΒΓΔΕΖΗΘΙΚΛΜΝΞΟΠΡΣΤΥΦΧΨΩ")
   #"\u25f0\u25ef Hello World")
-  dpy.put_image(
-    :ZPixmap, wid, $gc2,
+  window.put_image(
+    :ZPixmap, $gc2,
     $png.width, $png.height, 80, 120, 0, 24, $data
   )
-  render_str(dpy, wid, 30,90, 'HelloWorld')
+  render_str(window, 30,90, 'HelloWorld')
 end
 
 loop do
   pkt = display.next_packet
   if pkt
     p pkt
-    redraw(display, wid, gc) if pkt.is_a?(X11::Form::Expose)
+    redraw(window, gc) if pkt.is_a?(X11::Form::Expose)
 
     if pkt.is_a?(X11::Form::KeyPress)
       lookup_keysym(dpy,pkt)

data/lib/X11/display.rb

@@ -3,10 +3,16 @@ require 'stringio'
 
 module X11
 
-  class DisplayError < X11Error; end
-  class ConnectionError < X11Error; end
-  class AuthorizationError < X11Error; end
-  class ProtocolError < X11Error; end
+  class DisplayError < X11::BasicError; end
+  class ConnectionError < X11::BasicError; end
+  class AuthorizationError < X11::BasicError; end
+  class ProtocolError < X11::BasicError; end
+  class Error < X11::BasicError
+    def initialize(pkt)
+      super("Error: #{pkt.error}, code=#{pkt.code}, seq=#{pkt.sequence_number}, resource=#{pkt.bad_resource_id}, major=#{pkt.major_opcode}, minor=#{pkt.minor_opcode}")
+      @error = pkt
+    end
+  end
 
   class Display
     attr_accessor :socket
@@ -189,7 +195,7 @@ module X11
       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)
+      raise(X11::Error.new(pkt)) if pkt.is_a?(X11::Form::Error)
       return pkt if !pkt.is_a?(String)
       reply ? reply.from_packet(StringIO.new(pkt)) : pkt
     end
@@ -520,6 +526,8 @@ module X11
       send_event(propagate, destination, mask, event)
     end
       
+    def query_tree(...) = write_sync(X11::Form::QueryTree.new(...), X11::Form::QueryTreeReply)
+      
     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))
@@ -533,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
 
@@ -643,6 +655,10 @@ 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
 
     private
 

data/lib/X11/form.rb

@@ -694,6 +694,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 +882,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 +1224,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.7"
+  VERSION = "0.0.11"
 end

data/lib/X11/window.rb

@@ -0,0 +1,39 @@
+
+module X11
+
+  # A simple helper class that makes requests where the
+  # target object is a specific window a bit more convenient
+  class Window
+    attr_reader :dpy, :wid
+
+    def initialize(dpy,wid)
+      @dpy, @wid = dpy,wid
+    end
+
+    def self.create(dpy, ...)
+      wid = dpy.create_window(...)
+      Window.new(dpy,wid)
+    end
+    
+    def query_tree                 = dpy.query_tree(@wid)
+    def map                        = dpy.map_window(@wid)
+    def unmap                      = dpy.unmap_window(@wid)
+    def destroy                    = dpy.destroy_window(@wid)
+    def get_geometry               = dpy.get_geometry(@wid)
+    def configure(...)             = dpy.configure_window(@wid, ...)
+    def get_property(...)          = dpy.get_property(@wid,...)
+    def grab_key(arg, ...)         = dpy.grab_key(arg, @wid, ...)
+    def grab_button(arg,...)       = dpy.grab_button(arg, @wid, ...)
+    def change_property(mode, ...) = dpy.change_property(mode, @wid, ...)
+    def set_input_focus(mode)      = dpy.set_input_focus(mode, @wid)
+    def select_input(...)          = dpy.select_input(@wid,...)
+    def get_window_attributes(...) = dpy.get_window_attributes(@wid,...)
+    def change_attributes(...)     = dpy.change_window_attributes(@wid,...)
+
+    def image_text16(...) = dpy.image_text16(@wid, ...)
+    def clear_area(arg, ...) = dpy.clear_area(arg, @wid, ...)
+    def poly_fill_rectangle(...) = dpy.poly_fill_rectangle(@wid, ...)
+    def put_image(type, ...) = dpy.put_image(type, @wid, ...)
+    def create_gc(...) = dpy.create_gc(@wid, ...)
+  end
+end

data/lib/X11.rb

@@ -1,5 +1,5 @@
 module X11
-  class X11Error < StandardError; end
+  class BasicError < StandardError; end
 end
 
 require 'socket'
@@ -9,4 +9,5 @@ require_relative './X11/display'
 require_relative './X11/screen'
 require_relative './X11/type'
 require_relative './X11/form'
+require_relative './X11/window'
 require_relative './X11/keysyms'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pure-x11
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.11
 platform: ruby
 authors:
 - Vidar Hokstad
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-11 00:00:00.000000000 Z
+date: 2025-03-25 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
@@ -38,6 +39,7 @@ files:
 - lib/X11/screen.rb
 - lib/X11/type.rb
 - lib/X11/version.rb
+- lib/X11/window.rb
 - ruby-x11.gemspec
 - test/core_test.rb
 - test/form_test.rb