blob: 857748c2f71e94f1b08506031bc0034af7d0b838 (
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
|
// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#ifndef PYOBJECTHOLDER_H
#define PYOBJECTHOLDER_H
#include "sbkpython.h"
#include <cassert>
#include <utility>
namespace Shiboken
{
/// PyObjectHolder holds a PyObject pointer, keeping a reference decrementing
/// its reference counter when destroyed. It makes sure to hold the GIL when
/// releasing. It implements copy/move semantics and is mainly intended as a
/// base class for functors holding a callable which can be passed around and
/// stored in containers or moved from freely.
/// For one-shot functors, release() can be invoked after the call.
class PyObjectHolder
{
public:
PyObjectHolder() noexcept = default;
/// PyObjectHolder constructor.
/// \param pyobj A reference to a Python object
explicit PyObjectHolder(PyObject *pyObj) noexcept : m_pyObj(pyObj)
{
assert(pyObj != nullptr);
Py_INCREF(m_pyObj);
}
PyObjectHolder(const PyObjectHolder &o) noexcept : m_pyObj(o.m_pyObj)
{
Py_XINCREF(m_pyObj);
}
PyObjectHolder &operator=(const PyObjectHolder &o) noexcept
{
if (this != &o) {
m_pyObj = o.m_pyObj;
Py_XINCREF(m_pyObj);
}
return *this;
}
PyObjectHolder(PyObjectHolder &&o) noexcept : m_pyObj{std::exchange(o.m_pyObj, nullptr)} {}
PyObjectHolder &operator=(PyObjectHolder &&o) noexcept
{
m_pyObj = std::exchange(o.m_pyObj, nullptr);
return *this;
}
/// Decref the python reference
~PyObjectHolder() { release(); }
[[nodiscard]] bool isNull() const { return m_pyObj == nullptr; }
[[nodiscard]] operator bool() const { return m_pyObj != nullptr; }
/// Returns the pointer of the Python object being held.
[[nodiscard]] PyObject *object() const { return m_pyObj; }
[[nodiscard]] operator PyObject *() const { return m_pyObj; }
[[nodiscard]] PyObject *operator->() { return m_pyObj; }
protected:
void release()
{
if (m_pyObj != nullptr) {
assert(Py_IsInitialized());
auto gstate = PyGILState_Ensure();
Py_DECREF(m_pyObj);
PyGILState_Release(gstate);
m_pyObj = nullptr;
}
}
private:
PyObject *m_pyObj = nullptr;
};
} // namespace Shiboken
#endif // PYOBJECTHOLDER_H
|
