tools/qdoc3/helpprojectwriter.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the tools applications of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef HELPPROJECTWRITER_H
  43 #define HELPPROJECTWRITER_H
  44
  45 #include <QString>
  46 #include <QXmlStreamReader>
  47 #include <QXmlStreamWriter>
  48
  49 #include "config.h"
  50 #include "node.h"
  51
  52 QT_BEGIN_NAMESPACE
  53
  54 class Tree;
  55 typedef QPair<QString, const Node*> QStringNodePair;
  56
  57 struct SubProject
  58 {
  59     QString title;
  60     QString indexTitle;
  61     QHash<Node::Type, QSet<FakeNode::SubType> > selectors;
  62     bool sortPages;
  63     QHash<QString, const Node *> nodes;
  64 };
  65
  66 struct HelpProject
  67 {
  68     QString name;
  69     QString helpNamespace;
  70     QString virtualFolder;
  71     QString fileName;
  72     QString indexRoot;
  73     QString indexTitle;
  74     QList<QStringList> keywords;
  75     QSet<QString> files;
  76     QSet<QString> extraFiles;
  77     QSet<QString> filterAttributes;
  78     QHash<QString, QSet<QString> > customFilters;
  79     QSet<QString> excluded;
  80     QMap<QString, SubProject> subprojects;
  81     QHash<const Node *, QSet<Node::Status> > memberStatus;
  82 };
  83
  84 class HelpProjectWriter
  85 {
  86 public:
  87     HelpProjectWriter(const Config &config, const QString &defaultFileName);
  88     void addExtraFile(const QString &file);
  89     void addExtraFiles(const QSet<QString> &files);
  90     void generate(const Tree *tre);
  91
  92 private:
  93     void generateProject(HelpProject &project);
  94     void generateSections(HelpProject &project, QXmlStreamWriter &writer,
  95                           const Node *node);
  96     bool generateSection(HelpProject &project, QXmlStreamWriter &writer,
  97                          const Node *node);
  98     QStringList keywordDetails(const Node *node) const;
  99     void writeNode(HelpProject &project, QXmlStreamWriter &writer, const Node *node);
 100     void readSelectors(SubProject &subproject, const QStringList &selectors);
 101
 102     const Tree *tree;
 103
 104     QString outputDir;
 105     QList<HelpProject> projects;
 106 };
 107
 108 QT_END_NAMESPACE
 109
 110 #endif