LibreOffice: osl/diagnose.h File Reference

LibreOffice LibreOffice 5.2 SDK C/C++ API Reference

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List
- File Members

Macros
diagnose.h File Reference
`#include <sal/config.h>`
`#include <sal/detail/log.h>`
`#include <sal/saldllapi.h>`
`#include <sal/types.h>`

Go to the source code of this file.

## Macros
#define | OSL_DEBUG_LEVEL 0
| provides simple diagnostic support More...
#define | OSL_LOG_PREFIX SAL_DETAIL_WHERE
#define | OSL_TRACE(...) SAL_DETAIL_INFO_IF_FORMAT(OSL_DEBUG_LEVEL > 0, "legacy.osl", __VA_ARGS__)
#define | OSL_ASSERT(c) SAL_DETAIL_WARN_IF_FORMAT(!(c), "legacy.osl", "OSL_ASSERT: %s", #c)
#define | OSL_ENSURE(c, m) SAL_DETAIL_WARN_IF_FORMAT(!(c), "legacy.osl", "%s", m)
#define | OSL_FAIL(m) SAL_DETAIL_WARN_IF_FORMAT(sal_True, "legacy.osl", "%s", m)
#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_THIS_FUNC ""

## Macro Definition Documentation

#define OSL_ASSERT | ( |  | c | ) | SAL_DETAIL_WARN_IF_FORMAT(!(c), "legacy.osl", "OSL_ASSERT: %s", #c)

#define OSL_DEBUG_LEVEL 0

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)

#define OSL_ENSURE | ( |  | c,
|  |  | m
| ) |  | SAL_DETAIL_WARN_IF_FORMAT(!(c), "legacy.osl", "%s", m)

#define OSL_FAIL | ( |  | m | ) | SAL_DETAIL_WARN_IF_FORMAT(sal_True, "legacy.osl", "%s", m)

#define OSL_LOG_PREFIX SAL_DETAIL_WHERE

#define OSL_POSTCOND | ( |  | c,
|  |  | m
| ) |  | OSL_ENSURE(c, m)

#define OSL_PRECOND | ( |  | c,
|  |  | m
| ) |  | OSL_ENSURE(c, m)

#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)