IACLCustomMRU.cpp File Reference

#include <apitest.h>
#include <shlobj.h>
#include <atlbase.h>
#include <atlstr.h>
#include <atlcom.h>
#include <atlwin.h>
#include <shellutils.h>
#include <shlwapi.h>
#include <strsafe.h>
#include <initguid.h>

Include dependency graph for IACLCustomMRU.cpp:

Go to the source code of this file.

Classes
struct	CCoInit

Macros
#define	_UNICODE
#define	UNICODE
#define	ok_hex_(file, line, key, expression, result)
#define	INTERFACE   IACLCustomMRU
#define	verify_mru(mru, ...)   verify_mru_(__FILE__, __LINE__, mru, __VA_ARGS__, NULL)

Functions
ULONG	DbgPrint (PCH Format,...)
	DEFINE_GUID (IID_IACLCustomMRU, 0xf729fc5e, 0x8769, 0x4f3e, 0xbd, 0xb2, 0xd7, 0xb5, 0x0f, 0xd2, 0x27, 0x5b)
	DECLARE_INTERFACE_IID_ (IACLCustomMRU, IUnknown, "F729FC5E-8769-4F3E-BDB2-D7B50FD2275B")
static void	Cleanup_Testdata ()
static void	verify_mru_ (const char *file, int line, IACLCustomMRU *mru, PCWSTR MRUString,...)
static void	test_IACLCustomMRU_Basics ()
static void	FillDefault (IACLCustomMRU *CustomMRU)
static void	test_IACLCustomMRU_UpdateOrder ()
static void	test_IACLCustomMRU_ExtraChars ()
static void	test_IACLCustomMRU_Continue ()
	START_TEST (IACLCustomMRU)

Variables
static const WCHAR	szTestPath [] = L"TESTPATH_BROWSEUI_APITEST"

Macro Definition Documentation

_UNICODE

#define _UNICODE

Definition at line 8 of file IACLCustomMRU.cpp.

INTERFACE

#define INTERFACE   IACLCustomMRU

Definition at line 46 of file IACLCustomMRU.cpp.

ok_hex_

#define ok_hex_	(		file,
			line,
			key,
			expression,
			result
	)

Value:

do { \
        int _value = (expression); \
        ok_(file, line)(_value == (result), "Wrong value for '%s', expected: " #result " (0x%x), got: 0x%x for %c\n", \
           #expression, (int)(result), _value, (char)key); \
    } while (0)

Definition at line 25 of file IACLCustomMRU.cpp.

UNICODE

#define UNICODE

Definition at line 9 of file IACLCustomMRU.cpp.

verify_mru

#define verify_mru	(		mru,
			...
	)		verify_mru_(__FILE__, __LINE__, mru, __VA_ARGS__, NULL)

Definition at line 69 of file IACLCustomMRU.cpp.

Function Documentation

Cleanup_Testdata()

static void Cleanup_Testdata ( )

static

Definition at line 62 of file IACLCustomMRU.cpp.

{
    CRegKey tmp;
    if (!tmp.Open(HKEY_CURRENT_USER, NULL, KEY_READ | KEY_WRITE))
        tmp.DeleteSubKey(szTestPath);
}

Referenced by FillDefault(), START_TEST(), test_IACLCustomMRU_Basics(), test_IACLCustomMRU_Continue(), test_IACLCustomMRU_ExtraChars(), and test_IACLCustomMRU_UpdateOrder().

DbgPrint()

ULONG DbgPrint	(	PCH	Format,
			...
	)

DECLARE_INTERFACE_IID_()

DECLARE_INTERFACE_IID_	(	IACLCustomMRU	,
		IUnknown	,
		"F729FC5E-8769-4F3E-BDB2-D7B50FD2275B"
	)

Definition at line 49 of file IACLCustomMRU.cpp.

{
    // *** IUnknown methods ***
    STDMETHOD(QueryInterface) (THIS_ REFIID riid, void **ppv) PURE;
    STDMETHOD_(ULONG, AddRef) (THIS)PURE;
    STDMETHOD_(ULONG, Release) (THIS)PURE;

    // *** IACLCustomMRU methods ***
    STDMETHOD(Initialize) (THIS_ LPCWSTR pwszMRURegKey, DWORD dwMax) PURE;
    STDMETHOD(AddMRUString) (THIS_ LPCWSTR pwszEntry) PURE;
};

DEFINE_GUID()

DEFINE_GUID	(	IID_IACLCustomMRU	,
		0xf729fc5e	,
		0x8769	,
		0x4f3e	,
		0xbd	,
		0xb2	,
		0xd7	,
		0xb5	,
		0x0f	,
		0xd2	,
		0x27	,
		0x5b
	)

FillDefault()

static void FillDefault ( IACLCustomMRU *  CustomMRU )

static

Definition at line 157 of file IACLCustomMRU.cpp.

{
    Cleanup_Testdata();
    HRESULT hr = CustomMRU->Initialize(szTestPath, 3);
    ok_hex(hr, S_OK);
    hr = CustomMRU->AddMRUString(L"FIRST_ENTRY");
    ok_hex(hr, S_OK);
    hr = CustomMRU->AddMRUString(L"SECOND_ENTRY");
    ok_hex(hr, S_OK);
    hr = CustomMRU->AddMRUString(L"THIRD_ENTRY");
    ok_hex(hr, S_OK);
}

Referenced by test_IACLCustomMRU_Continue(), and test_IACLCustomMRU_UpdateOrder().

START_TEST()

START_TEST

(

IACLCustomMRU

)

Definition at line 404 of file IACLCustomMRU.cpp.

{
    CCoInit init;
    ok_hex(init.hres, S_OK);
    if (!SUCCEEDED(init.hres))
        return;

    test_IACLCustomMRU_Basics();
    test_IACLCustomMRU_UpdateOrder();
    test_IACLCustomMRU_ExtraChars();
    test_IACLCustomMRU_Continue();

    Cleanup_Testdata();
}

test_IACLCustomMRU_Basics()

static void test_IACLCustomMRU_Basics ( )

static

Definition at line 111 of file IACLCustomMRU.cpp.

{
    CComPtr<IACLCustomMRU> CustomMRU;
    HRESULT hr = CoCreateInstance(CLSID_ACLCustomMRU, NULL, CLSCTX_ALL, IID_PPV_ARG(IACLCustomMRU, &CustomMRU));
    ok_hex(hr, S_OK);
    if (!SUCCEEDED(hr))
        return;

    Cleanup_Testdata();

    /* Initialize with a NULL name will cause an AV */
    //hr = CustomMRU->Initialize(NULL, 0);

    hr = CustomMRU->Initialize(szTestPath, 0);
    ok_hex(hr, S_OK);
    /* Adding an entry with a dwMax of 0 will cause an AV */

    /* Calling it again will resize */
    hr = CustomMRU->Initialize(szTestPath, 3);
    ok_hex(hr, S_OK);
    verify_mru(CustomMRU, L"");

    hr = CustomMRU->AddMRUString(L"FIRST_ENTRY");
    ok_hex(hr, S_OK);
    verify_mru(CustomMRU, L"a", L"FIRST_ENTRY");

    hr = CustomMRU->AddMRUString(L"SECOND_ENTRY");
    ok_hex(hr, S_OK);
    verify_mru(CustomMRU, L"ba", L"FIRST_ENTRY", L"SECOND_ENTRY");

    hr = CustomMRU->AddMRUString(L"THIRD_ENTRY");
    ok_hex(hr, S_OK);
    verify_mru(CustomMRU, L"cba", L"FIRST_ENTRY", L"SECOND_ENTRY", L"THIRD_ENTRY");

    /* First entry is replaced */
    hr = CustomMRU->AddMRUString(L"FOURTH_ENTRY");
    ok_hex(hr, S_OK);
    verify_mru(CustomMRU, L"acb", L"FOURTH_ENTRY", L"SECOND_ENTRY", L"THIRD_ENTRY");

    /* Second entry is replaced */
    hr = CustomMRU->AddMRUString(L"FIFTH_ENTRY");
    ok_hex(hr, S_OK);
    verify_mru(CustomMRU, L"bac", L"FOURTH_ENTRY", L"FIFTH_ENTRY", L"THIRD_ENTRY");
}

Referenced by START_TEST().

test_IACLCustomMRU_Continue()

static void test_IACLCustomMRU_Continue ( )

static

Definition at line 249 of file IACLCustomMRU.cpp.

{
    CComPtr<IACLCustomMRU> CustomMRU;
    HRESULT hr = CoCreateInstance(CLSID_ACLCustomMRU, NULL, CLSCTX_ALL, IID_PPV_ARG(IACLCustomMRU, &CustomMRU));
    ok_hex(hr, S_OK);
    if (!SUCCEEDED(hr))
        return;

    Cleanup_Testdata();
    FillDefault(CustomMRU);
    verify_mru(CustomMRU, L"cba", L"FIRST_ENTRY", L"SECOND_ENTRY", L"THIRD_ENTRY");

    CustomMRU.Release();

    hr = CoCreateInstance(CLSID_ACLCustomMRU, NULL, CLSCTX_ALL, IID_PPV_ARG(IACLCustomMRU, &CustomMRU));
    ok_hex(hr, S_OK);
    if (!SUCCEEDED(hr))
        return;

    hr = CustomMRU->Initialize(szTestPath, 3);
    ok_hex(hr, S_OK);

    /* First entry is replaced */
    hr = CustomMRU->AddMRUString(L"FOURTH_ENTRY");
    ok_hex(hr, S_OK);
    verify_mru(CustomMRU, L"acb", L"FOURTH_ENTRY", L"SECOND_ENTRY", L"THIRD_ENTRY");

    CustomMRU.Release();

    hr = CoCreateInstance(CLSID_ACLCustomMRU, NULL, CLSCTX_ALL, IID_PPV_ARG(IACLCustomMRU, &CustomMRU));
    ok_hex(hr, S_OK);
    if (!SUCCEEDED(hr))
        return;

    hr = CustomMRU->Initialize(szTestPath, 3);
    ok_hex(hr, S_OK);

    /* Second entry is replaced */
    hr = CustomMRU->AddMRUString(L"FIFTH_ENTRY");
    ok_hex(hr, S_OK);
    verify_mru(CustomMRU, L"bac", L"FOURTH_ENTRY", L"FIFTH_ENTRY", L"THIRD_ENTRY");

    CustomMRU.Release();

    hr = CoCreateInstance(CLSID_ACLCustomMRU, NULL, CLSCTX_ALL, IID_PPV_ARG(IACLCustomMRU, &CustomMRU));
    ok_hex(hr, S_OK);
    if (!SUCCEEDED(hr))
        return;


    /* Save some garbage */
    CRegKey key;
    key.Open(HKEY_CURRENT_USER, szTestPath);
    key.SetStringValue(L"MRUList", L"b**");
    key.Close();

    hr = CustomMRU->Initialize(szTestPath, 3);
    ok_hex(hr, S_OK);

    CustomMRU.Release();

    /* Not cleaned up */
    verify_mru(CustomMRU, L"b**", L"FOURTH_ENTRY", L"FIFTH_ENTRY", L"THIRD_ENTRY");

    hr = CoCreateInstance(CLSID_ACLCustomMRU, NULL, CLSCTX_ALL, IID_PPV_ARG(IACLCustomMRU, &CustomMRU));
    ok_hex(hr, S_OK);
    if (!SUCCEEDED(hr))
        return;

    hr = CustomMRU->Initialize(szTestPath, 3);
    ok_hex(hr, S_OK);

    /* Now it's just cleaned up */
    hr = CustomMRU->AddMRUString(L"SIXTH_ENTRY");
    ok_hex(hr, S_OK);
    verify_mru(CustomMRU, L"ab", L"SIXTH_ENTRY");

    CustomMRU.Release();

    hr = CoCreateInstance(CLSID_ACLCustomMRU, NULL, CLSCTX_ALL, IID_PPV_ARG(IACLCustomMRU, &CustomMRU));
    ok_hex(hr, S_OK);
    if (!SUCCEEDED(hr))
        return;

    Cleanup_Testdata();
    FillDefault(CustomMRU);
    verify_mru(CustomMRU, L"cba", L"FIRST_ENTRY", L"SECOND_ENTRY", L"THIRD_ENTRY");

    CustomMRU.Release();

    hr = CoCreateInstance(CLSID_ACLCustomMRU, NULL, CLSCTX_ALL, IID_PPV_ARG(IACLCustomMRU, &CustomMRU));
    ok_hex(hr, S_OK);
    if (!SUCCEEDED(hr))
        return;

    key.Open(HKEY_CURRENT_USER, szTestPath);
    key.SetStringValue(L"MRUList", L"baccccc");
    key.Close();

    hr = CustomMRU->Initialize(szTestPath, 3);
    ok_hex(hr, S_OK);
    CustomMRU.Release();

    verify_mru(CustomMRU, L"baccccc", L"FIRST_ENTRY", L"SECOND_ENTRY", L"THIRD_ENTRY");

    hr = CoCreateInstance(CLSID_ACLCustomMRU, NULL, CLSCTX_ALL, IID_PPV_ARG(IACLCustomMRU, &CustomMRU));
    ok_hex(hr, S_OK);
    if (!SUCCEEDED(hr))
        return;

    hr = CustomMRU->Initialize(szTestPath, 3);
    ok_hex(hr, S_OK);

    hr = CustomMRU->AddMRUString(L"FOURTH_ENTRY");
    ok_hex(hr, S_OK);
    verify_mru(CustomMRU, L"a", L"FOURTH_ENTRY", L"SECOND_ENTRY", L"THIRD_ENTRY");

    CustomMRU.Release();
    Cleanup_Testdata();

    hr = CoCreateInstance(CLSID_ACLCustomMRU, NULL, CLSCTX_ALL, IID_PPV_ARG(IACLCustomMRU, &CustomMRU));
    ok_hex(hr, S_OK);
    if (!SUCCEEDED(hr))
        return;

    hr = CustomMRU->Initialize(szTestPath, 3);
    ok_hex(hr, S_OK);
    if (!SUCCEEDED(hr))
        return;

    hr = CustomMRU->AddMRUString(L"FIRST_ENTRY");
    ok_hex(hr, S_OK);
    verify_mru(CustomMRU, L"a", L"FIRST_ENTRY");

    CustomMRU.Release();

    key.Open(HKEY_CURRENT_USER, szTestPath);
    key.SetStringValue(L"MRUList", L"aaa");
    key.Close();

    hr = CoCreateInstance(CLSID_ACLCustomMRU, NULL, CLSCTX_ALL, IID_PPV_ARG(IACLCustomMRU, &CustomMRU));
    ok_hex(hr, S_OK);
    if (!SUCCEEDED(hr))
        return;

    hr = CustomMRU->Initialize(szTestPath, 3);
    ok_hex(hr, S_OK);
    if (!SUCCEEDED(hr))
        return;

    hr = CustomMRU->AddMRUString(L"SECOND_ENTRY");
    ok_hex(hr, S_OK);
    verify_mru(CustomMRU, L"ba", L"FIRST_ENTRY", L"SECOND_ENTRY");
}

Referenced by START_TEST().

test_IACLCustomMRU_ExtraChars()

static void test_IACLCustomMRU_ExtraChars ( )

static

Definition at line 217 of file IACLCustomMRU.cpp.

{
    CComPtr<IACLCustomMRU> CustomMRU;
    HRESULT hr = CoCreateInstance(CLSID_ACLCustomMRU, NULL, CLSCTX_ALL, IID_PPV_ARG(IACLCustomMRU, &CustomMRU));
    ok_hex(hr, S_OK);
    if (!SUCCEEDED(hr))
        return;

    Cleanup_Testdata();

    /* Still returnes success */
    hr = CustomMRU->Initialize(szTestPath, 30);
    ok_hex(hr, S_OK);

    for (int n = 0; n < 30; ++n)
    {
        CStringW tmp;
        tmp.Format(L"%d", n);

        hr = CustomMRU->AddMRUString(tmp);
        ok_hex(hr, S_OK);
    }
    /* But is starting to wrap around */
    verify_mru(CustomMRU, L"a}|{zyxwvutsrqponmlkjihgfedcb", L"29",
               L"1", L"2", L"3", L"4", L"5", L"6", L"7", L"8", L"9",
               L"10", L"11", L"12", L"13", L"14", L"15", L"16", L"17", L"18", L"19",
               L"20", L"21", L"22", L"23", L"24", L"25", L"26", L"27", L"28");

    Cleanup_Testdata();
}

Referenced by START_TEST().

test_IACLCustomMRU_UpdateOrder()

static void test_IACLCustomMRU_UpdateOrder ( )

static

Definition at line 171 of file IACLCustomMRU.cpp.

{
    CComPtr<IACLCustomMRU> CustomMRU;
    HRESULT hr = CoCreateInstance(CLSID_ACLCustomMRU, NULL, CLSCTX_ALL, IID_PPV_ARG(IACLCustomMRU, &CustomMRU));
    ok_hex(hr, S_OK);
    if (!SUCCEEDED(hr))
        return;

    Cleanup_Testdata();
    FillDefault(CustomMRU);
    verify_mru(CustomMRU, L"cba", L"FIRST_ENTRY", L"SECOND_ENTRY", L"THIRD_ENTRY");

    /* Add the first entry again */
    hr = CustomMRU->AddMRUString(L"FIRST_ENTRY");
    ok_hex(hr, S_OK);
    /* No change */
    verify_mru(CustomMRU, L"cba", L"FIRST_ENTRY", L"SECOND_ENTRY", L"THIRD_ENTRY");

    CustomMRU.Release();
    /* Now the order is updated */
    verify_mru(NULL, L"acb", L"FIRST_ENTRY", L"SECOND_ENTRY", L"THIRD_ENTRY");


    hr = CoCreateInstance(CLSID_ACLCustomMRU, NULL, CLSCTX_ALL, IID_PPV_ARG(IACLCustomMRU, &CustomMRU));
    ok_hex(hr, S_OK);
    if (!SUCCEEDED(hr))
        return;

    Cleanup_Testdata();
    FillDefault(CustomMRU);
    verify_mru(CustomMRU, L"cba", L"FIRST_ENTRY", L"SECOND_ENTRY", L"THIRD_ENTRY");


    /* Add the first entry again */
    hr = CustomMRU->AddMRUString(L"FIRST_ENTRY");
    ok_hex(hr, S_OK);
    /* No change */
    verify_mru(CustomMRU, L"cba", L"FIRST_ENTRY", L"SECOND_ENTRY", L"THIRD_ENTRY");

    hr = CustomMRU->AddMRUString(L"SOMETHING_ELSE");
    ok_hex(hr, S_OK);
    /* Now all changes are persisted */
    verify_mru(CustomMRU, L"bac", L"FIRST_ENTRY", L"SOMETHING_ELSE", L"THIRD_ENTRY");
}

Referenced by START_TEST().

verify_mru_()

static void verify_mru_ ( const char *  file, int  line, IACLCustomMRU *  mru, PCWSTR  MRUString,   ...  )

static

Definition at line 70 of file IACLCustomMRU.cpp.

{

    CRegKey key;
    key.Open(HKEY_CURRENT_USER, szTestPath);

    va_list args;
    va_start(args, MRUString);
    PCWSTR Entry;
    WCHAR Key = L'a';
    while ((Entry = va_arg(args, PCWSTR)))
    {
        WCHAR Value[MAX_PATH];
        ULONG nChars = _countof(Value);
        CStringW tmp;
        tmp += Key;
        LSTATUS Status = key.QueryStringValue(tmp, Value, &nChars);
        ok_hex_(file, line, Key, Status, ERROR_SUCCESS);
        if (Status == ERROR_SUCCESS)
        {
            ok_(file, line)(!wcscmp(Value, Entry), "Expected value %c to be %S, was %S\n", (char)Key, Entry, Value);
        }
        Key++;
    }
    va_end(args);

    if (Key != L'a')
    {
        WCHAR Value[MAX_PATH];
        ULONG nChars = _countof(Value);
        LSTATUS Status = key.QueryStringValue(L"MRUList", Value, &nChars);
        ok_hex_(file, line, Key, Status, ERROR_SUCCESS);
        if (Status == ERROR_SUCCESS)
        {
            ok_(file, line)(!wcscmp(Value, MRUString), "Expected MRUList to be %S, was %S\n", MRUString, Value);
        }
    }
}

Variable Documentation

szTestPath

const WCHAR szTestPath[] = L"TESTPATH_BROWSEUI_APITEST"

static

Definition at line 43 of file IACLCustomMRU.cpp.

Referenced by Cleanup_Testdata(), FillDefault(), test_IACLCustomMRU_Basics(), test_IACLCustomMRU_Continue(), test_IACLCustomMRU_ExtraChars(), and verify_mru_().