libraries_debug.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2000, 2004-2005, 2007, 2017-2018, 2020, 2023, 2026 Carlo Wood
// SPDX-License-Identifier: MIT
 
#pragma once

 
#ifndef LIBCWD_LIBRARIES_DEBUG_H
#define LIBCWD_LIBRARIES_DEBUG_H
 
#ifdef CWDEBUG
 
#include "libcwd/config.h"
 
// See https://gcc.gnu.org/onlinedocs/libstdc++/manual/debug_mode_using.html#debug_mode.using.mode for more information on -D_GLIBCXX_DEBUG
#if defined(_GLIBCXX_DEBUG) && !CWDEBUG_GLIBCXX_DEBUG
#error Libcwd was not compiled with -D_GLIBCXX_DEBUG while your application is. Please reconfigure libcwd with --enable-glibcxx-debug.
#endif
#if !defined(_GLIBCXX_DEBUG) && CWDEBUG_GLIBCXX_DEBUG
#error Libcwd was compiled with -D_GLIBCXX_DEBUG but your application is not. Please reconfigure libcwd without --enable-glibcxx-debug or use -D_GLIBCXX_DEBUG.
#endif
 
//===================================================================================================
// The global debug channels used by libcwd.
//
 
#include "AlwaysChannel.h"
#include "Channel.h"
#include "ContinuedChannel.h"
#include "FatalChannel.h"
 
namespace libcwd::channels::dc {
 
extern Channel debug;
extern Channel notice;
extern Channel system;
extern Channel warning;
#if CWDEBUG_LOCATION
extern Channel elfutils;
#endif
extern FatalChannel fatal;
extern FatalChannel core;
extern ContinuedChannel continued;
extern ContinuedChannel finish;
extern AlwaysChannel always;
 
} // namespace libcwd::channels::dc
 
//===================================================================================================
// The global debug object
//
 
#include "DebugObject.h"
 
namespace libcwd {
 
extern DebugObject libcw_do;

void initialize();
 
// Called from main_reached defined in include/libcwd/config.h.in. This does further initialization.
extern void internal_main_reached();
// Returns true once main_reached() was called.
extern bool test_main_reached();
 
} // namespace libcwd
 
//===================================================================================================
// Macros
//
 
#include "macro_Libcwd_macros.h"
 
//===================================================================================================
// Miscellaneous
//
 
namespace libcwd {
 
extern Channel* find_channel(char const* label);
extern void list_channels_on(DebugObject& debug_object);
 
// Make the inserter functions of std accessible in libcwd.
using std::operator<<;
 
} // namespace libcwd
 
// Make the inserter functions of libcwd accessible in global namespace.
namespace libcwd_inserters {
using libcwd::operator<<;
} // namespace libcwd_inserters
using namespace libcwd_inserters;
 
#include "attach_gdb.h"
#include "RcFile.h"
#include "demangle.h"
#include "LibcwdForAllDebugChannels.h"
#include "LibcwdForAllDebugObjects.h"
#include "private/environ.h"
 
// Include the inline functions.
#include "AlwaysChannel.inl.h"
#include "Channel.inl.h" // Debug channels.
#include "ChannelSet.inl.h" // Used in macro Dout et al.
#include "ContinuedChannel.inl.h"
#include "DebugObject.inl.h" // Debug objects (DebugObject).
#include "DebugString.inl.h" // Public member of DebugObject.
#include "FatalChannel.inl.h"
#include "Location.inl.h"
 
// Include optional features.
#if CWDEBUG_LOCATION // ‑DEnableLibcwdLocation:BOOL=ON
#include "elfutils.h"
#endif
 
#endif // CWDEBUG
#endif // LIBCWD_LIBRARIES_DEBUG_H