GCC Code Coverage Report

Directory: ./
File: src/iguana/services/Logger.h
Date: 2025-03-24 18:50:00
Exec Total Coverage
Lines: 26 28 92.9%
Functions: 58 167 34.7%
Branches: 24 83 28.9%
Line Branch Exec Source
1 #pragma once
2
3 #include <fmt/color.h>
4 #include <fmt/format.h>
5 #include <fmt/ranges.h>
6
7 #include <functional>
8 #include <unordered_map>
9
10 namespace iguana {
11
12 /// @brief Simple logger service
13 ///
14 /// - Each algorithm instance should own a `Logger` instance
15 /// - The user may control the log level of each `Logger`, thus the log level of each algorithm
16 /// - Errors and warnings print to `stderr`, whereas all other levels print to `stdout`
17 class Logger
18 {
19
20 friend class Object;
21
22 public:
23
24 /// These are the available log levels, from lowest to highest:
25 /// - `trace`: the most verbose level, used for fine-grained printouts for each event
26 /// - `debug`: less verbose printout, expected to be less frequent than `trace`
27 /// - `info`: the least verbose printout; this is the default level
28 /// - `quiet`: use this level to only allow warnings and errors, silencing all other printouts
29 /// - `warn`: an issue that may or may not be critical
30 /// - `error`: an issue that is likely critical
31 /// - `silent`: use this level to silence **all** printouts (use it at your own risk!)
32 enum Level {
33 trace,
34 debug,
35 info,
36 quiet,
37 warn,
38 error,
39 silent
40 };
41
42 /// The default log level
43 static Level const DEFAULT_LEVEL = info;
44
45 /// @param name the name of this logger instance, which will be include in all of its printouts
46 /// @param lev the log level
47 /// @param enable_style if true, certain printouts will be styled with color and emphasis
48 Logger(std::string_view name = "log", Level const lev = DEFAULT_LEVEL, bool const enable_style = true);
49 204 ~Logger() {}
50
51 /// Set the log level to this level. Log messages with a lower level will not be printed.
52 /// @see `Logger::Level` for available levels.
53 /// @param lev the log level name
54 void SetLevel(std::string_view lev);
55
56 /// Set the log level to this level. Log messages with a lower level will not be printed.
57 /// @see `Logger::Level` for available levels.
58 /// @param lev the log level
59 void SetLevel(Level const lev);
60
61 /// Get the current log level
62 /// @returns the log level
63 Level GetLevel();
64
65 /// Enable styled log printouts, with color and emphasis
66 void EnableStyle();
67
68 /// Disable styled log printout color and emphasis
69 void DisableStyle();
70
71 /// Generate a header for a printout
72 /// @param message the header message
73 /// @param width the width of the header in number of characters
74 /// @returns the header string
75 static std::string Header(std::string_view message, int const width = 50);
76
77 /// Printout a log message at the `trace` level @see `Logger::Print` for more details
78 template <typename... VALUES>
79
2/4
✓ Branch 0 (42→43) taken 16618 times.
✗ Branch 1 (42→48) not taken.
✓ Branch 2 (44→45) taken 1665 times.
✗ Branch 3 (44→48) not taken.
 46026 void Trace(std::string_view message, const VALUES... vals) const { Print(trace, message, vals...); }
80 /// Printout a log message at the `debug` level @see `Logger::Print` for more details
81 template <typename... VALUES>
82
1/2
✓ Branch 0 (3→4) taken 419 times.
✗ Branch 1 (3→6) not taken.
 72634 void Debug(std::string_view message, const VALUES... vals) const { Print(debug, message, vals...); }
83 /// Printout a log message at the `info` level @see `Logger::Print` for more details
84 template <typename... VALUES>
85
4/20
✓ Branch 0 (19→20) taken 2 times.
✗ Branch 1 (19→45) not taken.
✓ Branch 2 (25→26) taken 2 times.
✗ Branch 3 (25→45) not taken.
✗ Branch 4 (26→27) not taken.
✓ Branch 5 (26→38) taken 2 times.
✓ Branch 6 (41→42) taken 2 times.
✗ Branch 7 (41→43) not taken.
✗ Branch 8 (27→28) not taken.
✗ Branch 9 (27→67) not taken.
✗ Branch 10 (28→29) not taken.
✗ Branch 11 (28→67) not taken.
✗ Branch 12 (29→30) not taken.
✗ Branch 13 (29→67) not taken.
✗ Branch 14 (31→32) not taken.
✗ Branch 15 (31→67) not taken.
✗ Branch 16 (35→36) not taken.
✗ Branch 17 (35→67) not taken.
✗ Branch 18 (77→78) not taken.
✗ Branch 19 (77→96) not taken.
 15 void Info(std::string_view message, const VALUES... vals) const { Print(info, message, vals...); }
86 /// Printout a log message at the `warn` level @see `Logger::Print` for more details
87 template <typename... VALUES>
88
1/4
✓ Branch 0 (20→21) taken 24 times.
✗ Branch 1 (20→45) not taken.
✗ Branch 2 (33→34) not taken.
✗ Branch 3 (33→67) not taken.
 32 void Warn(std::string_view message, const VALUES... vals) const { Print(warn, message, vals...); }
89 /// Printout a log message at the `error` level @see `Logger::Print` for more details
90 template <typename... VALUES>
91
2/28
✓ Branch 0 (3→4) taken 13 times.
✗ Branch 1 (3→6) not taken.
✓ Branch 2 (51→52) taken 2 times.
✗ Branch 3 (51→55) not taken.
✗ Branch 4 (45→46) not taken.
✗ Branch 5 (45→51) not taken.
✗ Branch 6 (49→50) not taken.
✗ Branch 7 (49→53) not taken.
✗ Branch 8 (45→46) not taken.
✗ Branch 9 (45→51) not taken.
✗ Branch 10 (49→50) not taken.
✗ Branch 11 (49→53) not taken.
✗ Branch 12 (17→18) not taken.
✗ Branch 13 (17→23) not taken.
✗ Branch 14 (21→22) not taken.
✗ Branch 15 (21→25) not taken.
✗ Branch 16 (15→16) not taken.
✗ Branch 17 (15→21) not taken.
✗ Branch 18 (19→20) not taken.
✗ Branch 19 (19→23) not taken.
✗ Branch 20 (15→16) not taken.
✗ Branch 21 (15→21) not taken.
✗ Branch 22 (19→20) not taken.
✗ Branch 23 (19→23) not taken.
✗ Branch 24 (31→32) not taken.
✗ Branch 25 (31→37) not taken.
✗ Branch 26 (35→36) not taken.
✗ Branch 27 (35→39) not taken.
 26 void Error(std::string_view message, const VALUES... vals) const { Print(error, message, vals...); }
92
93 /// Printout a log message at the specified level. The message will only print if `lev` is at least as high as the current level of
94 /// this `Logger` instance, as set by `Logger::SetLevel`.
95 /// @param lev the log level for this message
96 /// @param message the message to print; this may be a format string, as in `fmt::format`
97 /// @param vals values for the format string `message`
98 template <typename... VALUES>
99 101877 void Print(Level const lev, std::string_view message, const VALUES... vals) const
100 {
101
2/2
✓ Branch 0 (2→3) taken 951 times.
✓ Branch 1 (2→37) taken 100926 times.
 101877 if(lev >= m_level) {
102
1/2
✓ Branch 0 (3→4) taken 951 times.
✗ Branch 1 (3→35) not taken.
 951 if(auto it{m_level_names.find(lev)}; it != m_level_names.end()) {
103 std::function<std::string(std::string)> style = [](std::string s)
104 18 { return fmt::format("[{}]", s); };
105
2/2
✓ Branch 0 (4→5) taken 942 times.
✓ Branch 1 (4→12) taken 9 times.
 951 if(m_enable_style) {
106
3/3
✓ Branch 0 (5→6) taken 23 times.
✓ Branch 1 (5→8) taken 27 times.
✓ Branch 2 (5→10) taken 892 times.
 942 switch(lev) {
107 23 case warn:
108 69 style = [](std::string s)
109 46 { return fmt::format("[{}]", fmt::styled(s, fmt::emphasis::bold | fmt::fg(fmt::terminal_color::magenta))); };
110 23 break;
111 27 case error:
112 81 style = [](std::string s)
113 54 { return fmt::format("[{}]", fmt::styled(s, fmt::emphasis::bold | fmt::fg(fmt::terminal_color::red))); };
114 27 break;
115 892 default:
116 2676 style = [](std::string s)
117 1784 { return fmt::format("[{}]", fmt::styled(s, fmt::emphasis::bold)); };
118 }
119 }
120
3/4
✓ Branch 0 (23→24) taken 52 times.
✓ Branch 1 (23→25) taken 899 times.
✓ Branch 2 (26→27) taken 42 times.
✗ Branch 3 (26→45) not taken.
 1858 fmt::print(
121 lev >= warn ? stderr : stdout,
122
3/6
✓ Branch 0 (22→23) taken 951 times.
✗ Branch 1 (22→40) not taken.
✓ Branch 2 (32→33) taken 949 times.
✗ Branch 3 (32→34) not taken.
✓ Branch 4 (48→49) taken 2 times.
✗ Branch 5 (48→50) not taken.
 3804 fmt::runtime(fmt::format("{} {} {}\n", style(it->second), style(m_name), message)),
123 vals...);
124 }
125 else {
126 ✗ Warn("Logger::Print called with unknown log level '{}'; printing as error instead", static_cast<int>(lev)); // FIXME: static_cast -> fmt::underlying, but needs new version of fmt
127 ✗ Error(message, vals...);
128 }
129 }
130 101875 }
131
132 private:
133
134 /// The name of this logger, which is included in all printouts
135 std::string m_name;
136
137 /// The current log level for this instance
138 Level m_level;
139
140 /// Association of the log level to its name
141 std::unordered_map<Level, std::string> m_level_names;
142
143 /// If true, style the printouts
144 bool m_enable_style;
145 };
146 }
147