Utilities

Library initialization, error handling, logging and a few minor libc extensions. More...

Macros
#define	DAS_OKAY   0
	success return code
#define	daslog_trace(M)   daslog(DASLOG_TRACE, __FILE__, __LINE__, M)
	Macro wrapper around das_log() for TRACE messages with out variable args.
#define	daslog_debug(M)   daslog(DASLOG_DEBUG, __FILE__, __LINE__, M)
	Macro wrapper around das_log() for DEBUG messages with out variable args.
#define	daslog_info(M)   daslog(DASLOG_INFO, __FILE__, __LINE__, M)
	Macro wrapper around das_log() for INFO messages with out variable args.
#define	daslog_warn(M)   daslog(DASLOG_WARN, __FILE__, __LINE__, M)
	Macro wrapper around das_log() for WARNING messages with out variable args.
#define	daslog_error(M)   daslog(DASLOG_ERROR, __FILE__, __LINE__, M)
	Macro wrapper around das_log() for ERROR messages with out variable args.
#define	daslog_critical(M)   daslog(DASLOG_CRIT, __FILE__, __LINE__, M)
	Macro wrapper around das_log() for CRITICAL messages with out variable args.
#define	daslog_trace_v(F, ...)    daslog(DASLOG_TRACE, __FILE__, __LINE__, F, __VA_ARGS__)
	Macro wrapper around das_log() for TRACE messages with variable arguments.
#define	daslog_debug_v(F, ...)    daslog(DASLOG_DEBUG, __FILE__, __LINE__, F, __VA_ARGS__)
	Macro wrapper around das_log() for DEBUG messages with variable arguments.
#define	daslog_info_v(F, ...)    daslog(DASLOG_INFO, __FILE__, __LINE__, F, __VA_ARGS__)
	Macro wrapper around das_log() for INFO messages with variable arguments.
#define	daslog_warn_v(F, ...)    daslog(DASLOG_WARN, __FILE__, __LINE__, F, __VA_ARGS__)
	Macro wrapper around das_log() for WARNING messages with variable arguments.
#define	daslog_error_v(F, ...)    daslog(DASLOG_ERROR, __FILE__, __LINE__, F, __VA_ARGS__)
	Macro wrapper around das_log() for ERROR messages with variable arguments.
#define	daslog_critical_v(F, ...)    daslog(DASLOG_CRIT, __FILE__, __LINE__, F, __VA_ARGS__)
	Macro wrapper around das_log() for CRITICAL messages with variable arguments.

Typedefs
typedef int	DasErrCode
	return code type 0 indicates success, negative integer indicates failure

Functions
DAS_API int	daslog_level (void)
	Get the log level.
DAS_API int	daslog_setlevel (int nLevel)
	Set the logging level for this thread.
DAS_API void	das_log_include_time (bool bPrnTime)
	Prefix each log message with the time it was written, off by default.
DAS_API int	daslog_strlevel (const char *sLevel)
	Get a logging level integer from a string.
DAS_API const char *	daslog_levelstr (int nLevel)
	The opposite of daslog_strlevel(), returns a string appropriate for the log level indicated.
DAS_API bool	daslog_set_showline (int nLevel)
	Output source file and line numbers for messages at or above this level.
DAS_API das_log_handler_t	daslog_sethandler (das_log_handler_t new_handler)
	Install a new message handler function for this thread.

Detailed Description

Library initialization, error handling, logging and a few minor libc extensions.

Function Documentation

daslog_level()

DAS_API int daslog_level

(

void

)

Get the log level.

Returns

one of: DASLOG_CRIT, DASLOG_ERROR, DASLOG_WARN, DASLOG_INFO, DASLOG_DEBUG, DASLOG_TRACE

daslog_setlevel()

DAS_API int daslog_setlevel

(

int

nLevel

)

Set the logging level for this thread.

Parameters

nLevel

Set to one of DASLOG_TRACE DASLOG_DEBUG DASLOG_NOTICE DASLOG_WARN DASLOG_ERROR DASLOG_CRITICAL DASLOG_NOTHING

Returns

The previous log level.

das_log_include_time()

DAS_API void das_log_include_time

(

bool

bPrnTime

)

Prefix each log message with the time it was written, off by default.

Parameters

bPrnTime

true to include the time, false to leave it out

daslog_strlevel()

DAS_API int daslog_strlevel

(

const char *

sLevel

)

Get a logging level integer from a string.

This function may safely be called prior to das_init()

Parameters

sLevel

One of "crit", "err", "warn", "info", "debug", "trace". Case is not significant, extra letters after the first are actually ignored.

Returns

One of DASLOG_CRIT, DASLOG_ERROR, DASLOG_WARN, DASLOG_INFO, DASLOG_DEBUG, DASLOG_TRACE, if the string is understood, DASLOG_NOTHING if not.

daslog_levelstr()

DAS_API const char * daslog_levelstr

(

int

nLevel

)

The opposite of daslog_strlevel(), returns a string appropriate for the log level indicated.

Is also safe to call prior to das_init()

Parameters

nLevel

an integer in the range of 0 to 254

Returns

One of the strings "TRACE", "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL" or the value "" (empty string if logging is at 255 or above, which shuts it off completely

daslog_sethandler()

DAS_API das_log_handler_t daslog_sethandler

(

das_log_handler_t

new_handler

)

Install a new message handler function for this thread.

The default message handler just prints to stderr, which is not very efficient, nor is it appropriate for GUI applications.

Parameters

new_handler

The new message handler, or NULL to set to the default handler.

Returns

The previous message handler function pointer