summaryrefslogtreecommitdiffstats
path: root/src/corelib/global/qnativeinterface.h
blob: d32e2cd9820842049b110125e06b4c0c3016056f (plain)
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
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtCore module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** 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-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QNATIVEINTERFACE_H
#define QNATIVEINTERFACE_H

#include <QtCore/qglobal.h>
#include <QtCore/qloggingcategory.h>

#ifndef QT_STATIC
#  define Q_NATIVE_INTERFACE_EXPORT Q_DECL_EXPORT
#  define Q_NATIVE_INTERFACE_IMPORT Q_DECL_IMPORT
#else
#  define Q_NATIVE_INTERFACE_EXPORT
#  define Q_NATIVE_INTERFACE_IMPORT
#endif

QT_BEGIN_NAMESPACE

// We declare a virtual non-inline function in the form
// of the destructor, making it the key function. This
// ensures that the typeinfo of the class is exported.
// By being protected, we also ensure that pointers to
// the interface can't be deleted.
#define QT_DECLARE_NATIVE_INTERFACE_3(NativeInterface, Revision, BaseType) \
    protected: \
        virtual ~NativeInterface(); \
        struct TypeInfo { \
            using baseType = BaseType; \
            static constexpr char const *name = QT_STRINGIFY(NativeInterface); \
            static constexpr int revision = Revision; \
        }; \
    public: \

// Revisioned interfaces only make sense when exposed through a base
// type via QT_DECLARE_NATIVE_INTERFACE_ACCESSOR, as the revision
// checks happen at that level (and not for normal dynamic_casts).
#define QT_DECLARE_NATIVE_INTERFACE_2(NativeInterface, Revision) \
    static_assert(false, "Must provide a base type when specifying revision");

#define QT_DECLARE_NATIVE_INTERFACE_1(NativeInterface) \
    QT_DECLARE_NATIVE_INTERFACE_3(NativeInterface, 0, void)

#define QT_DECLARE_NATIVE_INTERFACE(...) \
    QT_OVERLOADED_MACRO(QT_DECLARE_NATIVE_INTERFACE, __VA_ARGS__)

namespace QNativeInterface::Private {
    template <typename NativeInterface>
    struct TypeInfo : private NativeInterface
    {
        static constexpr char const *name() { return NativeInterface::TypeInfo::name; }
        static constexpr int revision() { return NativeInterface::TypeInfo::revision; }

        template<typename BaseType>
        static constexpr bool isCompatibleWith =
            std::is_base_of<typename NativeInterface::TypeInfo::baseType, BaseType>::value;
    };

    template <typename T>
    Q_NATIVE_INTERFACE_IMPORT void *resolveInterface(const T *that, const char *name, int revision);

    Q_CORE_EXPORT Q_DECLARE_LOGGING_CATEGORY(lcNativeInterface)
}

// Declares an accessor for the native interface
#define QT_DECLARE_NATIVE_INTERFACE_ACCESSOR \
    template <typename I> \
    I *nativeInterface() const \
    { \
        using T = std::decay_t<decltype(*this)>; \
        using NativeInterface = QNativeInterface::Private::TypeInfo<I>; \
        static_assert(NativeInterface::template isCompatibleWith<T>, \
            "T::nativeInterface<I>() requires that native interface I is compatible with T"); \
        \
        return static_cast<I*>(QNativeInterface::Private::resolveInterface(this, \
            NativeInterface::name(), NativeInterface::revision())); \
    }

// Provides a definition for the interface destructor
#define QT_DEFINE_NATIVE_INTERFACE_2(Namespace, InterfaceClass) \
    QT_PREPEND_NAMESPACE(Namespace)::InterfaceClass::~InterfaceClass() = default

#define QT_DEFINE_NATIVE_INTERFACE(...) QT_OVERLOADED_MACRO(QT_DEFINE_NATIVE_INTERFACE, QNativeInterface, __VA_ARGS__)
#define QT_DEFINE_PRIVATE_NATIVE_INTERFACE(...) QT_OVERLOADED_MACRO(QT_DEFINE_NATIVE_INTERFACE, QNativeInterface::Private, __VA_ARGS__)

#define QT_NATIVE_INTERFACE_RETURN_IF(NativeInterface, baseType) \
    using QNativeInterface::Private::lcNativeInterface; \
    qCDebug(lcNativeInterface, "Comparing requested interface name %s with available %s", \
            name, TypeInfo<NativeInterface>::name()); \
    if (qstrcmp(name, TypeInfo<NativeInterface>::name()) == 0) { \
        qCDebug(lcNativeInterface, "Match for interface %s. Comparing revisions (requested %d / available %d)", \
            name, revision, TypeInfo<NativeInterface>::revision()); \
        if (revision == TypeInfo<NativeInterface>::revision()) { \
            qCDebug(lcNativeInterface) << "Full match. Returning dynamic cast of" << baseType; \
            return dynamic_cast<NativeInterface*>(baseType); \
        } else { \
            qCWarning(lcNativeInterface, "Native interface revision mismatch (requested %d / available %d) for interface %s", \
                revision, TypeInfo<NativeInterface>::revision(), name); \
            return nullptr; \
        } \
    }

QT_END_NAMESPACE

#endif // QNATIVEINTERFACE_H