mirror of
https://github.com/godotengine/godot.git
synced 2024-12-27 11:24:59 +08:00
d95794ec8a
As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
110 lines
4.4 KiB
C++
110 lines
4.4 KiB
C++
/**************************************************************************/
|
|
/* logger.h */
|
|
/**************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/**************************************************************************/
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
/* */
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
/* a copy of this software and associated documentation files (the */
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
/* the following conditions: */
|
|
/* */
|
|
/* The above copyright notice and this permission notice shall be */
|
|
/* included in all copies or substantial portions of the Software. */
|
|
/* */
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
/**************************************************************************/
|
|
|
|
#ifndef LOGGER_H
|
|
#define LOGGER_H
|
|
|
|
#include "core/io/file_access.h"
|
|
#include "core/string/ustring.h"
|
|
#include "core/templates/vector.h"
|
|
|
|
#include <stdarg.h>
|
|
|
|
class Logger {
|
|
protected:
|
|
bool should_log(bool p_err);
|
|
|
|
static bool _flush_stdout_on_print;
|
|
|
|
public:
|
|
enum ErrorType {
|
|
ERR_ERROR,
|
|
ERR_WARNING,
|
|
ERR_SCRIPT,
|
|
ERR_SHADER
|
|
};
|
|
|
|
static void set_flush_stdout_on_print(bool value);
|
|
|
|
virtual void logv(const char *p_format, va_list p_list, bool p_err) _PRINTF_FORMAT_ATTRIBUTE_2_0 = 0;
|
|
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);
|
|
|
|
void logf(const char *p_format, ...) _PRINTF_FORMAT_ATTRIBUTE_2_3;
|
|
void logf_error(const char *p_format, ...) _PRINTF_FORMAT_ATTRIBUTE_2_3;
|
|
|
|
virtual ~Logger() {}
|
|
};
|
|
|
|
/**
|
|
* Writes messages to stdout/stderr.
|
|
*/
|
|
class StdLogger : public Logger {
|
|
public:
|
|
virtual void logv(const char *p_format, va_list p_list, bool p_err) override _PRINTF_FORMAT_ATTRIBUTE_2_0;
|
|
virtual ~StdLogger() {}
|
|
};
|
|
|
|
/**
|
|
* Writes messages to the specified file. If the file already exists, creates a copy (backup)
|
|
* of it with timestamp appended to the file name. Maximum number of backups is configurable.
|
|
* When maximum is reached, the oldest backups are erased. With the maximum being equal to 1,
|
|
* it acts as a simple file logger.
|
|
*/
|
|
class RotatedFileLogger : public Logger {
|
|
String base_path;
|
|
int max_files;
|
|
|
|
Ref<FileAccess> file;
|
|
|
|
void clear_old_backups();
|
|
void rotate_file();
|
|
|
|
public:
|
|
explicit RotatedFileLogger(const String &p_base_path, int p_max_files = 10);
|
|
|
|
virtual void logv(const char *p_format, va_list p_list, bool p_err) override _PRINTF_FORMAT_ATTRIBUTE_2_0;
|
|
};
|
|
|
|
class CompositeLogger : public Logger {
|
|
Vector<Logger *> loggers;
|
|
|
|
public:
|
|
explicit CompositeLogger(Vector<Logger *> p_loggers);
|
|
|
|
virtual void logv(const char *p_format, va_list p_list, bool p_err) override _PRINTF_FORMAT_ATTRIBUTE_2_0;
|
|
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;
|
|
|
|
void add_logger(Logger *p_logger);
|
|
|
|
virtual ~CompositeLogger();
|
|
};
|
|
|
|
#endif // LOGGER_H
|