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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
// Copyright (C) 2018 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0+ OR GPL-3.0 WITH Qt-GPL-exception-1.0
#include "clangfixitsrefactoringchanges.h"
#include <coreplugin/editormanager/editormanager.h>
#include <cppeditor/cppcodestylesettings.h>
#include <cppeditor/cppeditorconstants.h>
#include <cppeditor/cppmodelmanager.h>
#include <texteditor/icodestylepreferencesfactory.h>
#include <texteditor/indenter.h>
#include <texteditor/tabsettings.h>
#include <texteditor/texteditorsettings.h>
#include <QDebug>
#include <QLoggingCategory>
#include <QTextBlock>
#include <QTextCursor>
#include <utils/filepath.h>
#include <utils/qtcassert.h>
#include <algorithm>
static Q_LOGGING_CATEGORY(fixitsLog, "qtc.clangtools.fixits", QtWarningMsg);
using namespace TextEditor;
using namespace Utils;
namespace ClangTools {
namespace Internal {
int FixitsRefactoringFile::position(const QString &filePath, unsigned line, unsigned column) const
{
QTC_ASSERT(line != 0, return -1);
QTC_ASSERT(column != 0, return -1);
return document(filePath)->findBlockByNumber(line - 1).position() + column - 1;
}
static QDebug operator<<(QDebug debug, const ReplacementOperation &op)
{
debug.nospace() << "ReplacementOperation("
<< op.pos << ", "
<< op.length << ", "
<< op.text << ", "
<< op.apply
<< ")"
;
return debug;
}
bool FixitsRefactoringFile::apply()
{
if (m_replacementOperations.isEmpty())
return false; // Error nothing to apply TODO: Is this correct to return?
ICodeStylePreferencesFactory *factory = TextEditorSettings::codeStyleFactory(
CppEditor::Constants::CPP_SETTINGS_ID);
QHash<FilePath, QPair<ReplacementOperations, int>> operationsByFile;
for (int i = 0; i < m_replacementOperations.size(); ++i) {
ReplacementOperation &op = *m_replacementOperations[i];
if (!op.apply)
continue;
const FilePath filePath = FilePath::fromString(op.fileName);
// Check for permissions
if (!filePath.isWritableFile())
return false;
qCDebug(fixitsLog) << " " << i << "Applying" << op;
// Shift subsequent operations that are affected
shiftAffectedReplacements(op, i + 1);
// Apply
QTextDocument * const doc = document(op.fileName);
QTextCursor cursor(doc);
cursor.setPosition(op.pos);
cursor.setPosition(op.pos + op.length, QTextCursor::KeepAnchor);
cursor.insertText(op.text);
auto &opsForFile = operationsByFile[filePath];
opsForFile.first.push_back(&op);
opsForFile.second = i;
}
// Format
for (auto it = operationsByFile.cbegin(); it != operationsByFile.cend(); ++it) {
QTextDocument * const doc = document(it.key().toString());
const std::unique_ptr<TextEditor::Indenter> indenter(factory->createIndenter(doc));
if (!indenter)
continue;
indenter->setFileName(it.key());
format(*indenter, doc, it.value().first, it.value().second);
}
// Write file
if (!m_textFileFormat.codec)
return false; // Error reading file
QString error;
for (auto it = m_documents.begin(); it != m_documents.end(); ++it) {
if (!m_textFileFormat.writeFile(FilePath::fromString(it.key()),
it.value()->toPlainText(),
&error)) {
qCDebug(fixitsLog) << "ERROR: Could not write file" << it.key() << ":" << error;
return false; // Error writing file
}
}
return true;
}
void FixitsRefactoringFile::format(TextEditor::Indenter &indenter,
QTextDocument *doc,
const ReplacementOperations &operationsForFile,
int firstOperationIndex)
{
if (operationsForFile.isEmpty())
return;
TextEditor::RangesInLines ranges;
for (int i = 0; i < operationsForFile.size(); ++i) {
const ReplacementOperation &op = *operationsForFile.at(i);
const int start = doc->findBlock(op.pos).blockNumber() + 1;
const int end = doc->findBlock(op.pos + op.length).blockNumber() + 1;
ranges.push_back({start, end});
}
const Text::Replacements replacements = indenter.format(ranges);
if (replacements.empty())
return;
shiftAffectedReplacements(operationsForFile.front()->fileName,
replacements,
firstOperationIndex + 1);
}
QTextDocument *FixitsRefactoringFile::document(const QString &filePath) const
{
if (m_documents.find(filePath) == m_documents.end()) {
QString fileContents;
if (!filePath.isEmpty()) {
QString error;
QTextCodec *defaultCodec = Core::EditorManager::defaultTextCodec();
TextFileFormat::ReadResult result = TextFileFormat::readFile(FilePath::fromString(
filePath),
defaultCodec,
&fileContents,
&m_textFileFormat,
&error);
if (result != TextFileFormat::ReadSuccess) {
qCDebug(fixitsLog) << "ERROR: Could not read " << filePath << ":" << error;
m_textFileFormat.codec = nullptr;
}
}
// always make a QTextDocument to avoid excessive null checks
m_documents[filePath] = new QTextDocument(fileContents);
}
return m_documents[filePath];
}
void FixitsRefactoringFile::shiftAffectedReplacements(const ReplacementOperation &op, int startIndex)
{
for (int i = startIndex; i < m_replacementOperations.size(); ++i) {
ReplacementOperation ¤t = *m_replacementOperations[i];
if (op.fileName != current.fileName)
continue;
ReplacementOperation before = current;
if (op.pos <= current.pos)
current.pos += op.text.size();
if (op.pos < current.pos)
current.pos -= op.length;
qCDebug(fixitsLog) << " shift:" << i << before << " ====> " << current;
}
}
bool FixitsRefactoringFile::hasIntersection(const QString &fileName,
const Text::Replacements &replacements,
int startIndex) const
{
for (int i = startIndex; i < m_replacementOperations.size(); ++i) {
const ReplacementOperation ¤t = *m_replacementOperations[i];
if (fileName != current.fileName)
continue;
// Usually the number of replacements is from 1 to 3.
if (std::any_of(replacements.begin(),
replacements.end(),
[¤t](const Text::Replacement &replacement) {
return replacement.offset + replacement.length > current.pos
&& replacement.offset < current.pos + current.length;
})) {
return true;
}
}
return false;
}
void FixitsRefactoringFile::shiftAffectedReplacements(const QString &fileName,
const Text::Replacements &replacements,
int startIndex)
{
for (int i = startIndex; i < m_replacementOperations.size(); ++i) {
ReplacementOperation ¤t = *m_replacementOperations[i];
if (fileName != current.fileName)
continue;
for (const auto &replacement : replacements) {
if (replacement.offset > current.pos)
break;
current.pos += replacement.text.size() - replacement.length;
}
}
}
} // namespace Internal
} // namespace ClangTools
|
