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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
/****************************************************************************
**
** 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 "vcsbase_global.h"
#include <coreplugin/icontext.h>
#include <coreplugin/iversioncontrol.h>
#include <coreplugin/vcsmanager.h>
#include <extensionsystem/iplugin.h>
#include <QSharedDataPointer>
QT_BEGIN_NAMESPACE
class QAction;
class QTextCodec;
QT_END_NAMESPACE
namespace Utils {
class Environment;
} // namespace Utils
namespace Core {
class Context;
class IVersionControl;
class IDocument;
} // namespace Core
namespace VcsBase {
namespace Internal { class State; }
class VcsBaseSubmitEditor;
class VcsBasePluginPrivate;
class VcsBasePluginStateData;
class VcsBasePluginPrivate;
// Documentation inside.
class VCSBASE_EXPORT VcsBasePluginState
{
public:
VcsBasePluginState();
VcsBasePluginState(const VcsBasePluginState &);
VcsBasePluginState &operator=(const VcsBasePluginState &);
~VcsBasePluginState();
void clear();
bool isEmpty() const;
bool hasFile() const;
bool hasPatchFile() const;
bool hasProject() const;
bool hasTopLevel() const;
// Current file.
QString currentFile() const;
QString currentFileName() const;
Utils::FilePath currentFileDirectory() const;
Utils::FilePath currentFileTopLevel() const;
// Convenience: Returns file relative to top level.
QString relativeCurrentFile() const;
// If the current file looks like a patch and there is a top level,
// it will end up here (for VCS that offer patch functionality).
QString currentPatchFile() const;
QString currentPatchFileDisplayName() const;
// Current project.
Utils::FilePath currentProjectPath() const;
QString currentProjectName() const;
Utils::FilePath currentProjectTopLevel() const;
/* Convenience: Returns project path relative to top level if it
* differs from top level (else empty string) as an argument list to do
* eg a 'vcs diff <args>' */
QString relativeCurrentProject() const;
// Top level directory for actions on the top level. Preferably
// the file one.
Utils::FilePath topLevel() const;
bool equals(const VcsBasePluginState &rhs) const;
friend VCSBASE_EXPORT QDebug operator<<(QDebug in, const VcsBasePluginState &state);
private:
friend class VcsBasePluginPrivate;
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); }
// Convenience that searches for the repository specifically for version control
// systems that do not have directories like "CVS" in each managed subdirectory
// but have a directory at the top of the repository like ".git" containing
// a well known file. See implementation for gory details.
VCSBASE_EXPORT Utils::FilePath findRepositoryForFile(const Utils::FilePath &fileOrDir,
const QString &checkFile);
// Returns SSH prompt configured in settings.
VCSBASE_EXPORT QString sshPrompt();
// Returns whether an SSH prompt is configured.
VCSBASE_EXPORT bool isSshPromptConfigured();
// Set up the environment for a version control command line call.
// Sets up SSH graphical password prompting (note that the latter
// requires a terminal-less process) and sets LANG to 'C' to force English
// (suppress LOCALE warnings/parse commands output) if desired.
VCSBASE_EXPORT void setProcessEnvironment(Utils::Environment *e,
bool forceCLocale,
const QString &sshPasswordPrompt = sshPrompt());
// Sets the source of editor contents, can be directory or file.
VCSBASE_EXPORT void setSource(Core::IDocument *document, const QString &source);
// Returns the source of editor contents.
VCSBASE_EXPORT QString source(Core::IDocument *document);
class VCSBASE_EXPORT VcsBasePluginPrivate : public Core::IVersionControl
{
Q_OBJECT
protected:
explicit VcsBasePluginPrivate(const Core::Context &context);
public:
void extensionsInitialized();
const VcsBasePluginState ¤tState() const;
// Display name of the commit action
virtual QString commitDisplayName() const;
virtual void commitFromEditor() = 0;
protected:
// Prompt to save all files before commit:
bool promptBeforeCommit();
// Convenience slot for "Delete current file" action. Prompts to
// delete the file via VcsManager.
void promptToDeleteCurrentFile();
// Prompt to initialize version control in a directory, initially
// pointing to the current project.
void createRepository();
enum ActionState { NoVcsEnabled, OtherVcsEnabled, VcsEnabled };
// Sets the current submit editor for this specific version control plugin.
// The plugin automatically checks if the submit editor is closed and calls
// submitEditorAboutToClose().
// The function raiseSubmitEditor can be used to check for a running submit editor and raise it.
void setSubmitEditor(VcsBaseSubmitEditor *submitEditor);
// Current submit editor set through setSubmitEditor, if it wasn't closed inbetween
VcsBaseSubmitEditor *submitEditor() const;
// Tries to raise the submit editor set through setSubmitEditor. Returns true if that was found.
bool raiseSubmitEditor() const;
// Implement to enable the plugin menu actions according to state.
virtual void updateActions(ActionState as) = 0;
// Implement to start the submit process, use submitEditor() to get the submit editor instance.
virtual bool submitEditorAboutToClose() = 0;
// A helper to enable the VCS menu action according to state:
// NoVcsEnabled -> visible, enabled if repository creation is supported
// OtherVcsEnabled -> invisible
// Else: -> fully enabled.
// Returns whether actions should be set up further.
bool enableMenuAction(ActionState as, QAction *in) const;
private:
void slotSubmitEditorAboutToClose(VcsBaseSubmitEditor *submitEditor, bool *result);
void slotStateChanged(const Internal::State &s, Core::IVersionControl *vc);
bool supportsRepositoryCreation() const;
QPointer<VcsBaseSubmitEditor> m_submitEditor;
Core::Context m_context;
VcsBasePluginState m_state;
int m_actionState = -1;
};
} // namespace VcsBase
|
