x_do_bindings 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec538d7ebcacf6d9be941502f5a7d91f33e80b5a
+  data.tar.gz: 5b48ca12807f297cdd2dd7ff72511c5537b1cc2e
+SHA512:
+  metadata.gz: 8f31007fe362ba2d047eebd4b7e7d0bc1b4ffd8302a1e1e9435b0b93c0aff8f628d0c868b34b3dd5beddc8fe89b0e52ab961c2811af74750e13ed2a93ae858ee
+  data.tar.gz: f94e70a5d3e624cfcb3cc07124c440ecfdddfaa8b67a4976158b541725bef5ee9e44df70623985d9ab0697dce8c2e98bcaaf94da0a19ee8083189dbccf6e3871

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.project

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>x_do</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>com.aptana.ide.core.unifiedBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>com.aptana.ruby.core.rubynature</nature>
+	</natures>
+</projectDescription>

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,9 @@
+source 'http://rubygems.org'
+
+gem 'ffi'
+
+group :development do
+  gem 'rdoc'
+  gem 'rspec'
+  gem 'bundler'
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    ffi (1.9.8)
+    rdoc (4.2.0)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  ffi
+  rdoc
+  rspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Victor Costan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,31 @@
+= x_do
+
+FFI ruby bindings for libxdo, which injects keystrokes and mouse events into X event queues.
+
+== Installation
+
+The gem requires libxdo on your machine to compile. On an Ubuntu system, you can get it by installing the libxdo-dev package.
+
+== Documentation
+
+Up-to-date RDocs are available at http://rdoc.info/github/pwnall/x_do/frames
+
+== Testing
+
+Tests require that xdotool is installed and on your path. On an Ubuntu system, you can get it by installing the xdotool package.
+
+The terminal running the tests should remain focused while the suite runs, otherwise some tests will fail. The window should also not be maximized.
+
+== Contributing to x_do
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Victor Costan. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+require 'rake'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "x_do #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+load 'tasks/ffi_codegen.rb'
+task :package => :ffi_header
+task :spec => :ffi_header

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/x_do.rb

@@ -0,0 +1,13 @@
+# :nodoc: documented in x_do/context.rb
+class XDo
+end  # namespace XDo
+
+require 'x_do/context.rb'
+require 'x_do/mouse.rb'
+require 'x_do/keyboard.rb'
+require 'x_do/window.rb'
+
+require 'x_do/ffi_lib.rb'
+require 'x_do/ffi_autogen.rb'
+require 'x_do/ffi_functions.rb'
+require 'x_do/ffi_lib_ext.rb'

data/lib/x_do/context.rb

@@ -0,0 +1,102 @@
+# Context for automation actions.
+class XDo
+  # Creates a context for an X display.
+  #
+  # Args:
+  #   display_name:: an X display name, such as ":0"; if not given, libxdo will
+  #                  choose a default display (usually the one pointed by the
+  #                  DISPLAY variable)
+  def initialize(display_name = nil)
+    @_pointer = XDo::FFILib.xdo_new display_name
+    @_context = XDo::FFILib::XDoContext.new @_pointer
+    @keyboard = XDo::Keyboard.new self
+    @mouse = XDo::Mouse.new self
+  end
+
+  # Releases resources associated with this context.
+  def close
+    return unless @_context
+    XDo::FFILib.xdo_free @_pointer
+    @_pointer = nil
+    @_context = nil
+  end
+
+  # :nodoc: automatically close contexts as they go out of scope.
+  def finalize
+    close
+  end
+
+  # The display name for the current context.
+  def display_name
+    @_context[:display_name]
+  end
+
+  # The underlying libxdo context structure.
+  attr_accessor :_context
+  # Pointer to the underlying _libxdo context structure.
+  attr_accessor :_pointer
+
+  # The keyboard state for this context.
+  attr_accessor :keyboard
+
+  # The mouse state for this context.
+  attr_accessor :mouse
+
+  # Returns X windows matching a query.
+  #
+  # Args:
+  #   options:: hash that accepts the following keys:
+  #     :title:: grep pattern that the window title has to match
+  #     :name:: grep pattern that the window name has to match
+  #     :class:: grep pattern that the window class has to match
+  #     :class_name:: grep pattern that the window class (name?) has to match
+  #     :pid:: only return windows whose process ID equals this
+  #     :screen:: only return windows in this screen number
+  #     :desktop:: only return windows with this desktop number
+  #     :visible:: if true, only visible windows will be returned
+  #
+  # Returns an array of Window instances that match the query.
+  def find_windows(options = {})
+    query = XDo::FFILib::XDoSearch.from_options options
+    windows_pointer = FFI::MemoryPointer.new :pointer, 1
+    count_pointer = FFI::MemoryPointer.new :ulong, 1
+    XDo::FFILib.xdo_search_windows @_pointer, query, windows_pointer,
+                                  count_pointer
+    count = count_pointer.read_ulong
+    windows = windows_pointer.read_pointer.read_array_of_long(count)
+    windows.map { |window| XDo::Window.new self, window }
+  end
+
+  # Returns the currently active X window.
+  def active_window
+    window_pointer = FFI::MemoryPointer.new :ulong, 1
+    XDo::FFILib.xdo_get_active_window @_pointer, window_pointer
+    XDo::Window.new self, window_pointer.read_ulong
+  end
+
+  # Returns the X window that has the input focus.
+  def focused_window
+    window_pointer = FFI::MemoryPointer.new :ulong, 1
+    XDo::FFILib.xdo_get_focused_window @_pointer, window_pointer
+    XDo::Window.new self, window_pointer.read_ulong
+  end
+
+  # Returns the "real" X window that has the input focus.
+  #
+  # This calls xdo_get_focused_window_sane instead of xdo_get_focused_window and is
+  # recommended.
+  def real_focused_window
+    window_pointer = FFI::MemoryPointer.new :ulong, 1
+    XDo::FFILib.xdo_get_focused_window_sane @_pointer, window_pointer
+    XDo::Window.new self, window_pointer.read_ulong
+  end
+
+  # The version of the underlying library.
+  #
+  # This method is mostly useful as a health check on your installtion. A
+  # non-nil, non-empty result means the gem was built successfully against
+  # libxdo.
+  def self.lib_version
+    XDo::FFILib.xdo_version
+  end
+end  # class XDo

data/lib/x_do/ffi_autogen.rb

@@ -0,0 +1,50 @@
+# Automatically generated by tasks/ffi_codegen.rb
+
+# :nodoc: namespace
+class XDo
+
+# :nodoc: namespace
+module FFILib
+  # Constant values extracted from headers.
+  module Consts
+    XDO_ERROR = 1
+    XDO_SUCCESS = 0
+    SEARCH_TITLE = 0x0001
+    SEARCH_CLASS = 0x0002
+    SEARCH_NAME = 0x0004
+    SEARCH_PID = 0x0008
+    SEARCH_ONLYVISIBLE = 0x0010
+    SEARCH_SCREEN = 0x0020
+    SEARCH_CLASSNAME = 0x0040
+    SEARCH_DESKTOP = 0x0080
+    SEARCH_ANY = nil
+    SEARCH_ALL = nil
+    SIZE_USEHINTS = 1
+    SIZE_USEHINTS_X = 2
+    SIZE_USEHINTS_Y = 4
+    SIZE_TO = 0
+    SIZE_FROM = 1
+    XDO_FIND_PARENTS = 0
+    XDO_FIND_CHILDREN = 1
+    XDO_FEATURE_XTEST = nil
+  end  # module XDo::FFILib::Consts
+
+  # Status returned by libxdo functions.
+  Status = enum [
+    :error, Consts::XDO_ERROR,
+    :success, Consts::XDO_SUCCESS,
+  ]
+
+  # Search directions.
+  Direction = enum [
+    :parents, Consts::XDO_FIND_PARENTS,
+    :children, Consts::XDO_FIND_CHILDREN,
+  ]
+
+  # Optional features.
+  Feature = enum [
+    :xtest, Consts::XDO_FEATURE_XTEST,
+  ]
+
+end  # namespace XDo::FFILib
+end  # namespace XDo

data/lib/x_do/ffi_functions.rb

@@ -0,0 +1,65 @@
+require 'ffi'
+
+# :nodoc: namespace
+class XDo
+
+# :nodoc: function attachments
+module FFILib
+  attach_function :xdo_new, [:string], :pointer
+  attach_function :xdo_version, [], :string
+  attach_function :xdo_free, [:pointer], :void
+  attach_function :xdo_get_active_window, [:pointer, :pointer],
+                                          XDo::FFILib::Status
+  attach_function :xdo_get_focused_window, [:pointer, :pointer],
+                                         XDo::FFILib::Status
+  attach_function :xdo_get_focused_window_sane, [:pointer, :pointer],
+                                              XDo::FFILib::Status
+
+  attach_function :xdo_get_pid_window, [:pointer, :window], :int
+
+  attach_function :xdo_search_windows, [:pointer, :pointer, :pointer, :pointer],
+                                      XDo::FFILib::Status
+
+  attach_function :xdo_activate_window, [:pointer, :window], XDo::FFILib::Status
+  attach_function :xdo_focus_window, [:pointer, :window], XDo::FFILib::Status
+  attach_function :xdo_raise_window, [:pointer, :window], XDo::FFILib::Status
+
+  attach_function :xdo_get_window_name, [:pointer, :window, :pointer, :pointer,
+                                         :pointer], XDo::FFILib::Status
+  attach_function :xdo_get_window_location, [:pointer, :window, :pointer,
+                                             :pointer, :pointer],
+                                            XDo::FFILib::Status
+  attach_function :xdo_get_window_size, [:pointer, :window, :pointer, :pointer],
+                                        XDo::FFILib::Status
+  attach_function :xdo_move_window, [:pointer, :window, :int, :int],
+                                    XDo::FFILib::Status
+  attach_function :xdo_set_window_size, [:pointer, :window, :int, :int, :int],
+                                       XDo::FFILib::Status
+  attach_function :xdo_get_mouse_location, [:pointer, :pointer, :pointer, :pointer],
+                                      XDo::FFILib::Status
+  attach_function :xdo_move_mouse, [:pointer, :int, :int, :int],
+                                  XDo::FFILib::Status
+  attach_function :xdo_move_mouse_relative, [:pointer, :int, :int],
+                                           XDo::FFILib::Status
+  attach_function :xdo_wait_for_mouse_move_from, [:pointer, :int, :int],
+                                                 XDo::FFILib::Status
+  attach_function :xdo_wait_for_mouse_move_to, [:pointer, :int, :int],
+                                               XDo::FFILib::Status
+
+  attach_function :xdo_move_mouse_relative_to_window, [:pointer, :window, :int,
+                                                      :int], XDo::FFILib::Status
+  attach_function :xdo_mouse_down, [:pointer, :window, :int], XDo::FFILib::Status
+  attach_function :xdo_mouse_up, [:pointer, :window, :int], XDo::FFILib::Status
+  attach_function :xdo_click_window, [:pointer, :window, :int], XDo::FFILib::Status
+
+  attach_function :xdo_enter_text_window, [:pointer, :window, :string, :int],
+                             XDo::FFILib::Status
+  attach_function :xdo_send_keysequence_window, [:pointer, :window, :string, :int],
+                                    XDo::FFILib::Status
+  attach_function :xdo_send_keysequence_window_down, [:pointer, :window, :string, :int],
+                                         XDo::FFILib::Status
+  attach_function :xdo_send_keysequence_window_up, [:pointer, :window, :string, :int],
+                                       XDo::FFILib::Status
+end  # module XDo::FFILib
+
+end  # namespace XDo

data/lib/x_do/ffi_lib.rb

@@ -0,0 +1,50 @@
+require 'ffi'
+
+# :nodoc: namespace
+class XDo
+
+# FFI to the raw libxdo functions.
+module FFILib
+  extend FFI::Library
+  ffi_lib 'libxdo.so'
+  
+  # :nodoc: lifted from xdo.h
+  class XDoContext < FFI::Struct
+    layout :xdpy, :pointer,
+           :display_name, :string,
+           :charcodes, :pointer,
+           :charcodes_len, :int,
+           :modmap, :pointer,
+           :keymap, :pointer,
+           :keycode_high, :int,
+           :keycode_low, :int,
+           :keysyms_per_keycode, :int,
+           :close_display_when_freed, :int,
+           :quiet, :int,
+           :debug, :int,
+           :features_mask, :int
+  end  # class XDo::FFILib::XDoContext
+  
+  # :nodoc: lifted from xdo.h
+  class XDoSearch < FFI::Struct
+    layout :title, :pointer,
+           :winclass, :pointer,
+           :winclassname, :pointer,
+           :winname, :pointer,
+           :pid, :int,
+           :max_depth, :long,
+           :only_visible, :int,
+           :screen, :int,
+           :require, :int,
+           :searchmask, :int,
+           :desktop, :long,
+           :limit, :uint
+  end  # class XDo::FFILib::XDoSearch
+  
+  # :nodoc: Window from X11/X.h (Window -> XID -> unsigned long)
+  typedef :ulong, :window
+  # :nodoc: useconds_t from sys/types.h
+  typedef :ulong, :useconds_t
+end  # module XDo::FFILib
+
+end  # namespace XDo