assert.h revision 677833bc953b6cb418c701facbdcf4aa18d6c44e
/** @file
*
* MS COM / XPCOM Abstraction Layer:
* Assertion macros for COM/XPCOM
*/
/*
* Copyright (C) 2006 InnoTek Systemberatung GmbH
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License as published by the Free Software Foundation,
* in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
* distribution. VirtualBox OSE is distributed in the hope that it will
* be useful, but WITHOUT ANY WARRANTY of any kind.
*
* If you received this file as part of a commercial VirtualBox
* distribution, then only the terms of your commercial VirtualBox
* license agreement apply instead of the previous paragraph.
*/
#ifndef __VBox_com_assert_h__
#define __VBox_com_assert_h__
#include <iprt/assert.h>
/**
* Asserts that the COM result code is succeeded in strict builds.
* In non-strict builds the result code will be NOREF'ed to kill compiler warnings.
*
* @param rc COM result code
*/
#define AssertComRC(rc) \
do { AssertMsg (SUCCEEDED (rc), ("COM RC = 0x%08X\n", rc)); NOREF (rc); } while (0)
/**
* A special version of AssertComRC that returns the given expression
* if the result code is failed.
*
* @param rc COM result code
* @param ret the expression to return
*/
#define AssertComRCReturn(rc, ret) \
AssertMsgReturn (SUCCEEDED (rc), ("COM RC = 0x%08X\n", rc), ret)
/**
* A special version of AssertComRC that returns the given result code
* if it is failed.
*
* @param rc COM result code
* @param ret the expression to return
*/
#define AssertComRCReturnRC(rc) \
AssertMsgReturn (SUCCEEDED (rc), ("COM RC = 0x%08X\n", rc), rc)
/**
* A special version of AssertComRC that returns if the result code is failed.
*
* @param rc COM result code
* @param ret the expression to return
*/
#define AssertComRCReturnVoid(rc) \
AssertMsgReturnVoid (SUCCEEDED (rc), ("COM RC = 0x%08X\n", rc))
/**
* A special version of AssertComRC that evaluates the given expression and
* breaks if the result code is failed.
*
* @param rc COM result code
* @param eval the expression to evaluate
*/
#define AssertComRCBreak(rc, eval) \
if (1) { AssertComRC (rc); if (!SUCCEEDED (rc)) { eval; break; } } else do {} while (0)
/**
* A special version of AssertComRC that just breaks if the result code is
* failed.
*
* @param rc COM result code
*/
#define AssertComRCBreakRC(rc) \
if (1) { AssertComRC (rc); if (!SUCCEEDED (rc)) { break; } } else do {} while (0)
/**
* Checks whether the given COM result code is successful.
* If not, executes the return statement with this result code.
*
* @param rc COM result code
*/
#define CheckComRCReturnRC(rc) \
if (1) { if (!SUCCEEDED (rc)) return (rc); } else do {} while (0)
/**
* Checks whether the given COM result code is successful.
* If not, executes the break statement.
*
* @param rc COM result code
*/
#define CheckComRCBreakRC(rc) \
if (1) { if (!SUCCEEDED (rc)) { break; } } else do {} while (0)
/*
* A section of helpful macros for error output
*/
/**
* Prints a line describing the given COM result code.
* Used by command line tools or for debugging.
*/
#define PRINT_RC_MESSAGE(rc) \
RTPrintf ("[!] Primary RC = %Rwa\n", rc)
/**
* Prints the extended error information.
* Used by command line tools or for debugging.
*
* @param info com::ErrorInfo instance
*/
#define PRINT_ERROR_INFO(info) \
do { \
info.print ("[!] "); \
} while (0)
/**
* Calls the given interface method and then checks if the return value
* (COM result code) indicates a failure. If so, prints the failed
* function/line/file and the description of the result code.
*
* Used by command line tools or for debugging and assumes the |HRESULT rc|
* variable is accessible for assigning in the current scope.
*/
#define CHECK_RC(method) \
do { \
rc = method; \
if (FAILED (rc)) { \
RTPrintf("[!] FAILED calling " #method " at line %d!\n", __LINE__); \
PRINT_RC_MESSAGE(rc); \
} \
} while (0)
/**
* Does the same as CHECK_RC(), but executes the |return rc| statement on
* failure.
*/
#define CHECK_RC_RET(method) \
do { CHECK_RC (method); if (FAILED (rc)) return rc; } while (0)
/**
* Does the same as CHECK_RC(), but executes the |break| statement on
* failure.
*/
#define CHECK_RC_BREAK(method) \
if (1) { CHECK_RC (method); if (FAILED (rc)) break; } else do {} while (0)
/**
* Calls the given method of the given interface and then checks if the return
* value (COM result code) indicates a failure. If so, prints the failed
* function/line/file, the description of the result code and attempts to
* query the extended error information on the current thread (using
* com::ErrorInfo) if the interface reports that it supports error information.
*
* Used by command line tools or for debugging and assumes the |HRESULT rc|
* variable is accessible for assigning in the current scope.
*/
#define CHECK_ERROR(iface, method) \
do \
{ \
CHECK_RC(iface->method); \
if (FAILED(rc)) { \
com::ErrorInfo info (iface); \
info.print ("[!] "); \
} \
} while (0)
/**
* Does the same as CHECK_ERROR(), but executes the |return ret| statement on
* failure.
*/
#define CHECK_ERROR_RET(iface, method, ret) \
do { CHECK_ERROR (iface, method); if (FAILED (rc)) return (ret); } while (0)
/**
* Does the same as CHECK_ERROR(), but executes the |break| statement on
* failure.
*/
#define CHECK_ERROR_BREAK(iface, method) \
if (1) { CHECK_ERROR (iface, method); if (FAILED (rc)) break; } else do {} while (0)
#define CHECK_ERROR_NOCALL() \
do { \
com::ErrorInfo info; \
PRINT_ERROR_INFO (info); \
} while (0)
/**
* Does the same as CHECK_ERROR(), but doesn't need the interface pointer
* because doesn't do a check whether the interface supports error info or not.
*/
#define CHECK_ERROR_NI(method) \
do { \
CHECK_RC (method); \
if (FAILED (rc)) { \
com::ErrorInfo info; \
PRINT_ERROR_INFO (info); \
} \
} while (0)
/**
* Does the same as CHECK_ERROR_NI(), but executes the |return rc| statement
* on failure.
*/
#define CHECK_ERROR_NI_RET(method) \
do { CHECK_ERROR_NI (method); if (FAILED (rc)) return rc; } while (0)
/**
* Does the same as CHECK_ERROR_NI(), but executes the |break| statement
* on failure.
*/
#define CHECK_ERROR_NI_BREAK(method) \
if (1) { CHECK_ERROR_NI (method); if (FAILED (rc)) break; } else do {} while (0)
/**
* Asserts the given expression is true. When the expression is false, prints
* a line containing the failied function/line/file; otherwise does nothing.
*/
#define ASSERT(expr) \
do { \
if (!(expr)) \
RTPrintf("[!] ASSERTION FAILED at line %d: %s\n", __LINE__, #expr); \
} while (0)
/**
* Does the same as ASSERT(), but executes the |return ret| statement if the
* expression to assert is false.
*/
#define ASSERT_RET(expr, ret) \
do { ASSERT (expr); if (!(expr)) return (ret); } while (0)
/**
* Does the same as ASSERT(), but executes the |break| statement if the
* expression to assert is false.
*/
#define ASSERT_BREAK(expr) \
if (1) { ASSERT (expr); if (!(expr)) break; } else do {} while (0)
#endif // __VBox_com_assert_h__