summaryrefslogtreecommitdiffstats
path: root/util/normalize/main.cpp
blob: 659f5b68102877624858a474317eab111585dc99 (plain)
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
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

#include <qcoreapplication.h>
#include <qdiriterator.h>
#include <qfile.h>
#include <qmetaobject.h>
#include <qstring.h>
#include <qtextstream.h>
#include <qcommandlineparser.h>

#include <qdebug.h>

#include <limits.h>
#include <stdio.h>

static bool printFilename = true;
static bool modify = false;

static QByteArray signature(const QByteArray &line, int pos)
{
    int start = pos;
    // find first open parentheses
    while (start < line.length() && line.at(start) != '(')
        ++start;
    int i = ++start;
    int par = 1;
    // find matching closing parentheses
    while (i < line.length() && par > 0) {
        if (line.at(i) == '(')
            ++par;
        else if (line.at(i) == ')')
            --par;
        ++i;
    }
    if (par == 0)
        return line.mid(start, i - start - 1);
    return QByteArray();
}

static bool isValidIdentifierChar(char c)
{
    return c == '_' || QChar::isLetterOrNumber(uchar(c));
}

static bool checkSignature(const QString &fileName, QByteArray &line, const char *sig)
{
    static QStringList fileList;

    const int siglen = strlen(sig);
    int idx = -1;
    bool found = false;
    while ((idx = line.indexOf(sig, ++idx)) != -1) {
        if (idx > 0 && isValidIdentifierChar(line.at(idx - 1)))
            continue;
        int endIdx = idx + siglen;
        if (endIdx < line.length() && isValidIdentifierChar(line.at(endIdx)))
            continue;
        const QByteArray sl = signature(line, idx);
        QByteArray nsl(QMetaObject::normalizedSignature(sl.constData()));
        if (sl != nsl) {
            found = true;
            if (printFilename && !fileList.contains(fileName)) {
                fileList.prepend(fileName);
                printf("%s\n", fileName.toLocal8Bit().constData());
            }
            if (modify)
                line.replace(sl, nsl);
            //qDebug("expected '%s', got '%s'", nsl.data(), sl.data());
        }
    }
    return found;
}

void writeChanges(const QString &fileName, const QStringList &lines)
{
    QFile file(fileName);
    if (!file.open(QIODevice::WriteOnly)) {
        qDebug("unable to open file '%s' for writing (%s)", fileName.toLocal8Bit().constData(), file.errorString().toLocal8Bit().constData());
        return;
    }
    QTextStream stream(&file);
    for (int i = 0; i < lines.count(); ++i)
        stream << lines.at(i);
    file.close();
}

void check(const QString &fileName)
{
    QFile file(fileName);
    if (!file.open(QIODevice::ReadOnly)) {
        qDebug("unable to open file: '%s' (%s)", fileName.toLocal8Bit().constData(), file.errorString().toLocal8Bit().constData());
        return;
    }
    QStringList lines;
    bool found = false;
    while (true) {
        QByteArray line = file.readLine();
        if (line.isEmpty())
            break;
        found |= checkSignature(fileName, line, "SLOT");
        found |= checkSignature(fileName, line, "SIGNAL");
        if (modify)
            lines << line;
    }
    file.close();

    if (found && modify) {
        printf("Modifying file: '%s'\n", fileName.toLocal8Bit().constData());
        writeChanges(fileName, lines);
    }
}

void traverse(const QString &path)
{
    auto needsChecking = [] (QStringView path) {
        // list of file extensions that
        constexpr char extensions[][5] = {
            // C++ impl files:
            "C", // will also match .c (because we're matching case-insensitively, but ¯\_(ツ)_/¯
            "cpp",
            "cxx",
            "c++",
            // header files:
            "h",
            "hpp",
            "hxx",
            // Obj-C++ impl:
            "mm",
            // Parser generators:
            "g",
            // documentation may also include SIGNAL/SLOT macros:
            "qdoc",
        };

        // treat .in files like the underlying file
        if (path.endsWith(QLatin1StringView{".in"}, Qt::CaseInsensitive))
            path = path.chopped(3);

        for (const char *extension : extensions) {
            const QLatin1StringView ext{extension};
            if (path.endsWith(ext, Qt::CaseInsensitive) &&
                path.chopped(ext.size()).endsWith(u'.'))
            {
                return true;
            }
        }
        return false;
    };

    QDirIterator dirIterator(path, QDir::NoDotAndDotDot | QDir::Dirs | QDir::Files | QDir::NoSymLinks);

    while (dirIterator.hasNext()) {
        QString filePath = dirIterator.next();
        if (needsChecking(filePath))
            check(filePath);
        else if (QFileInfo(filePath).isDir())
            traverse(filePath); // recurse
    }
}

int main(int argc, char *argv[])
{
    QCoreApplication app(argc, argv);

    QCommandLineParser parser;
    parser.setApplicationDescription(
            QStringLiteral("Qt Normalize tool (Qt %1)\nOutputs all filenames that contain non-normalized SIGNALs and SLOTs")
            .arg(QString::fromLatin1(QT_VERSION_STR)));
    parser.addHelpOption();
    parser.addVersionOption();

    QCommandLineOption modifyOption(QStringLiteral("modify"),
                                    QStringLiteral("Fix all occurrences of non-normalized SIGNALs and SLOTs."));
    parser.addOption(modifyOption);

    parser.addPositionalArgument(QStringLiteral("path"),
                                 QStringLiteral("can be a single file or a directory (in which case, look for file types that may contain SIGNALs and SLOTs recursively)"));

    parser.process(app);

    if (parser.positionalArguments().count() != 1)
        parser.showHelp(1);
    QString path = parser.positionalArguments().first();
    if (path == "-")
        parser.showHelp(1);

    if (parser.isSet(modifyOption)) {
        printFilename = false;
        modify = true;
    }

    QFileInfo fi(path);
    if (fi.isFile()) {
        check(path);
    } else if (fi.isDir()) {
        if (!path.endsWith("/"))
            path.append("/");
        traverse(path);
    } else {
        qWarning("Don't know what to do with '%s'", path.toLocal8Bit().constData());
        return 1;
    }

    return 0;
}