debugman.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos 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.
 *
 * xoreos 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 xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

// Inspired by ScummVM's debug channels

#ifndef COMMON_DEBUGMAN_H
#define COMMON_DEBUGMAN_H

#include <vector>
#include <map>

#include "src/common/types.h"
#include "src/common/ustring.h"
#include "src/common/singleton.h"
#include "src/common/writefile.h"

namespace Common {

enum DebugChannel {
    kDebugGraphics, 
    kDebugSound   , 
    kDebugVideo   , 
    kDebugEvents  , 
    kDebugScripts , 

    kDebugGLAPI   , 
    kDebugGLWindow, 
    kDebugGLShader, 
    kDebugGL3rd   , 
    kDebugGLApp   , 
    kDebugGLOther , 

    kDebugEngineGraphics, 
    kDebugEngineSound   , 
    kDebugEngineVideo   , 
    kDebugEngineEvents  , 
    kDebugEngineScripts , 
    kDebugEngineLogic   , 

    kDebugActionScript, 

    kDebugChannelCount, 
    kDebugChannelAll    
};

enum DebugGLType {
    kDebugGLTypeError,       
    kDebugGLTypeDeprecated , 
    kDebugGLTypeUndefined  , 
    kDebugGLTypePortability, 
    kDebugGLTypePerformance, 
    kDebugGLTypeOther,       

    kDebugGLTypeMAX 
};

class DebugManager : public Singleton<DebugManager> {
public:
    static const uint32 kMaxVerbosityLevel = 9;

    DebugManager();
    ~DebugManager();

    void getDebugChannels(std::vector<UString> &names, std::vector<UString> &descriptions) const;

    void setVerbosityLevel(DebugChannel channel, uint32 level);
    void setVerbosityLevel(const UString &channel, uint32 level);

    uint32 getVerbosityLevel(DebugChannel channel) const;
    uint32 getVerbosityLevel(const UString &channel) const;

    bool isEnabled(DebugChannel channel, uint32 level) const;
    bool isEnabled(const UString &channel, uint32 level) const;

    void setVerbosityLevelsFromConfig();

    void setConfigToVerbosityLevels();

    void logDebugGL(DebugChannel channel, uint32 level, DebugGLType type, uint32 id, const char *msg);

    bool openLogFile(const UString &file);
    void closeLogFile();

    void logString(const UString &str);

    void logCommandLine(const std::vector<UString> &argv);

    static UString getDefaultLogFile();

private:
    struct Channel {
        UString name;        
        UString description; 

        uint32 level; 

        uint32 glTypeIDs[kDebugGLTypeMAX];
    };

    typedef std::map<UString, DebugChannel, UString::iless> ChannelMap;

    Channel    _channels[kDebugChannelCount]; 
    ChannelMap _channelMap;                   

    WriteFile _logFile;
    bool _logFileStartLine;

    bool _changedConfig;
};

} // End of namespace Common

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

#endif // COMMON_DEBUGMAN_H