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
|
/****************************************************************************
**
** Copyright (C) 2021 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$
**
****************************************************************************/
#include "abstractmetabuilder.h"
#include "abstractmetabuilder_p.h"
#include "abstractmetaenum.h"
#include "abstractmetalang.h"
#include "typesystem.h"
using QStringViewList = QList<QStringView>;
// Return a prefix to fully qualify value, eg:
// resolveScopePrefix("Class::NestedClass::Enum::Value1", "Enum::Value1")
// -> "Class::NestedClass::")
static QString resolveScopePrefixHelper(const QStringViewList &scopeList,
QStringView value)
{
QString name;
for (qsizetype i = scopeList.size() - 1 ; i >= 0; --i) {
const QString prefix = scopeList.at(i).toString() + u"::"_qs;
if (value.startsWith(prefix))
name.clear();
else
name.prepend(prefix);
}
return name;
}
QString AbstractMetaBuilder::resolveScopePrefix(const AbstractMetaClass *scope,
QStringView value)
{
if (!scope)
return {};
const QString &qualifiedCppName = scope->qualifiedCppName();
const QStringViewList scopeList =
QStringView{qualifiedCppName}.split(u"::"_qs, Qt::SkipEmptyParts);
return resolveScopePrefixHelper(scopeList, value);
}
// Return the scope for fully qualifying the enumeration value
static QString resolveEnumValueScopePrefix(const AbstractMetaEnum &metaEnum,
QStringView value)
{
const AbstractMetaClass *scope = metaEnum.enclosingClass();
if (!scope)
return {}; // global enum, value should work as is
const QString &qualifiedCppName = scope->qualifiedCppName();
const QString &enumName = metaEnum.name();
QStringViewList parts =
QStringView{qualifiedCppName}.split(u"::"_qs, Qt::SkipEmptyParts);
// Append the type (as required for enum classes) unless it is an anonymous enum.
if (!metaEnum.isAnonymous())
parts.append(QStringView{enumName});
return resolveScopePrefixHelper(parts, value);
}
static bool isQualifiedCppIdentifier(QStringView e)
{
return !e.isEmpty() && e.at(0).isLetter()
&& std::all_of(e.cbegin() + 1, e.cend(),
[](QChar c) { return c.isLetterOrNumber() || c == u'_' || c == u':'; });
}
static bool isIntegerConstant(const QStringView expr)
{
bool isNumber;
auto n = expr.toInt(&isNumber, /* guess base: 0x or decimal */ 0);
Q_UNUSED(n);
return isNumber;
}
static bool isFloatConstant(const QStringView expr)
{
bool isNumber;
auto d = expr.toDouble(&isNumber);
Q_UNUSED(d);
return isNumber;
}
// Fix an enum default value: Add the enum/flag scope or fully qualified name
// to the default value, making it usable from Python wrapper code outside the
// owner class hierarchy. See TestEnum::testEnumDefaultValues().
QString AbstractMetaBuilderPrivate::fixEnumDefault(const AbstractMetaType &type,
const QString &expr) const
{
// QFlags construct from integers, do not fix that
if (isIntegerConstant(expr))
return expr;
const auto *typeEntry = type.typeEntry();
const EnumTypeEntry *enumTypeEntry = nullptr;
const FlagsTypeEntry *flagsTypeEntry = nullptr;
if (typeEntry->isFlags()) {
flagsTypeEntry = static_cast<const FlagsTypeEntry *>(typeEntry);
enumTypeEntry = flagsTypeEntry->originator();
} else {
Q_ASSERT(typeEntry->isEnum());
enumTypeEntry = static_cast<const EnumTypeEntry *>(typeEntry);
}
// Use the enum's qualified name (would otherwise be "QFlags<Enum>")
if (!enumTypeEntry->qualifiedCppName().contains(u"::"))
return expr; // Global enum, nothing to fix here
// This is a somehow scoped enum
AbstractMetaEnum metaEnum = m_enums.value(enumTypeEntry);
if (isQualifiedCppIdentifier(expr)) // A single enum value
return resolveEnumValueScopePrefix(metaEnum, expr) + expr;
QString result;
// Is this a cast from integer or other type ("Enum(-1)" or "Options(0x10|0x20)"?
// Prepend the scope (assuming enum and flags are in the same scope).
auto parenPos = expr.indexOf(u'(');
const bool typeCast = parenPos != -1 && expr.endsWith(u')')
&& isQualifiedCppIdentifier(QStringView{expr}.left(parenPos));
if (typeCast) {
const QString prefix =
AbstractMetaBuilder::resolveScopePrefix(metaEnum.enclosingClass(), expr);
result += prefix;
parenPos += prefix.size();
}
result += expr;
// Extract "Option1 | Option2" from "Options(Option1 | Option2)"
QStringView innerExpression = typeCast
? QStringView{result}.mid(parenPos + 1, result.size() - parenPos - 2)
: QStringView{result};
// Quick check for number "Options(0x4)"
if (isIntegerConstant(innerExpression))
return result;
// Quick check for single enum value "Options(Option1)"
if (isQualifiedCppIdentifier(innerExpression)) {
const QString prefix = resolveEnumValueScopePrefix(metaEnum, innerExpression);
result.insert(parenPos + 1, prefix);
return result;
}
// Tokenize simple "A | B" expressions and qualify the enum values therein.
// Anything more complicated is left as is ATM.
if (!innerExpression.contains(u'|') || innerExpression.contains(u'&')
|| innerExpression.contains(u'^') || innerExpression.contains(u'(')
|| innerExpression.contains(u'~')) {
return result;
}
const QList<QStringView> tokens = innerExpression.split(u'|', Qt::SkipEmptyParts);
QStringList qualifiedTokens;
qualifiedTokens.reserve(tokens.size());
for (const auto &tokenIn : tokens) {
const auto token = tokenIn.trimmed();
QString qualified = token.toString();
if (!isIntegerConstant(token) && isQualifiedCppIdentifier(token))
qualified.prepend(resolveEnumValueScopePrefix(metaEnum, token));
qualifiedTokens.append(qualified);
}
const QString qualifiedExpression = qualifiedTokens.join(u" | "_qs);
if (!typeCast)
return qualifiedExpression;
result.replace(parenPos + 1, innerExpression.size(), qualifiedExpression);
return result;
}
bool AbstractMetaBuilder::dontFixDefaultValue(QStringView expr)
{
return expr.isEmpty() || expr == u"{}" || expr == u"nullptr"
|| expr == u"NULL" || expr == u"true" || expr == u"false"
|| (expr.startsWith(u'{') && expr.startsWith(u'}')) // initializer list
|| (expr.startsWith(u'[') && expr.startsWith(u']')) // array
|| expr.startsWith(u"Qt::") // Qt namespace constant
|| isIntegerConstant(expr) || isFloatConstant(expr);
}
|
