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
126
127
128
|
/****************************************************************************
**
** Copyright (C) 2019 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$
**
****************************************************************************/
#include "puredocparser.h"
#include "qdocdatabase.h"
#include "tokenizer.h"
#include <errno.h>
QT_BEGIN_NAMESPACE
PureDocParser *PureDocParser::pureParser_ = nullptr;
/*!
Returns a list of the kinds of files that the pure doc
parser is meant to parse. The elements of the list are
file suffixes.
*/
QStringList PureDocParser::sourceFileNameFilter()
{
return QStringList() << "*.qdoc"
<< "*.qtx"
<< "*.qtt"
<< "*.js";
}
/*!
Parses the source file identified by \a filePath and adds its
parsed contents to the database. The \a location is used for
reporting errors.
*/
void PureDocParser::parseSourceFile(const Location &location, const QString &filePath)
{
QFile in(filePath);
currentFile_ = filePath;
if (!in.open(QIODevice::ReadOnly)) {
location.error(tr("Can't open source file '%1' (%2)").arg(filePath).arg(strerror(errno)));
currentFile_.clear();
return;
}
Location fileLocation(filePath);
Tokenizer fileTokenizer(fileLocation, in);
tokenizer_ = &fileTokenizer;
tok_ = tokenizer_->getToken();
/*
The set of open namespaces is cleared before parsing
each source file. The word "source" here means cpp file.
*/
qdb_->clearOpenNamespaces();
processQdocComments();
in.close();
currentFile_.clear();
}
/*!
This is called by parseSourceFile() to do the actual parsing
and tree building. It only processes qdoc comments. It skips
everything else.
*/
bool PureDocParser::processQdocComments()
{
const QSet<QString> &commands = topicCommands() + metaCommands();
while (tok_ != Tok_Eoi) {
if (tok_ == Tok_Doc) {
QString comment = tokenizer_->lexeme(); // returns an entire qdoc comment.
Location start_loc(tokenizer_->location());
tok_ = tokenizer_->getToken();
Doc::trimCStyleComment(start_loc, comment);
Location end_loc(tokenizer_->location());
// Doc constructor parses the comment.
Doc doc(start_loc, end_loc, comment, commands, topicCommands());
const TopicList &topics = doc.topicsUsed();
if (topics.isEmpty()) {
doc.location().warning(tr("This qdoc comment contains no topic command "
"(e.g., '\\%1', '\\%2').")
.arg(COMMAND_MODULE)
.arg(COMMAND_PAGE));
continue;
}
if (hasTooManyTopics(doc))
continue;
DocList docs;
NodeList nodes;
QString topic = topics[0].topic;
processTopicArgs(doc, topic, nodes, docs);
processMetaCommands(nodes, docs);
} else {
tok_ = tokenizer_->getToken();
}
}
return true;
}
QT_END_NAMESPACE
|
