uia 0.0.5.1 → 0.0.6

data/ChangeLog

@@ -1,8 +1,23 @@
-===	Version 0.0.5.1 / 2012-10-16
+=== Version 0.0.6 / 2013-10-22
+*	Enhancements
+	* Have implemented the following patterns:
+		*	ExpandCollapse
+		*	Invoke
+		*	Selection
+		*	SelectionItem
+		*	Toggle
+		*	Value
+	*	Element can find their descendants by :id or :name
+	*	Can search for top-level elements with Regex
+	*	Elements can be refreshed
+	*	Moved Uia methods to be class-level (i.e. Uia.find_element rather than
+	including Uia)
+
+===	Version 0.0.5.1 / 2013-10-16
 *	Enhancements
 	*	reduced the size of the gem package by excluding gmock and gtest
 
-===	Version 0.0.5 / 2012-10-16
+===	Version 0.0.5 / 2013-10-16
 
 *	Enhancements
 	*	Pushed #find_element into the Uia module

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ruby-uia.gemspec
+gem 'albacore', :git => 'git://github.com/Albacore/albacore.git', :branch => 'clean_slate'
 gemspec

data/Rakefile

@@ -1,6 +1,19 @@
+require 'bundler/setup'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
+require 'albacore'
+require 'albacore/tasks/versionizer'
+
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+task :spec => :build_release
+task :build => :spec
+
+desc 'Build the release version of UiaDll'
+build :build_release do |b|
+  b.sln = 'ext/UiaDll/UiaDll.sln'
+  b.prop :Configuration, :Release
+end

data/ext/UiaDll/UIA.Helper/{AutomationProperty.cs → AutomationPropertyCondition.cs}

@@ -3,7 +3,7 @@ using System.Windows.Automation;
 
 namespace UIA.Helper
 {
-    public class AutomationProperty
+    public class AutomationPropertyCondition
     {
         public enum Id
         {

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

@@ -17,6 +17,11 @@ namespace UIA.Helper
             _element = element;
         }
 
+        public TPattern As<TPattern>(AutomationPattern pattern)
+        {
+            return (TPattern) _element.GetCurrentPattern(pattern);
+        }
+
         public virtual int[] RuntimeId
         {
             get { return _element.GetRuntimeId(); }
@@ -27,11 +32,21 @@ namespace UIA.Helper
             get { return _element.Current.Name; }
         }
 
+        public virtual string ClassName
+        {
+            get { return _element.Current.ClassName; }
+        }
+
         public virtual string Id
         {
             get { return _element.Current.AutomationId; }
         }
 
+        public virtual bool IsEnabled
+        {
+            get { return _element.Current.IsEnabled; }
+        }
+
         public virtual int NativeWindowHandle
         {
             get { return _element.Current.NativeWindowHandle; }
@@ -52,9 +67,9 @@ namespace UIA.Helper
             get { return Find(TreeScope.Children, Condition.TrueCondition); }
         }
 
-        public Element[] ChildrenOf(AutomationProperty.Id id)
+        public Element[] ChildrenOf(AutomationPropertyCondition.Id id)
         {
-            return Find(TreeScope.Children, AutomationProperty.From(id));
+            return Find(TreeScope.Children, AutomationPropertyCondition.From(id));
         }
 
         public Element[] Descendants
@@ -67,9 +82,29 @@ namespace UIA.Helper
             Clicker.MouseClick(_element);
         }
 
+        public static Element From(AutomationElement element)
+        {
+            return new Element(element);
+        }
+
         public static Element ById(string automationId)
         {
-            return FindFirst(new PropertyCondition(AutomationElement.AutomationIdProperty, automationId));
+            return FindFirst(automationId.IdCondition());
+        }
+
+        public Element ChildById(string automationId)
+        {
+            return FindFirst(TreeScope.Descendants, automationId.IdCondition());
+        }
+
+        public static Element ByName(string name)
+        {
+            return FindFirst(new PropertyCondition(AutomationElement.NameProperty, name));
+        }
+
+        public Element ChildByName(string name)
+        {
+            return FindFirst(TreeScope.Descendants, new PropertyCondition(AutomationElement.NameProperty, name));
         }
 
         public static Element ByProcessId(int processId)
@@ -84,7 +119,7 @@ namespace UIA.Helper
 
         public static Element ByRuntimeId(int[] runtimeId)
         {
-            return FindFirst(new PropertyCondition(AutomationElement.RuntimeIdProperty, runtimeId));
+            return FindFirst(new PropertyCondition(AutomationElement.RuntimeIdProperty, runtimeId), TreeScope.Descendants);
         }
 
         private Element[] Find(TreeScope scope, Condition condition)
@@ -94,9 +129,14 @@ namespace UIA.Helper
                            .ToArray();
         }
 
-        private static Element FindFirst(Condition condition)
+        private Element FindFirst(TreeScope scope, Condition condition)
+        {
+            return NullOr(_element.FindFirst(scope, condition));
+        }
+
+        private static Element FindFirst(Condition condition, TreeScope scope = TreeScope.Children)
         {
-            return NullOr(AutomationElement.RootElement.FindFirst(TreeScope.Descendants, condition));
+            return NullOr(AutomationElement.RootElement.FindFirst(scope, condition));
         }
 
         private static Element NullOr(AutomationElement automationElement)

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

@@ -15,6 +15,19 @@ namespace UIA.Helper
         }
     }
 
+    public static class PropertyExtensions
+    {
+        public static Condition IdCondition(this string automationId)
+        {
+            return new PropertyCondition(AutomationElement.AutomationIdProperty, automationId);
+        }
+
+        public static Condition NameCondition(this string name)
+        {
+            return new PropertyCondition(AutomationElement.NameProperty, name);
+        }
+    }
+
     public static class ElementExtensions
     {
 

data/ext/UiaDll/UIA.Helper/UIA.Helper.csproj

@@ -45,7 +45,7 @@
     <Reference Include="WindowsBase" />
   </ItemGroup>
   <ItemGroup>
-    <Compile Include="AutomationProperty.cs" />
+    <Compile Include="AutomationPropertyCondition.cs" />
     <Compile Include="Clicker.cs" />
     <Compile Include="Element.cs" />
     <Compile Include="Extensions.cs" />

data/ext/UiaDll/UiaDll.Test/ElementInformationTest.cpp

@@ -63,6 +63,14 @@ TEST_F(ElementInformationTest, ItKnowsTheControlType)
   ASSERT_EQ(1234, ElementInformation(element).controlTypeId);
 }
 
+TEST_F(ElementInformationTest, ItKnowsTheClassName)
+{
+  auto element = gcnew ElementStub("");
+  element->ClassName = "Expected class name";
+
+  ASSERT_STREQ("Expected class name", ElementInformation(element).className);
+}
+
 TEST_F(ElementInformationTest, ItKnowsTheSupportedPatterns)
 {
   auto element = gcnew ElementStub("");
@@ -74,16 +82,24 @@ TEST_F(ElementInformationTest, ItKnowsTheSupportedPatterns)
   ASSERT_THAT(expectedPatterns, ::testing::ElementsAreArray(elementInformation.patterns, elementInformation.patternsLength));
 }
 
-TEST_F(ElementInformationTest, ItCanBeUpdated)
+TEST_F(ElementInformationTest, ItKnowIfItIsEnabled)
+{
+  auto element = gcnew ElementStub("");
+  element->IsEnabled = true;
+
+  ASSERT_EQ(true, ElementInformation(element).isEnabled);
+}
+
+TEST_F(ElementInformationTest, ItCanBeRefreshed)
 {
   auto elementInformation = ElementInformation(gcnew ElementStub("Initial", 0));
 
-  auto updatedElement = gcnew ElementStub("Updated", 46, 2);
+  auto updatedElement = gcnew ElementStub("Refreshed", 46, 2);
   updatedElement->NativeWindowHandle = 123;
-  elementInformation.Update(updatedElement);
+  elementInformation.Refresh(updatedElement);
 
   const int expectedId[] = {46, 2};
   ASSERT_THAT(expectedId, ::testing::ElementsAreArray(elementInformation.runtimeId, elementInformation.runtimeIdLength));
-  ASSERT_STREQ("Updated", elementInformation.name);
+  ASSERT_STREQ("Refreshed", elementInformation.name);
   ASSERT_EQ(123, elementInformation.nativeWindowHandle);
 }

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

@@ -16,10 +16,22 @@ public:
     void set(String^ name) { _name = name; }
   }
 
+  virtual property String^ ClassName
+  {
+    String^ get() override { return _className; }
+    void set(String^ className) { _className = className; }
+  }
+
   virtual property String^ Id
   {
     String^ get() override { return _id; }
-    void set(String^ value) override { _id = value; }
+    void set(String^ value) { _id = value; }
+  }
+
+  virtual property bool IsEnabled
+  {
+    bool get() override { return _isEnabled; }
+    void set(bool value) { _isEnabled = value; }
   }
 
   virtual property array<int>^ RuntimeId
@@ -36,7 +48,7 @@ public:
   virtual property int ControlTypeId
   {
     int get() override { return _controlTypeId; }
-    void set(int value) override { _controlTypeId = value; }
+    void set(int value) { _controlTypeId = value; }
   }
 
   virtual property array<int>^ SupportedPatternIds
@@ -51,9 +63,11 @@ public:
 
 private:
   String^ _name;
+  String^ _className;
   String^ _id;
   array<int>^ _runtimeIds;
   array<int>^ _patterns;
   int _nativeWindowHandle;
   int _controlTypeId;
+  bool _isEnabled;
 };

data/ext/UiaDll/UiaDll.Test/PatternInformationTest.cpp

@@ -0,0 +1,35 @@
+#include "stdafx.h"
+
+#include <PatternInformationStructures.h>
+#include "ElementStub.h"
+
+TEST(ValueInformation, CanBeInitialized)
+{
+  auto valueInfo = new ValuePatternInformation("Whatever", true);
+  ASSERT_STREQ("Whatever", valueInfo->Value);
+  ASSERT_EQ(true, valueInfo->IsReadOnly);
+  delete valueInfo;
+}
+
+TEST(ToggleInformation, CanBeInitialized)
+{
+  auto toggleInfo = new ToggleInformation("On");
+  ASSERT_STREQ("On", toggleInfo->ToggleState);
+  delete toggleInfo;
+}
+
+TEST(SelectionItemInformation, CanBeInitialized)
+{
+  auto isSelected = true;
+  auto container = gcnew ElementStub("Expected container");
+
+  auto selectionItemInfo = SelectionItemInformation(isSelected, container);
+
+  ASSERT_STREQ("Expected container", selectionItemInfo.Container->name);
+  ASSERT_EQ(true, selectionItemInfo.IsSelected);
+}
+
+TEST(ExpandCollapseInfo, CanBeInitialized) {
+  auto expandCollapseInfo = ExpandCollapseInfo("Collapsed");
+  ASSERT_STREQ("Collapsed", expandCollapseInfo.ExpandCollapseState);
+}

data/ext/UiaDll/UiaDll.Test/UiaDll.Test.vcxproj

@@ -53,13 +53,13 @@
       <Optimization>Disabled</Optimization>
       <PreprocessorDefinitions>WIN32;_VARIADIC_MAX=10;_DEBUG;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <PrecompiledHeader>Use</PrecompiledHeader>
-      <AdditionalIncludeDirectories>C:\Users\Levi\git\northwoods\uia\ext\UiaDll\UiaDll.Test\gmock\include;C:\Users\Levi\git\northwoods\uia\ext\UiaDll\UiaDll;C:\Users\Levi\git\northwoods\uia\ext\UiaDll\UiaDll.Test\gtest\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>C:\Users\Levi\git\northwoods\uia\ext\UiaDll\UiaDll.Test\vendor\gmock\include;C:\Users\Levi\git\northwoods\uia\ext\UiaDll\UiaDll;C:\Users\Levi\git\northwoods\uia\ext\UiaDll\UiaDll.Test\vendor\gtest\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
     </ClCompile>
     <Link>
       <GenerateDebugInformation>true</GenerateDebugInformation>
       <AdditionalDependencies>gtestd.lib;gmockd.lib</AdditionalDependencies>
       <SubSystem>Console</SubSystem>
-      <AdditionalLibraryDirectories>C:\Users\Levi\git\northwoods\uia\ext\UiaDll\UiaDll.Test\gmock\lib;C:\Users\Levi\git\northwoods\uia\ext\UiaDll\UiaDll.Test\gtest\lib;%(AdditionalLibraryDirectories)</AdditionalLibraryDirectories>
+      <AdditionalLibraryDirectories>C:\Users\Levi\git\northwoods\uia\ext\UiaDll\UiaDll.Test\vendor\gmock\lib;C:\Users\Levi\git\northwoods\uia\ext\UiaDll\UiaDll.Test\vendor\gtest\lib;%(AdditionalLibraryDirectories)</AdditionalLibraryDirectories>
     </Link>
     <PostBuildEvent>
       <Command>$(TargetPath)</Command>
@@ -70,13 +70,13 @@
       <WarningLevel>Level3</WarningLevel>
       <PreprocessorDefinitions>WIN32;_VARIADIC_MAX=10;NDEBUG;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <PrecompiledHeader>Use</PrecompiledHeader>
-      <AdditionalIncludeDirectories>C:\Users\Levi\git\northwoods\uia\ext\UiaDll\UiaDll.Test\gmock\include;C:\Users\Levi\git\northwoods\uia\ext\UiaDll\UiaDll;C:\Users\Levi\git\northwoods\uia\ext\UiaDll\UiaDll.Test\gtest\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>C:\Users\Levi\git\northwoods\uia\ext\UiaDll\UiaDll.Test\vendor\gmock\include;C:\Users\Levi\git\northwoods\uia\ext\UiaDll\UiaDll;C:\Users\Levi\git\northwoods\uia\ext\UiaDll\UiaDll.Test\vendor\gtest\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
     </ClCompile>
     <Link>
       <GenerateDebugInformation>true</GenerateDebugInformation>
       <AdditionalDependencies>gtest.lib;gmock.lib</AdditionalDependencies>
       <SubSystem>Console</SubSystem>
-      <AdditionalLibraryDirectories>C:\Users\Levi\git\northwoods\uia\ext\UiaDll\UiaDll.Test\gmock\lib;C:\Users\Levi\git\northwoods\uia\ext\UiaDll\UiaDll.Test\gtest\lib;%(AdditionalLibraryDirectories)</AdditionalLibraryDirectories>
+      <AdditionalLibraryDirectories>C:\Users\Levi\git\northwoods\uia\ext\UiaDll\UiaDll.Test\vendor\gmock\lib;C:\Users\Levi\git\northwoods\uia\ext\UiaDll\UiaDll.Test\vendor\gtest\lib;%(AdditionalLibraryDirectories)</AdditionalLibraryDirectories>
     </Link>
     <PostBuildEvent>
       <Command>$(TargetPath)</Command>
@@ -86,6 +86,7 @@
     <Reference Include="System" />
     <Reference Include="System.Data" />
     <Reference Include="System.Xml" />
+    <Reference Include="UIAutomationClient" />
   </ItemGroup>
   <ItemGroup>
     <Text Include="ReadMe.txt" />
@@ -103,6 +104,7 @@
     <ClCompile Include="AssemblyInfo.cpp" />
     <ClCompile Include="ElementInformationTest.cpp" />
     <ClCompile Include="ElementsTest.cpp" />
+    <ClCompile Include="PatternInformationTest.cpp" />
     <ClCompile Include="stdafx.cpp">
       <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">Create</PrecompiledHeader>
       <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">Create</PrecompiledHeader>

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

@@ -58,6 +58,9 @@
     <ClCompile Include="StringHelperTest.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="PatternInformationTest.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <Image Include="app.ico">

data/ext/UiaDll/UiaDll/ElementMethods.cpp

@@ -3,7 +3,7 @@
 using namespace UIA::Helper;
 
 extern "C" {
-  Element^ Find(PElementInformation element) {
+  Element^ Find(ElementInformationPtr element) {
     if( element->nativeWindowHandle > 0 ) {
       return Element::ByHandle(IntPtr(element->nativeWindowHandle));
     }
@@ -11,17 +11,25 @@ extern "C" {
     return Element::ByRuntimeId(ArrayHelper::ToArray(element->runtimeId, element->runtimeIdLength));
   }
 
-  __declspec(dllexport) void Element_Release(PElementInformation elementInformation) {
+  __declspec(dllexport) void Element_Release(ElementInformationPtr elementInformation) {
     delete elementInformation;
   }
 
-  __declspec(dllexport) void Element_ReleaseMany(PElements elements) {
+  __declspec(dllexport) void Element_ReleaseMany(ElementsPtr elements) {
     delete elements;
   }
 
-  __declspec(dllexport) PElementInformation Element_FindById(const char* automationId, char* errorInfo, const int errorLength) {
+  __declspec(dllexport) void Element_Refresh(ElementInformationPtr element, char* errorInfo, const int errorInfoLength) {
     try {
-      return new ElementInformation(Element::ById(gcnew String(automationId)));
+      element->Refresh(Find(element));
+    } catch(Exception^ e) {
+      StringHelper::CopyToUnmanagedString(e->Message, errorInfo, errorInfoLength);
+    }
+  }
+
+  __declspec(dllexport) ElementInformationPtr Element_FindById(const char* automationId, char* errorInfo, const int errorLength) {
+    try {
+      return ElementInformation::From(Element::ById(gcnew String(automationId)));
     } catch(Exception^ error) {
       StringHelper::CopyToUnmanagedString(error->Message, errorInfo, errorLength);
     }
@@ -29,9 +37,9 @@ extern "C" {
     return NULL;
   }
 
-  __declspec(dllexport) PElementInformation Element_FindByProcessId(const int processId, char* errorInfo, const int errorLength) {
+  __declspec(dllexport) ElementInformationPtr Element_FindChildById(ElementInformationPtr parent, const char* automationId, char* errorInfo, const int errorLength) {
     try {
-      return new ElementInformation(Element::ByProcessId(processId));
+      return ElementInformation::From(Find(parent)->ChildById(gcnew String(automationId)));
     } catch(Exception^ error) {
       StringHelper::CopyToUnmanagedString(error->Message, errorInfo, errorLength);
     }
@@ -39,9 +47,9 @@ extern "C" {
     return NULL;
   }
 
-  __declspec(dllexport) PElementInformation Element_FindByHandle(HWND windowHandle, char* errorInfo, const int errorLength) {
+  __declspec(dllexport) ElementInformationPtr Element_FindByName(const char* name, char* errorInfo, const int errorLength) {
     try {
-      return new ElementInformation(Element::ByHandle(IntPtr(windowHandle)));
+      return ElementInformation::From(Element::ByName(gcnew String(name)));
     } catch(Exception^ error) {
       StringHelper::CopyToUnmanagedString(error->Message, errorInfo, errorLength);
     }
@@ -49,39 +57,76 @@ extern "C" {
     return NULL;
   }
 
-  __declspec(dllexport) PElementInformation Element_FindByRuntimeId(const int runtimeIds[], const int numberOfIds, char* errorInfo, const int errorLength) {
+  __declspec(dllexport) ElementInformationPtr Element_FindChildByName(ElementInformationPtr parent, const char* name, char* errorInfo, const int errorLength) {
     try {
-      return new ElementInformation(Element::ByRuntimeId(ArrayHelper::ToArray(runtimeIds, numberOfIds)));
+      return ElementInformation::From(Find(parent)->ChildByName(gcnew String(name)));
     } catch(Exception^ error) {
       StringHelper::CopyToUnmanagedString(error->Message, errorInfo, errorLength);
     }
+
+    return NULL;
   }
 
-  __declspec(dllexport) PElements Element_Children(PElementInformation parentElement, char* errorInfo, const int errorLength) {
+  __declspec(dllexport) ElementInformationPtr Element_FindByProcessId(const int processId, char* errorInfo, const int errorLength) {
     try {
-      return new Elements(Find(parentElement)->Children);
+      return ElementInformation::From(Element::ByProcessId(processId));
+    } catch(Exception^ error) {
+      StringHelper::CopyToUnmanagedString(error->Message, errorInfo, errorLength);
+    }
+
+    return NULL;
+  }
+
+  __declspec(dllexport) ElementInformationPtr Element_FindByHandle(HWND windowHandle, char* errorInfo, const int errorLength) {
+    try {
+      return new ElementInformation(Element::ByHandle(IntPtr(windowHandle)));
+    } catch(Exception^ error) {
+      StringHelper::CopyToUnmanagedString(error->Message, errorInfo, errorLength);
+    }
+
+    return NULL;
+  }
+
+  __declspec(dllexport) ElementInformationPtr Element_FindByRuntimeId(const int runtimeIds[], const int numberOfIds, char* errorInfo, const int errorLength) {
+    try {
+      return ElementInformation::From(Element::ByRuntimeId(ArrayHelper::ToArray(runtimeIds, numberOfIds)));
     } catch(Exception^ error) {
       StringHelper::CopyToUnmanagedString(error->Message, errorInfo, errorLength);
     }
+
+    return NULL;
+  }
+
+  __declspec(dllexport) ElementsPtr Root_Children(char* errorInfo, const int errorInfoLength) {
+    try {
+      return new Elements(Element::From(AutomationElement::RootElement)->Children);
+    } catch(Exception^ e) {
+      StringHelper::CopyToUnmanagedString(e->Message, errorInfo, errorInfoLength);
+      return NULL;
+    }
   }
 
-  __declspec(dllexport) PElements Element_ChildrenOfType(PElementInformation parent, int propertyId, char* errorInfo, const int errorLength) {
+  __declspec(dllexport) ElementsPtr Element_Children(ElementInformationPtr parentElement, char* errorInfo, const int errorLength) {
     try {
-      return new Elements(Find(parent)->ChildrenOf((AutomationProperty::Id)propertyId));
+      return new Elements(Find(parentElement)->Children);
     } catch(Exception^ error) {
       StringHelper::CopyToUnmanagedString(error->Message, errorInfo, errorLength);
     }
+
+    return NULL;
   }
 
-  __declspec(dllexport) PElements Element_Descendants(PElementInformation parentElement, char* errorInfo, const int errorLength) {
+  __declspec(dllexport) ElementsPtr Element_Descendants(ElementInformationPtr parentElement, char* errorInfo, const int errorLength) {
     try {
       return new Elements(Find(parentElement)->Descendants);
     } catch(Exception^ error) {
       StringHelper::CopyToUnmanagedString(error->Message, errorInfo, errorLength);
     }
+
+    return NULL;
   }
 
-  __declspec(dllexport) void Element_Click(PElementInformation element, char* errorInfo, const int errorLength) {
+  __declspec(dllexport) void Element_Click(ElementInformationPtr element, char* errorInfo, const int errorLength) {
     try {
       Find(element)->MouseClick();
     } catch(Exception^ error) {