diff options
Diffstat (limited to 'tools/qdoc3/webxmlgenerator.h')
| -rw-r--r-- | tools/qdoc3/webxmlgenerator.h | 122 |
1 files changed, 122 insertions, 0 deletions
diff --git a/tools/qdoc3/webxmlgenerator.h b/tools/qdoc3/webxmlgenerator.h new file mode 100644 index 0000000..f7b4445 --- /dev/null +++ b/tools/qdoc3/webxmlgenerator.h @@ -0,0 +1,122 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** Contact: Qt Software Information (qt-info@nokia.com) +** +** This file is part of the tools applications of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the either Technology Preview License Agreement or the +** Beta Release License Agreement. +** +** GNU Lesser General Public License Usage +** Alternatively, 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.0, 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. +** +** If you are unsure which license is appropriate for your use, please +** contact the sales department at qt-sales@nokia.com. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/* + WebXMLGenerator.h +*/ + +#ifndef WEBXMLGENERATOR_H +#define WEBXMLGENERATOR_H + +#include "codemarker.h" +#include "config.h" +#include "pagegenerator.h" + +QT_BEGIN_NAMESPACE + +class WebXMLGenerator : public PageGenerator +{ +public: + WebXMLGenerator(); + ~WebXMLGenerator(); + + virtual void initializeGenerator(const Config &config); + virtual void terminateGenerator(); + virtual QString format(); + virtual void generateTree(const Tree *tree, CodeMarker *marker); + +protected: + virtual void startText( const Node *relative, CodeMarker *marker ); + virtual int generateAtom(QXmlStreamWriter &writer, const Atom *atom, + const Node *relative, CodeMarker *marker ); + virtual void generateClassLikeNode(const InnerNode *inner, CodeMarker *marker); + virtual void generateFakeNode(const FakeNode *fake, CodeMarker *marker); + virtual QString fileExtension(const Node *node); + + virtual const Atom *addAtomElements(QXmlStreamWriter &writer, const Atom *atom, + const Node *relative, CodeMarker *marker); + virtual void generateIndexSections(QXmlStreamWriter &writer, const Node *node, + CodeMarker *marker); + virtual void generateInnerNode( const InnerNode *node, CodeMarker *marker ); + +private: + const QPair<QString,QString> anchorForNode(const Node *node); + void findAllClasses(const InnerNode *node); + void findAllNamespaces(const InnerNode *node); + const Node *findNode(const Atom *atom, const Node *relative, CodeMarker *marker); + const Node *findNode(const QString &title, const Node *relative, CodeMarker *marker); + void generateAnnotatedList(QXmlStreamWriter &writer, const Node *relative, + CodeMarker *marker, const QMap<QString, + const Node *> &nodeMap); + void generateFullName(QXmlStreamWriter &writer, const Node *apparentNode, + const Node *relative, CodeMarker *marker, + const Node *actualNode = 0); + void generateRelations(QXmlStreamWriter &writer, const Node *node, CodeMarker *marker); + void generateTableOfContents(QXmlStreamWriter &writer, const Node *node, + Doc::SectioningUnit sectioningUnit, + int numColumns, const Node *relative); + void startLink(QXmlStreamWriter &writer, const Atom *atom, const Node *node, + const Node *relative); + QString targetType(const Node *node); + + const Tree *tre; + bool generateIndex; + bool inLink; + bool inContents; + bool inSectionHeading; + bool inTableHeader; + int numTableRows; + bool threeColumnEnumValueTable; + QMap<QString, QMap<QString, const Node *> > moduleClassMap; + QMap<QString, QMap<QString, const Node *> > moduleNamespaceMap; + QMap<QString, const Node *> namespaceIndex; + QMap<QString, const Node *> serviceClasses; + QString link; + QString project; + QString projectDescription; + QString projectUrl; + QString quoteCommand; + QStringList sectionNumber; +}; + +QT_END_NAMESPACE + +#endif |