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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of PySide2.
**
** $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 DOCGENERATOR_H
#define DOCGENERATOR_H
#include <QtCore/QStack>
#include <QtCore/QHash>
#include <QtCore/QScopedPointer>
#include <QtCore/QTextStream>
#include <QXmlStreamReader>
#include "generator.h"
#include "docparser.h"
#include "typesystem_enums.h"
#include "typesystem_typedefs.h"
class QtDocParser;
class AbstractMetaFunction;
class AbstractMetaClass;
QT_BEGIN_NAMESPACE
class QXmlStreamReader;
QT_END_NAMESPACE
class QtDocGenerator;
class QtXmlToSphinx
{
public:
struct InlineImage
{
QString tag;
QString href;
};
struct TableCell
{
short rowSpan;
short colSpan;
QString data;
TableCell(const QString& text = QString()) : rowSpan(0), colSpan(0), data(text) {}
TableCell(const char* text) : rowSpan(0), colSpan(0), data(QLatin1String(text)) {}
};
typedef QList<TableCell> TableRow;
class Table : public QList<TableRow>
{
public:
Table() : m_hasHeader(false), m_normalized(false)
{
}
void enableHeader(bool enable)
{
m_hasHeader = enable;
}
bool hasHeader() const
{
return m_hasHeader;
}
void normalize();
bool isNormalized() const
{
return m_normalized;
}
void clear() {
m_normalized = false;
QList<TableRow>::clear();
}
private:
bool m_hasHeader;
bool m_normalized;
};
QtXmlToSphinx(QtDocGenerator* generator, const QString& doc, const QString& context = QString());
QString result() const
{
return m_result;
}
private:
struct LinkContext
{
LinkContext(const QString &ref, const QString &lType) : linkRef(ref), type(lType) {}
QString linkTag;
QString linkRef;
QString linkText;
QString linkTagEnding;
QString type;
};
QString resolveContextForMethod(const QString& methodName) const;
QString expandFunction(const QString& function) const;
QString transform(const QString& doc);
void handleHeadingTag(QXmlStreamReader& reader);
void handleParaTag(QXmlStreamReader& reader);
void handleItalicTag(QXmlStreamReader& reader);
void handleBoldTag(QXmlStreamReader& reader);
void handleArgumentTag(QXmlStreamReader& reader);
void handleSeeAlsoTag(QXmlStreamReader& reader);
void handleSnippetTag(QXmlStreamReader& reader);
void handleDotsTag(QXmlStreamReader& reader);
void handleLinkTag(QXmlStreamReader& reader);
void handleImageTag(QXmlStreamReader& reader);
void handleInlineImageTag(QXmlStreamReader& reader);
void handleListTag(QXmlStreamReader& reader);
void handleTermTag(QXmlStreamReader& reader);
void handleSuperScriptTag(QXmlStreamReader& reader);
void handleQuoteFileTag(QXmlStreamReader& reader);
// table tagsvoid QtXmlToSphinx::handleValueTag(QXmlStreamReader& reader)
void handleTableTag(QXmlStreamReader& reader);
void handleRowTag(QXmlStreamReader& reader);
void handleItemTag(QXmlStreamReader& reader);
void handleRawTag(QXmlStreamReader& reader);
void handleCodeTag(QXmlStreamReader& reader);
void handleIgnoredTag(QXmlStreamReader& reader);
void handleUnknownTag(QXmlStreamReader& reader);
void handleUselessTag(QXmlStreamReader& reader);
void handleAnchorTag(QXmlStreamReader& reader);
LinkContext *handleLinkStart(const QString &type, const QString &ref) const;
void handleLinkText(LinkContext *linkContext, QString linktext) const;
void handleLinkEnd(LinkContext *linkContext);
typedef void (QtXmlToSphinx::*TagHandler)(QXmlStreamReader&);
QHash<QString, TagHandler> m_handlerMap;
QStack<TagHandler> m_handlers;
QTextStream m_output;
QString m_result;
QStack<QString*> m_buffers;
Table m_currentTable;
QScopedPointer<LinkContext> m_linkContext; // for <link>
QScopedPointer<LinkContext> m_seeAlsoContext; // for <see-also>foo()</see-also>
bool m_tableHasHeader;
QString m_context;
QtDocGenerator* m_generator;
bool m_insideBold;
bool m_insideItalic;
QString m_lastTagName;
QString m_opened_anchor;
QVector<InlineImage> m_inlineImages;
QString readFromLocations(const QStringList &locations, const QString &path,
const QString &identifier, QString *errorMessage);
QString readFromLocation(const QString &location, const QString &identifier,
QString *errorMessage);
void pushOutputBuffer();
QString popOutputBuffer();
void writeTable(Table& table);
bool copyImage(const QString &href) const;
};
inline QTextStream& operator<<(QTextStream& s, const QtXmlToSphinx& xmlToSphinx)
{
return s << xmlToSphinx.result();
}
QTextStream& operator<<(QTextStream& s, const QtXmlToSphinx::Table &table);
/**
* The DocGenerator generates documentation from library being binded.
*/
class QtDocGenerator : public Generator
{
public:
QtDocGenerator();
~QtDocGenerator();
QString libSourceDir() const
{
return m_libSourceDir;
}
QString docDataDir() const { return m_docDataDir; }
bool doSetup(const QMap<QString, QString>& args) override;
const char* name() const override
{
return "QtDocGenerator";
}
OptionDescriptions options() const override;
QStringList codeSnippetDirs() const
{
return m_codeSnippetDirs;
}
bool shouldGenerate(const AbstractMetaClass *) const override;
protected:
QString fileNameSuffix() const override;
QString fileNameForContext(GeneratorContext &context) const override;
void generateClass(QTextStream &s, GeneratorContext &classContext) override;
bool finishGeneration() override;
void writeFunctionArguments(QTextStream&, const AbstractMetaFunction*, Options) const override {}
void writeArgumentNames(QTextStream&, const AbstractMetaFunction*, Options) const override {}
private:
void writeEnums(QTextStream& s, const AbstractMetaClass* cppClass);
void writeFields(QTextStream &s, const AbstractMetaClass *cppClass);
void writeArguments(QTextStream &s, const AbstractMetaClass *cppClass, const AbstractMetaFunction *func);
void writeFunctionSignature(QTextStream& s, const AbstractMetaClass* cppClass, const AbstractMetaFunction* func);
void writeFunction(QTextStream& s, bool writeDoc, const AbstractMetaClass* cppClass, const AbstractMetaFunction* func);
void writeFunctionParametersType(QTextStream &s, const AbstractMetaClass *cppClass,
const AbstractMetaFunction* func);
void writeFunctionList(QTextStream& s, const AbstractMetaClass* cppClass);
void writeFunctionBlock(QTextStream& s, const QString& title, QStringList& functions);
void writeParameterType(QTextStream &s, const AbstractMetaClass *cppClass, const AbstractMetaArgument *arg);
void writeConstructors(QTextStream &s, const AbstractMetaClass *cppClass);
void writeFormattedText(QTextStream &s, const Documentation &doc,
const AbstractMetaClass *metaclass = nullptr);
bool writeInjectDocumentation(QTextStream& s, TypeSystem::DocModificationMode mode, const AbstractMetaClass* cppClass, const AbstractMetaFunction* func);
void writeDocSnips(QTextStream &s, const CodeSnipList &codeSnips, TypeSystem::CodeSnipPosition position, TypeSystem::Language language);
QString parseArgDocStyle(const AbstractMetaClass *cppClass, const AbstractMetaFunction *func);
QString translateToPythonType(const AbstractMetaType *type, const AbstractMetaClass *cppClass);
QString m_docDataDir;
QString m_libSourceDir;
QStringList m_codeSnippetDirs;
QString m_extraSectionDir;
QStringList m_functionList;
QMap<QString, QStringList> m_packages;
DocParser* m_docParser;
};
#endif // DOCGENERATOR_H
|
