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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the tools applications of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
/*
doc.h
*/
#ifndef DOC_H
#define DOC_H
#include "location.h"
#include "docutilities.h"
#include "topic.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 QPair<QString, Location> ArgLocPair;
typedef QList<ArgLocPair> ArgList;
typedef QMultiMap<QString, QString> QStringMultiMap;
class Doc
{
public:
// the order is important
enum Sections {
NoSection = -2,
Part = -1,
Chapter = 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);
const Location &location() const;
const Location &startLocation() const;
bool isEmpty() const;
const QString &source() const;
const Text &body() const;
Text briefText(bool inclusive = false) const;
Text trimmedBriefText(const QString &className) const;
Text legaleseText() const;
QSet<QString> parameterNames() const;
QStringList enumItemNames() const;
QStringList omitEnumItemNames() const;
QSet<QString> metaCommandsUsed() const;
TopicList topicsUsed() const;
ArgList metaCommandArgs(const QString &metaCommand) const;
QList<Text> alsoList() const;
bool hasTableOfContents() const;
bool hasKeywords() const;
bool hasTargets() const;
bool isInternal() const;
bool isMarkedReimp() const;
const QList<Atom *> &tableOfContents() const;
const QList<int> &tableOfContentsLevels() const;
const QList<Atom *> &keywords() const;
const QList<Atom *> &targets() const;
QStringMultiMap *metaTagMap() const;
static void initialize();
static void terminate();
static QString alias(const QString &english);
static void trimCStyleComment(Location &location, QString &str);
static QString resolveFile(const Location &location, const QString &fileName,
QString *userFriendlyFilePath = nullptr);
static CodeMarker *quoteFromFile(const Location &location, Quoter "er,
const QString &fileName);
static QString canonicalTitle(const QString &title);
private:
void detach();
DocPrivate *priv { nullptr };
static DocUtilities &m_utilities;
};
Q_DECLARE_TYPEINFO(Doc, Q_MOVABLE_TYPE);
typedef QList<Doc> DocList;
QT_END_NAMESPACE
#endif
|
