ruby-wmctrl 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64b85024233d08a600bd914867fcf4e3250aa4c21e8ec45eb7bf31644c3a317c
-  data.tar.gz: d42e156ef9c64fd3b43664b3cc4738295528541c12cae7dd7d4897c34e9496e4
+  metadata.gz: 207ccda9bcf9eef6653853a9cbf21f4ff720348c2e105ed438862b6dbd1d99c0
+  data.tar.gz: 59318faac41732c72b002e2aab29e00bbb76c711e058f066a8683fad81ac9607
 SHA512:
-  metadata.gz: b83996d39afbf0b47c6b964673f0a147ac6dc10d49670f3dfac051092fb45684e9e114ec07378034e443b04c539fff7bb7cc564773484efc8931dc771b8e134b
-  data.tar.gz: 412805d6b06f93ba5fad169dc2192204cdfcbb410778c1459421a11c6d3d5891d9f6aab9507f265d96abd4342af2f8603ff6959936448794ad8d56e954e734f7
+  metadata.gz: 7839e29f39f10420a359ad6891ce9225ca8d830f9d7ac68dc822cc9519c987cc79ee5097737bb7bac55e13d9017b376c112b09092feee524c48d3828c5429af4
+  data.tar.gz: 9c1fa80e1b3e5656f64f80a1908c7a7187b2e27f5f4c456eb263b4d7b9791b073202297f8711a29e1614da435b44f6918f35dee20b8ef66eafbddb41a029e497

data/README.md

@@ -31,12 +31,12 @@ We load 'wmctrl' as below;
 
 We get desktops and windows as follows;
 
-    pp WMCtrl.instance.desktops
-    pp WMCtrl.instance.windows
+    pp WMCtrl.display.desktops
+    pp WMCtrl.display.windows
 
 We can specify search conditions of windows; for example,
 
-    pp WMCtrl.instance.windows(:wm_class => /^emacs/)
+    pp WMCtrl.display.windows(:wm_class => /^emacs/)
 
 ## Usage (Basic method similar to the command "wmctrl")
 
@@ -47,7 +47,7 @@ but the author think that these methods may be changed in future release.
 
     require 'wmctrl'
     require 'pp'
-    wm = WMCtrl.instance
+    wm = WMCtrl.display
     pp wm.list_windows
 
 If you want to get properties of windows, you pass true as an argument.
@@ -111,4 +111,4 @@ Copyright (C) 2003
 
 ### ruby-wmctrl
 
-Takayuki YAMAGUCHI d@ytak.info Copyright (C) 2011
+Takayuki YAMAGUCHI d@ytak.info Copyright (C) 2011-2019

data/bin/rwmctrl

@@ -143,11 +143,11 @@ MES
   exit(2)
 end
 
-wm = WMCtrl.instance
+wm = WMCtrl.display
 
 # Return first window specified by arg and options
 def specify_window(arg, options)
-  wm = WMCtrl.instance
+  wm = WMCtrl.display
   win = nil
   if arg == ':ACTIVE:'
     win = wm.windows(:active => true).first

data/ext/wmctrl.c

@@ -32,7 +32,7 @@ static int client_msg(Display *disp, Window win, const char *msg,
 		      unsigned long data4);
 static gchar *get_property (Display *disp, Window win,
 			    Atom xa_prop_type, const gchar *prop_name, unsigned long *size);
-static Window *get_client_list (Display *disp, unsigned long *size);
+static Window *get_client_list (Display *disp, unsigned long *size, gboolean stacking_order);
 static gchar *get_window_class (Display *disp, Window win);
 static gchar *get_window_title (Display *disp, Window win);
 static VALUE activate_window (Display *disp, Window win, gboolean switch_desktop);
@@ -48,7 +48,7 @@ static Window get_target_window (Display *disp, VALUE obj);
 
 
 static VALUE rb_wmctrl_class, key_id, key_title, key_pid, key_geometry,
-  key_active, key_class, key_client_machine, key_desktop,
+  key_display, key_active, key_class, key_client_machine, key_desktop,
   key_viewport, key_workarea, key_current, key_showing_desktop, key_name,
   key_state, key_window_type, key_frame_extents, key_strut, key_exterior_frame;
 
@@ -60,7 +60,9 @@ static void rb_wmctrl_free (void **ptr)
 {
   Display **disp;
   disp = (Display **) ptr;
-  XCloseDisplay(*disp);
+  if (*disp) {
+    XCloseDisplay(*disp);
+  }
   free(ptr);
 }
 
@@ -72,14 +74,35 @@ static VALUE rb_wmctrl_alloc(VALUE self)
 
 static VALUE rb_wmctrl_initialize(int argc, VALUE *argv, VALUE self)
 {
+  char *display_name = NULL;
   Display **ptr;
   Data_Get_Struct(self, Display*, ptr);
-  if (! (*ptr = XOpenDisplay(NULL))) {
-    rb_raise(rb_eStandardError, "Cannot open display.\n");
+  if (argc > 0) {
+    display_name = StringValuePtr(argv[0]);
+  }
+  if (!(*ptr = XOpenDisplay(display_name))) {
+    if (display_name) {
+      rb_raise(rb_eStandardError, "Cannot open display %s", display_name);
+    } else {
+      rb_raise(rb_eStandardError, "Cannot open display");
+    }
   }
   return self;
 }
 
+/*
+  Get display name.
+
+  @return [String] A name of display.
+*/
+static VALUE rb_wmctrl_get_display_name (VALUE self) {
+  char *display_name;
+  Display **ptr;
+  Data_Get_Struct(self, Display*, ptr);
+  display_name = DisplayString(*ptr);
+  return(RB_UTF8_STRING_NEW2(display_name));
+}
+
 static int client_msg(Display *disp, Window win, const char *msg,
 		      unsigned long data0, unsigned long data1,
 		      unsigned long data2, unsigned long data3,
@@ -107,6 +130,25 @@ static int client_msg(Display *disp, Window win, const char *msg,
   return True;
 }
 
+static VALUE rb_client_msg(VALUE self, VALUE win_id_obj, VALUE msg_obj, VALUE data0_obj, VALUE data1_obj, VALUE data2_obj, VALUE data3_obj, VALUE data4_obj)
+{
+  Display **ptr, *disp;
+  Window win_id;
+  char *msg;
+  unsigned long data0, data1, data2, data3, data4;
+  win_id = (Window) NUM2LONG(win_id_obj);
+  Data_Get_Struct(self, Display*, ptr);
+  disp = *ptr;
+  msg = StringValuePtr(msg_obj);
+  data0 = (Window) NUM2ULONG(data0_obj);
+  data1 = (Window) NUM2ULONG(data1_obj);
+  data2 = (Window) NUM2ULONG(data2_obj);
+  data3 = (Window) NUM2ULONG(data3_obj);
+  data4 = (Window) NUM2ULONG(data4_obj);
+  client_msg(disp, win_id, msg, data0, data1, data2, data3, data4);
+  return Qtrue;
+}
+
 /* Copy from debian package for 64bit support. */
 static gchar *get_property (Display *disp, Window win,
 			    Atom xa_prop_type, const gchar *prop_name, unsigned long *size)
@@ -166,21 +208,23 @@ static gchar *get_property (Display *disp, Window win,
   return ret;
 }
 
-static Window *get_client_list (Display *disp, unsigned long *size)
+static Window *get_client_list (Display *disp, unsigned long *size, gboolean stacking_order)
 {
   Window *client_list;
-
-  if ((client_list = (Window *)get_property(disp, DefaultRootWindow(disp),
-  					    XA_WINDOW, "_NET_CLIENT_LIST", size)) == NULL) {
-    if ((client_list = (Window *)get_property(disp, DefaultRootWindow(disp),
-  					      XA_CARDINAL, "_WIN_CLIENT_LIST", size)) == NULL) {
-      fputs("Cannot get client list properties. \n"
-  	    "(_NET_CLIENT_LIST or _WIN_CLIENT_LIST)"
-  	    "\n", stderr);
-      return NULL;
+  if (stacking_order) {
+    client_list = (Window *)get_property(disp, DefaultRootWindow(disp), XA_WINDOW, "_NET_CLIENT_LIST_STACKING", size);
+  } else {
+    client_list = (Window *)get_property(disp, DefaultRootWindow(disp), XA_WINDOW, "_NET_CLIENT_LIST", size);
+    if (client_list == NULL) {
+      client_list = (Window *)get_property(disp, DefaultRootWindow(disp), XA_CARDINAL, "_WIN_CLIENT_LIST", size);
     }
   }
-
+  if (client_list == NULL) {
+    fputs("Cannot get client list properties. \n"
+          "(_NET_CLIENT_LIST or _WIN_CLIENT_LIST)"
+          "\n", stderr);
+    return NULL;
+  }
   return client_list;
 }
 
@@ -235,7 +279,7 @@ static gchar *get_window_title (Display *disp, Window win)
   return title_utf8;
 }
 
-static VALUE get_window_hash_data (Window win, Display *disp, Window window_active, int get_state)
+static VALUE get_window_hash_data (Window win, Display *disp, Window window_active, int get_state, VALUE display_name)
 {
   VALUE window_obj = rb_hash_new();
   gchar *title_utf8 = get_window_title(disp, win); /* UTF8 */
@@ -250,6 +294,7 @@ static VALUE get_window_hash_data (Window win, Display *disp, Window window_acti
   rb_hash_aset(window_obj, key_id, INT2NUM(win));
   rb_hash_aset(window_obj, key_title, (title_utf8 ? RB_UTF8_STRING_NEW2(title_utf8) : Qnil));
   rb_hash_aset(window_obj, key_class, (class_out ? RB_UTF8_STRING_NEW2(class_out) : Qnil));
+  rb_hash_aset(window_obj, key_display, display_name);
 
   if (window_active == win) {
     rb_hash_aset(window_obj, key_active, Qtrue);
@@ -378,7 +423,7 @@ static VALUE get_window_hash_data (Window win, Display *disp, Window window_acti
 }
 
 /*
-  @overload list_windows(get_state = nil)
+  @overload list_windows(get_state = nil, stacking_order = nil)
 
   Get list of information of windows.
   @param get_state [Boolean] If the value is true then we get some properties at the same time
@@ -391,23 +436,25 @@ static VALUE rb_wmctrl_list_windows (int argc, VALUE *argv, VALUE self) {
   Window window_active;
   unsigned long client_list_size;
   unsigned int i;
-  int get_state;
-  VALUE get_state_obj, window_ary;
+  int get_state, stacking_order;
+  VALUE get_state_obj, stacking_order_obj, window_ary, display_name;
   Data_Get_Struct(self, Display*, ptr);
   disp = *ptr;
-  rb_scan_args(argc, argv, "01", &get_state_obj);
+  rb_scan_args(argc, argv, "02", &get_state_obj, &stacking_order_obj);
   get_state = RTEST(get_state_obj);
+  stacking_order = RTEST(stacking_order_obj);
 
-  if ((client_list = get_client_list(disp, &client_list_size)) == NULL) {
+  if ((client_list = get_client_list(disp, &client_list_size, stacking_order)) == NULL) {
     /* return EXIT_FAILURE; */
     return Qfalse;
   }
 
   window_active = get_active_window(disp);
   window_ary = rb_ary_new2(client_list_size);
+  display_name = rb_wmctrl_get_display_name(self);
 
   for (i = 0; i < client_list_size / sizeof(Window); i++) {
-    rb_ary_push(window_ary, get_window_hash_data(client_list[i], disp, window_active, get_state));
+    rb_ary_push(window_ary, get_window_hash_data(client_list[i], disp, window_active, get_state, display_name));
   }
   g_free(client_list);
 
@@ -420,10 +467,12 @@ static VALUE rb_wmctrl_list_windows (int argc, VALUE *argv, VALUE self) {
 static VALUE rb_wmctrl_get_window_data (VALUE self, VALUE win_id_obj) {
   Display **ptr, *disp;
   Window win_id;
+  VALUE display_name;
   win_id = (Window) NUM2LONG(win_id_obj);
   Data_Get_Struct(self, Display*, ptr);
   disp = *ptr;
-  return get_window_hash_data(win_id, disp, -1, TRUE);
+  display_name = rb_wmctrl_get_display_name(self);
+  return get_window_hash_data(win_id, disp, -1, TRUE, display_name);
 }
 
 /*
@@ -1307,6 +1356,8 @@ void Init_wmctrl()
   rb_define_alloc_func(rb_wmctrl_class, rb_wmctrl_alloc);
   rb_define_private_method(rb_wmctrl_class, "initialize", rb_wmctrl_initialize, -1);
 
+  rb_define_method(rb_wmctrl_class, "get_display_name", rb_wmctrl_get_display_name, 0);
+  rb_define_method(rb_wmctrl_class, "client_msg", rb_client_msg, 7);
   rb_define_method(rb_wmctrl_class, "list_windows", rb_wmctrl_list_windows, -1);
   rb_define_method(rb_wmctrl_class, "get_window_data", rb_wmctrl_get_window_data, 1);
   rb_define_method(rb_wmctrl_class, "list_desktops", rb_wmctrl_list_desktops, 0);
@@ -1323,6 +1374,7 @@ void Init_wmctrl()
   key_title = ID2SYM(rb_intern("title"));
   key_pid = ID2SYM(rb_intern("pid"));
   key_geometry = ID2SYM(rb_intern("geometry"));
+  key_display = ID2SYM(rb_intern("display"));
   key_active = ID2SYM(rb_intern("active"));
   key_class = ID2SYM(rb_intern("class"));
   key_client_machine = ID2SYM(rb_intern("client_machine"));

data/lib/wmctrl/version.rb

@@ -1,3 +1,3 @@
 class WMCtrl
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/wmctrl/wmctrl.rb

@@ -14,8 +14,20 @@ class WMCtrl
   GRAVITY_SOUTH_EAST = 9
   GRAVITY_STATIC = 10
 
+  @wmctrl = {}
+
   def self.instance
-    @wmctrl ||= self.new
+    STDERR.puts "WMCtrl.instance is deprecated. Please use WMCtrl.display alternatively."
+    self.display
+  end
+
+  def self.display(dpy = nil)
+    dpy ||= ENV["DISPLAY"]
+    unless display = @wmctrl[dpy]
+      display = self.new(dpy)
+      @wmctrl[dpy] = display
+    end
+    display
   end
 
   class DataHash
@@ -68,7 +80,7 @@ class WMCtrl
 
   class Window < DataHash
     [:id, :title, :active, :desktop, :client_machine,
-     :pid, :geometry, :state, :exterior_frame, :frame_extents, :strut].each do |key|
+     :pid, :geometry, :state, :exterior_frame, :frame_extents, :strut, :display].each do |key|
       define_method(key) do
         self[key]
       end
@@ -131,8 +143,9 @@ class WMCtrl
     end
 
     def action(*args)
-      WMCtrl.instance.action_window(self[:id], *args)
-      @data = WMCtrl.instance.get_window_data(self[:id])
+      wmctrl = WMCtrl.display(self[:display])
+      wmctrl.action_window(self[:id], *args)
+      @data = wmctrl.get_window_data(self[:id])
       self
     end
     private :action
@@ -191,16 +204,26 @@ class WMCtrl
     list_desktops.map { |hash| WMCtrl::Desktop.new(hash) }
   end
 
+  # @overload windows(*conditions, opts = {}, &block)
   # @param [Array] conditions An array of condition hash.
   #   The keys of the hash are keys of WMCtrl::Window#[].
   #   The values of the hash are tested by the method ===.
   #   Keys of each condition are combined by logical product and
   #   all conditions are combined by logical sum.
+  # @param [Hash] opts Options
+  # @option opts [Integer] :order Order of windows: :mapping or :stacking
   # @yield [WMCtrl::Window] Test window by block
   # @return [Array] An array of WMCtrl::Window including windows
   #   matched by the conditions and the block.
   def windows(*conditions, &block)
-    wins = list_windows(true).map { |hash| WMCtrl::Window.new(hash) }
+    cond_last = conditions.last || {}
+    if cond_last[:order] && (cond_last[:order] == :stacking)
+      conditions.pop
+      wins = list_windows(true, true)
+    else
+      wins = list_windows(true, nil)
+    end
+    wins.map! { |h| WMCtrl::Window.new(h) }
     unless conditions.empty?
       wins_selected = []
       conditions.each do |condition|
@@ -221,4 +244,25 @@ class WMCtrl
     end
     wins
   end
+
+  WAIT_CHANGE_STACKING_ORDER = 0.01
+
+  # @param [Hash] opts Options
+  # @option opts [Float] :waiting_time Time to wait restack request
+  # @option opts [String] :display Display name
+  def restack(wins_bottom_to_top, opts = {})
+    win_upper = nil
+    waiting_time = opts[:sleep] || WAIT_CHANGE_STACKING_ORDER
+    wins_bottom_to_top.reverse.each do |win|
+      next if win.sticky?
+      if win_upper
+        # 1 means below
+        WMCtrl.display(opts[:display]).client_msg(win.id, "_NET_RESTACK_WINDOW", 2, win_upper.id, 1, 0, 0)
+        # If there is no sleep, change the stacking order fails.
+        # Can we use _NET_WM_SYNC_REQUEST?
+        sleep(waiting_time)
+      end
+      win_upper = win
+    end
+  end
 end

data/ruby-wmctrl.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.extensions    = Dir.glob("ext/**/extconf.rb")
 
   # specify any dependencies here; for example:
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "yard"
   spec.add_runtime_dependency "pkg-config"

data/spec/wmctrl_spec.rb

@@ -15,6 +15,16 @@ describe WMCtrl do
     wins.each do |w|
       expect(w).to be_an_instance_of Hash
     end
+    wins = wm.list_windows(true)
+    expect(wins).to be_an_instance_of Array
+    wins.each do |w|
+      expect(w).to be_an_instance_of Hash
+    end
+    wins = wm.list_windows(true, true)
+    expect(wins).to be_an_instance_of Array
+    wins.each do |w|
+      expect(w).to be_an_instance_of Hash
+    end
   end
 
   it "should get an array of hashes." do

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ruby-wmctrl
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Takayuki YAMAGUCHI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-17 00:00:00.000000000 Z
+date: 2019-07-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -111,8 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby bindings to control windows