[Scummvm-cvs-logs] SF.net SVN: scummvm:[48935] scummvm/trunk
fingolfin at users.sourceforge.net
fingolfin at users.sourceforge.net
Tue May 4 13:59:22 CEST 2010
Revision: 48935
http://scummvm.svn.sourceforge.net/scummvm/?rev=48935&view=rev
Author: fingolfin
Date: 2010-05-04 11:59:22 +0000 (Tue, 04 May 2010)
Log Message:
-----------
Move DebugChannel related code to new header
Modified Paths:
--------------
scummvm/trunk/base/main.cpp
scummvm/trunk/common/debug.cpp
scummvm/trunk/common/debug.h
scummvm/trunk/common/system.h
scummvm/trunk/engines/agi/agi.cpp
scummvm/trunk/engines/agi/preagi.cpp
scummvm/trunk/engines/cine/cine.cpp
scummvm/trunk/engines/cruise/cruise.cpp
scummvm/trunk/engines/draci/draci.cpp
scummvm/trunk/engines/gob/gob.cpp
scummvm/trunk/engines/groovie/debug.cpp
scummvm/trunk/engines/groovie/groovie.cpp
scummvm/trunk/engines/groovie/script.cpp
scummvm/trunk/engines/kyra/kyra_lok.cpp
scummvm/trunk/engines/kyra/kyra_v1.cpp
scummvm/trunk/engines/lure/lure.cpp
scummvm/trunk/engines/m4/m4.cpp
scummvm/trunk/engines/mohawk/myst.cpp
scummvm/trunk/engines/parallaction/parallaction.cpp
scummvm/trunk/engines/sci/decompressor.cpp
scummvm/trunk/engines/sci/engine/kpathing.cpp
scummvm/trunk/engines/sci/engine/vm.cpp
scummvm/trunk/engines/sci/sci.cpp
scummvm/trunk/engines/scumm/debugger.cpp
scummvm/trunk/engines/scumm/scumm.cpp
scummvm/trunk/engines/tinsel/tinsel.cpp
scummvm/trunk/engines/touche/touche.cpp
scummvm/trunk/gui/debugger.cpp
Added Paths:
-----------
scummvm/trunk/common/debug-channels.h
Modified: scummvm/trunk/base/main.cpp
===================================================================
--- scummvm/trunk/base/main.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/base/main.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -40,6 +40,7 @@
#include "common/archive.h"
#include "common/config-manager.h"
#include "common/debug.h"
+#include "common/debug-channels.h"
#include "common/events.h"
#include "common/EventRecorder.h"
#include "common/file.h"
Added: scummvm/trunk/common/debug-channels.h
===================================================================
--- scummvm/trunk/common/debug-channels.h (rev 0)
+++ scummvm/trunk/common/debug-channels.h 2010-05-04 11:59:22 UTC (rev 48935)
@@ -0,0 +1,132 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ */
+
+#ifndef COMMON_DEBUG_CHANNELS_H
+#define COMMON_DEBUG_CHANNELS_H
+
+#include "common/scummsys.h"
+
+#include "common/hashmap.h"
+#include "common/hash-str.h"
+#include "common/list.h"
+#include "common/singleton.h"
+#include "common/str.h"
+
+
+namespace Common {
+
+// TODO: Find a better name for this
+class DebugManager : public Singleton<DebugManager> {
+public:
+
+ struct DebugChannel {
+ DebugChannel() : channel(0), enabled(false) {}
+ DebugChannel(uint32 c, const String &n, const String &d)
+ : name(n), description(d), channel(c), enabled(false) {}
+
+ String name;
+ String description;
+
+ uint32 channel;
+ bool enabled;
+ };
+
+ /**
+ * Adds a debug channel.
+ *
+ * A debug channel is considered roughly similar to what our debug levels described by
+ * gDebugLevel try to achieve:
+ *
+ * Debug channels should only affect the display of additional debug output, based on
+ * their state. That is if they are enabled, channel specific debug messages should
+ * be shown. If they are disabled on the other hand, those messages will be hidden.
+ *
+ * @see gDebugLevel.
+ *
+ * Note that we have debug* functions which depend both on the debug level set and
+ * specific debug channels. Those functions will only show output, when *both* criteria
+ * are satisfied.
+ *
+ * @param channel the channel flag (should be OR-able i.e. first one should be 1 then 2, 4, etc.)
+ * @param name the option name which is used in the debugger/on the command line to enable
+ * this special debug level (case will be ignored)
+ * @param description the description which shows up in the debugger
+ * @return true on success false on failure
+ */
+ bool addDebugChannel(uint32 channel, const String &name, const String &description);
+
+ /**
+ * Resets all engine specific debug channels.
+ */
+ void clearAllDebugChannels();
+
+ /**
+ * Enables an debug channel.
+ *
+ * @param name the name of the debug channel to enable
+ * @return true on success, false on failure
+ */
+ bool enableDebugChannel(const String &name);
+
+ /**
+ * Disables an debug channel.
+ *
+ * @param name the name of the debug channel to disable
+ * @return true on success, false on failure
+ */
+ bool disableDebugChannel(const String &name);
+
+
+
+ typedef List<DebugChannel> DebugChannelList;
+
+ /**
+ * Lists all engine specific debug channels.
+ *
+ * @return returns an array with all debug channels
+ */
+ DebugChannelList listDebugChannels();
+
+
+ /**
+ * Test whether the given debug channel is enabled.
+ */
+ bool isDebugChannelEnabled(uint32 channel);
+
+private:
+ typedef HashMap<String, DebugChannel, IgnoreCase_Hash, IgnoreCase_EqualTo> DebugChannelMap;
+
+ DebugChannelMap gDebugChannels;
+ uint32 gDebugChannelsEnabled;
+
+ friend class Singleton<SingletonBaseType>;
+ DebugManager() : gDebugChannelsEnabled(0) {}
+};
+
+/** Shortcut for accessing the debug manager. */
+#define DebugMan Common::DebugManager::instance()
+
+} // End of namespace Common
+
+#endif
Property changes on: scummvm/trunk/common/debug-channels.h
___________________________________________________________________
Added: svn:mime-type
+ text/plain
Added: svn:keywords
+ Date Rev Author URL Id
Added: svn:eol-style
+ native
Modified: scummvm/trunk/common/debug.cpp
===================================================================
--- scummvm/trunk/common/debug.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/common/debug.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -23,6 +23,7 @@
*/
#include "common/debug.h"
+#include "common/debug-channels.h"
#include "common/util.h"
#include <stdarg.h> // For va_list etc.
Modified: scummvm/trunk/common/debug.h
===================================================================
--- scummvm/trunk/common/debug.h 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/common/debug.h 2010-05-04 11:59:22 UTC (rev 48935)
@@ -26,108 +26,11 @@
#define COMMON_DEBUG_H
#include "common/scummsys.h"
-#include "common/singleton.h"
+#include "common/debug-channels.h"
#include "common/textconsole.h"
-#include "common/list.h"
-#include "common/str.h"
-#include "common/hashmap.h"
-#include "common/hash-str.h"
-
-
namespace Common {
-// TODO: Find a better name for this
-class DebugManager : public Singleton<DebugManager> {
-public:
-
- struct DebugChannel {
- DebugChannel() : channel(0), enabled(false) {}
- DebugChannel(uint32 c, const String &n, const String &d)
- : name(n), description(d), channel(c), enabled(false) {}
-
- String name;
- String description;
-
- uint32 channel;
- bool enabled;
- };
-
- /**
- * Adds a debug channel.
- *
- * A debug channel is considered roughly similar to what our debug levels described by
- * gDebugLevel try to achieve:
- *
- * Debug channels should only affect the display of additional debug output, based on
- * their state. That is if they are enabled, channel specific debug messages should
- * be shown. If they are disabled on the other hand, those messages will be hidden.
- *
- * @see gDebugLevel.
- *
- * Note that we have debug* functions which depend both on the debug level set and
- * specific debug channels. Those functions will only show output, when *both* criteria
- * are satisfied.
- *
- * @param channel the channel flag (should be OR-able i.e. first one should be 1 then 2, 4, etc.)
- * @param name the option name which is used in the debugger/on the command line to enable
- * this special debug level (case will be ignored)
- * @param description the description which shows up in the debugger
- * @return true on success false on failure
- */
- bool addDebugChannel(uint32 channel, const String &name, const String &description);
-
- /**
- * Resets all engine specific debug channels.
- */
- void clearAllDebugChannels();
-
- /**
- * Enables an debug channel.
- *
- * @param name the name of the debug channel to enable
- * @return true on success, false on failure
- */
- bool enableDebugChannel(const String &name);
-
- /**
- * Disables an debug channel.
- *
- * @param name the name of the debug channel to disable
- * @return true on success, false on failure
- */
- bool disableDebugChannel(const String &name);
-
-
-
- typedef List<DebugChannel> DebugChannelList;
-
- /**
- * Lists all engine specific debug channels.
- *
- * @return returns an array with all debug channels
- */
- DebugChannelList listDebugChannels();
-
-
- /**
- * Test whether the given debug channel is enabled.
- */
- bool isDebugChannelEnabled(uint32 channel);
-
-private:
- typedef HashMap<String, DebugChannel, IgnoreCase_Hash, IgnoreCase_EqualTo> DebugChannelMap;
-
- DebugChannelMap gDebugChannels;
- uint32 gDebugChannelsEnabled;
-
- friend class Singleton<SingletonBaseType>;
- DebugManager() : gDebugChannelsEnabled(0) {}
-};
-
-/** Shortcut for accessing the debug manager. */
-#define DebugMan Common::DebugManager::instance()
-
/**
* Set the output formatter used by debug() and related functions.
*/
Modified: scummvm/trunk/common/system.h
===================================================================
--- scummvm/trunk/common/system.h 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/common/system.h 2010-05-04 11:59:22 UTC (rev 48935)
@@ -29,6 +29,7 @@
#include "common/scummsys.h"
#include "common/noncopyable.h"
#include "common/rect.h"
+#include "common/list.h" // For OSystem::getSupportedFormats()
#include "graphics/pixelformat.h"
Modified: scummvm/trunk/engines/agi/agi.cpp
===================================================================
--- scummvm/trunk/engines/agi/agi.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/agi/agi.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -29,6 +29,7 @@
#include "common/file.h"
#include "common/savefile.h"
#include "common/config-manager.h"
+#include "common/debug-channels.h"
#include "common/random.h"
#include "engines/util.h"
Modified: scummvm/trunk/engines/agi/preagi.cpp
===================================================================
--- scummvm/trunk/engines/agi/preagi.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/agi/preagi.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -24,6 +24,7 @@
*/
#include "common/config-manager.h"
+#include "common/debug-channels.h"
#include "common/random.h"
#include "sound/mididrv.h"
Modified: scummvm/trunk/engines/cine/cine.cpp
===================================================================
--- scummvm/trunk/engines/cine/cine.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/cine/cine.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -28,6 +28,7 @@
#include "common/file.h"
#include "common/savefile.h"
#include "common/config-manager.h"
+#include "common/debug-channels.h"
#include "common/system.h"
#include "engines/util.h"
Modified: scummvm/trunk/engines/cruise/cruise.cpp
===================================================================
--- scummvm/trunk/engines/cruise/cruise.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/cruise/cruise.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -28,6 +28,7 @@
#include "common/file.h"
#include "common/savefile.h"
#include "common/config-manager.h"
+#include "common/debug-channels.h"
#include "common/system.h"
#include "engines/util.h"
Modified: scummvm/trunk/engines/draci/draci.cpp
===================================================================
--- scummvm/trunk/engines/draci/draci.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/draci/draci.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -26,6 +26,7 @@
#include "common/scummsys.h"
#include "common/config-manager.h"
+#include "common/debug-channels.h"
#include "common/events.h"
#include "common/file.h"
#include "common/keyboard.h"
Modified: scummvm/trunk/engines/gob/gob.cpp
===================================================================
--- scummvm/trunk/engines/gob/gob.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/gob/gob.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -23,6 +23,7 @@
*
*/
+#include "common/debug-channels.h"
#include "common/endian.h"
#include "common/events.h"
#include "common/EventRecorder.h"
Modified: scummvm/trunk/engines/groovie/debug.cpp
===================================================================
--- scummvm/trunk/engines/groovie/debug.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/groovie/debug.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -27,6 +27,8 @@
#include "groovie/groovie.h"
#include "groovie/script.h"
+#include "common/debug-channels.h"
+
namespace Groovie {
Debugger::Debugger(GroovieEngine *vm) :
Modified: scummvm/trunk/engines/groovie/groovie.cpp
===================================================================
--- scummvm/trunk/engines/groovie/groovie.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/groovie/groovie.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -24,6 +24,7 @@
*/
#include "common/config-manager.h"
+#include "common/debug-channels.h"
#include "common/events.h"
#include "engines/util.h"
Modified: scummvm/trunk/engines/groovie/script.cpp
===================================================================
--- scummvm/trunk/engines/groovie/script.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/groovie/script.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -31,6 +31,7 @@
#include "groovie/saveload.h"
#include "common/config-manager.h"
+#include "common/debug-channels.h"
#include "common/endian.h"
#include "common/events.h"
#include "common/EventRecorder.h"
Modified: scummvm/trunk/engines/kyra/kyra_lok.cpp
===================================================================
--- scummvm/trunk/engines/kyra/kyra_lok.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/kyra/kyra_lok.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -29,6 +29,7 @@
#include "common/system.h"
#include "common/savefile.h"
#include "common/config-manager.h"
+#include "common/debug-channels.h"
#include "gui/message.h"
Modified: scummvm/trunk/engines/kyra/kyra_v1.cpp
===================================================================
--- scummvm/trunk/engines/kyra/kyra_v1.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/kyra/kyra_v1.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -24,6 +24,7 @@
*/
#include "common/config-manager.h"
+#include "common/debug-channels.h"
#include "common/EventRecorder.h"
#include "sound/mididrv.h"
Modified: scummvm/trunk/engines/lure/lure.cpp
===================================================================
--- scummvm/trunk/engines/lure/lure.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/lure/lure.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -24,6 +24,7 @@
*/
#include "common/config-manager.h"
+#include "common/debug-channels.h"
#include "common/system.h"
#include "common/savefile.h"
#include "common/EventRecorder.h"
Modified: scummvm/trunk/engines/m4/m4.cpp
===================================================================
--- scummvm/trunk/engines/m4/m4.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/m4/m4.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -58,6 +58,7 @@
#include "common/endian.h"
#include "common/system.h"
#include "common/config-manager.h"
+#include "common/debug-channels.h"
#include "engines/util.h"
#include "graphics/surface.h"
#include "sound/mididrv.h"
Modified: scummvm/trunk/engines/mohawk/myst.cpp
===================================================================
--- scummvm/trunk/engines/mohawk/myst.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/mohawk/myst.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -24,6 +24,7 @@
*/
#include "common/config-manager.h"
+#include "common/debug-channels.h"
#include "mohawk/graphics.h"
#include "mohawk/myst.h"
Modified: scummvm/trunk/engines/parallaction/parallaction.cpp
===================================================================
--- scummvm/trunk/engines/parallaction/parallaction.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/parallaction/parallaction.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -24,6 +24,7 @@
*/
#include "common/config-manager.h"
+#include "common/debug-channels.h"
#include "common/events.h"
#include "common/EventRecorder.h"
#include "common/file.h"
Modified: scummvm/trunk/engines/sci/decompressor.cpp
===================================================================
--- scummvm/trunk/engines/sci/decompressor.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/sci/decompressor.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -28,6 +28,7 @@
#include "common/util.h"
#include "common/endian.h"
#include "common/debug.h"
+#include "common/debug-channels.h"
#include "common/stream.h"
#include "sci/decompressor.h"
Modified: scummvm/trunk/engines/sci/engine/kpathing.cpp
===================================================================
--- scummvm/trunk/engines/sci/engine/kpathing.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/sci/engine/kpathing.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -31,6 +31,7 @@
#include "sci/graphics/palette.h"
#include "sci/graphics/screen.h"
+#include "common/debug-channels.h"
#include "common/list.h"
#include "common/system.h"
Modified: scummvm/trunk/engines/sci/engine/vm.cpp
===================================================================
--- scummvm/trunk/engines/sci/engine/vm.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/sci/engine/vm.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -24,6 +24,7 @@
*/
#include "common/debug.h"
+#include "common/debug-channels.h"
#include "common/stack.h"
#include "common/config-manager.h"
Modified: scummvm/trunk/engines/sci/sci.cpp
===================================================================
--- scummvm/trunk/engines/sci/sci.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/sci/sci.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -23,9 +23,9 @@
*
*/
-
#include "common/system.h"
#include "common/config-manager.h"
+#include "common/debug-channels.h"
#include "engines/advancedDetector.h"
#include "engines/util.h"
Modified: scummvm/trunk/engines/scumm/debugger.cpp
===================================================================
--- scummvm/trunk/engines/scumm/debugger.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/scumm/debugger.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -23,8 +23,8 @@
*
*/
-
#include "common/config-manager.h"
+#include "common/debug-channels.h"
#include "common/file.h"
#include "common/str.h"
#include "common/system.h"
Modified: scummvm/trunk/engines/scumm/scumm.cpp
===================================================================
--- scummvm/trunk/engines/scumm/scumm.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/scumm/scumm.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -24,6 +24,7 @@
*/
#include "common/config-manager.h"
+#include "common/debug-channels.h"
#include "common/md5.h"
#include "common/events.h"
#include "common/EventRecorder.h"
Modified: scummvm/trunk/engines/tinsel/tinsel.cpp
===================================================================
--- scummvm/trunk/engines/tinsel/tinsel.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/tinsel/tinsel.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -23,6 +23,7 @@
*
*/
+#include "common/debug-channels.h"
#include "common/endian.h"
#include "common/error.h"
#include "common/events.h"
Modified: scummvm/trunk/engines/touche/touche.cpp
===================================================================
--- scummvm/trunk/engines/touche/touche.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/engines/touche/touche.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -25,6 +25,7 @@
#include "common/config-manager.h"
+#include "common/debug-channels.h"
#include "common/events.h"
#include "common/EventRecorder.h"
#include "common/system.h"
Modified: scummvm/trunk/gui/debugger.cpp
===================================================================
--- scummvm/trunk/gui/debugger.cpp 2010-05-04 11:58:12 UTC (rev 48934)
+++ scummvm/trunk/gui/debugger.cpp 2010-05-04 11:59:22 UTC (rev 48935)
@@ -24,6 +24,7 @@
*/
#include "common/debug.h"
+#include "common/debug-channels.h"
#include "common/system.h"
#include "gui/debugger.h"
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the Scummvm-git-logs
mailing list