dmxlog.h File Reference

Go to the source code of this file.

Enumerations
enum	dmxLogLevel {   dmxDebug, dmxInfo, dmxWarning, dmxError,   dmxFatal }

Functions
dmxLogLevel	dmxSetLogLevel (dmxLogLevel newLevel)
dmxLogLevel	dmxGetLogLevel (void)
void	dmxLog (dmxLogLevel logLevel, const char *format,...) _X_ATTRIBUTE_PRINTF(2
void void	dmxLogCont (dmxLogLevel logLevel, const char *format,...) _X_ATTRIBUTE_PRINTF(2
void void const char *	dmxEventName (int type)
void	dmxLogOutput (DMXScreenInfo *dmxScreen, const char *format,...) _X_ATTRIBUTE_PRINTF(2
void void	dmxLogOutputCont (DMXScreenInfo *dmxScreen, const char *format,...) _X_ATTRIBUTE_PRINTF(2
void void void	dmxLogOutputWarning (DMXScreenInfo *dmxScreen, const char *format,...) _X_ATTRIBUTE_PRINTF(2
void void void void	dmxLogInput (DMXInputInfo *dmxInput, const char *format,...) _X_ATTRIBUTE_PRINTF(2
void void void void void	dmxLogInputCont (DMXInputInfo *dmxInput, const char *format,...) _X_ATTRIBUTE_PRINTF(2
void void void void void void	dmxLogArgs (dmxLogLevel logLevel, int argc, char **argv)
void	dmxLogVisual (DMXScreenInfo *dmxScreen, XVisualInfo *vi, int defaultVisual)
const char *	dmxXInputEventName (int type)

Detailed Description

This header is included by all files that need to use the DMX logging facilities.

Enumeration Type Documentation

enum dmxLogLevel

Logging levels – output is tunable with dmxSetLogLevel.

Enumerator
dmxDebug	Usually verbose debugging info
dmxInfo	Non-warning information
dmxWarning	A warning that may indicate DMX will not function as the user intends.
dmxError	A non-fatal error that probably indicates DMX will not function as desired.
dmxFatal	A fatal error that will cause DMX to shut down.

Function Documentation

void void const char* dmxEventName

(

int

type

)

Translate an event type into a human-readable string.

Referenced by dmxConsoleUpdateFineCursor(), dmxDump(), and dmxEnqueue().

dmxLogLevel dmxGetLogLevel

(

void

)

Returns the log level set by dmxLogLevel.

References dmxCurrentLogLevel.

void dmxLog	(	dmxLogLevel	logLevel,
		const char *	format,
			...
	)

void void void void void void dmxLogArgs	(	dmxLogLevel	logLevel,
		int	argc,
		char **	argv
	)

Print argc messages, each describing an element in argv. This is maingly for debugging purposes.

References dmxLog().

void void dmxLogCont	(	dmxLogLevel	logLevel,
		const char *	format,
			...
	)

void void void void dmxLogInput	(	DMXInputInfo *	dmxInput,
		const char *	format,
			...
	)

void void void void void dmxLogInputCont	(	DMXInputInfo *	dmxInput,
		const char *	format,
			...
	)

void dmxLogOutput	(	DMXScreenInfo *	dmxScreen,
		const char *	format,
			...
	)

void void dmxLogOutputCont	(	DMXScreenInfo *	dmxScreen,
		const char *	format,
			...
	)

void void void dmxLogOutputWarning	(	DMXScreenInfo *	dmxScreen,
		const char *	format,
			...
	)

void dmxLogVisual	(	DMXScreenInfo *	dmxScreen,
		XVisualInfo *	vi,
		int	defaultVisual
	)

Print messages at level dmxInfo describing the visuals in vi.

References dmxInfo, dmxLog(), dmxLogOutput(), and VisualLogFormat.

Referenced by dmxConnectionBlockCallback(), and dmxGetVisualInfo().

dmxLogLevel dmxSetLogLevel

(

dmxLogLevel

newLevel

)

Set the default level for logging to dmxLogLevel. Returns the previous log level.

References dmxCurrentLogLevel, and dmxFatal.

const char* dmxXInputEventName

(

int

type

)

Translate a (normalized) XInput event type into a human-readable string.