summaryrefslogtreecommitdiffstats
path: root/util/normalize
diff options
context:
space:
mode:
authorLars Knoll <lars.knoll@nokia.com>2009-03-23 10:18:55 +0100
committerSimon Hausmann <simon.hausmann@nokia.com>2009-03-23 10:18:55 +0100
commite5fcad302d86d316390c6b0f62759a067313e8a9 (patch)
treec2afbf6f1066b6ce261f14341cf6d310e5595bc1 /util/normalize
Long live Qt 4.5!
Diffstat (limited to 'util/normalize')
-rw-r--r--util/normalize/README16
-rw-r--r--util/normalize/main.cpp197
-rw-r--r--util/normalize/normalize.pro9
3 files changed, 222 insertions, 0 deletions
diff --git a/util/normalize/README b/util/normalize/README
new file mode 100644
index 0000000000..55c921025f
--- /dev/null
+++ b/util/normalize/README
@@ -0,0 +1,16 @@
+This tool greps through files for SIGNAL() or SLOT() macros and pipes the signals/slots
+through QMetaObject::normalizedSignature().
+
+Rationale: In connect statements, you'll get a micro-speed update when passing in normalized
+signatures for signals and slots.
+
+Run it without any arguments to see the command line parameters.
+
+Typical usage on Qt:
+
+# find all files with non-normalized signal/slot connections and p4 edit them
+normalize $QTDIR/src | xargs p4 edit
+# replace all non-normalized signal/slots
+normalize --modify $QTDIR/src
+# p4 diff to see that everything is OK then submit :)
+p4 submit $QTDIR/src/...
diff --git a/util/normalize/main.cpp b/util/normalize/main.cpp
new file mode 100644
index 0000000000..905c1ec9f9
--- /dev/null
+++ b/util/normalize/main.cpp
@@ -0,0 +1,197 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: Qt Software Information (qt-info@nokia.com)
+**
+** This file is part of the utils of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the either Technology Preview License Agreement or the
+** Beta Release License Agreement.
+**
+** 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, Nokia gives you certain
+** additional rights. These rights are described in the Nokia Qt LGPL
+** Exception version 1.0, 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.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at qt-sales@nokia.com.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+#include <qcoreapplication.h>
+#include <qdir.h>
+#include <qfile.h>
+#include <qmetaobject.h>
+#include <qstring.h>
+#include <qtextstream.h>
+
+#include <qdebug.h>
+
+#include <limits.h>
+#include <stdio.h>
+
+static bool printFilename = true;
+static bool modify = false;
+
+QString signature(const QString &line, int pos)
+{
+ int start = pos;
+ // find first open parentheses
+ while (start < line.length() && line.at(start) != QLatin1Char('('))
+ ++start;
+ int i = ++start;
+ int par = 1;
+ // find matching closing parentheses
+ while (i < line.length() && par > 0) {
+ if (line.at(i) == QLatin1Char('('))
+ ++par;
+ else if (line.at(i) == QLatin1Char(')'))
+ --par;
+ ++i;
+ }
+ if (par == 0)
+ return line.mid(start, i - start - 1);
+ return QString();
+}
+
+bool checkSignature(const QString &fileName, QString &line, const char *sig)
+{
+ static QStringList fileList;
+
+ int idx = -1;
+ bool found = false;
+ while ((idx = line.indexOf(sig, ++idx)) != -1) {
+ const QByteArray sl(signature(line, idx).toLocal8Bit());
+ 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 bline = file.readLine(16384);
+ if (bline.isEmpty())
+ break;
+ QString line = QString::fromLocal8Bit(bline);
+ Q_ASSERT_X(line.endsWith("\n"), "check()", fileName.toLocal8Bit().constData());
+ 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)
+{
+ QDir dir(path);
+ dir.setFilter(QDir::Dirs | QDir::Files | QDir::NoSymLinks);
+
+ const QFileInfoList list = dir.entryInfoList();
+ for (int i = 0; i < list.count(); ++i) {
+ const QFileInfo fi = list.at(i);
+ if (fi.fileName() == QLatin1String(".") || fi.fileName() == QLatin1String(".."))
+ continue;
+ if (fi.fileName().endsWith(".cpp"))
+ check(path + fi.fileName());
+ if (fi.isDir())
+ traverse(path + fi.fileName() + "/"); // recurse
+ }
+}
+
+int main(int argc, char *argv[])
+{
+ QCoreApplication app(argc, argv);
+
+ if (app.argc() < 2 || (app.argc() == 2 && (app.argv()[1][0] == '-'))) {
+ printf("usage: normalize [--modify] <path>\n");
+ printf(" <path> can be a single file or a directory (default: look for *.cpp recursively)");
+ printf(" Outputs all filenames that contain non-normalized SIGNALs and SLOTs\n");
+ printf(" with --modify: fix all occurences of non-normalized SIGNALs and SLOTs\n");
+ return 1;
+ }
+
+ QString path;
+ if (qstrcmp(app.argv()[1], "--modify") == 0) {
+ printFilename = false;
+ modify = true;
+ path = app.argv()[2];
+ } else {
+ path = app.argv()[1];
+ }
+
+ if (path.startsWith("-")) {
+ qWarning("unknown parameter: %s", path.toLocal8Bit().constData());
+ return 1;
+ }
+
+ 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;
+}
diff --git a/util/normalize/normalize.pro b/util/normalize/normalize.pro
new file mode 100644
index 0000000000..cff3f05f63
--- /dev/null
+++ b/util/normalize/normalize.pro
@@ -0,0 +1,9 @@
+TEMPLATE = app
+CONFIG -= moc
+
+# Input
+SOURCES += main.cpp
+
+QT = core
+CONFIG += warn_on console
+mac:CONFIG -= app_bundle