diff options
author | Bent Bisballe Nyeng <deva@aasimon.org> | 2012-12-07 14:01:16 +0100 |
---|---|---|
committer | Bent Bisballe Nyeng <deva@aasimon.org> | 2012-12-07 14:01:16 +0100 |
commit | d64294639375cd5758cd7abe090348d62e5d9ca7 (patch) | |
tree | 317742e627fcb5cda54610e260f64f1477d9217f /debug.h | |
parent | 2f6d64ad096817a13c90af63f3cfd229e9b42122 (diff) |
Completely new interface.
Diffstat (limited to 'debug.h')
-rw-r--r-- | debug.h | 99 |
1 files changed, 96 insertions, 3 deletions
@@ -28,10 +28,103 @@ #ifndef __DEBUG_MODULE_DEBUG_H__ #define __DEBUG_MODULE_DEBUG_H__ -#include <stdio.h> +enum DBG_FLAG { + // Features +#ifdef WITH_DBG_THREAD + DBG_FLAG_USE_THREAD = 0x00000001, +#endif +#ifdef WITH_DBG_MUTEX + DBG_FLAG_USE_MUTEX = 0x00000002, +#endif +#ifdef WITH_DBG_FILTER + DBG_FLAG_USE_FILTER = 0x00000004, +#endif -void debug_init(FILE *fp); -void debug_parse(const char *fmt); + // Outputs + DBG_FLAG_OUTPUT_TO_STDOUT = 0x00010000, + DBG_FLAG_OUTPUT_TO_STDERR = 0x00020000, + DBG_FLAG_OUTPUT_TO_FD = 0x00040000, + DBG_FLAG_OUTPUT_TO_FILE = 0x00080000, +#ifdef WITH_DBG_SYSLOG + DBG_FLAG_OUTPUT_TO_SYSLOG = 0x000f0000, +#endif + + // Default value of flags + DBG_FLAG_DEFAULT = DBG_FLAG_OUTPUT_TO_STDOUT, // Output to stdout +}; + +enum DBG_OPTION { + /** + * No more options / last option. This is used + * to terminate the VARARGs list. + */ + DBG_OPTION_END, + + /** + * const char* argument containing a filename which will be used for log + * output. To be used with the DBG_FLAG_OUTPUT_TO_FILE flag. + */ + DBG_OPTION_FILENAME, + + /** + * Integer argument describing a file descriptor which will be used for log + * output. To be used with the DBG_FLAG_OUTPUT_TO_FD flag. + */ + DBG_OPTION_FD, + + /** + * Host and port to use when logging on an external server. + * Host is a const char* argument, port is an integer. + * To be used with the DBG_FLAG_USE_SYSLOG flag. + * Linux: If DBG_OPTION_SYSLOG_HOST is not supplied, the local syslog will be + * used. + * Windows: If DBG_OPTION_SYSLOG_HOST is not supplied an error will be + * returned by debug_init. + * If DBG_OPTION_SYSLOG_PORT is not supplied, the default syslogd port will + * be used (port 514). + */ +#ifdef WITH_DBG_SYSLOG + DBG_OPTION_SYSLOG_HOST, + DBG_OPTION_SYSLOG_PORT, +#endif + + /** + * + */ +}; + +typedef enum { + DBG_STATUS_OK = 0, + DBG_STATUS_UNKNOWN_OPTION, + DBG_STATUS_ERROR, +} dbg_status_t; + +/** + * @param flags combination of DBG_FLAG values + * @param ... list of options (type-value pairs, + * terminated with DBG_OPTION_END). + * @return 0 on success, 1 on error. + */ +dbg_status_t dbg_init(unsigned int flags, ...); +void dbg_close(); + +/** + * Example of usage (use mutex protected calls, send output to file): + * + * dbg_status_t status; + * status = debug_init(DBG_FLAG_OUTPUT_TO_FILE | DBG_FLAG_USE_MUTEX, + * DBG_OPTION_FILENAME, "/tmp/my.log", + DBG_OPTION_END); + * if(status != DBG_STATUS_OK) exit(1); + * INFO(example, "We are up and running\n"); + * dbg_close(); + */ + +/** + * Example of usage (simply outputs to stdout): + * + * INFO(example, "We are up and running\n"); + */ enum __debug_class { |