pit-rayの備忘録

知識のあうとぷっと

MinGWでUI Automationを使う (CMake, MinGW-w64, uiautomationclient.h)

 C++のコンパイラを自由に選べる環境ならば、GNUのg++を利用したいと考えている人は少なくないかと思います。Windowsでは、MinGWやCygwinなどを利用することになると思いますが、付属されているWindows SDKが完全なモノとは限りません。今回は頻繁に利用されないWindows APIを利用し、不完全ゆえのエラーが出力された時の対策を考えます。

Microsoft UI Automation

 Microsoft UI Automation (UIA) は、プログラムからWindowsのGUIのコンポーネントを操作するためのAPIです。前身であるMicrosoft Active Accessibility (MSAA)は、身体的または認知的困難を持つ障碍者やアプリケーションの自動化のためにWindows 95から導入されています。身近なものだと、Windowsのナレーター機能などがあります。ナレーションをするには、UIを認識する必要があるわけです。UIAとMSAAはどちらもComponent Object Model(COM)に基づいています。

参考
docs.microsoft.com

問題

 Mingw-w64にて、次のように、単にインクルードしたところ、宣言・定義されていないとのエラーを大量に吐かれました。

#include <uiautomationclient.h>

 そこで、MinGWのuiautomationclient.h (MinGW/x86_64-w64-mingw32/include)を参照したところ、マクロの羅列ばかりで実装が不完全でした。

2015年にも同様の報告があります。
sourceforge.net
最新のMinGWとMinGW-w64のソースコードを確認しましたが、未だ実装されていません。

対策

 公式で提供されているWindows SDKを利用するのが手っ取り早いので、CMakeでWindows SDKを検出し、MinGWと使い分けるようにインクルードします。

Windows SDKは次のリンクからインストールできます。
developer.microsoft.com

CMakeでは、WindowsのレジストリからWindows SDKのパスを読み出して、最新のWindows SDKのパスの検出を行うようにします。

# CMake
set(WINDOWS_SDK_INCLUDE_DIR "")
if("${WINDOWS_SDK_INCLUDE_DIR}" STREQUAL "")
    get_filename_component(WINDOWS_SDK_ROOT_DIR "[HKEY_LOCAL_MACHINE\\SOFTWARE\\WOW6432Node\\Microsoft\\Windows Kits\\Installed Roots;KitsRoot10]" REALPATH)
    file(GLOB WINDOWS_SDK_INCS LIST_DIRECTORIES true "${WINDOWS_SDK_ROOT_DIR}/Include/10.0.*.*")
    list(SORT WINDOWS_SDK_INCS ORDER DESCENDING)
    list(GET WINDOWS_SDK_INCS 0 WINDOWS_SDK_INCLUDE_DIR)
endif()
if(NOT EXISTS ${WINDOWS_SDK_INCLUDE_DIR})
    message(FATAL_ERROR "Could not find the directory; ${WINDOWS_SDK_INCLUDE_DIR}. You can fix by the cmake flag; -DWINDOWS_SDK_INCLUDE_DIR=<Path>")
endif()
message(STATUS "Detected Windows SDK: ${WINDOWS_SDK_INCLUDE_DIR}")

以上で、${WINDOWS_SDK_INCLUDE_DIR}に次のような値が得られます。

C:/Program Files (x86)/Windows Kits/10/Include/10.0.19041.0

したがって、${WINDOWS_SDK_INCLUDE_DIR}include_directoriesで読み込むことで、次のようにMinGWのものと区別してuiautomationclient.hを読み込むことができます。

#include <um/uiautomationclient.h>

 

UI AutomationのGUID

 先ほどの手順でuiautomationclient.hを読み込むことはできますが、COMオブジェクトが必要とするGUIDが定義されていないため、CLSID_CUIAutomationIID_CUIAutomationなどでリンクエラーが生じると思います。

対策1: Windows SDKのGUIDをまとめたライブラリをリンクする

 先ほどインクルードしたWindows SDKのlibディレクトリのlibuuid.libというライブラリをリンクします。ただ、プロジェクトによってはその他のライブラリと競合し、multiple definitionとしてリンクエラーを吐かれることがあります。私は、wxWidgetsと併用してuuidライブラリをリンクしたところ、定義の重複が生じました。その際、リンカに--allow-multiple-definitionオプションを渡すことでリンクすることができます。

対策2: GUIDを定義する

 GUIDは、基本的に一意な128 bitの定数なので、自前で定義することも可能です。WindowsのGUIDは以下のデータベースで検索することができます。
www.magnumdb.com

これにより、次のように定義が可能です。

#include <initguid.h>

DEFINE_GUID(IID_IUIAutomation,   0x30cbe57d, 0xd9d0, 0x452a, 0xab, 0x13, 0x7a, 0xc5, 0xac, 0x48, 0x25, 0xee) ;
DEFINE_GUID(CLSID_CUIAutomation, 0xff48dba4, 0x60ef, 0x4201, 0xaa, 0x87, 0x54, 0x10, 0x3e, 0xef, 0x59, 0x4e) ;


参考になれば幸いです。