Console Logging

Data Structures
struct	LogConsoleConfig

Typedefs
typedef struct LogConsoleConfig	LogConsoleConfig
typedef struct LogConsoleData	LogConsoleData
	Opaque handle for console logging state.

Enumerations
enum	LOGCON_COLOR_MODE { LOGCON_ColorAuto = 0 , LOGCON_ColorOn , LOGCON_ColorOff }
	Color decision for a console destination. More...

Functions
LogDest *	logconsoleRegister (int maxlevel, strref chanfilter, ConStream *out, ConStream *err, const LogConsoleConfig *config, LogSerializer *ser)
LogConsoleData *	logconsoleCreate (ConStream *out, ConStream *err, const LogConsoleConfig *config, LogSerializer *ser)
void	logconsoleMsgFunc (const LogRecord *rec, void *userdata)
void	logconsoleBatchFunc (uint32 batchid, void *userdata)
void	logconsoleCloseFunc (void *userdata)

Detailed Description

Console-based logging destination that writes formatted, level-colored log lines to conOut()/conErr() (see Console).

The console is a transport and takes a serializer like any other (see Log Serializers), so a line looks the same whether it ends up in a file or on a terminal. What the console destination adds is routing between stdout/stderr by severity and a per-level ConStyle, both automatically downgraded (or dropped entirely) by the destination stream's own capabilities – a line sent to a redirected-to-a-file stdout gets no escape codes even though the identical line to a real terminal would be colored.

Basic Usage:

LogConsoleConfig cfg = {
    .stderrLevel = LOG_Count,   // everything to stderr, stdout stays clean
};
LogTextConfig tcfg = {
    .dateFormat = LOG_DateISOCompact,
    .flags      = LOG_ShortLevel | LOG_IncludeChannel,
};
 
// ...or, on a console where the timestamp is just noise, LOG_OmitDate leaves it out
// entirely and the line starts with whatever comes next:
//   LogTextConfig tcfg = { .flags = LOG_OmitDate | LOG_ShortLevel | LOG_IncludeChannel };
 
// real conOut()/conErr()
LogDest *dest = logconsoleRegister(LOG_Info, NULL, NULL, NULL, &cfg,
                                   logTextSerializer(&tcfg));
 
// Later, unregister to release
logUnregisterDest(dest);

Typedef Documentation

LogConsoleConfig

typedef struct LogConsoleConfig LogConsoleConfig

Configuration for console-based logging

Controls stdout/stderr routing and per-level coloring. Output formatting belongs to the serializer the console is created with, not here.

Enumeration Type Documentation

LOGCON_COLOR_MODE

enum LOGCON_COLOR_MODE

Color decision for a console destination.

Enumerator
LOGCON_ColorAuto	Style only when the destination stream reports color support.
LOGCON_ColorOn	Always apply per-level style, letting ConStyle's own downgrade ladder decide what the stream can actually render
LOGCON_ColorOff	Never apply style; plain text only.

Definition at line 49 of file logconsole.h.

Function Documentation

logconsoleBatchFunc()

void logconsoleBatchFunc	(	uint32	batchid,
		void *	userdata
	)

Batch completion callback for console destinations

Flushes both conOut() and conErr() so batch messages reach the terminal together.

Parameters

batchid	Completed batch identifier
userdata	LogConsoleData pointer from logconsoleCreate()

logconsoleCloseFunc()

void logconsoleCloseFunc

(

void *

userdata

)

Cleanup callback for console destinations

Releases the console logging handle. Never closes conOut()/conErr() themselves – they are process singletons.

Parameters

userdata

LogConsoleData pointer from logconsoleCreate()

logconsoleCreate()

LogConsoleData * logconsoleCreate	(	ConStream *	out,
		ConStream *	err,
		const LogConsoleConfig *	config,
		LogSerializer *	ser
	)

Create a console logging destination

Only needed to register the console by hand with logRegisterDest() – logconsoleRegister() does this and the registration together. The returned handle belongs to exactly one destination: it is freed by logconsoleCloseFunc() and cannot be registered twice.

Parameters

out	Stream for messages less severe than stderrLevel; NULL uses conOut(). Not acquired or owned – must outlive the returned handle.
err	Stream for messages at or more severe than stderrLevel; NULL uses conErr(). Not acquired or owned – must outlive the returned handle.
config	Console configuration (copied, caller retains ownership)
ser	Serializer to render records with; ownership transfers. NULL gets a default text serializer.

Returns

Console logging handle

LogConsoleConfig cfg = { .stderrLevel = LOG_Count };
LogConsoleData *lcd = logconsoleCreate(NULL, NULL, &cfg, NULL);
LogDest *dest = logRegisterDest(LOG_Info, NULL, logconsoleMsgFunc, logconsoleBatchFunc,
                                logconsoleCloseFunc, lcd);

logconsoleMsgFunc()

void logconsoleMsgFunc	(	const LogRecord *	rec,
		void *	userdata
	)

Log message callback for console destinations

Renders a log record and writes it to conOut() or conErr(), styled per level according to the destination's configuration and the destination stream's capabilities.

Parameters

rec	Log record to write
userdata	LogConsoleData pointer from logconsoleCreate()

logconsoleRegister()

LogDest * logconsoleRegister	(	int	maxlevel,
		strref	chanfilter,
		ConStream *	out,
		ConStream *	err,
		const LogConsoleConfig *	config,
		LogSerializer *	ser
	)

Register a console logging destination

Builds the console destination and registers it with the logging system in one step. It is closed and released when logUnregisterDest() retires the returned handle.

Parameters

maxlevel	Maximum log level to write to the console
chanfilter	Channel path pattern, or NULL for every unrestricted channel
out	Stream for messages less severe than stderrLevel; NULL uses conOut(). Not acquired or owned – must outlive the destination.
err	Stream for messages at or more severe than stderrLevel; NULL uses conErr(). Not acquired or owned – must outlive the destination.
config	Console configuration (copied, caller retains ownership)
ser	Serializer to render records with; ownership transfers, including if this call fails. NULL gets a default text serializer.

Returns

Destination handle for later unregistration, or NULL on failure

LogConsoleConfig cfg = { .stderrLevel = LOG_Count };
LogDest *dest = logconsoleRegister(LOG_Info, NULL, NULL, NULL, &cfg, NULL);
 
// or, for a test that asserts exact output:
ConStream *mem = conCreateMem(&(ConCaps){ 0 });
LogDest *tdest = logconsoleRegister(LOG_Info, NULL, mem, mem, &cfg, NULL);