rautomation 0.6.3 → 0.7.0

data/lib/rautomation/adapter/autoit/locators.rb

@@ -8,7 +8,7 @@ module RAutomation
 
         def extract(locators)
           locators = self.class::DEFAULT_LOCATORS.merge(locators) if self.class.const_defined?(:DEFAULT_LOCATORS)
-          @locators = locators
+          @locators = {:index => 0}.merge(locators)
           @autoit_locators = "[#{@locators.map do |locator, value|
             locator_key = self.class::LOCATORS[locator] || self.class::LOCATORS[[locator, value.class]]
             value = value.to_i + 1 if locator == :index # use 0-based indexing

data/lib/rautomation/adapter/autoit/text_field.rb

@@ -30,6 +30,10 @@ module RAutomation
           extract(locators)
         end
 
+        def hwnd
+          Window.autoit.ControlGetHandle(@window.locator_hwnd, "", @autoit_locators).hex
+        end
+
         # @see RAutomation::TextField#set
         def set(text)
           wait_until do
@@ -53,7 +57,12 @@ module RAutomation
 
         # @see RAutomation::TextField#exists?
         def exists?
-          not Window.autoit.ControlGetHandle(@window.locator_hwnd, "", @autoit_locators).empty?
+          hwnd != 0
+        end
+
+        def hwnd
+          handle = Window.autoit.ControlGetHandle(@window.locator_hwnd, "", @autoit_locators)
+          handle.to_i(16)
         end
       end
     end

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

@@ -30,9 +30,9 @@ module RAutomation
         # @private
         # Special-cased locators
         LOCATORS = {
-          [:title, Regexp] => :regexptitle,
-          :index => :instance,
-          :hwnd => :handle
+            [:title, Regexp] => :regexptitle,
+            :index => :instance,
+            :hwnd => :handle
         }
 
         # Creates the window object.
@@ -44,7 +44,8 @@ module RAutomation
         # @option locators [String, Fixnum] :hwnd Window handle in decimal format
         # @option locators [String, Fixnum] :index 0-based index to specify n-th window if all other criteria match
         # @see RAutomation::Window#initialize
-        def initialize(locators)
+        def initialize(container, locators)
+          @container = container
           @hwnd = locators[:hwnd]
           @locator_index = locators.delete(:index) if locators[:index] && locators.size == 1
           @locator_pid = locators.delete(:pid).to_i if locators[:pid]
@@ -57,22 +58,22 @@ module RAutomation
         # @see RAutomation::Window#hwnd
         def hwnd
           @hwnd ||= begin
-                      locators = @autoit_locators
-                      if @locator_index || @locator_pid
-                        # @todo Come up with some better solution for this case
-                        locators = "[regexptitle:]" # match all, needed for the case when only :index or :pid is used
-                      end
-                      windows = @@autoit.WinList(locators, @locator_text).pop.compact.
-                        map {|handle| self.class.new(:hwnd => handle.hex)}
-                      windows.delete_if {|window| !window.visible?}
-                      
-                      if @locator_pid
-                        window = windows.find {|win| win.pid == @locator_pid} 
-                      else
-                        window = windows[@locator_index || 0]
-                      end
-                      window ? window.hwnd : nil
-                    end
+            locators = @autoit_locators
+            if @locator_index || @locator_pid
+              # @todo Come up with some better solution for this case
+              locators = "[regexptitle:]" # match all, needed for the case when only :index or :pid is used
+            end
+            windows = @@autoit.WinList(locators, @locator_text).pop.compact.
+                map { |handle| RAutomation::Window.new(:hwnd => handle.hex) }
+            windows.delete_if { |window| !window.visible? }
+
+            if @locator_pid
+              window = windows.find { |win| win.pid == @locator_pid }
+            else
+              window = windows[@locator_index || 0]
+            end
+            window ? window.hwnd : nil
+          end
         end
 
         # @see RAutomation::Window#pid
@@ -85,6 +86,11 @@ module RAutomation
           @@autoit.WinGetTitle(locator_hwnd)
         end
 
+        # @see RAutomation::Window#class_names
+        def class_names
+          @@autoit.WinGetClassList(locator_hwnd).split("\n").sort
+        end
+
         # @see RAutomation::Window#activate
         def activate
           @@autoit.WinWait(locator_hwnd, "", 1)
@@ -145,7 +151,7 @@ module RAutomation
             activate
             active?
           end
-          @@autoit.Send(keys)
+          @@autoit.Send(keys[0])
         end
 
         # @see RAutomation::Window#close
@@ -156,13 +162,13 @@ module RAutomation
 
         # @see Button#initialize
         # @see RAutomation::Window#button
-        def button(locator)
+        def button(locator={})
           Button.new(self, locator)
         end
 
         # @see TextField#initialize
         # @see RAutomation::Window#text_field
-        def text_field(locator)
+        def text_field(locator={})
           TextField.new(self, locator)
         end
 
@@ -174,6 +180,27 @@ module RAutomation
           @@autoit.send(name, *args)
         end
 
+        # AutoIt adapter specific API methods
+        def move_mouse(x_coord, y_coord)
+          @@autoit.MouseMove(x_coord, y_coord)
+        end
+
+        def mouse_position
+          [@@autoit.MouseGetPosX, @@autoit.MouseGetPosY]
+        end
+
+        def click_mouse(button = "left")
+          @@autoit.MouseClick(button)
+        end
+
+        def press_mouse(button = "left")
+          @@autoit.MouseDown(button)
+        end
+
+        def release_mouse(button = "left")
+          @@autoit.MouseUp(button)
+        end
+
         # @private
         def locator_hwnd
           "[HANDLE:#{hwnd.to_i.to_s(16)}]"

data/lib/rautomation/adapter/helper.rb

@@ -1,7 +1,8 @@
 module RAutomation
   module Adapter
     autoload :Autoit, File.dirname(__FILE__) + "/autoit.rb"
-    autoload :WinFfi, File.dirname(__FILE__) + "/win_ffi.rb"
+    autoload :MsUia, File.dirname(__FILE__) + "/ms_uia.rb"
+    autoload :Win32, File.dirname(__FILE__) + "/win_32.rb"
 
     module Helper
       extend self
@@ -9,11 +10,10 @@ module RAutomation
       # @private
       # Retrieves default {Adapter} for the current platform.
       def default_adapter
-        case RUBY_PLATFORM
-          when /mswin|msys|mingw32/
-            :win_ffi
-          else
-            raise "unsupported platform for RAutomation: #{RUBY_PLATFORM}"
+        if ENV['OS'] == 'Windows_NT'
+          :win_32
+        else
+          raise "unsupported platform for RAutomation: #{RUBY_PLATFORM}"
         end
       end
     end

data/lib/rautomation/adapter/ms_uia.rb

@@ -0,0 +1,22 @@
+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/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/button"
+require File.dirname(__FILE__) + "/ms_uia/checkbox"
+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/table"
+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_ffi → ms_uia}/button.rb

@@ -1,6 +1,6 @@
 module RAutomation
   module Adapter
-    module WinFfi
+    module MsUia
       class Button < Control
         include WaitHelper
         include Locators
@@ -8,13 +8,14 @@ module RAutomation
         # Default locators used for searching buttons.
         DEFAULT_LOCATORS = {:class => /button/i}
 
+        #todo - replace with UIA version
         # @see RAutomation::Button#value
         def value
           Functions.control_value(Functions.control_hwnd(@window.hwnd, @locators))
         end
 
         def exist?
-          @locators[:id].nil? ? super : super && matches_type(Constants::UIA_BUTTON_CONTROL_TYPE)
+          super && matches_type?(Constants::UIA_BUTTON_CONTROL_TYPE)
         end
 
         alias_method :exists?, :exist?

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

@@ -0,0 +1,25 @@
+module RAutomation
+  module Adapter
+    module MsUia
+      module ButtonHelper
+
+        #todo - replace with UIA version
+        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/ms_uia/checkbox.rb

@@ -0,0 +1,27 @@
+module RAutomation
+  module Adapter
+    module MsUia
+      class Checkbox < Control
+        include WaitHelper
+        include Locators
+        include ButtonHelper
+
+        def value
+          hwnd = Functions.control_hwnd(@window.hwnd, @locators)
+          checkbox = UiaDll::element_from_handle(hwnd)
+
+          checkbox_value = FFI::MemoryPointer.new :char, UiaDll::get_name(checkbox, nil) + 1
+          UiaDll::get_name(checkbox, checkbox_value)
+          checkbox_value.read_string
+        end
+
+        def exist?
+          super && matches_type?(Constants::UIA_CHECKBOX_CONTROL_TYPE)
+        end
+
+        alias_method :exists?, :exist?
+
+      end
+    end
+  end
+end

data/lib/rautomation/adapter/{win_ffi → ms_uia}/constants.rb

@@ -1,7 +1,6 @@
 module RAutomation
   module Adapter
-    module WinFfi
-      # @private
+    module MsUia
       module Constants
         WM_GETTEXT = 0xD
         WM_SETTEXT = 0xC
@@ -50,6 +49,8 @@ module RAutomation
         VK_NUMLOCK = 0x90
         VK_DELETE = 0x2E
         VK_INSERT = 0x2D
+        VK_NEXT = 0x22
+        VK_PRIOR = 0x21
 
         # GetWindow constants
         GW_ENABLEDPOPUP = 6
@@ -65,11 +66,23 @@ module RAutomation
 
         # 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
+        CB_SETTOPINDEX = 0x015c
+
+        #ListBox
+        LB_SETTOPINDEX   = 0x0197
+        LB_GETITEMHEIGHT = 0x01A1
+        LB_GETITEMRECT   = 0x0198
+        LB_GETTOPINDEX   = 0x018E
 
         # listview
         LVM_FIRST = 0x1000
@@ -78,15 +91,17 @@ module RAutomation
         # UI Automation control type IDs
         UIA_LIST_CONTROL_TYPE = 50008
         UIA_LIST_ITEM_CONTROL_TYPE = 50007
+        UIA_DATA_ITEM_CONTROL_TYPE =50029
         UIA_CHECKBOX_CONTROL_TYPE = 50002
         UIA_BUTTON_CONTROL_TYPE = 50000
-        UIA_LABEL_CONTROL_TYPE = 50020
+        UIA_TEXT_CONTROL_TYPE = 50020
         UIA_RADIO_BUTTON_CONTROL_TYPE = 50013
         UIA_COMBOBOX_CONTROL_TYPE = 50003
         UIA_EDIT_CONTROL_TYPE = 50004
         UIA_HEADER_CONTROL_TYPE = 50034
-        UIA_HEADER_ITEM_CONTROL_TYPE	=	50035
-
+        UIA_HEADER_ITEM_CONTROL_TYPE = 50035
+        UIA_WINDOW_CONTROL_TYPE = 50032
+        UIA_PANE_CONTROL_TYPE = 50033
 
       end
     end

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

@@ -0,0 +1,180 @@
+module RAutomation
+  module Adapter
+    module MsUia
+      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, Fixnum] :id Internal ID of the button
+        # @option locators [String, Fixnum] :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
+
+        #todo - replace with UIA version
+        def hwnd
+          Functions.control_hwnd(@window.hwnd, @locators)
+        end
+
+        def uia_element
+#          puts "finding element with #{@locators.inspect}"
+
+          case
+            #Causes a bug for some reason
+#            when @locators[:value]
+#              uia_window = UiaDll::element_from_handle(@window.hwnd)
+#              begin
+#                uia_window.read_pointer
+#              rescue FFI::NullPointerError => e
+#                raise UnknownElementException, "Window with handle #{@window.hwnd} does not exist"
+#              end
+#              uia_control = UiaDll::find_child_by_name(uia_window, @locators[:value].to_s)
+#              begin
+#                uia_control.read_pointer
+#              rescue FFI::NullPointerError => e
+#                raise UnknownElementException, "#{@locators[:value]} does not exist"
+#              end
+            when @locators[:focus]
+              uia_control = UiaDll::get_focused_element
+              begin
+                uia_control.read_pointer
+              rescue FFI::NullPointerError => e
+                raise UnknownElementException, "Focused element does not exist"
+              end
+            when @locators[:id]
+              uia_window = UiaDll::element_from_handle(@window.hwnd)
+              uia_control = UiaDll::find_child_by_id(uia_window, @locators[:id].to_s)
+              begin
+                uia_control.read_pointer
+              rescue FFI::NullPointerError => e
+                raise UnknownElementException, "#{@locators[:id]} does not exist"
+              end
+            when @locators[:point]
+              uia_control = UiaDll::element_from_point(@locators[:point][0], @locators[:point][1])
+              begin
+                uia_control.read_pointer
+              rescue FFI::NullPointerError => e
+                raise UnknownElementException, "#{@locators[:point]} does not exist"
+              end
+            else
+              handle= hwnd
+              raise UnknownElementException, "Element with #{@locators.inspect} does not exist" if (handle == 0) or (handle == nil)
+              uia_control = UiaDll::element_from_handle(handle)
+          end
+          uia_control
+        end
+
+
+        #todo - replace with UIA version
+        def click
+          assert_enabled
+          clicked = false
+          wait_until do
+            @window.activate
+            @window.active? &&
+                Functions.set_control_focus(hwnd) &&
+                Functions.control_click(hwnd) &&
+                clicked = true # is clicked at least once
+
+            block_given? ? yield : clicked && !exist?
+          end
+        end
+
+        def exist?
+          begin
+            !!uia_element
+          rescue UnknownElementException
+            false
+          end
+        end
+
+        def enabled?
+          !disabled?
+        end
+
+        #todo - replace with UIA version
+        def disabled?
+          Functions.unavailable?(hwnd)
+        end
+
+        #todo - replace with UIA version
+        def has_focus?
+          Functions.has_focus?(hwnd)
+        end
+
+        def set_focus
+          assert_enabled
+          uia_control = UiaDll::element_from_handle(hwnd)
+          UiaDll::set_focus(uia_control)
+        end
+
+        def bounding_rectangle
+          control = uia_element
+
+          boundary = FFI::MemoryPointer.new :long, 4
+          UiaDll::bounding_rectangle(control, boundary)
+
+          boundary.read_array_of_long(4)
+        end
+
+        def visible?
+          element = UiaDll::element_from_handle(hwnd)
+
+          off_screen = FFI::MemoryPointer.new :int
+
+          if UiaDll::is_offscreen(element, off_screen) == 0
+            fail "Could not check element"
+          end
+
+#          puts "return #{off_screen.read_int}"
+          if off_screen.read_int == 0
+            return true
+          end
+          false
+        end
+
+        def matches_type?(clazz)
+          get_current_control_type == clazz
+        end
+
+        def get_current_control_type
+          UiaDll::current_control_type(uia_element)
+        end
+
+        def new_pid
+          UiaDll::current_process_id(uia_element)
+        end
+
+        def control_name
+          uia_control = uia_element
+          element_name = FFI::MemoryPointer.new :char, UiaDll::get_name(uia_control, nil) + 1
+
+          UiaDll::get_name(uia_control, element_name)
+          element_name.read_string
+        end
+
+        def control_class
+          uia_control = uia_element
+          element_class = FFI::MemoryPointer.new :char, UiaDll::get_class_name(uia_control, nil) + 1
+
+          UiaDll::get_class_name(uia_control, element_class)
+          element_class.read_string
+        end
+
+        alias_method :exists?, :exist?
+
+        def assert_enabled
+          raise "Cannot interact with disabled control #{@locators.inspect} on window #{@window.locators.inspect}!" if disabled?
+        end
+      end
+    end
+  end
+end