Mercurial > molko
annotate libmlk-ui/ui/debug.h @ 261:bfde372bf152
core: prefix utilities with util_
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sun, 06 Dec 2020 23:06:34 +0100 |
parents | 71b3b7036de7 |
children | 08ab73b32832 |
rev | line source |
---|---|
79
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 /* |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
2 * debug.h -- debugging interfaces |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 * |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 * Copyright (c) 2020 David Demelier <markand@malikania.fr> |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 * |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 * Permission to use, copy, modify, and/or distribute this software for any |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 * purpose with or without fee is hereby granted, provided that the above |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 * copyright notice and this permission notice appear in all copies. |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 * |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
17 */ |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
18 |
243
71b3b7036de7
misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents:
226
diff
changeset
|
19 #ifndef MOLKO_UI_DEBUG_H |
71b3b7036de7
misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents:
226
diff
changeset
|
20 #define MOLKO_UI_DEBUG_H |
79
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 /** |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 * \file debug.h |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 * \brief Debugging interfaces. |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
25 * |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
26 * This module provides functions to draw debugging information within the game |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
27 * window. It is mostly used for information only when state of the game is |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
28 * better inspected via direct window information rather than writing in the |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
29 * console. |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
30 * |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
31 * Predefined core states may print debugging information if |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
32 * debug_options.enabled variable is set to true. However, you need to specify |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 * the font to use in order to work. |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
34 * |
168
aab824406d3d
misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents:
154
diff
changeset
|
35 * Each call to \ref debugf or \ref vdebugf automatically adjust |
79
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
36 * next coordinate for rendering the text. As such, user may simply print |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
37 * several lines of text without having to deal with that manually. |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
38 */ |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
39 |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
40 #include <stdbool.h> |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
41 #include <stdarg.h> |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
42 |
148
c577c15df07f
misc: split libraries, closes #2496
David Demelier <markand@malikania.fr>
parents:
147
diff
changeset
|
43 #include <core/font.h> |
79
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
44 |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
45 /** |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
46 * Maximum content length per report. |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
47 */ |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
48 #define DEBUG_LINE_MAX 1024 |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
49 |
133
c46f80820b42
core: revamp debug using theme
David Demelier <markand@malikania.fr>
parents:
121
diff
changeset
|
50 struct theme; |
c46f80820b42
core: revamp debug using theme
David Demelier <markand@malikania.fr>
parents:
121
diff
changeset
|
51 |
79
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
52 /** |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
53 * \brief Debugging options. |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
54 * |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
55 * Fill this structure with appropriate values to change debugging behavior |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
56 * in core API. |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
57 */ |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
58 struct debug_options { |
147
b386d25832c8
doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents:
133
diff
changeset
|
59 bool enable; /*!< (+) Enable core API debugging. */ |
79
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
60 }; |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
61 |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
62 /** |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
63 * \brief Debug context. |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
64 * |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
65 * Use this structure each time you need to print one or more messages. |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
66 */ |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
67 struct debug_report { |
174
6992085d47fd
ui: major theme overhaul, closes #2509 @1h
David Demelier <markand@malikania.fr>
parents:
168
diff
changeset
|
68 const struct theme *theme; /*!< (+&?) Theme to use. */ |
147
b386d25832c8
doc: use new nomenclature, closes #2497
David Demelier <markand@malikania.fr>
parents:
133
diff
changeset
|
69 unsigned int count; /*!< (-) Number of messages already printed. */ |
79
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
70 }; |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
71 |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
72 /** |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
73 * Global debugging options. |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
74 */ |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
75 extern struct debug_options debug_options; |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
76 |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
77 /** |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
78 * Print debugging information into the screen. |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
79 * |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
80 * \pre report != NULL |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
81 * \pre fmt != NULL |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
82 * \param report the reporting context |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
83 * \param fmt the printf(3) format string |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
84 * \note The message length must not exceed DEBUG_LINE_MAX, otherwise its |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
85 * result is truncated. |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
86 */ |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
87 void |
226
dd7c8d4321a3
misc: miscellaneous cleanups
David Demelier <markand@malikania.fr>
parents:
174
diff
changeset
|
88 debugf(struct debug_report *report, const char *fmt, ...); |
79
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
89 |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
90 /** |
168
aab824406d3d
misc: all printf-like function are name foof and vfoof
David Demelier <markand@malikania.fr>
parents:
154
diff
changeset
|
91 * Similar to \ref debugf with a va_list arguments pointer. |
79
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
92 * |
154
2252f9efac9a
ui: remove style from debug_report, closes #2499
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
93 * \pre fmt != NULL |
2252f9efac9a
ui: remove style from debug_report, closes #2499
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
94 * \param report the reporting context |
2252f9efac9a
ui: remove style from debug_report, closes #2499
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
95 * \param fmt the printf(3) format string |
2252f9efac9a
ui: remove style from debug_report, closes #2499
David Demelier <markand@malikania.fr>
parents:
148
diff
changeset
|
96 * \param ap the argument list |
79
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
97 */ |
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
98 void |
226
dd7c8d4321a3
misc: miscellaneous cleanups
David Demelier <markand@malikania.fr>
parents:
174
diff
changeset
|
99 vdebugf(struct debug_report *report, const char *fmt, va_list ap); |
79
8f95462ac5f8
core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
100 |
243
71b3b7036de7
misc: lot of cleanups,
David Demelier <markand@malikania.fr>
parents:
226
diff
changeset
|
101 #endif /* !MOLKO_UI_DEBUG_H */ |