diff options
Diffstat (limited to 'sources/shiboken6/ApiExtractor/typedatabase.h')
| -rw-r--r-- | sources/shiboken6/ApiExtractor/typedatabase.h | 224 |
1 files changed, 224 insertions, 0 deletions
diff --git a/sources/shiboken6/ApiExtractor/typedatabase.h b/sources/shiboken6/ApiExtractor/typedatabase.h new file mode 100644 index 000000000..fff301c6e --- /dev/null +++ b/sources/shiboken6/ApiExtractor/typedatabase.h @@ -0,0 +1,224 @@ +/**************************************************************************** +** +** 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 TYPEDATABASE_H +#define TYPEDATABASE_H + +#include "apiextractormacros.h" +#include "include.h" +#include "typedatabase_typedefs.h" +#include "typesystem_enums.h" +#include "typesystem_typedefs.h" + +#include <QtCore/QRegularExpression> +#include <QtCore/QStringList> +#include <QtCore/QVersionNumber> + +QT_FORWARD_DECLARE_CLASS(QIODevice) + +class ComplexTypeEntry; +class ContainerTypeEntry; +class FlagsTypeEntry; +class FunctionTypeEntry; +class NamespaceTypeEntry; +class ObjectTypeEntry; +class TemplateEntry; +class TypeEntry; + +struct TypeRejection; + +QT_FORWARD_DECLARE_CLASS(QDebug) + +int getMaxTypeIndex(); + +class ContainerTypeEntry; +class PrimitiveTypeEntry; +class TypeSystemTypeEntry; + +struct VersionRange +{ + bool isNull() const + { + return since.majorVersion() == 0 && since.minorVersion() == 0 + && until.majorVersion() == 9999 && until.minorVersion() == 9999; + } + + QVersionNumber since{0, 0}; + QVersionNumber until{9999, 9999}; +}; + +class TypeDatabase +{ + TypeDatabase(); + Q_DISABLE_COPY(TypeDatabase) +public: + ~TypeDatabase(); + + /** + * Return the type system instance. + * \param newInstance This parameter is useful just for unit testing, because singletons causes + * too many side effects on unit testing. + */ + static TypeDatabase *instance(bool newInstance = false); + + static QString normalizedSignature(const QString &signature); + + QStringList requiredTargetImports() const; + + void addRequiredTargetImport(const QString &moduleName); + + void addTypesystemPath(const QString &typesystem_paths); + + IncludeList extraIncludes(const QString &className) const; + + const QByteArrayList &systemIncludes() const { return m_systemIncludes; } + void addSystemInclude(const QString &name); + + void addInlineNamespaceLookups(const NamespaceTypeEntry *n); + + PrimitiveTypeEntry *findPrimitiveType(const QString &name) const; + ComplexTypeEntry *findComplexType(const QString &name) const; + ObjectTypeEntry *findObjectType(const QString &name) const; + NamespaceTypeEntryList findNamespaceTypes(const QString &name) const; + NamespaceTypeEntry *findNamespaceType(const QString &name, const QString &fileName = QString()) const; + ContainerTypeEntry *findContainerType(const QString &name) const; + FunctionTypeEntry *findFunctionType(const QString &name) const; + const TypeSystemTypeEntry *findTypeSystemType(const QString &name) const; + const TypeSystemTypeEntry *defaultTypeSystemType() const; + QString defaultPackageName() const; + + TypeEntry *findType(const QString &name) const; + TypeEntries findTypes(const QString &name) const; + TypeEntries findCppTypes(const QString &name) const; + + const TypeEntryMultiMap &entries() const { return m_entries; } + const TypedefEntryMap &typedefEntries() const { return m_typedefEntries; } + + PrimitiveTypeEntryList primitiveTypes() const; + + ContainerTypeEntryList containerTypes() const; + + void addRejection(const TypeRejection &); + bool isClassRejected(const QString &className, QString *reason = nullptr) const; + bool isFunctionRejected(const QString &className, const QString &functionName, + QString *reason = nullptr) const; + bool isFieldRejected(const QString &className, const QString &fieldName, + QString *reason = nullptr) const; + bool isEnumRejected(const QString &className, const QString &enumName, + QString *reason = nullptr) const; + bool isArgumentTypeRejected(const QString &className, const QString &typeName, + QString *reason = nullptr) const; + bool isReturnTypeRejected(const QString &className, const QString &typeName, + QString *reason = nullptr) const; + + bool addType(TypeEntry *e, QString *errorMessage = nullptr); + ConstantValueTypeEntry *addConstantValueTypeEntry(const QString &value, + const TypeEntry *parent); + void addTypeSystemType(const TypeSystemTypeEntry *e); + + FlagsTypeEntry *findFlagsType(const QString &name) const; + void addFlagsType(FlagsTypeEntry *fte); + + TemplateEntry *findTemplate(const QString &name) const { return m_templates[name]; } + + void addTemplate(TemplateEntry *t); + + AddedFunctionList globalUserFunctions() const { return m_globalUserFunctions; } + + void addGlobalUserFunctions(const AddedFunctionList &functions); + + AddedFunctionList findGlobalUserFunctions(const QString &name) const; + + void addGlobalUserFunctionModifications(const FunctionModificationList &functionModifications); + + FunctionModificationList functionModifications(const QString &signature) const; + + void setSuppressWarnings(bool on) { m_suppressWarnings = on; } + + bool addSuppressedWarning(const QString &warning, QString *errorMessage); + + bool isSuppressedWarning(QStringView s) const; + + static QString globalNamespaceClassName(const TypeEntry *te); + + bool parseFile(const QString &filename, bool generate = true); + bool parseFile(const QString &filename, const QString ¤tPath, bool generate); + + bool parseFile(QIODevice *device, bool generate = true); + + static bool setApiVersion(const QString &package, const QString &version); + static void clearApiVersions(); + + static bool checkApiVersion(const QString &package, const VersionRange &vr); + + bool hasDroppedTypeEntries() const { return !m_dropTypeEntries.isEmpty(); } + + bool shouldDropTypeEntry(const QString &fullTypeName) const; + + void setDropTypeEntries(QStringList dropTypeEntries); + + QString modifiedTypesystemFilepath(const QString &tsFile, const QString ¤tPath = QString()) const; + +#ifndef QT_NO_DEBUG_STREAM + void formatDebug(QDebug &d) const; +#endif +private: + TypeEntryMultiMapConstIteratorRange findTypeRange(const QString &name) const; + template <class Predicate> + TypeEntries findTypesHelper(const QString &name, Predicate pred) const; + TypeEntry *resolveTypeDefEntry(TypedefEntry *typedefEntry, QString *errorMessage); + template <class String> + bool isSuppressedWarningHelper(const String &s) const; + + bool m_suppressWarnings = true; + TypeEntryMultiMap m_entries; // Contains duplicate entries (cf addInlineNamespaceLookups). + TypeEntryMap m_flagsEntries; + TypedefEntryMap m_typedefEntries; + TemplateEntryMap m_templates; + QVector<QRegularExpression> m_suppressedWarnings; + QVector<const TypeSystemTypeEntry *> m_typeSystemEntries; // maintain order, default is first. + + AddedFunctionList m_globalUserFunctions; + FunctionModificationList m_functionMods; + + QStringList m_requiredTargetImports; + + QStringList m_typesystemPaths; + QHash<QString, bool> m_parsedTypesystemFiles; + + QVector<TypeRejection> m_rejections; + + QStringList m_dropTypeEntries; + QByteArrayList m_systemIncludes; +}; + +#ifndef QT_NO_DEBUG_STREAM +QDebug operator<<(QDebug d, const TypeEntry *te); +QDebug operator<<(QDebug d, const TypeDatabase &db); +#endif +#endif // TYPEDATABASE_H |