/**************************************************************************** ** ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). ** All rights reserved. ** Contact: Nokia Corporation (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 Technology Preview License Agreement accompanying ** this package. ** ** 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.1, included in the file LGPL_EXCEPTION.txt in this package. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. ** ** ** ** ** ** ** ** ** $QT_END_LICENSE$ ** ****************************************************************************/ /* generator.h */ #ifndef GENERATOR_H #define GENERATOR_H #include #include #include #include #include #include "node.h" #include "text.h" QT_BEGIN_NAMESPACE class ClassNode; class Config; class CodeMarker; class FakeNode; class FunctionNode; class InnerNode; class Location; class NamespaceNode; class Node; class Tree; class Generator { public: Generator(); virtual ~Generator(); virtual void initializeGenerator(const Config &config); virtual void terminateGenerator(); virtual QString format() = 0; virtual bool canHandleFormat(const QString &format) { return format == this->format(); } virtual void generateTree(const Tree *tree, CodeMarker *marker) = 0; static void initialize(const Config& config); static void terminate(); static Generator *generatorForFormat(const QString& format); protected: virtual void startText(const Node *relative, CodeMarker *marker); virtual void endText(const Node *relative, CodeMarker *marker); virtual int generateAtom(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 void generateText(const Text& text, const Node *relative, CodeMarker *marker); #ifdef QDOC_QML virtual void generateQmlText(const Text& text, const Node *relative, CodeMarker *marker); #endif virtual void generateBody(const Node *node, CodeMarker *marker); virtual void generateAlsoList(const Node *node, CodeMarker *marker); virtual void generateInherits(const ClassNode *classe, CodeMarker *marker); virtual void generateInheritedBy(const ClassNode *classe, CodeMarker *marker); void generateThreadSafeness(const Node *node, CodeMarker *marker); void generateSince(const Node *node, CodeMarker *marker); void generateStatus(const Node *node, CodeMarker *marker); const Atom *generateAtomList(const Atom *atom, const Node *relative, CodeMarker *marker, bool generate, int& numGeneratedAtoms); void generateExampleFiles(const FakeNode *fake, CodeMarker *marker); void generateModuleWarning(const ClassNode *classe, CodeMarker *marker); virtual int skipAtoms(const Atom *atom, Atom::Type type) const; virtual QString fullName(const Node *node, const Node *relative, CodeMarker *marker) const; const QString& outputDir() { return outDir; } QString indent(int level, const QString& markedCode); QString plainCode(const QString& markedCode); virtual QString typeString(const Node *node); virtual QString imageFileName(const Node *relative, const QString& fileBase); void setImageFileExtensions(const QStringList& extensions); void unknownAtom(const Atom *atom); QMap &formattingLeftMap(); QMap &formattingRightMap(); QMap editionModuleMap; QMap editionGroupMap; static QString trimmedTrailing(const QString &string); static bool matchAhead(const Atom *atom, Atom::Type expectedAtomType); static void supplementAlsoList(const Node *node, QList &alsoList); private: void generateOverload(const Node *node, CodeMarker *marker); void generateReimplementedFrom(const FunctionNode *func, CodeMarker *marker); void appendFullName(Text& text, const Node *apparentNode, const Node *relative, CodeMarker *marker, const Node *actualNode = 0); void appendSortedNames(Text& text, const ClassNode *classe, const QList &classes, CodeMarker *marker); QString amp; QString lt; QString gt; QString quot; QRegExp tag; static QList generators; static QMap > fmtLeftMaps; static QMap > fmtRightMaps; static QMap imgFileExts; static QSet outputFormats; static QStringList imageFiles; static QStringList imageDirs; static QString outDir; static QString project; }; QT_END_NAMESPACE #endif