ruby-wmctrl 0.0.1 → 0.0.2

data/.gitignore

@@ -7,3 +7,5 @@ ext/*.so
 ext/*.o
 ext/Makefile
 ext/mkmf.log
+doc
+.yardoc

data/.yardopts

@@ -0,0 +1,6 @@
+-m
+markdown
+lib/**/*.rb
+ext/**/*.c
+- 
+COPYING

data/README.md

@@ -0,0 +1,32 @@
+# ruby-wmctrl
+
+Ruby bindings to control windows in EWMH and NetWM compatible X Window manager.
+
+- <http://rubygems.org/gems/ruby-wmctrl>
+- <https://github.com/ytaka/ruby-wmctrl>
+
+## Compilation
+
+ruby-wmctrl is a C extended library, which uses glib and x11.
+For ubuntu 11.04, we should install packages.
+
+    apt-get install libx11-dev libglib2.0-dev
+
+## License
+
+GPLv2
+
+## Copyright
+
+### wmctrl
+
+ruby-wmctrl is created from source code of wmctrl <http://sweb.cz/tripie/utils/wmctrl/>.
+
+The copyright of originl wmctrl:
+
+Author, current maintainer: Tomas Styblo tripie@cpan.org
+Copyright (C) 2003
+
+### ruby-wmctrl
+
+Takayuki YAMAGUCHI d@ytak.info Copyright (C) 2011

data/Rakefile

@@ -1 +1,4 @@
 require "bundler/gem_tasks"
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/ext/wmctrl.c

@@ -26,8 +26,32 @@
 
 #define envir_utf8 TRUE
 
+static int client_msg(Display *disp, Window win, const char *msg,
+		      unsigned long data0, unsigned long data1,
+		      unsigned long data2, unsigned long data3,
+		      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 gchar *get_window_class (Display *disp, Window win);
+static gchar *get_window_title (Display *disp, Window win);
+static int activate_window (Display *disp, Window win, gboolean switch_desktop);
+static int close_window (Display *disp, Window win);
+static gboolean wm_supports (Display *disp, const gchar *prop);
+static int window_move_resize (Display *disp, Window win, signed long grav,
+			       signed long x, signed long y, signed long w, signed long h);
+static int window_state (Display *disp, Window win,
+			 const char *action_str, const char *prop1_str, const char *prop2_str);
+static int window_to_desktop (Display *disp, Window win, int desktop);
+static void window_set_title (Display *disp, Window win, char *title, char mode);
+static int action_window (Display *disp, Window win, char mode, int argc, VALUE *argv);
+static Window Select_Window(Display *dpy);
+static Window get_active_window(Display *disp);
+static Window get_target_window (Display *disp, VALUE obj);
+
+
 static VALUE rb_wmctrl_class, key_id, key_title, key_pid, key_geometry,
-  key_class, key_client_machine, key_desktop,
+  key_active, key_class, key_client_machine, key_desktop,
   key_viewport, key_workarea, key_current, key_showing_desktop, key_name;
 
 static ID id_select, id_active, id_activate, id_close, id_move_resize,
@@ -59,7 +83,8 @@ static VALUE rb_wmctrl_initialize(int argc, VALUE *argv, VALUE self)
 static int client_msg(Display *disp, Window win, const char *msg,
 		      unsigned long data0, unsigned long data1,
 		      unsigned long data2, unsigned long data3,
-		      unsigned long data4) {
+		      unsigned long data4)
+{
   XEvent event;
   long mask = SubstructureRedirectMask | SubstructureNotifyMask;
 
@@ -84,7 +109,8 @@ static int client_msg(Display *disp, Window win, const char *msg,
 
 /* 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) {
+			    Atom xa_prop_type, const gchar *prop_name, unsigned long *size)
+{
   Atom xa_prop_name;
   Atom xa_ret_type;
   int ret_format;
@@ -140,7 +166,8 @@ 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)
+{
   Window *client_list;
 
   if ((client_list = (Window *)get_property(disp, DefaultRootWindow(disp),
@@ -157,7 +184,8 @@ static Window *get_client_list (Display *disp, unsigned long *size) {
   return client_list;
 }
 
-static gchar *get_window_class (Display *disp, Window win) {
+static gchar *get_window_class (Display *disp, Window win)
+{
   gchar *class_utf8;
   gchar *wm_class;
   unsigned long size;
@@ -179,7 +207,8 @@ static gchar *get_window_class (Display *disp, Window win) {
   return class_utf8;
 }
 
-static gchar *get_window_title (Display *disp, Window win) {
+static gchar *get_window_title (Display *disp, Window win)
+{
   gchar *title_utf8;
   gchar *wm_name;
   gchar *net_wm_name;
@@ -206,9 +235,11 @@ static gchar *get_window_title (Display *disp, Window win) {
   return title_utf8;
 }
 
+/* Get list of information of windows. */
 static VALUE rb_wmctrl_list_windows (VALUE self) {
   Display **ptr, *disp;
   Window *client_list;
+  Window window_active;
   unsigned long client_list_size;
   unsigned int i;
   VALUE window_ary;
@@ -221,6 +252,7 @@ static VALUE rb_wmctrl_list_windows (VALUE self) {
     return Qfalse;
   }
 
+  window_active = get_active_window(disp);
   window_ary = rb_ary_new2(client_list_size);
 
   for (i = 0; i < client_list_size / sizeof(Window); i++) {
@@ -240,6 +272,12 @@ static VALUE rb_wmctrl_list_windows (VALUE self) {
     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));
 
+    if (window_active == client_list[i]) {
+      rb_hash_aset(window_obj, key_active, Qtrue);
+    } else {
+      rb_hash_aset(window_obj, key_active, Qnil);
+    }
+
     /* desktop ID */
     if ((desktop = (unsigned long *)get_property(disp, client_list[i],
   						 XA_CARDINAL, "_NET_WM_DESKTOP", NULL)) == NULL) {
@@ -277,6 +315,7 @@ static VALUE rb_wmctrl_list_windows (VALUE self) {
   return window_ary;
 }
 
+/* Get list of information of desktops. */
 static VALUE rb_wmctrl_list_desktops (VALUE self) {
   Display **ptr, *disp;
   unsigned long *num_desktops = NULL;
@@ -498,6 +537,7 @@ static VALUE rb_wmctrl_list_desktops (VALUE self) {
   return ret;
 }
 
+/* Switch desktop. */
 static VALUE rb_wmctrl_switch_desktop (VALUE self, VALUE desktop_id) {
   int target;
   Display **ptr, *disp;
@@ -512,6 +552,7 @@ static VALUE rb_wmctrl_switch_desktop (VALUE self, VALUE desktop_id) {
   return Qtrue;
 }
 
+/* Get hash of information of window manager. */
 static VALUE rb_wmctrl_info (VALUE self) {
   Display **ptr, *disp;
   Window *sup_window = NULL;
@@ -582,6 +623,7 @@ static VALUE rb_wmctrl_info (VALUE self) {
   return ret;
 }
 
+/* Minimize windows to show desktop. */
 static VALUE rb_wmctrl_showing_desktop (VALUE self, VALUE state) {
   Display **ptr, *disp;
   Data_Get_Struct(self, Display*, ptr);
@@ -618,6 +660,7 @@ static VALUE rb_wmctrl_change_geometry (VALUE self, VALUE xnum, VALUE ynum) {
   return Qtrue;
 }
 
+/* Change number of desktops. */
 static VALUE rb_wmctrl_change_number_of_desktops (VALUE self, VALUE num) {
   long n;
   Display **ptr, *disp;
@@ -631,7 +674,8 @@ static VALUE rb_wmctrl_change_number_of_desktops (VALUE self, VALUE num) {
   return Qtrue;
 }
 
-static int activate_window (Display *disp, Window win, gboolean switch_desktop) {
+static int activate_window (Display *disp, Window win, gboolean switch_desktop)
+{
   unsigned long *desktop;
 
   /* desktop ID */
@@ -658,11 +702,13 @@ static int activate_window (Display *disp, Window win, gboolean switch_desktop)
   return True;
 }
 
-static int close_window (Display *disp, Window win) {
+static int close_window (Display *disp, Window win)
+{
   return client_msg(disp, win, "_NET_CLOSE_WINDOW", 0, 0, 0, 0, 0);
 }
 
-static gboolean wm_supports (Display *disp, const gchar *prop) {
+static gboolean wm_supports (Display *disp, const gchar *prop)
+{
   Atom xa_prop = XInternAtom(disp, prop, False);
   Atom *list;
   unsigned long size;
@@ -686,7 +732,8 @@ static gboolean wm_supports (Display *disp, const gchar *prop) {
 }
 
 static int window_move_resize (Display *disp, Window win, signed long grav,
-			       signed long x, signed long y, signed long w, signed long h) {
+			       signed long x, signed long y, signed long w, signed long h)
+{
   unsigned long grflags;
   grflags = grav;
   if (x != -1) grflags |= (1 << 8);
@@ -716,7 +763,8 @@ static int window_move_resize (Display *disp, Window win, signed long grav,
 }
 
 static int window_state (Display *disp, Window win,
-			 const char *action_str, const char *prop1_str, const char *prop2_str) {
+			 const char *action_str, const char *prop1_str, const char *prop2_str)
+{
   unsigned long action;
   Atom prop1 = 0;
   Atom prop2 = 0;
@@ -754,7 +802,8 @@ static int window_state (Display *disp, Window win,
   return client_msg(disp, win, "_NET_WM_STATE", action, (unsigned long)prop1, (unsigned long)prop2, 0, 0);
 }
 
-static int window_to_desktop (Display *disp, Window win, int desktop) {
+static int window_to_desktop (Display *disp, Window win, int desktop)
+{
   unsigned long *cur_desktop = NULL;
   Window root = DefaultRootWindow(disp);
 
@@ -776,7 +825,8 @@ static int window_to_desktop (Display *disp, Window win, int desktop) {
   return client_msg(disp, win, "_NET_WM_DESKTOP", (unsigned long)desktop, 0, 0, 0, 0);
 }
 
-static void window_set_title (Display *disp, Window win, char *title, char mode) {
+static void window_set_title (Display *disp, Window win, char *title, char mode)
+{
   gchar *title_utf8;
   gchar *title_local;
 
@@ -823,7 +873,8 @@ static void window_set_title (Display *disp, Window win, char *title, char mode)
   g_free(title_local);
 }
 
-static int action_window (Display *disp, Window win, char mode, int argc, VALUE *argv) {
+static int action_window (Display *disp, Window win, char mode, int argc, VALUE *argv)
+{
   p_verbose("Using window: 0x%.8lx\n", win);
   switch (mode) {
   case 'a':
@@ -887,7 +938,8 @@ static int action_window (Display *disp, Window win, char mode, int argc, VALUE
   rb_raise(rb_eArgError, "Invalid argument of action_window.");
 }
 
-static Window Select_Window(Display *dpy) {
+static Window Select_Window(Display *dpy)
+{
   /*
    * Routine to let user select a window using the mouse
    * Taken from xfree86.
@@ -943,7 +995,8 @@ static Window Select_Window(Display *dpy) {
   return(target_win);
 }
 
-static Window get_active_window(Display *disp) {
+static Window get_active_window(Display *disp)
+{
   char *prop;
   unsigned long size;
   Window ret = (Window)0;
@@ -957,7 +1010,8 @@ static Window get_active_window(Display *disp) {
   return(ret);
 }
 
-static Window get_target_window (Display *disp, VALUE obj) {
+static Window get_target_window (Display *disp, VALUE obj)
+{
   Window wid = 0;
   switch (TYPE(obj)) {
   case T_FIXNUM:
@@ -1041,6 +1095,19 @@ static Window get_target_window (Display *disp, VALUE obj) {
 /*   return activate; */
 /* } */
 
+/*
+  call-seq:
+  wm.action_window(wid, :close)
+  wm.action_window(wid, :move_resize, grav, x, y, w, h)
+  wm.action_window(wid, :change_state, add, prop1, prop2 = nil)
+  wm.action_window(wid, :change_state, remove, prop1, prop2 = nil)
+  wm.action_window(wid, :change_state, toggle, prop1, prop2 = nil)
+  wm.action_window(wid, :move_to_desktop, desktop_id)
+  wm.action_window(wid, :move_to_current)
+  wm.action_window(wid, :set_title_long, str)
+  wm.action_window(wid, :set_title_short, str)
+  wm.action_window(wid, :set_title_both, str)
+*/
 static VALUE rb_wmctrl_action_window(int argc, VALUE *argv, VALUE self) {
   Window wid;
   int mode;
@@ -1101,7 +1168,8 @@ void Init_wmctrl()
   key_id = ID2SYM(rb_intern("id"));
   key_title = ID2SYM(rb_intern("title"));
   key_pid = ID2SYM(rb_intern("pid"));
-  key_geometry = ID2SYM(rb_intern("geometory"));
+  key_geometry = ID2SYM(rb_intern("geometry"));
+  key_active = ID2SYM(rb_intern("active"));
   key_class = ID2SYM(rb_intern("class"));
   key_client_machine = ID2SYM(rb_intern("client_machine"));
   key_desktop = ID2SYM(rb_intern("desktop"));

data/lib/wmctrl/version.rb

@@ -1,3 +1,3 @@
-module WMCtrl
-  VERSION = "0.0.1"
+class WMCtrl
+  VERSION = "0.0.2"
 end

data/lib/wmctrl.rb

@@ -0,0 +1,2 @@
+require 'wmctrl.so'
+require 'wmctrl/version'

data/sample/activate.rb

@@ -1,3 +1,4 @@
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "../ext")))
 require 'wmctrl'
 require 'pp'
 

data/sample/change_number_of_desktops.rb

@@ -1,3 +1,4 @@
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "../ext")))
 require 'wmctrl'
 require 'pp'
 

data/sample/change_state.rb

@@ -1,3 +1,4 @@
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "../ext")))
 require 'wmctrl'
 require 'pp'
 

data/sample/change_state2.rb

@@ -1,3 +1,4 @@
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "../ext")))
 require 'wmctrl'
 require 'pp'
 

data/sample/close.rb

@@ -1,3 +1,4 @@
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "../ext")))
 require 'wmctrl'
 require 'pp'
 

data/sample/info.rb

@@ -1,3 +1,4 @@
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "../ext")))
 require 'wmctrl'
 require 'pp'
 

data/sample/list_desktops.rb

@@ -1,3 +1,4 @@
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "../ext")))
 require 'wmctrl'
 require 'pp'
 

data/sample/list_windows.rb

@@ -1,3 +1,4 @@
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "../ext")))
 require 'wmctrl'
 require 'pp'
 

data/sample/move_resize.rb

@@ -1,3 +1,4 @@
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "../ext")))
 require 'wmctrl'
 require 'pp'
 

data/sample/move_to_desktop.rb

@@ -1,3 +1,4 @@
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "../ext")))
 require 'wmctrl'
 require 'pp'
 

data/sample/set_title.rb

@@ -1,3 +1,4 @@
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "../ext")))
 require 'wmctrl'
 require 'pp'
 

data/sample/showing_desktop.rb

@@ -1,3 +1,4 @@
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "../ext")))
 require 'wmctrl'
 require 'pp'
 

data/sample/switch_desktop.rb

@@ -1,3 +1,4 @@
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "../ext")))
 require 'wmctrl'
 require 'pp'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-wmctrl
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &7209860 !ruby/object:Gem::Requirement
+  requirement: &11195400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7209860
+  version_requirements: *11195400
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &7209440 !ruby/object:Gem::Requirement
+  requirement: &11194980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7209440
+  version_requirements: *11194980
 - !ruby/object:Gem::Dependency
   name: pkg-config
-  requirement: &7209020 !ruby/object:Gem::Requirement
+  requirement: &11194560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *7209020
+  version_requirements: *11194560
 description: Ruby bindings to control windows in EWMH and NetWM compatible X Window
   manager, which is created from source code of wmctrl command.
 email:
@@ -54,11 +54,14 @@ extensions:
 extra_rdoc_files: []
 files:
 - .gitignore
+- .yardopts
 - COPYING
 - Gemfile
+- README.md
 - Rakefile
 - ext/extconf.rb
 - ext/wmctrl.c
+- lib/wmctrl.rb
 - lib/wmctrl/version.rb
 - ruby-wmctrl.gemspec
 - sample/activate.rb