Mercurial > molko
annotate doc/docs/dev/api/core/trace.md @ 376:b75fa5f47bf0
doc: document presence of (panic|trace)_data
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Tue, 02 Nov 2021 15:35:53 +0100 |
| parents | c4da052c0def |
| children |
| rev | line source |
|---|---|
| 253 | 1 # Module: trace |
| 2 | |
| 3 Synopsis | |
| 4 | |
| 5 ```c | |
| 6 #include <core/trace.h> | |
| 7 ``` | |
| 8 | |
| 9 The purpose of this module is to provide a feedback from the code when there are | |
| 10 non-fatal programming error or unexpected results. In contrast to the | |
| 11 [debug](debug.md) module this one is always activated no manner if the build is | |
| 12 in Debug or Release. | |
| 13 | |
| 14 For example, having an animation with a delay of 0 is not a technical issue | |
| 15 but is probably not what the use wants. Thus, a trace warning may be | |
| 16 generated in that way. | |
| 17 | |
| 18 ## Globals | |
| 19 | |
| 20 | Variable | Type | | |
| 21 |---------------------------------|--------------------------| | |
| 22 | [trace_handler](#trace_handler) | `void (*)(const char *)` | | |
|
376
b75fa5f47bf0
doc: document presence of (panic|trace)_data
David Demelier <markand@malikania.fr>
parents:
253
diff
changeset
|
23 | [trace_data](#trace_data) | `void *` | |
| 253 | 24 |
| 25 ### trace\_handler | |
| 26 | |
| 27 The default one use a simple printf on the standard output. | |
| 28 | |
|
376
b75fa5f47bf0
doc: document presence of (panic|trace)_data
David Demelier <markand@malikania.fr>
parents:
253
diff
changeset
|
29 ### trace\_data |
|
b75fa5f47bf0
doc: document presence of (panic|trace)_data
David Demelier <markand@malikania.fr>
parents:
253
diff
changeset
|
30 |
|
b75fa5f47bf0
doc: document presence of (panic|trace)_data
David Demelier <markand@malikania.fr>
parents:
253
diff
changeset
|
31 Placeholder data for the handler if needed. |
|
b75fa5f47bf0
doc: document presence of (panic|trace)_data
David Demelier <markand@malikania.fr>
parents:
253
diff
changeset
|
32 |
| 253 | 33 ## Macros |
| 34 | |
| 35 ### TRACE\_LINE\_MAX | |
| 36 | |
| 37 Maximum length for a trace log. | |
| 38 | |
| 39 ```c | |
| 40 #define TRACE_LINE_MAX (1024) | |
| 41 ``` | |
| 42 | |
| 43 ## Functions | |
| 44 | |
| 45 ### tracef | |
| 46 | |
| 47 Log some information using [printf][] format string. | |
| 48 | |
| 49 ```c | |
| 50 void | |
| 51 tracef(const char *fmt, ...) | |
| 52 ``` | |
| 53 | |
| 54 ### traceva | |
| 55 | |
| 56 Like [tracef](#tracef) but using a `va_list`. | |
| 57 | |
| 58 ```c | |
| 59 void | |
| 60 traceva(const char *fmt, va_list ap) | |
| 61 ``` | |
| 62 | |
| 63 [printf]: https://en.cppreference.com/w/c/io/fprintf |