ruby-wmctrl 0.0.3 → 0.0.4

data/README.md

@@ -5,12 +5,66 @@ 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
+## Installation
 
 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
+    apt-get install libx11-dev libglib2.0-dev libxmu-dev
+
+Then we can install ruby-wmctrl from rubygems.
+
+    gem install ruby-wmctrl
+
+## Usage
+
+We load 'wmctrl' as below
+
+    require 'wmctrl'
+
+and call methods of an instance of WMCtrl.
+
+### List windows
+
+    require 'wmctrl'
+    require 'pp'
+    wm = WMCtrl.new
+    pp wm.list_windows
+
+### Activate a window
+
+    wm.action_window(window_id, :activate)
+
+The method 'action_window' takes window ID as first argument.
+We can get window ID by the method 'list_windows'.
+The second argument of 'action_window' is an action that
+manages the window of window ID.
+The rest arguments are arguments of the action.
+
+### Close a window
+
+    wm.action_window(window_id, :close)
+
+### Move and resize a window
+
+    wm.action_window(window_id, :move_resize, 0, 100, 200, 500, 400)
+
+The integers of the arguments means gravity, x coordinate, y coordinate,
+width, and height, respectively. That is,
+
+    wm.action_window(window_id, :move_resize, gravity, x, y, width, height)
+
+### Move window to a desktop
+
+    wm.action_window(window_id, :move_to_desktop, desktop_id)
+
+### Move wndow to current desktop
+
+    wm.action_window(window_id, :move_to_current)
+
+### List desktops
+
+    pp wm.list_desktops
 
 ## License
 
@@ -22,7 +76,7 @@ GPLv2
 
 ruby-wmctrl is created from source code of wmctrl <http://sweb.cz/tripie/utils/wmctrl/>.
 
-The copyright of originl wmctrl:
+The copyright of original wmctrl:
 
 Author, current maintainer: Tomas Styblo tripie@cpan.org
 Copyright (C) 2003

data/bin/rwmctrl

@@ -0,0 +1,197 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../ext'))
+require 'wmctrl'
+require 'optparse'
+
+help_message =<<HELP
+Usage: rwmctrl [options ...]
+HELP
+
+Version = WMCtrl::VERSION
+
+options = {}
+begin
+  OptionParser.new(help_message) do |opt|
+    opt.on('-l', 'List windows.') do |v|
+      options[:mode] = :list_windows
+    end
+    opt.on('-p', 'Display PID of windows.') do |v|
+      options[:pid] = true
+    end
+    opt.on('-x', 'Display class name.') do |v|
+      options[:class] = true
+    end
+    opt.on('-G', 'Display geometry of windows.') do |v|
+      options[:geometry] = true
+    end
+    opt.on('-A', 'Mark active window.') do |v|
+      options[:active] = true
+    end
+    opt.on('-E', 'Display corners of exterior frame of windows.') do |v|
+      options[:exterior_frame] = true
+    end
+    opt.on('-e <MVARG>', String, 'Move and resize windows.') do |v|
+      options[:mode] = :move_resize
+      options[:move_resize] = v
+    end
+    opt.on('-r <WIN>', String, 'Specify target window.') do |v|
+      options[:target] = v
+    end
+    opt.on('-c <WIN>', String, 'Close window.') do |v|
+      options[:mode] = :close
+      options[:target] = v
+    end
+    opt.on('-d', 'List all desktops.') do |v|
+      options[:mode] = :desktop
+    end
+    opt.on('-m', 'Show information of window manager.') do |v|
+      options[:mode] = :wm_info
+    end
+    opt.on('-b STR', String, 'Change window properties. Format is (add|remove|toggle),prop1[,prop2]') do |v|
+      options[:mode] = :change_state
+      options[:change_state] = v
+    end
+    opt.on('-n N', Integer, 'Change the number of desktops.') do |v|
+      options[:mode] = :desktop_number
+      options[:desktop_number] = v
+    end
+    # Not implemented options
+    # '-g'
+    # '-I'
+    # '-k'
+    # '-N'
+    # '-o'
+    # '-R'
+    # '-s'
+    # '-t'
+    # '-T'
+    # '-w'
+
+    # '-u'
+    # '-v'
+    opt.on('-i', 'Use window ID number as window argument.') do |v|
+      options[:use_wid] = true
+    end
+    opt.on('-F', 'Use exact match of window title.') do |v|
+      option[:use_exact] = true
+    end
+    opt.on('--ignore-case', 'Ignore case to specfy target window.') do |v|
+      options[:ignore_case] = true
+    end
+    opt.parse!(ARGV)
+  end
+rescue OptionParser::InvalidOption
+  $stderr.print <<MES
+error: Invalid Option
+#{help_message}
+MES
+  exit(2)
+rescue OptionParser::InvalidArgument
+  $stderr.print <<MES
+error: Invalid Argument
+#{help_message}
+MES
+  exit(2)
+end
+
+wm = WMCtrl.new
+
+def specify_window(wm, arg, options)
+  if arg == ':ACTIVE:'
+    wm.list_windows.find do |w|
+      w[:active] ? w : nil
+    end
+  elsif arg == ':SELECT:'
+    raise 'Not implemented.'
+  elsif options[:use_wid]
+    wid = Integer(arg)
+    wm.list_windows.find do |w|
+      wid == w[:id] ? w : nil
+    end
+  else
+    if options[:use_exact]
+      wm.list_windows.find do |w|
+        arg == w[:title] ? w : nil
+      end
+    else
+      reg = Regexp.new(arg, options[:ignore_case] ? Regexp::IGNORECASE : 0)
+      wm.list_windows.find do |w|
+        reg =~ w[:title] ? w : nil
+      end
+    end
+  end
+end
+
+case options[:mode]
+when :list_windows
+  windows = wm.list_windows(true)
+  str_class_size = windows.map { |w| w[:class].to_s.size }.max
+  windows.each do |win|
+    s = ''
+    if options[:active]
+      s << (win[:active] ? "* " : "  ")
+    end
+    s << sprintf("0x%08x %2d ", win[:id], win[:desktop])
+    if options[:pid]
+      s << "%-7d" % (win[:pid] || 0)
+    end
+    if options[:geometry]
+      s << win[:geometry].map { |n| "%-5d" % n}.join
+    end
+    if options[:exterior_frame]
+      if win[:exterior_frame]
+        s << win[:exterior_frame].map { |n| "%-5d" % n}.join
+      else
+        s << "N/A"
+      end
+    end
+    if options[:class]
+      s << sprintf("%*s ", -str_class_size, (win[:class] || "N/A"))
+    end
+    s << sprintf("%s %s", win[:client_machine] || "N/A", win[:title] || "N/A")
+    puts s
+  end
+when :move_resize
+  if target_win = specify_window(wm, options[:target], options)
+    args = options[:move_resize].split(',').map(&:to_i)
+    if args.size == 5
+      wm.action_window(target_win[:id], :move_resize, *args)
+    else
+      puts "Invalid arguments."
+    end
+  else
+    puts "Can not specify target window."
+  end
+when :change_state
+  if target_win = specify_window(wm, options[:target], options)
+    args = options[:change_state].split(',')
+    if args.size == 2 || args.size == 3
+      wm.action_window(target_win[:id], :change_state, *args)
+    else
+      puts "Invalid property string."
+    end
+  end
+when :close
+  if target_win = specify_window(wm, options[:target], options)
+    wm.action_window(target_win[:id], :close)
+  end
+when :desktop
+  wm.list_desktops.each do |dt|
+    printf("%d  %s DG: %dx%d  VP: %d,%d WA: %d,%d %dx%d  %s\n",
+           dt[:id], dt[:current] ? '*' : '-', dt[:geometry][0], dt[:geometry][1], dt[:viewport][0], dt[:viewport][1],
+           dt[:workarea][0], dt[:workarea][1], dt[:workarea][2], dt[:workarea][3], dt[:title])
+  end
+when :desktop_number
+  wm.change_number_of_desktops(options[:desktop_number])
+when :wm_info
+  info = wm.info
+  puts "Name: #{info[:name]}"
+  puts "Class: #{info[:class]}"
+  puts "PID: #{info[:pid] ? info[:pid].to_s : "N/A"}"
+  puts "Window manager's \"showing the desktop\" mode: #{info[:showing_desktop]}"
+else
+  puts "Not implemented."
+  exit(1)
+end

data/ext/wmctrl.c

@@ -53,7 +53,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_viewport, key_workarea, key_current, key_showing_desktop, key_name,
-  key_state, key_frame_extents, key_strut;
+  key_state, key_frame_extents, key_strut, key_exterior_frame;
 
 static ID id_select, id_active, id_activate, id_close, id_move_resize,
   id_change_state, id_move_to_desktop, id_move_to_current,
@@ -318,7 +318,7 @@ static VALUE rb_wmctrl_list_windows (int argc, VALUE *argv, VALUE self) {
 
       /* geometry */
       XGetGeometry (disp, client_list[i], &junkroot, &junkx, &junky, &wwidth, &wheight, &bw, &depth);
-      XTranslateCoordinates (disp, client_list[i], junkroot, junkx, junky, &x, &y, &junkroot);
+      XTranslateCoordinates (disp, client_list[i], junkroot, -bw, -bw, &x, &y, &junkroot);
 
       rb_hash_aset(window_obj, key_geometry,
 		   rb_ary_new3(4, INT2NUM(x), INT2NUM(y), INT2NUM(wwidth), INT2NUM(wheight)));
@@ -345,6 +345,13 @@ static VALUE rb_wmctrl_list_windows (int argc, VALUE *argv, VALUE self) {
       	for (j = 0; j < extents_size / sizeof(unsigned long); j++) {
       	  rb_ary_push(extents_ary, ULONG2NUM(extents[j]));
       	}
+	/* exterior frame */
+	if (extents) {
+	  rb_hash_aset(window_obj, key_exterior_frame,
+		       rb_ary_new3(4, INT2NUM(x - (int)extents[0]), INT2NUM(y - (int)extents[2]),
+				   INT2NUM(wwidth + (int)extents[0] + (int)extents[1]),
+				   INT2NUM(wheight + (int)extents[2] + (int)extents[3])));
+	}
       	g_free(extents);
       } else {
       	extents_ary = Qnil;
@@ -806,7 +813,7 @@ static int window_move_resize (Display *disp, Window win, signed long grav,
   if (w != -1) grflags |= (1 << 10);
   if (h != -1) grflags |= (1 << 11);
 
-  p_verbose("grflags: %lu\n", grflags);
+  p_verbose("move_resize: %lu %ld %ld %ld %ld\n", grflags, x, y, w, h);
 
   if (wm_supports(disp, "_NET_MOVERESIZE_WINDOW")){
     return client_msg(disp, win, "_NET_MOVERESIZE_WINDOW",
@@ -1101,65 +1108,6 @@ static Window get_target_window (Display *disp, VALUE obj)
   return wid;
 }
 
-/* static int action_window_str (Display *disp) { */
-/*   Window activate = 0; */
-/*   Window *client_list; */
-/*   unsigned long client_list_size; */
-/*   int i; */
-
-/*   if ((client_list = get_client_list(disp, &client_list_size)) != NULL) { */
-/*     for (i = 0; i < client_list_size / sizeof(Window); i++) { */
-/*       gchar *match_utf8; */
-/*       if (options.show_class) { */
-/* 	match_utf8 = get_window_class(disp, client_list[i]); /\* UTF8 *\/ */
-/*       } */
-/*       else { */
-/* 	match_utf8 = get_window_title(disp, client_list[i]); /\* UTF8 *\/ */
-/*       } */
-/*       if (match_utf8) { */
-/* 	gchar *match; */
-/* 	gchar *match_cf; */
-/* 	gchar *match_utf8_cf = NULL; */
-/* 	if (envir_utf8) { */
-/* 	  match = g_strdup(options.param_window); */
-/* 	  match_cf = g_utf8_casefold(options.param_window, -1); */
-/* 	} */
-/* 	else { */
-/* 	  if (! (match = g_locale_to_utf8(options.param_window, -1, NULL, NULL, NULL))) { */
-/* 	    match = g_strdup(options.param_window); */
-/* 	  } */
-/* 	  match_cf = g_utf8_casefold(match, -1); */
-/* 	} */
-
-/* 	if (!match || !match_cf) { */
-/* 	  continue; */
-/* 	} */
-
-/* 	match_utf8_cf = g_utf8_casefold(match_utf8, -1); */
-
-/* 	if ((options.full_window_title_match && strcmp(match_utf8, match) == 0) || */
-/* 	    (!options.full_window_title_match && strstr(match_utf8_cf, match_cf))) { */
-/* 	  activate = client_list[i]; */
-/* 	  g_free(match); */
-/* 	  g_free(match_cf); */
-/* 	  g_free(match_utf8); */
-/* 	  g_free(match_utf8_cf); */
-/* 	  break; */
-/* 	} */
-/* 	g_free(match); */
-/* 	g_free(match_cf); */
-/* 	g_free(match_utf8); */
-/* 	g_free(match_utf8_cf); */
-/*       } */
-/*       g_free(client_list); */
-/*       if (activate) { */
-/* 	break; */
-/*       } */
-/*     } */
-/*   } */
-/*   return activate; */
-/* } */
-
 /*
   call-seq:
     wm.action_window(wid, cmd, *args)
@@ -1281,6 +1229,7 @@ void Init_wmctrl()
   key_state = ID2SYM(rb_intern("state"));
   key_frame_extents = ID2SYM(rb_intern("frame_extents"));
   key_strut = ID2SYM(rb_intern("strut"));
+  key_exterior_frame = ID2SYM(rb_intern("exterior_frame"));
 
   id_active = rb_intern("active");
   id_select = rb_intern("select");

data/lib/wmctrl/version.rb

@@ -1,3 +1,3 @@
 class WMCtrl
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-wmctrl
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-18 00:00:00.000000000 Z
+date: 2011-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &9960620 !ruby/object:Gem::Requirement
+  requirement: &7241240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9960620
+  version_requirements: *7241240
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &9960120 !ruby/object:Gem::Requirement
+  requirement: &7240760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9960120
+  version_requirements: *7240760
 - !ruby/object:Gem::Dependency
   name: pkg-config
-  requirement: &9959580 !ruby/object:Gem::Requirement
+  requirement: &7240220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,12 +43,13 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *9959580
+  version_requirements: *7240220
 description: Ruby bindings to control windows in EWMH and NetWM compatible X Window
   manager, which is created from source code of wmctrl command.
 email:
 - d@ytak.info
-executables: []
+executables:
+- rwmctrl
 extensions:
 - ext/extconf.rb
 extra_rdoc_files: []
@@ -59,6 +60,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- bin/rwmctrl
 - ext/extconf.rb
 - ext/wmctrl.c
 - lib/wmctrl.rb