include/tools/debug.hxx

   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 #ifndef INCLUDED_TOOLS_DEBUG_HXX
  20 #define INCLUDED_TOOLS_DEBUG_HXX
  21
  22 #include <tools/toolsdllapi.h>
  23
  24 #include <sal/detail/log.h>
  25
  26 /** The facilities provided by this header are deprecated.  True assertions
  27     (that detect broken program logic) should use standard assert (which aborts
  28     if an assertion fails, and is controlled by the standard NDEBUG macro).
  29     Logging of warnings (e.g., about malformed input) should use the facilities
  30     provided by sal/log.hxx.
  31
  32     Because the assertion macro (DBG_ASSERT) has been used for
  33     true assertions as well as to log warnings, it maps to SAL_WARN instead of
  34     standard assert.
  35 */
  36
  37 typedef void (*DbgTestSolarMutexProc)();
  38
  39 TOOLS_DLLPUBLIC void DbgSetTestSolarMutex( DbgTestSolarMutexProc pParam );
  40 TOOLS_DLLPUBLIC void DbgTestSolarMutex();
  41
  42 #ifndef NDEBUG
  43 // we want the solar mutex checking to be enabled in the assert-enabled builds that the QA people use
  44
  45 #define DBG_TESTSOLARMUTEX()   \
  46 do                             \
  47 {                              \
  48     DbgTestSolarMutex();       \
  49 } while(false)
  50
  51 #else
  52
  53 #define DBG_TESTSOLARMUTEX() ((void)0)
  54
  55 #endif
  56
  57 #define DBG_ASSERT( sCon, aError ) \
  58     SAL_DETAIL_WARN_IF_FORMAT(!(sCon), "legacy.tools", "%s", aError)
  59
  60
  61 #endif // INCLUDED_TOOLS_DEBUG_HXX
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */