uia_utils.c File Reference

#include "uia_private.h"
#include "wine/debug.h"

Include dependency graph for uia_utils.c:

Go to the source code of this file.

Classes
struct	uia_hwnd_map_entry

Macros
#define	UIA_RUNTIME_ID_PREFIX   42

Functions
	WINE_DEFAULT_DEBUG_CHANNEL (uiautomation)
static HRESULT	get_global_interface_table (IGlobalInterfaceTable **git)
HRESULT	register_interface_in_git (IUnknown *iface, REFIID riid, DWORD *ret_cookie)
HRESULT	unregister_interface_in_git (DWORD git_cookie)
HRESULT	get_interface_in_git (REFIID riid, DWORD git_cookie, IUnknown **ret_iface)
HRESULT	write_runtime_id_base (SAFEARRAY *sa, HWND hwnd)
static void	uia_condition_destroy (struct UiaCondition *cond)
static HRESULT	uia_condition_clone (struct UiaCondition **dst, struct UiaCondition *src)
void	uia_cache_request_destroy (struct UiaCacheRequest *cache_req)
HRESULT	uia_cache_request_clone (struct UiaCacheRequest *dst, struct UiaCacheRequest *src)
HRESULT	get_safearray_dim_bounds (SAFEARRAY *sa, UINT dim, LONG *lbound, LONG *elems)
HRESULT	get_safearray_bounds (SAFEARRAY *sa, LONG *lbound, LONG *elems)
int	uia_compare_safearrays (SAFEARRAY *sa1, SAFEARRAY *sa2, int prop_type)
BOOL	uia_hwnd_is_visible (HWND hwnd)
BOOL	uia_is_top_level_hwnd (HWND hwnd)
static int	uia_hwnd_map_hwnd_compare (const void *key, const struct rb_entry *entry)
static void	uia_hwnd_map_free (struct rb_entry *entry, void *context)
BOOL	uia_hwnd_map_check_hwnd (struct rb_tree *hwnd_map, HWND hwnd)
HRESULT	uia_hwnd_map_add_hwnd (struct rb_tree *hwnd_map, HWND hwnd)
void	uia_hwnd_map_remove_hwnd (struct rb_tree *hwnd_map, HWND hwnd)
void	uia_hwnd_map_init (struct rb_tree *hwnd_map)
void	uia_hwnd_map_destroy (struct rb_tree *hwnd_map)

Macro Definition Documentation

UIA_RUNTIME_ID_PREFIX

#define UIA_RUNTIME_ID_PREFIX   42

Definition at line 101 of file uia_utils.c.

Function Documentation

get_global_interface_table()

static HRESULT get_global_interface_table ( IGlobalInterfaceTable **  git )

static

Definition at line 28 of file uia_utils.c.

{
    HRESULT hr;
 
    hr = CoCreateInstance(&CLSID_StdGlobalInterfaceTable, NULL,
            CLSCTX_INPROC_SERVER, &IID_IGlobalInterfaceTable, (void **)git);
    if (FAILED(hr))
        WARN("Failed to get GlobalInterfaceTable, hr %#lx\n", hr);
 
    return hr;
}

Referenced by get_interface_in_git(), register_interface_in_git(), and unregister_interface_in_git().

get_interface_in_git()

HRESULT get_interface_in_git	(	REFIID	riid,
		DWORD	git_cookie,
		IUnknown **	ret_iface
	)

Definition at line 79 of file uia_utils.c.

{
    IGlobalInterfaceTable *git;
    IUnknown *iface;
    HRESULT hr;
 
    hr = get_global_interface_table(&git);
    if (FAILED(hr))
        return hr;
 
    hr = IGlobalInterfaceTable_GetInterfaceFromGlobal(git, git_cookie, riid, (void **)&iface);
    if (FAILED(hr))
    {
        ERR("Failed to get interface from Global Interface Table, hr %#lx\n", hr);
        return hr;
    }
 
    *ret_iface = iface;
 
    return S_OK;
}

Referenced by uia_com_event_callback(), uia_event_advise(), uia_event_adviser_advise(), and uia_node_get_provider().

get_safearray_bounds()

HRESULT get_safearray_bounds	(	SAFEARRAY *	sa,
		LONG *	lbound,
		LONG *	elems
	)

Definition at line 319 of file uia_utils.c.

{
    UINT dims;
 
    *lbound = *elems = 0;
    dims = SafeArrayGetDim(sa);
    if (dims != 1)
    {
        WARN("Invalid dimensions %d for safearray.\n", dims);
        return E_FAIL;
    }
 
    return get_safearray_dim_bounds(sa, 1, lbound, elems);
}

Referenced by append_uia_runtime_id(), create_uia_node_safearray(), get_element_variant_from_node_variant(), uia_compare_safearrays(), uia_element_FindAllBuildCache(), uia_element_FindFirstBuildCache(), uia_get_clientside_provider(), uia_iface_IntSafeArrayToNativeArray(), and uia_provider_attach_event().

get_safearray_dim_bounds()

HRESULT get_safearray_dim_bounds	(	SAFEARRAY *	sa,
		UINT	dim,
		LONG *	lbound,
		LONG *	elems
	)

Definition at line 301 of file uia_utils.c.

{
    LONG ubound;
    HRESULT hr;
 
    *lbound = *elems = 0;
    hr = SafeArrayGetLBound(sa, dim, lbound);
    if (FAILED(hr))
        return hr;
 
    hr = SafeArrayGetUBound(sa, dim, &ubound);
    if (FAILED(hr))
        return hr;
 
    *elems = (ubound - (*lbound)) + 1;
    return S_OK;
}

Referenced by get_safearray_bounds(), uia_cache_request_combine(), and UiaFind().

register_interface_in_git()

HRESULT register_interface_in_git	(	IUnknown *	iface,
		REFIID	riid,
		DWORD *	ret_cookie
	)

Definition at line 40 of file uia_utils.c.

{
    IGlobalInterfaceTable *git;
    DWORD git_cookie;
    HRESULT hr;
 
    *ret_cookie = 0;
    hr = get_global_interface_table(&git);
    if (FAILED(hr))
        return hr;
 
    hr = IGlobalInterfaceTable_RegisterInterfaceInGlobal(git, iface, riid, &git_cookie);
    if (FAILED(hr))
    {
        WARN("Failed to register interface in GlobalInterfaceTable, hr %#lx\n", hr);
        return hr;
    }
 
    *ret_cookie = git_cookie;
 
    return S_OK;
}

Referenced by clone_uia_node(), create_wine_uia_nested_node_provider(), prepare_uia_node(), uia_add_com_event_handler(), uia_event_add_provider_event_adviser(), and uia_event_add_serverside_event_adviser().

uia_cache_request_clone()

HRESULT uia_cache_request_clone	(	struct UiaCacheRequest *	dst,
		struct UiaCacheRequest *	src
	)

Definition at line 264 of file uia_utils.c.

{
    HRESULT hr;
 
    hr = uia_condition_clone(&dst->pViewCondition, src->pViewCondition);
    if (FAILED(hr))
        return hr;
 
    dst->Scope = src->Scope;
    dst->automationElementMode = src->automationElementMode;
    if (src->cProperties)
    {
        if (!(dst->pProperties = calloc(src->cProperties, sizeof(*dst->pProperties))))
        {
            uia_cache_request_destroy(dst);
            return E_OUTOFMEMORY;
        }
 
        dst->cProperties = src->cProperties;
        memcpy(dst->pProperties, src->pProperties, sizeof(*dst->pProperties) * dst->cProperties);
    }
 
    if (src->cPatterns)
    {
        if (!(dst->pPatterns = calloc(src->cPatterns, sizeof(*dst->pPatterns))))
        {
            uia_cache_request_destroy(dst);
            return E_OUTOFMEMORY;
        }
 
        dst->cPatterns = src->cPatterns;
        memcpy(dst->pPatterns, src->pPatterns, sizeof(*dst->pPatterns) * dst->cPatterns);
    }
 
    return S_OK;
}

Referenced by uia_add_clientside_event().

uia_cache_request_destroy()

void uia_cache_request_destroy

(

struct UiaCacheRequest *

cache_req

)

Definition at line 257 of file uia_utils.c.

{
    uia_condition_destroy(cache_req->pViewCondition);
    free(cache_req->pProperties);
    free(cache_req->pPatterns);
}

Referenced by uia_cache_request_clone(), and uia_event_Release().

uia_compare_safearrays()

int uia_compare_safearrays	(	SAFEARRAY *	sa1,
		SAFEARRAY *	sa2,
		int	prop_type
	)

Definition at line 334 of file uia_utils.c.

{
    LONG i, idx, lbound[2], elems[2];
    int val[2];
    HRESULT hr;
 
    hr = get_safearray_bounds(sa1, &lbound[0], &elems[0]);
    if (FAILED(hr))
    {
        ERR("Failed to get safearray bounds from sa1 with hr %#lx\n", hr);
        return -1;
    }
 
    hr = get_safearray_bounds(sa2, &lbound[1], &elems[1]);
    if (FAILED(hr))
    {
        ERR("Failed to get safearray bounds from sa2 with hr %#lx\n", hr);
        return -1;
    }
 
    if (elems[0] != elems[1])
        return (elems[0] > elems[1]) - (elems[0] < elems[1]);
 
    if (prop_type != UIAutomationType_IntArray)
    {
        FIXME("Array type %#x value comparison currently unimplemented.\n", prop_type);
        return -1;
    }
 
    for (i = 0; i < elems[0]; i++)
    {
        idx = lbound[0] + i;
        hr = SafeArrayGetElement(sa1, &idx, &val[0]);
        if (FAILED(hr))
        {
            ERR("Failed to get element from sa1 with hr %#lx\n", hr);
            return -1;
        }
 
        idx = lbound[1] + i;
        hr = SafeArrayGetElement(sa2, &idx, &val[1]);
        if (FAILED(hr))
        {
            ERR("Failed to get element from sa2 with hr %#lx\n", hr);
            return -1;
        }
 
        if (val[0] != val[1])
            return (val[0] > val[1]) - (val[0] < val[1]);
    }
 
    return 0;
}

Referenced by uia_com_event_handler_id_compare(), uia_event_check_node_within_event_scope(), uia_event_map_add_event(), uia_property_condition_check(), and uia_runtime_id_compare().

uia_condition_clone()

static HRESULT uia_condition_clone ( struct UiaCondition **  dst, struct UiaCondition *  src  )

static

Definition at line 163 of file uia_utils.c.

{
    HRESULT hr = S_OK;
 
    *dst = NULL;
    switch (src->ConditionType)
    {
    case ConditionType_True:
    case ConditionType_False:
        if (!(*dst = calloc(1, sizeof(**dst))))
            return E_OUTOFMEMORY;
 
        (*dst)->ConditionType = src->ConditionType;
        break;
 
    case ConditionType_Property:
    {
        struct UiaPropertyCondition *prop_cond = calloc(1, sizeof(*prop_cond));
        struct UiaPropertyCondition *src_cond = (struct UiaPropertyCondition *)src;
 
        if (!prop_cond)
            return E_OUTOFMEMORY;
 
        *dst = (struct UiaCondition *)prop_cond;
        prop_cond->ConditionType = ConditionType_Property;
        prop_cond->PropertyId = src_cond->PropertyId;
        prop_cond->Flags = src_cond->Flags;
        VariantInit(&prop_cond->Value);
        hr = VariantCopy(&prop_cond->Value, &src_cond->Value);
        break;
    }
 
    case ConditionType_Not:
    {
        struct UiaNotCondition *not_cond = calloc(1, sizeof(*not_cond));
        struct UiaNotCondition *src_cond = (struct UiaNotCondition *)src;
 
        if (!not_cond)
            return E_OUTOFMEMORY;
 
        *dst = (struct UiaCondition *)not_cond;
        not_cond->ConditionType = ConditionType_Not;
        hr = uia_condition_clone(&not_cond->pConditions, src_cond->pConditions);
        break;
    }
 
    case ConditionType_And:
    case ConditionType_Or:
    {
        struct UiaAndOrCondition *and_or_cond = calloc(1, sizeof(*and_or_cond));
        struct UiaAndOrCondition *src_cond = (struct UiaAndOrCondition *)src;
        int i;
 
        if (!and_or_cond)
            return E_OUTOFMEMORY;
 
        *dst = (struct UiaCondition *)and_or_cond;
        and_or_cond->ConditionType = src_cond->ConditionType;
        and_or_cond->ppConditions = calloc(src_cond->cConditions, sizeof(*and_or_cond->ppConditions));
        if (!and_or_cond->ppConditions)
        {
            hr = E_OUTOFMEMORY;
            goto exit;
        }
 
        and_or_cond->cConditions = src_cond->cConditions;
        for (i = 0; i < src_cond->cConditions; i++)
        {
            hr = uia_condition_clone(&and_or_cond->ppConditions[i], src_cond->ppConditions[i]);
            if (FAILED(hr))
                goto exit;
        }
 
        break;
    }
 
    default:
        WARN("Tried to clone condition with invalid type %d\n", src->ConditionType);
        return E_INVALIDARG;
    }
 
exit:
    if (FAILED(hr))
    {
        uia_condition_destroy(*dst);
        *dst = NULL;
    }
 
    return hr;
}

Referenced by uia_cache_request_clone(), and uia_condition_clone().

uia_condition_destroy()

static void uia_condition_destroy ( struct UiaCondition *  cond )

static

Definition at line 121 of file uia_utils.c.

{
    if (!cond)
        return;
 
    switch (cond->ConditionType)
    {
    case ConditionType_Property:
    {
        struct UiaPropertyCondition *prop_cond = (struct UiaPropertyCondition *)cond;
 
        VariantClear(&prop_cond->Value);
        break;
    }
 
    case ConditionType_Not:
    {
        struct UiaNotCondition *not_cond = (struct UiaNotCondition *)cond;
 
        uia_condition_destroy(not_cond->pConditions);
        break;
    }
 
    case ConditionType_And:
    case ConditionType_Or:
    {
        struct UiaAndOrCondition *and_or_cond = (struct UiaAndOrCondition *)cond;
        int i;
 
        for (i = 0; i < and_or_cond->cConditions; i++)
            uia_condition_destroy(and_or_cond->ppConditions[i]);
        free(and_or_cond->ppConditions);
        break;
    }
 
    default:
        break;
    }
 
    free(cond);
}

Referenced by uia_cache_request_destroy(), uia_condition_clone(), and uia_condition_destroy().

uia_hwnd_is_visible()

BOOL uia_hwnd_is_visible

(

HWND

hwnd

)

Definition at line 391 of file uia_utils.c.

{
    RECT rect;
 
    if (!IsWindowVisible(hwnd))
        return FALSE;
 
    if (!GetWindowRect(hwnd, &rect))
        return FALSE;
 
    if ((rect.right - rect.left) <= 0 || (rect.bottom - rect.top) <= 0)
        return FALSE;
 
    return TRUE;
}

Referenced by uia_com_win_event_callback(), and uia_win_event_enum_top_level_hwnds().

uia_hwnd_map_add_hwnd()

HRESULT uia_hwnd_map_add_hwnd	(	struct rb_tree *	hwnd_map,
		HWND	hwnd
	)

Definition at line 442 of file uia_utils.c.

{
    struct uia_hwnd_map_entry *entry;
 
    if (uia_hwnd_map_check_hwnd(hwnd_map, hwnd))
    {
        TRACE("hwnd %p already in map %p\n", hwnd, hwnd_map);
        return S_OK;
    }
 
    if (!(entry = calloc(1, sizeof(*entry))))
        return E_OUTOFMEMORY;
 
    TRACE("Adding hwnd %p to map %p\n", hwnd, hwnd_map);
    entry->hwnd = hwnd;
    rb_put(hwnd_map, hwnd, &entry->entry);
 
    return S_OK;
}

Referenced by uia_com_focus_handler_advise_node(), uia_event_add_win_event_hwnd(), and uia_win_event_enum_top_level_hwnds().

uia_hwnd_map_check_hwnd()

BOOL uia_hwnd_map_check_hwnd	(	struct rb_tree *	hwnd_map,
		HWND	hwnd
	)

Definition at line 437 of file uia_utils.c.

{
    return !!rb_get(hwnd_map, hwnd);
}

Referenced by uia_com_focus_win_event_handler(), uia_hwnd_map_add_hwnd(), uia_win_event_for_each_callback(), and uia_win_event_hwnd_map_contains_ancestors().

uia_hwnd_map_destroy()

void uia_hwnd_map_destroy

(

struct rb_tree *

hwnd_map

)

Definition at line 484 of file uia_utils.c.

{
    rb_destroy(hwnd_map, uia_hwnd_map_free, hwnd_map);
}

Referenced by uia_event_handler_destroy(), and uia_event_Release().

uia_hwnd_map_free()

static void uia_hwnd_map_free ( struct rb_entry *  entry, void *  context  )

static

Definition at line 429 of file uia_utils.c.

{
    struct uia_hwnd_map_entry *hwnd_entry = RB_ENTRY_VALUE(entry, struct uia_hwnd_map_entry, entry);
 
    TRACE("Removing hwnd %p from map %p\n", hwnd_entry->hwnd, context);
    free(hwnd_entry);
}

Referenced by uia_hwnd_map_destroy().

uia_hwnd_map_hwnd_compare()

static int uia_hwnd_map_hwnd_compare ( const void *  key, const struct rb_entry *  entry  )

static

Definition at line 421 of file uia_utils.c.

{
    struct uia_hwnd_map_entry *hwnd_entry = RB_ENTRY_VALUE(entry, struct uia_hwnd_map_entry, entry);
    HWND hwnd = (HWND)key;
 
    return (hwnd_entry->hwnd > hwnd) - (hwnd_entry->hwnd < hwnd);
}

Referenced by uia_hwnd_map_init().

uia_hwnd_map_init()

void uia_hwnd_map_init

(

struct rb_tree *

hwnd_map

)

Definition at line 479 of file uia_utils.c.

{
    rb_init(hwnd_map, uia_hwnd_map_hwnd_compare);
}

Referenced by create_clientside_uia_event(), and uia_add_com_event_handler().

uia_hwnd_map_remove_hwnd()

void uia_hwnd_map_remove_hwnd	(	struct rb_tree *	hwnd_map,
		HWND	hwnd
	)

Definition at line 462 of file uia_utils.c.

{
    struct rb_entry *rb_entry = rb_get(hwnd_map, hwnd);
    struct uia_hwnd_map_entry *entry;
 
    if (!rb_entry)
    {
        TRACE("hwnd %p not in map %p, nothing to remove.\n", hwnd, hwnd_map);
        return;
    }
 
    TRACE("Removing hwnd %p from map %p\n", hwnd, hwnd_map);
    entry = RB_ENTRY_VALUE(rb_entry, struct uia_hwnd_map_entry, entry);
    rb_remove(hwnd_map, &entry->entry);
    free(entry);
}

Referenced by uia_com_win_event_callback().

uia_is_top_level_hwnd()

BOOL uia_is_top_level_hwnd

(

HWND

hwnd

)

Definition at line 407 of file uia_utils.c.

{
    return GetAncestor(hwnd, GA_PARENT) == GetDesktopWindow();
}

Referenced by base_hwnd_fragment_get_BoundingRectangle(), base_hwnd_fragment_Navigate(), and get_uia_control_type_for_hwnd().

unregister_interface_in_git()

HRESULT unregister_interface_in_git

(

DWORD

git_cookie

)

Definition at line 63 of file uia_utils.c.

{
    IGlobalInterfaceTable *git;
    HRESULT hr;
 
    hr = get_global_interface_table(&git);
    if (FAILED(hr))
        return hr;
 
    hr = IGlobalInterfaceTable_RevokeInterfaceFromGlobal(git, git_cookie);
    if (FAILED(hr))
        WARN("Failed to revoke interface from GlobalInterfaceTable, hr %#lx\n", hr);
 
    return hr;
}

Referenced by uia_event_adviser_Release(), uia_event_handler_destroy(), uia_node_disconnect(), uia_node_Release(), and UiaRemoveEvent().

WINE_DEFAULT_DEBUG_CHANNEL()

WINE_DEFAULT_DEBUG_CHANNEL

(

uiautomation

)

write_runtime_id_base()

HRESULT write_runtime_id_base	(	SAFEARRAY *	sa,
		HWND	hwnd
	)

Definition at line 102 of file uia_utils.c.

{
    const int rt_id[2] = { UIA_RUNTIME_ID_PREFIX, HandleToUlong(hwnd) };
    HRESULT hr;
    LONG idx;
 
    for (idx = 0; idx < ARRAY_SIZE(rt_id); idx++)
    {
        hr = SafeArrayPutElement(sa, &idx, (void *)&rt_id[idx]);
        if (FAILED(hr))
            return hr;
    }
 
    return S_OK;
}

Referenced by append_uia_runtime_id(), uia_init_desktop_rt_id(), and UiaGetRuntimeId().