rautomation 2.0.1-x86-mingw32

data/lib/rautomation/adapter/ms_uia/window.rb

@@ -0,0 +1,289 @@
+module RAutomation
+  module Adapter
+    module MsUia
+      autoload :UiaDll, File.dirname(__FILE__) + "/uia_dll"
+
+      class Window
+        include WaitHelper
+        include Locators
+        extend ElementCollections
+
+        has_many :controls
+
+        # Locators of the window.
+        attr_reader :locators
+
+        # Possible locators are :title, :text, :hwnd, :pid, :class and :index.
+        #todo - update list of valid locators for UIA
+        # Creates the window object.
+        # @note this method is not meant to be accessed directly, but only through {RAutomation::Window#initialize}!
+        # @param [Hash] locators for searching the window.
+        # @option locators [String, Regexp] :title Title of the window
+        # @option locators [String, Regexp] :text Visible text of the window
+        # @option locators [String, Regexp] :class Internal class name of the window
+        # @option locators [String, Integer] :hwnd Window handle in decimal format
+        # @option locators [String, Integer] :pid Window process ID (PID)
+        # @option locators [String, Integer] :index 0-based index to specify n-th window if all other criteria match
+        #   all other criteria match
+        # @see RAutomation::Window#initialize
+        def initialize(container, locators)
+          @container = container
+          extract(locators)
+        end
+
+        #todo - replace with UIA version
+        # Retrieves handle of the window.
+        # @note Searches only for visible windows.
+        # @see RAutomation::Window#hwnd
+        def hwnd
+          @hwnd ||= Functions.window_hwnd(@locators)
+        end
+
+        #todo - replace with UIA version
+        # @see RAutomation::Window#pid
+        def pid
+          Functions.window_pid(hwnd)
+        end
+
+        #todo - replace with UIA version
+        # @see RAutomation::Window#title
+        def title
+          Functions.window_title(hwnd)
+        end
+
+        # @see RAutomation::Window#class_names
+        def class_names
+          classes = UiaDll::children_class_names(UiaDll::SearchCriteria.from_locator(hwnd, :hwnd => hwnd))
+          classes.delete_if(&:empty?).sort
+        end
+
+        # @see RAutomation::Window#activate
+        def activate
+          return if !exists? || active?
+          restore if minimized?
+          Functions.activate_window(hwnd)
+          restore if minimized?
+          sleep 1
+        end
+
+        #todo - replace with UIA version
+        # @see RAutomation::Window#active?
+        def active?
+          exists? && Functions.foreground_window == hwnd
+        end
+
+        #todo - replace with UIA version
+        # @see RAutomation::Window#text
+        def text
+          Functions.window_text(hwnd)
+        end
+
+        #todo - replace with UIA version
+        # @see RAutomation::Window#exists?
+        def exists?
+          hwnd && Functions.window_exists(hwnd)
+        end
+
+        #todo - replace with UIA version
+        # @see RAutomation::Window#visible?
+        def visible?
+          Functions.window_visible(hwnd)
+        end
+
+        #todo - replace with UIA version
+        # @see RAutomation::Window#maximize
+        def maximize
+          Functions.show_window(hwnd, Constants::SW_MAXIMIZE)
+          sleep 1
+        end
+
+        #todo - replace with UIA version
+        # @see RAutomation::Window#minimize
+        def minimize
+          Functions.show_window(hwnd, Constants::SW_MINIMIZE)
+          sleep 1
+        end
+
+        #todo - replace with UIA version
+        # @see RAutomation::Window#minimized?
+        def minimized?
+          Functions.minimized(hwnd)
+        end
+
+        #todo - replace with UIA version
+        # @see RAutomation::Window#restore
+        def restore
+          Functions.show_window(hwnd, Constants::SW_RESTORE)
+          sleep 1
+        end
+
+        # Activates the window and sends keys to it.
+        #
+        # @example
+        #   RAutomation::Window.new(:title => //).send_keys "hello!"
+        #   RAutomation::Window.new(:title => //).send_keys [:control, "a"], "world!"
+        # Refer to {Keys::KEYS} for all the special keycodes.
+        # @see RAutomation::Window#send_keys
+        def send_keys(args)
+          Keys.encode(args).each do |arg|
+            wait_until do
+              activate
+              active?
+            end
+
+            if arg.is_a?(Array)
+              arg.reduce([]) do |pressed_keys, k|
+                if k == Keys[:null]
+                  pressed_keys.each {|pressed_key| release_key pressed_key}
+                  pressed_keys = []
+                else
+                  pressed_keys << press_key(k)
+                end
+                pressed_keys
+              end
+            else
+              send_key arg
+            end
+          end
+          sleep 1
+        end
+
+        #todo - replace with UIA version
+        # @see RAutomation::Window#close
+        def close
+          Functions.close_window(hwnd)
+        end
+
+        # @see Button#initialize
+        # @see RAutomation::Window#button
+        def button(locator)
+          Button.new(self, locator)
+        end
+
+        def value_control(locator)
+          ValueControl.new(self, locator)
+        end
+
+        # @see TabControl#initialize
+        def tab_control(locator)
+          TabControl.new(self, locator)
+        end
+
+        # @see Spinner#initialize
+        def spinner(locator)
+          Spinner.new(self, locator)
+        end
+
+        # @see TextField#initialize
+        # @see RAutomation::Window#text_field
+        def text_field(locator)
+          TextField.new(self, locator)
+        end
+
+        # Returns a {Menu} object use to build a path to a menu item to open.
+        # @param [Hash] locator for the {Menu}.  Only :text is allowed.
+        def menu(locator)
+          Menu.new(self, locator)
+        end
+
+        # Redirects all method calls not part of the public API to the {Functions} directly.
+        # @see RAutomation::Window#method_missing
+        def method_missing(name, *args)
+          Functions.respond_to?(name) ? Functions.send(name, *args) : super
+        end
+
+        def bounding_rectangle
+          window = UiaDll::element_from_handle(hwnd)
+
+          boundary = FFI::MemoryPointer.new :long, 4
+          UiaDll::bounding_rectangle(window, boundary)
+
+          boundary.read_array_of_long(4)
+        end
+
+        def move_mouse(x, y)
+          UiaDll::move_mouse(x, y)
+        end
+
+        def click_mouse()
+          UiaDll::click_mouse
+        end
+
+        def label(locator)
+          @container.wait_until_present
+          Label.new(self, locator)
+        end
+
+        def control(locator)
+          @container.wait_until_present
+          Control.new(self, locator)
+        end
+
+        def controls(locator)
+          @container.wait_until_present
+          Controls.new(self, locator)
+        end
+
+        def list_box(locator)
+          @container.wait_until_present
+          ListBox.new(self, locator)
+        end
+
+        def list_item(locator)
+          @container.wait_until_present
+          ListItem.new(self, locator)
+        end
+
+        def select_list(locator)
+          @container.wait_until_present
+          SelectList.new(self, locator)
+        end
+
+        def checkbox(locator)
+          @container.wait_until_present
+          Checkbox.new(self, locator)
+        end
+
+        def radio(locator)
+          @container.wait_until_present
+          Radio.new(self, locator)
+        end
+
+        def table(locator)
+          @container.wait_until_present
+          Table.new(self, locator)
+        end
+
+        #todo - replace with UIA version
+        # Creates the child window object.
+        # @note This is an Win32 adapter specific method, not part of the public API
+        # @example
+        #   RAutomation::Window.new(:title => /Windows Internet Explorer/i).
+        #     child(:title => /some popup/)
+        # @param (see Window#initialize)
+        # @return [RAutomation::Window] child window, popup or regular window.
+        def child(locators)
+          RAutomation::Window.new Functions.child_window_locators(hwnd, locators)
+        end
+
+        private
+
+        def press_key key
+          Functions.send_key(key, 0, 0, nil)
+          key
+        end
+
+        def release_key key
+          Functions.send_key(key, 0, Constants::KEYEVENTF_KEYUP, nil)
+          key
+        end
+
+        def send_key key
+          press_key key
+          release_key key
+          key
+        end
+      end
+    end
+  end
+end

data/lib/rautomation/adapter/ms_uia.rb

@@ -0,0 +1,27 @@
+begin
+  gem "ffi"
+rescue Gem::LoadError
+  raise Gem::LoadError, "Unable to load FFI gem. Install it with:\n\tgem install ffi"
+end
+require "ffi"
+require File.dirname(__FILE__) + "/ms_uia/constants"
+require File.dirname(__FILE__) + "/ms_uia/keys"
+require File.dirname(__FILE__) + "/ms_uia/keystroke_converter"
+require File.dirname(__FILE__) + "/ms_uia/functions"
+require File.dirname(__FILE__) + "/ms_uia/locators"
+require File.dirname(__FILE__) + "/ms_uia/window"
+require File.dirname(__FILE__) + "/ms_uia/button_helper"
+require File.dirname(__FILE__) + "/ms_uia/control"
+require File.dirname(__FILE__) + "/ms_uia/value_control"
+require File.dirname(__FILE__) + "/ms_uia/button"
+require File.dirname(__FILE__) + "/ms_uia/checkbox"
+require File.dirname(__FILE__) + "/ms_uia/menu"
+require File.dirname(__FILE__) + "/ms_uia/radio"
+require File.dirname(__FILE__) + "/ms_uia/text_field"
+require File.dirname(__FILE__) + "/ms_uia/select_list"
+require File.dirname(__FILE__) + "/ms_uia/spinner"
+require File.dirname(__FILE__) + "/ms_uia/table"
+require File.dirname(__FILE__) + "/ms_uia/tab_control"
+require File.dirname(__FILE__) + "/ms_uia/label"
+require File.dirname(__FILE__) + "/ms_uia/list_box"
+require File.dirname(__FILE__) + "/ms_uia/list_item"

data/lib/rautomation/adapter/win_32/button.rb

@@ -0,0 +1,14 @@
+module RAutomation
+  module Adapter
+    module Win32
+      class Button < Control
+        include WaitHelper
+        include Locators
+
+        # Default locators used for searching buttons.
+        DEFAULT_LOCATORS = {:class => /button/i}
+
+      end
+    end
+  end
+end

data/lib/rautomation/adapter/win_32/button_helper.rb

@@ -0,0 +1,24 @@
+module RAutomation
+  module Adapter
+    module Win32
+      module ButtonHelper
+
+        def set?
+          control_hwnd = Functions.control_hwnd(@window.hwnd, @locators)
+          Functions.control_set? control_hwnd
+        end
+
+        # @todo call a windows function to do this without clicking
+        def clear
+          click {!set?} if set?
+        end
+
+        # @todo call a windows function to do this without clicking
+        def set
+          click {set?} unless set?
+        end
+
+      end
+    end
+  end
+end

data/lib/rautomation/adapter/win_32/checkbox.rb

@@ -0,0 +1,14 @@
+module RAutomation
+  module Adapter
+    module Win32
+      class Checkbox < Control
+        include WaitHelper
+        include Locators
+        include ButtonHelper
+
+        DEFAULT_LOCATORS = {:class => /button/i}
+
+      end
+    end
+  end
+end

data/lib/rautomation/adapter/win_32/constants.rb

@@ -0,0 +1,73 @@
+module RAutomation
+  module Adapter
+    module Win32
+      # @private
+      module Constants
+        WM_GETTEXT = 0xD
+        WM_SETTEXT = 0xC
+        WM_GETTEXTLENGTH = 0xE
+        WM_CLOSE = 0x10
+
+        SW_MAXIMIZE = 3
+        SW_MINIMIZE = 6
+        SW_RESTORE = 9
+
+        SMTO_ABORTIFHUNG = 0x2
+
+        STANDARD_RIGHTS_REQUIRED = 0xF0000
+        SYNCHRONIZE = 0x100000
+        PROCESS_ALL_ACCESS = STANDARD_RIGHTS_REQUIRED | SYNCHRONIZE | 0xFFF
+
+        BM_CLICK = 0xF5
+        BM_GETSTATE = 0xF2
+        BST_CHECKED = 0x1
+
+        # keybd_event constants
+        KEYEVENTF_EXTENDEDKEY = 0x1
+        KEYEVENTF_KEYUP = 0x2
+
+        # GetWindow constants
+        GW_ENABLEDPOPUP = 6
+
+        # HRESULT
+        S_OK = 0
+
+        # IAccessible Button States
+        STATE_SYSTEM_UNAVAILABLE = 0x00000001
+        STATE_SYSTEM_SELECTED = 0x00000002
+        STATE_SYSTEM_FOCUSED = 0x00000004
+        STATE_SYSTEM_CHECKED = 0x00000010
+
+        # Combobox
+        CB_GETCOUNT = 0x0146
+        CB_GETTOPINDEX  = 0x015b
+        CB_GETLBTEXTLEN = 0x0149
+        CB_GETLBTEXT = 0x0148
+        CB_GETCURSEL = 0x0147
+        CB_GETDROPPEDCONTROLRECT = 0x0152
+        CB_GETITEMHEIGHT = 0x0154
+        CB_ERR = -1
+        CB_SETCURSEL = 0x14E
+        CB_SELECTSTRING = 0x14D
+        CB_SETEDITSEL = 0x142
+
+        # listview
+        LVM_FIRST = 0x1000
+        LVM_GETITEMCOUNT = LVM_FIRST + 4
+
+        # listbox
+        LB_GETCOUNT = 0x18b
+        LB_GETTEXT = 0x189
+        LB_GETTEXTLEN = 0x18a
+        LB_SETCURSEL = 0x186
+        LB_GETSEL = 0x187
+
+        # SendInput
+        INPUT_MOUSE = 0
+        MOUSEEVENTF_LEFTDOWN = 0x2
+        MOUSEEVENTF_LEFTUP = 0x4
+
+      end
+    end
+  end
+end

data/lib/rautomation/adapter/win_32/control.rb

@@ -0,0 +1,86 @@
+module RAutomation
+  module Adapter
+    module Win32
+      class Control
+        include WaitHelper
+        include Locators
+
+        # Creates the control object.
+        # @note this method is not meant to be accessed directly
+        # @param [RAutomation::Window] window this button belongs to.
+        # @param [Hash] locators for searching the button.
+        # @option locators [String, Regexp] :value Value (text) of the button
+        # @option locators [String, Regexp] :class Internal class name of the button
+        # @option locators [String, Integer] :id Internal ID of the button
+        # @option locators [String, Integer] :index 0-based index to specify n-th button if all other criteria match
+        # @see RAutomation::Window#button
+        def initialize(window, locators)
+          @window = window
+          extract(locators)
+        end
+
+        def hwnd
+          Functions.control_hwnd(@window.hwnd, @locators)
+        end
+
+        def class_name
+          Functions.control_class(hwnd)
+        end
+
+        def click
+          assert_enabled
+          clicked = false
+          wait_until do
+            @window.activate
+            @window.active? &&
+                focus &&
+                Functions.control_click(hwnd) &&
+                clicked = true # is clicked at least once
+
+            block_given? ? yield : clicked && !exist?
+          end
+        end
+
+        def hwnd
+          Functions.control_hwnd(@window.hwnd, @locators)
+        end
+
+        def exist?
+          !!hwnd
+        rescue UnknownElementException
+          false
+        end
+
+        alias_method :exists?, :exist?
+
+        def enabled?
+          !disabled?
+        end
+
+        def disabled?
+          Functions.unavailable? hwnd
+        end
+
+        def focus
+          assert_enabled
+          @window.activate
+          Functions.set_control_focus hwnd
+        end
+
+        def focused?
+          Functions.has_focus?(hwnd)
+        end
+
+        def value
+          Functions.control_value(hwnd)
+        end
+
+        private
+
+        def assert_enabled
+          raise "Cannot interact with disabled control #{@locators.inspect} on window #{@window.locators.inspect}!" if disabled?
+        end
+      end
+    end
+  end
+end