ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

debug-channels.h

Go to the documentation of this file.
00001 /* ScummVM - Graphic Adventure Engine
00002  *
00003  * ScummVM is the legal property of its developers, whose names
00004  * are too numerous to list here. Please refer to the COPYRIGHT
00005  * file distributed with this source distribution.
00006  *
00007  * This program is free software; you can redistribute it and/or
00008  * modify it under the terms of the GNU General Public License
00009  * as published by the Free Software Foundation; either version 2
00010  * of the License, or (at your option) any later version.
00011  *
00012  * This program is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with this program; if not, write to the Free Software
00019  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00020  *
00021  */
00022 
00023 #ifndef COMMON_DEBUG_CHANNELS_H
00024 #define COMMON_DEBUG_CHANNELS_H
00025 
00026 #include "common/scummsys.h"
00027 
00028 #include "common/hashmap.h"
00029 #include "common/hash-str.h"
00030 #include "common/list.h"
00031 #include "common/singleton.h"
00032 #include "common/str.h"
00033 
00034 
00035 namespace Common {
00036 
00037 // TODO: Find a better name for this
00038 class DebugManager : public Singleton<DebugManager> {
00039 public:
00040 
00041     struct DebugChannel {
00042         DebugChannel() : channel(0), enabled(false) {}
00043         DebugChannel(uint32 c, const String &n, const String &d)
00044             : name(n), description(d), channel(c), enabled(false) {}
00045 
00046         String name;
00047         String description;
00048 
00049         uint32 channel;
00050         bool enabled;
00051     };
00052 
00075     bool addDebugChannel(uint32 channel, const String &name, const String &description);
00076 
00080     void clearAllDebugChannels();
00081 
00088     bool enableDebugChannel(const String &name);
00089 
00096     bool disableDebugChannel(const String &name);
00097 
00098     typedef List<DebugChannel> DebugChannelList;
00099 
00105     DebugChannelList listDebugChannels();
00106 
00110     void enableAllDebugChannels();
00111 
00115     void disableAllDebugChannels();
00116 
00120     bool isDebugChannelEnabled(uint32 channel, bool enforce = false);
00121 
00122 private:
00123     typedef HashMap<String, DebugChannel, IgnoreCase_Hash, IgnoreCase_EqualTo> DebugChannelMap;
00124 
00125     DebugChannelMap gDebugChannels;
00126     uint32 gDebugChannelsEnabled;
00127 
00128     friend class Singleton<SingletonBaseType>;
00129     DebugManager() : gDebugChannelsEnabled(0) {}
00130 };
00131 
00133 #define DebugMan        Common::DebugManager::instance()
00134 
00135 } // End of namespace Common
00136 
00137 #endif


Generated on Sat May 18 2019 05:00:59 for ResidualVM by doxygen 1.7.1
curved edge   curved edge