My Project
UDK 3.2.7 C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Macros | Typedefs | Functions
diagnose.h File Reference
#include "sal/config.h"
#include <sal/detail/log.h>
#include <sal/types.h>

Go to the source code of this file.

Macros

#define OSL_THIS_FILE   __FILE__
#define OSL_LOG_PREFIX   SAL_DETAIL_WHERE
#define OSL_DEBUG_ONLY(s)   _OSL_DEBUG_ONLY(s)
#define OSL_TRACE(...)   SAL_DETAIL_INFO_IF_FORMAT(OSL_DEBUG_LEVEL > 0, "legacy.osl", __VA_ARGS__)
#define OSL_ASSERT(c)   ((void) 0)
#define OSL_ENSURE(c, m)   ((void) 0)
#define OSL_FAIL(m)   ((void) 0)
#define OSL_VERIFY(c)   do { if (!(c)) OSL_ASSERT(0); } while (0)
#define OSL_PRECOND(c, m)   OSL_ENSURE(c, m)
#define OSL_POSTCOND(c, m)   OSL_ENSURE(c, m)
#define _OSL_GLOBAL   ::
#define _OSL_DEBUG_ONLY(f)   ((void)0)
#define OSL_THIS_FUNC   ""

Typedefs

typedef void(* pfunc_osl_printDebugMessage )(const sal_Char *pszMessage)
 a message delivery function which receives a pre-formatted message string
typedef void(* pfunc_osl_printDetailedDebugMessage )(const sal_Char *pszFileName, sal_Int32 nLine, const sal_Char *pszMessage)
 a message delivery function which receives detailed information about where the message was triggered

Functions

SAL_DLLPUBLIC void osl_breakDebug (void)
 provides simple diagnostic support
SAL_DLLPUBLIC sal_Bool osl_assertFailedLine (const sal_Char *pszFileName, sal_Int32 nLine, const sal_Char *pszMessage)
SAL_DLLPUBLIC void osl_trace (const sal_Char *pszFormat,...)
SAL_DLLPUBLIC sal_Int32 osl_reportError (sal_uInt32 nType, const sal_Char *pszErrorMessage)
SAL_DLLPUBLIC
pfunc_osl_printDebugMessage 
osl_setDebugMessageFunc (pfunc_osl_printDebugMessage pNewFunc)
 sets a message delivery function
SAL_DLLPUBLIC
pfunc_osl_printDetailedDebugMessage 
osl_setDetailedDebugMessageFunc (pfunc_osl_printDetailedDebugMessage pNewFunc)
 sets a delivery function for detailed message information.

Macro Definition Documentation

#define _OSL_DEBUG_ONLY (   f)    ((void)0)
#define _OSL_GLOBAL   ::
#define OSL_ASSERT (   c)    ((void) 0)
#define OSL_DEBUG_ONLY (   s)    _OSL_DEBUG_ONLY(s)
#define OSL_ENSURE (   c,
 
)    ((void) 0)
#define OSL_FAIL (   m)    ((void) 0)
#define OSL_LOG_PREFIX   SAL_DETAIL_WHERE
#define OSL_POSTCOND (   c,
 
)    OSL_ENSURE(c, m)
#define OSL_PRECOND (   c,
 
)    OSL_ENSURE(c, m)
#define OSL_THIS_FILE   __FILE__
#define OSL_THIS_FUNC   ""
#define OSL_TRACE (   ...)    SAL_DETAIL_INFO_IF_FORMAT(OSL_DEBUG_LEVEL > 0, "legacy.osl", __VA_ARGS__)
#define OSL_VERIFY (   c)    do { if (!(c)) OSL_ASSERT(0); } while (0)

Typedef Documentation

typedef void( * pfunc_osl_printDebugMessage)(const sal_Char *pszMessage)

a message delivery function which receives a pre-formatted message string

typedef void( * pfunc_osl_printDetailedDebugMessage)(const sal_Char *pszFileName, sal_Int32 nLine, const sal_Char *pszMessage)

a message delivery function which receives detailed information about where the message was triggered

Function Documentation

SAL_DLLPUBLIC sal_Bool osl_assertFailedLine ( const sal_Char pszFileName,
sal_Int32  nLine,
const sal_Char pszMessage 
)
SAL_DLLPUBLIC void osl_breakDebug ( void  )

provides simple diagnostic support

The facilities provided by this header are deprecated. True assertions (that detect broken program logic) should use standard assert (which aborts if an assertion fails, and is controlled by the standard NDEBUG macro). Logging of warnings (e.g., about malformed input) and traces (e.g., about steps taken while executing some protocol) should use the facilities provided by (C++ only) sal/log.hxx.

Because the assertion macros (OSL_ASSERT, OSL_ENSURE, OSL_FAIL, OSL_PRECOND, and OSL_POSTCOND) have been used for true assertions as well as for logged warnings, they map to SAL_WARN instead of standard assert. OSL_TRACE maps to SAL_INFO.

The functions defined in this header are not intended to be used directly, but through defined macros. The macros can be divided into three categories: assertions, traces and other stuff .-) Their usability depends on the value of OSL_DEBUG_LEVEL macro: assertions are only active if OSL_DEBUG_LEVEL is 1 or greater, traces if OSL_DEBUG_LEVEL is 2 or greater.

Assertions (cond is bool, msg is char*): OSL_ASSERT(cond) If cond is false, reports an error.

OSL_ENSURE(cond, msg) If cond is false, reports an error with message msg.

OSL_FAIL(msg) Reports an error with message msg unconditionally.

OSL_PRECOND(cond, msg) OSL_POSTCOND(cond, msg) These two are functionally equivalent to OSL_ENSURE(cond, msg). They are intended to be used for checking pre- and postconditions of functions.

Traces: OSL_TRACE(fmt, args...) Prints trace message. The arguments have the same meaning as the arguments of printf.

Other: OSL_VERIFY(expr) Evaluates the expression and if it is false, reports an error. The expression is evaluated once without regard of the value of OSL_DEBUG_LEVEL.

Example:

void extractBool(Any const& rAny, bool& rBool) { OSL_VERIFY(rAny >>= rBool); }

OSL_DEBUG_ONLY(expr)

SAL_DLLPUBLIC sal_Int32 osl_reportError ( sal_uInt32  nType,
const sal_Char pszErrorMessage 
)

sets a message delivery function

The function set here is ignored if a function for detailed message information (pfunc_osl_printDetailedDebugMessage) has been set.

The given message handler must be able to cope with a null message.

sets a delivery function for detailed message information.

The given message handler must be able to cope with a null message.

SAL_DLLPUBLIC void osl_trace ( const sal_Char pszFormat,
  ... 
)