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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt for Python.
**
** $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 DOCPARSER_H
#define DOCPARSER_H
#include "typesystem_typedefs.h"
#include "abstractmetalang_typedefs.h"
#include <QtCore/QString>
QT_BEGIN_NAMESPACE
class QDomDocument;
class QDomNode;
class QXmlQuery;
QT_END_NAMESPACE
class AbstractMetaClass;
class DocModification;
class Documentation;
class DocParser
{
public:
DocParser();
virtual ~DocParser();
virtual void fillDocumentation(AbstractMetaClass* metaClass) = 0;
/**
* Process and retrieves documentation concerning the entire
* module or library.
* \return object containing module/library documentation information
*/
virtual Documentation retrieveModuleDocumentation() = 0;
void setDocumentationDataDirectory(const QString& dir)
{
m_docDataDir = dir;
}
/**
* Informs the location of the XML data generated by the tool
* (e.g.: DoxyGen, qdoc) used to extract the library's documentation
* comment.
* \return the path for the directory containing the XML data created
* from the library's documentation beign parsed.
*/
QString documentationDataDirectory() const
{
return m_docDataDir;
}
void setLibrarySourceDirectory(const QString& dir)
{
m_libSourceDir = dir;
}
/**
* Informs the location of the library being parsed. The library
* source code is parsed for the documentation comments.
* \return the path for the directory containing the source code of
* the library beign parsed.
*/
QString librarySourceDirectory() const
{
return m_libSourceDir;
}
void setPackageName(const QString& packageName)
{
m_packageName = packageName;
}
/**
* Retrieves the name of the package (or module or library) being parsed.
* \return the name of the package (module/library) being parsed
*/
QString packageName() const
{
return m_packageName;
}
/**
* Process and retrieves documentation concerning the entire
* module or library.
* \param name module name
* \return object containing module/library documentation information
* \todo Merge with retrieveModuleDocumentation() on next ABI change.
*/
virtual Documentation retrieveModuleDocumentation(const QString& name) = 0;
static bool skipForQuery(const AbstractMetaFunction *func);
protected:
QString getDocumentation(QXmlQuery& xquery, const QString& query,
const DocModificationList& mods) const;
static AbstractMetaFunctionList documentableFunctions(const AbstractMetaClass *metaClass);
static QString msgCannotFindDocumentation(const QString &fileName,
const char *what, const QString &name,
const QString &query);
static QString msgCannotFindDocumentation(const QString &fileName,
const AbstractMetaClass *metaClass,
const AbstractMetaFunction *function,
const QString &query);
static QString msgCannotFindDocumentation(const QString &fileName,
const AbstractMetaClass *metaClass,
const AbstractMetaEnum *e,
const QString &query);
static QString msgCannotFindDocumentation(const QString &fileName,
const AbstractMetaClass *metaClass,
const AbstractMetaField *f,
const QString &query);
private:
QString m_packageName;
QString m_docDataDir;
QString m_libSourceDir;
QString execXQuery(QXmlQuery& xquery, const QString& query) const;
QString applyDocModifications(const DocModificationList& mods, const QString& xml) const;
QString applyDocModificationsLibXsl(const DocModificationList& mods, const QString& xml) const;
QString applyDocModificationsQt(const DocModificationList& mods, const QString& xml) const;
};
#endif // DOCPARSER_H
|
