|
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 *)` | |
|
|
23 |
|
|
24 ### trace\_handler |
|
|
25 |
|
|
26 The default one use a simple printf on the standard output. |
|
|
27 |
|
|
28 ## Macros |
|
|
29 |
|
|
30 ### TRACE\_LINE\_MAX |
|
|
31 |
|
|
32 Maximum length for a trace log. |
|
|
33 |
|
|
34 ```c |
|
|
35 #define TRACE_LINE_MAX (1024) |
|
|
36 ``` |
|
|
37 |
|
|
38 ## Functions |
|
|
39 |
|
|
40 ### tracef |
|
|
41 |
|
|
42 Log some information using [printf][] format string. |
|
|
43 |
|
|
44 ```c |
|
|
45 void |
|
|
46 tracef(const char *fmt, ...) |
|
|
47 ``` |
|
|
48 |
|
|
49 ### traceva |
|
|
50 |
|
|
51 Like [tracef](#tracef) but using a `va_list`. |
|
|
52 |
|
|
53 ```c |
|
|
54 void |
|
|
55 traceva(const char *fmt, va_list ap) |
|
|
56 ``` |
|
|
57 |
|
|
58 [printf]: https://en.cppreference.com/w/c/io/fprintf |
