Yate
|
An object that logs messages on creation and destruction. More...
#include <yateclass.h>
Public Types | |
enum | Formatting { None = 0, Relative, Absolute, Textual, TextLocal } |
Public Member Functions | |
Debugger (const char *name, const char *format=0,...) | |
Debugger (int level, const char *name, const char *format=0,...) | |
~Debugger () | |
Static Public Member Functions | |
static void | setOutput (void(*outFunc)(const char *, int)=0) |
static void | setIntOut (void(*outFunc)(const char *, int)=0) |
static void | enableOutput (bool enable=true, bool colorize=false) |
static Formatting | getFormatting () |
static void | setFormatting (Formatting format) |
static unsigned int | formatTime (char *buf, Formatting format=getFormatting()) |
An object that logs messages on creation and destruction.
This class is used as an automatic variable that logs messages on creation and destruction (when the instruction block is left or function returns). IMPORTANT: the name is not copied so it should best be static.
enum Formatting |
Timestamp formatting
Debugger | ( | const char * | name, |
const char * | format = 0 , |
||
... | |||
) | [explicit] |
The constructor prints the method entry message and indents.
name | Name of the function or block entered, must be static |
format | printf() style format string |
Debugger | ( | int | level, |
const char * | name, | ||
const char * | format = 0 , |
||
... | |||
) |
The constructor prints the method entry message and indents.
level | The level of the message |
name | Name of the function or block entered, must be static |
format | printf() style format string |
~Debugger | ( | ) |
The destructor prints the method leave message and deindents.
static void enableOutput | ( | bool | enable = true , |
bool | colorize = false |
||
) | [static] |
Enable or disable the debug output
enable | Set to true to globally enable output |
colorize | Enable ANSI colorization of output |
static unsigned int formatTime | ( | char * | buf, |
Formatting | format = getFormatting() |
||
) | [static] |
Fill a buffer with a current timestamp prefix
buf | Buffer to fill, must be at least 24 characters long |
format | Desired timestamp formatting |
static Formatting getFormatting | ( | ) | [static] |
Retrieve the format of timestamps
static void setFormatting | ( | Formatting | format | ) | [static] |
Set the format of timestamps on output messages and set the time start reference
format | Desired timestamp formatting |
static void setIntOut | ( | void(*)(const char *, int) | outFunc = 0 | ) | [static] |
Set the interactive output callback
outFunc | Pointer to the output function, NULL to disable |
static void setOutput | ( | void(*)(const char *, int) | outFunc = 0 | ) | [static] |
Set the output callback
outFunc | Pointer to the output function, NULL to use stderr |