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 #ifndef INCLUDED_OSL_DIAGNOSE_H
  22 #define INCLUDED_OSL_DIAGNOSE_H
  23
  24 #include <sal/config.h>
  25
  26 #include <sal/detail/log.h>
  27 #include <sal/saldllapi.h>
  28 #include <sal/types.h>
  29
  30 /** provides simple diagnostic support
  31
  32     The facilities provided by this header are deprecated.  True assertions
  33     (that detect broken program logic) should use standard assert (which aborts
  34     if an assertion fails, and is controlled by the standard NDEBUG macro).
  35     Logging of warnings (e.g., about malformed input) and traces (e.g., about
  36     steps taken while executing some protocol) should use the facilities
  37     provided by (C++ only) sal/log.hxx.
  38
  39     Because the assertion macros (OSL_ASSERT, OSL_ENSURE, OSL_FAIL, OSL_PRECOND,
  40     and OSL_POSTCOND) have been used for true assertions as well as for logged
  41     warnings, they map to SAL_WARN instead of standard assert.  OSL_TRACE maps
  42     to SAL_INFO.
  43
  44     The functions defined in this header are not intended to be used directly,
  45     but through defined macros. The macros can be divided into three categories:
  46     assertions, traces and other stuff .-) Their usability depends on the value
  47     of OSL_DEBUG_LEVEL macro: assertions are only active if OSL_DEBUG_LEVEL is 1
  48     or greater, traces if OSL_DEBUG_LEVEL is 2 or greater.
  49
  50     Assertions (cond is bool, msg is char*):
  51     OSL_ASSERT(cond)
  52         If cond is false, reports an error.
  53
  54     OSL_ENSURE(cond, msg)
  55         If cond is false, reports an error with message msg.
  56
  57     OSL_FAIL(msg)
  58         Reports an error with message msg unconditionally.
  59
  60     OSL_PRECOND(cond, msg)
  61     OSL_POSTCOND(cond, msg)
  62         These two are functionally equivalent to OSL_ENSURE(cond, msg). They are
  63         intended to be used for checking pre- and postconditions of functions.
  64
  65     Traces:
  66     OSL_TRACE(fmt, args...)
  67         Prints trace message. The arguments have the same meaning as the
  68         arguments of printf.
  69
  70     Other:
  71     OSL_VERIFY(expr)
  72         Evaluates the expression and if it is false, reports an error. The
  73         expression is evaluated once without regard of the value of
  74         OSL_DEBUG_LEVEL.
  75
  76         Example:
  77
  78         void extractBool(Any const& rAny, bool& rBool)
  79         {
  80             OSL_VERIFY(rAny >>= rBool);
  81         }
  82
  83     OSL_DEBUG_ONLY(expr)
  84  */
  85
  86 #if !defined OSL_DEBUG_LEVEL
  87 #define OSL_DEBUG_LEVEL 0
  88 #endif
  89
  90 /* the macro OSL_LOG_PREFIX is intended to be an office internal macro for now
  91
  92    it is deprecated and superseded by (C++ only) SAL_WHERE
  93 */
  94 #define OSL_LOG_PREFIX SAL_DETAIL_WHERE
  95
  96 #define OSL_TRACE(...) \
  97     SAL_DETAIL_INFO_IF_FORMAT(OSL_DEBUG_LEVEL > 0, "legacy.osl", __VA_ARGS__)
  98
  99 #define OSL_ASSERT(c) \
 100     SAL_DETAIL_WARN_IF_FORMAT(!(c), "legacy.osl", "OSL_ASSERT: %s", #c)
 101 #define OSL_ENSURE(c, m) SAL_DETAIL_WARN_IF_FORMAT(!(c), "legacy.osl", "%s", m)
 102 #define OSL_FAIL(m) SAL_DETAIL_WARN_IF_FORMAT(sal_True, "legacy.osl", "%s", m)
 103
 104 #define OSL_VERIFY(c) do { if (!(c)) OSL_ASSERT(0); } while (0)
 105 #define OSL_PRECOND(c, m)   OSL_ENSURE(c, m)
 106 #define OSL_POSTCOND(c, m)  OSL_ENSURE(c, m)
 107
 108
 109 /* the macro OSL_THIS_FUNC is intended to be an office internal macro for now */
 110 /* copied from boost/current_function.hpp to make it usable from C
 111  * sources as well
 112  *
 113  * Copyright (c) 2002 Peter Dimov and Multi Media Ltd.
 114  *
 115  * Distributed under the Boost Software License, Version 1.0. (See
 116  * accompanying file LICENSE_1_0.txt or copy at
 117  * http://www.boost.org/LICENSE_1_0.txt) */
 118 #if defined(__GNUC__)
 119 #define OSL_THIS_FUNC __PRETTY_FUNCTION__
 120 #elif defined(__FUNCSIG__)
 121 #define OSL_THIS_FUNC __FUNCSIG__
 122 #elif defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901)
 123 #define OSL_THIS_FUNC __func__
 124 #else
 125 #define OSL_THIS_FUNC ""
 126 #endif
 127
 128 #endif // INCLUDED_OSL_DIAGNOSE_H
 129
 130 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */