1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
4
5 This software is provided 'as-is', without any express or implied
6 warranty. In no event will the authors be held liable for any damages
7 arising from the use of this software.
8
9 Permission is granted to anyone to use this software for any purpose,
10 including commercial applications, and to alter it and redistribute it
11 freely, subject to the following restrictions:
12
13 1. The origin of this software must not be misrepresented; you must not
14 claim that you wrote the original software. If you use this software
15 in a product, an acknowledgment in the product documentation would be
16 appreciated but is not required.
17 2. Altered source versions must be plainly marked as such, and must not be
18 misrepresented as being the original software.
19 3. This notice may not be removed or altered from any source distribution.
20*/
21
22/**
23 * Logging related functions of SDL test framework.
24 *
25 * This code is a part of the SDL test library, not the main SDL library.
26 */
27
28/*
29 *
30 * Wrapper to log in the TEST category
31 *
32 */
33
34#ifndef SDL_test_log_h_
35#define SDL_test_log_h_
36
37#include <SDL3/SDL_stdinc.h>
38
39#include <SDL3/SDL_begin_code.h>
40/* Set up for C function definitions, even when using C++ */
41#ifdef __cplusplus
42extern "C" {
43#endif
44
45/**
46 * Prints given message with a timestamp in the TEST category and INFO priority.
47 *
48 * \param fmt Message to be logged
49 */
50void SDLCALL SDLTest_Log(SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(1);
51
52/**
53 * Prints given prefix and buffer.
54 * Non-printible characters in the raw data are substituted by printible alternatives.
55 *
56 * \param prefix Prefix message.
57 * \param buffer Raw data to be escaped.
58 * \param size Number of bytes in buffer.
59 */
60void SDLCALL SDLTest_LogEscapedString(const char *prefix, const void *buffer, size_t size);
61
62/**
63 * Prints given message with a timestamp in the TEST category and the ERROR priority.
64 *
65 * \param fmt Message to be logged
66 */
67void SDLCALL SDLTest_LogError(SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(1);
68
69/* Ends C function definitions when using C++ */
70#ifdef __cplusplus
71}
72#endif
73#include <SDL3/SDL_close_code.h>
74
75#endif /* SDL_test_log_h_ */
76