1 | // Copyright (C) 2021 The Qt Company Ltd. |
2 | // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 |
3 | |
4 | #ifndef WEBXMLGENERATOR_H |
5 | #define WEBXMLGENERATOR_H |
6 | |
7 | #include "codemarker.h" |
8 | #include "htmlgenerator.h" |
9 | #include "qdocindexfiles.h" |
10 | |
11 | #include <QtCore/qscopedpointer.h> |
12 | #include <QtCore/qxmlstream.h> |
13 | |
14 | QT_BEGIN_NAMESPACE |
15 | |
16 | class Aggregate; |
17 | |
18 | class WebXMLGenerator : public HtmlGenerator, public IndexSectionWriter |
19 | { |
20 | public: |
21 | WebXMLGenerator(FileResolver& file_resolver); |
22 | |
23 | void initializeGenerator() override; |
24 | void terminateGenerator() override; |
25 | QString format() override; |
26 | // from IndexSectionWriter |
27 | void append(QXmlStreamWriter &writer, Node *node) override; |
28 | |
29 | protected: |
30 | qsizetype generateAtom(const Atom *atom, const Node *relative, CodeMarker *marker) override; |
31 | void generateCppReferencePage(Aggregate *aggregate, CodeMarker *marker) override; |
32 | void generatePageNode(PageNode *pn, CodeMarker *marker) override; |
33 | void generateDocumentation(Node *node) override; |
34 | void generateExampleFilePage(const Node *en, ResolvedFile file, CodeMarker *marker = nullptr) override; |
35 | [[nodiscard]] QString fileExtension() const override; |
36 | |
37 | virtual const Atom *addAtomElements(QXmlStreamWriter &writer, const Atom *atom, |
38 | const Node *relative, CodeMarker *marker); |
39 | virtual void generateIndexSections(QXmlStreamWriter &writer, Node *node); |
40 | |
41 | private: |
42 | void generateAnnotatedList(QXmlStreamWriter &writer, const Node *relative, |
43 | const NodeMap &nodeMap); |
44 | void generateAnnotatedList(QXmlStreamWriter &writer, const Node *relative, |
45 | const NodeList &nodeList); |
46 | void generateRelations(QXmlStreamWriter &writer, const Node *node); |
47 | void startLink(QXmlStreamWriter &writer, const Atom *atom, const Node *node, |
48 | const QString &link); |
49 | void endLink(QXmlStreamWriter &writer); |
50 | QString fileBase(const Node *node) const override; |
51 | |
52 | bool m_hasQuotingInformation { false }; |
53 | QString quoteCommand {}; |
54 | QScopedPointer<QXmlStreamWriter> currentWriter {}; |
55 | bool m_supplement { false }; |
56 | }; |
57 | |
58 | QT_END_NAMESPACE |
59 | |
60 | #endif |
61 | |