prowriter.cpp 16 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2
3
4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
Eike Ziller's avatar
Eike Ziller committed
7
** Contact: http://www.qt-project.org/
con's avatar
con committed
8
**
9
**
10
** GNU Lesser General Public License Usage
11
**
hjk's avatar
hjk committed
12
13
14
15
16
17
** 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.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21
22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23
24
25
26
27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
**
29
**************************************************************************/
con's avatar
con committed
30
31
32
33

#include "proitems.h"
#include "prowriter.h"

34
35
#include <QDir>
#include <QPair>
36

con's avatar
con committed
37
38
using namespace Qt4ProjectManager::Internal;

39
40
41
42
43
44
45
static uint getBlockLen(const ushort *&tokPtr)
{
    uint len = *tokPtr++;
    len |= (uint)*tokPtr++ << 16;
    return len;
}

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
46
static bool getLiteral(const ushort *tokPtr, const ushort *tokEnd, QString &tmp)
47
{
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
    int count = 0;
    while (tokPtr != tokEnd) {
        ushort tok = *tokPtr++;
        switch (tok & TokMask) {
        case TokLine:
            tokPtr++;
            break;
        case TokHashLiteral:
            tokPtr += 2;
            // fallthrough
        case TokLiteral: {
            uint len = *tokPtr++;
            tmp.setRawData((const QChar *)tokPtr, len);
            count++;
            tokPtr += len;
            break; }
        default:
            return false;
        }
    }
    return count == 1;
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
}

static void skipStr(const ushort *&tokPtr)
{
    uint len = *tokPtr++;
    tokPtr += len;
}

static void skipHashStr(const ushort *&tokPtr)
{
    tokPtr += 2;
    uint len = *tokPtr++;
    tokPtr += len;
}

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
84
static void skipBlock(const ushort *&tokPtr)
85
86
87
88
89
{
    uint len = getBlockLen(tokPtr);
    tokPtr += len;
}

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
90
static void skipExpression(const ushort *&pTokPtr, int &lineNo)
91
{
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
    const ushort *tokPtr = pTokPtr;
    forever {
        ushort tok = *tokPtr++;
        switch (tok) {
        case TokLine:
            lineNo = *tokPtr++;
            break;
        case TokValueTerminator:
        case TokFuncTerminator:
            pTokPtr = tokPtr;
            return;
        case TokArgSeparator:
            break;
        default:
            switch (tok & TokMask) {
            case TokLiteral:
            case TokEnvVar:
                skipStr(tokPtr);
                break;
            case TokHashLiteral:
            case TokVariable:
113
            case TokProperty:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
114
115
116
117
118
119
120
121
122
123
124
125
126
127
                skipHashStr(tokPtr);
                break;
            case TokFuncName:
                skipHashStr(tokPtr);
                pTokPtr = tokPtr;
                skipExpression(pTokPtr, lineNo);
                tokPtr = pTokPtr;
                break;
            default:
                pTokPtr = tokPtr - 1;
                return;
            }
        }
    }
128
129
}

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
130
static const ushort *skipToken(ushort tok, const ushort *&tokPtr, int &lineNo)
131
132
133
134
135
136
137
138
139
140
{
    switch (tok) {
    case TokLine:
        lineNo = *tokPtr++;
        break;
    case TokAssign:
    case TokAppend:
    case TokAppendUnique:
    case TokRemove:
    case TokReplace:
141
142
        tokPtr++;
        // fallthrough
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
143
144
    case TokTestCall:
        skipExpression(tokPtr, lineNo);
145
146
147
        break;
    case TokForLoop:
        skipHashStr(tokPtr);
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
148
149
150
        // fallthrough
    case TokBranch:
        skipBlock(tokPtr);
151
152
153
154
155
156
157
158
159
160
161
        skipBlock(tokPtr);
        break;
    case TokTestDef:
    case TokReplaceDef:
        skipHashStr(tokPtr);
        skipBlock(tokPtr);
        break;
    case TokNot:
    case TokAnd:
    case TokOr:
    case TokCondition:
162
163
164
    case TokReturn:
    case TokNext:
    case TokBreak:
165
        break;
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
166
167
168
169
170
171
172
    default: {
            const ushort *oTokPtr = --tokPtr;
            skipExpression(tokPtr, lineNo);
            if (tokPtr != oTokPtr)
                return oTokPtr;
        }
        Q_ASSERT_X(false, "skipToken", "unexpected item type");
173
    }
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
174
    return 0;
175
176
}

177
178
bool ProWriter::locateVarValues(const ushort *tokPtr,
    const QString &scope, const QString &var, int *scopeStart, int *bestLine)
con's avatar
con committed
179
{
180
181
    const bool inScope = scope.isEmpty();
    int lineNo = *scopeStart + 1;
182
    QString tmp;
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
183
    const ushort *lastXpr = 0;
184
    bool fresh = true;
185
    while (ushort tok = *tokPtr++) {
186
        if (inScope && (tok == TokAssign || tok == TokAppend || tok == TokAppendUnique)) {
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
187
            if (getLiteral(lastXpr, tokPtr - 1, tmp) && var == tmp) {
188
189
                *bestLine = lineNo - 1;
                return true;
190
            }
191
            skipExpression(++tokPtr, lineNo);
192
            fresh = true;
193
        } else {
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
            if (!inScope && tok == TokCondition && *tokPtr == TokBranch
                && getLiteral(lastXpr, tokPtr - 1, tmp) && scope == tmp) {
                *scopeStart = lineNo - 1;
                if (locateVarValues(tokPtr + 3, QString(), var, scopeStart, bestLine))
                    return true;
            }
            const ushort *oTokPtr = skipToken(tok, tokPtr, lineNo);
            if (tok != TokLine) {
                if (oTokPtr) {
                    if (fresh)
                        lastXpr = oTokPtr;
                } else if (tok == TokNot || tok == TokAnd || tok == TokOr) {
                    fresh = false;
                } else {
                    fresh = true;
                }
            }
211
        }
con's avatar
con committed
212
    }
213
214
    return false;
}
con's avatar
con committed
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
static int skipContLines(QStringList *lines, int lineNo, bool addCont)
{
    for (; lineNo < lines->count(); lineNo++) {
        QString line = lines->at(lineNo);
        int idx = line.indexOf(QLatin1Char('#'));
        if (idx >= 0)
            line.truncate(idx);
        while (line.endsWith(QLatin1Char(' ')) || line.endsWith(QLatin1Char('\t')))
            line.chop(1);
        if (line.isEmpty()) {
            if (idx >= 0)
                continue;
            break;
        }
        if (!line.endsWith(QLatin1Char('\\'))) {
            if (addCont)
                (*lines)[lineNo].insert(line.length(), QLatin1String(" \\"));
            lineNo++;
            break;
        }
    }
    return lineNo;
}

void ProWriter::putVarValues(ProFile *profile, QStringList *lines,
241
    const QStringList &values, const QString &var, PutFlags flags, const QString &scope)
242
{
243
244
245
    QString indent = scope.isEmpty() ? QString() : QLatin1String("    ");
    int scopeStart = -1, lineNo;
    if (locateVarValues(profile->tokPtr(), scope, var, &scopeStart, &lineNo)) {
246
247
248
249
250
251
252
253
254
255
256
        if (flags & ReplaceValues) {
            // remove continuation lines with old values
            int lNo = skipContLines(lines, lineNo, false);
            lines->erase(lines->begin() + lineNo + 1, lines->begin() + lNo);
            // remove rest of the line
            QString &line = (*lines)[lineNo];
            int eqs = line.indexOf(QLatin1Char('='));
            if (eqs >= 0) // If this is not true, we mess up the file a bit.
                line.truncate(eqs + 1);
            // put new values
            foreach (const QString &v, values)
257
                line += ((flags & MultiLine) ? QLatin1String(" \\\n    ") + indent : QString::fromLatin1(" ")) + v;
258
259
260
261
        } else {
            lineNo = skipContLines(lines, lineNo, true);
            QString added;
            foreach (const QString &v, values)
262
                added += QLatin1String("    ") + indent + v + QLatin1String(" \\\n");
263
264
265
266
267
268
            added.chop(3);
            lines->insert(lineNo, added);
        }
    } else {
        // Create & append new variable item
        QString added;
269
        int lNo = lines->count();
270
271
272
273
        if (!scope.isEmpty()) {
            if (scopeStart < 0) {
                added = QLatin1Char('\n') + scope + QLatin1String(" {");
            } else {
274
                QRegExp rx(QLatin1String("(\\s*") + scope + QLatin1String("\\s*:\\s*)[^\\s{].*"));
275
276
277
                if (rx.exactMatch(lines->at(scopeStart))) {
                    (*lines)[scopeStart].replace(0, rx.cap(1).length(),
                                                 QString(scope + QLatin1String(" {\n    ")));
278
                    lNo = skipContLines(lines, scopeStart, false);
279
280
281
282
                    scopeStart = -1;
                }
            }
        }
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
        if (scopeStart >= 0) {
            lNo = scopeStart;
            int braces = 0;
            do {
                const QString &line = (*lines).at(lNo);
                for (int i = 0; i < line.size(); i++)
                    // This is pretty sick, but qmake does pretty much the same ...
                    if (line.at(i) == QLatin1Char('{')) {
                        ++braces;
                    } else if (line.at(i) == QLatin1Char('}')) {
                        if (!--braces)
                            break;
                    } else if (line.at(i) == QLatin1Char('#')) {
                        break;
                    }
            } while (braces && ++lNo < lines->size());
        }
        for (; lNo > scopeStart + 1 && lines->at(lNo - 1).isEmpty(); lNo--) ;
301
        if (lNo != scopeStart + 1)
302
            added += QLatin1Char('\n');
303
        added += indent + var + QLatin1String((flags & AppendOperator) ? " +=" : " =");
304
        foreach (const QString &v, values)
305
306
307
            added += ((flags & MultiLine) ? QLatin1String(" \\\n    ") + indent : QString::fromLatin1(" ")) + v;
        if (!scope.isEmpty() && scopeStart < 0)
            added += QLatin1String("\n}");
308
309
        lines->insert(lNo, added);
    }
con's avatar
con committed
310
311
}

312
313
314
315
316
317
318
void ProWriter::addFiles(ProFile *profile, QStringList *lines,
    const QDir &proFileDir, const QStringList &values, const QString &var)
{
    QStringList valuesToWrite;
    foreach (const QString &v, values)
        valuesToWrite << proFileDir.relativeFilePath(v);

319
    putVarValues(profile, lines, valuesToWrite, var, AppendValues | MultiLine | AppendOperator);
320
321
}

322
static void findProVariables(const ushort *tokPtr, const QStringList &vars,
323
                             QList<int> *proVars, const uint firstLine = 0)
con's avatar
con committed
324
{
325
    int lineNo = firstLine;
326
    QString tmp;
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
327
    const ushort *lastXpr = 0;
328
329
330
    while (ushort tok = *tokPtr++) {
        if (tok == TokBranch) {
            uint blockLen = getBlockLen(tokPtr);
331
332
333
334
            if (blockLen) {
                findProVariables(tokPtr, vars, proVars, lineNo);
                tokPtr += blockLen;
            }
335
            blockLen = getBlockLen(tokPtr);
336
337
338
339
            if (blockLen) {
                findProVariables(tokPtr, vars, proVars, lineNo);
                tokPtr += blockLen;
            }
340
        } else if (tok == TokAssign || tok == TokAppend || tok == TokAppendUnique) {
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
341
            if (getLiteral(lastXpr, tokPtr - 1, tmp) && vars.contains(tmp))
342
                *proVars << lineNo;
343
            skipExpression(++tokPtr, lineNo);
344
        } else {
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
345
            lastXpr = skipToken(tok, tokPtr, lineNo);
con's avatar
con committed
346
347
348
349
        }
    }
}

350
351
QList<int> ProWriter::removeVarValues(ProFile *profile, QStringList *lines,
    const QStringList &values, const QStringList &vars)
con's avatar
con committed
352
{
353
354
355
356
    QList<int> notChanged;
    // yeah, this is a bit silly
    for (int i = 0; i < values.size(); i++)
        notChanged << i;
357

358
    QList<int> varLines;
359
    findProVariables(profile->tokPtr(), vars, &varLines);
360
361
362

    // This code expects proVars to be sorted by the variables' appearance in the file.
    int delta = 1;
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
    foreach (int ln, varLines) {
       bool first = true;
       int lineNo = ln - delta;
       typedef QPair<int, int> ContPos;
       QList<ContPos> contPos;
       while (lineNo < lines->count()) {
           QString &line = (*lines)[lineNo];
           int lineLen = line.length();
           bool killed = false;
           bool saved = false;
           int idx = line.indexOf(QLatin1Char('#'));
           if (idx >= 0)
               lineLen = idx;
           QChar *chars = line.data();
           forever {
               if (!lineLen) {
                   if (idx >= 0)
                       goto nextLine;
                   goto nextVar;
               }
               QChar c = chars[lineLen - 1];
               if (c != QLatin1Char(' ') && c != QLatin1Char('\t'))
                   break;
               lineLen--;
           }
           {
               int contCol = -1;
               if (chars[lineLen - 1] == QLatin1Char('\\'))
                   contCol = --lineLen;
               int colNo = 0;
               if (first) {
                   colNo = line.indexOf(QLatin1Char('=')) + 1;
                   first = false;
                   saved = true;
               }
               while (colNo < lineLen) {
                   QChar c = chars[colNo];
                   if (c == QLatin1Char(' ') || c == QLatin1Char('\t')) {
                       colNo++;
                       continue;
                   }
                   int varCol = colNo;
                   while (colNo < lineLen) {
                       QChar c = chars[colNo];
                       if (c == QLatin1Char(' ') || c == QLatin1Char('\t'))
                           break;
                       colNo++;
                   }
411
                   const QString fn = line.mid(varCol, colNo - varCol);
412
                   const int pos = values.indexOf(fn);
413
                   if (pos != -1) {
414
                       notChanged.removeOne(pos);
415
416
417
418
419
420
421
422
423
424
425
426
                       if (colNo < lineLen)
                           colNo++;
                       else if (varCol)
                           varCol--;
                       int len = colNo - varCol;
                       colNo = varCol;
                       line.remove(varCol, len);
                       lineLen -= len;
                       contCol -= len;
                       idx -= len;
                       if (idx >= 0)
                           line.insert(idx, QLatin1String("# ") + fn + QLatin1Char(' '));
427
                       chars = line.data();
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
                       killed = true;
                   } else {
                       saved = true;
                   }
               }
               if (saved) {
                   // Entries remained
                   contPos.clear();
               } else if (killed) {
                   // Entries existed, but were all removed
                   if (contCol < 0) {
                       // This is the last line, so clear continuations leading to it
                       foreach (const ContPos &pos, contPos) {
                           QString &bline = (*lines)[pos.first];
                           bline.remove(pos.second, 1);
                           if (pos.second == bline.length())
                               while (bline.endsWith(QLatin1Char(' '))
                                      || bline.endsWith(QLatin1Char('\t')))
                                   bline.chop(1);
                       }
                       contPos.clear();
                   }
                   if (idx < 0) {
                       // Not even a comment stayed behind, so zap the line
                       lines->removeAt(lineNo);
                       delta++;
                       continue;
                   }
               }
               if (contCol >= 0)
                   contPos.append(qMakePair(lineNo, contCol));
           }
         nextLine:
           lineNo++;
       }
     nextVar: ;
con's avatar
con committed
464
    }
465
    return notChanged;
con's avatar
con committed
466
}
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481

QStringList ProWriter::removeFiles(ProFile *profile, QStringList *lines,
    const QDir &proFileDir, const QStringList &values, const QStringList &vars)
{
    // This is a tad stupid - basically, it can remove only entries which
    // the above code added.
    QStringList valuesToFind;
    foreach (const QString &absoluteFilePath, values)
        valuesToFind << proFileDir.relativeFilePath(absoluteFilePath);

    QStringList notChanged;
    foreach (int i, removeVarValues(profile, lines, valuesToFind, vars))
        notChanged.append(values.at(i));
    return notChanged;
}