aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/util/Log.h
blob: b43fe306c478ebe00d60186d8861293e1ceda2a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
#pragma once

#include <format>

namespace crepe {

/**
 * \brief Logging utility
 *
 * This class is used to output log messages to the console and/or log files.
 */
class Log {
public:
	//! Log message severity
	enum Level {
		TRACE, //!< Include (internal) function calls
		DEBUG, //!< Include dbg_logf output
		INFO, //!< General-purpose messages
		WARNING, //!< Non-fatal errors
		ERROR, //!< Fatal errors
	};

	/**
	 * \brief Log a formatted message
	 *
	 * \param level Message severity
	 * \param msg Formatted message
	 */
	static void log(const Level & level, const std::string & msg);

	/**
	 * \brief Format a message and log it
	 *
	 * \param level Message severity
	 * \param fmt Message format
	 * \param args Format arguments
	 */
	template <class... Args>
	static void logf(const Level & level, std::format_string<Args...> fmt, Args &&... args);

	/**
	 * \brief Format a message and log it (with default severity \c INFO)
	 *
	 * \param fmt Message format
	 * \param args Format arguments
	 */
	template <class... Args>
	static void logf(std::format_string<Args...> fmt, Args &&... args);

private:
	/**
	 * \brief Output a message prefix depending on the log level
	 *
	 * \param level Message severity
	 *
	 * \return Colored message severity prefix string
	 */
	static std::string prefix(const Level & level);
};

} // namespace crepe

#include "Log.hpp"