ChannelSet.h

Go to the documentation of this file.

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

 
#ifndef LIBCWD_CLASS_CHANNEL_SET_H
#define LIBCWD_CLASS_CHANNEL_SET_H
 
#include "control_flag.h"
#include "private/ThreadSpecificData.h"
#include "libcwd/config.h"
 
namespace libcwd {
 
class DebugObject;
struct DebugObject_ThreadSpecificData;
class Channel;
class FatalChannel;
 
//===================================================================================================
// struct ChannelSetData
//
// The attributes of ChannelSetBootstrap, ChannelSet and ContinuedChannelSet
//
 
struct ChannelSetData
{
  char const* label;
  // The label of the most left channel that is turned on.
 
  control_flag_t mask;
  // The bit-wise OR mask of all control flags and special channels.
 
  bool on;
  // Set if at least one of the provided channels is turned on.
 
  DebugObject_ThreadSpecificData* debug_object_tsd_ptr;
  // Thread specific data of current debug object.
 
#if CWDEBUG_DEBUG
  ChannelSetData() : debug_object_tsd_ptr(nullptr) { }
#endif
};
 
//===================================================================================================
// class ChannelSetBootstrap
//
// This is the left-most type of channel 'control' series
// existing of <ChannelSetBootstrap>|<one or more channels>|<optional control flags>.
// It is used in macro LibcwDoutScopeBegin.
//
// LibcwdDoutFatalScopeBegin uses FatalChannelSetBootstrap,
// to make sure it was used with dc::fatal or dc::core.
//
// The return type is a cast of this object to
// either a ChannelSet (the normal case) or a
// ContinuedChannelSet in the case that the
// special debug channel dc::continued was used.
//
 
class Channel;
class FatalChannel;
class ContinuedChannel;
class AlwaysChannel;
class ChannelSet;
class ContinuedChannelSet;
 
class ChannelSetBootstrap : public ChannelSetData
{
  // Warning: This struct may not have attributes of its own!
 public:
  ChannelSetBootstrap(DebugObject_ThreadSpecificData& debug_object_tsd, LIBCWD_TSD_PARAM_UNUSED)
  {
    debug_object_tsd_ptr = &debug_object_tsd;
  }
 
  //-------------------------------------------------------------------------------------------------
  // Operators that combine channels/control bits.
  //
 
  ChannelSet& operator|(Channel const& dc);
  ChannelSet& operator|(AlwaysChannel const& adc);
  ContinuedChannelSet& operator|(ContinuedChannel const& cdc);
};
 
class FatalChannelSetBootstrap : public ChannelSetData
{
  // Warning: This struct may not have attributes of its own!
 public:
  FatalChannelSetBootstrap(DebugObject_ThreadSpecificData& debug_object_tsd, LIBCWD_TSD_PARAM_UNUSED)
  {
    debug_object_tsd_ptr = &debug_object_tsd;
  }
 
  //-------------------------------------------------------------------------------------------------
  // Operators that combine channels/control bits.
  //
  ChannelSet& operator|(FatalChannel const& fdc);
};
 
//===================================================================================================
// class ChannelSet
//
// The debug output target; a combination of channels and control bits.
// The final result of a series of <channel>|<control flag>|...
// is passed to struct_debug_tsd_st::start().
//
 
class ChannelSet : public ChannelSetData
{
  // Warning: This class may not have attributes of its own!
 public:
  ChannelSet& operator|(control_flag_t cf);
  ChannelSet& operator|(Channel const& dc);
  ChannelSet& operator|(FatalChannel const& fdc);
  ContinuedChannelSet& operator|(continued_cf_nt);
};
 
//===================================================================================================
// class ContinuedChannelSet
//
// The channel set type used for a series that starts with dc::continued.
//
 
class ContinuedChannelSet : public ChannelSetData
{
  // Warning: This class may not have attributes of its own!
 public:
  ContinuedChannelSet& operator|(control_flag_t cf);
};
 
} // namespace libcwd
 
#endif // LIBCWD_CLASS_CHANNEL_SET_H