epochryphon/log.c
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
rxi
2020-06-20 08:57:22 +01:00
parent 4c5da2155e
commit 9e44c2491d
1 changed files with 27 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@@ -31,33 +31,46 @@ Resulting in a line with the given format printed to stderr:
``` ```
#### log_set_quiet(int enable) #### log_set_quiet(bool enable)
Quiet-mode can be enabled by passing `1` to the `log_set_quiet()` function. Quiet-mode can be enabled by passing `true` to the `log_set_quiet()` function.
While this mode is enabled the library will not output anything to stderr, but While this mode is enabled the library will not output anything to `stderr`, but
will continue to write to the file if one is set. will continue to write to files and callbacks if any are set.
#### log_set_level(int level) #### log_set_level(int level)
The current logging level can be set by using the `log_set_level()` function. The current logging level can be set by using the `log_set_level()` function.
All logs below the given level will be ignored. By default the level is All logs below the given level will not be written to `stderr`. By default the
`LOG_TRACE`, such that nothing is ignored. level is `LOG_TRACE`, such that nothing is ignored.
#### log_set_fp(FILE *fp) #### log_add_fp(FILE *fp, int level)
A file pointer where the log should be written can be provided to the library by One or more file pointers where the log will be written can be provided to the
using the `log_set_fp()` function. The data written to the file output is library by using the `log_add_fp()` function. The data written to the file
of the following format: output is of the following format:
``` ```
2047-03-11 20:18:26 TRACE src/main.c:11: Hello world 2047-03-11 20:18:26 TRACE src/main.c:11: Hello world
``` ```
Any messages below the given `level` are ignored. If the library failed to add a
file pointer a value less-than-zero is returned.
#### log_set_lock(log_LockFn fn)
#### log_add_callback(log_LogFn fn, void *udata, int level)
One or more callback functions which are called with the log data can be
provided to the library by using the `log_add_callback()` function. A callback
function is passed a `log_Event` structure containing the `line` number,
`filename`, `fmt` string, `va` printf va\_list, `level` and the given `udata`.
#### log_set_lock(log_LockFn fn, void *udata)
If the log will be written to from multiple threads a lock function can be set. If the log will be written to from multiple threads a lock function can be set.
The function is passed a `udata` value (set by `log_set_udata()`) and the The function is passed the boolean `true` if the lock should be acquired or
integer `1` if the lock should be acquired or `0` if the lock should be `false` if the lock should be released and the given `udata` value.
released.
#### const char* log_level_string(int level)
Returns the name of the given log level as a string.
#### LOG_USE_COLOR #### LOG_USE_COLOR