Trace.h File Reference

#include "colony_config.h"
#include "Cpl/Text/String.h"
#include "Cpl/System/Thread.h"
#include "Cpl/Io/Output.h"

Include dependency graph for Trace.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	Cpl::System::Trace
	This concrete class provide a 'printf' tracing mechanism. More...

Namespaces
namespace	Cpl
	The 'Cpl' namespace is the root name space for the Colony.
namespace	Cpl::System
	The System namespace contains platform independent foundation abstractions and classes related to program execution.

Macros
#define	CPL_SYSTEM_TRACE_FUNC(sect)
	Macro Wrapper.
#define	CPL_SYSTEM_TRACE_SCOPE(sect, label)
	Macro Wrapper.
#define	CPL_SYSTEM_TRACE_MSG(sect, var_args)
	Macro Wrapper.
#define	CPL_SYSTEM_TRACE_ENABLE()
	Macro Wrapper.
#define	CPL_SYSTEM_TRACE_DISABLE()
	Macro Wrapper.
#define	CPL_SYSTEM_TRACE_IS_ENABLED()   false
	Macro Wrapper.
#define	CPL_SYSTEM_TRACE_IS_SECTION_ENABLED(sect)   false
	Macro Wrapper.
#define	CPL_SYSTEM_TRACE_SET_INFO_LEVEL(l)
	Macro Wrapper.
#define	CPL_SYSTEM_TRACE_GET_INFO_LEVEL()   ((Cpl::System::Trace::InfoLevel_T)0)
	Macro Wrapper.
#define	CPL_SYSTEM_TRACE_ENABLE_SECTION(sect)
	Macro Wrapper.
#define	CPL_SYSTEM_TRACE_DISABLE_SECTION(sect)
	Macro Wrapper.
#define	CPL_SYSTEM_TRACE_SET_THREAD_FILTER(t1)
	Macro Wrapper.
#define	CPL_SYSTEM_TRACE_SET_THREAD_2FILTERS(t1, t2)
	Macro Wrapper.
#define	CPL_SYSTEM_TRACE_SET_THREAD_3FILTERS(t1, t2, t3)
	Macro Wrapper.
#define	CPL_SYSTEM_TRACE_SET_THREAD_4FILTERS(t1, t2, t3, t4)
	Macro Wrapper.
#define	CPL_SYSTEM_TRACE_GET_THREAD_FILTERS(dst)   0
	Macro Wrapper.
#define	CPL_SYSTEM_TRACE_CLEAR_THREAD_FILTER()
	Macro Wrapper.
#define	CPL_SYSTEM_TRACE_GET_SECTIONS(dst)   0
	Macro Wrapper.
#define	CPL_SYSTEM_TRACE_REDIRECT(newdst)
	Macro Wrapper.
#define	CPL_SYSTEM_TRACE_REVERT()
	Macro Wrapper.
#define	CPL_SYSTEM_TRACE_IS_COMPILED()   false
	Returns false if TRACE was NOT activated/enabled at compile time.
#define	CPL_SYSTEM_TRACE_ALLOCATE(type, varname, initval)
	Macro Wrapper.
#define	OPTION_CPL_SYSTEM_TRACE_MAX_SECTIONS   8
	The default maximum number of actively enabled 'sections' supported.
#define	OPTION_CPL_SYSTEM_TRACE_MAX_SECTION_NAME_LEN   63
	The default maximum size, in bytes, for a section name (not including the null terminator).
#define	OPTION_CPL_SYSTEM_TRACE_MAX_BUFFER   511
	The size, in bytes (without the null terminator), of trace engine's internal String use to construct a complete (info + user msg) trace message.
#define	OPTION_CPL_SYSTEM_TRACE_PREFIX_STRING   ">> "
	String literal that is the prefix for all trace messages.
#define	OPTION_CPL_SYSTEM_TRACE_SUFFIX_STRING   "\n"
	String literal that is the final suffix for all trace messages.
#define	OPTION_CPL_SYSTEM_TRACE_DEFAULT_INFO_LEVEL   Cpl::System::Trace::eBRIEF
	The compile time default setting for the info level.
#define	OPTION_CPL_SYSTEM_TRACE_DEFAULT_ENABLE_STATE   true
	The compile time default setting what enable/disable state the trace starts in.

Macro Definition Documentation

CPL_SYSTEM_TRACE_ALLOCATE

#define CPL_SYSTEM_TRACE_ALLOCATE	(		type,
			varname,
			initval
	)

Macro Wrapper.

CPL_SYSTEM_TRACE_CLEAR_THREAD_FILTER

#define CPL_SYSTEM_TRACE_CLEAR_THREAD_FILTER

(

)

Macro Wrapper.

CPL_SYSTEM_TRACE_DISABLE

#define CPL_SYSTEM_TRACE_DISABLE

(

)

Macro Wrapper.

CPL_SYSTEM_TRACE_DISABLE_SECTION

#define CPL_SYSTEM_TRACE_DISABLE_SECTION

(

sect

)

Macro Wrapper.

CPL_SYSTEM_TRACE_ENABLE

#define CPL_SYSTEM_TRACE_ENABLE

(

)

Macro Wrapper.

CPL_SYSTEM_TRACE_ENABLE_SECTION

#define CPL_SYSTEM_TRACE_ENABLE_SECTION

(

sect

)

Macro Wrapper.

CPL_SYSTEM_TRACE_FUNC

#define CPL_SYSTEM_TRACE_FUNC

(

sect

)

Macro Wrapper.

CPL_SYSTEM_TRACE_GET_INFO_LEVEL

#define CPL_SYSTEM_TRACE_GET_INFO_LEVEL

(

)

((Cpl::System::Trace::InfoLevel_T)0)

Macro Wrapper.

CPL_SYSTEM_TRACE_GET_SECTIONS

#define CPL_SYSTEM_TRACE_GET_SECTIONS

(

dst

)

0

Macro Wrapper.

CPL_SYSTEM_TRACE_GET_THREAD_FILTERS

#define CPL_SYSTEM_TRACE_GET_THREAD_FILTERS

(

dst

)

0

Macro Wrapper.

CPL_SYSTEM_TRACE_IS_COMPILED

#define CPL_SYSTEM_TRACE_IS_COMPILED

(

)

false

Returns false if TRACE was NOT activated/enabled at compile time.

CPL_SYSTEM_TRACE_IS_ENABLED

#define CPL_SYSTEM_TRACE_IS_ENABLED

(

)

false

Macro Wrapper.

CPL_SYSTEM_TRACE_IS_SECTION_ENABLED

#define CPL_SYSTEM_TRACE_IS_SECTION_ENABLED

(

sect

)

false

Macro Wrapper.

CPL_SYSTEM_TRACE_MSG

#define CPL_SYSTEM_TRACE_MSG	(		sect,
			var_args
	)

Macro Wrapper.

CPL_SYSTEM_TRACE_REDIRECT

#define CPL_SYSTEM_TRACE_REDIRECT

(

newdst

)

Macro Wrapper.

CPL_SYSTEM_TRACE_REVERT

#define CPL_SYSTEM_TRACE_REVERT

(

)

Macro Wrapper.

CPL_SYSTEM_TRACE_SCOPE

#define CPL_SYSTEM_TRACE_SCOPE	(		sect,
			label
	)

Macro Wrapper.

CPL_SYSTEM_TRACE_SET_INFO_LEVEL

#define CPL_SYSTEM_TRACE_SET_INFO_LEVEL

(

l

)

Macro Wrapper.

CPL_SYSTEM_TRACE_SET_THREAD_2FILTERS

#define CPL_SYSTEM_TRACE_SET_THREAD_2FILTERS	(		t1,
			t2
	)

Macro Wrapper.

CPL_SYSTEM_TRACE_SET_THREAD_3FILTERS

#define CPL_SYSTEM_TRACE_SET_THREAD_3FILTERS	(		t1,
			t2,
			t3
	)

Macro Wrapper.

CPL_SYSTEM_TRACE_SET_THREAD_4FILTERS

#define CPL_SYSTEM_TRACE_SET_THREAD_4FILTERS	(		t1,
			t2,
			t3,
			t4
	)

Macro Wrapper.

CPL_SYSTEM_TRACE_SET_THREAD_FILTER

#define CPL_SYSTEM_TRACE_SET_THREAD_FILTER

(

t1

)

Macro Wrapper.

OPTION_CPL_SYSTEM_TRACE_DEFAULT_ENABLE_STATE

#define OPTION_CPL_SYSTEM_TRACE_DEFAULT_ENABLE_STATE   true

The compile time default setting what enable/disable state the trace starts in.

OPTION_CPL_SYSTEM_TRACE_DEFAULT_INFO_LEVEL

#define OPTION_CPL_SYSTEM_TRACE_DEFAULT_INFO_LEVEL   Cpl::System::Trace::eBRIEF

The compile time default setting for the info level.

OPTION_CPL_SYSTEM_TRACE_MAX_BUFFER

#define OPTION_CPL_SYSTEM_TRACE_MAX_BUFFER   511

The size, in bytes (without the null terminator), of trace engine's internal String use to construct a complete (info + user msg) trace message.

OPTION_CPL_SYSTEM_TRACE_MAX_SECTION_NAME_LEN

#define OPTION_CPL_SYSTEM_TRACE_MAX_SECTION_NAME_LEN   63

The default maximum size, in bytes, for a section name (not including the null terminator).

OPTION_CPL_SYSTEM_TRACE_MAX_SECTIONS

#define OPTION_CPL_SYSTEM_TRACE_MAX_SECTIONS   8

The default maximum number of actively enabled 'sections' supported.

OPTION_CPL_SYSTEM_TRACE_PREFIX_STRING

#define OPTION_CPL_SYSTEM_TRACE_PREFIX_STRING   ">> "

String literal that is the prefix for all trace messages.

OPTION_CPL_SYSTEM_TRACE_SUFFIX_STRING

#define OPTION_CPL_SYSTEM_TRACE_SUFFIX_STRING   "\n"

String literal that is the final suffix for all trace messages.