src/xmlpatterns/utils/qdebug_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   6 **
   7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 //
  43 //  W A R N I N G
  44 //  -------------
  45 //
  46 // This file is not part of the Qt API.  It exists purely as an
  47 // implementation detail.  This header file may change from version to
  48 // version without notice, or even be removed.
  49 //
  50 // We mean it.
  51
  52 #ifndef Patternist_Debug_H
  53 #define Patternist_Debug_H
  54
  55 #include <QtDebug>
  56 /**
  57  * @file
  58  * @short Contains macros for debugging.
  59  */
  60
  61 QT_BEGIN_NAMESPACE
  62
  63 /**
  64  * @short Enables detailed parser debug output.
  65  *
  66  * If this macro is defined, @em a @em lot of debugging information will be outputted.
  67  * This is all the state transitions, token shifting, and rule reductions that
  68  * the parser do.
  69  *
  70  * This is automatically disabled if @c QT_NO_DEBUG is defined.
  71  */
  72 #define Patternist_DEBUG_PARSER
  73
  74 /**
  75  * @short Enables debug printing statements.
  76  *
  77  * Patternist does not use qDebug(), but pDebug() instead. It only output
  78  * if this define is defined.
  79  *
  80  * It is automatically disabled if @c QT_NO_DEBUG is defined.
  81  */
  82 #define Patternist_DEBUG
  83
  84 #undef Patternist_DEBUG // disable it for now
  85
  86 #ifdef QT_NO_DEBUG
  87 #   undef Patternist_DEBUG_PARSER
  88 #   undef Patternist_DEBUG
  89 #endif
  90
  91 namespace QPatternist
  92 {
  93 #ifdef Patternist_DEBUG
  94     inline QDebug pDebug()
  95     {
  96         return qDebug();
  97     }
  98 #else
  99     inline QNoDebug pDebug()
 100     {
 101         return QNoDebug();
 102     }
 103 #endif
 104 }
 105
 106 QT_END_NAMESPACE
 107 #endif