Process-wide singleton logging hub with per-topic verbosity/debug levels. More...

#include <Utils.h>

Collaboration diagram for cmlabs::LogSystem:

Public Member Functions
	LogSystem ()
	~LogSystem ()

Static Public Member Functions
static bool	SetLogReceiver (LogReceiver *rec)
	Register a receiver that gets every accepted LogEntry.
static bool	SetLogFileOutput (const char *logfile, bool printOut=true)
	Direct log output to a file.
static bool	SetLogLevelDebug (uint8 level)
	Set the debug level threshold for all topics.
static bool	SetLogLevelDebug (uint8 subject, uint8 level)
	Set the debug level threshold for one topic.
static bool	SetLogLevelVerbose (uint8 level)
	Set the verbose (print) level threshold for all topics.
static bool	SetLogLevelVerbose (uint8 subject, uint8 level)
	Set the verbose (print) level threshold for one topic.
static bool	LogSystemPrint (uint32 source, uint8 subject, uint8 level, const char *formatstring,...)
	printf-style informational logging (usually invoked via the LogPrint macro).
static bool	LogSystemDebug (uint32 source, uint8 subject, uint8 level, const char *formatstring,...)
	printf-style debug logging (usually invoked via the LogDebug macro); same parameters as LogSystemPrint() but gated on the debug thresholds.

Public Attributes
uint8	logLevelVerbose [LOG_MAXCOUNT]
uint8	logLevelDebug [LOG_MAXCOUNT]
LogReceiver *	logReceiverObj
char *	logfile
bool	printToStdOut

Static Public Attributes
static LogSystem *	LogSingleton = NULL
	Lazily-created global instance used by all static functions.

Detailed Description

Process-wide singleton logging hub with per-topic verbosity/debug levels.

Log calls go through the LogPrint / LogDebug macros which forward to the static LogSystemPrint()/LogSystemDebug() printf-style entry points. Output can go to stdout, a file, and/or a registered LogReceiver. Topics (subjects) are the LOG_* constants above; each has independent verbose and debug level thresholds.

Definition at line 272 of file Utils.h.

Constructor & Destructor Documentation

◆ LogSystem()

cmlabs::LogSystem::LogSystem ( )

Definition at line 242 of file Utils.cpp.

References logfile, and printToStdOut.

Referenced by LogSystemDebug(), LogSystemPrint(), SetLogFileOutput(), SetLogLevelDebug(), SetLogLevelDebug(), SetLogLevelVerbose(), SetLogLevelVerbose(), and SetLogReceiver().

◆ ~LogSystem()

cmlabs::LogSystem::~LogSystem ( )

Definition at line 246 of file Utils.cpp.

References logfile, and printToStdOut.

Member Function Documentation

◆ LogSystemDebug()

bool cmlabs::LogSystem::LogSystemDebug	(	uint32	source,
		uint8	subject,
		uint8	level,
		const char *	formatstring,
			... )

static

printf-style debug logging (usually invoked via the LogDebug macro); same parameters as LogSystemPrint() but gated on the debug thresholds.

Definition at line 367 of file Utils.cpp.

References cmlabs::LogEntry::cid, cmlabs::GetTimeNow(), cmlabs::LogEntry::level, LOG_MAXCOUNT, LOGDEBUG, LOGENTRYID, LogSingleton, LogSystem(), cmlabs::PrintTimeNowString(), cmlabs::LogEntry::setText(), cmlabs::LogEntry::size, cmlabs::LogEntry::source, cmlabs::utils::StringFormatVA(), cmlabs::LogEntry::subject, cmlabs::LogEntry::time, and cmlabs::LogEntry::type.

Referenced by _wrap_LogSystem_LogSystemDebug__varargs__().

◆ LogSystemPrint()

bool cmlabs::LogSystem::LogSystemPrint	(	uint32	source,
		uint8	subject,
		uint8	level,
		const char *	formatstring,
			... )

static

printf-style informational logging (usually invoked via the LogPrint macro).

Parameters

source	Numeric id of the logging component.
subject	LOG_* topic.
level	Importance; emitted when <= the topic's verbose threshold.
formatstring	printf format followed by matching varargs.