com_apitest.c File Reference

#include "com_apitest.h"
#include <winreg.h>
#include <mshtmhst.h>
#include <shlwapi.h>
#include <commoncontrols.h>
#include <activscp.h>
#include <ndk/rtlfuncs.h>
#include <debug.h>

Include dependency graph for com_apitest.c:

Go to the source code of this file.

Classes
struct	_KNOWN_INTERFACE

Macros
#define	NDEBUG
#define	myskip(c, ...)   ((c) ? 0 : (skip(__VA_ARGS__), 1))
#define	mytrace(...)
#define	ID_NAME(c)   &c, #c, L ## #c
#define	ID_NAME_EX(c, d)   &c, #d, L ## #d
#define	ValidClassForVersion(pClass, version)    ((pClass)->MinClassNTDDIVersion <= (version) && (pClass)->MaxClassNTDDIVersion >= (version))
#define	ValidInterfaceForVersion(interface, version)    ((interface).MinInterfaceNTDDIVersion <= (version) && (interface).MaxInterfaceNTDDIVersion >= (version))
#define	INTF_NOT_EXPOSED   LONG_MAX

Typedefs
typedef struct _KNOWN_INTERFACE	KNOWN_INTERFACE
typedef const KNOWN_INTERFACE *	PCKNOWN_INTERFACE

Functions
BOOLEAN	RegisteredAlways (ULONG version)
BOOLEAN	RegisteredNever (ULONG version)
BOOLEAN	RegisteredOnWS03AndVista (ULONG version)
BOOLEAN	RegisteredOnVistaOrNewer (ULONG version)
BOOLEAN	RegisteredOnVistaOnly (ULONG version)
BOOLEAN	RegisteredOnVistaAndWin7 (ULONG version)
BOOLEAN	RegisteredOnVistaToWin8Dot1 (ULONG version)
BOOLEAN	RegisteredOnWin7OrNewer (ULONG version)
BOOLEAN	RegisteredOnWin8OrNewer (ULONG version)
BOOLEAN	RegisteredOnWS03OrOlder (ULONG version)
static PCKNOWN_INTERFACE	FindInterface (_In_ const IID *iid)
static BOOLEAN	IsInterfaceExpected (_In_ PCCLASS_AND_INTERFACES class, _In_ const IID *iid, _In_ ULONG NTDDIVersion)
static LONG	GetInterfaceOffset (_In_ PUNKNOWN pUnk, _In_ const IID *iid)
static VOID	TestModuleInterfaces (_In_ PCCLASS_AND_INTERFACES ExpectedInterfaces, _In_ INT ExpectedInterfaceCount, _In_ ULONG NTDDIVersion)
static VOID	TestModuleRegistry (_In_ PCWSTR ModuleName, _In_ PCCLASS_AND_INTERFACES ExpectedInterfaces, _In_ INT ExpectedInterfaceCount, _In_ ULONG NTDDIVersion)
static VOID	TestManualInstantiation (_In_ PCWSTR ModuleName, _In_ PCCLASS_AND_INTERFACES ExpectedInterfaces, _In_ INT ExpectedInterfaceCount, _In_ ULONG NTDDIVersion)
VOID	TestClassesEx (_In_ PCWSTR ModuleName, _In_ PCCLASS_AND_INTERFACES ExpectedInterfaces, _In_ INT ExpectedInterfaceCount, _In_ ULONG MinimumNTDDIVersion, _In_ ULONG MaximumNTDDIVersion, _In_ BOOLEAN IsWinRT)
VOID	TestClasses (_In_ PCWSTR ModuleName, _In_ PCCLASS_AND_INTERFACES ExpectedInterfaces, _In_ INT ExpectedInterfaceCount)
static VOID	TestInterfaceRegistry (_In_ PCKNOWN_INTERFACE Interfaces, _In_ INT InterfaceCount)
	START_TEST (interfaces)

Variables
static KNOWN_INTERFACE	KnownInterfaces []
static const INT	KnownInterfaceCount = RTL_NUMBER_OF(KnownInterfaces)

Macro Definition Documentation

ID_NAME

#define ID_NAME

(

c

)

&c, #c, L ## #c

Definition at line 38 of file com_apitest.c.

ID_NAME_EX

#define ID_NAME_EX	(		c,
			d
	)		&c, #d, L ## #d

Definition at line 39 of file com_apitest.c.

INTF_NOT_EXPOSED

#define INTF_NOT_EXPOSED   LONG_MAX

Definition at line 566 of file com_apitest.c.

myskip

#define myskip	(		c,
			...
	)		((c) ? 0 : (skip(__VA_ARGS__), 1))

Definition at line 20 of file com_apitest.c.

mytrace

#define mytrace

(

...

)

Value:

    do {       \
    int debug = winetest_debug; \
    winetest_debug = 1;         \
    trace(__VA_ARGS__);         \
    winetest_debug = debug;     \
} while (0)

Definition at line 21 of file com_apitest.c.

NDEBUG

#define NDEBUG

Definition at line 17 of file com_apitest.c.

ValidClassForVersion

#define ValidClassForVersion	(		pClass,
			version
	)		((pClass)->MinClassNTDDIVersion <= (version) && (pClass)->MaxClassNTDDIVersion >= (version))

Definition at line 527 of file com_apitest.c.

ValidInterfaceForVersion

#define ValidInterfaceForVersion	(		interface,
			version
	)		((interface).MinInterfaceNTDDIVersion <= (version) && (interface).MaxInterfaceNTDDIVersion >= (version))

Definition at line 529 of file com_apitest.c.

Typedef Documentation

KNOWN_INTERFACE

typedef struct _KNOWN_INTERFACE KNOWN_INTERFACE

PCKNOWN_INTERFACE

typedef const KNOWN_INTERFACE* PCKNOWN_INTERFACE

Definition at line 35 of file com_apitest.c.

Function Documentation

FindInterface()

static PCKNOWN_INTERFACE FindInterface ( _In_ const IID *  iid )

static

Definition at line 534 of file com_apitest.c.

{
    INT i;
 
    for (i = 0; i < KnownInterfaceCount; i++)
        if (IsEqualIID(KnownInterfaces[i].iid, iid))
            return &KnownInterfaces[i];
    ASSERT(i != KnownInterfaceCount);
    return NULL;
}

Referenced by TestModuleInterfaces().

GetInterfaceOffset()

static LONG GetInterfaceOffset ( _In_ PUNKNOWN  pUnk, _In_ const IID *  iid  )

static

Definition at line 569 of file com_apitest.c.

{
    HRESULT hr;
    PVOID pObj;
    PUNKNOWN pUnk2;
    LONG offset;
 
    hr = IUnknown_QueryInterface(pUnk, iid, &pObj);
    ok(hr == S_OK || hr == E_NOINTERFACE, "IUnknown::QueryInterface returned 0x%lx\n", hr);
    if (FAILED(hr))
        return INTF_NOT_EXPOSED;
 
    pUnk2 = pObj;
    offset = (LONG_PTR)pObj - (LONG_PTR)pUnk;
    IUnknown_Release(pUnk2);
    return offset;
}

Referenced by TestModuleInterfaces().

IsInterfaceExpected()

static BOOLEAN IsInterfaceExpected ( _In_ PCCLASS_AND_INTERFACES  class, _In_ const IID *  iid, _In_ ULONG  NTDDIVersion  )

static

Definition at line 548 of file com_apitest.c.

{
    INT i;
 
    for (i = 0; class->ifaces[i].iid; i++)
    {
        if (ValidInterfaceForVersion(class->ifaces[i], NTDDIVersion) &&
            IsEqualIID(class->ifaces[i].iid, iid))
        {
            return TRUE;
        }
    }
    return FALSE;
}

Referenced by TestModuleInterfaces().

RegisteredAlways()

BOOLEAN RegisteredAlways

(

ULONG

version

)

Definition at line 41 of file com_apitest.c.

{ return TRUE; }

RegisteredNever()

BOOLEAN RegisteredNever

(

ULONG

version

)

Definition at line 42 of file com_apitest.c.

{ return FALSE; }

RegisteredOnVistaAndWin7()

BOOLEAN RegisteredOnVistaAndWin7

(

ULONG

version

)

Definition at line 46 of file com_apitest.c.

{ return version >= NTDDI_VISTA && version < NTDDI_WIN8; }

RegisteredOnVistaOnly()

BOOLEAN RegisteredOnVistaOnly

(

ULONG

version

)

Definition at line 45 of file com_apitest.c.

{ return version >= NTDDI_VISTA && version < NTDDI_WIN7; }

RegisteredOnVistaOrNewer()

BOOLEAN RegisteredOnVistaOrNewer

(

ULONG

version

)

Definition at line 44 of file com_apitest.c.

{ return version >= NTDDI_VISTA; }

RegisteredOnVistaToWin8Dot1()

BOOLEAN RegisteredOnVistaToWin8Dot1

(

ULONG

version

)

Definition at line 47 of file com_apitest.c.

{ return version >= NTDDI_VISTA && version < NTDDI_WIN10; }

RegisteredOnWin7OrNewer()

BOOLEAN RegisteredOnWin7OrNewer

(

ULONG

version

)

Definition at line 48 of file com_apitest.c.

{ return version >= NTDDI_WIN7; }

RegisteredOnWin8OrNewer()

BOOLEAN RegisteredOnWin8OrNewer

(

ULONG

version

)

Definition at line 49 of file com_apitest.c.

{ return version >= NTDDI_WIN8; }

RegisteredOnWS03AndVista()

BOOLEAN RegisteredOnWS03AndVista

(

ULONG

version

)

Definition at line 43 of file com_apitest.c.

{ return version >= NTDDI_WS03 && version < NTDDI_WIN7; }

RegisteredOnWS03OrOlder()

BOOLEAN RegisteredOnWS03OrOlder

(

ULONG

version

)

Definition at line 50 of file com_apitest.c.

{ return version <= NTDDI_WS03SP4; }

START_TEST()

START_TEST

(

interfaces

)

Definition at line 894 of file com_apitest.c.

{
    TestInterfaceRegistry(KnownInterfaces, KnownInterfaceCount);
}

TestClasses()

VOID TestClasses	(	_In_ PCWSTR	ModuleName,
		_In_ PCCLASS_AND_INTERFACES	ExpectedInterfaces,
		_In_ INT	ExpectedInterfaceCount
	)

Definition at line 815 of file com_apitest.c.

{
    TestClassesEx(ModuleName, ExpectedInterfaces, ExpectedInterfaceCount, NTDDI_MIN, NTDDI_MAX, FALSE);
}

Referenced by START_TEST().

TestClassesEx()

VOID TestClassesEx	(	_In_ PCWSTR	ModuleName,
		_In_ PCCLASS_AND_INTERFACES	ExpectedInterfaces,
		_In_ INT	ExpectedInterfaceCount,
		_In_ ULONG	MinimumNTDDIVersion,
		_In_ ULONG	MaximumNTDDIVersion,
		_In_ BOOLEAN	IsWinRT
	)

Definition at line 779 of file com_apitest.c.

{
    HRESULT hr;
    ULONG NTDDIVersion;
 
    NTDDIVersion = GetNTDDIVersion();
 
    if (NTDDIVersion < MinimumNTDDIVersion || NTDDIVersion > MaximumNTDDIVersion)
    {
        skip("Skipping all tests for module %S, NTDDI version (0x%08lx) is outside of the supported range (0x%08lx-0x%08lx).\n",
             ModuleName, NTDDIVersion, MinimumNTDDIVersion, MaximumNTDDIVersion);
        return;
    }
 
    hr = CoInitializeEx(NULL, COINIT_APARTMENTTHREADED);
    ok(hr == S_OK, "CoInitializeEx failed. hr=0x%lx\n", hr);
    if (myskip(SUCCEEDED(hr), "Failed to initialize COM. Cannot perform tests\n"))
        return;
 
    TestModuleInterfaces(ExpectedInterfaces, ExpectedInterfaceCount, NTDDIVersion);
    TestModuleRegistry(ModuleName, ExpectedInterfaces, ExpectedInterfaceCount, NTDDIVersion);
    if (IsWinRT)
        skip("%S is a WinRT module, skipping manual instantiation tests.\n", ModuleName);
    else
        TestManualInstantiation(ModuleName, ExpectedInterfaces, ExpectedInterfaceCount, NTDDIVersion);
 
    CoUninitialize();
}

Referenced by START_TEST(), and TestClasses().

TestInterfaceRegistry()

static VOID TestInterfaceRegistry ( _In_ PCKNOWN_INTERFACE  Interfaces, _In_ INT  InterfaceCount  )

static

Definition at line 825 of file com_apitest.c.

{
    INT i;
    HKEY hKeyInterface;
    LONG result;
    ULONG CurrentNTDDI;
 
    result = RegOpenKeyExW(HKEY_LOCAL_MACHINE, L"Software\\Classes\\Interface", 0, KEY_ENUMERATE_SUB_KEYS, &hKeyInterface);
    ok(result == NO_ERROR, "Failed to open interface key, error %lu\n", result);
    if (!myskip(result == NO_ERROR, "No interface key\n"))
    {
        CurrentNTDDI = GetNTDDIVersion();
 
        for (i = 0; i < InterfaceCount; i++)
        {
            HKEY hKey;
            NTSTATUS status;
            UNICODE_STRING iid;
            DWORD type;
            WCHAR data[100];
            DWORD dataSize;
            PCKNOWN_INTERFACE iface;
            PCWSTR expectedName;
 
            iface = &Interfaces[i];
            status = RtlStringFromGUID(iface->iid, &iid);
            ok(status == STATUS_SUCCESS, "Failed to convert guid to string for %s, status %lx\n", iface->name, status);
            if (myskip(NT_SUCCESS(status), "No guid string\n"))
                continue;
 
            result = RegOpenKeyExW(hKeyInterface, iid.Buffer, 0, KEY_QUERY_VALUE, &hKey);
            if (iface->IsRegistered(CurrentNTDDI))
            {
                ok(result == NO_ERROR, "%s should be registered. (Error %lu)\n", iface->name, result);
                // (void)myskip(result == NO_ERROR, "No key\n");
            }
            else
            {
                ok(result == ERROR_FILE_NOT_FOUND, "%s should not be registered. (Error %lu)\n", iface->name, result);
            }
            RtlFreeUnicodeString(&iid);
            if (result != NO_ERROR)
                continue;
 
            dataSize = sizeof(data);
            result = RegQueryValueExW(hKey, NULL, NULL, &type, (PBYTE)data, &dataSize);
            ok(result == NO_ERROR, "Failed to query value for %s, error %lu\n", iface->name, result);
            if (!myskip(result == NO_ERROR, "No module name\n"))
            {
                ok(type == REG_SZ, "type %lu for %s\n", type, iface->name);
                ok(dataSize % sizeof(WCHAR) == 0, "size %lu for %s\n", dataSize, iface->name);
                ok(dataSize <= sizeof(data), "size %lu for %s\n", dataSize, iface->name);
                ok(data[dataSize / sizeof(WCHAR) - 1] == UNICODE_NULL, "Not null terminated for %s\n", iface->name);
                expectedName = wcschr(iface->wname, L'_');
                if (expectedName)
                    expectedName++;
                else
                    expectedName = iface->wname;
                ok(!_wcsicmp(data, expectedName), "Name is %ls, expected %ls\n", data, expectedName);
            }
 
            RegCloseKey(hKey);
        }
        RegCloseKey(hKeyInterface);
    }
}

Referenced by START_TEST().

TestManualInstantiation()

static VOID TestManualInstantiation ( _In_ PCWSTR  ModuleName, _In_ PCCLASS_AND_INTERFACES  ExpectedInterfaces, _In_ INT  ExpectedInterfaceCount, _In_ ULONG  NTDDIVersion  )

static

Definition at line 739 of file com_apitest.c.

{
    INT iClass;
    PCCLASS_AND_INTERFACES class;
    HRESULT (__stdcall *DllGetClassObject)(REFCLSID, REFIID, PVOID *);
 
    DllGetClassObject = (PVOID)GetProcAddress(GetModuleHandleW(ModuleName), "DllGetClassObject");
    ok(DllGetClassObject != NULL, "DllGetClassObject not found in %ls, error %lu\n", ModuleName, GetLastError());
    if (myskip(DllGetClassObject != NULL, "No DllGetClassObject\n"))
        return;
 
    for (iClass = 0; iClass < ExpectedInterfaceCount; iClass++)
    {
        PVOID pv;
        HRESULT hr;
        class = &ExpectedInterfaces[iClass];
        if (!ValidClassForVersion(class, NTDDIVersion))
            continue;
        hr = DllGetClassObject(class->clsid, &IID_IClassFactory, &pv);
        ok(hr == S_OK, "DllGetClassObject failed for %s, hr = 0x%lx\n", class->name, hr);
        if (!myskip(SUCCEEDED(hr), "No class factory\n"))
        {
            IClassFactory *pCF = pv;
            hr = IClassFactory_CreateInstance(pCF, NULL, &IID_IUnknown, &pv);
            ok(hr == S_OK, "IClassFactory::CreateInstance failed for %s, hr = 0x%lx\n", class->name, hr);
            if (!myskip(SUCCEEDED(hr), "No instance\n"))
            {
                IUnknown *pUnk = pv;
                IUnknown_Release(pUnk);
            }
            IClassFactory_Release(pCF);
        }
    }
}

Referenced by TestClassesEx().

TestModuleInterfaces()

static VOID TestModuleInterfaces ( _In_ PCCLASS_AND_INTERFACES  ExpectedInterfaces, _In_ INT  ExpectedInterfaceCount, _In_ ULONG  NTDDIVersion  )

static

Definition at line 591 of file com_apitest.c.

{
    HRESULT hr;
    PVOID pObj;
    PUNKNOWN pUnk;
    INT iClass, iIntf;
    PCCLASS_AND_INTERFACES class;
 
    for (iClass = 0; iClass < ExpectedInterfaceCount; iClass++)
    {
        class = &ExpectedInterfaces[iClass];
        if (!ValidClassForVersion(class, NTDDIVersion))
            continue;
        hr = CoCreateInstance(class->clsid,
                              NULL,
                              CLSCTX_INPROC_SERVER,
                              &IID_IUnknown,
                              &pObj);
        ok(hr == S_OK, "CoCreateInstance failed. hr=0x%lx\n", hr);
        if (FAILED(hr))
        {
            skip("Failed to instantiate %s.\n", class->name);
            continue;
        }
 
        pUnk = pObj;
 
        /* Check that all expected interfaces are present */
        for (iIntf = 0; class->ifaces[iIntf].iid; iIntf++)
        {
            if (!ValidInterfaceForVersion(class->ifaces[iIntf], NTDDIVersion))
                continue;
            PCKNOWN_INTERFACE iface = FindInterface(class->ifaces[iIntf].iid);
            LONG offset = GetInterfaceOffset(pUnk, iface->iid);
            if (offset == INTF_NOT_EXPOSED)
                ok(0, "%s is missing %s\n", class->name, iface->name);
#ifdef LOG_COM_INTERFACE_OFFSETS
            else
                mytrace("%s0x%lx, %s, %s\n", offset < 0 ? "-" : "", offset < 0 ? -offset : offset, class->name, iface->name);
#endif
        }
 
        /* Check that none other than the expected interfaces are present */
        for (iIntf = 0; iIntf < KnownInterfaceCount; iIntf++)
        {
            PCKNOWN_INTERFACE iface = &KnownInterfaces[iIntf];
            LONG offset;
            if (IsInterfaceExpected(class, iface->iid, NTDDIVersion))
                continue;
            offset = GetInterfaceOffset(pUnk, iface->iid);
            ok(offset == INTF_NOT_EXPOSED, "%s exposes %s (offset %s0x%lx), but shouldn't\n", class->name, iface->name, offset < 0 ? "-" : "", offset < 0 ? -offset : offset);
        }
 
        // TODO: do some aggregation
 
        IUnknown_Release(pUnk);
    }
}

Referenced by TestClassesEx().

TestModuleRegistry()

static VOID TestModuleRegistry ( _In_ PCWSTR  ModuleName, _In_ PCCLASS_AND_INTERFACES  ExpectedInterfaces, _In_ INT  ExpectedInterfaceCount, _In_ ULONG  NTDDIVersion  )

static

Definition at line 655 of file com_apitest.c.

{
    INT iClass;
    PCCLASS_AND_INTERFACES class;
    HKEY hKeyClasses;
    LONG result;
 
    result = RegOpenKeyExW(HKEY_LOCAL_MACHINE, L"Software\\Classes\\CLSID", 0, KEY_ENUMERATE_SUB_KEYS, &hKeyClasses);
    ok(result == NO_ERROR, "Failed to open classes key, error %lu\n", result);
    if (!myskip(result == NO_ERROR, "No classes key\n"))
    {
        for (iClass = 0; iClass < ExpectedInterfaceCount; iClass++)
        {
            HKEY hKey;
            HKEY hKeyServer;
            NTSTATUS status;
            UNICODE_STRING clsid;
            DWORD type;
            WCHAR data[100];
            DWORD dataSize;
            PCWSTR expectedThreadingModel;
 
            class = &ExpectedInterfaces[iClass];
            if (!ValidClassForVersion(class, NTDDIVersion))
                continue;
            status = RtlStringFromGUID(class->clsid, &clsid);
            ok(status == STATUS_SUCCESS, "Failed to convert guid to string for %s, status %lx\n", class->name, status);
            if (myskip(NT_SUCCESS(status), "No guid string\n"))
                continue;
 
            result = RegOpenKeyExW(hKeyClasses, clsid.Buffer, 0, KEY_ENUMERATE_SUB_KEYS, &hKey);
            ok(result == NO_ERROR, "Failed to open key for %s, error %lu\n", class->name, result);
            RtlFreeUnicodeString(&clsid);
            if (myskip(result == NO_ERROR, "No key\n"))
                continue;
 
            result = RegOpenKeyExW(hKey, L"InProcServer32", 0, KEY_QUERY_VALUE, &hKeyServer);
            ok(result == NO_ERROR, "Failed to open key for %s, error %lu\n", class->name, result);
            RegCloseKey(hKey);
            if (myskip(result == NO_ERROR, "No key\n"))
                continue;
 
            dataSize = sizeof(data);
            result = RegQueryValueExW(hKeyServer, NULL, NULL, &type, (PBYTE)data, &dataSize);
            ok(result == NO_ERROR, "Failed to query value for %s, error %lu\n", class->name, result);
            if (!myskip(result == NO_ERROR, "No module name\n"))
            {
                ok(type == REG_SZ || type == REG_EXPAND_SZ, "type %lu for %s\n", type, class->name);
                ok(dataSize % sizeof(WCHAR) == 0, "size %lu for %s\n", dataSize, class->name);
                ok(dataSize <= sizeof(data), "size %lu for %s\n", dataSize, class->name);
                ok(data[dataSize / sizeof(WCHAR) - 1] == UNICODE_NULL, "Not null terminated for %s\n", class->name);
                // TODO: Use SearchPath (or assume everything's in system32) and do a proper full path compare
                PathStripPathW(data);
                PathRemoveExtensionW(data);
                ok(!_wcsicmp(data, ModuleName), "Server is %ls, expected %ls for %s\n", data, ModuleName, class->name);
            }
 
            dataSize = sizeof(data);
            result = RegQueryValueExW(hKeyServer, L"ThreadingModel", NULL, &type, (PBYTE)data, &dataSize);
            ok(result == NO_ERROR, "Failed to query value for %s, error %lu\n", class->name, result);
            if (!myskip(result == NO_ERROR, "No ThreadingModel\n"))
            {
                ok(type == REG_SZ || type == REG_EXPAND_SZ, "type %lu for %s\n", type, class->name);
                ok(dataSize % sizeof(WCHAR) == 0, "size %lu for %s\n", dataSize, class->name);
                ok(dataSize <= sizeof(data), "size %lu for %s\n", dataSize, class->name);
                ok(data[dataSize / sizeof(WCHAR) - 1] == UNICODE_NULL, "Not null terminated for %s\n", class->name);
                expectedThreadingModel = class->ThreadingModel;
                if (!expectedThreadingModel)
                    expectedThreadingModel = L"Apartment";
                ok(!_wcsicmp(data, expectedThreadingModel), "Server is %ls, expected %ls for %s\n", data, expectedThreadingModel, class->name);
            }
 
            RegCloseKey(hKeyServer);
        }
        RegCloseKey(hKeyClasses);
    }
}

Referenced by TestClassesEx().

Variable Documentation

KnownInterfaceCount

const INT KnownInterfaceCount = RTL_NUMBER_OF(KnownInterfaces)

static

Definition at line 525 of file com_apitest.c.

Referenced by FindInterface(), START_TEST(), and TestModuleInterfaces().

KnownInterfaces

KNOWN_INTERFACE KnownInterfaces[]

static

Definition at line 52 of file com_apitest.c.

Referenced by FindInterface(), START_TEST(), and TestModuleInterfaces().