aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/util/Log.h
blob: 914145aca09598e9b54eab36e5f3fc3e86325396 (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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
#pragma once

#include <format>

// allow user to disable debug macros
#ifndef CREPE_DISABLE_MACROS

#include "LogColor.h"

// utility macros
#define _crepe_logf_here(level, fmt, ...) \
	crepe::Log::logf(level, "{}" fmt, \
					 crepe::LogColor().fg_white(false).str(std::format( \
						 "{} ({}:{})", __PRETTY_FUNCTION__, __FILE_NAME__, __LINE__)), \
					 __VA_ARGS__)

// very illegal global function-style macros
// NOLINTBEGIN
#define dbg_logf(fmt, ...) _crepe_logf_here(crepe::Log::Level::DEBUG, ": " fmt, __VA_ARGS__)
#define dbg_log(str) _crepe_logf_here(crepe::Log::Level::DEBUG, ": {}", str)
#define dbg_trace() _crepe_logf_here(crepe::Log::Level::TRACE, "", "")
// NOLINTEND

#endif

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);

public:
	struct Config {
		/**
		 * \brief Log level
		 *
		 * Only messages with equal or higher priority than this value will be logged.
		 */
		Level level = INFO;
		/**
		 * \brief Colored log output
		 *
		 * Enables log coloring using ANSI escape codes.
		 */
		bool color = true;
	};
};

} // namespace crepe

#include "Log.hpp"