1/**************************************************************************/
2/* logger.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 LOGGER_H
32#define LOGGER_H
33
34#include "core/io/file_access.h"
35#include "core/string/ustring.h"
36#include "core/templates/vector.h"
37
38#include <stdarg.h>
39
40class Logger {
41protected:
42 bool should_log(bool p_err);
43
44 static bool _flush_stdout_on_print;
45
46public:
47 enum ErrorType {
48 ERR_ERROR,
49 ERR_WARNING,
50 ERR_SCRIPT,
51 ERR_SHADER
52 };
53
54 static void set_flush_stdout_on_print(bool value);
55
56 virtual void logv(const char *p_format, va_list p_list, bool p_err) _PRINTF_FORMAT_ATTRIBUTE_2_0 = 0;
57 virtual void log_error(const char *p_function, const char *p_file, int p_line, const char *p_code, const char *p_rationale, bool p_editor_notify = false, ErrorType p_type = ERR_ERROR);
58
59 void logf(const char *p_format, ...) _PRINTF_FORMAT_ATTRIBUTE_2_3;
60 void logf_error(const char *p_format, ...) _PRINTF_FORMAT_ATTRIBUTE_2_3;
61
62 virtual ~Logger() {}
63};
64
65/**
66 * Writes messages to stdout/stderr.
67 */
68class StdLogger : public Logger {
69public:
70 virtual void logv(const char *p_format, va_list p_list, bool p_err) override _PRINTF_FORMAT_ATTRIBUTE_2_0;
71 virtual ~StdLogger() {}
72};
73
74/**
75 * Writes messages to the specified file. If the file already exists, creates a copy (backup)
76 * of it with timestamp appended to the file name. Maximum number of backups is configurable.
77 * When maximum is reached, the oldest backups are erased. With the maximum being equal to 1,
78 * it acts as a simple file logger.
79 */
80class RotatedFileLogger : public Logger {
81 String base_path;
82 int max_files;
83
84 Ref<FileAccess> file;
85
86 void clear_old_backups();
87 void rotate_file();
88
89public:
90 explicit RotatedFileLogger(const String &p_base_path, int p_max_files = 10);
91
92 virtual void logv(const char *p_format, va_list p_list, bool p_err) override _PRINTF_FORMAT_ATTRIBUTE_2_0;
93};
94
95class CompositeLogger : public Logger {
96 Vector<Logger *> loggers;
97
98public:
99 explicit CompositeLogger(Vector<Logger *> p_loggers);
100
101 virtual void logv(const char *p_format, va_list p_list, bool p_err) override _PRINTF_FORMAT_ATTRIBUTE_2_0;
102 virtual void log_error(const char *p_function, const char *p_file, int p_line, const char *p_code, const char *p_rationale, bool p_editor_notify, ErrorType p_type = ERR_ERROR) override;
103
104 void add_logger(Logger *p_logger);
105
106 virtual ~CompositeLogger();
107};
108
109#endif // LOGGER_H
110