uia 0.0.4 → 0.0.5

data/ext/UiaDll/UiaDll/StringHelper.h

@@ -5,7 +5,21 @@ using namespace System::Runtime::InteropServices;
 ref class StringHelper
 {
 public:
-  static void CopyToUnmanagedString(String^ source, char* destination, const int destinationSize);
-  static char* ToUnmanaged(String^ string);
+  static void CopyToUnmanagedString(String^ source, char* destination, const int destinationSize)
+  {
+    auto unmanagedString = Marshal::StringToHGlobalAnsi(source);
+    strncpy_s(destination, destinationSize, (const char*)(void*)unmanagedString,  _TRUNCATE);
+    Marshal::FreeHGlobal(unmanagedString);
+  }
+
+  static char* ToUnmanaged(String^ source)
+  {
+    if( nullptr == source ) return NULL;
+
+    const int numberOfBytes = source->Length + 1;
+    auto unmanagedString = new char[numberOfBytes];
+    CopyToUnmanagedString(source, unmanagedString, numberOfBytes);
+    return unmanagedString;
+  }
 };
 

data/ext/UiaDll/UiaDll/UiaDll.vcxproj

@@ -83,7 +83,6 @@
     <ClInclude Include="StringHelper.h" />
   </ItemGroup>
   <ItemGroup>
-    <ClCompile Include="ArrayHelper.cpp" />
     <ClCompile Include="AssemblyInfo.cpp" />
     <ClCompile Include="DynamicAssemblyResolver.cpp" />
     <ClCompile Include="ElementMethods.cpp" />
@@ -91,7 +90,6 @@
       <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">Create</PrecompiledHeader>
       <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">Create</PrecompiledHeader>
     </ClCompile>
-    <ClCompile Include="StringHelper.cpp" />
     <ClCompile Include="UiaDll.cpp" />
   </ItemGroup>
   <ItemGroup>

data/ext/UiaDll/UiaDll/UiaDll.vcxproj.filters

@@ -47,11 +47,5 @@
     <ClCompile Include="ElementMethods.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
-    <ClCompile Include="StringHelper.cpp">
-      <Filter>Source Files</Filter>
-    </ClCompile>
-    <ClCompile Include="ArrayHelper.cpp">
-      <Filter>Source Files</Filter>
-    </ClCompile>
   </ItemGroup>
 </Project>

data/lib/uia.rb

@@ -1,117 +1,23 @@
-require 'uia/version'
-require 'ffi'
-
-module Uia
-  extend FFI::Library
-
-  module ElementLayout
-    def self.included(base)
-      base.class_eval do
-        layout :handle, :int,
-               :runtime_id, :pointer,
-               :number_of_ids, :int,
-               :name, :string
-
-        def handle
-          self[:handle]
-        end
-
-        def runtime_id
-          self[:runtime_id].read_array_of_int(number_of_ids)
-        end
-
-        def number_of_ids
-          self[:number_of_ids]
-        end
-
-        def children(type=nil)
-          elements = (type && Uia.children_of_type(self, type)) || Uia.children(self)
-          elements.children
-        end
-
-        def name
-          self[:name]
-        end
-
-        def click
-          Uia.click(self)
-        end
-      end
-    end
-  end
-
-  class ElementStruct < FFI::ManagedStruct
-    include ElementLayout
-
-    def self.release(pointer)
-      Uia.release_element(pointer)
-    end
-  end
-
-  class ElementCast < FFI::Struct
-    include ElementLayout
-  end
-
-  class ElementChildrenStruct < FFI::ManagedStruct
-    layout :length, :int,
-           :items, :pointer
-
-    def children
-      @children ||= self[:length].times.collect do |i|
-        ElementCast.new(self[:items] + i * ElementCast.size)
-      end
-    end
-
-    def self.release(pointer)
-      Uia.release_elements(pointer)
-    end
-  end
-
-  def self.uia_directory
-    File.dirname(__FILE__) + '/../ext/UiaDll/Release'
-  end
-
-  ffi_lib File.join(uia_directory, 'UiaDll.dll')
-  ffi_convention :stdcall
-
-  attach_function :init, :initialize, [:string], :void
-  init(uia_directory)
-
-  PropertyId = enum(:is_selection_item, 0)
-
-
-  def self.attach_throwable_function(name_alias, name, arg_types, return_type)
-    attach_function name, arg_types + [:pointer, :int], return_type
-    define_singleton_method(name_alias) do |*args|
-      can_throw(name, *args)
-    end
-  end
-
-  # cleanup
-  attach_function :release_element, :Element_Release, [:pointer], :void
-  attach_function :release_elements, :Element_ReleaseMany, [:pointer], :void
-
-  # finding elements
-  attach_throwable_function :find_by_id, :Element_FindById, [:string], ElementStruct.by_ref
-  attach_throwable_function :find_by_handle, :Element_FindByHandle, [:int], ElementStruct.by_ref
-  attach_function :Element_FindByRuntimeId, [:pointer, :int, :pointer, :int], ElementStruct.by_ref
-
-  # element methods
-  attach_throwable_function :children, :Element_Children, [:pointer], ElementChildrenStruct.by_ref
-  attach_throwable_function :children_of_type, :Element_ChildrenOfType, [:pointer, PropertyId], ElementChildrenStruct.by_ref
-  attach_throwable_function :click, :Element_Click, [:pointer], :void
-
-  def self.find_by_runtime_id(id)
-    p = FFI::MemoryPointer.new :int, id.count
-    p.write_array_of_int(id)
-    can_throw(:Element_FindByRuntimeId, p, id.count)
-  end
-
-  def self.can_throw(method, *args)
-    string_buffer = FFI::MemoryPointer.new :char, 1024
-    result = send method, *(args << string_buffer << 1024)
-    error_info = string_buffer.read_string
-    raise error_info unless error_info.empty?
-    result
-  end
-end
+require 'uia/version'
+require 'uia/library'
+require 'uia/element'
+require 'uia/library/constants'
+
+module Uia
+  class BadLocator < StandardError; end
+
+  def find_element(how)
+    case
+      when how[:id]
+        Element.new Library.find_by_id(how[:id])
+      when how[:pid]
+        Element.new Library.find_by_pid(how[:pid])
+      when how[:runtime_id]
+        Element.new Library.find_by_runtime_id(how[:runtime_id])
+      when how[:handle]
+        Element.new Library.find_by_handle(how[:handle])
+      else
+        raise BadLocator, "#{how} is not a valid locator"
+    end
+  end
+end

data/lib/uia/element.rb

@@ -0,0 +1,38 @@
+module Uia
+  class Element
+    def initialize(element)
+      @element = element
+      @default = lambda { [:unknown] }
+    end
+
+    def control_type
+      Library::Constants::ControlTypes.find(@default) { |_, v| v == control_type_id }.first
+    end
+
+    def patterns
+      pattern_ids.map do |id|
+        Library::Constants::Patterns.find(@default) { |_, v| v == id }.first
+      end
+    end
+
+    def children
+      @element.children.map { |c| Element.new c }
+    end
+
+    def descendants
+      @element.descendants.map { |c| Element.new c }
+    end
+
+    def click
+      Library.click(@element)
+      true
+    end
+
+    def method_missing(meth, *args, &block)
+      if @element.respond_to? meth
+        return @element.send(meth, *args, &block)
+      end
+      super
+    end
+  end
+end

data/lib/uia/library.rb

@@ -0,0 +1,60 @@
+require 'uia/library/structs'
+require 'ffi'
+
+module Uia
+  module Library
+    extend FFI::Library
+
+    PropertyId = enum(:is_selection_item, 0)
+
+    def self.uia_directory
+      File.dirname(__FILE__) + '/../../ext/UiaDll/Release'
+    end
+
+    ffi_lib File.join(uia_directory, 'UiaDll.dll')
+    ffi_convention :stdcall
+
+    attach_function :init, :initialize, [:string], :void
+    init(uia_directory)
+
+    def self.attach_throwable_function(name_alias, name, arg_types, return_type)
+      attach_function name, arg_types + [:pointer, :int], return_type
+      define_singleton_method(name_alias) do |*args|
+        can_throw(name, *args)
+      end
+    end
+
+    # cleanup
+    attach_function :release_element, :Element_Release, [:pointer], :void
+    attach_function :release_elements, :Element_ReleaseMany, [:pointer], :void
+
+    # finding elements
+    attach_throwable_function :find_by_id, :Element_FindById, [:string], ElementStruct.by_ref
+    attach_throwable_function :find_by_pid, :Element_FindByProcessId, [:int], ElementStruct.by_ref
+    attach_throwable_function :find_by_handle, :Element_FindByHandle, [:int], ElementStruct.by_ref
+    attach_function :Element_FindByRuntimeId, [:pointer, :int, :pointer, :int], ElementStruct.by_ref
+
+    # element methods
+    attach_throwable_function :children, :Element_Children, [:pointer], ElementChildrenStruct.by_ref
+    attach_throwable_function :children_of_type, :Element_ChildrenOfType, [:pointer, PropertyId], ElementChildrenStruct.by_ref
+    attach_throwable_function :descendants, :Element_Descendants, [:pointer], ElementChildrenStruct.by_ref
+    attach_throwable_function :click, :Element_Click, [:pointer], :void
+
+    def self.find_by_runtime_id(id)
+      p = FFI::MemoryPointer.new :int, id.count
+      p.write_array_of_int(id)
+      can_throw(:Element_FindByRuntimeId, p, id.count)
+    end
+
+    def self.can_throw(method, *args)
+      string_buffer = FFI::MemoryPointer.new :char, 1024
+      result = send method, *(args << string_buffer << 1024)
+      error_info = string_buffer.read_string
+      raise error_info unless error_info.empty?
+      result
+    end
+
+  rescue LoadError => e
+    raise LoadError, 'You must install the Visual Studio 2012 C++ Runtime Environment to use the Uia gem (http://www.microsoft.com/en-us/download/details.aspx?id=30679)'
+  end
+end

data/lib/uia/library/constants.rb

@@ -0,0 +1,85 @@
+module Uia
+  module Library
+    module Constants
+      Patterns = {
+          :annotation => 10023,
+          :dock => 10011,
+          :drag => 10030,
+          :drop_target => 10031,
+          :expand_collapse => 10005,
+          :grid_item => 10007,
+          :grid => 10006,
+          :invoke => 10000,
+          :item_container => 10019,
+          :legacy_i_accessible => 10018,
+          :multiple_view => 10008,
+          :object_model => 10022,
+          :range_value => 10003,
+          :scroll_item => 10017,
+          :scroll => 10004,
+          :selection_item => 10010,
+          :selection => 10001,
+          :spreadsheet => 10026,
+          :spreadsheet_item => 10027,
+          :styles => 10025,
+          :synchronized_input => 10021,
+          :table_item => 10013,
+          :table => 10012,
+          :text_child => 10029,
+          :text_edit => 10032,
+          :text => 10014,
+          :text_pattern2 => 10024,
+          :toggle => 10015,
+          :transform => 10016,
+          :transform_pattern2 => 10028,
+          :value => 10002,
+          :virtualized_item => 10020,
+          :window => 10009
+      }
+
+      ControlTypes = {
+          :app_bar => 50040,
+          :button => 50000,
+          :calendar => 50001,
+          :check_box => 50002,
+          :combo_box => 50003,
+          :custom => 50025,
+          :data_grid => 50028,
+          :data_item => 50029,
+          :document => 50030,
+          :edit => 50004,
+          :group => 50026,
+          :header => 50034,
+          :header_item => 50035,
+          :hyperlink => 50005,
+          :image => 50006,
+          :list => 50008,
+          :list_item => 50007,
+          :menu_bar => 50010,
+          :menu => 50009,
+          :menu_item => 50011,
+          :pane => 50033,
+          :progress_bar => 50012,
+          :radio_button => 50013,
+          :scroll_bar => 50014,
+          :semantic_zoom => 50039,
+          :separator => 50038,
+          :slider => 50015,
+          :spinner => 50016,
+          :split_button => 50031,
+          :status_bar => 50017,
+          :tab => 50018,
+          :tab_item => 50019,
+          :table => 50036,
+          :text => 50020,
+          :thumb => 50027,
+          :title_bar => 50037,
+          :tool_bar => 50021,
+          :tool_tip => 50022,
+          :tree => 50023,
+          :tree_item => 50024,
+          :window => 50032
+      }
+    end
+  end
+end

data/lib/uia/library/structs.rb

@@ -0,0 +1,85 @@
+require 'ffi'
+
+module Uia
+  module Library
+    module ElementLayout
+      def self.included(base)
+        base.class_eval do
+          layout :handle, :int,
+                 :runtime_id, :pointer,
+                 :number_of_ids, :int,
+                 :name, :string,
+                 :control_type_id, :int,
+                 :patterns, :pointer,
+                 :patterns_length, :int,
+                 :id, :string
+
+          def id
+            self[:id]
+          end
+
+          def name
+            self[:name]
+          end
+
+          def handle
+            self[:handle]
+          end
+
+          def runtime_id
+            self[:runtime_id].read_array_of_int(number_of_ids)
+          end
+
+          def control_type_id
+            self[:control_type_id]
+          end
+
+          def pattern_ids
+            self[:patterns].read_array_of_int(self[:patterns_length])
+          end
+
+          def children(type=nil)
+            elements = (type && Library.children_of_type(self, type)) || Library.children(self)
+            elements.children
+          end
+
+          def descendants
+            Library.descendants(self).children
+          end
+
+          private
+          def number_of_ids
+            self[:number_of_ids]
+          end
+        end
+      end
+    end
+
+    class ElementStruct < FFI::ManagedStruct
+      include ElementLayout
+
+      def self.release(pointer)
+        Library.release_element(pointer)
+      end
+    end
+
+    class ElementCast < FFI::Struct
+      include ElementLayout
+    end
+
+    class ElementChildrenStruct < FFI::ManagedStruct
+      layout :length, :int,
+             :items, :pointer
+
+      def children
+        @children ||= self[:length].times.collect do |i|
+          ElementCast.new(self[:items] + i * ElementCast.size)
+        end
+      end
+
+      def self.release(pointer)
+        Library.release_elements(pointer)
+      end
+    end
+  end
+end