debug-channels.h

/* 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */

#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"

struct DebugChannelDef {
    uint32 channel;             
    const char *name;           
    const char *description;    
};

#define DEBUG_CHANNEL_END {0, NULL, NULL}

extern const DebugChannelDef gDebugChannels[];

namespace Common {

// TODO: Find a better name for this
class DebugManager : public Singleton<DebugManager> {
public:

    struct DebugChannel {
        DebugChannel() : channel(0) {}
        DebugChannel(uint32 c, const String &n, const String &d)
            : name(n), description(d), channel(c) {}

        String name; 
        String description; 
        uint32 channel; 
    };

    bool addDebugChannel(uint32 channel, const String &name, const String &description);

    void addAllDebugChannels(const DebugChannelDef *channels);

    void removeAllDebugChannels();

    bool enableDebugChannel(const String &name);

    bool enableDebugChannel(uint32 channel);

    bool disableDebugChannel(const String &name);

    bool disableDebugChannel(uint32 channel);

    typedef List<DebugChannel> DebugChannelList;

    DebugChannelList getDebugChannels();

    void enableAllDebugChannels();

    void disableAllDebugChannels();

    bool isDebugChannelEnabled(uint32 channel, bool enforce = false);

private:
    typedef HashMap<String, DebugChannel, IgnoreCase_Hash, IgnoreCase_EqualTo> DebugChannelMap;
    typedef HashMap<uint32, bool> EnabledChannelsMap;

    DebugChannelMap _debugChannels;
    EnabledChannelsMap _debugChannelsEnabled;
    uint32 _globalChannelsMask;

    friend class Singleton<SingletonBaseType>;

    DebugManager();

    void addDebugChannels(const DebugChannelDef *channels);
};

#define DebugMan        Common::DebugManager::instance()

} // End of namespace Common

#endif