annotate libui/ui/debug.c @ 154:2252f9efac9a

ui: remove style from debug_report, closes #2499 While here add an example of usage and rename the function similar to trace.
author David Demelier <markand@malikania.fr>
date Fri, 16 Oct 2020 13:04:48 +0200
parents c577c15df07f
children 13b7a1a4a72c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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.c -- 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
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #include <assert.h>
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #include <stdio.h>
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
148
c577c15df07f misc: split libraries, closes #2496
David Demelier <markand@malikania.fr>
parents: 133
diff changeset
22 #include <core/texture.h>
c577c15df07f misc: split libraries, closes #2496
David Demelier <markand@malikania.fr>
parents: 133
diff changeset
23
79
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 #include "debug.h"
131
c679e08b32b2 molko: fix startup
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
25 #include "theme.h"
79
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
26
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 struct debug_options debug_options = {
133
c46f80820b42 core: revamp debug using theme
David Demelier <markand@malikania.fr>
parents: 131
diff changeset
28 #if !defined(NDEBUG)
c46f80820b42 core: revamp debug using theme
David Demelier <markand@malikania.fr>
parents: 131
diff changeset
29 .enable = true
c46f80820b42 core: revamp debug using theme
David Demelier <markand@malikania.fr>
parents: 131
diff changeset
30 #endif
79
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 };
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
32
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 void
154
2252f9efac9a ui: remove style from debug_report, closes #2499
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
34 debug(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
35 {
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 assert(report);
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 assert(fmt);
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
38
133
c46f80820b42 core: revamp debug using theme
David Demelier <markand@malikania.fr>
parents: 131
diff changeset
39 if (!debug_options.enable)
c46f80820b42 core: revamp debug using theme
David Demelier <markand@malikania.fr>
parents: 131
diff changeset
40 return;
c46f80820b42 core: revamp debug using theme
David Demelier <markand@malikania.fr>
parents: 131
diff changeset
41
79
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 va_list ap;
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
43
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 va_start(ap, fmt);
154
2252f9efac9a ui: remove style from debug_report, closes #2499
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
45 vdebug(report, fmt, ap);
79
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 va_end(ap);
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
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 void
154
2252f9efac9a ui: remove style from debug_report, closes #2499
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
50 vdebug(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
51 {
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 assert(report);
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 assert(fmt);
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
54
133
c46f80820b42 core: revamp debug using theme
David Demelier <markand@malikania.fr>
parents: 131
diff changeset
55 if (!debug_options.enable)
c46f80820b42 core: revamp debug using theme
David Demelier <markand@malikania.fr>
parents: 131
diff changeset
56 return;
c46f80820b42 core: revamp debug using theme
David Demelier <markand@malikania.fr>
parents: 131
diff changeset
57
79
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 char line[DEBUG_LINE_MAX];
133
c46f80820b42 core: revamp debug using theme
David Demelier <markand@malikania.fr>
parents: 131
diff changeset
59 struct theme *theme;
154
2252f9efac9a ui: remove style from debug_report, closes #2499
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
60 struct font font;
94
ed72843a7194 core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents: 79
diff changeset
61 struct texture tex;
154
2252f9efac9a ui: remove style from debug_report, closes #2499
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
62 int x, y;
79
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
63
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 vsnprintf(line, sizeof (line), fmt, ap);
94
ed72843a7194 core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents: 79
diff changeset
65
154
2252f9efac9a ui: remove style from debug_report, closes #2499
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
66 /* Get the font and modify its style. */
133
c46f80820b42 core: revamp debug using theme
David Demelier <markand@malikania.fr>
parents: 131
diff changeset
67 theme = report->theme ? report->theme : theme_default();
79
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
68
154
2252f9efac9a ui: remove style from debug_report, closes #2499
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
69 /* Update font style. */
2252f9efac9a ui: remove style from debug_report, closes #2499
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
70 font_shallow(&font, theme->fonts[THEME_FONT_DEBUG]);
2252f9efac9a ui: remove style from debug_report, closes #2499
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
71 font.style = FONT_STYLE_NONE;
2252f9efac9a ui: remove style from debug_report, closes #2499
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
72 font.color = theme->colors[THEME_COLOR_DEBUG];
2252f9efac9a ui: remove style from debug_report, closes #2499
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
73
2252f9efac9a ui: remove style from debug_report, closes #2499
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
74 if (!font_render(&font, &tex, line))
79
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 return;
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
76
154
2252f9efac9a ui: remove style from debug_report, closes #2499
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
77 x = theme->padding;
2252f9efac9a ui: remove style from debug_report, closes #2499
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
78 y = (theme->padding * (report->count + 1)) + (tex.h * (report->count));
79
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 report->count++;
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
80
154
2252f9efac9a ui: remove style from debug_report, closes #2499
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
81 texture_draw(&tex, x, y);
94
ed72843a7194 core: simplify font/texture interfaces
David Demelier <markand@malikania.fr>
parents: 79
diff changeset
82 texture_finish(&tex);
79
8f95462ac5f8 core: create a debugging API, closes #2469 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 }