debuggercore.h 4.47 KB
Newer Older
hjk's avatar
hjk committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/

#ifndef DEBUGGERCORE_H
#define DEBUGGERCORE_H

#include "debugger_global.h"
#include "debuggerconstants.h"

#include <QtCore/QObject>
hjk's avatar
hjk committed
37
#include <QtCore/QMultiMap>
hjk's avatar
hjk committed
38 39 40 41 42 43 44 45 46 47 48

QT_BEGIN_NAMESPACE
class QIcon;
class QMessageBox;
class QWidget;
QT_END_NAMESPACE

namespace CPlusPlus {
class Snapshot;
}

hjk's avatar
hjk committed
49 50 51 52
namespace Utils {
class SavedAction;
}

hjk's avatar
hjk committed
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
namespace Debugger {

class DebuggerEngine;
class DebuggerRunControl;
class DebuggerStartParameters;

namespace Internal {

class BreakHandler;
class SnapshotHandler;

// This is the "internal" interface of the debugger plugin that's
// used by debugger views and debugger engines. The interface is
// implemented in DebuggerPluginPrivate.

class DebuggerCore : public QObject
{
    Q_OBJECT

public:
    DebuggerCore() {}

    virtual QVariant sessionValue(const QString &name) = 0;
    virtual void setSessionValue(const QString &name, const QVariant &value) = 0;
    virtual QVariant configValue(const QString &name) const = 0;
    virtual void setConfigValue(const QString &name, const QVariant &value) = 0;
    virtual void updateState(DebuggerEngine *engine) = 0;
    virtual void showQtDumperLibraryWarning(const QString &details) = 0;
    virtual QIcon locationMarkIcon() const = 0;
    virtual const CPlusPlus::Snapshot &cppCodeModelSnapshot() const = 0;
    virtual bool isRegisterViewVisible() const = 0;
    virtual bool hasSnapshots() const = 0;
    virtual void openTextEditor(const QString &titlePattern, const QString &contents) = 0;
hjk's avatar
hjk committed
86 87
    virtual BreakHandler *breakHandler() const = 0;
    virtual SnapshotHandler *snapshotHandler() const = 0;
hjk's avatar
hjk committed
88 89 90 91 92 93 94 95 96 97 98 99
    virtual DebuggerEngine *currentEngine() const = 0;
    virtual bool isActiveDebugLanguage(int language) const = 0;

    virtual void clearCppCodeModelSnapshot() = 0;
    virtual void ensureLogVisible() = 0;

    // void runTest(const QString &fileName);
    virtual void showMessage(const QString &msg, int channel, int timeout = -1) = 0;
    virtual void gotoLocation(const QString &fileName, int lineNumber = -1,
        bool setMarker = false) = 0;

    virtual void resetLocation() = 0;
100 101
    virtual void removeLocationMark() = 0;

hjk's avatar
hjk committed
102 103 104 105 106 107 108 109 110
    virtual void readSettings() = 0;
    virtual void writeSettings() const = 0;

    virtual bool isReverseDebugging() const = 0;
    virtual void createNewDock(QWidget *widget) = 0;
    virtual void runControlStarted(DebuggerRunControl *runControl) = 0;
    virtual void runControlFinished(DebuggerRunControl *runControl) = 0;
    virtual void displayDebugger(DebuggerEngine *engine, bool updateEngine) = 0;
    virtual DebuggerLanguages activeLanguages() const = 0;
hjk's avatar
hjk committed
111
    virtual void synchronizeBreakpoints() = 0;
hjk's avatar
hjk committed
112 113 114

    virtual bool initialize(const QStringList &arguments, QString *errorMessage) = 0;
    virtual QWidget *mainWindow() const = 0;
hjk's avatar
hjk committed
115 116 117 118 119
    virtual QString gdbBinaryForToolChain(int toolChain) const = 0;

    virtual Utils::SavedAction *action(int code) const = 0;
    virtual bool boolSetting(int code) const = 0;
    virtual QString stringSetting(int code) const = 0;
hjk's avatar
hjk committed
120 121
};

122
// This is the only way to access the global object.
hjk's avatar
hjk committed
123
DebuggerCore *debuggerCore();
hjk's avatar
hjk committed
124 125 126
inline BreakHandler *breakHandler() { return debuggerCore()->breakHandler(); }
QMessageBox *showMessageBox(int icon, const QString &title,
    const QString &text, int buttons = 0);
hjk's avatar
hjk committed
127 128 129 130 131

} // namespace Internal
} // namespace Debugger

#endif // DEBUGGERPLUGIN_H