debugger.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 GUI_DEBUGGER_H
#define GUI_DEBUGGER_H

#include "common/func.h"
#include "common/ptr.h"
#include "common/hashmap.h"
#include "common/hash-str.h"
#include "common/array.h"
#include "common/str.h"
#include "common/str-array.h"

#include "engines/engine.h"

namespace GUI {

#ifndef USE_TEXT_CONSOLE_FOR_DEBUGGER
class ConsoleDialog;
#endif

class Debugger {
public:
    Debugger();
    virtual ~Debugger();

    int getCharsPerLine();

    int debugPrintf(MSVC_PRINTF const char *format, ...) GCC_PRINTF(2, 3);

    void debugPrintColumns(const Common::StringArray &list);

    virtual void onFrame();

    virtual void attach(const char *entry = nullptr);

    bool isActive() const { return _isActive; }

protected:
    typedef Common::Functor1<const char *, bool> defaultCommand;
    typedef Common::Functor2<int, const char **, bool> Debuglet;

    #define WRAP_METHOD(cls, method) \
        new Common::Functor2Mem<int, const char **, bool, cls>(this, &cls::method)

    #define WRAP_DEFAULTCOMMAND(cls, command) \
        new Common::Functor1Mem<const char *, bool, cls>(this, &cls::command)

    enum VarType {
        DVAR_BYTE,
        DVAR_INT,
        DVAR_FLOAT,
        DVAR_BOOL,
        DVAR_INTARRAY,
        DVAR_STRING
    };

    struct Var {
        Common::String name;
        void *variable;
        VarType type;
        int arraySize;
    };

private:
    void registerVarImpl(const Common::String &varname, void *variable, VarType type, int arraySize);

protected:
    void registerVar(const Common::String &varname, byte *variable) {
        registerVarImpl(varname, variable, DVAR_BYTE, 0);
    }

    void registerVar(const Common::String &varname, int *variable) {
        registerVarImpl(varname, variable, DVAR_INT, 0);
    }

    void registerVar(const Common::String &varname, float *variable) {
        registerVarImpl(varname, variable, DVAR_FLOAT, 0);
    }

    void registerVar(const Common::String &varname, bool *variable) {
        registerVarImpl(varname, variable, DVAR_BOOL, 0);
    }

    void registerVar(const Common::String &varname, int32 **variable, int arraySize) {
        registerVarImpl(varname, variable, DVAR_INTARRAY, arraySize);
    }

    void registerVar(const Common::String &varname, Common::String *variable) {
        registerVarImpl(varname, variable, DVAR_STRING, 0);
    }

    void registerCmd(const Common::String &cmdname, Debuglet *debuglet);

    void registerDefaultCmd(defaultCommand *defaultCommandProcessor) {
        _defaultCommandProcessor = defaultCommandProcessor; }

    void clearVars();

    void setPrompt(Common::String prompt);
    void resetPrompt();

private:
    uint _frameCountdown;

    Common::Array<Var> _vars;

    typedef Common::HashMap<Common::String, Common::SharedPtr<Debuglet>, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> CommandsMap;
    CommandsMap _cmds;

    bool _isActive;

    Common::String _errStr;

    bool _firstTime;

    defaultCommand *_defaultCommandProcessor;

protected:
    PauseToken _debugPauseToken;

#ifndef USE_TEXT_CONSOLE_FOR_DEBUGGER
    GUI::ConsoleDialog *_debuggerDialog;
#endif

protected:
    virtual void preEnter();

    virtual void postEnter();

    virtual bool handleCommand(int argc, const char **argv, bool &keepRunning);

    void detach();

private:
    void enter();

    void splitCommand(Common::String &input, int &argc, const char **argv);

    bool parseCommand(const char *input);
    bool tabComplete(const char *input, Common::String &completion) const;

protected:
    bool cmdExit(int argc, const char **argv);
    bool cmdHelp(int argc, const char **argv);
    bool cmdOpenLog(int argc, const char **argv);
#ifndef DISABLE_MD5
    bool cmdMd5(int argc, const char **argv);
    bool cmdMd5Mac(int argc, const char **argv);
#endif
    bool cmdDebugLevel(int argc, const char **argv);
    bool cmdDebugFlagsList(int argc, const char **argv);
    bool cmdDebugFlagEnable(int argc, const char **argv);
    bool cmdDebugFlagDisable(int argc, const char **argv);
    bool cmdClearLog(int argc, const char **argv);
    bool cmdExecFile(int argc, const char **argv);

#ifndef USE_TEXT_CONSOLE_FOR_DEBUGGER
private:
    static bool debuggerInputCallback(GUI::ConsoleDialog *console, const char *input, void *refCon);
    static bool debuggerCompletionCallback(GUI::ConsoleDialog *console, const char *input, Common::String &completion, void *refCon);
#elif defined(USE_READLINE)
public:
    char *readlineComplete(const char *input, int state);
#endif

};

} // End of namespace GUI

#endif