summaryrefslogtreecommitdiffstats
path: root/src/corelib/plugin/qplugin_p.h
blob: 026992ba97d267f634131c43e5c270c37dc38f77 (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
/****************************************************************************
**
** Copyright (C) 2018 Intel Corporation.
** 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 QPLUGIN_P_H
#define QPLUGIN_P_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists for the convenience
// of the QLibrary class.  This header file may change from
// version to version without notice, or even be removed.
//
// We mean it.
//

#include <private/qglobal_p.h>

QT_BEGIN_NAMESPACE

enum class QtPluginMetaDataKeys {
    QtVersion,
    Requirements,
    IID,
    ClassName,
    MetaData,
    URI,
    IsDebug,
};

// F(IntKey, StringKey, Description)
// Keep this list sorted in the order moc should output.
#define QT_PLUGIN_FOREACH_METADATA(F) \
    F(QtPluginMetaDataKeys::IID, "IID", "Plugin's Interface ID")                \
    F(QtPluginMetaDataKeys::ClassName, "className", "Plugin class name")        \
    F(QtPluginMetaDataKeys::MetaData, "MetaData", "Other meta data")            \
    F(QtPluginMetaDataKeys::URI, "URI", "Plugin URI")                           \
    /* not output by moc in CBOR */                                             \
    F(QtPluginMetaDataKeys::QtVersion, "version", "Qt version")                 \
    F(QtPluginMetaDataKeys::Requirements, "archlevel", "Architectural level")   \
    F(QtPluginMetaDataKeys::IsDebug, "debug", "Debug-mode plugin")              \
    /**/

namespace {
struct DecodedArchRequirements
{
    quint8 level;
    bool isDebug;
    friend constexpr bool operator==(DecodedArchRequirements r1, DecodedArchRequirements r2)
    {
        return r1.level == r2.level && r1.isDebug == r2.isDebug;
    }
};

static constexpr DecodedArchRequirements decodeVersion0ArchRequirements(quint8 value)
{
    // see qPluginArchRequirements() and QPluginMetaDataV2::archRequirements()
    DecodedArchRequirements r = {};
#ifdef Q_PROCESSOR_X86
    if (value & 4)
        r.level = 4;            // AVX512F -> x86-64-v4
    else if (value & 2)
        r.level = 3;            // AVX2 -> x86-64-v3
#endif
    if (value & 1)
        r.isDebug = true;
    return r;
}
// self checks
static_assert(decodeVersion0ArchRequirements(0) == DecodedArchRequirements{ 0, false });
static_assert(decodeVersion0ArchRequirements(1) == DecodedArchRequirements{ 0, true });
#ifdef Q_PROCESSOR_X86
static_assert(decodeVersion0ArchRequirements(2) == DecodedArchRequirements{ 3, false });
static_assert(decodeVersion0ArchRequirements(3) == DecodedArchRequirements{ 3, true });
static_assert(decodeVersion0ArchRequirements(4) == DecodedArchRequirements{ 4, false });
static_assert(decodeVersion0ArchRequirements(5) == DecodedArchRequirements{ 4, true });
#endif

static constexpr DecodedArchRequirements decodeVersion1ArchRequirements(quint8 value)
{
    return { quint8(value & 0x7f), bool(value & 0x80) };
}
// self checks
static_assert(decodeVersion1ArchRequirements(0) == DecodedArchRequirements{ 0, false });
static_assert(decodeVersion1ArchRequirements(0x80) == DecodedArchRequirements{ 0, true });
#ifdef Q_PROCESSOR_X86
static_assert(decodeVersion1ArchRequirements(1) == DecodedArchRequirements{ 1, false });
static_assert(decodeVersion1ArchRequirements(3) == DecodedArchRequirements{ 3, false});
static_assert(decodeVersion1ArchRequirements(4) == DecodedArchRequirements{ 4, false });
static_assert(decodeVersion1ArchRequirements(0x82) == DecodedArchRequirements{ 2, true });
static_assert(decodeVersion1ArchRequirements(0x84) == DecodedArchRequirements{ 4, true });
#endif
} // unnamed namespace

QT_END_NAMESPACE

#endif // QPLUGIN_P_H