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
|
/**************************************************************************
**
** 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://www.qtsoftware.com/contact.
**
**************************************************************************/
#ifndef VCSBASE_BASEEDITOR_H
#define VCSBASE_BASEEDITOR_H
#include "vcsbase_global.h"
#include <texteditor/basetexteditor.h>
#include <QtCore/QSet>
QT_BEGIN_NAMESPACE
class QAction;
class QTextCodec;
class QTextCursor;
QT_END_NAMESPACE
namespace VCSBase {
struct VCSBaseEditorPrivate;
class DiffHighlighter;
class BaseAnnotationHighlighter;
// Contents of a VCSBaseEditor
enum EditorContentType {
// No special handling.
RegularCommandOutput,
// Log of a file under revision control. Provide 'click on change'
// description.
LogOutput,
// <change description>: file line
// Color per change number and provide 'click on change' description.
AnnotateOutput,
// Diff output. Might includes describe output, which consists of a
// header and diffs. Interaction is 'double click in hunk' which
// opens the file
DiffOutput
};
// Helper struct used to parametrize an editor with mime type, context
// and kind. The extension is currently only a suggestion when running
// VCS commands with redirection.
struct VCSBASE_EXPORT VCSBaseEditorParameters {
EditorContentType type;
const char *kind;
const char *context;
const char *mimeType;
const char *extension;
};
// Base class for editors showing version control system output
// of the type enumerated by EditorContentType.
// The source property should contain the file or directory the log
// refers to and will be emitted with describeRequested().
// This is for VCS that need a current directory.
class VCSBASE_EXPORT VCSBaseEditor : public TextEditor::BaseTextEditor
{
Q_PROPERTY(QString source READ source WRITE setSource)
Q_PROPERTY(QTextCodec *codec READ codec WRITE setCodec)
Q_OBJECT
protected:
// Initialization requires calling init() (which in turns calls
// virtual functions).
explicit VCSBaseEditor(const VCSBaseEditorParameters *type,
QWidget *parent);
public:
void init();
virtual ~VCSBaseEditor();
QString source() const;
void setSource(const QString &source);
QTextCodec *codec() const;
void setCodec(QTextCodec *);
bool isModified() const;
EditorContentType contentType() const;
// Utility to find a parameter set by type in an array.
static const VCSBaseEditorParameters *
findType(const VCSBaseEditorParameters *array, int arraySize, EditorContentType et);
// Utility to find the codec for a source (file or directory), querying
// the editor manager and the project managers (defaults to system codec).
// The codec should be set on editors displaying diff or annotation
// output.
static QTextCodec *getCodec(const QString &source);
// Utility to return the editor from the IEditor returned by the editor
// manager which is a BaseTextEditable.
static VCSBaseEditor *getVcsBaseEditor(const Core::IEditor *editor);
signals:
void describeRequested(const QString &source, const QString &change);
public slots:
// Convenience slot to set data read from stdout, will use the
// documents' codec to decode
void setPlainTextData(const QByteArray &data);
protected:
virtual TextEditor::BaseTextEditorEditable *createEditableInterface();
void contextMenuEvent(QContextMenuEvent *e);
void mouseMoveEvent(QMouseEvent *e);
void mouseReleaseEvent(QMouseEvent *e);
void mouseDoubleClickEvent(QMouseEvent *e);
void keyPressEvent(QKeyEvent *);
public slots:
void setFontSettings(const TextEditor::FontSettings &);
private slots:
void describe();
void slotActivateAnnotation();
void slotPopulateDiffBrowser();
void slotDiffBrowse(int);
void slotDiffCursorPositionChanged();
private:
// Implement to return a set of change identifiers in
// annotation mode
virtual QSet<QString> annotationChanges() const = 0;
// Implement to identify a change number at the cursor position
virtual QString changeUnderCursor(const QTextCursor &) const = 0;
// Factory functions for highlighters
virtual DiffHighlighter *createDiffHighlighter() const = 0;
virtual BaseAnnotationHighlighter *createAnnotationHighlighter(const QSet<QString> &changes) const = 0;
// Implement to return a local file name from the diff file specification
// (text cursor at position above change hunk)
virtual QString fileNameFromDiffSpecification(const QTextBlock &diffFileSpec) const = 0;
void jumpToChangeFromDiff(QTextCursor cursor);
VCSBaseEditorPrivate *d;
};
} // namespace VCSBase
#endif // VCSBASE_BASEEDITOR_H
|
