1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#ifndef DOC_H
#define DOC_H
#include "location.h"
#include "docutilities.h"
#include "topic.h"
#include "filesystem/fileresolver.h"
#include "boundaries/filesystem/resolvedfile.h"
#include <QtCore/qmap.h>
#include <QtCore/qset.h>
#include <QtCore/qstring.h>
QT_BEGIN_NAMESPACE
class Atom;
class CodeMarker;
class DocPrivate;
class Quoter;
class Text;
typedef std::pair<QString, QString> ArgPair;
typedef QList<ArgPair> ArgList;
typedef QMultiMap<QString, QString> QStringMultiMap;
class Doc
{
public:
// the order is important
enum Sections {
NoSection = -1,
Section1 = 1,
Section2 = 2,
Section3 = 3,
Section4 = 4
};
Doc() = default;
Doc(const Location &start_loc, const Location &end_loc, const QString &source,
const QSet<QString> &metaCommandSet, const QSet<QString> &topics);
Doc(const Doc &doc);
~Doc();
Doc &operator=(const Doc &doc);
[[nodiscard]] const Location &location() const;
[[nodiscard]] const Location &startLocation() const;
[[nodiscard]] bool isEmpty() const;
[[nodiscard]] const QString &source() const;
[[nodiscard]] const Text &body() const;
[[nodiscard]] Text briefText(bool inclusive = false) const;
[[nodiscard]] Text trimmedBriefText(const QString &className) const;
[[nodiscard]] Text legaleseText() const;
[[nodiscard]] QSet<QString> parameterNames() const;
[[nodiscard]] QStringList enumItemNames() const;
[[nodiscard]] QStringList omitEnumItemNames() const;
[[nodiscard]] QSet<QString> metaCommandsUsed() const;
[[nodiscard]] TopicList topicsUsed() const;
[[nodiscard]] ArgList metaCommandArgs(const QString &metaCommand) const;
[[nodiscard]] QList<Text> alsoList() const;
[[nodiscard]] bool hasTableOfContents() const;
[[nodiscard]] bool hasKeywords() const;
[[nodiscard]] bool hasTargets() const;
[[nodiscard]] bool isInternal() const;
[[nodiscard]] bool isMarkedReimp() const;
[[nodiscard]] const QList<Atom *> &tableOfContents() const;
[[nodiscard]] const QList<int> &tableOfContentsLevels() const;
[[nodiscard]] const QList<Atom *> &keywords() const;
[[nodiscard]] const QList<Atom *> &targets() const;
[[nodiscard]] QStringMultiMap *metaTagMap() const;
static void initialize(FileResolver& file_resolver);
static void terminate();
static void trimCStyleComment(Location &location, QString &str);
static CodeMarker *quoteFromFile(const Location &location, Quoter "er,
ResolvedFile resolved_file);
private:
void detach();
DocPrivate *m_priv { nullptr };
static DocUtilities &m_utilities;
};
Q_DECLARE_TYPEINFO(Doc, Q_RELOCATABLE_TYPE);
typedef QList<Doc> DocList;
QT_END_NAMESPACE
#endif
|
