follow qt_tool.prf now setting up DESTDIR
[profile/ivi/qtdeclarative.git] / tools / qmlmin / main.cpp
index ef848f6..192a17a 100644 (file)
@@ -1,47 +1,47 @@
 /****************************************************************************
 **
-** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
-** All rights reserved.
-** Contact: Nokia Corporation (qt-info@nokia.com)
+** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
 **
-** This file is part of the QtDeclarative module of the Qt Toolkit.
+** This file is part of the QtQml module 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
-** 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.
+** 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
+** 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.
-**
-** 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.
-**
-**
-**
+** 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 "qdeclarativejsengine_p.h"
-#include "qdeclarativejslexer_p.h"
-#include "qdeclarativejsparser_p.h"
+#include <private/qqmljsengine_p.h>
+#include <private/qqmljslexer_p.h>
+#include <private/qqmljsparser_p.h>
 #include <QtCore/QCoreApplication>
 #include <QtCore/QStringList>
 #include <QtCore/QFile>
 #include <iostream>
 #include <cstdlib>
 
+QT_BEGIN_NAMESPACE
+
 //
 // QML/JS minifier
 //
-namespace QDeclarativeJS {
+namespace QQmlJS {
 
 enum RegExpFlag {
     Global     = 0x01,
@@ -61,10 +63,12 @@ enum RegExpFlag {
     Multiline  = 0x04
 };
 
-class QmlminLexer: protected Lexer
+
+class QmlminLexer: protected Lexer, public Directives
 {
-    QDeclarativeJS::Engine _engine;
+    QQmlJS::Engine _engine;
     QString _fileName;
+    QString _directives;
 
 public:
     QmlminLexer(): Lexer(&_engine) {}
@@ -80,15 +84,68 @@ public:
             startToken = T_FEED_UI_PROGRAM;
         setCode(code, /*line = */ 1, /*qmlMode = */ startToken == T_FEED_UI_PROGRAM);
         _fileName = fileName;
+        _directives.clear();
         return parse(startToken);
     }
 
+    QString directives()
+    {
+        return _directives;
+    }
+
+    //
+    // Handle the .pragma/.import directives
+    //
+    virtual void pragmaLibrary()
+    {
+        _directives += QLatin1String(".pragma library\n");
+    }
+
+    virtual void importFile(const QString &jsfile, const QString &module)
+    {
+        _directives += QLatin1String(".import");
+        _directives += QLatin1Char('"');
+        _directives += quote(jsfile);
+        _directives += QLatin1Char('"');
+        _directives += QLatin1String("as ");
+        _directives += module;
+        _directives += QLatin1Char('\n');
+    }
+
+    virtual void importModule(const QString &uri, const QString &version, const QString &module)
+    {
+        _directives += QLatin1String(".import ");
+        _directives += uri;
+        _directives += QLatin1Char(' ');
+        _directives += version;
+        _directives += QLatin1String(" as ");
+        _directives += module;
+        _directives += QLatin1Char('\n');
+    }
+
 protected:
     virtual bool parse(int startToken) = 0;
 
-    bool automatic(int token) const
+    static QString quote(const QString &string)
     {
-        return token == T_RBRACE || token == 0 || prevTerminator();
+        QString quotedString;
+        foreach (const QChar &ch, string) {
+            if (ch == QLatin1Char('"'))
+                quotedString += QLatin1String("\\\"");
+            else {
+                if (ch == QLatin1Char('\\')) quotedString += QLatin1String("\\\\");
+                else if (ch == QLatin1Char('\"')) quotedString += QLatin1String("\\\"");
+                else if (ch == QLatin1Char('\b')) quotedString += QLatin1String("\\b");
+                else if (ch == QLatin1Char('\f')) quotedString += QLatin1String("\\f");
+                else if (ch == QLatin1Char('\n')) quotedString += QLatin1String("\\n");
+                else if (ch == QLatin1Char('\r')) quotedString += QLatin1String("\\r");
+                else if (ch == QLatin1Char('\t')) quotedString += QLatin1String("\\t");
+                else if (ch == QLatin1Char('\v')) quotedString += QLatin1String("\\v");
+                else if (ch == QLatin1Char('\0')) quotedString += QLatin1String("\\0");
+                else quotedString += ch;
+            }
+        }
+        return quotedString;
     }
 
     bool isIdentChar(const QChar &ch) const
@@ -125,7 +182,13 @@ protected:
             *restOfRegExp += QLatin1Char('i');
         if (flags & Multiline)
             *restOfRegExp += QLatin1Char('m');
-        qDebug() << *restOfRegExp;
+
+        if (regExpFlags() == 0) {
+            // Add an extra space after the regexp literal delimiter (aka '/').
+            // This will avoid possible problems when pasting tokens like `instanceof'
+            // after the regexp literal.
+            *restOfRegExp += QLatin1Char(' ');
+        }
         return true;
     }
 };
@@ -137,18 +200,22 @@ class Minify: public QmlminLexer
     QList<int> _tokens;
     QList<QString> _tokenStrings;
     QString _minifiedCode;
+    int _maxWidth;
+    int _width;
 
 public:
-    Minify();
+    Minify(int maxWidth);
 
     QString minifiedCode() const;
 
 protected:
+    void append(const QString &s);
     bool parse(int startToken);
+    void escape(const QChar &ch, QString *out);
 };
 
-Minify::Minify()
-    : _stateStack(128)
+Minify::Minify(int maxWidth)
+    : _stateStack(128), _maxWidth(maxWidth), _width(0)
 {
 }
 
@@ -157,17 +224,64 @@ QString Minify::minifiedCode() const
     return _minifiedCode;
 }
 
+void Minify::append(const QString &s)
+{
+    if (!s.isEmpty()) {
+        if (_maxWidth) {
+            // Prefer not to exceed the maximum chars per line (but don't break up segments)
+            int segmentLength = s.count();
+            if (_width && ((_width + segmentLength) > _maxWidth)) {
+                _minifiedCode.append(QLatin1Char('\n'));
+                _width = 0;
+            }
+
+            _width += segmentLength;
+        }
+
+        _minifiedCode.append(s);
+    }
+}
+
+void Minify::escape(const QChar &ch, QString *out)
+{
+    out->append(QLatin1String("\\u"));
+    const QString hx = QString::number(ch.unicode(), 16);
+    switch (hx.length()) {
+    case 1: out->append(QLatin1String("000")); break;
+    case 2: out->append(QLatin1String("00")); break;
+    case 3: out->append(QLatin1String("0")); break;
+    case 4: break;
+    default: Q_ASSERT(!"unreachable");
+    }
+    out->append(hx);
+}
+
 bool Minify::parse(int startToken)
 {
     int yyaction = 0;
     int yytoken = -1;
     int yytos = -1;
     QString yytokentext;
+    QString assembled;
 
     _minifiedCode.clear();
     _tokens.append(startToken);
     _tokenStrings.append(QString());
 
+    if (startToken == T_FEED_JS_PROGRAM) {
+        // parse optional pragma directive
+        if (scanDirectives(this)) {
+            // append the scanned directives to the minifier code.
+            append(directives());
+
+            _tokens.append(tokenKind());
+            _tokenStrings.append(tokenText());
+        } else {
+            std::cerr << qPrintable(fileName()) << ":" << tokenStartLine() << ":" << tokenStartColumn() << ": syntax error" << std::endl;
+            return false;
+        }
+    }
+
     do {
         if (++yytos == _stateStack.size())
             _stateStack.resize(_stateStack.size() * 2);
@@ -189,85 +303,76 @@ bool Minify::parse(int startToken)
         if (yyaction > 0) {
             if (yyaction == ACCEPT_STATE) {
                 --yytos;
+                if (!assembled.isEmpty())
+                    append(assembled);
                 return true;
             }
 
-            const QChar lastChar = _minifiedCode.isEmpty() ? QChar() : _minifiedCode.at(_minifiedCode.length() - 1);
+            const QChar lastChar = assembled.isEmpty() ? (_minifiedCode.isEmpty() ? QChar()
+                                                                                  : _minifiedCode.at(_minifiedCode.length() - 1))
+                                                       : assembled.at(assembled.length() - 1);
 
             if (yytoken == T_SEMICOLON) {
-                _minifiedCode += QLatin1Char(';');
+                assembled += QLatin1Char(';');
+
+                append(assembled);
+                assembled.clear();
 
             } else if (yytoken == T_PLUS || yytoken == T_MINUS || yytoken == T_PLUS_PLUS || yytoken == T_MINUS_MINUS) {
                 if (lastChar == QLatin1Char(spell[yytoken][0])) {
                     // don't merge unary signs, additive expressions and postfix/prefix increments.
-                    _minifiedCode += QLatin1Char(' ');
+                    assembled += QLatin1Char(' ');
                 }
 
-                _minifiedCode += QLatin1String(spell[yytoken]);
+                assembled += QLatin1String(spell[yytoken]);
 
             } else if (yytoken == T_NUMERIC_LITERAL) {
                 if (isIdentChar(lastChar))
-                    _minifiedCode += QLatin1Char(' ');
+                    assembled += QLatin1Char(' ');
 
                 if (yytokentext.startsWith('.'))
-                    _minifiedCode += QLatin1Char('0');
+                    assembled += QLatin1Char('0');
 
-                _minifiedCode += yytokentext;
+                assembled += yytokentext;
 
-                if (_minifiedCode.endsWith(QLatin1Char('.')))
-                    _minifiedCode += QLatin1Char('0');
+                if (assembled.endsWith(QLatin1Char('.')))
+                    assembled += QLatin1Char('0');
 
             } else if (yytoken == T_IDENTIFIER) {
+                QString identifier = yytokentext;
+
+                if (classify(identifier.constData(), identifier.size(), qmlMode()) != T_IDENTIFIER) {
+                    // the unescaped identifier is a keyword. In this case just replace
+                    // the last character of the identifier with it escape sequence.
+                    const QChar ch = identifier.at(identifier.length() - 1);
+                    identifier.chop(1);
+                    escape(ch, &identifier);
+                }
+
                 if (isIdentChar(lastChar))
-                    _minifiedCode += QLatin1Char(' ');
+                    assembled += QLatin1Char(' ');
 
-                foreach (const QChar &ch, yytokentext) {
+                foreach (const QChar &ch, identifier) {
                     if (isIdentChar(ch))
-                        _minifiedCode += ch;
+                        assembled += ch;
                     else {
-                        _minifiedCode += QLatin1String("\\u");
-                        const QString hx = QString::number(ch.unicode(), 16);
-                        switch (hx.length()) {
-                        case 1: _minifiedCode += QLatin1String("000"); break;
-                        case 2: _minifiedCode += QLatin1String("00"); break;
-                        case 3: _minifiedCode += QLatin1String("0"); break;
-                        case 4: break;
-                        default:
-                            std::cerr << "qmlmin: invalid unicode sequence" << std::endl;
-                            return false;
-                        }
-                        _minifiedCode += hx;
+                        escape(ch, &assembled);
                     }
                 }
 
             } else if (yytoken == T_STRING_LITERAL || yytoken == T_MULTILINE_STRING_LITERAL) {
-                _minifiedCode += QLatin1Char('"');
-                foreach (const QChar &ch, yytokentext) {
-                    if (ch == QLatin1Char('"'))
-                        _minifiedCode += QLatin1String("\\\"");
-                    else {
-                        if (ch == QLatin1Char('\\')) _minifiedCode += QLatin1String("\\\\");
-                        else if (ch == QLatin1Char('\"')) _minifiedCode += QLatin1String("\\\"");
-                        else if (ch == QLatin1Char('\b')) _minifiedCode += QLatin1String("\\b");
-                        else if (ch == QLatin1Char('\f')) _minifiedCode += QLatin1String("\\f");
-                        else if (ch == QLatin1Char('\n')) _minifiedCode += QLatin1String("\\n");
-                        else if (ch == QLatin1Char('\r')) _minifiedCode += QLatin1String("\\r");
-                        else if (ch == QLatin1Char('\t')) _minifiedCode += QLatin1String("\\t");
-                        else if (ch == QLatin1Char('\v')) _minifiedCode += QLatin1String("\\v");
-                        else _minifiedCode += ch;
-                    }
-                }
-
-                _minifiedCode += QLatin1Char('"');
+                assembled += QLatin1Char('"');
+                assembled += quote(yytokentext);
+                assembled += QLatin1Char('"');
             } else {
                 if (isIdentChar(lastChar)) {
                     if (! yytokentext.isEmpty()) {
                         const QChar ch = yytokentext.at(0);
                         if (isIdentChar(ch))
-                            _minifiedCode += QLatin1Char(' ');
+                            assembled += QLatin1Char(' ');
                     }
                 }
-                _minifiedCode += yytokentext;
+                assembled += yytokentext;
             }
             yytoken = -1;
         } else if (yyaction < 0) {
@@ -280,7 +385,7 @@ bool Minify::parse(int startToken)
                 if (! scanRestOfRegExp(ruleno, &restOfRegExp))
                     break; // break the loop, it wil report a syntax error
 
-                _minifiedCode += restOfRegExp;
+                assembled += restOfRegExp;
             }
             yyaction = nt_action(_stateStack[yytos], lhs[ruleno] - TERMINAL_COUNT);
         }
@@ -289,7 +394,7 @@ bool Minify::parse(int startToken)
     const int yyerrorstate = _stateStack[yytos];
 
     // automatic insertion of `;'
-    if (yytoken != -1 && t_action(yyerrorstate, T_AUTOMATIC_SEMICOLON) && automatic(yytoken)) {
+    if (yytoken != -1 && t_action(yyerrorstate, T_AUTOMATIC_SEMICOLON) && canInsertAutomaticSemicolon(yytoken)) {
         _tokens.prepend(yytoken);
         _tokenStrings.prepend(yytokentext);
         yyaction = yyerrorstate;
@@ -339,6 +444,21 @@ bool Tokenize::parse(int startToken)
     _tokens.append(startToken);
     _tokenStrings.append(QString());
 
+    if (startToken == T_FEED_JS_PROGRAM) {
+        // parse optional pragma directive
+        if (scanDirectives(this)) {
+            // append the scanned directives as one token to
+            // the token stream.
+            _minifiedCode.append(directives());
+
+            _tokens.append(tokenKind());
+            _tokenStrings.append(tokenText());
+        } else {
+            std::cerr << qPrintable(fileName()) << ":" << tokenStartLine() << ":" << tokenStartColumn() << ": syntax error" << std::endl;
+            return false;
+        }
+    }
+
     do {
         if (++yytos == _stateStack.size())
             _stateStack.resize(_stateStack.size() * 2);
@@ -389,7 +509,7 @@ bool Tokenize::parse(int startToken)
     const int yyerrorstate = _stateStack[yytos];
 
     // automatic insertion of `;'
-    if (yytoken != -1 && t_action(yyerrorstate, T_AUTOMATIC_SEMICOLON) && automatic(yytoken)) {
+    if (yytoken != -1 && t_action(yyerrorstate, T_AUTOMATIC_SEMICOLON) && canInsertAutomaticSemicolon(yytoken)) {
         _tokens.prepend(yytoken);
         _tokenStrings.prepend(yytokentext);
         yyaction = yyerrorstate;
@@ -401,7 +521,7 @@ bool Tokenize::parse(int startToken)
     return false;
 }
 
-} // end of QDeclarativeJS namespace
+} // end of QQmlJS namespace
 
 static void usage(bool showHelp = false)
 {
@@ -411,11 +531,13 @@ static void usage(bool showHelp = false)
         std::cerr << " Removes comments and layout characters" << std::endl
                   << " The options are:" << std::endl
                   << "  -o<file>                write output to file rather than stdout" << std::endl
+                  << "  -v --verify-only        just run the verifier, no output" << std::endl
+                  << "  -w<width>               restrict line characters to width" << std::endl
                   << "  -h                      display this output" << std::endl;
     }
 }
 
-int main(int argc, char *argv[])
+int runQmlmin(int argc, char *argv[])
 {
     QCoreApplication app(argc, argv);
 
@@ -423,6 +545,10 @@ int main(int argc, char *argv[])
 
     QString fileName;
     QString outputFile;
+    bool verifyOnly = false;
+
+    // By default ensure the output character width is less than 16-bits (pass 0 to disable)
+    int width = USHRT_MAX;
 
     int index = 1;
     while (index < args.size()) {
@@ -432,6 +558,8 @@ int main(int argc, char *argv[])
         if (arg == QLatin1String("-h") || arg == QLatin1String("--help")) {
             usage(/*showHelp*/ true);
             return 0;
+        } else if (arg == QLatin1String("-v") || arg == QLatin1String("--verify-only")) {
+            verifyOnly = true;
         } else if (arg == QLatin1String("-o")) {
             if (next.isEmpty()) {
                 std::cerr << "qmlmin: argument to '-o' is missing" << std::endl;
@@ -447,6 +575,29 @@ int main(int argc, char *argv[])
                 std::cerr << "qmlmin: argument to '-o' is missing" << std::endl;
                 return EXIT_FAILURE;
             }
+        } else if (arg == QLatin1String("-w")) {
+            if (next.isEmpty()) {
+                std::cerr << "qmlmin: argument to '-w' is missing" << std::endl;
+                return EXIT_FAILURE;
+            } else {
+                bool ok;
+                width = next.toInt(&ok);
+
+                if (!ok) {
+                    std::cerr << "qmlmin: argument to '-w' is invalid" << std::endl;
+                    return EXIT_FAILURE;
+                }
+
+                ++index; // consume the next argument
+            }
+        } else if (arg.startsWith(QLatin1String("-w"))) {
+            bool ok;
+            width = arg.mid(2).toInt(&ok);
+
+            if (!ok) {
+                std::cerr << "qmlmin: argument to '-w' is invalid" << std::endl;
+                return EXIT_FAILURE;
+            }
         } else {
             const bool isInvalidOpt = arg.startsWith(QLatin1Char('-'));
             if (! isInvalidOpt && fileName.isEmpty())
@@ -476,7 +627,7 @@ int main(int argc, char *argv[])
     const QString code = QString::fromUtf8(file.readAll()); // QML files are UTF-8 encoded.
     file.close();
 
-    QDeclarativeJS::Minify minify;
+    QQmlJS::Minify minify(width);
     if (! minify(fileName, code)) {
         std::cerr << "qmlmin: cannot minify '" << qPrintable(fileName) << "' (not a valid QML/JS file)" << std::endl;
         return EXIT_FAILURE;
@@ -485,13 +636,13 @@ int main(int argc, char *argv[])
     //
     // verify the output
     //
-    QDeclarativeJS::Minify secondMinify;
+    QQmlJS::Minify secondMinify(width);
     if (! secondMinify(fileName, minify.minifiedCode()) || secondMinify.minifiedCode() != minify.minifiedCode()) {
         std::cerr << "qmlmin: cannot minify '" << qPrintable(fileName) << "'" << std::endl;
         return EXIT_FAILURE;
     }
 
-    QDeclarativeJS::Tokenize originalTokens, minimizedTokens;
+    QQmlJS::Tokenize originalTokens, minimizedTokens;
     originalTokens(fileName, code);
     minimizedTokens(fileName, minify.minifiedCode());
 
@@ -500,19 +651,28 @@ int main(int argc, char *argv[])
         return EXIT_FAILURE;
     }
 
-    if (outputFile.isEmpty()) {
-        const QByteArray chars = minify.minifiedCode().toUtf8();
-        std::cout << chars.constData();
-    } else {
-        QFile file(outputFile);
-        if (! file.open(QFile::WriteOnly)) {
-            std::cerr << "qmlmin: cannot minify '" << qPrintable(fileName) << "' (permission denied)" << std::endl;
-            return EXIT_FAILURE;
-        }
+    if (! verifyOnly) {
+        if (outputFile.isEmpty()) {
+            const QByteArray chars = minify.minifiedCode().toUtf8();
+            std::cout << chars.constData();
+        } else {
+            QFile file(outputFile);
+            if (! file.open(QFile::WriteOnly)) {
+                std::cerr << "qmlmin: cannot minify '" << qPrintable(fileName) << "' (permission denied)" << std::endl;
+                return EXIT_FAILURE;
+            }
 
-        file.write(minify.minifiedCode().toUtf8());
-        file.close();
+            file.write(minify.minifiedCode().toUtf8());
+            file.close();
+        }
     }
 
     return 0;
 }
+
+QT_END_NAMESPACE
+
+int main(int argc, char **argv)
+{
+    return QT_PREPEND_NAMESPACE(runQmlmin(argc, argv));
+}