assert.h revision 1c94c0a63ba68be1a7b2c640e70d7a06464e4fca
/** @file
* MS COM / XPCOM Abstraction Layer:
*/
/*
* Copyright (C) 2006-2007 Sun Microsystems, Inc.
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) 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.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 USA or visit http://www.sun.com if you need
* additional information or have any questions.
*/
#ifndef ___VBox_com_assert_h
#define ___VBox_com_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) \
/**
* 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
*/
/**
* 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) \
/**
* 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) \
/**
* 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
*/
/**
* A special version of AssertComRC that evaluates the given expression and
* throws it if the result code is failed.
*
* @param rc COM result code
* @param eval the expression to evaluate
*/
/**
* A special version of AssertComRC that just breaks if the result code is
* failed.
*
* @param rc COM result code
*/
#define AssertComRCBreakRC(rc) \
/**
* A special version of AssertComRC that just throws @a rc if the result code is
* failed.
*
* @param rc COM result code
*/
#define AssertComRCThrowRC(rc) \
/**
* 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) \
/**
* Checks whether the given COM result code is successful.
* If not, executes the break statement.
*
* @param rc COM result code
*/
#define CheckComRCBreakRC(rc) \
/**
* Checks whether the given COM result code is successful.
* If not, throws the given COM result.
*
* @param rc COM result code
*/
#define CheckComRCThrowRC(rc) \
/*
* 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) \
do { \
} while (0)
/**
* Prints the extended error information.
* Used by command line tools or for debugging.
*
* @param info com::ErrorInfo instance
*/
#define PRINT_ERROR_INFO(info) \
do { \
} 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
*
* Used by command line tools or for debugging and assumes the |HRESULT rc|
* variable is accessible for assigning in the current scope.
*/
do { \
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) \
/**
* Does the same as CHECK_RC(), but executes the |break| statement on
* failure.
*/
#define CHECK_RC_BREAK(method) \
/**
* 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
* 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.
*/
do \
{ \
} \
} while (0)
/**
* Does the same as CHECK_ERROR(), but executes the |return ret| statement on
* failure.
*/
/**
* Does the same as CHECK_ERROR(), but executes the |break| statement on
* failure.
*/
#define CHECK_ERROR_NOCALL() \
do { \
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 { \
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) \
/**
* Does the same as CHECK_ERROR_NI(), but executes the |break| statement
* on failure.
*/
#define CHECK_ERROR_NI_BREAK(method) \
/**
* Asserts the given expression is true. When the expression is false, prints
*/
do { \
if (!(expr)) \
{ \
} \
} while (0)
/**
* Does the same as ASSERT(), but executes the |return ret| statement if the
* expression to assert is false.
*/
/**
* Does the same as ASSERT(), but executes the |break| statement if the
* expression to assert is false.
*/
#define ASSERT_BREAK(expr) \
#endif