LibreOffice
LibreOffice 6.0 SDK C/C++ API Reference
diagnose.h
Go to the documentation of this file.
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 
57 #if !defined OSL_DEBUG_LEVEL
58 #define OSL_DEBUG_LEVEL 0
59 #endif
60 
64 #define OSL_LOG_PREFIX SAL_DETAIL_WHERE
65 
70 #define OSL_TRACE(...) \
71  SAL_DETAIL_INFO_IF_FORMAT(OSL_DEBUG_LEVEL > 0, "legacy.osl", __VA_ARGS__)
72 
81 #define OSL_ASSERT(c) \
82  SAL_DETAIL_WARN_IF_FORMAT(!(c), "legacy.osl", "OSL_ASSERT: %s", #c)
83 
84 #define OSL_ENSURE(c, m) SAL_DETAIL_WARN_IF_FORMAT(!(c), "legacy.osl", "%s", m)
85 
86 #define OSL_FAIL(m) SAL_DETAIL_WARN_IF_FORMAT(sal_True, "legacy.osl", "%s", m)
87 
103 #define OSL_VERIFY(c) do { if (!(c)) OSL_ASSERT(0); } while (0)
104 
109 #define OSL_PRECOND(c, m) OSL_ENSURE(c, m)
110 
115 #define OSL_POSTCOND(c, m) OSL_ENSURE(c, m)
116 
119 /* the macro OSL_THIS_FUNC is intended to be an office internal macro for now */
120 /* copied from boost/current_function.hpp to make it usable from C
121  * sources as well
122  *
123  * Copyright (c) 2002 Peter Dimov and Multi Media Ltd.
124  *
125  * Distributed under the Boost Software License, Version 1.0. (See
126  * accompanying file LICENSE_1_0.txt or copy at
127  * http://www.boost.org/LICENSE_1_0.txt) */
128 #if defined(__GNUC__)
129 #define OSL_THIS_FUNC __PRETTY_FUNCTION__
130 #elif defined(__FUNCSIG__)
131 #define OSL_THIS_FUNC __FUNCSIG__
132 #elif defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901)
133 #define OSL_THIS_FUNC __func__
134 #else
135 #define OSL_THIS_FUNC ""
136 #endif
137 
138 #endif // INCLUDED_OSL_DIAGNOSE_H
139 
140 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */