tools/qdoc3/pagegenerator.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   pagegenerator.h
  44 */
  45
  46 #ifndef PAGEGENERATOR_H
  47 #define PAGEGENERATOR_H
  48
  49 #include <QStack>
  50 #include <qtextstream.h>
  51
  52 #include "generator.h"
  53 #include "location.h"
  54
  55 QT_BEGIN_NAMESPACE
  56
  57 class ClassNode;
  58 class InnerNode;
  59 class NamespaceNode;
  60
  61 class PageGenerator : public Generator
  62 {
  63  public:
  64     PageGenerator();
  65     ~PageGenerator();
  66
  67     virtual void generateTree(const Tree *tree, CodeMarker *marker);
  68
  69  protected:
  70     virtual QString fileBase(const Node *node);
  71     virtual QString fileExtension(const Node *node) = 0;
  72     QString fileName(const Node *node);
  73     QString outFileName();
  74     void beginSubPage(const Location& location, const QString& fileName);
  75     void endSubPage();
  76     virtual void generateInnerNode(const InnerNode *node, CodeMarker *marker);
  77     QTextStream& out();
  78
  79  private:
  80     QStack<QTextStream *> outStreamStack;
  81 };
  82
  83 QT_END_NAMESPACE
  84
  85 #endif