rautomation 0.4.0 → 0.5.1

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

@@ -0,0 +1,12 @@
+module RAutomation
+  module Adapter
+    module WinFfi
+      class Checkbox < Control
+        include WaitHelper
+        include Locators
+        include ButtonHelper
+
+      end
+    end
+  end
+end

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

@@ -19,6 +19,8 @@ module RAutomation
         PROCESS_ALL_ACCESS = STANDARD_RIGHTS_REQUIRED | SYNCHRONIZE | 0xFFF
 
         BM_CLICK = 0xF5
+        BM_GETSTATE = 0xF2
+        BST_CHECKED = 0x1
 
         # keybd_event constants
         KEYEVENTF_EXTENDEDKEY = 0x1
@@ -26,6 +28,25 @@ module RAutomation
 
         # GetWindow constants
         GW_ENABLEDPOPUP = 6
+
+        # HRESULT
+        S_OK                 = 0
+
+        # IAccessible Button States
+        STATE_SYSTEM_CHECKED = 0x00000010
+
+        # Combobox
+        CB_GETCOUNT = 0x0146
+        CB_GETLBTEXTLEN = 0x0149
+        CB_GETLBTEXT = 0x0148
+        CB_GETCURSEL = 0x0147
+        CB_ERR = -1
+        CB_SETCURSEL = 0x14E
+
+        # listview
+        LVM_FIRST = 0x1000
+        LVM_GETITEMCOUNT = LVM_FIRST + 4
+
       end
     end
   end

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

@@ -0,0 +1,46 @@
+module RAutomation
+  module Adapter
+    module WinFfi
+      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
+
+        def click
+          clicked = false
+          wait_until do
+            hwnd = Functions.control_hwnd(@window.hwnd, @locators)
+
+            @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?
+          !!Functions.control_hwnd(@window.hwnd, @locators)
+        end
+
+        alias_method :exists?, :exist?
+
+      end
+    end
+  end
+end

data/lib/rautomation/adapter/win_ffi/functions.rb

@@ -5,7 +5,8 @@ module RAutomation
       module Functions
         extend FFI::Library
 
-        ffi_lib 'user32', 'kernel32'
+        # TODO once done adapt the path to the DLL (somewhere in the packaged gem)
+        ffi_lib 'user32', 'kernel32', 'ole32', File.dirname(__FILE__) + '/../../../../ext/IAccessibleDLL/Release/iaccessibleDll.dll'
         ffi_convention :stdcall
 
         callback :enum_callback, [:long, :pointer], :bool
@@ -57,6 +58,8 @@ module RAutomation
                         [:long], :long
         attach_function :get_window, :GetWindow,
                         [:long, :uint], :long
+        attach_function :get_last_error, :GetLastError,
+                        [], :long
 
         # kernel32
         attach_function :open_process, :OpenProcess,
@@ -65,8 +68,19 @@ module RAutomation
                         [:long, :uint], :bool
         attach_function :close_handle, :CloseHandle,
                         [:long], :bool
+        attach_function :load_library, :LoadLibraryA,
+                        [:string], :long
+
+        # ole32
+        attach_function :co_initialize, :CoInitialize,
+                        [:pointer], :uint16
+
+        # iaccessible
+        attach_function :get_button_state, :get_button_state,
+                        [:long], :long
 
         class << self
+
           def window_title(hwnd)
             title_length = window_title_length(hwnd) + 1
             title = FFI::MemoryPointer.new :char, title_length
@@ -108,6 +122,20 @@ module RAutomation
             locators
           end
 
+          def child_window_locators(parent_hwnd, locators)
+            child_hwnd = locators[:hwnd] || child_hwnd(parent_hwnd, locators)
+            if child_hwnd
+              locators.merge!(:hwnd => child_hwnd)
+            else
+              popup_hwnd = get_window(parent_hwnd, Constants::GW_ENABLEDPOPUP)
+              if popup_hwnd != parent_hwnd
+                popup_properties = window_properties(popup_hwnd, locators)
+                locators.merge!(:hwnd => popup_hwnd) if locators_match?(locators, popup_properties)
+              end
+            end
+            locators
+          end
+
           def window_pid(hwnd)
             pid = FFI::MemoryPointer.new :int
             window_thread_process_id(hwnd, pid)
@@ -171,6 +199,28 @@ module RAutomation
             send_message(control_hwnd, Constants::WM_SETTEXT, 0, text)
           end
 
+          def control_set?(control_hwnd)
+            get_button_state(control_hwnd) & Constants::STATE_SYSTEM_CHECKED != 0
+          end
+
+          def retrieve_combobox_item_text(control_hwnd, item_no)
+            text_len = send_message(control_hwnd, Constants::CB_GETLBTEXTLEN, item_no, nil)
+
+            string_buffer = FFI::MemoryPointer.new :char, text_len
+            send_message(control_hwnd, Constants::CB_GETLBTEXT, item_no, string_buffer)
+            string_buffer.read_string
+          end
+
+          def control_name(control_hwnd)
+            puts "Trying to get control name for #{control_hwnd}"
+            string_buffer = FFI::MemoryPointer.new :char, 255
+            if (get_control_name(control_hwnd, string_buffer) == Constants::S_OK)
+              string_buffer.read_string
+            else
+              fail "Cannot get name for control with HWND 0x" + control_hwnd.to_s(16)
+            end
+          end
+
           private
 
           def within_foreground_thread(hwnd)
@@ -246,3 +296,4 @@ module RAutomation
     end
   end
 end
+

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

@@ -14,9 +14,10 @@ module RAutomation
 
           # control locator
           locators[:id] = locators[:id].to_i if locators[:id]
+          locators = self.class::DEFAULT_LOCATORS.merge(locators) if self.class.const_defined?(:DEFAULT_LOCATORS)
           @locators = locators
         end
       end
     end
   end
-end
+end

data/lib/rautomation/adapter/win_ffi/radio.rb

@@ -0,0 +1,12 @@
+module RAutomation
+  module Adapter
+    module WinFfi
+      class Radio < Control
+        include WaitHelper
+        include Locators
+        include ButtonHelper
+
+      end
+    end
+  end
+end

data/lib/rautomation/adapter/win_ffi/select_list.rb

@@ -0,0 +1,64 @@
+module RAutomation
+  module Adapter
+    module WinFfi
+
+      class SelectList < Control
+        include WaitHelper
+        include Locators
+
+        class SelectListOption
+          attr_accessor :text, :index, :control_hwnd
+
+          def initialize(control_hwnd, text, index)
+            @control_hwnd = control_hwnd
+            @text = text
+            @index = index
+          end
+
+          def selected?
+            selected_idx = Functions.send_message(@control_hwnd, Constants::CB_GETCURSEL, 0, nil)
+            return false if selected_idx == Constants::CB_ERR
+            @text == Functions.retrieve_combobox_item_text(@control_hwnd, selected_idx)
+          end
+
+          def select
+            Functions.send_message(@control_hwnd, Constants::CB_SETCURSEL, @index, nil) != Constants::CB_ERR
+          end
+        end
+
+        def initialize(window, locators)
+          super
+          @hwnd = Functions.control_hwnd(@window.hwnd, @locators)
+        end
+
+        def options(options = {})
+          items = []
+
+          item_count.times do |item_no|
+            item = Functions.retrieve_combobox_item_text(@hwnd, item_no)
+
+            if options[:text] 
+              items.push(SelectListOption.new(@hwnd, item, item_no)) if options[:text] == item
+            else
+              items.push(SelectListOption.new(@hwnd, item, item_no))
+            end
+          end
+
+          items
+        end
+
+        def value
+          selected_option = options.find {|option| option.selected?}
+          selected_option ? selected_option.text : ""
+        end
+
+        private
+
+        def item_count
+          Functions.send_message(@hwnd, Constants::CB_GETCOUNT, 0, nil)
+        end
+
+      end
+    end
+  end
+end

data/lib/rautomation/adapter/win_ffi/table.rb

@@ -0,0 +1,18 @@
+module RAutomation
+  module Adapter
+    module WinFfi
+      class Table < Control
+        include WaitHelper
+        include Locators
+
+        private
+
+        def row_count
+          Functions.send_message(Functions.control_hwnd(@window.hwnd, @locators), Constants::LVM_GETITEMCOUNT, 0, nil)
+        end
+
+      end
+    end
+  end
+end
+

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

@@ -1,23 +1,12 @@
 module RAutomation
   module Adapter
     module WinFfi
-      class TextField
+      class TextField < Control
         include WaitHelper
         include Locators
 
-        # Creates the text field object.
-        # @note this method is not meant to be accessed directly, but only through {RAutomation::Window#text_field}!
-        # @param [RAutomation::Window] window this text field belongs to.
-        # @param [Hash] locators for searching the text field.
-        # @option locators [String, Regexp] :class Internal class name of the text field
-        # @option locators [String, Regexp] :value Value (text) of the text field
-        # @option locators [String, Fixnum] :id Internal ID of the text field
-        # @option locators [String, Fixnum] :index 0-based index to specify n-th text field if all other criteria match
-        # @see RAutomation::Window#text_field
-        def initialize(window, locators)
-          @window = window
-          extract(locators)
-        end
+        # Default locators used for searching text fields.
+        DEFAULT_LOCATORS = {:class => /edit/i}
 
         # @see RAutomation::TextField#set
         def set(text)
@@ -41,12 +30,7 @@ module RAutomation
           Functions.control_value(Functions.control_hwnd(@window.hwnd, @locators))
         end
 
-        # @see RAutomation::TextField#exists?
-        def exists?
-          !!Functions.control_hwnd(@window.hwnd, @locators)
-        end
-
       end
     end
   end
-end
+end

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

@@ -5,6 +5,19 @@ module RAutomation
         include WaitHelper
         include Locators
 
+        class << self
+          def initialize_com
+            @@oleacc_module_handle = Functions.load_library "oleacc.dll"
+            Functions.co_initialize nil
+          end
+        end
+
+        initialize_com
+
+        def oleacc_module_handle
+          @@oleacc_module_handle
+        end
+
         # Locators of the window.
         attr_reader :locators
 
@@ -105,7 +118,9 @@ module RAutomation
               activate
               active?
             end
+            Functions.send_key(0x12, 0, 0, nil)
             Functions.send_key(key, 0, 0, nil)
+            Functions.send_key(0x12, 0, Constants::KEYEVENTF_KEYUP, nil)
             Functions.send_key(key, 0, Constants::KEYEVENTF_KEYUP, nil)
           end
         end
@@ -133,17 +148,40 @@ module RAutomation
           Functions.respond_to?(name) ? Functions.send(name, *args) : super
         end
 
-        # Creates the child window object.
-        # @note This is an WinFfi 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)
+        # extend public API
+        RAutomation::Window.class_eval do
+          def select_list(locator)
+            wait_until_exists
+            RAutomation::Adapter::WinFfi::SelectList.new(@window, locator)
+          end
+
+          def checkbox(locator)
+            wait_until_exists
+            RAutomation::Adapter::WinFfi::Checkbox.new(@window, locator)
+          end
+
+          def radio(locator)
+            wait_until_exists
+            RAutomation::Adapter::WinFfi::Radio.new(@window, locator)
+          end
+
+          def table(locator)
+            wait_until_exists
+            RAutomation::Adapter::WinFfi::Table.new(@window, locator)
+          end
+
+          # Creates the child window object.
+          # @note This is an WinFfi 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
         end
-        
+
       end
     end
   end

data/lib/rautomation/element_collections.rb

@@ -0,0 +1,44 @@
+module RAutomation
+  # @private
+  module ElementCollections
+    # Creates collection classes and methods for elements.
+    # @param [Array<Symbol>] elements for which to create collection classes
+    #   and methods.
+    def has_many(*elements)
+      elements.each do |element|
+        class_name = element.to_s.split("_").map {|e| e.capitalize}.join
+        RAutomation.class_eval %Q{
+            class #{class_name}
+              include Enumerable
+
+              def initialize(window, locators)
+                @window = window
+                @locators = locators
+              end
+
+              def each
+                i = -1 
+                while true
+                  args = [@window, @locators.merge(:index => i += 1)].compact
+                  object = RAutomation::#{class_name.chop}.new(*args)
+                  break unless object.exists?
+                  yield object
+                end
+              end
+
+              def method_missing(name, *args)
+                ary = self.to_a
+                ary.respond_to?(name) ? ary.send(name, *args) : super
+              end
+            end
+        }
+
+        class_eval %Q{
+            def #{element}(locators = {})
+              #{class_name}.new(@window, locators)
+            end
+        }
+      end
+    end
+  end
+end