Added a specialized version of the QML code marker for JavaScript files.

4 files changed, 207 insertions, 0 deletions

diff --git a/tools/qdoc3/jscodemarker.cpp b/tools/qdoc3/jscodemarker.cpp
new file mode 100644
index 0000000..e3a0ff1
--- /dev/null
+++ b/tools/qdoc3/jscodemarker.cpp
@@ -0,0 +1,129 @@
+/****************************************************************************
+**
+** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the tools applications 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 Technology Preview License Agreement accompanying
+** this package.
+**
+** 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.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*
+  jscodemarker.cpp
+*/
+
+#include "private/qdeclarativejsast_p.h"
+#include "private/qdeclarativejsengine_p.h"
+#include "private/qdeclarativejslexer_p.h"
+#include "private/qdeclarativejsnodepool_p.h"
+#include "private/qdeclarativejsparser_p.h"
+
+#include "atom.h"
+#include "node.h"
+#include "jscodemarker.h"
+#include "qmlmarkupvisitor.h"
+#include "text.h"
+#include "tree.h"
+
+QT_BEGIN_NAMESPACE
+
+JsCodeMarker::JsCodeMarker()
+{
+}
+
+JsCodeMarker::~JsCodeMarker()
+{
+}
+
+/*!
+  Returns true if the \a code is recognized by the parser.
+ */
+bool JsCodeMarker::recognizeCode(const QString &code)
+{
+    QDeclarativeJS::Engine engine;
+    QDeclarativeJS::Lexer lexer(&engine);
+    QDeclarativeJS::Parser parser(&engine);
+    QDeclarativeJS::NodePool m_nodePool("<JsCodeMarker::recognizeCode>", &engine);
+    lexer.setCode(code, 1);
+
+    return parser.parseProgram();
+}
+
+/*!
+  Returns true if \a ext is any of a list of file extensions
+  for the QML language.
+ */
+bool JsCodeMarker::recognizeExtension(const QString &ext)
+{
+    return ext == "js";
+}
+
+/*!
+  Returns true if the \a language is recognized. Only "QML" is
+  recognized by this marker.
+ */
+bool JsCodeMarker::recognizeLanguage(const QString &language)
+{
+    return language == "JavaScript" || language == "ECMAScript";
+}
+
+QString JsCodeMarker::markedUpCode(const QString &code,
+                                    const Node *relative,
+                                    const QString &dirPath)
+{
+    return addMarkUp(code, relative, dirPath);
+}
+
+QString JsCodeMarker::addMarkUp(const QString &code,
+                                 const Node * /* relative */,
+                                 const QString &dirPath)
+{
+    QDeclarativeJS::Engine engine;
+    QDeclarativeJS::Lexer lexer(&engine);
+    lexer.setCode(code, 1);
+
+    QDeclarativeJS::Parser parser(&engine);
+    QDeclarativeJS::NodePool m_nodePool("<JsCodeMarker::addMarkUp>", &engine);
+    QString output;
+
+    if (parser.parseProgram()) {
+        QDeclarativeJS::AST::Node *ast = parser.rootNode();
+        QmlMarkupVisitor visitor(code, &engine);
+        QDeclarativeJS::AST::Node::accept(ast, &visitor);
+        output = visitor.markedUpCode();
+    }
+    return output;
+}
+
+QT_END_NAMESPACE
diff --git a/tools/qdoc3/jscodemarker.h b/tools/qdoc3/jscodemarker.h
new file mode 100644
index 0000000..f7cb025
--- /dev/null
+++ b/tools/qdoc3/jscodemarker.h
@@ -0,0 +1,74 @@
+/****************************************************************************
+**
+** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the tools applications 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 Technology Preview License Agreement accompanying
+** this package.
+**
+** 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.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*
+  jscodemarker.h
+*/
+
+#ifndef JSCODEMARKER_H
+#define JSCODEMARKER_H
+
+#include "qmlcodemarker.h"
+
+QT_BEGIN_NAMESPACE
+
+class JsCodeMarker : public QmlCodeMarker
+{
+public:
+    JsCodeMarker();
+    ~JsCodeMarker();
+
+    virtual bool recognizeCode(const QString &code);
+    virtual bool recognizeExtension(const QString &ext);
+    virtual bool recognizeLanguage(const QString &language);
+
+    virtual QString markedUpCode(const QString &code, 
+                                 const Node *relative, 
+                                 const QString &dirPath);
+
+private:
+    QString addMarkUp(const QString &code, const Node * /* relative */,
+                      const QString & /* dirPath */);
+};
+
+QT_END_NAMESPACE
+
+#endif
diff --git a/tools/qdoc3/main.cpp b/tools/qdoc3/main.cpp
index 68b5370..782df39 100644
--- a/tools/qdoc3/main.cpp
+++ b/tools/qdoc3/main.cpp
@@ -53,6 +53,7 @@
 #include "ditaxmlgenerator.h"
 #include "doc.h"
 #include "htmlgenerator.h"
+#include "jscodemarker.h"
 #include "plaincodemarker.h"
 #include "puredocparser.h"
 #include "qmlcodemarker.h"
@@ -368,6 +369,7 @@ int main(int argc, char **argv)
      */
     PlainCodeMarker plainMarker;
     CppCodeMarker cppMarker;
+    JsCodeMarker jsMarker;
     QmlCodeMarker qmlMarker;
 
     HtmlGenerator htmlGenerator;
diff --git a/tools/qdoc3/qdoc3.pro b/tools/qdoc3/qdoc3.pro
index 23ff7bd..4bc6bca 100644
--- a/tools/qdoc3/qdoc3.pro
+++ b/tools/qdoc3/qdoc3.pro
@@ -37,6 +37,7 @@ HEADERS += atom.h \
 	   generator.h \
            helpprojectwriter.h \
 	   htmlgenerator.h \
+           jscodemarker.h \
            location.h \
            node.h \
            openedlist.h \
@@ -66,6 +67,7 @@ SOURCES += atom.cpp \
 	   generator.cpp \
            helpprojectwriter.cpp \
 	   htmlgenerator.cpp \
+           jscodemarker.cpp \
            location.cpp \
            main.cpp \
            node.cpp \