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
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of PySide2.
**
** $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 SBKENUM_H
#define SBKENUM_H
#include "sbkpython.h"
#include "shibokenmacros.h"
extern "C"
{
extern LIBSHIBOKEN_API PyTypeObject SbkEnumType_Type;
struct SbkObjectType;
struct SbkConverter;
} // extern "C"
namespace Shiboken
{
inline bool isShibokenEnum(PyObject* pyObj)
{
return Py_TYPE(pyObj->ob_type) == &SbkEnumType_Type;
}
namespace Enum
{
LIBSHIBOKEN_API bool check(PyObject* obj);
/**
* Creates a new enum type (and its flags type, if any is given)
* and registers it to Python and adds it to \p module.
* \param module Module to where the new enum type will be added.
* \param name Name of the enum.
* \param fullName Name of the enum that includes all scope information (e.g.: "module.Enum").
* \param cppName Full qualified C++ name of the enum.
* \param flagsType Optional Python type for the flags associated with the enum.
* \return The new enum type or NULL if it fails.
*/
LIBSHIBOKEN_API PyTypeObject* createGlobalEnum(PyObject* module,
const char* name,
const char* fullName,
const char* cppName,
PyTypeObject* flagsType = 0);
/// This function does the same as createGlobalEnum, but adds the enum to a Shiboken type or namespace.
LIBSHIBOKEN_API PyTypeObject* createScopedEnum(SbkObjectType* scope,
const char* name,
const char* fullName,
const char* cppName,
PyTypeObject* flagsType = 0);
/**
* Creates a new enum item for a given enum type and adds it to \p module.
* \param enumType Enum type to where the new enum item will be added.
* \param module Module to where the enum type of the new enum item belongs.
* \param itemName Name of the enum item.
* \param itemValue Numerical value of the enum item.
* \return true if everything goes fine, false if it fails.
*/
LIBSHIBOKEN_API bool createGlobalEnumItem(PyTypeObject* enumType, PyObject* module, const char* itemName, long itemValue);
/// This function does the same as createGlobalEnumItem, but adds the enum to a Shiboken type or namespace.
LIBSHIBOKEN_API bool createScopedEnumItem(PyTypeObject* enumType, SbkObjectType* scope, const char* itemName, long itemValue);
LIBSHIBOKEN_API PyObject* newItem(PyTypeObject* enumType, long itemValue, const char* itemName = 0);
/// \deprecated Use 'newTypeWithName'
SBK_DEPRECATED(LIBSHIBOKEN_API PyTypeObject* newType(const char* name));
LIBSHIBOKEN_API PyTypeObject* newTypeWithName(const char* name, const char* cppName);
LIBSHIBOKEN_API const char* getCppName(PyTypeObject* type);
LIBSHIBOKEN_API long getValue(PyObject* enumItem);
LIBSHIBOKEN_API PyObject* getEnumItemFromValue(PyTypeObject* enumType, long itemValue);
/// Sets the enum's type converter.
LIBSHIBOKEN_API void setTypeConverter(PyTypeObject* enumType, SbkConverter* converter);
/// Returns the converter assigned to the enum \p type.
LIBSHIBOKEN_API SbkConverter* getTypeConverter(PyTypeObject* enumType);
}
} // namespace Shiboken
#endif // SKB_PYENUM_H
|
