uia 0.2.1 → 0.3

data/ChangeLog

@@ -1,3 +1,7 @@
+=== Version 0.3 /2014-05-06
+*   Enhancements
+    *   added the ability to list more than one pattern to search for
+
 === Version 0.2.1 / 2014-04-30
 *   Bug Fixes
     *   fixes issue with using the :control_type condition with multiple types allowed (i.e. [:button, :list])

data/ext/UiaDll/UIA.Helper/Element.cs

@@ -48,12 +48,12 @@ namespace UIA.Helper
             get { return _element.GetRuntimeId(); }
         }
 
-        public virtual long[] BoundingRectangle
+        public virtual int[] BoundingRectangle
         {
             get
             {
                 var r = _element.Current.BoundingRectangle;
-                return new[] { (long)r.Left, (long)r.Top, (long)(r.Right - r.Left), (long)(r.Bottom - r.Top) };
+                return new[] { (int)r.Left, (int)r.Top, (int)(r.Right - r.Left), (int)(r.Bottom - r.Top) };
             }
         }
 

data/ext/UiaDll/UIA.Helper/Extensions.cs

@@ -16,7 +16,7 @@ namespace UIA.Helper
 
         public static Point Center(this Rect rectangle)
         {
-            if( rectangle == Rect.Empty )
+            if (rectangle == Rect.Empty)
                 throw new Exception("No point could be found");
 
             return new Point(rectangle.Left + rectangle.Width / 2, rectangle.Top + rectangle.Height / 2);
@@ -34,6 +34,16 @@ namespace UIA.Helper
         {
             return new PropertyCondition(AutomationElement.NameProperty, name);
         }
+
+        public static int PropertyId(this string propertyName)
+        {
+            var automationField = typeof(AutomationElement).GetField(propertyName);
+
+            if (null == automationField)
+                throw new ArgumentException(string.Format("{0} is not a valid AutomationProperty", propertyName));
+
+            return ((AutomationProperty)automationField.GetValue(null)).Id;
+        }
     }
 
     public static class ElementExtensions
@@ -49,7 +59,8 @@ namespace UIA.Helper
                     Thread.Sleep(100);
                 }
                 return automationElement.Current.HasKeyboardFocus;
-            } catch { return false; }
+            }
+            catch { return false; }
         }
 
         public static bool ScrollToIfPossible(this AutomationElement automationElement)

data/ext/UiaDll/UiaDll.Test/ElementStub.h

@@ -51,9 +51,9 @@ public:
     array<int>^ get() override { return _runtimeIds; }
   }
 
-  virtual property array<long long>^ BoundingRectangle
+  virtual property array<int>^ BoundingRectangle
   {
-    array<long long>^ get() override { return gcnew array<long long> {0, 0, 0, 0}; }
+    array<int>^ get() override { return gcnew array<int> {0, 0, 0, 0}; }
   }
 
   virtual property int NativeWindowHandle

data/ext/UiaDll/UiaDll.Test/SearchConditionTest.cpp

@@ -1,26 +1,26 @@
 #include "stdafx.h"
-#include <ElementStructures.h>
+#include <SearchCondition.h>
 
-TEST(Conditions_HaveIds)
+TEST(Conditions, HaveIds)
 {
   auto condition = SearchCondition(123, 0);
   ASSERT_EQ(123, condition.propertyId);
 }
 
-TEST(Conditions_CanBeNumbers)
+TEST(Conditions, CanBeNumbers)
 {
   auto condition = SearchCondition(0, 456);
   ASSERT_EQ(456, condition.number);
 }
 
-TEST(Conditions_CanBeStrings)
+TEST(Conditions, CanBeStrings)
 {
   auto condition = SearchCondition(0, "expected value");
   ASSERT_STREQ("expected value", condition.string);
   ASSERT_TRUE(condition.IsString());
 }
 
-TEST(Conditions_CanHaveMultipleNumbers)
+TEST(Conditions, CanHaveMultipleNumbers)
 {
   list<const int> numbers;
   numbers.push_back(7);
@@ -32,3 +32,16 @@ TEST(Conditions_CanHaveMultipleNumbers)
   ASSERT_EQ(6, condition.numbers[1]);
   ASSERT_TRUE(condition.HasNumbers());
 }
+
+TEST(Conditions, CanBePatterns)
+{
+  list<const int> patterns;
+  patterns.push_back(123);
+  patterns.push_back(456);
+
+  auto condition = SearchCondition(patterns);
+  ASSERT_EQ(2, condition.patternsCount);
+  ASSERT_EQ(123, condition.patterns[0]);
+  ASSERT_EQ(456, condition.patterns[1]);
+  ASSERT_TRUE(condition.IsPattern());
+}

data/ext/UiaDll/UiaDll.Test/stdafx.h

@@ -4,4 +4,4 @@
 #include <gmock\gmock.h>
 
 using namespace System;
-using namespace UIA::Helper;
+using namespace UIA::Helper;

data/ext/UiaDll/UiaDll/ConditionHelper.h

@@ -1,6 +1,7 @@
 #pragma once
-#include "ElementStructures.h"
+#include "SearchCondition.h"
 #include <list>
+#include <functional>
 
 using namespace System::Collections::Generic;
 using namespace std;
@@ -27,11 +28,11 @@ public:
     Object^ value = nullptr;
 
     if(automationProperty == AutomationElement::ControlTypeProperty) {
-      return ControlTypeConditions(searchCondition->numbers, searchCondition->numbersCount);
+      return Or(searchCondition->numbers, searchCondition->numbersCount, ControlType);
     } else if(searchCondition->IsString()) {
       value = gcnew String(searchCondition->string);
-    } else if(searchCondition->IsPatternAvailableProperty()) {
-      value = true;
+    } else if(searchCondition->IsPattern()) {
+      return Or(searchCondition->patterns, searchCondition->patternsCount, Pattern);
     } else {
       value = searchCondition->number;
     }
@@ -40,14 +41,14 @@ public:
   }
 
 private:
-  static Condition^ ControlTypeConditions(const int* controlTypeIds, const int controlTypes) {
-    if(controlTypes == 1) {
-      return ControlType(controlTypeIds[0]);
+  static Condition^ Or(const int* ids, const int count, std::function<Condition^(int)> conditionFor) {
+    if( count == 1 ) {
+      return conditionFor(ids[0]);
     }
 
     auto conditions = gcnew List<Condition^>();
-    for(auto index = 0; index < controlTypes; ++index) {
-      conditions->Add(ControlType(controlTypeIds[index]));
+    for(auto index = 0; index < count; ++index) {
+      conditions->Add(conditionFor(ids[index]));
     }
 
     return gcnew OrCondition(conditions->ToArray());
@@ -56,4 +57,8 @@ private:
   static Condition^ ControlType(const int id) {
     return gcnew PropertyCondition(AutomationElement::ControlTypeProperty, ControlType::LookupById(id));
   }
+
+  static Condition^ Pattern(const int patternId) {
+    return gcnew PropertyCondition(AutomationProperty::LookupById(patternId), true);
+  }
 };

data/ext/UiaDll/UiaDll/ConditionMethods.cpp

@@ -15,27 +15,32 @@ extern "C" {
     return new SearchCondition(AutomationElement::NameProperty->Id, name);
   }
 
-  __declspec(dllexport) SearchConditionPtr Condition_Pattern(const char* pattern, char* errorInfo, const int errorInfoLength) {
+   SearchConditionPtr ManagedBuildPatternCondition(list<const char*>& patterns, char* errorInfo, const int errorInfoLength) {
     try {
-      auto patternPropertyId = dynamic_cast<AutomationProperty^>(AutomationElement::typeid->GetField(gcnew String(pattern))->GetValue(nullptr))->Id;
-      return new SearchCondition(patternPropertyId, true);
+      list<const int> patternIds;
+
+      for(auto pattern = patterns.begin(); pattern != patterns.end(); ++pattern) {
+        patternIds.push_back(PropertyExtensions::PropertyId(gcnew String(*pattern)));
+      }
+
+      return new SearchCondition(patternIds);
     } catch(Exception^ e) {
-      StringHelper::CopyToUnmanagedString(String::Format("{0} is an invalid AutomationProperty", gcnew String(pattern)), errorInfo, errorInfoLength);
+      StringHelper::CopyToUnmanagedString(e->Message, errorInfo, errorInfoLength);
       return NULL;
     }
   }
 
-  __declspec(dllexport) SearchConditionPtr Condition_ControlType(const int n, const int arg0, ...) {
-    va_list arguments;
-    va_start(arguments, arg0);
-
-    list<const int> controlTypes;
-    controlTypes.push_back(arg0);
-    for(auto index = 1; index < n; index++) {
-      auto value = va_arg(arguments, int);
-      controlTypes.push_back(value);
-    }
+  #pragma managed(push, off)
+  __declspec(dllexport) SearchConditionPtr Condition_Pattern(char* errorInfo, const int errorInfoLength, const int n, const char* arg0, ...) {
+    GRAB_VARARGS(patterns, const char*, n);
+    return ManagedBuildPatternCondition(patterns, errorInfo, errorInfoLength); 
+  }
+  #pragma managed(pop)
 
+  #pragma managed(push, off)
+  __declspec(dllexport) SearchConditionPtr Condition_ControlType(const int n, const int arg0, ...) {
+    GRAB_VARARGS(controlTypes, const int, n);
     return SearchCondition::FromControlTypes(controlTypes);
   }
+  #pragma managed(pop)
 }

data/ext/UiaDll/UiaDll/ElementMethods.cpp

@@ -42,18 +42,12 @@ extern "C" {
     return NULL;
   }
 
+  #pragma managed(push, off)
   __declspec(dllexport) ElementInformationPtr FindFirst(ElementInformationPtr element, const char* treeScope, char* errorInfo, const int errorInfoLength, const int count, SearchConditionPtr arg0, ...) {
-    va_list arguments;
-    va_start(arguments, arg0);
-
-    list<SearchConditionPtr> conditions;
-    conditions.push_back(arg0);
-    for(auto index = 1; index < count; index++) {
-      conditions.push_back(va_arg(arguments, SearchConditionPtr));
-    }
-
+    GRAB_VARARGS(conditions, SearchConditionPtr, count);
     return ManagedFindFirst(element, treeScope, conditions, errorInfo, errorInfoLength);
   }
+  #pragma managed(pop)
 
   int ManagedFindAll(ElementInformationPtr element, ElementInformation** elements, const char* treeScope, list<SearchConditionPtr>& conditions, char* errorInfo, const int errorInfoLength) {
     try {
@@ -68,18 +62,12 @@ extern "C" {
     return 0;
   }
 
+  #pragma managed(push, off)
   __declspec(dllexport) int FindAll(ElementInformationPtr parent, ElementInformation** elements, const char* treeScope, char* errorInfo, const int errorInfoLength, const int count, SearchConditionPtr arg0, ...) {
-    va_list arguments;
-    va_start(arguments, arg0);
-
-    list<SearchConditionPtr> conditions;
-    conditions.push_back(arg0);
-    for(auto index = 1; index < count; index++) {
-      conditions.push_back(va_arg(arguments, SearchConditionPtr));
-    }
-
+    GRAB_VARARGS(conditions, SearchConditionPtr, count);
     return ManagedFindAll(parent, elements, treeScope, conditions, errorInfo, errorInfoLength);
   }
+  #pragma managed(pop)
 
   __declspec(dllexport) ElementInformationPtr Element_FindById(const char* automationId, char* errorInfo, const int errorLength) {
     try {

data/ext/UiaDll/UiaDll/ElementStructures.h

@@ -2,81 +2,6 @@
 #include "ArrayHelper.h"
 #include "StringHelper.h"
 
-#include <list>
-using namespace std;
-
-typedef struct _SearchCondition {
-  int propertyId;
-
-  int number;
-  char* string;
-  int* numbers;
-  int numbersCount;
-
-  _SearchCondition(const int id) : string(NULL), numbers(NULL) {
-    Reset(id);
-  }
-
-  _SearchCondition(const int id, const char* s) : string(NULL), numbers(NULL) {
-    Reset(id);
-
-    auto length = strnlen_s(s, 10000);
-    auto size = length + 1;
-    this->string = new char[size];
-    strcpy_s(this->string, size, s);
-  }
-
-  _SearchCondition(const int id, const int number) : string(NULL), numbers(NULL) {
-    Reset(id);
-    this->number = number;
-  }
-
-  _SearchCondition(const int id, list<const int>& numbers) : string(NULL), numbers(NULL) {
-    Reset(id);
-    numbersCount = numbers.size();
-    this->numbers = new int[numbersCount];
-
-    int index = 0; 
-    for(std::list<const int>::iterator number = numbers.begin(); number != numbers.end(); ++number, ++index) {
-      this->numbers[index] = *number;
-    }
-  }
-
-  bool HasNumbers() {
-    return NULL != numbers;
-  }
-
-  bool IsString() {
-    return NULL != string;
-  }
-
-  bool IsPatternAvailableProperty() {
-    try {
-      auto automationProperty = System::Windows::Automation::AutomationProperty::LookupById(propertyId);
-      return automationProperty->ProgrammaticName->Contains("PatternAvailableProperty");
-    } catch(Exception^ e) {
-      Console::WriteLine(e->Message);
-      return false;
-    }
-  }
-
-  static _SearchCondition* FromControlTypes(list<const int>& controlTypes) {
-    return new SearchCondition(System::Windows::Automation::AutomationElement::ControlTypeProperty->Id, controlTypes);
-  }
-
-  void Reset(const int id) {
-    propertyId = id;
-    delete[] string; delete[] numbers;
-    string = NULL; numbers = NULL;
-    number = 0; numbersCount = 0;
-  }
-
-  ~_SearchCondition() {
-    Reset(propertyId);
-  }
-
-} SearchCondition, *SearchConditionPtr;
-
 typedef struct _ElementInformation {
   int nativeWindowHandle;
   int* runtimeId;

data/ext/UiaDll/UiaDll/SearchCondition.h

@@ -0,0 +1,83 @@
+#pragma once
+#include <list>
+using namespace std;
+
+typedef struct _SearchCondition {
+  int propertyId;
+
+  int number;
+  char* string;
+  int* numbers;
+  int numbersCount;
+  int* patterns;
+  int patternsCount;
+
+  _SearchCondition(const int id) : string(NULL), numbers(NULL), patterns(NULL) {
+    Reset(id);
+  }
+
+  _SearchCondition(const int id, const char* s) : string(NULL), numbers(NULL), patterns(NULL) {
+    Reset(id);
+
+    auto length = strnlen_s(s, 10000);
+    auto size = length + 1;
+    this->string = new char[size];
+    strcpy_s(this->string, size, s);
+  }
+
+  _SearchCondition(const int id, const int number) : string(NULL), numbers(NULL), patterns(NULL) {
+    Reset(id);
+    this->number = number;
+  }
+
+  _SearchCondition(const int id, list<const int>& numbers) : string(NULL), numbers(NULL), patterns(NULL) {
+    Reset(id);
+    numbersCount = numbers.size();
+    this->numbers = new int[numbersCount];
+
+    int index = 0; 
+    for(list<const int>::iterator number = numbers.begin(); number != numbers.end(); ++number, ++index) {
+      this->numbers[index] = *number;
+    }
+  }
+
+  _SearchCondition(list<const int>& patterns) : string(NULL), numbers(NULL), patterns(NULL) {
+    Reset(patterns.front());
+
+    patternsCount = patterns.size();
+    this->patterns = new int[patternsCount];
+
+    int index = 0;
+    for(std::list<const int>::iterator pattern = patterns.begin(); pattern != patterns.end(); ++pattern, ++index) {
+      this->patterns[index] = * pattern;
+    }
+  }
+
+  bool HasNumbers() {
+    return NULL != numbers;
+  }
+
+  bool IsString() {
+    return NULL != string;
+  }
+
+  bool IsPattern() {
+    return NULL != patterns;
+  }
+
+  static _SearchCondition* FromControlTypes(list<const int>& controlTypes) {
+    return new SearchCondition(System::Windows::Automation::AutomationElement::ControlTypeProperty->Id, controlTypes);
+  }
+
+  void Reset(const int id) {
+    propertyId = id;
+    delete[] string; delete[] numbers; delete[] patterns;
+    string = NULL; numbers = NULL;
+    number = 0; numbersCount = 0; patternsCount = 0;
+  }
+
+  ~_SearchCondition() {
+    Reset(propertyId);
+  }
+
+} SearchCondition, *SearchConditionPtr;

data/ext/UiaDll/UiaDll/Stdafx.h

@@ -13,6 +13,17 @@ using namespace UIA::Helper;
 #include "ArrayHelper.h"
 #include "ElementStructures.h"
 #include "PatternInformationStructures.h"
+#include "SearchCondition.h"
 #include <list>
 
-extern "C" Element^ ElementFrom(ElementInformationPtr element);
+extern "C" Element^ ElementFrom(ElementInformationPtr element);
+
+#define GRAB_VARARGS(argument_list, arg_type, arg_count) \
+  va_list arguments;\
+  va_start(arguments, arg0);\
+  list<##arg_type##> ##argument_list##;\
+  ##argument_list##.push_back(arg0);\
+  for(auto index = 1; index < ##arg_count##; ++index) {\
+    auto value = va_arg(arguments, ##arg_type##);\
+    ##argument_list##.push_back(value);\
+  }

data/ext/UiaDll/UiaDll/UiaDll.vcxproj

@@ -84,6 +84,7 @@
     <ClInclude Include="DynamicAssemblyResolver.h" />
     <ClInclude Include="ElementStructures.h" />
     <ClInclude Include="PatternInformationStructures.h" />
+    <ClInclude Include="SearchCondition.h" />
     <ClInclude Include="Stdafx.h" />
     <ClInclude Include="StringHelper.h" />
   </ItemGroup>

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

@@ -39,6 +39,9 @@
     <ClInclude Include="ConditionHelper.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="SearchCondition.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="UiaDll.cpp">

data/lib/core_ext/array.rb

@@ -0,0 +1,5 @@
+class Array
+  def to_var_args(type)
+    self.flatten.reduce([]) { |a, n| a << type << n }
+  end
+end

data/lib/core_ext/symbol.rb

@@ -3,6 +3,10 @@ class Symbol
     self.to_s.split('_').map(&:capitalize).join(' ')
   end
 
+  def to_pattern_available_property
+    "Is#{self.to_camelized_s.delete(' ')}PatternAvailableProperty"
+  end
+
   # :selection_item => Uia::Patterns::SelectionItem
   def to_pattern_const
     "Uia::Patterns::#{self.to_s.capitalize}".split('::').reduce(Object) do |m, current|

data/lib/uia/library.rb

@@ -69,18 +69,23 @@ module Uia
     ## conditions
     attach_function :release_condition, :Condition_Release, [:pointer], :void
     attach_function :id_condition, :Condition_Id, [:string], SearchCondition.by_ref
-    attach_function :Condition_Pattern, [:string, :pointer, :int], SearchCondition.by_ref
+    attach_function :Condition_Pattern, [:pointer, :int, :int, :varargs], SearchCondition.by_ref
     attach_function :name_condition, :Condition_Name, [:string], SearchCondition.by_ref
     self.singleton_class.send(:alias_method, :value_condition, :name_condition)
     attach_function :Condition_ControlType, [:int, :varargs], SearchCondition.by_ref
 
-    def self.pattern_condition(pattern)
-      can_throw(:Condition_Pattern, "Is#{pattern.to_camelized_s.delete(' ')}PatternAvailableProperty")
+    def self.pattern_condition(*patterns)
+      string_buffer = FFI::MemoryPointer.new :char, 1024
+      pattern_strings = patterns.flatten.map(&:to_pattern_available_property)
+      result = Condition_Pattern string_buffer, 1024, pattern_strings.count, *pattern_strings.to_var_args(:string)
+      error_info = string_buffer.read_string
+      raise error_info unless error_info.empty?
+      result
     end
 
     def self.control_type_condition(*control_types)
-      args = control_types.flatten.map(&:to_control_type_const).reduce([]) { |a, n| a << :int << n }
-      Condition_ControlType args.count, *args
+      control_type_ids = control_types.flatten.map(&:to_control_type_const)
+      Condition_ControlType control_type_ids.count, *control_type_ids.to_var_args(:int)
     end
 
     # element methods
@@ -162,20 +167,18 @@ module Uia
       result
     end
 
-    def self.find_first(element, scope, *args)
+    def self.find_first(element, scope, *conditions)
       string_buffer = FFI::MemoryPointer.new :char, 1024
-      conditions = args.reduce([]) { |a, c| a << :pointer << c }
-      result = FindFirst element, scope, string_buffer, 1024, args.count, *conditions
+      result = FindFirst element, scope, string_buffer, 1024, conditions.count, *conditions.to_var_args(:pointer)
       error_info = string_buffer.read_string
       raise error_info unless error_info.empty?
       Uia::Element.new(result) unless result.empty?
     end
 
-    def self.find_all(element, scope, *args)
+    def self.find_all(element, scope, *conditions)
       elements_pointer = FFI::MemoryPointer.new :pointer
       string_buffer = FFI::MemoryPointer.new :char, 1024
-      conditions = args.reduce([]) { |a, c| a << :pointer << c }
-      result = FindAll element, elements_pointer, scope, string_buffer, 1024, args.count, *conditions
+      result = FindAll element, elements_pointer, scope, string_buffer, 1024, conditions.count, *conditions.to_var_args(:pointer)
       error_info = string_buffer.read_string
       raise error_info unless error_info.empty?
       result.times.collect do |which_element|

data/lib/uia/version.rb

@@ -1,3 +1,3 @@
 module Uia
-  VERSION = '0.2.1'
+  VERSION = '0.3'
 end

data/spec/uia/element_spec.rb

@@ -124,6 +124,8 @@ describe Uia::Element do
 
     context 'pattern' do
       Then { element.find(pattern: :range_value).id == 'numericUpDown1' }
+      Then { element.find(pattern: [:selection_item, :range_value]).id == 'numericUpDown1' }
+      Then { expect { element.find(pattern: [:not_valid, :range_value]) }.to raise_error RuntimeError, 'IsNotValidPatternAvailableProperty is not a valid AutomationProperty' }
     end
 
     context 'combinations' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uia
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: '0.3'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-30 00:00:00.000000000 Z
+date: 2014-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -176,6 +176,7 @@ files:
 - ext/UiaDll/UiaDll/PatternInformationStructures.h
 - ext/UiaDll/UiaDll/RangeValueMethods.cpp
 - ext/UiaDll/UiaDll/ReadMe.txt
+- ext/UiaDll/UiaDll/SearchCondition.h
 - ext/UiaDll/UiaDll/SelectionItemMethods.cpp
 - ext/UiaDll/UiaDll/SelectionMethods.cpp
 - ext/UiaDll/UiaDll/Stdafx.cpp
@@ -192,6 +193,7 @@ files:
 - ext/UiaDll/UiaDll/ValuePatternMethods.cpp
 - ext/UiaDll/UiaDll/WindowMethods.cpp
 - ext/UiaDll/UiaDll/app.rc
+- lib/core_ext/array.rb
 - lib/core_ext/string.rb
 - lib/core_ext/symbol.rb
 - lib/uia.rb
@@ -255,7 +257,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -475586851
+      hash: 914295965
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -264,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -475586851
+      hash: 914295965
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.28