/**************************************************************************** ** ** Copyright (C) 2011 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$ ** GNU Lesser General Public License Usage ** 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. ** ** 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. ** ** Other Usage ** Alternatively, this file may be used in accordance with the terms and ** conditions contained in a signed written agreement between you and Nokia. ** ** ** ** ** ** $QT_END_LICENSE$ ** ****************************************************************************/ #ifndef DITAXMLGENERATOR_H #define DITAXMLGENERATOR_H #include #include #include #include "codemarker.h" #include "config.h" #include "pagegenerator.h" QT_BEGIN_NAMESPACE typedef QMap GuidMap; typedef QMap GuidMaps; class DitaXmlGenerator : public PageGenerator { public: enum SinceType { Namespace, Class, MemberFunction, NamespaceFunction, GlobalFunction, Macro, Enum, Typedef, Property, Variable, QmlClass, QmlProperty, QmlSignal, QmlMethod, LastSinceType }; enum DitaTag { DT_NONE, DT_alt, DT_apiDesc, DT_APIMap, DT_apiName, DT_apiRelation, DT_audience, DT_author, DT_b, DT_body, DT_bodydiv, DT_brand, DT_category, DT_codeblock, DT_comment, DT_component, DT_copyrholder, DT_copyright, DT_copyryear, DT_created, DT_critdates, DT_cxxAPIMap, DT_cxxClass, DT_cxxClassAbstract, DT_cxxClassAccessSpecifier, DT_cxxClassAPIItemLocation, DT_cxxClassBaseClass, DT_cxxClassDeclarationFile, DT_cxxClassDeclarationFileLine, DT_cxxClassDefinition, DT_cxxClassDerivation, DT_cxxClassDerivationAccessSpecifier, DT_cxxClassDerivations, DT_cxxClassDetail, DT_cxxClassNested, DT_cxxClassNestedClass, DT_cxxClassNestedDetail, DT_cxxDefine, DT_cxxDefineAccessSpecifier, DT_cxxDefineAPIItemLocation, DT_cxxDefineDeclarationFile, DT_cxxDefineDeclarationFileLine, DT_cxxDefineDefinition, DT_cxxDefineDetail, DT_cxxDefineNameLookup, DT_cxxDefineParameter, DT_cxxDefineParameterDeclarationName, DT_cxxDefineParameters, DT_cxxDefinePrototype, DT_cxxDefineReimplemented, DT_cxxEnumeration, DT_cxxEnumerationAccessSpecifier, DT_cxxEnumerationAPIItemLocation, DT_cxxEnumerationDeclarationFile, DT_cxxEnumerationDeclarationFileLine, DT_cxxEnumerationDefinition, DT_cxxEnumerationDefinitionFile, DT_cxxEnumerationDefinitionFileLineStart, DT_cxxEnumerationDefinitionFileLineEnd, DT_cxxEnumerationDetail, DT_cxxEnumerationNameLookup, DT_cxxEnumerationPrototype, DT_cxxEnumerationScopedName, DT_cxxEnumerator, DT_cxxEnumeratorInitialiser, DT_cxxEnumeratorNameLookup, DT_cxxEnumeratorPrototype, DT_cxxEnumerators, DT_cxxEnumeratorScopedName, DT_cxxFunction, DT_cxxFunctionAccessSpecifier, DT_cxxFunctionAPIItemLocation, DT_cxxFunctionConst, DT_cxxFunctionConstructor, DT_cxxFunctionDeclarationFile, DT_cxxFunctionDeclarationFileLine, DT_cxxFunctionDeclaredType, DT_cxxFunctionDefinition, DT_cxxFunctionDestructor, DT_cxxFunctionDetail, DT_cxxFunctionNameLookup, DT_cxxFunctionParameter, DT_cxxFunctionParameterDeclarationName, DT_cxxFunctionParameterDeclaredType, DT_cxxFunctionParameterDefaultValue, DT_cxxFunctionParameters, DT_cxxFunctionPrototype, DT_cxxFunctionPureVirtual, DT_cxxFunctionReimplemented, DT_cxxFunctionScopedName, DT_cxxFunctionStorageClassSpecifierStatic, DT_cxxFunctionVirtual, DT_cxxTypedef, DT_cxxTypedefAccessSpecifier, DT_cxxTypedefAPIItemLocation, DT_cxxTypedefDeclarationFile, DT_cxxTypedefDeclarationFileLine, DT_cxxTypedefDefinition, DT_cxxTypedefDetail, DT_cxxTypedefNameLookup, DT_cxxTypedefScopedName, DT_cxxVariable, DT_cxxVariableAccessSpecifier, DT_cxxVariableAPIItemLocation, DT_cxxVariableDeclarationFile, DT_cxxVariableDeclarationFileLine, DT_cxxVariableDeclaredType, DT_cxxVariableDefinition, DT_cxxVariableDetail, DT_cxxVariableNameLookup, DT_cxxVariablePrototype, DT_cxxVariableReimplemented, DT_cxxVariableScopedName, DT_cxxVariableStorageClassSpecifierStatic, DT_data, DT_dataabout, DT_dd, DT_dl, DT_dlentry, DT_dt, DT_entry, DT_fig, DT_i, DT_image, DT_keyword, DT_keywords, DT_li, DT_link, DT_linktext, DT_lq, DT_metadata, DT_ol, DT_othermeta, DT_p, DT_parameter, DT_permissions, DT_ph, DT_platform, DT_pre, DT_prodinfo, DT_prodname, DT_prolog, DT_publisher, DT_relatedLinks, DT_resourceid, DT_revised, DT_row, DT_section, DT_sectiondiv, DT_shortdesc, DT_simpletable, DT_source, DT_stentry, DT_sthead, DT_strow, DT_sub, DT_sup, DT_table, DT_tbody, DT_tgroup, DT_thead, DT_title, DT_tm, DT_topic, DT_topicmeta, DT_topicref, DT_tt, DT_u, DT_ul, DT_unknown, DT_vrm, DT_vrmlist, DT_xref, DT_LAST }; public: DitaXmlGenerator(); ~DitaXmlGenerator(); virtual void initializeGenerator(const Config& config); virtual void terminateGenerator(); virtual QString format(); virtual bool canHandleFormat(const QString& format); virtual void generateTree(const Tree *tree); 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 guidForNode(const Node* node); virtual QString linkForNode(const Node* node, const Node* relative); virtual QString refForAtom(Atom* atom, const Node* node); void writeXrefListItem(const QString& link, const QString& text); QString fullQualification(const Node* n); void writeCharacters(const QString& text); void writeDerivations(const ClassNode* cn, CodeMarker* marker); void writeLocation(const Node* n); void writeFunctions(const Section& s, const InnerNode* parent, CodeMarker* marker, const QString& attribute = QString()); void writeNestedClasses(const Section& s, const Node* n); void replaceTypesWithLinks(const Node* n, const InnerNode* parent, CodeMarker* marker, QString& src); void writeParameters(const FunctionNode* fn, const InnerNode* parent, CodeMarker* marker); void writeEnumerations(const Section& s, CodeMarker* marker, const QString& attribute = QString()); void writeTypedefs(const Section& s, CodeMarker* marker, const QString& attribute = QString()); void writeDataMembers(const Section& s, CodeMarker* marker, const QString& attribute = QString()); void writeProperties(const Section& s, CodeMarker* marker, const QString& attribute = QString()); void writeMacros(const Section& s, CodeMarker* marker, const QString& attribute = QString()); void writePropertyParameter(const QString& tag, const NodeList& nlist); void writeRelatedLinks(const FakeNode* fake, CodeMarker* marker); void writeLink(const Node* node, const QString& tex, const QString& role); void writeProlog(const InnerNode* inner); bool writeMetadataElement(const InnerNode* inner, DitaXmlGenerator::DitaTag t, bool force=true); bool writeMetadataElements(const InnerNode* inner, DitaXmlGenerator::DitaTag t); QString getMetadataElement(const InnerNode* inner, DitaXmlGenerator::DitaTag t); QStringList getMetadataElements(const InnerNode* inner, DitaXmlGenerator::DitaTag t); 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 generateHeader(const Node* node, const QString& name, bool subpage = false); void generateBrief(const Node* node, CodeMarker* marker); void generateIncludes(const InnerNode* inner, CodeMarker* marker); void generateTableOfContents(const Node* node, CodeMarker* marker, Doc::Sections sectioningUnit, int numColumns, const Node* relative = 0); void generateTableOfContents(const Node* node, CodeMarker* marker, QList
* sections = 0); void generateLowStatusMembers(const InnerNode* inner, CodeMarker* marker, CodeMarker::Status status); 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); #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); QString getMarkedUpSynopsis(const Node* node, const Node* relative, CodeMarker* marker, CodeMarker::SynopsisStyle style); void generateSectionInheritedList(const Section& section, const Node* relative, CodeMarker* marker); void writeText(const QString& markedCode, CodeMarker* marker, const Node* relative); void generateFullName(const Node* apparentNode, const Node* relative, CodeMarker* marker, const Node* actualNode = 0); 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) const; 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); 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 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); void endLink(); QString writeGuidAttribute(QString text); void writeGuidAttribute(Node* node); QString lookupGuid(QString text); QString lookupGuid(const QString& fileName, const QString& text); GuidMap* lookupGuidMap(const QString& fileName); virtual void beginSubPage(const Location& location, const QString& fileName); virtual void endSubPage(); virtual void generateInnerNode(const InnerNode* node); QXmlStreamWriter& xmlWriter(); void writeApiDesc(const Node* node, CodeMarker* marker, const QString& title); void addLink(const QString& href, const QStringRef& text, DitaTag t = DT_xref); void writeDitaMap(); void writeStartTag(DitaTag t); void writeEndTag(DitaTag t=DT_NONE); DitaTag currentTag(); void clearSectionNesting() { sectionNestingLevel = 0; } int enterApiDesc(const QString& outputclass, const QString& title); int enterSection(const QString& outputclass, const QString& title); int leaveSection(); bool inSection() const { return (sectionNestingLevel > 0); } int currentSectionNestingLevel() const { return sectionNestingLevel; } QString metadataDefault(DitaTag t) const; private: /* These flags indicate which elements the generator is currently outputting. */ bool inContents; bool inDetailedDescription; bool inLegaleseText; bool inLink; bool inObsoleteLink; bool inSectionHeading; bool inTableHeader; bool inTableBody; bool noLinks; bool obsoleteLinks; bool offlineDocs; bool threeColumnEnumValueTable; int codeIndent; int numTableRows; int divNestingLevel; int sectionNestingLevel; int tableColumnCount; 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; QString version; QStringList vrm; QStringList stylesheets; QStringList customHeadElements; const Tree* myTree; QMap refMap; QMap name2guidMap; GuidMaps guidMaps; QMap moduleClassMap; QMap moduleNamespaceMap; NodeMap nonCompatClasses; NodeMap mainClasses; NodeMap compatClasses; NodeMap obsoleteClasses; NodeMap namespaceIndex; NodeMap serviceClasses; #ifdef QDOC_QML NodeMap qmlClasses; #endif QMap funcIndex; QMap legaleseTexts; static int id; static QString ditaTags[]; QStack xmlWriterStack; QStack tagStack; QStringMultiMap metadataDefaults; }; #define DITAXMLGENERATOR_ADDRESS "address" #define DITAXMLGENERATOR_FOOTER "footer" #define DITAXMLGENERATOR_GENERATEMACREFS "generatemacrefs" // ### document me #define DITAXMLGENERATOR_POSTHEADER "postheader" #define DITAXMLGENERATOR_POSTPOSTHEADER "postpostheader" #define DITAXMLGENERATOR_STYLE "style" #define DITAXMLGENERATOR_STYLESHEETS "stylesheets" #define DITAXMLGENERATOR_CUSTOMHEADELEMENTS "customheadelements" QT_END_NAMESPACE #endif