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
|
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** 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 Digia. For licensing terms and
** conditions see http://www.qt.io/licensing. For further information
** use the contact form at http://www.qt.io/contact-us.
**
** 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 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.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#ifndef REFACTORINGCHANGES_H
#define REFACTORINGCHANGES_H
#include <utils/changeset.h>
#include <utils/textfileformat.h>
#include <texteditor/texteditor_global.h>
#include <QList>
#include <QString>
#include <QSharedPointer>
#include <QPair>
QT_BEGIN_NAMESPACE
class QTextDocument;
QT_END_NAMESPACE
namespace TextEditor {
class TextDocument;
class TextEditorWidget;
class RefactoringChanges;
class RefactoringFile;
class RefactoringChangesData;
typedef QSharedPointer<RefactoringFile> RefactoringFilePtr;
typedef QVector<QPair<QTextCursor, QTextCursor> > RefactoringSelections;
// ### listen to the m_editor::destroyed signal?
class TEXTEDITOR_EXPORT RefactoringFile
{
Q_DISABLE_COPY(RefactoringFile)
public:
typedef Utils::ChangeSet::Range Range;
public:
virtual ~RefactoringFile();
bool isValid() const;
const QTextDocument *document() const;
// mustn't use the cursor to change the document
const QTextCursor cursor() const;
QString fileName() const;
TextEditorWidget *editor() const;
// converts 1-based line and column into 0-based source offset
int position(unsigned line, unsigned column) const;
// converts 0-based source offset into 1-based line and column
void lineAndColumn(int offset, unsigned *line, unsigned *column) const;
QChar charAt(int pos) const;
QString textOf(int start, int end) const;
QString textOf(const Range &range) const;
void setChangeSet(const Utils::ChangeSet &changeSet);
void appendIndentRange(const Range &range);
void appendReindentRange(const Range &range);
void setOpenEditor(bool activate = false, int pos = -1);
void apply();
protected:
// users may only get const access to RefactoringFiles created through
// this constructor, because it can't be used to apply changes
RefactoringFile(QTextDocument *document, const QString &fileName);
RefactoringFile(TextEditorWidget *editor);
RefactoringFile(const QString &fileName, const QSharedPointer<RefactoringChangesData> &data);
QTextDocument *mutableDocument() const;
// derived classes may want to clear language specific extra data
virtual void fileChanged();
void indentOrReindent(void (RefactoringChangesData::*mf)(const QTextCursor &,
const QString &,
const TextDocument *) const,
const RefactoringSelections &ranges);
protected:
QString m_fileName;
QSharedPointer<RefactoringChangesData> m_data;
mutable Utils::TextFileFormat m_textFileFormat;
mutable QTextDocument *m_document;
TextEditorWidget *m_editor;
Utils::ChangeSet m_changes;
QList<Range> m_indentRanges;
QList<Range> m_reindentRanges;
bool m_openEditor;
bool m_activateEditor;
int m_editorCursorPosition;
bool m_appliedOnce;
friend class RefactoringChanges; // access to constructor
};
/*!
This class batches changes to multiple file, which are applied as a single big
change.
*/
class TEXTEDITOR_EXPORT RefactoringChanges
{
public:
typedef Utils::ChangeSet::Range Range;
public:
RefactoringChanges();
virtual ~RefactoringChanges();
static RefactoringFilePtr file(TextEditorWidget *editor);
RefactoringFilePtr file(const QString &fileName) const;
bool createFile(const QString &fileName, const QString &contents, bool reindent = true, bool openEditor = true) const;
bool removeFile(const QString &fileName) const;
protected:
explicit RefactoringChanges(RefactoringChangesData *data);
static TextEditorWidget *openEditor(const QString &fileName, bool activate, int line, int column);
static RefactoringSelections rangesToSelections(QTextDocument *document, const QList<Range> &ranges);
protected:
QSharedPointer<RefactoringChangesData> m_data;
friend class RefactoringFile;
};
class TEXTEDITOR_EXPORT RefactoringChangesData
{
Q_DISABLE_COPY(RefactoringChangesData)
public:
RefactoringChangesData() {}
virtual ~RefactoringChangesData();
virtual void indentSelection(const QTextCursor &selection,
const QString &fileName,
const TextDocument *textEditor) const;
virtual void reindentSelection(const QTextCursor &selection,
const QString &fileName,
const TextDocument *textEditor) const;
virtual void fileChanged(const QString &fileName);
};
} // namespace TextEditor
#endif // REFACTORINGCHANGES_H
|
