tools/qdoc3/webxmlgenerator.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 /*
  43   WebXMLGenerator.h
  44 */
  45
  46 #ifndef WEBXMLGENERATOR_H
  47 #define WEBXMLGENERATOR_H
  48
  49 #include "codemarker.h"
  50 #include "config.h"
  51 #include "pagegenerator.h"
  52
  53 QT_BEGIN_NAMESPACE
  54
  55 class WebXMLGenerator : public PageGenerator
  56 {
  57 public:
  58     WebXMLGenerator();
  59     ~WebXMLGenerator();
  60
  61     virtual void initializeGenerator(const Config &config);
  62     virtual void terminateGenerator();
  63     virtual QString format();
  64     virtual void generateTree(const Tree *tree, CodeMarker *marker);
  65
  66 protected:
  67     virtual void startText( const Node *relative, CodeMarker *marker );
  68     virtual int generateAtom(QXmlStreamWriter &writer, const Atom *atom,
  69                              const Node *relative, CodeMarker *marker );
  70     virtual void generateClassLikeNode(const InnerNode *inner, CodeMarker *marker);
  71     virtual void generateFakeNode(const FakeNode *fake, CodeMarker *marker);
  72     virtual QString fileExtension(const Node *node);
  73
  74     virtual const Atom *addAtomElements(QXmlStreamWriter &writer, const Atom *atom,
  75                                  const Node *relative, CodeMarker *marker);
  76     virtual void generateIndexSections(QXmlStreamWriter &writer, const Node *node,
  77                                        CodeMarker *marker);
  78     virtual void generateInnerNode( const InnerNode *node, CodeMarker *marker );
  79
  80 private:
  81     const QPair<QString,QString> anchorForNode(const Node *node);
  82     void findAllClasses(const InnerNode *node);
  83     void findAllNamespaces(const InnerNode *node);
  84     const Node *findNode(const Atom *atom, const Node *relative, CodeMarker *marker);
  85     const Node *findNode(const QString &title, const Node *relative, CodeMarker *marker);
  86     void generateAnnotatedList(QXmlStreamWriter &writer, const Node *relative,
  87                                CodeMarker *marker, const QMap<QString,
  88                                const Node *> &nodeMap);
  89     void generateFullName(QXmlStreamWriter &writer, const Node *apparentNode,
  90                           const Node *relative, CodeMarker *marker,
  91                           const Node *actualNode = 0);
  92     void generateRelations(QXmlStreamWriter &writer, const Node *node, CodeMarker *marker);
  93     void generateTableOfContents(QXmlStreamWriter &writer, const Node *node,
  94                                  Doc::SectioningUnit sectioningUnit,
  95                                  int numColumns, const Node *relative);
  96     void startLink(QXmlStreamWriter &writer, const Atom *atom, const Node *node,
  97                    const Node *relative);
  98     QString targetType(const Node *node);
  99
 100     const Tree *tre;
 101     bool generateIndex;
 102     bool inLink;
 103     bool inContents;
 104     bool inSectionHeading;
 105     bool inTableHeader;
 106     int numTableRows;
 107     bool threeColumnEnumValueTable;
 108     QMap<QString, QMap<QString, const Node *> > moduleClassMap;
 109     QMap<QString, QMap<QString, const Node *> > moduleNamespaceMap;
 110     QMap<QString, const Node *> namespaceIndex;
 111     QMap<QString, const Node *> serviceClasses;
 112     QString link;
 113     QString project;
 114     QString projectDescription;
 115     QString projectUrl;
 116     QString quoteCommand;
 117     QStringList sectionNumber;
 118 };
 119
 120 QT_END_NAMESPACE
 121
 122 #endif