From: Vibhav Pant vibhavp@gmail.com
--- dlls/combase/tests/Makefile.in | 2 +- dlls/combase/tests/roapi.c | 305 +++++++++++++++++++++++++++++++++ include/roerrorapi.h | 3 + 3 files changed, 309 insertions(+), 1 deletion(-)
diff --git a/dlls/combase/tests/Makefile.in b/dlls/combase/tests/Makefile.in index 21597b38d51..ea76b746555 100644 --- a/dlls/combase/tests/Makefile.in +++ b/dlls/combase/tests/Makefile.in @@ -1,5 +1,5 @@ TESTDLL = combase.dll -IMPORTS = combase uuid user32 +IMPORTS = combase kernel32 oleaut32 uuid user32
SOURCES = \ combase.rc \ diff --git a/dlls/combase/tests/roapi.c b/dlls/combase/tests/roapi.c index 6ba30ad87a7..6c5cc2319bf 100644 --- a/dlls/combase/tests/roapi.c +++ b/dlls/combase/tests/roapi.c @@ -783,6 +783,310 @@ static void test_RoSetErrorReportingFlags(void) set_error_reporting_flags(RO_ERROR_REPORTING_USESETERRORINFO); }
+static void get_hresult_message(HRESULT code, WCHAR *buf, ULONG len) +{ + static const WCHAR *fallback = L"The text associated with this error code could not be found.\r\n"; + + if (!FormatMessageW(FORMAT_MESSAGE_FROM_SYSTEM, NULL, code, 0, buf, len, NULL)) + wcscpy(buf, fallback); +} + +#define test_IRestrictedErrorInfo(info, code, rest_desc, ref) \ + test_IRestrictedErrorInfo_(__LINE__, info, code, rest_desc, ref) +static void test_IRestrictedErrorInfo_(int line, IRestrictedErrorInfo *r_info, HRESULT exp_code, + const WCHAR *exp_rest_desc, const WCHAR *exp_ref) +{ + BSTR desc = NULL, rest_desc = NULL, sid = NULL, ref = NULL, str; + GUID guid = IID_IUnknown; + HRESULT hr, code = S_OK; + WCHAR default_msg[513]; + const WCHAR *str2; + IErrorInfo *info; + ULONG count, ctx; + + default_msg[0] = L'\0'; + get_hresult_message(exp_code, default_msg, ARRAY_SIZE(default_msg)); + + hr = IRestrictedErrorInfo_GetErrorDetails(r_info, &desc, &code, &rest_desc, &sid); + ok_(__FILE__, line)(hr == S_OK, "GetErrorDetails failed, hr %#lx.\n", hr); + ok_(__FILE__, line)(desc && !wcscmp(desc, default_msg), "Got desc %s != %s.\n", debugstr_w(desc), debugstr_w(default_msg)); + ok_(__FILE__, line)(code == exp_code, "Got unexpected code %#lx.\n", code); + str2 = exp_rest_desc ? exp_rest_desc : default_msg; + ok_(__FILE__, line)(rest_desc && !wcscmp(rest_desc, str2), "Got rest_desc %s != %s.\n", debugstr_w(rest_desc), + debugstr_w(str2)); + SysFreeString(desc); + SysFreeString(rest_desc); + + hr = IRestrictedErrorInfo_GetReference(r_info, &ref); + ok_(__FILE__, line)(hr == S_OK, "GetReference failed, hr %#lx.\n", hr); + ok_(__FILE__, line)((!ref && !exp_ref) || (ref && !wcscmp(ref, exp_ref)), "Got ref %s != %s.\n", debugstr_w(ref), + debugstr_w(exp_ref)); + SysFreeString(ref); + + /* IRestrictedErrorInfo objects also implement IErrorInfo. */ + hr = IRestrictedErrorInfo_QueryInterface(r_info, &IID_IErrorInfo, (void **)&info); + ok(hr == S_OK, "QueryInterface failed, hr %#lx.\n", hr); + + hr = IErrorInfo_GetGUID(info, &guid); + ok(hr == S_OK, "GetGUID failed, hr %#lx.\n", hr); + ok(IsEqualGUID(&guid, &GUID_NULL), "Got unexpected guid %s.\n", debugstr_guid(&guid)); + + desc = NULL; + hr = IErrorInfo_GetDescription(info, &desc); + ok(hr == S_OK, "GetDescription failed, hr %#lx.\n", hr); + ok(desc && !wcscmp(desc, default_msg), "GetDescription returned desc %s != %s\n", debugstr_w(desc), debugstr_w(default_msg)); + SysFreeString(desc); + + str = (BSTR)0xdeadbeef; + hr = IErrorInfo_GetSource(info, &str); + ok(hr == S_OK, "GetSource failed, hr %#lx.\n", hr); + ok(!str, "GetSource returned str %p.\n", debugstr_w(str)); + + str = (BSTR)0xdeadbeef; + hr = IErrorInfo_GetHelpFile(info, &str); + ok(hr == S_OK, "GetHelpFile failed, hr %#lx.\n", hr); + ok(!str, "GetHelpFile returned str %p.\n", debugstr_w(str)); + + ctx = 0xdeadbeef; + hr = IErrorInfo_GetHelpContext(info, &ctx); + ok(hr == S_OK, "GetHelpContext failed, hr %#lx.\n", hr); + ok(!ctx, "GetHelpContext returned ctx %#lx.\n", ctx); + + IErrorInfo_Release(info); + /* GetRestrictedErrorInfo transfers ownership of the object to the caller. */ + count = IRestrictedErrorInfo_Release(r_info); + ok(count == 0, "Got unexpected count %lu.\n", count); +} + +static BOOL exception_caught; +static HRESULT exp_hresult; +static ULONG exp_len; +static const WCHAR *exp_msg; + +static LONG WINAPI vectored_eh(EXCEPTION_POINTERS *ptr) +{ + const EXCEPTION_RECORD *rec = ptr->ExceptionRecord; + const WCHAR *msg = (WCHAR *)rec->ExceptionInformation[2]; + + exception_caught = TRUE; + ok(rec->NumberParameters == 3, "Got unexpected NumberParameters %lu.\n", rec->NumberParameters); + ok(rec->ExceptionCode == EXCEPTION_RO_ORIGINATEERROR, "Got unexpected ExceptionCode %#lx.\n", rec->ExceptionCode); + ok((HRESULT)rec->ExceptionInformation[0] == exp_hresult, "Got unexpected ExceptionInformation[0] %#Ix != %#lx.\n", + rec->ExceptionInformation[0], exp_hresult); + ok(rec->ExceptionInformation[1] == exp_len, "Got unexpected ExceptionInformation[1] %Iu != %lu.\n", + rec->ExceptionInformation[1], exp_len); + ok((!msg && !exp_msg) || (msg && exp_msg && !wcscmp(msg, exp_msg)), + "Got unexpected ExceptionInformation[2] %s != %s.\n", debugstr_w(msg), debugstr_w(exp_msg)); + return EXCEPTION_CONTINUE_SEARCH; +} + +static void test_RoOriginateError(void) +{ + static const HRESULT test_codes[] = {E_INVALIDARG, E_FAIL, E_BOUNDS, E_NOINTERFACE, E_ABORT, E_CHANGED_STATE, RO_E_CLOSED, 0xdeffbeef}; + static const WCHAR message_nul[] = {'W', 'i', 'n', 'e', '\0', 'H', 'Q', '\0'}; + static const WCHAR *message = L"Wine is not an emulator."; + + WCHAR message_large[600], message_trunc[513], default_msg[513]; + const BOOL debugger = IsDebuggerPresent(); + IRestrictedErrorInfo *r_info; + void *handler; + HRESULT hr; + BOOL ret; + int i; + + /* RoOriginateError will only raise a structured exception if: + * A debugger is attached to the process, or + * RO_ERROR_REPORTING_FORCEEXCEPTIONS is set. + * In either case, setting RO_ERROR_REPORTING_SUPPRESSEXCEPTIONS will not cause an exception to be raised. */ + handler = RtlAddVectoredExceptionHandler(1, vectored_eh); + ok(!!handler, "RtlAddVectoredExceptionHandler returned NULL.\n"); + + /* Using non-failure HRESULT values returns FALSE. No error information is set, and no exception is thrown. */ + exception_caught = FALSE; + ret = RoOriginateError(S_OK, NULL); + ok(!ret, "RoOriginateError returned %d.\n", ret); + ok(!exception_caught, "Got unexpected exception_caught %d.\n", exception_caught); + + set_error_reporting_flags(RO_ERROR_REPORTING_USESETERRORINFO | RO_ERROR_REPORTING_FORCEEXCEPTIONS); + exception_caught = FALSE; + ret = RoOriginateError(S_FALSE, NULL); + ok(!ret, "RoOriginateError returned %d.\n", ret); + ok(!exception_caught, "Got unexpected exception_caught %d.\n", exception_caught); + + memset(message_large, L'c', sizeof(message_large)); + message_large[ARRAY_SIZE(message_large) - 1] = L'\0'; + memcpy(message_trunc, message_large, sizeof(WCHAR) * 512); + message_trunc[512] = L'\0'; + + for (i = 0; i < ARRAY_SIZE(test_codes); i++) + { + HSTRING_BUFFER hstr_buf; + HSTRING_HEADER hstr_hdr; + HSTRING msg = NULL; + IErrorInfo *info; + WCHAR *buf; + + winetest_push_context("test_codes[%d]", i); + + default_msg[0] = L'\0'; + get_hresult_message(test_codes[i], default_msg, ARRAY_SIZE(default_msg)); + + set_error_reporting_flags(RO_ERROR_REPORTING_USESETERRORINFO); + exception_caught = FALSE; + exp_hresult = test_codes[i]; + exp_len = wcslen(default_msg); + exp_msg = default_msg[0] ? default_msg : NULL; + ret = RoOriginateError(test_codes[i], NULL); + todo_wine ok(ret, "RoOriginateError returned %d.\n", ret); + todo_wine_if(debugger) + ok(exception_caught == debugger, "Got unexpected exception_caught %d.\n", exception_caught); + hr = GetRestrictedErrorInfo(&r_info); + todo_wine ok(hr == S_OK, "Got unexpected hr %#lx.\n", hr); + if (SUCCEEDED(hr)) test_IRestrictedErrorInfo(r_info, test_codes[i], NULL, NULL); + + /* A NULL string with a non-zero length is accepted. */ + exception_caught = FALSE; + ret = RoOriginateError(test_codes[i], NULL); + todo_wine ok(ret, "RoOriginateError returned %d.\n", ret); + todo_wine_if(debugger) + ok(exception_caught == debugger, "Got unexpected exception_caught %d.\n", exception_caught); + hr = GetRestrictedErrorInfo(&r_info); + todo_wine ok(hr == S_OK, "Got unexpected hr %#lx.\n", hr); + if (SUCCEEDED(hr)) test_IRestrictedErrorInfo(r_info, test_codes[i], NULL, NULL); + + /* RO_ERROR_REPORTING_FORCEEXCEPTIONS overrides RO_ERROR_REPORTING_SUPPRESSEXCEPTIONS */ + set_error_reporting_flags(RO_ERROR_REPORTING_USESETERRORINFO | RO_ERROR_REPORTING_SUPPRESSEXCEPTIONS | + RO_ERROR_REPORTING_FORCEEXCEPTIONS); + exception_caught = FALSE; + ret = RoOriginateErrorW(test_codes[i], 0, NULL); + todo_wine ok(ret, "RoOriginateErrorW returned %d.\n", ret); + todo_wine ok(exception_caught, "Got unexpected exception_caught %d.\n", exception_caught); + hr = GetRestrictedErrorInfo(&r_info); + todo_wine ok(hr == S_OK, "Got unexpected hr %#lx.\n", hr); + if (SUCCEEDED(hr)) test_IRestrictedErrorInfo(r_info, test_codes[i], NULL, NULL); + + set_error_reporting_flags(RO_ERROR_REPORTING_USESETERRORINFO); + exception_caught = FALSE; + exp_len = wcslen(message); + exp_msg = message; + /* RoOriginateError with a custom error message. */ + WindowsCreateStringReference(message, wcslen(message), &hstr_hdr, &msg); + ret = RoOriginateError(test_codes[i], msg); + todo_wine ok(ret, "RoOriginateError returned %d.\n", ret); + todo_wine_if(debugger) + ok(exception_caught == debugger, "Got unexpected exception_caught %d.\n", exception_caught); + hr = GetRestrictedErrorInfo(&r_info); + todo_wine ok(hr == S_OK, "Got unexpected hr %#lx.\n", hr); + if (SUCCEEDED(hr)) test_IRestrictedErrorInfo(r_info, test_codes[i], message, NULL); + + set_error_reporting_flags(RO_ERROR_REPORTING_USESETERRORINFO | RO_ERROR_REPORTING_FORCEEXCEPTIONS); + exception_caught = FALSE; + ret = RoOriginateErrorW(test_codes[i], wcslen(message), message); + todo_wine ok(ret, "RoOriginateErrorW returned %d.\n", ret); + todo_wine ok(exception_caught, "Got unexpected exception_caught %d.\n", exception_caught); + hr = GetRestrictedErrorInfo(&r_info); + todo_wine ok(hr == S_OK, "Got unexpected hr %#lx.\n", hr); + if (SUCCEEDED(hr)) test_IRestrictedErrorInfo(r_info, test_codes[i], message, NULL); + + exception_caught = FALSE; + ret = RoOriginateErrorW(test_codes[i], 0, message); + todo_wine ok(ret, "RoOriginateErrorW returned %d.\n", ret); + todo_wine ok(exception_caught, "Got unexpected exception_caught %d.\n", exception_caught); + hr = GetRestrictedErrorInfo(&r_info); + todo_wine ok(hr == S_OK, "Got unexpected hr %#lx.\n", hr); + if (SUCCEEDED(hr)) test_IRestrictedErrorInfo(r_info, test_codes[i], message, NULL); + + /* Error messages longer than 512 characters are truncated. */ + exception_caught = FALSE; + exp_len = wcslen(message_trunc); + exp_msg = message_trunc; + WindowsCreateStringReference(message_large, wcslen(message_large), &hstr_hdr, &msg); + ret = RoOriginateError(test_codes[i], msg); + todo_wine ok(ret, "RoOriginateError returned %d.\n", ret); + todo_wine ok(exception_caught, "Got unexpected exception_caught %d.\n", exception_caught); + hr = GetRestrictedErrorInfo(&r_info); + todo_wine ok(hr == S_OK, "Got unexpected hr %#lx.\n", hr); + if (SUCCEEDED(hr)) test_IRestrictedErrorInfo(r_info, test_codes[i], message_trunc, NULL); + + exception_caught = FALSE; + ret = RoOriginateErrorW(test_codes[i], wcslen(message_large), message_large); + todo_wine ok(ret, "RoOriginateErrorW returned %d.\n", ret); + todo_wine ok(exception_caught, "Got unexpected exception_caught %d.\n", exception_caught); + hr = GetRestrictedErrorInfo(&r_info); + todo_wine ok(hr == S_OK, "Got unexpected hr %#lx.\n", hr); + if (SUCCEEDED(hr)) test_IRestrictedErrorInfo(r_info, test_codes[i], message_trunc, NULL); + + exception_caught = FALSE; + ret = RoOriginateErrorW(test_codes[i], 0, message_large); + todo_wine ok(ret, "RoOriginateErrorW returned %d.\n", ret); + todo_wine ok(exception_caught, "Got unexpected exception_caught %d.\n", exception_caught); + hr = GetRestrictedErrorInfo(&r_info); + todo_wine ok(hr == S_OK, "Got unexpected hr %#lx.\n", hr); + if (SUCCEEDED(hr)) test_IRestrictedErrorInfo(r_info, test_codes[i], message_trunc, NULL); + + /* RoOriginateError with a custom error message containing an embedded NUL. */ + exception_caught = FALSE; + exp_len = wcslen(message_nul); + exp_msg = message_nul; + hr = WindowsPreallocateStringBuffer(ARRAY_SIZE(message_nul), &buf, &hstr_buf); + ok(hr == S_OK, "Got unexpected hr %#lx.\n", hr); + memcpy(buf, message_nul, sizeof(message_nul)); + hr = WindowsPromoteStringBuffer(hstr_buf, &msg); + ok(hr == S_OK, "Got unexpected hr %#lx\n", hr); + ret = RoOriginateError(test_codes[i], msg); + todo_wine ok(ret, "RoOriginateError returned %d.\n", ret); + todo_wine ok(exception_caught, "Got unexpected exception_caught %d.\n", exception_caught); + WindowsDeleteString(msg); + /* MSDN says that RoOriginateError uses SetErrorInfo to set the error object for the current thread, so we + * should be able to get the it through GetErrorInfo as well. */ + hr = GetErrorInfo(0, &info); + todo_wine ok(hr == S_OK, "Got unexpected hr %#lx.\n", hr); + if (hr == S_OK) + { + hr = IErrorInfo_QueryInterface(info, &IID_IRestrictedErrorInfo, (void **)&r_info); + ok(hr == S_OK, "Got unexpected hr %#lx.\n", hr); + IErrorInfo_Release(info); + test_IRestrictedErrorInfo(r_info, test_codes[i], message_nul, NULL); + } + + exception_caught = FALSE; + ret = RoOriginateErrorW(test_codes[i], ARRAY_SIZE(message_nul), message_nul); + todo_wine ok(ret, "RoOriginateErrorW returned %d.\n", ret); + todo_wine ok(exception_caught, "Got unexpected exception_caught %d.\n", exception_caught); + hr = GetRestrictedErrorInfo(&r_info); + todo_wine ok(hr == S_OK, "Got unexpected hr %#lx.\n", hr); + if (SUCCEEDED(hr)) test_IRestrictedErrorInfo(r_info, test_codes[i], message_nul, NULL); + + winetest_pop_context(); + } + + /* Disable SetErrorInfo, and suppress exceptions. */ + exception_caught = FALSE; + set_error_reporting_flags(RO_ERROR_REPORTING_NONE | RO_ERROR_REPORTING_SUPPRESSEXCEPTIONS); + ret = RoOriginateError(E_FAIL, NULL); + todo_wine ok(ret, "RoOriginateError returned %d.\n", ret); + ok(!exception_caught, "Got unexpected exception_caught %d.\n", exception_caught); + r_info = (IRestrictedErrorInfo *)0xdeadbeef; + hr = GetRestrictedErrorInfo(&r_info); + todo_wine ok(hr == S_FALSE, "Got unexpected hr %#lx.\n", hr); + todo_wine ok(!r_info, "Got unexpected r_info %p\n", r_info); + ret = RtlRemoveVectoredExceptionHandler(handler); + ok(ret, "RtlRemoveVectoredExceptionHandler returned %d.\n", ret); + + /* RO_ERROR_REPORTING_SUPPRESSSETERRORINFO overrides RO_ERROR_REPORTING_USESETERRORINFO. */ + set_error_reporting_flags(RO_ERROR_REPORTING_USESETERRORINFO | RO_ERROR_REPORTING_SUPPRESSSETERRORINFO); + ret = RoOriginateError(E_FAIL, NULL); + todo_wine ok(ret, "RoOriginateError returned %d.\n", ret); + hr = GetRestrictedErrorInfo(&r_info); + todo_wine ok(hr == S_FALSE, "Got unexpected hr %#lx.\n", hr); + hr = GetRestrictedErrorInfo(&r_info); + todo_wine ok(hr == S_FALSE, "Got unexpected hr %#lx.\n", hr); + todo_wine ok(!r_info, "Got unexpected r_info %p\n", r_info); + + /* Restore the default flags. */ + set_error_reporting_flags(RO_ERROR_REPORTING_USESETERRORINFO); +} + START_TEST(roapi) { BOOL ret; @@ -794,6 +1098,7 @@ START_TEST(roapi) test_RoGetAgileReference(); test_RoGetErrorReportingFlags(); test_RoSetErrorReportingFlags(); + test_RoOriginateError();
SetLastError(0xdeadbeef); ret = DeleteFileW(L"wine.combase.test.dll"); diff --git a/include/roerrorapi.h b/include/roerrorapi.h index 8f3200c559d..99ab59418be 100644 --- a/include/roerrorapi.h +++ b/include/roerrorapi.h @@ -32,6 +32,9 @@ typedef enum RO_ERROR_REPORTING_SUPPRESSSETERRORINFO = 0x8, } RO_ERROR_REPORTING_FLAGS;
+#define EXCEPTION_RO_ORIGINATEERROR 0x40080201 +#define EXCEPTION_RO_TRANSFORMERROR 0x40080202 + HRESULT WINAPI GetRestrictedErrorInfo(IRestrictedErrorInfo **info); HRESULT WINAPI RoGetErrorReportingFlags(UINT32 *flags); BOOL WINAPI RoOriginateError(HRESULT error, HSTRING message);