/**************************************************************************** ** ** Copyright (C) 2010 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$ ** ****************************************************************************/ /* htmlgenerator.h */ #ifndef HTMLGENERATOR_H #define HTMLGENERATOR_H #include #include #include #include "codemarker.h" #include "config.h" #include "dcfsection.h" #include "pagegenerator.h" QT_BEGIN_NAMESPACE #if 0 struct NavigationBar { SectionIterator prev; SectionIterator current; SectionIterator next; }; #endif typedef QMultiMap NodeMultiMap; typedef QMap NewSinceMaps; typedef QMap ParentMaps; typedef QMap NodeMap; typedef QMap NewClassMaps; class HelpProjectWriter; class HtmlGenerator : public PageGenerator { public: enum SinceType { Namespace, Class, MemberFunction, NamespaceFunction, GlobalFunction, Macro, Enum, Typedef, Property, Variable, QmlClass, QmlProperty, QmlSignal, QmlMethod, LastSinceType }; public: HtmlGenerator(); ~HtmlGenerator(); virtual void initializeGenerator(const Config& config); virtual void terminateGenerator(); virtual QString format(); virtual void generateTree(const Tree *tree, CodeMarker *marker); QString protectEnc(const QString &string); static QString protect(const QString &string, const QString &encoding = "ISO-8859-1"); static QString cleanRef(const QString& ref); static QString sinceTitle(int i) { return sinceTitles[i]; } protected: virtual void startText(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 QString fileExtension(const Node *node) const; virtual QString refForNode(const Node *node); virtual QString linkForNode(const Node *node, const Node *relative); virtual QString refForAtom(Atom *atom, const Node *node); private: enum SubTitleSize { SmallSubTitle, LargeSubTitle }; const QPair anchorForNode(const Node *node); const Node *findNodeForTarget(const QString &target, const Node *relative, CodeMarker *marker, const Atom *atom = 0); void generateBreadCrumbs(const QString& title, const Node *node, CodeMarker *marker); void generateHeader(const QString& title, const Node *node = 0, CodeMarker *marker = 0); void generateTitle(const QString& title, const Text &subTitle, SubTitleSize subTitleSize, const Node *relative, CodeMarker *marker); void generateFooter(const Node *node = 0); void generateBrief(const Node *node, CodeMarker *marker, const Node *relative = 0); void generateIncludes(const InnerNode *inner, CodeMarker *marker); #if 0 void generateNavigationBar(const NavigationBar& bar, const Node *node, CodeMarker *marker); #endif void generateTableOfContents(const Node *node, CodeMarker *marker, Doc::SectioningUnit sectioningUnit, int numColumns, const Node *relative = 0); void generateTableOfContents(const Node *node, CodeMarker *marker, QList
* sections = 0); QString generateListOfAllMemberFile(const InnerNode *inner, CodeMarker *marker); QString generateLowStatusMemberFile(const InnerNode *inner, CodeMarker *marker, CodeMarker::Status status); void generateClassHierarchy(const Node *relative, CodeMarker *marker, const NodeMap &classMap); void generateAnnotatedList(const Node *relative, CodeMarker *marker, const NodeMap &nodeMap); void generateCompactList(const Node *relative, CodeMarker *marker, const NodeMap &classMap, bool includeAlphabet, QString commonPrefix = QString()); void generateFunctionIndex(const Node *relative, CodeMarker *marker); void generateLegaleseList(const Node *relative, CodeMarker *marker); void generateOverviewList(const Node *relative, CodeMarker *marker); void generateSectionList(const Section& section, const Node *relative, CodeMarker *marker, CodeMarker::SynopsisStyle style); #ifdef QDOC_QML void generateQmlSummary(const Section& section, const Node *relative, CodeMarker *marker); void generateQmlItem(const Node *node, const Node *relative, CodeMarker *marker, bool summary); void generateDetailedQmlMember(const Node *node, const InnerNode *relative, CodeMarker *marker); void generateQmlInherits(const QmlClassNode* cn, CodeMarker* marker); void generateQmlInheritedBy(const QmlClassNode* cn, CodeMarker* marker); void generateQmlInstantiates(const QmlClassNode* qcn, CodeMarker* marker); void generateInstantiatedBy(const ClassNode* cn, CodeMarker* marker); #endif void generateSection(const NodeList& nl, const Node *relative, CodeMarker *marker, CodeMarker::SynopsisStyle style); void generateSynopsis(const Node *node, const Node *relative, CodeMarker *marker, CodeMarker::SynopsisStyle style, bool alignNames = false); void generateSectionInheritedList(const Section& section, const Node *relative, CodeMarker *marker); QString highlightedCode(const QString& markedCode, CodeMarker* marker, const Node* relative, bool alignNames = false, const Node* self = 0); void generateFullName(const Node *apparentNode, const Node *relative, CodeMarker *marker, const Node *actualNode = 0); void generateDetailedMember(const Node *node, const InnerNode *relative, CodeMarker *marker); void generateLink(const Atom *atom, const Node *relative, CodeMarker *marker); void generateStatus(const Node *node, CodeMarker *marker); QString registerRef(const QString& ref); QString fileBase(const Node *node); #if 0 QString fileBase(const Node *node, const SectionIterator& section); #endif QString fileName(const Node *node); void findAllClasses(const InnerNode *node); void findAllFunctions(const InnerNode *node); void findAllLegaleseTexts(const InnerNode *node); void findAllNamespaces(const InnerNode *node); void findAllSince(const InnerNode *node); static int hOffset(const Node *node); static bool isThreeColumnEnumValueTable(const Atom *atom); virtual QString getLink(const Atom *atom, const Node *relative, CodeMarker *marker, const Node** node); virtual void generateDcf(const QString &fileBase, const QString &startPage, const QString &title, DcfSection &dcfRoot); virtual void generateIndex(const QString &fileBase, const QString &url, const QString &title); #ifdef GENERATE_MAC_REFS void generateMacRef(const Node *node, CodeMarker *marker); #endif void beginLink(const QString &link, const Node *node, const Node *relative, CodeMarker *marker); void endLink(); bool generatePageElement(QXmlStreamWriter& writer, const Node* node, CodeMarker* marker) const; void generatePageElements(QXmlStreamWriter& writer, const Node* node, CodeMarker* marker) const; void generatePageIndex(const QString& fileName, CodeMarker* marker) const; #if 0 NavigationBar currentNavigationBar; #endif QMap refMap; int codeIndent; DcfSection dcfClassesRoot; DcfSection dcfOverviewsRoot; DcfSection dcfExamplesRoot; DcfSection dcfDesignerRoot; DcfSection dcfLinguistRoot; DcfSection dcfAssistantRoot; DcfSection dcfQmakeRoot; HelpProjectWriter *helpProjectWriter; bool inLink; bool inObsoleteLink; bool inContents; bool inSectionHeading; bool inTableHeader; int numTableRows; bool threeColumnEnumValueTable; bool offlineDocs; bool creatorDocs; QString link; QStringList sectionNumber; QRegExp funcLeftParen; QString style; QString postHeader; QString postPostHeader; QString footer; QString address; bool pleaseGenerateMacRef; QString project; QString projectDescription; QString projectUrl; QString navigationLinks; QStringList stylesheets; QStringList customHeadElements; const Tree *myTree; bool slow; bool obsoleteLinks; QMap moduleClassMap; QMap moduleNamespaceMap; NodeMap nonCompatClasses; NodeMap mainClasses; NodeMap compatClasses; NodeMap obsoleteClasses; NodeMap namespaceIndex; NodeMap serviceClasses; QMap funcIndex; QMap legaleseTexts; NewSinceMaps newSinceMaps; static QString sinceTitles[]; NewClassMaps newClassMaps; NewClassMaps newQmlClassMaps; static int id; public: static bool debugging_on; }; #define HTMLGENERATOR_ADDRESS "address" #define HTMLGENERATOR_FOOTER "footer" #define HTMLGENERATOR_GENERATEMACREFS "generatemacrefs" // ### document me #define HTMLGENERATOR_POSTHEADER "postheader" #define HTMLGENERATOR_POSTPOSTHEADER "postpostheader" #define HTMLGENERATOR_STYLE "style" #define HTMLGENERATOR_STYLESHEETS "stylesheets" #define HTMLGENERATOR_CUSTOMHEADELEMENTS "customheadelements" QT_END_NAMESPACE #endif