aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken6/ApiExtractor/apiextractorresult.h
diff options
context:
space:
mode:
Diffstat (limited to 'sources/shiboken6/ApiExtractor/apiextractorresult.h')
-rw-r--r--sources/shiboken6/ApiExtractor/apiextractorresult.h75
1 files changed, 75 insertions, 0 deletions
diff --git a/sources/shiboken6/ApiExtractor/apiextractorresult.h b/sources/shiboken6/ApiExtractor/apiextractorresult.h
new file mode 100644
index 000000000..5d30073e9
--- /dev/null
+++ b/sources/shiboken6/ApiExtractor/apiextractorresult.h
@@ -0,0 +1,75 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 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 APIEXTRACTORRESULT_H
+#define APIEXTRACTORRESULT_H
+
+#include "abstractmetalang.h"
+#include "abstractmetaenum.h"
+#include "abstractmetatype.h"
+#include "typesystem_typedefs.h"
+
+#include <QtCore/QHash>
+
+#include <optional>
+
+/// Result of an ApiExtractor run.
+/// Note: The class lists in here are flat, non-owning lists, currently
+/// (pending introduction of QSharedPointer for AbstractMetaClass); the
+/// ApiExtractor/AbstractMetaBuilder must be kept alive during the
+/// generator run since it owns the classes.
+class ApiExtractorResult
+{
+ friend class ApiExtractor;
+public:
+ const AbstractMetaEnumList &globalEnums() const { return m_globalEnums; }
+ const AbstractMetaFunctionCList &globalFunctions() const { return m_globalFunctions; }
+ const AbstractMetaClassList &classes() const { return m_metaClasses; }
+ const AbstractMetaClassList &smartPointers() const { return m_smartPointers; }
+
+ // Query functions for the generators
+ std::optional<AbstractMetaEnum> findAbstractMetaEnum(const TypeEntry* typeEntry) const;
+
+ /// Retrieves a list of constructors used in implicit conversions
+ /// available on the given type. The TypeEntry must be a value-type
+ /// or else it will return an empty list.
+ /// \param type a TypeEntry that is expected to be a value-type
+ /// \return a list of constructors that could be used as implicit converters
+ AbstractMetaFunctionCList implicitConversions(const TypeEntry *type) const;
+ AbstractMetaFunctionCList implicitConversions(const AbstractMetaType &metaType) const;
+
+private:
+ AbstractMetaClassList m_metaClasses;
+ AbstractMetaClassList m_smartPointers;
+ AbstractMetaFunctionCList m_globalFunctions;
+ AbstractMetaEnumList m_globalEnums;
+
+ QHash<const TypeEntry *, AbstractMetaEnum> m_enums;
+};
+
+#endif // APIEXTRACTORRESULT_H