Move qdoc into qtbase and bootstrap it

We need qdoc in qtbase to be able to properly
modularize our documentation and build it
when building the different Qt modules.

qdoc does contain a copy of the qml parser from
qmldevtools, but this is the lesser evil compared
to how we are currently forced to genereate our
docs (and the fact that no developer can run
qdoc and check the docs for their module).

Change-Id: I9f748459382a11cf5d5153d1ee611d7a5d3f4ac1
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
Reviewed-by: Martin Smith <martin.smith@nokia.com>

1 files changed, 174 insertions, 0 deletions

diff --git a/src/tools/qdoc/tree.h b/src/tools/qdoc/tree.h
new file mode 100644
index 0000000000..d39babfab0
--- /dev/null
+++ b/src/tools/qdoc/tree.h
@@ -0,0 +1,174 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the tools applications of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** 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.
+**
+** 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.
+**
+** 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.
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*
+  tree.h
+*/
+
+#ifndef TREE_H
+#define TREE_H
+
+#include "node.h"
+#include <QDomElement>
+#include <QXmlStreamWriter>
+
+QT_BEGIN_NAMESPACE
+
+class QStringList;
+class TreePrivate;
+
+class Tree
+{
+public:
+    enum FindFlag { SearchBaseClasses = 0x1,
+                    SearchEnumValues = 0x2,
+                    NonFunction = 0x4 };
+
+    Tree();
+    ~Tree();
+
+    Node* findNode(const QStringList &path,
+                   Node* relative=0,
+                   int findFlags=0,
+                   const Node* self=0);
+    Node* findNode(const QStringList &path,
+                   Node::Type type,
+                   Node* relative = 0,
+                   int findFlags = 0);
+    const Node* findNode(const QStringList& path,
+                         const Node* start,
+                         int findFlags,
+                         const Node* self,
+                         bool qml) const;
+    QmlClassNode* findQmlClassNode(const QString& module, const QString& name);
+    NameCollisionNode* checkForCollision(const QString& name) const;
+    NameCollisionNode* findCollisionNode(const QString& name) const;
+    FunctionNode *findFunctionNode(const QStringList &path,
+                                   Node *relative = 0,
+                                   int findFlags = 0);
+    FunctionNode *findFunctionNode(const QStringList &parentPath,
+                                   const FunctionNode *clone,
+                                   Node *relative = 0,
+                                   int findFlags = 0);
+    void addBaseClass(ClassNode *subclass,
+                      Node::Access access,
+                      const QStringList &basePath,
+                      const QString &dataTypeWithTemplateArgs,
+                      InnerNode *parent = 0);
+    void addPropertyFunction(PropertyNode *property,
+                             const QString &funcName,
+                             PropertyNode::FunctionRole funcRole);
+    void addToGroup(Node *node, const QString &group);
+    void addToPublicGroup(Node *node, const QString &group);
+    void addToQmlModule(Node* node, const QString& module);
+    NodeMultiMap groups() const;
+    NodeMultiMap qmlModules() const;
+    QMultiMap<QString,QString> publicGroups() const;
+    void resolveInheritance(NamespaceNode *rootNode = 0);
+    void resolveProperties();
+    void resolveGroups();
+    void resolveQmlModules();
+    void resolveTargets(InnerNode* root);
+    void resolveCppToQmlLinks();
+    void fixInheritance(NamespaceNode *rootNode = 0);
+    void setVersion(const QString &version) { vers = version; }
+    NamespaceNode *root() { return &roo; }
+
+    QString version() const { return vers; }
+    const Node* findNode(const QStringList &path,
+                         const Node* relative = 0,
+                         int findFlags = 0,
+                         const Node* self=0) const;
+    const Node* findNode(const QStringList &path,
+                         Node::Type type, const
+                         Node* relative = 0,
+                         int findFlags = 0) const;
+    const QmlClassNode* findQmlClassNode(const QString& module, const QString& element) const;
+    const FunctionNode *findFunctionNode(const QStringList &path,
+                                         const Node *relative = 0,
+                                         int findFlags = 0) const;
+    const FunctionNode *findFunctionNode(const QStringList &parentPath,
+                                         const FunctionNode *clone,
+                                         const Node *relative = 0,
+                                         int findFlags = 0) const;
+    const FakeNode *findFakeNodeByTitle(const QString &title, const Node* relative = 0) const;
+    const Node *findUnambiguousTarget(const QString &target, Atom *&atom, const Node* relative) const;
+    Atom *findTarget(const QString &target, const Node *node) const;
+    const NamespaceNode *root() const { return &roo; }
+    void readIndexes(const QStringList &indexFiles);
+    bool generateIndexSection(QXmlStreamWriter &writer, const Node *node,
+                              bool generateInternalNodes = false) const;
+    void generateIndexSections(QXmlStreamWriter &writer, const Node *node,
+                               bool generateInternalNodes = false) const;
+    void generateIndex(const QString &fileName,
+                       const QString &url,
+                       const QString &title,
+                       bool generateInternalNodes = false) const;
+    void generateTagFileCompounds(QXmlStreamWriter &writer,
+                                  const InnerNode *inner) const;
+    void generateTagFileMembers(QXmlStreamWriter &writer,
+                                const InnerNode *inner) const;
+    void generateTagFile(const QString &fileName) const;
+    void addExternalLink(const QString &url, const Node *relative);
+    QString fullDocumentLocation(const Node *node) const;
+    void resolveQmlInheritance();
+
+private:
+    void resolveInheritance(int pass, ClassNode *classe);
+    FunctionNode *findVirtualFunctionInBaseClasses(ClassNode *classe,
+                                                   FunctionNode *clone);
+    void fixPropertyUsingBaseClasses(ClassNode *classe, PropertyNode *property);
+    NodeList allBaseClasses(const ClassNode *classe) const;
+    void readIndexFile(const QString &path);
+    void readIndexSection(const QDomElement &element, InnerNode *parent,
+                          const QString &indexUrl);
+    QString readIndexText(const QDomElement &element);
+    void resolveIndex();
+
+private:
+    NamespaceNode roo;
+    QString vers;
+    TreePrivate *priv;
+};
+
+QT_END_NAMESPACE
+
+#endif