git.maemo.org Git - someplayer/blob - src/taglib/toolkit/tdebug.h

   1 /***************************************************************************
   2     copyright            : (C) 2002 - 2008 by Scott Wheeler
   3     email                : wheeler@kde.org
   4  ***************************************************************************/
   5
   6 /***************************************************************************
   7  *   This library is free software; you can redistribute it and/or modify  *
   8  *   it under the terms of the GNU Lesser General Public License version   *
   9  *   2.1 as published by the Free Software Foundation.                     *
  10  *                                                                         *
  11  *   This library is distributed in the hope that it will be useful, but   *
  12  *   WITHOUT ANY WARRANTY; without even the implied warranty of            *
  13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
  14  *   Lesser General Public License for more details.                       *
  15  *                                                                         *
  16  *   You should have received a copy of the GNU Lesser General Public      *
  17  *   License along with this library; if not, write to the Free Software   *
  18  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  *
  19  *   USA                                                                   *
  20  *                                                                         *
  21  *   Alternatively, this file is available under the Mozilla Public        *
  22  *   License Version 1.1.  You may obtain a copy of the License at         *
  23  *   http://www.mozilla.org/MPL/                                           *
  24  ***************************************************************************/
  25
  26 #ifndef TAGLIB_DEBUG_H
  27 #define TAGLIB_DEBUG_H
  28
  29 namespace TagLib {
  30
  31   class String;
  32   class ByteVector;
  33
  34 #ifndef DO_NOT_DOCUMENT
  35 #ifndef NDEBUG
  36
  37   /*!
  38    * A simple function that prints debugging output to cerr if debugging is
  39    * not disabled.
  40    *
  41    * \warning Do not use this outside of TagLib, it could lead to undefined
  42    * symbols in your build if TagLib is built with NDEBUG defined and your
  43    * application is not.
  44    *
  45    * \internal
  46    */
  47   void debug(const String &s);
  48
  49   /*!
  50    * For debugging binary data.
  51    *
  52    * \warning Do not use this outside of TagLib, it could lead to undefined
  53    * symbols in your build if TagLib is built with NDEBUG defined and your
  54    * application is not.
  55    *
  56    * \internal
  57    */
  58   void debugData(const ByteVector &v);
  59
  60 #else
  61
  62   // Define these to an empty statement if debugging is disabled.
  63
  64 #define debug(x)
  65 #define debugData(x)
  66
  67 #endif
  68 #endif
  69 }
  70
  71 #endif