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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
|
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the qt3to4 porting application of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/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 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.
**
** 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.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "tokenreplacements.h"
#include "logger.h"
#include "portingrules.h"
QT_BEGIN_NAMESPACE
using namespace TokenEngine;
void addLogSourceEntry(const QString &text, const TokenContainer &tokenContainer, const int index)
{
Logger *logger = Logger::instance();
int line = tokenContainer.line(index);
int col = tokenContainer.column(index);
SourcePointLogEntry *logEntry =
new SourcePointLogEntry(QLatin1String("Info"), QLatin1String("Porting"),
logger->globalState.value(QLatin1String("currentFileName")),
line, col, text);
logger->addEntry(logEntry);
}
void addLogWarning(const QString &text)
{
Logger::instance()->addEntry(new PlainLogEntry(QLatin1String("Warning"), QLatin1String("Porting"), text));
}
QualifiedNameParser::QualifiedNameParser(const TokenContainer &tokenContainer, const int tokenIndex)
:tokenContainer(tokenContainer)
,currentIndex(tokenIndex)
{
Q_ASSERT(isValidIndex(currentIndex));
}
bool QualifiedNameParser::isPartOfQualifiedName()
{
return ((nextScopeToken(Left) != -1) || (nextScopeToken(Right) != -1));
}
bool QualifiedNameParser::isValidIndex(int index)
{
return (index < tokenContainer.count() && index >= 0);
}
/*
A qualifier is a the leftmost or middle part of a qualified name
*/
bool QualifiedNameParser::isQualifier()
{
return (nextScopeToken(Right) != -1);
}
/*
A name is a the rightmost part of a qualified name.
*/
bool QualifiedNameParser::isName()
{
return (nextScopeToken(Left) != -1);
}
/*
Peek for a qualifier or name in the given direction
*/
int QualifiedNameParser::peek(Direction direction)
{
return nextScopeToken(direction);
}
/*
Look for a qualifier or name in the given direction,update
current position if found.
*/
int QualifiedNameParser::move(Direction direction)
{
int tokenIndex = nextScopeToken(direction);
if(tokenIndex != -1)
currentIndex = tokenIndex;
return tokenIndex;
}
/*
Looks for "::" starting at currentIndex, returns the token index
for it if found. If the first non-whitespace token found is something else,
-1 is returned.
*/
int QualifiedNameParser::findScopeOperator(Direction direction)
{
int tokenIndex = currentIndex;
QByteArray tokenText;
//loop until we get a token containing text or we pass the beginning/end of the source
tokenIndex += direction;
while(tokenText.isEmpty() && isValidIndex(tokenIndex)) {
tokenText = tokenContainer.text(tokenIndex).trimmed();
if(tokenText==QByteArray("::"))
return tokenIndex;
tokenIndex += direction;
}
return -1;
}
/*
Walks a qualified name. Returns the token index
for the next identifer in the qualified name, or -1 if its not found.
*/
int QualifiedNameParser::nextScopeToken(Direction direction)
{
int tokenIndex = findScopeOperator(direction);
if (tokenIndex == -1)
return -1;
QByteArray tokenText;
//loop until we get a token containing text or we pass the start of the source
tokenIndex += direction;
while(tokenText.isEmpty() && isValidIndex(tokenIndex)) {
tokenText = tokenContainer.text(tokenIndex).trimmed();
tokenIndex += direction;
}
return tokenIndex - direction;
}
/////////////////////
GenericTokenReplacement::GenericTokenReplacement(QByteArray oldToken, QByteArray newToken)
:oldToken(oldToken)
,newToken(newToken)
{}
QByteArray GenericTokenReplacement::getReplaceKey()
{
return QByteArray(oldToken);
}
bool GenericTokenReplacement::doReplace(const TokenContainer &tokenContainer,
int index, TextReplacements &textReplacements)
{
QByteArray tokenText = tokenContainer.text(index);
if(tokenText == oldToken){
addLogSourceEntry(QString::fromLatin1(tokenText + QByteArray(" -> ") + newToken), tokenContainer, index);
TokenEngine::Token token = tokenContainer.token(index);
textReplacements.insert(newToken, token.start, token.length);
return true;
}
return false;
}
///////////////////
ClassNameReplacement::ClassNameReplacement(QByteArray oldToken, QByteArray newToken)
:oldToken(oldToken)
,newToken(newToken)
{}
QByteArray ClassNameReplacement::getReplaceKey()
{
return QByteArray(oldToken);
}
/*
Replace a class name token. If the class name is a scope specifier (a "qualifier")
in a qualified name, we check if qualified name will be replaced by a porting rule.
If so, we don't do the class name replacement.
*/
bool ClassNameReplacement::doReplace(const TokenContainer &tokenContainer, int index, TextReplacements &textReplacements)
{
QByteArray tokenText = tokenContainer.text(index);
if(tokenText != oldToken)
return false;
QualifiedNameParser nameParser(tokenContainer, index);
if(nameParser.isPartOfQualifiedName() &&
nameParser.peek(QualifiedNameParser::Right) != -1) {
int nameTokenIndex = nameParser.peek(QualifiedNameParser::Right);
QByteArray name = tokenContainer.text(nameTokenIndex);
TextReplacements textReplacements;
QList<TokenReplacement*> tokenReplacements
= PortingRules::instance()->getTokenReplacementRules();
bool changed = false;
foreach(TokenReplacement *tokenReplacement, tokenReplacements) {
changed = tokenReplacement->doReplace(tokenContainer, nameTokenIndex, textReplacements);
if(changed)
break;
}
if(changed)
return false;
}
addLogSourceEntry(QString::fromLatin1(tokenText + QByteArray(" -> ") + newToken), tokenContainer, index);
TokenEngine::Token token = tokenContainer.token(index);
textReplacements.insert(newToken, token.start, token.length);
return true;
}
///////////////////
ScopedTokenReplacement::ScopedTokenReplacement(const QByteArray &oldToken,
const QByteArray &newToken)
:newScopedName(newToken)
{
Q_ASSERT(oldToken.contains(QByteArray("::")));
// Split oldToken into scope and name parts.
oldName = oldToken.mid(oldToken.lastIndexOf(':')+1);
oldScope = oldToken.mid(0, oldToken.indexOf(':'));
// Split newToken into scope and name parts, execept if we have a spcial
// case like Qt::WType_Modal -> (Qt::WType_Dialog | Qt::WShowModal)
if (newToken.count(QByteArray("::")) != 1 || newToken.contains(QByteArray("("))) {
newName = newToken;
} else {
newName = newToken.mid(newToken.lastIndexOf(':')+1);
newScope = newToken.mid(0, newToken.indexOf(':'));
}
strictMode = Logger::instance()->globalState.contains(QString::fromLatin1("strictMode"));
}
bool ScopedTokenReplacement::doReplace(const TokenContainer &tokenContainer, int sourceIndex, TextReplacements &textReplacements)
{
const QByteArray sourceName = tokenContainer.text(sourceIndex);
// Check if the token texts matches.
if (sourceName != oldName)
return false;
// Get token attributes. The attributes are created by the the C++ parser/analyzer.
const TokenAttributes *attributes = tokenContainer.tokenAttributes();
// If the declaration attribute is set we don't replace.
if (!attributes->attribute(sourceIndex, "declaration").isEmpty())
return false;
// If the unknown (undeclared) attribute is set we don't replace.
if (!attributes->attribute(sourceIndex, "unknown").isEmpty())
return false;
// If nameUse is set we test if the nameUse refers to the correct declaration.
// This is done by checking the parentScope attribute, which returns the scope
// for the declaration associated with this name use.
const bool haveNameUseInfo = !attributes->attribute(sourceIndex, "nameUse").isEmpty();
if (haveNameUseInfo) {
if (attributes->attribute(sourceIndex, "parentScope") != oldScope)
return false;
// If the user has specified -strict, we don't replace tokens when we don't have name use info.
} else if (strictMode) {
return false;
}
// The token might have a qualifier, and in that case we need to check if
// we should replace the qualifier as well.
QualifiedNameParser nameParser(tokenContainer, sourceIndex);
// This is a pretty special case, it means that in a qualified
// name like aaa::bbb the replacement rule has been triggered for
// the aaa part. Since this is not what we'd normally use a
// ScopedReplacement for, we just return here.
if (nameParser.isQualifier())
return false;
// If the token is unqualified, just replace it.
if (!nameParser.isPartOfQualifiedName()) {
// If we have no name use info we try to avoid replacements of
// e.g. Vertical with QSizePolicy::Vertically. Unqualified tokens
// can't happen for classes one does not usually inherit from, so
// we only let them pass for stuff that people usually inherited from.
if (!haveNameUseInfo && newScope != "Qt" && newScope != "QFrame" && newScope != "QValidator")
return false;
const Token sourceToken = tokenContainer.token(sourceIndex);
addLogSourceEntry(QString::fromLatin1(sourceName + QByteArray(" -> ") + newScopedName), tokenContainer, sourceIndex);
textReplacements.insert(newScopedName, sourceToken.start, sourceName.size());
return true;
}
// Peek left for the qualifer token.
const int sourceScopeIndex = nameParser.peek(QualifiedNameParser::Left);
if (sourceScopeIndex == -1) {
return false;
}
const Token sourceNameToken = tokenContainer.token(sourceIndex);
const Token sourceScopeToken = tokenContainer.token(sourceScopeIndex);
const QByteArray sourceScope = tokenContainer.text(sourceScopeIndex);
// If we have no name use info and the source and old scopes don't match,
// we generally don't do a replace, unless the old scope is Qt and
// the source scope inherits Qt. For example, QWidget::ButtonState should
// be renamed to Qt::ButtonState.
if (!haveNameUseInfo && sourceScope != oldScope) {
if (oldScope != "Qt")
return false;
// Check if sourceScope inherits the Qt class.
if (!PortingRules::instance()->getInheritsQt().contains(QString::fromLatin1(sourceScope.constData()))) //TODO optimize: linear search
return false;
}
// Spcecial cases, such as QIODevice::Offset -> Q_LONGLONG
// or Qt::WType_Modal -> (Qt::WType_Dialog | Qt::WShowModal).
if (newScope.isEmpty()) {
addLogSourceEntry(QString::fromLatin1((sourceScope + QByteArray("::") + sourceName +
QByteArray(" -> ") + newScopedName).constData()), tokenContainer, sourceIndex);
const int qualiferLength = sourceNameToken.start - sourceScopeToken.start;
const int length = qualiferLength + sourceNameToken.length;
textReplacements.insert(newName, sourceScopeToken.start, length);
return true;
}
// If the old and new scopes are equal, we replace the name part only.
if (newScope == sourceScope) {
// If the names are equal, there is no need to do anything.
if (newName == sourceName)
return true;
addLogSourceEntry(QString::fromLatin1((sourceName + QByteArray(" -> ") + newName).constData()), tokenContainer, sourceIndex);
textReplacements.insert(newName, sourceNameToken.start, sourceNameToken.length);
return true;
}
// If the names are equal, replace scope only.
if (newName == sourceName) {
addLogSourceEntry(QString::fromLatin1((sourceScope + QByteArray(" -> ") + newScope).constData()), tokenContainer, sourceScopeIndex);
textReplacements.insert(newScope, sourceScopeToken.start, sourceScopeToken.length);
return true;
}
// Replace scope and name.
addLogSourceEntry(QString::fromLatin1((sourceScope + QByteArray("::") + sourceName +
QByteArray(" -> ") + newScopedName).constData()),
tokenContainer, sourceScopeIndex);
textReplacements.insert(newScope, sourceScopeToken.start, sourceScopeToken.length);
textReplacements.insert(newName, sourceNameToken.start, sourceNameToken.length);
return true;
}
QByteArray ScopedTokenReplacement::getReplaceKey()
{
return oldName;
}
QT_END_NAMESPACE
|