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
164
165
166
167
168
169
170
171
172
173
174
175
|
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2009 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 VCSBASEPLUGIN_H
#define VCSBASEPLUGIN_H
#include "vcsbase_global.h"
#include <extensionsystem/iplugin.h>
#include <QSharedDataPointer>
QT_BEGIN_NAMESPACE
class QAction;
QT_END_NAMESPACE
namespace Core {
class IVersionControl;
}
namespace VCSBase {
namespace Internal {
struct State;
}
class VCSBaseSubmitEditor;
struct VCSBasePluginPrivate;
class VCSBasePluginStateData;
class VCSBasePlugin;
/* VCSBasePlugin and VCSBasePluginState: Provide a base class for
* VCS plugins. It mainly takes care of maintaining the
* VCS-relevant state of Qt Creator which is a tuple of
*
* 1) Current file and it's version system control/top level
* 2) Current project and it's version system control/top level
*
* (reflected in VCSBasePluginState). The plugin connects to the
* relevant change signals in Qt Creator and calls the virtual
* updateActions() for the plugins to update their menu actions
* according to the new state. This is done centrally to avoid
* single plugins repeatedly invoking searches/QFileInfo on files,
* etc.
*
* If current file/project are managed
* by different version controls, the project is discarded and only
* the current file is taken into account, allowing to do a diff
* also when the project of a file is not opened.
*
* When triggering an action, a copy of the state should be made to
* keep it, as it may rapidly change due to context changes, etc.
*
* The class also detects the VCS plugin submit editor closing and calls
* the virtual submitEditorAboutToClose() to trigger the submit process. */
class VCSBASE_EXPORT VCSBasePluginState
{
public:
VCSBasePluginState();
VCSBasePluginState(const VCSBasePluginState &);
VCSBasePluginState &operator=(const VCSBasePluginState &);
~VCSBasePluginState();
void clear();
bool isEmpty() const;
bool hasFile() const;
bool hasProject() const;
bool hasTopLevel() const;
// Current file.
QString currentFile() const;
QString currentFileName() const;
QString currentFileDirectory() const;
QString currentFileTopLevel() const;
// Convenience: Returns file relative to top level.
QString relativeCurrentFile() const;
// Current project.
QString currentProjectPath() const;
QString currentProjectName() const;
QString currentProjectTopLevel() const;
/* Convenience: Returns project path relative to top level if it
* differs from top level (else empty()) as an argument list to do
* eg a 'vcs diff <args>' */
QStringList relativeCurrentProject() const;
// Top level directory for actions on the top level. Preferably
// the file one.
QString topLevel() const;
bool equals(const VCSBasePluginState &rhs) const;
friend VCSBASE_EXPORT QDebug operator<<(QDebug in, const VCSBasePluginState &state);
private:
friend class VCSBasePlugin;
bool equals(const Internal::State &s) const;
void setState(const Internal::State &s);
QSharedDataPointer<VCSBasePluginStateData> data;
};
VCSBASE_EXPORT QDebug operator<<(QDebug in, const VCSBasePluginState &state);
inline bool operator==(const VCSBasePluginState &s1, const VCSBasePluginState &s2)
{ return s1.equals(s2); }
inline bool operator!=(const VCSBasePluginState &s1, const VCSBasePluginState &s2)
{ return !s1.equals(s2); }
class VCSBASE_EXPORT VCSBasePlugin : public ExtensionSystem::IPlugin
{
Q_OBJECT
protected:
explicit VCSBasePlugin(const QString &submitEditorKind);
void initialize(Core::IVersionControl *vc);
public:
virtual ~VCSBasePlugin();
const VCSBasePluginState ¤tState() const;
Core::IVersionControl *versionControl() const;
protected:
enum ActionState { NoVCSEnabled, OtherVCSEnabled, VCSEnabled };
// Implement to enable the plugin menu actions according to state.
virtual void updateActions(ActionState as) = 0;
// Implement to start the submit process.
virtual bool submitEditorAboutToClose(VCSBaseSubmitEditor *submitEditor) = 0;
// A helper to enable the VCS menu action according to state:
// NoVCSEnabled->(visible,disabled), OtherVCSEnabled->(invisible), else
// enabled. Returns whether actions should be set up further.
static bool enableMenuAction(ActionState as, QAction *in);
private slots:
void slotSubmitEditorAboutToClose(VCSBaseSubmitEditor *submitEditor, bool *result);
void slotStateChanged(const VCSBase::Internal::State &s, Core::IVersionControl *vc);
private:
VCSBasePluginPrivate *d;
};
} // namespace VCSBase
#endif // VCSBASEPLUGIN_H
|
