include/osl/diagnose.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 /*
  21  * This file is part of LibreOffice published API.
  22  */
  23
  24 #ifndef INCLUDED_OSL_DIAGNOSE_H
  25 #define INCLUDED_OSL_DIAGNOSE_H
  26
  27 #include "sal/config.h"
  28
  29 #include "sal/detail/log.h"
  30 #include "sal/types.h"
  31
  32 /** @file
  33     Provides simple diagnostic support.
  34
  35     @deprecated
  36     The facilities provided by this header are deprecated.  True assertions
  37     (that detect broken program logic) should use standard assert (which aborts
  38     if an assertion fails, and is controlled by the standard NDEBUG macro).
  39     Logging of warnings (e.g., about malformed input) and traces (e.g., about
  40     steps taken while executing some protocol) should use the facilities
  41     provided by (C++ only) sal/log.hxx.
  42
  43     Because the assertion macros (OSL_ASSERT, OSL_ENSURE, OSL_FAIL, OSL_PRECOND,
  44     and OSL_POSTCOND) have been used for true assertions as well as for logged
  45     warnings, they map to SAL_WARN instead of standard assert.  OSL_TRACE maps
  46     to SAL_INFO.
  47
  48     The functions defined in this header are not intended to be used directly,
  49     but through defined macros. The macros can be divided into three categories:
  50     assertions, traces and other stuff .-) Their usability depends on the value
  51     of OSL_DEBUG_LEVEL macro: assertions are only active if OSL_DEBUG_LEVEL is 1
  52     or greater, traces if OSL_DEBUG_LEVEL is 2 or greater.
  53
  54     Traces:
  55     OSL_TRACE(fmt, args...)
  56         Prints trace message. The arguments have the same meaning as the
  57         arguments of printf.
  58  */
  59
  60 #if !defined OSL_DEBUG_LEVEL
  61 #define OSL_DEBUG_LEVEL 0
  62 #endif
  63
  64 /** @internal The macro OSL_LOG_PREFIX is intended to be an office internal macro for now
  65     @deprecated superseded by (C++ only) SAL_WHERE
  66 */
  67 #define OSL_LOG_PREFIX SAL_DETAIL_WHERE
  68
  69 /** Prints trace message.
  70
  71     The arguments have the same meaning as the arguments of printf.
  72 */
  73 #define OSL_TRACE(...) \
  74     SAL_DETAIL_INFO_IF_FORMAT(OSL_DEBUG_LEVEL > 0, "legacy.osl", __VA_ARGS__)
  75
  76 /** @defgroup assert Assertions
  77
  78     Assertions (cond is bool, msg is char*).
  79
  80     @{
  81  */
  82
  83 /** If cond is false, reports an error. */
  84 #define OSL_ASSERT(c) \
  85     SAL_DETAIL_WARN_IF_FORMAT(!(c), "legacy.osl", "OSL_ASSERT: %s", #c)
  86 /** If cond is false, reports an error with message msg. */
  87 #define OSL_ENSURE(c, m) SAL_DETAIL_WARN_IF_FORMAT(!(c), "legacy.osl", "%s", m)
  88 /** Reports an error with message msg unconditionally. */
  89 #define OSL_FAIL(m) SAL_DETAIL_WARN_IF_FORMAT(sal_True, "legacy.osl", "%s", m)
  90
  91 /** Evaluates the expression and if it is false, reports an error. The
  92     expression is evaluated once without regard of the value of
  93     OSL_DEBUG_LEVEL.
  94
  95     Example:
  96
  97     @code{.c}
  98
  99     void extractBool(Any const& rAny, bool& rBool)
 100     {
 101         OSL_VERIFY(rAny >>= rBool);
 102     }
 103
 104     @endcode
 105 */
 106 #define OSL_VERIFY(c) do { if (!(c)) OSL_ASSERT(0); } while (0)
 107
 108 /** Check the precondition of functions.
 109
 110     Functionally equivalent to OSL_ENSURE(cond, msg).
 111 */
 112 #define OSL_PRECOND(c, m)   OSL_ENSURE(c, m)
 113
 114 /** Check the postcondition of functions.
 115
 116     Functionally equivalent to OSL_ENSURE(cond, msg).
 117 */
 118 #define OSL_POSTCOND(c, m)  OSL_ENSURE(c, m)
 119
 120 /** @} */
 121
 122 #endif // INCLUDED_OSL_DIAGNOSE_H
 123
 124 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */