1/**************************************************************************/
2/* print_string.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef PRINT_STRING_H
32#define PRINT_STRING_H
33
34#include "core/variant/variant.h"
35
36extern void (*_print_func)(String);
37
38typedef void (*PrintHandlerFunc)(void *, const String &p_string, bool p_error, bool p_rich);
39
40struct PrintHandlerList {
41 PrintHandlerFunc printfunc = nullptr;
42 void *userdata = nullptr;
43
44 PrintHandlerList *next = nullptr;
45
46 PrintHandlerList() {}
47};
48
49String stringify_variants(Variant p_var);
50
51template <typename... Args>
52String stringify_variants(Variant p_var, Args... p_args) {
53 return p_var.operator String() + " " + stringify_variants(p_args...);
54}
55
56void add_print_handler(PrintHandlerList *p_handler);
57void remove_print_handler(const PrintHandlerList *p_handler);
58
59extern void __print_line(String p_string);
60extern void __print_line_rich(String p_string);
61extern void print_error(String p_string);
62extern bool is_print_verbose_enabled();
63
64// This version avoids processing the text to be printed until it actually has to be printed, saving some CPU usage.
65#define print_verbose(m_text) \
66 { \
67 if (is_print_verbose_enabled()) { \
68 print_line(m_text); \
69 } \
70 }
71
72inline void print_line(Variant v) {
73 __print_line(stringify_variants(v));
74}
75
76inline void print_line_rich(Variant v) {
77 __print_line_rich(stringify_variants(v));
78}
79
80template <typename... Args>
81void print_line(Variant p_var, Args... p_args) {
82 __print_line(stringify_variants(p_var, p_args...));
83}
84
85template <typename... Args>
86void print_line_rich(Variant p_var, Args... p_args) {
87 __print_line_rich(stringify_variants(p_var, p_args...));
88}
89
90#endif // PRINT_STRING_H
91