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
|
/****************************************************************************
**
** 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$
**
****************************************************************************/
#ifndef CPPCODEPARSER_H
#define CPPCODEPARSER_H
#include "codeparser.h"
QT_BEGIN_NAMESPACE
class ClassNode;
class FunctionNode;
class Aggregate;
class CppCodeParser : public CodeParser
{
Q_DECLARE_TR_FUNCTIONS(QDoc::CppCodeParser)
struct ExtraFuncData
{
Aggregate *root; // Used as the parent.
Node::NodeType type; // The node type: Function, etc.
bool isAttached; // If true, the method is attached.
bool isMacro; // If true, we are parsing a macro signature.
ExtraFuncData() : root(nullptr), type(Node::Function), isAttached(false), isMacro(false) {}
ExtraFuncData(Aggregate *r, Node::NodeType t, bool a)
: root(r), type(t), isAttached(a), isMacro(false)
{
}
};
public:
CppCodeParser();
void initializeParser() override;
void terminateParser() override;
QString language() override { return QStringLiteral("Cpp"); }
QStringList headerFileNameFilter() override;
QStringList sourceFileNameFilter() override;
FunctionNode *parseMacroArg(const Location &location, const QString ¯oArg);
FunctionNode *parseOtherFuncArg(const QString &topic, const Location &location,
const QString &funcArg);
static bool isJSMethodTopic(const QString &t);
static bool isQMLMethodTopic(const QString &t);
static bool isJSPropertyTopic(const QString &t);
static bool isQMLPropertyTopic(const QString &t);
protected:
static const QSet<QString> &topicCommands();
static const QSet<QString> &metaCommands();
virtual Node *processTopicCommand(const Doc &doc, const QString &command,
const ArgLocPair &arg);
void processQmlProperties(const Doc &doc, NodeList &nodes, DocList &docs);
bool splitQmlPropertyArg(const QString &arg, QString &type, QString &module, QString &element,
QString &name, const Location &location);
void processMetaCommand(const Doc &doc, const QString &command, const ArgLocPair &argLocPair,
Node *node);
void processMetaCommands(const Doc &doc, Node *node);
void processMetaCommands(NodeList &nodes, DocList &docs);
void processTopicArgs(const Doc &doc, const QString &topic, NodeList &nodes, DocList &docs);
bool hasTooManyTopics(const Doc &doc) const;
private:
void setExampleFileLists(PageNode *pn);
protected:
typedef bool (Node::*NodeTypeTestFunc)() const;
QMap<QString, NodeTypeTestFunc> nodeTypeTestFuncMap_;
QMap<QString, Node::NodeType> nodeTypeMap_;
private:
static QStringList exampleFiles;
static QStringList exampleDirs;
static QSet<QString> excludeDirs;
static QSet<QString> excludeFiles;
QString exampleNameFilter;
QString exampleImageFilter;
};
QT_END_NAMESPACE
#endif
|
