debuggercore.h 4.56 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
hjk's avatar
hjk committed
2
**
3
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
hjk's avatar
hjk committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
hjk's avatar
hjk committed
7
**
hjk's avatar
hjk committed
8 9 10 11 12
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
Eike Ziller's avatar
Eike Ziller committed
13 14
** conditions see http://www.qt.io/licensing.  For further information
** use the contact form at http://www.qt.io/contact-us.
hjk's avatar
hjk committed
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18 19 20 21 22 23
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
hjk's avatar
hjk committed
24
**
hjk's avatar
hjk committed
25 26
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
27 28
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
29
****************************************************************************/
hjk's avatar
hjk committed
30 31 32 33 34 35

#ifndef DEBUGGERCORE_H
#define DEBUGGERCORE_H

#include "debuggerconstants.h"

36 37
#include <projectexplorer/abi.h>

38 39
#include <QObject>
#include <QSharedPointer>
hjk's avatar
hjk committed
40 41 42 43 44

QT_BEGIN_NAMESPACE
class QIcon;
class QMessageBox;
class QWidget;
45
class QTreeView;
hjk's avatar
hjk committed
46 47
QT_END_NAMESPACE

48
namespace CPlusPlus { class Snapshot; }
hjk's avatar
hjk committed
49

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

52
namespace ProjectExplorer { class RunControl; }
53

hjk's avatar
hjk committed
54 55 56 57 58 59 60
namespace Debugger {

class DebuggerEngine;

namespace Internal {

class BreakHandler;
hjk's avatar
hjk committed
61
class Symbol;
62
class Section;
63
class GlobalDebuggerOptions;
hjk's avatar
hjk committed
64

hjk's avatar
hjk committed
65 66 67
enum TestCases
{
    // Gdb
68
    TestNoBoundsOfCurrentFunction = 1
hjk's avatar
hjk committed
69 70
};

hjk's avatar
hjk committed
71 72 73 74 75 76 77 78
class DebuggerCore : public QObject
{
    Q_OBJECT

public:
    DebuggerCore() {}

    virtual void updateState(DebuggerEngine *engine) = 0;
hjk's avatar
hjk committed
79
    virtual void updateWatchersWindow(bool showWatch, bool showReturn) = 0;
hjk's avatar
hjk committed
80 81 82 83 84 85 86 87
    virtual QIcon locationMarkIcon() const = 0;
    virtual const CPlusPlus::Snapshot &cppCodeModelSnapshot() const = 0;
    virtual bool hasSnapshots() const = 0;
    virtual void openTextEditor(const QString &titlePattern, const QString &contents) = 0;
    virtual bool isActiveDebugLanguage(int language) const = 0;

    // void runTest(const QString &fileName);
    virtual void showMessage(const QString &msg, int channel, int timeout = -1) = 0;
88

hjk's avatar
hjk committed
89
    virtual bool isReverseDebugging() const = 0;
90 91
    virtual void runControlStarted(DebuggerEngine *engine) = 0;
    virtual void runControlFinished(DebuggerEngine *engine) = 0;
hjk's avatar
hjk committed
92 93
    virtual void displayDebugger(DebuggerEngine *engine, bool updateEngine) = 0;
    virtual DebuggerLanguages activeLanguages() const = 0;
hjk's avatar
hjk committed
94
    virtual void synchronizeBreakpoints() = 0;
hjk's avatar
hjk committed
95 96 97

    virtual bool initialize(const QStringList &arguments, QString *errorMessage) = 0;
    virtual QWidget *mainWindow() const = 0;
98
    virtual bool isDockVisible(const QString &objectName) const = 0;
hjk's avatar
hjk committed
99
    virtual void showModuleSymbols(const QString &moduleName,
hjk's avatar
hjk committed
100
        const QVector<Symbol> &symbols) = 0;
101 102
    virtual void showModuleSections(const QString &moduleName,
        const QVector<Section> &sections) = 0;
hjk's avatar
hjk committed
103 104
    virtual void openMemoryEditor() = 0;
    virtual void languagesChanged() = 0;
hjk's avatar
hjk committed
105

106
    virtual void setThreads(const QStringList &list, int index) = 0;
107

108
    virtual QSharedPointer<GlobalDebuggerOptions> globalDebuggerOptions() const = 0;
109

110 111
    static QTreeView *inspectorView();

112 113
public slots:
    virtual void attachExternalApplication(ProjectExplorer::RunControl *rc) = 0;
hjk's avatar
hjk committed
114 115
};

hjk's avatar
hjk committed
116 117 118 119 120 121 122 123 124 125 126 127 128 129
// Some convenience.
QVariant sessionValue(const QByteArray &name);
void setSessionValue(const QByteArray &name, const QVariant &value);
QVariant configValue(const QByteArray &name);
void setConfigValue(const QByteArray &name, const QVariant &value);

Utils::SavedAction *action(int code);
bool boolSetting(int code);
QString stringSetting(int code);
QStringList stringListSetting(int code);

BreakHandler *breakHandler();
DebuggerEngine *currentEngine();

130
// This is the only way to access the global object.
hjk's avatar
hjk committed
131
DebuggerCore *debuggerCore();
hjk's avatar
hjk committed
132

hjk's avatar
hjk committed
133 134
QMessageBox *showMessageBox(int icon, const QString &title,
    const QString &text, int buttons = 0);
hjk's avatar
hjk committed
135 136 137 138 139

} // namespace Internal
} // namespace Debugger

#endif // DEBUGGERPLUGIN_H