Mercurial > molko
diff libmlk-ui/ui/debug.h @ 243:71b3b7036de7
misc: lot of cleanups,
- prefix libraries with libmlk,
- move assets from source directories closes #2520,
- prefix header guards closes #2519
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sat, 28 Nov 2020 22:37:30 +0100 |
parents | libui/ui/debug.h@dd7c8d4321a3 |
children | 08ab73b32832 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/libmlk-ui/ui/debug.h Sat Nov 28 22:37:30 2020 +0100 @@ -0,0 +1,101 @@ +/* + * debug.h -- debugging interfaces + * + * Copyright (c) 2020 David Demelier <markand@malikania.fr> + * + * Permission to use, copy, modify, and/or distribute this software for any + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + */ + +#ifndef MOLKO_UI_DEBUG_H +#define MOLKO_UI_DEBUG_H + +/** + * \file debug.h + * \brief Debugging interfaces. + * + * This module provides functions to draw debugging information within the game + * window. It is mostly used for information only when state of the game is + * better inspected via direct window information rather than writing in the + * console. + * + * Predefined core states may print debugging information if + * debug_options.enabled variable is set to true. However, you need to specify + * the font to use in order to work. + * + * Each call to \ref debugf or \ref vdebugf automatically adjust + * next coordinate for rendering the text. As such, user may simply print + * several lines of text without having to deal with that manually. + */ + +#include <stdbool.h> +#include <stdarg.h> + +#include <core/font.h> + +/** + * Maximum content length per report. + */ +#define DEBUG_LINE_MAX 1024 + +struct theme; + +/** + * \brief Debugging options. + * + * Fill this structure with appropriate values to change debugging behavior + * in core API. + */ +struct debug_options { + bool enable; /*!< (+) Enable core API debugging. */ +}; + +/** + * \brief Debug context. + * + * Use this structure each time you need to print one or more messages. + */ +struct debug_report { + const struct theme *theme; /*!< (+&?) Theme to use. */ + unsigned int count; /*!< (-) Number of messages already printed. */ +}; + +/** + * Global debugging options. + */ +extern struct debug_options debug_options; + +/** + * Print debugging information into the screen. + * + * \pre report != NULL + * \pre fmt != NULL + * \param report the reporting context + * \param fmt the printf(3) format string + * \note The message length must not exceed DEBUG_LINE_MAX, otherwise its + * result is truncated. + */ +void +debugf(struct debug_report *report, const char *fmt, ...); + +/** + * Similar to \ref debugf with a va_list arguments pointer. + * + * \pre fmt != NULL + * \param report the reporting context + * \param fmt the printf(3) format string + * \param ap the argument list + */ +void +vdebugf(struct debug_report *report, const char *fmt, va_list ap); + +#endif /* !MOLKO_UI_DEBUG_H */