aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/debugger/debuggermainwindow.h
blob: 30e646ccea2d0c4dde60b56d116d217fbcbd0780 (plain)
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/

#pragma once

#include "debugger_global.h"

#include <utils/fancymainwindow.h>
#include <utils/statuslabel.h>

#include <QHBoxLayout>
#include <QPointer>
#include <QSet>

#include <functional>

QT_BEGIN_NAMESPACE
class QComboBox;
class QToolButton;
class QStackedWidget;
QT_END_NAMESPACE

namespace Core { class Id; }

namespace Utils {

class DEBUGGER_EXPORT Perspective
{
public:
    enum OperationType { SplitVertical, SplitHorizontal, AddToTab, Raise };

    explicit Perspective(const QByteArray &id, const QString &name);
    ~Perspective();

    void setCentralWidget(QWidget *centralWidget);
    void addWindow(QWidget *widget,
                   OperationType op,
                   QWidget *anchorWidget,
                   bool visibleByDefault = true,
                   Qt::DockWidgetArea area = Qt::BottomDockWidgetArea);

    QToolButton *addToolbarAction(QAction *action, const QIcon &toolbarIcon = QIcon());
    void addToolbarWidget(QWidget *widget);
    void addToolbarSeparator();

    QWidget *centralWidget() const;

    QString name() const;

    using Callback = std::function<void()>;
    void setAboutToActivateCallback(const Callback &cb);
    void aboutToActivate() const;

    QByteArray parentPerspective() const;
    void setParentPerspective(const QByteArray &parentPerspective);

private:
    Perspective(const Perspective &) = delete;
    void operator=(const Perspective &) = delete;

    friend class DebuggerMainWindow;
    class PerspectivePrivate *d = nullptr;
    class Operation
    {
    public:
        QPointer<QWidget> widget;
        QByteArray anchorDockId;
        OperationType operationType = Raise;
        bool visibleByDefault = true;
        Qt::DockWidgetArea area = Qt::BottomDockWidgetArea;
    };

    class ToolbarOperation
    {
    public:
        QPointer<QWidget> widget; // Owned by plugin if present
        QPointer<QAction> action; // Owned by plugin if present
        QPointer<QToolButton> toolbutton; // Owned here in case action is used
        QPointer<QWidget> separator;
        QIcon icon;
    };

    const QByteArray m_id;
    QString m_name;
    QByteArray m_parentPerspective;
    QVector<Operation> m_operations;
    QPointer<QWidget> m_centralWidget;
    Callback m_aboutToActivateCallback;
    QVector<ToolbarOperation> m_toolbarOperations;
};

class DEBUGGER_EXPORT DebuggerMainWindow : public FancyMainWindow
{
    Q_OBJECT

public:
    DebuggerMainWindow();
    ~DebuggerMainWindow() override;

    void registerPerspective(Perspective *perspective);
    void destroyDynamicPerspective(Perspective *perspective);

    void resetCurrentPerspective();
    void restorePerspective(Perspective *perspective);

    void finalizeSetup();

    void showStatusMessage(const QString &message, int timeoutMS);
    void raiseDock(const QByteArray &dockId);
    QByteArray currentPerspective() const;
    QStackedWidget *centralWidgetStack() const { return m_centralWidgetStack; }

    void onModeChanged(Core::Id mode);

    void setPerspectiveEnabled(const QByteArray &perspectiveId, bool enabled);

    Perspective *findPerspective(const QByteArray &perspectiveId) const;

private:
    void closeEvent(QCloseEvent *) final { savePerspectiveHelper(m_currentPerspective); }

    void loadPerspectiveHelper(Perspective *perspective, bool fromStoredSettings = true);
    void savePerspectiveHelper(const Perspective *perspective);
    void increaseChooserWidthIfNecessary(const QString &visibleName);
    int indexInChooser(Perspective *perspective) const;

    Perspective *m_currentPerspective = nullptr;
    QComboBox *m_perspectiveChooser = nullptr;
    QHBoxLayout *m_toolbuttonBoxLayout = nullptr;
    QStackedWidget *m_centralWidgetStack = nullptr;
    QWidget *m_editorPlaceHolder = nullptr;
    Utils::StatusLabel *m_statusLabel = nullptr;
    QDockWidget *m_toolbarDock = nullptr;

    QHash<QByteArray, QDockWidget *> m_dockForDockId;
    QList<Perspective *> m_perspectives;
};

DEBUGGER_EXPORT QWidget *createModeWindow(const Core::Id &mode, DebuggerMainWindow *mainWindow);

} // Utils