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
|
/****************************************************************************
**
** 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 OVERLOADDATA_H
#define OVERLOADDATA_H
#include <apiextractorresult.h>
#include <QtCore/QBitArray>
#include <QtCore/QList>
#include <QtCore/QSharedPointer>
QT_FORWARD_DECLARE_CLASS(QDebug)
QT_FORWARD_DECLARE_CLASS(QTextStream)
class OverloadDataNode;
using OverloadDataNodePtr = QSharedPointer<OverloadDataNode>;
using OverloadDataList = QList<OverloadDataNodePtr>;
/// The root node of OverloadData. It contains all functions
class OverloadDataRootNode
{
public:
virtual ~OverloadDataRootNode();
OverloadDataRootNode(const OverloadDataRootNode &) = delete;
OverloadDataRootNode &operator=(const OverloadDataRootNode &) = delete;
OverloadDataRootNode(OverloadDataRootNode &&) = delete;
OverloadDataRootNode &operator=(OverloadDataRootNode &&) = delete;
virtual int argPos() const { return -1; }
virtual const OverloadDataRootNode *parent() const { return nullptr; }
bool isRoot() const { return parent() == nullptr; }
AbstractMetaFunctionCPtr referenceFunction() const;
const AbstractMetaFunctionCList &overloads() const { return m_overloads; }
const OverloadDataList &children() const { return m_children; }
bool nextArgumentHasDefaultValue() const;
/// Returns the function that has a default value at the current OverloadData argument position, otherwise returns null.
AbstractMetaFunctionCPtr getFunctionWithDefaultValue() const;
/// Returns the nearest occurrence, including this instance, of an argument with a default value.
const OverloadDataRootNode *findNextArgWithDefault();
bool isFinalOccurrence(const AbstractMetaFunctionCPtr &func) const;
int functionNumber(const AbstractMetaFunctionCPtr &func) const;
#ifndef QT_NO_DEBUG_STREAM
virtual void formatDebug(QDebug &d) const;
#endif
OverloadDataNode *addOverloadDataNode(const AbstractMetaFunctionCPtr &func,
const AbstractMetaArgument &arg);
protected:
OverloadDataRootNode(const AbstractMetaFunctionCList &o= {});
void dumpRootGraph(QTextStream &s, int minArgs, int maxArgs) const;
void sortNextOverloads(const ApiExtractorResult &api);
#ifndef QT_NO_DEBUG_STREAM
void formatReferenceFunction(QDebug &d) const;
void formatOverloads(QDebug &d) const;
void formatNextOverloadData(QDebug &d) const;
#endif
AbstractMetaFunctionCList m_overloads;
OverloadDataList m_children;
};
/// OverloadDataNode references an argument/type combination.
class OverloadDataNode : public OverloadDataRootNode
{
public:
explicit OverloadDataNode(const AbstractMetaFunctionCPtr &func,
OverloadDataRootNode *parent,
const AbstractMetaType &argType, int argPos,
const QString argTypeReplaced = {});
void addOverload(const AbstractMetaFunctionCPtr &func);
int argPos() const override { return m_argPos; }
const OverloadDataRootNode *parent() const override;
void dumpNodeGraph(QTextStream &s) const;
const AbstractMetaType &argType() const { return m_argType; }
bool hasArgumentTypeReplace() const { return !m_argTypeReplaced.isEmpty(); }
const QString &argumentTypeReplaced() const { return m_argTypeReplaced; }
const AbstractMetaArgument *argument(const AbstractMetaFunctionCPtr &func) const;
#ifndef QT_NO_DEBUG_STREAM
void formatDebug(QDebug &d) const override;
#endif
private:
AbstractMetaType m_argType;
QString m_argTypeReplaced;
OverloadDataRootNode *m_parent = nullptr;
int m_argPos = -1;
};
class OverloadData : public OverloadDataRootNode
{
public:
explicit OverloadData(const AbstractMetaFunctionCList &overloads,
const ApiExtractorResult &api);
int minArgs() const { return m_minArgs; }
int maxArgs() const { return m_maxArgs; }
/// Returns true if any of the overloads for the current OverloadData has a return type different from void.
bool hasNonVoidReturnType() const;
/// Returns true if any of the overloads for the current OverloadData has a varargs argument.
bool hasVarargs() const;
/// Returns true if any of the overloads for the current OverloadData is static.
bool hasStaticFunction() const;
/// Returns true if any of the overloads passed as argument is static.
static bool hasStaticFunction(const AbstractMetaFunctionCList &overloads);
/// Returns true if any of the overloads for the current OverloadData is classmethod.
bool hasClassMethod() const;
/// Returns true if any of the overloads passed as argument is classmethod.
static bool hasClassMethod(const AbstractMetaFunctionCList &overloads);
/// Returns true if any of the overloads for the current OverloadData is not static.
bool hasInstanceFunction() const;
/// Returns true if any of the overloads passed as argument is not static.
static bool hasInstanceFunction(const AbstractMetaFunctionCList &overloads);
/// Returns true if among the overloads for the current OverloadData there are static and non-static methods altogether.
bool hasStaticAndInstanceFunctions() const;
/// Returns true if among the overloads passed as argument there are static and non-static methods altogether.
static bool hasStaticAndInstanceFunctions(const AbstractMetaFunctionCList &overloads);
QList<int> invalidArgumentLengths() const;
static int numberOfRemovedArguments(const AbstractMetaFunctionCPtr &func);
static int numberOfRemovedArguments(const AbstractMetaFunctionCPtr &func, int finalArgPos);
void dumpGraph(const QString &filename) const;
QString dumpGraph() const;
bool showGraph() const;
/// Returns true if a list of arguments is used (METH_VARARGS)
bool pythonFunctionWrapperUsesListOfArguments() const;
bool hasArgumentWithDefaultValue() const;
static bool hasArgumentWithDefaultValue(const AbstractMetaFunctionCPtr &func);
/// Returns a list of function arguments which have default values and were not removed.
static AbstractMetaArgumentList getArgumentsWithDefaultValues(const AbstractMetaFunctionCPtr &func);
#ifndef QT_NO_DEBUG_STREAM
void formatDebug(QDebug &) const override;
#endif
private:
int m_minArgs = 256;
int m_maxArgs = 0;
};
#ifndef QT_NO_DEBUG_STREAM
QDebug operator<<(QDebug, const OverloadData &);
#endif
#endif // OVERLOADDATA_H
|
