x11_client 0.0.1 → 0.0.2

data/Gemfile

@@ -1,4 +1,5 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in x11_client.gemspec
 gemspec
+
+gem "rspec"

data/README.md

@@ -21,8 +21,11 @@ It can be handy if you want to controll some programs running in Xvfb.
 * X11Client#close_display - explicit close display
 * X11Client#sync - sync display
 * X11Client#start(&block) - block execution and yield event attributes for each new event.
-* X11Client#stop(&block) - stop blocking loop
+* X11Client#stop - stop blocking loop
+* X11Client#root_window_id - returns root window id in decimal.
+* X11Client#root_window - returns root window attributes hash.
 * X11Client#get_window(window_id) - returns window attributes hash or nil for given window_id.
+* X11Client#get_window(window_id) - returns window name for given window_id.
 * X11Client#mousemove(x,y) - move mouse pointer to (x,y) coordinates.
 * X11Client#mousedown(button) - down mouse buton
 * X11Client#mouseup(buton) - up mouse button
@@ -123,6 +126,12 @@ Supported events:
 
     end
 
+## Testing
+
+    $ sudo pacman -S xorg-xwininfo
+    $ bundle install
+    $ bundle exec rspec spec
+
 ## References
 
 * [The Xlib Programming Manual](http://tronche.com/gui/x/xlib/)

data/ext/x11_client_ext/x11_client_ext.c

@@ -25,7 +25,10 @@ void Init_x11_client_ext() {
   rb_define_method(cX11Client, "start", X11Client_start, 0);
   rb_define_method(cX11Client, "stop", X11Client_stop, 0);
 
+  rb_define_method(cX11Client, "root_window_id", X11Client_root_window_id, 0);
+  rb_define_method(cX11Client, "window_children_ids", X11Client_window_children_ids, 1);
   rb_define_method(cX11Client, "get_window", X11Client_get_window, 1);
+  rb_define_method(cX11Client, "get_window_name", X11Client_get_window_name, 1);
 
   rb_define_method(cX11Client, "mousemove", X11Client_mousemove, 2);
   rb_define_method(cX11Client, "mousedown", X11Client_mousedown, 1);

data/ext/x11_client_ext/x11_client_window.c

@@ -4,6 +4,13 @@
 
 #include "X11/Xutil.h"
 
+VALUE X11Client_root_window_id(VALUE self) {
+  X11Client *client;
+  Data_Get_Struct(self, X11Client, client);
+
+  return LONG2FIX(DefaultRootWindow(client->display));
+}
+
 VALUE X11Client_get_window(VALUE self, VALUE window_id) {
   VALUE result = Qnil;
 
@@ -11,7 +18,6 @@ VALUE X11Client_get_window(VALUE self, VALUE window_id) {
   Data_Get_Struct(self, X11Client, client);
 
   Window window = NUM2LONG(window_id);
-  char* window_name = '\0';
   XWindowAttributes attributes;
   XClassHint classhint;
   
@@ -27,11 +33,8 @@ VALUE X11Client_get_window(VALUE self, VALUE window_id) {
     rb_funcall(result, rb_intern("[]="), 2, rb_str_new2("border_width"), INT2FIX(attributes.border_width));
     rb_funcall(result, rb_intern("[]="), 2, rb_str_new2("root_id"), LONG2FIX(attributes.root));
     rb_funcall(result, rb_intern("[]="), 2, rb_str_new2("state"), X11Client_window_state(attributes));
+    rb_funcall(result, rb_intern("[]="), 2, rb_str_new2("name"), X11Client_get_window_name(self, window_id));
 
-    if (XFetchName(client->display, window, &window_name)) {
-      rb_funcall(result, rb_intern("[]="), 2, rb_str_new2("name"), rb_str_new2(window_name));
-      XFree(window_name);
-    }
 
     if (XGetClassHint(client->display, window, &classhint)) {
       rb_funcall(result, rb_intern("[]="), 2, rb_str_new2("class"), rb_str_new2(classhint.res_class));
@@ -46,6 +49,59 @@ VALUE X11Client_get_window(VALUE self, VALUE window_id) {
   return result;
 }
 
+VALUE X11Client_get_window_name(VALUE self, VALUE window_id) {
+  VALUE result = Qnil;
+
+  X11Client *client;
+  Data_Get_Struct(self, X11Client, client);
+
+  Window window = NUM2LONG(window_id);
+  char* window_name = '\0';
+  XTextProperty wmName;
+
+  if (XFetchName(client->display, window, &window_name)) {
+    result = rb_str_new2(window_name);
+    XFree(window_name);
+  } else {
+    Status status = XGetWMName(client->display, window, &wmName);
+    if(status && wmName.value && wmName.nitems) {
+      int list_size;
+      char **list;
+      status = XmbTextPropertyToTextList(client->display, &wmName, &list, &list_size);
+      if (status >= Success && list_size && *list) {
+        result = rb_str_new2(*list);
+        XFree(list);
+      }
+    }
+  }
+  return result;
+}
+
+VALUE X11Client_window_children_ids(VALUE self, VALUE window_id) {
+  Window window = NUM2LONG(window_id);
+  Window dummy;
+  Window *children = NULL;
+  unsigned int i, nchildren;
+
+  X11Client *client;
+  Data_Get_Struct(self, X11Client, client);
+
+  XSetErrorHandler(X11Client_IgnoreBadWindowHandler);
+
+  VALUE children_ids = rb_ary_new();
+  if (XQueryTree(client->display, window, &dummy, &dummy, &children, &nchildren)) {
+    for (i = 0; i < nchildren; i++) {
+      Window child_id = children[i];
+      rb_funcall(children_ids, rb_intern("push"), 1, LONG2FIX(child_id));
+    }
+  }
+
+  XSetErrorHandler(NULL);
+
+  XFree(children);
+  return children_ids;
+}
+
 VALUE X11Client_window_state(XWindowAttributes attributes) {
   VALUE state = Qnil;
   switch(attributes.map_state) {

data/ext/x11_client_ext/x11_client_window.h

@@ -1,3 +1,17 @@
+// returns root window id
+VALUE X11Client_root_window_id(VALUE self);
+
+// returns window attributes for specified window id
 VALUE X11Client_get_window(VALUE self, VALUE window_id);
+
+// return children window ids for specified window id
+VALUE X11Client_window_children_ids(VALUE self, VALUE window_id);
+
+// get window state
 VALUE X11Client_window_state(XWindowAttributes attributes);
+
+// get window name for given window id
+VALUE X11Client_get_window_name(VALUE self, VALUE window_id);
+
+// handler that ignores BadWindow error
 int X11Client_IgnoreBadWindowHandler(Display *display, XErrorEvent *error);

data/lib/x11_client.rb

@@ -1,4 +1,32 @@
 require "x11_client_ext"
 
 class X11Client
+  def window_children(window_id)
+    window_children_ids(window_id).map do |child_id|
+      get_window(child_id)
+    end.compact
+  end
+
+  def window_descendants(window_id)
+    windows = []
+    ids = [window_id]
+    until ids.empty?
+      window = get_window(ids.shift)
+      windows << window
+      ids += window_children_ids(window['id'])
+    end
+    windows
+  end
+
+  def root_window
+    get_window(root_window_id)
+  end
+
+  def root_window_children
+    window_children(root_window_id)
+  end
+
+  def root_window_descendants
+    window_descendants(root_window_id)
+  end
 end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'x11_client'

data/spec/x11_client_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe X11Client do
+  let(:client) { described_class.new(ENV['DISPLAY']) }
+
+  let(:root_window_id) { `xwininfo -root -int | grep "Window id:"`.scan(/\d+/).first.to_i }
+
+  let(:root_window_children_ids) do
+    ids = []
+    `xwininfo -root -int -children`.split("\n").each do |line|
+      next if line =~ /\d+\s+children:/
+      line =~ /^\s*(\d+)/ and  ids.push($1.to_i)
+    end
+    ids
+  end
+
+  describe "#root_window_id" do
+    it "should be root window integer" do
+      root_window_id.should_not be_zero
+      client.root_window_id.should == root_window_id
+    end
+  end
+
+  describe "#root_window" do
+    it "should return hash of root window attributes" do
+      window = client.root_window
+      window.should be_kind_of(Hash)
+      window['id'].should == root_window_id
+      window['root_id'].should == root_window_id
+      window['x'].should == 0
+      window['y'].should == 0
+    end
+  end
+
+  describe "#window_children" do
+    it "should return empty array if window does not exists" do
+      client.window_children(0).should == []
+    end
+
+    it "should return root window children array for roor window" do
+      root_window_children_ids.should_not be_empty
+      children = client.window_children(root_window_id)
+
+      children.should be_kind_of(Array)
+      children.map { |child| child['id'] }.sort.should == root_window_children_ids.sort
+    end
+  end
+end

data/x11_client.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "x11_client"
-  s.version     = "0.0.1"
+  s.version     = "0.0.2"
   s.authors     = ["Andriy Yanko"]
   s.email       = ["andriy.yanko@gmail.com"]
   s.homepage    = "https://github.com/ayanko/x11_client"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: x11_client
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Andriy Yanko
@@ -48,6 +48,8 @@ files:
 - ext/x11_client_ext/x11_client_window.c
 - ext/x11_client_ext/x11_client_window.h
 - lib/x11_client.rb
+- spec/spec_helper.rb
+- spec/x11_client_spec.rb
 - x11_client.gemspec
 homepage: https://github.com/ayanko/x11_client
 licenses: []
@@ -82,5 +84,6 @@ rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: X11 client
-test_files: []
-
+test_files: 
+- spec/spec_helper.rb
+- spec/x11_client_spec.rb