debug.h

Go to the documentation of this file.

// $Header$
//
// Copyright (C) 2000 - 2004, by
//
// Carlo Wood, Run on IRC <carlo@alinoe.com>
// RSA-1024 0x624ACAD5 1997-01-26                    Sign & Encrypt
// Fingerprint16 = 32 EC A7 B6 AC DB 65 A6  F6 F6 55 DD 1C DC FF 61
//
// This file may be distributed under the terms of the Q Public License
// version 1.0 as appearing in the file LICENSE.QPL included in the
// packaging of this file.
//
 
#ifndef CWDEBUG
 
// If you run into this error then you included <libcwd/debug.h> (or any other libcwd header file)
// while the macro CWDEBUG was not defined.  Doing so would cause the compilation of your
// application to fail on machines that do not have libcwd installed.  Instead you should use:
// #include "debug.h"
// and add a file debug.h to your applications distribution.  Please see the the example-project
// that comes with the source code of libcwd (or is included in the documentation that comes with
// the rpm (ie: /usr/doc/libcwd-1.0/example-project) for a description of the content of "debug.h".
// Note1: CWDEBUG should be defined on the compiler commandline, for example: g++ -DCWDEBUG ...
#error "You are including <libcwd/debug.h> while CWDEBUG is not defined.  See the comments in this header file for more information."
 
#else // CWDEBUG (normal usage of this file):
 
#ifndef LIBCWD_SYS_H
#error "You need to #include "sys.h" at the top of every source file (which in turn should #include "sys.h")."
#endif
 
#if defined(LIBCWD_DEFAULT_DEBUGCHANNELS) && defined(DEBUGCHANNELS)
// If you run into this error then you included <libcwd/debug.h> (or any other libcwd header file)
// without defining DEBUGCHANNELS, and later (the moment of this error) you included it with
// DEBUGCHANNELS defined.
//
// The most likely reason for this is that you include <libcwd/debug.h> in one of your headers
// instead of using #include "debug.h", and then included that header file before including
// "debug.h" in the .cpp file.
// End-applications should #include "debug.h" everywhere.  See the the example-project that comes
// with the source code of libcwd (or is included in the documentation that comes with the rpm
// (ie: /usr/doc/libcwd-1.0/example-project) for a description of the content of "debug.h".
// More information for end-application users can be found on
// http://carlowood.github.io/libcwd/reference-manual/preparation.html
//
// Third-party libraries should never include <libcwd/debug.h> but also not "debug.h".  They
// should include <libcwd/libraries_debug.h> (and not use Dout et al in their headers).  If you
// are using a library that did include <libcwd/debug.h> then please report this bug the author
// of that library.  You can workaround it for now by including "debug.h" before including the
// header of that library.
// More information for library authors that use libcwd can be found on
// http://carlowood.github.io/libcwd/reference-manual/group__chapter__custom__debug__h.html
#error "DEBUGCHANNELS is defined while previously it was not defined.  See the comments in this header file for more information."
#endif
 
#endif // CWDEBUG
 
#ifndef LIBCWD_DEBUG_H
#define LIBCWD_DEBUG_H
 
#ifdef CWDEBUG
 
// The following header is also needed for end-applications, despite its name.
#include "libraries_debug.h"
 
#ifndef LIBCWD_DOXYGEN
 
// The real code
#ifdef DEBUGCHANNELS
#define LIBCWD_DEBUGCHANNELS DEBUGCHANNELS
#else
#define LIBCWD_DEBUGCHANNELS libcwd::channels
#define LIBCWD_DEFAULT_DEBUGCHANNELS
#endif
 
#else // LIBCWD_DOXYGEN
 
// This is only here for the documentation.  The user will define DEBUGCHANNELS, not LIBCWD_DEBUGCHANNELS.
#define DEBUGCHANNELS
#endif // LIBCWD_DOXYGEN
 
// For use in applications
#define Debug(STATEMENTS...) \
    LibcwDebug(LIBCWD_DEBUGCHANNELS, STATEMENTS)
 
#define Dout(cntrl, data) \
    LibcwDout(LIBCWD_DEBUGCHANNELS, ::libcwd::libcw_do, cntrl, data)
 
#define DoutFatal(cntrl, data) \
    LibcwDoutFatal(LIBCWD_DEBUGCHANNELS, ::libcwd::libcw_do, cntrl, data)
 
#define ForAllDebugChannels(STATEMENT...) \
    LibcwdForAllDebugChannels(LIBCWD_DEBUGCHANNELS, STATEMENT)
 
#define ForAllDebugObjects(STATEMENT...) \
    LibcwdForAllDebugObjects(LIBCWD_DEBUGCHANNELS, STATEMENT)
 
// Finally, in order for Dout() to be usable, we need this.
#ifndef LIBCW_IOSTREAM
#define LIBCW_IOSTREAM
#include <iostream>
#endif
 
#endif // CWDEBUG
#endif // LIBCWD_DEBUG_H