1 /* ScummVM - Graphic Adventure Engine
2 *
3 * ScummVM is the legal property of its developers, whose names
4 * are too numerous to list here. Please refer to the COPYRIGHT
5 * file distributed with this source distribution.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 *
21 */
22
23 #include "common/debug.h"
24 #include "common/debug-channels.h"
25 #include "common/system.h"
26 #include "common/textconsole.h"
27 #include "common/algorithm.h"
28
29 #include <stdarg.h> // For va_list etc.
30
31 // TODO: Move gDebugLevel into namespace Common.
32 int gDebugLevel = -1;
33 bool gDebugChannelsOnly = false;
34
35 const DebugChannelDef gDebugChannels[] = {
36 { kDebugLevelEventRec, "eventrec", "Event recorder debug level" },
37 { kDebugGlobalDetection, "detection", "debug messages for advancedDetector" },
38 DEBUG_CHANNEL_END
39 };
40 namespace Common {
41
42 DECLARE_SINGLETON(DebugManager);
43
44 namespace {
45
46 struct DebugLevelComperator {
operator ()Common::__anon8e9300e50111::DebugLevelComperator47 bool operator()(const DebugManager::DebugChannel &l, const DebugManager::DebugChannel &r) {
48 return (l.name.compareToIgnoreCase(r.name) < 0);
49 }
50 };
51
52 } // end of anonymous namespace
53
DebugManager()54 DebugManager::DebugManager() :
55 _debugChannelsEnabled(0) {
56 addDebugChannels(gDebugChannels);
57
58 // Create global debug channels mask
59 _globalChannelsMask = 0;
60 for (uint i = 0; gDebugChannels[i].channel != 0; ++i) {
61 _globalChannelsMask |= gDebugChannels[i].channel;
62 }
63 }
64
addDebugChannel(uint32 channel,const String & name,const String & description)65 bool DebugManager::addDebugChannel(uint32 channel, const String &name, const String &description) {
66 if (name.equalsIgnoreCase("all")) {
67 warning("Debug channel 'all' is reserved for internal use");
68 return false;
69 }
70
71 if (_debugChannels.contains(name))
72 warning("Duplicate declaration of engine debug channel '%s'", name.c_str());
73
74 for (DebugChannelMap::iterator i = _debugChannels.begin(); i != _debugChannels.end(); ++i)
75 if (i->_value.channel == channel)
76 error("Duplicate engine debug channel id '%d' for flag '%s'", channel, name.c_str());
77
78 _debugChannels[name] = DebugChannel(channel, name, description);
79
80 return true;
81 }
82
addAllDebugChannels(const DebugChannelDef * channels)83 void DebugManager::addAllDebugChannels(const DebugChannelDef *channels) {
84 removeAllDebugChannels();
85
86 if (channels) {
87 addDebugChannels(channels);
88 }
89 }
90
removeAllDebugChannels()91 void DebugManager::removeAllDebugChannels() {
92 uint32 globalChannels = _debugChannelsEnabled & _globalChannelsMask;
93 _debugChannelsEnabled = 0;
94 _debugChannels.clear();
95 addDebugChannels(gDebugChannels);
96
97 _debugChannelsEnabled |= globalChannels;
98 }
99
enableDebugChannel(const String & name)100 bool DebugManager::enableDebugChannel(const String &name) {
101 DebugChannelMap::iterator i = _debugChannels.find(name);
102
103 if (i != _debugChannels.end()) {
104 _debugChannelsEnabled |= i->_value.channel;
105 i->_value.enabled = true;
106
107 return true;
108 } else {
109 return false;
110 }
111 }
112
enableDebugChannel(uint32 channel)113 bool DebugManager::enableDebugChannel(uint32 channel) {
114 _debugChannelsEnabled |= channel;
115 return true;
116 }
117
disableDebugChannel(const String & name)118 bool DebugManager::disableDebugChannel(const String &name) {
119 DebugChannelMap::iterator i = _debugChannels.find(name);
120
121 if (i != _debugChannels.end()) {
122 _debugChannelsEnabled &= ~i->_value.channel;
123 i->_value.enabled = false;
124
125 return true;
126 } else {
127 return false;
128 }
129 }
130
disableDebugChannel(uint32 channel)131 bool DebugManager::disableDebugChannel(uint32 channel) {
132 _debugChannelsEnabled &= ~channel;
133 return true;
134 }
135
getDebugChannels()136 DebugManager::DebugChannelList DebugManager::getDebugChannels() {
137 DebugChannelList tmp;
138 for (DebugChannelMap::iterator i = _debugChannels.begin(); i != _debugChannels.end(); ++i)
139 tmp.push_back(i->_value);
140 sort(tmp.begin(), tmp.end(), DebugLevelComperator());
141
142 return tmp;
143 }
144
enableAllDebugChannels()145 void DebugManager::enableAllDebugChannels() {
146 for (DebugChannelMap::iterator i = _debugChannels.begin(); i != _debugChannels.end(); ++i)
147 enableDebugChannel(i->_value.name);
148 }
149
disableAllDebugChannels()150 void DebugManager::disableAllDebugChannels() {
151 for (DebugChannelMap::iterator i = _debugChannels.begin(); i != _debugChannels.end(); ++i)
152 disableDebugChannel(i->_value.name);
153 }
154
isDebugChannelEnabled(uint32 channel,bool enforce)155 bool DebugManager::isDebugChannelEnabled(uint32 channel, bool enforce) {
156 // Debug level 11 turns on all special debug level messages
157 if (gDebugLevel == 11 && enforce == false)
158 return true;
159 else
160 return (_debugChannelsEnabled & channel) != 0;
161 }
162
addDebugChannels(const DebugChannelDef * channels)163 void DebugManager::addDebugChannels(const DebugChannelDef *channels) {
164 for (uint i = 0; channels[i].channel != 0; ++i) {
165 addDebugChannel(channels[i].channel, channels[i].name, channels[i].description);
166 }
167 }
168
169 } // End of namespace Common
170
debugLevelSet(int level)171 bool debugLevelSet(int level) {
172 return level <= gDebugLevel;
173 }
174
debugChannelSet(int level,uint32 debugChannels)175 bool debugChannelSet(int level, uint32 debugChannels) {
176 if (gDebugLevel != 11 || level == -1)
177 if ((level != -1 && level > gDebugLevel) || !(DebugMan.isDebugChannelEnabled(debugChannels, level == -1)))
178 return false;
179
180 return true;
181 }
182
183
184 #ifndef DISABLE_TEXT_CONSOLE
185
debugHelper(const char * s,va_list va,bool caret=true)186 static void debugHelper(const char *s, va_list va, bool caret = true) {
187 Common::String buf = Common::String::vformat(s, va);
188
189 if (caret)
190 buf += '\n';
191
192 if (g_system)
193 g_system->logMessage(LogMessageType::kDebug, buf.c_str());
194 // TODO: Think of a good fallback in case we do not have
195 // any OSystem yet.
196 }
197
debug(const char * s,...)198 void debug(const char *s, ...) {
199 va_list va;
200
201 if (gDebugChannelsOnly)
202 return;
203
204 va_start(va, s);
205 debugHelper(s, va);
206 va_end(va);
207 }
208
debug(int level,const char * s,...)209 void debug(int level, const char *s, ...) {
210 va_list va;
211
212 if (level > gDebugLevel || gDebugChannelsOnly)
213 return;
214
215 va_start(va, s);
216 debugHelper(s, va);
217 va_end(va);
218
219 }
220
debugN(const char * s,...)221 void debugN(const char *s, ...) {
222 va_list va;
223
224 if (gDebugChannelsOnly)
225 return;
226
227 va_start(va, s);
228 debugHelper(s, va, false);
229 va_end(va);
230 }
231
debugN(int level,const char * s,...)232 void debugN(int level, const char *s, ...) {
233 va_list va;
234
235 if (level > gDebugLevel || gDebugChannelsOnly)
236 return;
237
238 va_start(va, s);
239 debugHelper(s, va, false);
240 va_end(va);
241 }
242
debugC(int level,uint32 debugChannels,const char * s,...)243 void debugC(int level, uint32 debugChannels, const char *s, ...) {
244 va_list va;
245
246 // Debug level 11 turns on all special debug level messages
247 if (gDebugLevel != 11)
248 if (level > gDebugLevel || !(DebugMan.isDebugChannelEnabled(debugChannels)))
249 return;
250
251 va_start(va, s);
252 debugHelper(s, va);
253 va_end(va);
254 }
255
debugCN(int level,uint32 debugChannels,const char * s,...)256 void debugCN(int level, uint32 debugChannels, const char *s, ...) {
257 va_list va;
258
259 // Debug level 11 turns on all special debug level messages
260 if (gDebugLevel != 11)
261 if (level > gDebugLevel || !(DebugMan.isDebugChannelEnabled(debugChannels)))
262 return;
263
264 va_start(va, s);
265 debugHelper(s, va, false);
266 va_end(va);
267 }
268
debugC(uint32 debugChannels,const char * s,...)269 void debugC(uint32 debugChannels, const char *s, ...) {
270 va_list va;
271
272 // Debug level 11 turns on all special debug level messages
273 if (gDebugLevel != 11)
274 if (!(DebugMan.isDebugChannelEnabled(debugChannels)))
275 return;
276
277 va_start(va, s);
278 debugHelper(s, va);
279 va_end(va);
280 }
281
debugCN(uint32 debugChannels,const char * s,...)282 void debugCN(uint32 debugChannels, const char *s, ...) {
283 va_list va;
284
285 // Debug level 11 turns on all special debug level messages
286 if (gDebugLevel != 11)
287 if (!(DebugMan.isDebugChannelEnabled(debugChannels)))
288 return;
289
290 va_start(va, s);
291 debugHelper(s, va, false);
292 va_end(va);
293 }
294
295 #endif
296