Global Functions in Global Namespace C++
in Sourcefile diagnose.h
- osl_assertFailedLine
- extern "C"
sal_Bool osl_assertFailedLine(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- osl_breakDebug
- extern "C"
void osl_breakDebug(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- provides simple diagnostic support
- Description
- 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)
- osl_reportError
- extern "C"
sal_Int32 osl_reportError(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- osl_setDebugMessageFunc
- extern "C"
pfunc_osl_printDebugMessage osl_setDebugMessageFunc(
pfunc_osl_printDebugMessage |
pNewFunc ); |
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- sets a message delivery function
- Description
- 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 message.
- osl_setDetailedDebugMessageFunc
- extern "C"
pfunc_osl_printDetailedDebugMessage osl_setDetailedDebugMessageFunc(
pfunc_osl_printDetailedDebugMessage |
pNewFunc ); |
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- sets a delivery function for detailed message information.
- Description
- The given message handler must be able to cope with a message.
- osl_trace
- extern "C"
void osl_trace(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
Top of Page
Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.
LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.
The Document Foundation acknowledges all community members, please find more info at our website.
Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.