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, 111 insertions, 0 deletions

diff --git a/src/tools/qdoc/helpprojectwriter.h b/src/tools/qdoc/helpprojectwriter.h
new file mode 100644
index 0000000000..8725f6275e
--- /dev/null
+++ b/src/tools/qdoc/helpprojectwriter.h
@@ -0,0 +1,111 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+#ifndef HELPPROJECTWRITER_H
+#define HELPPROJECTWRITER_H
+
+#include <QString>
+#include <QXmlStreamReader>
+#include <QXmlStreamWriter>
+
+#include "config.h"
+#include "node.h"
+
+QT_BEGIN_NAMESPACE
+
+class Tree;
+typedef QPair<QString, const Node*> QStringNodePair;
+
+struct SubProject
+{
+    QString title;
+    QString indexTitle;
+    QHash<Node::Type, QSet<FakeNode::SubType> > selectors;
+    bool sortPages;
+    QString type;
+    QHash<QString, const Node *> nodes;
+};
+
+struct HelpProject
+{
+    QString name;
+    QString helpNamespace;
+    QString virtualFolder;
+    QString fileName;
+    QString indexRoot;
+    QString indexTitle;
+    QList<QStringList> keywords;
+    QSet<QString> files;
+    QSet<QString> extraFiles;
+    QSet<QString> filterAttributes;
+    QHash<QString, QSet<QString> > customFilters;
+    QSet<QString> excluded;
+    QMap<QString, SubProject> subprojects;
+    QHash<const Node *, QSet<Node::Status> > memberStatus;
+};
+
+class HelpProjectWriter
+{
+public:
+    HelpProjectWriter(const Config &config, const QString &defaultFileName);
+    void addExtraFile(const QString &file);
+    void addExtraFiles(const QSet<QString> &files);
+    void generate(const Tree *tre);
+
+private:
+    void generateProject(HelpProject &project);
+    void generateSections(HelpProject &project, QXmlStreamWriter &writer,
+                          const Node *node);
+    bool generateSection(HelpProject &project, QXmlStreamWriter &writer,
+                         const Node *node);
+    QStringList keywordDetails(const Node *node) const;
+    void writeNode(HelpProject &project, QXmlStreamWriter &writer, const Node *node);
+    void readSelectors(SubProject &subproject, const QStringList &selectors);
+
+    const Tree *tree;
+
+    QString outputDir;
+    QList<HelpProject> projects;
+};
+
+QT_END_NAMESPACE
+
+#endif