win-user32-ruby 0.1.0

data/lib/win-user32-ruby.rb

@@ -0,0 +1,194 @@
+# Author:: Jerry Fernholz
+# Date:: 21 May 2009
+#
+# Functions for simulating window interactions.
+
+require 'winapisys'
+require 'timeout'
+
+module WinUser32Ruby
+  include WinAPISys
+
+  class Window
+    TIMEOUT = 10
+    @handle = nil
+    attr_reader :handle
+
+    def initialize(hwnd)
+      @handle = hwnd
+    end
+
+    def text
+
+    end
+    # Wrapper for +FindWindow+.
+    # +title+:: is the title of the window we are trying to find
+    # +class_name+: is the predefined registered control-class name, generally not used
+    # *Return*:: window handle
+    def self.find_window(title, class_name = nil)
+      fw= user32 'FindWindow', 'PP', 'L'
+
+      begin
+        wnd = timeout(TIMEOUT) {sleep 0.2 while (h = fw.call class_name, title) <= 0; h}
+      rescue TimeoutError
+        return nil
+      end
+
+      Window.new wnd
+    end
+
+    # Wrapper for +FindWindowEx+.
+    # +title+:: is the title of the window we are trying to find
+    # +class_name+: is the predefined registered control-class name, generally not used
+    # *Return*:: window handle
+    def find_window_ex(title, child = 0, class_name = nil)
+      parent = @handle
+
+      fw= user32 'FindWindowEx', 'LLPP', 'L'
+
+      begin
+        wnd = timeout(TIMEOUT) {sleep 0.2 while (h = fw.call parent, child, class_name, title) <= 0; h}
+      rescue TimeoutError
+        return nil
+      end
+    
+      Window.new wnd
+    end
+
+    # Wrapper for +GetTopWindow+.
+    # +title+:: is the title of the window we are trying to find
+    # +class_name+: is the predefined registered control-class name, generally not used
+    # *Return*:: window handle
+    def get_top_window
+      parent = @handle
+      fw= user32 'GetTopWindow', 'L', 'L'
+
+      wnd = timeout(TIMEOUT) {sleep 0.2 while (h = fw.call parent) <= 0; h}
+
+      Window.new wnd
+    end
+
+    # Wrapper for +GetTopWindow+.
+    # +title+:: is the title of the window we are trying to find
+    # +class_name+: is the predefined registered control-class name, generally not used
+    # *Return*:: window handle
+    def self.get_top_window
+      parent = 0
+      fw= user32 'GetTopWindow', 'L', 'L'
+
+      wnd = timeout(TIMEOUT) {sleep 0.2 while (h = fw.call parent) <= 0; h}
+
+      Window.new wnd
+    end
+
+    # Wrapper for +GetWindow+.
+    # +hwnd+:: handle to window on which +cmd+ will be called
+    # +cmd+: command to issue to +hwnd+
+    # *Return*:: handle to window according to +cmd+
+    def get_next_child
+      hwnd, cmd = @handle, GW_CHILD
+      fw = user32 'GetWindow', 'LI', 'L'
+
+      Window.new fw.call(hwnd, cmd)
+    end
+
+    # Wrapper for +WM_GETTEXT+.
+    # +hwnd+:: handle to the window whose text we want
+    # *Return*:: window text
+    def get_window_text
+      hwnd = @handle
+      buffer = ' ' * 2048
+
+      length = send_message hwnd, WM_GETTEXT, buffer.length, buffer
+
+      length == 0 ? '' : buffer[0..length - 1]
+    end
+
+
+    # Wrapper for +GetWindowRect+.
+    # +hwnd+:: handle the window whose rectangle we are trying to get
+    # *Return*:: [left, top, right, bottom]
+    def get_window_rect
+      hwnd = @handle
+      rect = [0, 0, 0, 0].pack("L*")
+
+      gr = user32 'GetWindowRect', 'LP', 'I'
+
+      gr.call hwnd, rect
+
+      left, top, right, bottom = rect.unpack("L*")
+
+      [left, top, right, bottom]
+    end
+
+    def get_center
+      r = get_window_rect
+      [(r[0] + r[2]) / 2, (r[1] + r[3]) / 2]
+    end
+
+    def cursor_center
+      set_cursor_pos(*get_center)
+    end
+
+    def click
+      cursor_center
+      mouse_click
+    end
+
+    # Wrapper for +BringWindowToTop+.
+    # +hwnd+:: handle to window
+    def bring_window_to_top
+      hwnd = @handle
+      b = user32 'BringWindowToTop', 'L', 'I'
+      b.call hwnd
+    end
+
+    # Wrapper for +SetFocus+.
+    # +hwnd+:: handle to window
+    # *Return*:: window handle
+    def set_focus
+      hwnd = @handle
+      b = user32 'SetFocus', 'L', 'L'
+      b.call hwnd
+    end
+
+    # Wrapper for +SetForegroundWindow+.
+    # +hwnd+:: handle to window
+    # *Return*:: true if successful
+    def set_foreground_window
+      hwnd = @handle
+      b = user32 'SetForegroundWindow', 'L', 'I'
+    
+      r = b.call hwnd
+    
+      sleep 0.5
+      r
+    end
+
+    def self.get_foreground_window
+      b = user32 'GetForegroundWindow', 'V', 'L'
+
+      r = b.call
+
+      sleep 0.5
+      r
+    end
+  
+    # Wrapper for +ShowWindow+.
+    # +hwnd+:: handle to window
+    # *Return*:: true if successful
+    def show_window
+      hwnd = @handle
+      b = user32 'ShowWindow', 'LI', 'I'
+      b.call hwnd, SW_RESTORE
+    end
+
+    # Helper to Post Message to close window
+    # +hwnd+:: handle to the window to close
+    def exit!
+      hwnd = @handle
+      send_message hwnd, WM_CLOSE, 0, 0
+    end
+
+  end
+end

data/lib/winapisys.rb

@@ -0,0 +1,117 @@
+# Author:: Jerry Fernholz
+# Date:: 21 May 2009
+#
+# System level function for wrapping the Win32API
+
+module WinAPISys
+  require 'win32/api'
+  include Win32
+  # IMPORTANT: Using Win32 requires some special considerations. Native C
+  # is strongly typed whereas Ruby is not.  Therefore we need to give Ruby hints
+  # as to the correct types for any parameters or return_values.
+  #
+  # Win32 type hints:
+  # 'L':: = long
+  # 'I':: = int
+  # 'P':: = Pointer
+  # 'V':: = void
+  # 'K':: = callback
+  # 'S':: = string
+  #
+  # See rdoc for win32-api
+
+    require 'system_const'
+  # Defines a bunch of constants from windows.h and winuser.h
+
+  # Wrap the API call to functions in 'user32.dll' so we don't have to call
+  # <tt>API.new 'user32' ...</tt> repeatedly
+  # +name+:: Name of the Win32 function to be called
+  # +param_type+:: Array of parameter type hints
+  # +return_value+:: Type hint for the return value
+  # Example: <tt>user32 'FindWindow', ['P', 'P'], 'L'</tt>
+  # => calls the <i>FindWindow</i> function
+  def user32(name, param_type, return_value)
+    API.new name, param_type, return_value, 'user32'
+  end
+
+  # Wrapper for +PostMessage+.
+  # +hwnd+:: Handle to the window we're sending the message to
+  # +message+:: message to send
+  # +w_param+:: message specific information
+  # +l_param+:: more message specific information
+  def post_message(hwnd, message, w_param, l_param)
+    pm = user32 'PostMessage', 'LLLL', 'L'
+    pm.call hwnd, message, w_param, l_param
+  end
+
+  # Wrapper for +SendMessage+.
+  # +hwnd+:: Handle to the window we're sending the message to
+  # +message+:: message to send
+  # +w_param+:: message specific information
+  # +l_param+:: more message specific information
+  def send_message(hwnd, message, w_param, l_param)
+    pm = user32 'SendMessage', 'LLLP', 'L'
+    pm.call hwnd, message, w_param, l_param
+  end
+
+  # Wrapper for +SetCursorPos+.
+  # +x+:: x position
+  # +y+:: y position
+  # *Return*:: nonzero if successful or zero otherwise
+  def set_cursor_pos(x, y)
+    s = user32 'SetCursorPos', 'LL', 'I'
+
+    s.call x, y
+  end
+
+  # Simulates a mouse click by pressing and releasing the _left_ mouse button
+  def mouse_click
+    me = user32 'mouse_event', 'LLLLL', 'V'
+
+    me.call MOUSEEVENTF_LEFTDOWN, 0, 0, 0, 0
+    me.call MOUSEEVENTF_LEFTUP, 0, 0, 0, 0
+  end
+
+  # Keyboard Event constants
+  KEYEVENTF_KEYDOWN = 0
+
+  # Wrapper for +keydb_event+.
+  # +v_key+:: virtual key code from \http://msdn.microsoft.com/en-us/library/ms645540(VS.85).aspx
+  # +event+:: type of event: KEYEVENTF_KEYDOWN or KEYEVENTF_KEYUP
+  # +hw_scan_code+:: not used
+  # +extra_info+:: not used
+  # *Return*:: none
+  def kb_event(v_key, event, hw_scan_code = 0x0, extra_info = 0)
+    kbe = user32 'keybd_event', %w{I I L L}, 'V'
+    kbe.call v_key, hw_scan_code, event, extra_info
+    sleep 0.05
+  end
+
+  # Simulates key down event
+  def key_up(v_key, scan_code = 0x0)
+    kb_event v_key, KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, scan_code
+  end
+
+  # Simulates key down event
+  def key_down(v_key, scan_code = 0x0)
+    kb_event v_key, KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYDOWN, scan_code
+  end
+
+  # Simulates key press and release
+  def key_press(v_key, scan_code = 0x0)
+    kb_event v_key, KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYDOWN, scan_code
+    kb_event v_key, KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, scan_code
+  end
+
+  # Simulates a sequence of keys being pressed, but not released
+  def keys_down(v_keys)
+    raise if !v_keys.is_a?(Array)
+    v_keys.each{|k| key_down k}
+  end
+
+  # Simulates a sequence of keys being released
+  def keys_up(v_keys)
+    raise if !v_keys.is_a?(Array)
+    v_keys.each{|k| key_up k}
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: win-user32-ruby
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jerry Fernholz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-04 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: win32-api
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.2
+    version: 
+description: Ruby wrapper for the user32.dll on Windows.
+email: jerry.fernholz@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- LICENSE
+- README
+- Rakefile
+- lib/helpers.rb
+- lib/system_const.rb
+- lib/win-user32-ruby.rb
+- lib/winapisys.rb
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Ruby wrapper for the user32.dll on Windows.
+test_files: []
+