Class for handling user debug/warnings/errors. Use instance of this class instead of 'std::cout' for all your regular io. Channel argument must be related to the location of the source file. For example if you create Tracer object in src/basic/scoring/myfile.cc, then channel must be something like 'basic.scoring.myfile'. More...

#include <Tracer.hh>

Inheritance diagram for basic::Tracer:

[legend]

Classes
class	TracerProxy

Public Member Functions
	Tracer (std::string const &channel="", TracerPriority priority=t_info, bool muted_by_default=false)
	Create Tracer object with given channel and priority. More...

	Tracer (std::string const &channel, utility::CSI::CSI_Enum const &channel_color, utility::CSI::CSI_Enum const &channel_name_color=utility::CSI::Nothing, TracerPriority priority=t_info, bool muted_by_default=false)
	Create Tracer object with channel color, channel name color and given channel and priority. More...

virtual	~Tracer ()

	Tracer (Tracer const &)=delete

Tracer &	operator= (Tracer const &)=delete

template<typename T >
TracerImpl &	operator<< (T const &entry)
	output operator We return a TracerImpl instead of ourself to make subsequent access faster. More...

TracerImpl &	operator<< (std::ostream &(*entry)(std::ostream &))

	operator std::ostream & ()
	Allow Tracer object to be passed to something expecting a std::ostream. More...

void	flush ()

void	flush_all_channels ()
	flush tracer buffer and flush buffers of all sub-channels ie: Fatal, Error, Warning, Info, Debug, Trace More...

bool	visible ()

bool	visible (int priority)

std::string const &	channel ()

TracerImpl &	operator() (int priority)

std::streamsize	width ()

std::streamsize	width (std::streamsize wide)

std::streamsize	precision ()

std::streamsize	precision (std::streamsize prec)

std::ios_base::fmtflags	flags ()

std::ios_base::fmtflags	flags (std::ios_base::fmtflags fmtfl)

Static Public Member Functions
static void	set_ios_hook (otstreamOP tr, std::string const &monitoring_channels_list, bool raw=true)
	TODO: See if we can kill any usage of this, except for the esoteric. More...

static std::string const &	get_all_channels_string ()

static bool	super_mute ()
	global super mute flag that allow to mute all io no matter what. More...

static void	super_mute (bool f)

Public Attributes
TracerProxy	Fatal
	channels with predefined priority levels. More...

TracerProxy	Error

TracerProxy	Warning

TracerProxy	Info

TracerProxy	Debug

TracerProxy	Trace

Static Public Attributes
static utility::CSI::CSI_Enum	Reset

static utility::CSI::CSI_Enum	Bold

static utility::CSI::CSI_Enum	Underline

static utility::CSI::CSI_Enum	Black

static utility::CSI::CSI_Enum	Red

static utility::CSI::CSI_Enum	Green

static utility::CSI::CSI_Enum	Yellow

static utility::CSI::CSI_Enum	Blue

static utility::CSI::CSI_Enum	Magenta

static utility::CSI::CSI_Enum	Cyan

static utility::CSI::CSI_Enum	White

static utility::CSI::CSI_Enum	bgBlack

static utility::CSI::CSI_Enum	bgRed

static utility::CSI::CSI_Enum	bgGreen

static utility::CSI::CSI_Enum	bgYellow

static utility::CSI::CSI_Enum	bgBlue

static utility::CSI::CSI_Enum	bgMagenta

static utility::CSI::CSI_Enum	bgCyan

static utility::CSI::CSI_Enum	bgWhite

Protected Member Functions
TracerImpl &	tracer_impl ()
	The function which handles the construct-on-first use. More...

virtual std::unique_ptr < TracerImpl >	create_impl ()

Private Attributes
std::string	channel_

utility::CSI::CSI_Enum	channel_color_

utility::CSI::CSI_Enum	channel_name_color_

TracerPriority	priority_

bool	muted_by_default_

Detailed Description

Class for handling user debug/warnings/errors. Use instance of this class instead of 'std::cout' for all your regular io. Channel argument must be related to the location of the source file. For example if you create Tracer object in src/basic/scoring/myfile.cc, then channel must be something like 'basic.scoring.myfile'.

Intended usage is as a global-scope static object. If you need a heap/stack allocated object, use the TracerImpl class directly.

The funky indirection to TracerImpl here is so that the heavy-weight TracerImpl object is only constructed on first use, and isn't static or thread_local

Constructor & Destructor Documentation

basic::Tracer::Tracer	(	std::string const &	channel = `""`,
		TracerPriority	priority = `t_info`,
		bool	muted_by_default = `false`
	)

Create Tracer object with given channel and priority.

basic::Tracer::Tracer	(	std::string const &	channel,
		utility::CSI::CSI_Enum const &	channel_color,
		utility::CSI::CSI_Enum const &	channel_name_color = `utility::CSI::Nothing`,
		TracerPriority	priority = `t_info`,
		bool	muted_by_default = `false`
	)

Create Tracer object with channel color, channel name color and given channel and priority.

Ex: static basic::Tracer Blue("blue", utility::CSI::Blue);

basic::Tracer::~Tracer ( )

virtualdefault

Ideally, we'd clean ourselves up from the tracer_impl_map, but that's complicated by it being a) thread-dependent, and b) subject to static initialization order fiasco (static destruction order fiasco) issues. Regardless, the associated TracerImpl will be flushed when the static tracer_impl_map gets destroyed. The one tricky bit is that the TracerImpl for non-static tracers stick around, and may accidentally be re-used if we re-use the same pointer ... so avoid non-static Tracer objects: use a TracerImpl directly instead.

basic::Tracer::Tracer ( Tracer const & )

delete