debug.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2000-2004, 2017-2020, 2025-2026 Carlo Wood
// SPDX-License-Identifier: MIT
 
#pragma once
 
// Libcwd-2 defines things that were originally in cwds.
#include "cwds_debug.h"

 
#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 source distribution. Please see the the example-project
// that comes with the source code of libcwd (and is included in the documentation that comes with
// a libcwd package (ie: /usr/share/doc/libcwd/example-project) for a description of the content of "debug.h".
// Note: CWDEBUG should be defined on the compiler commandline, for example: g++ -DCWDEBUG ...
// which normally happens automatically, simply by linking with libcwd (when using cmake).
#error You are including <libcwd/debug.h> while CWDEBUG is not defined.  See the comments in this header file for more information.
 
#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"
 
// For use in applications
// clang-format off
#define Debug(/*STATEMENTS*/...) LibcwDebug(LIBCWD_DEBUG_CHANNELS, __VA_ARGS__)

#define Dout(cntrl, ...) LibcwDout(LIBCWD_DEBUG_CHANNELS, ::libcwd::libcw_do, cntrl, __VA_ARGS__)

#define DoutEntering(cntrl, ...)                                                \
  int __cwds_debug_indentation = 2;                                             \
  LibcwDoutScopeBegin(LIBCWD_DEBUG_CHANNELS, ::libcwd::libcw_do, cntrl)          \
  LibcwDoutStream << "Entering " << __VA_ARGS__;                                \
  LibcwDoutScopeEnd;                                                            \
  ::libcwd::Indent __cwds_debug_indent(__cwds_debug_indentation);

#define DoutFatal(cntrl, ...) LibcwDoutFatal(LIBCWD_DEBUG_CHANNELS, ::libcwd::libcw_do, cntrl, __VA_ARGS__)

#define ForAllDebugChannels(/*STATEMENT*/...) LibcwdForAllDebugChannels(LIBCWD_DEBUG_CHANNELS, __VA_ARGS__)

#define ForAllDebugObjects(/*STATEMENT*/...) LibcwdForAllDebugObjects(LIBCWD_DEBUG_CHANNELS, __VA_ARGS__)
 
namespace libcwd {

struct Indent
{
  int M_indent;

  explicit Indent(int indent) : M_indent(indent) { if (M_indent > 0) libcwd::libcw_do.inc_indent(M_indent); }

  ~Indent() { if (M_indent > 0) libcwd::libcw_do.dec_indent(M_indent); }
};

struct Mark
{
  int M_indent;

  explicit Mark(char m = '|') : M_indent(libcwd::libcw_do.get_indent())
  {
    libcwd::libcw_do.push_marker();
    libcwd::libcw_do.marker().append(std::string(M_indent, ' ') + m + ' ');
    // This is basically a decrement of M_indent.
    libcwd::libcw_do.set_indent(0);
  }
  explicit Mark(char const* utf8_m) : M_indent(libcwd::libcw_do.get_indent())
  {
    libcwd::libcw_do.push_marker();
    libcwd::libcw_do.marker().append(std::string(M_indent, ' ') + utf8_m + ' ');
    // This is basically a decrement of M_indent.
    libcwd::libcw_do.set_indent(0);
  }
#ifdef __cpp_char8_t
  explicit Mark(char8_t const* utf8_m) : Mark(reinterpret_cast<char const*>(utf8_m)) { }
#endif

  ~Mark() { end(); }
 
  void end()
  {
    if (M_indent != -1)
    {
      libcwd::libcw_do.pop_marker();
      // Restore indentation relative to possible other indentation increments that happened in the mean time.
      libcwd::libcw_do.inc_indent(M_indent);
      // Mark that end() was already called.
      M_indent = -1;
    }
  }
};
 
} // namespace libcwd
 
#endif // CWDEBUG
 
// clang-format on
#include <libcwd/init_functions.h>

#if defined(CWDEBUG) || !defined(NDEBUG)
#define CW_DEBUG 1
#else
#define CW_DEBUG 0
#endif
 
#ifdef CWDEBUG
 
NAMESPACE_DEBUG_START
using namespace libcwd::init_functions;
NAMESPACE_DEBUG_END
 
// Build the LIBCWD_DEBUG_CHANNELS::dc facade.
// Users should insert their debug channels in here.
NAMESPACE_DEBUG_CHANNELS_START
using namespace libcwd::channels::dc;
using libcwd::Channel;
NAMESPACE_DEBUG_CHANNELS_END
 
#endif // CWDEBUG
#endif // LIBCWD_DEBUG_H