| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497 |
- // Header file providing new C API functions to old Python versions.
- //
- // File distributed under the Zero Clause BSD (0BSD) license.
- // Copyright Contributors to the pythoncapi_compat project.
- //
- // Homepage:
- // https://github.com/python/pythoncapi_compat
- //
- // Latest version:
- // https://raw.githubusercontent.com/python/pythoncapi_compat/master/pythoncapi_compat.h
- //
- // SPDX-License-Identifier: 0BSD
- #ifndef PYTHONCAPI_COMPAT
- #define PYTHONCAPI_COMPAT
- #ifdef __cplusplus
- extern "C" {
- #endif
- #include <Python.h>
- #include "frameobject.h" // PyFrameObject, PyFrame_GetBack()
- // Compatibility with Visual Studio 2013 and older which don't support
- // the inline keyword in C (only in C++): use __inline instead.
- #if (defined(_MSC_VER) && _MSC_VER < 1900 \
- && !defined(__cplusplus) && !defined(inline))
- # define PYCAPI_COMPAT_STATIC_INLINE(TYPE) static __inline TYPE
- #else
- # define PYCAPI_COMPAT_STATIC_INLINE(TYPE) static inline TYPE
- #endif
- // C++ compatibility: _Py_CAST() and _Py_NULL
- #ifndef _Py_CAST
- # ifdef __cplusplus
- # define _Py_CAST(type, expr) \
- const_cast<type>(reinterpret_cast<const type>(expr))
- # else
- # define _Py_CAST(type, expr) ((type)(expr))
- # endif
- #endif
- #ifndef _Py_NULL
- # ifdef __cplusplus
- # define _Py_NULL nullptr
- # else
- # define _Py_NULL NULL
- # endif
- #endif
- // Cast argument to PyObject* type.
- #ifndef _PyObject_CAST
- # define _PyObject_CAST(op) _Py_CAST(PyObject*, op)
- #endif
- // bpo-42262 added Py_NewRef() to Python 3.10.0a3
- #if PY_VERSION_HEX < 0x030A00A3 && !defined(Py_NewRef)
- PYCAPI_COMPAT_STATIC_INLINE(PyObject*)
- _Py_NewRef(PyObject *obj)
- {
- Py_INCREF(obj);
- return obj;
- }
- #define Py_NewRef(obj) _Py_NewRef(_PyObject_CAST(obj))
- #endif
- // bpo-42262 added Py_XNewRef() to Python 3.10.0a3
- #if PY_VERSION_HEX < 0x030A00A3 && !defined(Py_XNewRef)
- PYCAPI_COMPAT_STATIC_INLINE(PyObject*)
- _Py_XNewRef(PyObject *obj)
- {
- Py_XINCREF(obj);
- return obj;
- }
- #define Py_XNewRef(obj) _Py_XNewRef(_PyObject_CAST(obj))
- #endif
- // bpo-39573 added Py_SET_REFCNT() to Python 3.9.0a4
- #if PY_VERSION_HEX < 0x030900A4 && !defined(Py_SET_REFCNT)
- PYCAPI_COMPAT_STATIC_INLINE(void)
- _Py_SET_REFCNT(PyObject *ob, Py_ssize_t refcnt)
- {
- ob->ob_refcnt = refcnt;
- }
- #define Py_SET_REFCNT(ob, refcnt) _Py_SET_REFCNT(_PyObject_CAST(ob), refcnt)
- #endif
- // Py_SETREF() and Py_XSETREF() were added to Python 3.5.2.
- // It is excluded from the limited C API.
- #if (PY_VERSION_HEX < 0x03050200 && !defined(Py_SETREF)) && !defined(Py_LIMITED_API)
- #define Py_SETREF(op, op2) \
- do { \
- PyObject *_py_tmp = _PyObject_CAST(op); \
- (op) = (op2); \
- Py_DECREF(_py_tmp); \
- } while (0)
- #define Py_XSETREF(op, op2) \
- do { \
- PyObject *_py_tmp = _PyObject_CAST(op); \
- (op) = (op2); \
- Py_XDECREF(_py_tmp); \
- } while (0)
- #endif
- // bpo-43753 added Py_Is(), Py_IsNone(), Py_IsTrue() and Py_IsFalse()
- // to Python 3.10.0b1.
- #if PY_VERSION_HEX < 0x030A00B1 && !defined(Py_Is)
- # define Py_Is(x, y) ((x) == (y))
- #endif
- #if PY_VERSION_HEX < 0x030A00B1 && !defined(Py_IsNone)
- # define Py_IsNone(x) Py_Is(x, Py_None)
- #endif
- #if PY_VERSION_HEX < 0x030A00B1 && !defined(Py_IsTrue)
- # define Py_IsTrue(x) Py_Is(x, Py_True)
- #endif
- #if PY_VERSION_HEX < 0x030A00B1 && !defined(Py_IsFalse)
- # define Py_IsFalse(x) Py_Is(x, Py_False)
- #endif
- // bpo-39573 added Py_SET_TYPE() to Python 3.9.0a4
- #if PY_VERSION_HEX < 0x030900A4 && !defined(Py_SET_TYPE)
- PYCAPI_COMPAT_STATIC_INLINE(void)
- _Py_SET_TYPE(PyObject *ob, PyTypeObject *type)
- {
- ob->ob_type = type;
- }
- #define Py_SET_TYPE(ob, type) _Py_SET_TYPE(_PyObject_CAST(ob), type)
- #endif
- // bpo-39573 added Py_SET_SIZE() to Python 3.9.0a4
- #if PY_VERSION_HEX < 0x030900A4 && !defined(Py_SET_SIZE)
- PYCAPI_COMPAT_STATIC_INLINE(void)
- _Py_SET_SIZE(PyVarObject *ob, Py_ssize_t size)
- {
- ob->ob_size = size;
- }
- #define Py_SET_SIZE(ob, size) _Py_SET_SIZE((PyVarObject*)(ob), size)
- #endif
- // bpo-40421 added PyFrame_GetCode() to Python 3.9.0b1
- #if PY_VERSION_HEX < 0x030900B1
- PYCAPI_COMPAT_STATIC_INLINE(PyCodeObject*)
- PyFrame_GetCode(PyFrameObject *frame)
- {
- assert(frame != _Py_NULL);
- assert(frame->f_code != _Py_NULL);
- return _Py_CAST(PyCodeObject*, Py_NewRef(frame->f_code));
- }
- #endif
- PYCAPI_COMPAT_STATIC_INLINE(PyCodeObject*)
- _PyFrame_GetCodeBorrow(PyFrameObject *frame)
- {
- PyCodeObject *code = PyFrame_GetCode(frame);
- Py_DECREF(code);
- return code;
- }
- // bpo-40421 added PyFrame_GetBack() to Python 3.9.0b1
- #if PY_VERSION_HEX < 0x030900B1 && !defined(PYPY_VERSION)
- PYCAPI_COMPAT_STATIC_INLINE(PyFrameObject*)
- PyFrame_GetBack(PyFrameObject *frame)
- {
- assert(frame != _Py_NULL);
- return _Py_CAST(PyFrameObject*, Py_XNewRef(frame->f_back));
- }
- #endif
- #if !defined(PYPY_VERSION)
- PYCAPI_COMPAT_STATIC_INLINE(PyFrameObject*)
- _PyFrame_GetBackBorrow(PyFrameObject *frame)
- {
- PyFrameObject *back = PyFrame_GetBack(frame);
- Py_XDECREF(back);
- return back;
- }
- #endif
- // bpo-40421 added PyFrame_GetLocals() to Python 3.11.0a7
- #if PY_VERSION_HEX < 0x030B00A7 && !defined(PYPY_VERSION)
- PYCAPI_COMPAT_STATIC_INLINE(PyObject*)
- PyFrame_GetLocals(PyFrameObject *frame)
- {
- #if PY_VERSION_HEX >= 0x030400B1
- if (PyFrame_FastToLocalsWithError(frame) < 0) {
- return NULL;
- }
- #else
- PyFrame_FastToLocals(frame);
- #endif
- return Py_NewRef(frame->f_locals);
- }
- #endif
- // bpo-40421 added PyFrame_GetGlobals() to Python 3.11.0a7
- #if PY_VERSION_HEX < 0x030B00A7 && !defined(PYPY_VERSION)
- PYCAPI_COMPAT_STATIC_INLINE(PyObject*)
- PyFrame_GetGlobals(PyFrameObject *frame)
- {
- return Py_NewRef(frame->f_globals);
- }
- #endif
- // bpo-40421 added PyFrame_GetBuiltins() to Python 3.11.0a7
- #if PY_VERSION_HEX < 0x030B00A7 && !defined(PYPY_VERSION)
- PYCAPI_COMPAT_STATIC_INLINE(PyObject*)
- PyFrame_GetBuiltins(PyFrameObject *frame)
- {
- return Py_NewRef(frame->f_builtins);
- }
- #endif
- // bpo-40421 added PyFrame_GetLasti() to Python 3.11.0b1
- #if PY_VERSION_HEX < 0x030B00B1 && !defined(PYPY_VERSION)
- PYCAPI_COMPAT_STATIC_INLINE(int)
- PyFrame_GetLasti(PyFrameObject *frame)
- {
- #if PY_VERSION_HEX >= 0x030A00A7
- // bpo-27129: Since Python 3.10.0a7, f_lasti is an instruction offset,
- // not a bytes offset anymore. Python uses 16-bit "wordcode" (2 bytes)
- // instructions.
- if (frame->f_lasti < 0) {
- return -1;
- }
- return frame->f_lasti * 2;
- #else
- return frame->f_lasti;
- #endif
- }
- #endif
- // bpo-39947 added PyThreadState_GetInterpreter() to Python 3.9.0a5
- #if PY_VERSION_HEX < 0x030900A5
- PYCAPI_COMPAT_STATIC_INLINE(PyInterpreterState *)
- PyThreadState_GetInterpreter(PyThreadState *tstate)
- {
- assert(tstate != _Py_NULL);
- return tstate->interp;
- }
- #endif
- // bpo-40429 added PyThreadState_GetFrame() to Python 3.9.0b1
- #if PY_VERSION_HEX < 0x030900B1 && !defined(PYPY_VERSION)
- PYCAPI_COMPAT_STATIC_INLINE(PyFrameObject*)
- PyThreadState_GetFrame(PyThreadState *tstate)
- {
- assert(tstate != _Py_NULL);
- return _Py_CAST(PyFrameObject *, Py_XNewRef(tstate->frame));
- }
- #endif
- #if !defined(PYPY_VERSION)
- PYCAPI_COMPAT_STATIC_INLINE(PyFrameObject*)
- _PyThreadState_GetFrameBorrow(PyThreadState *tstate)
- {
- PyFrameObject *frame = PyThreadState_GetFrame(tstate);
- Py_XDECREF(frame);
- return frame;
- }
- #endif
- // bpo-39947 added PyInterpreterState_Get() to Python 3.9.0a5
- #if PY_VERSION_HEX < 0x030900A5
- PYCAPI_COMPAT_STATIC_INLINE(PyInterpreterState*)
- PyInterpreterState_Get(void)
- {
- PyThreadState *tstate;
- PyInterpreterState *interp;
- tstate = PyThreadState_GET();
- if (tstate == _Py_NULL) {
- Py_FatalError("GIL released (tstate is NULL)");
- }
- interp = tstate->interp;
- if (interp == _Py_NULL) {
- Py_FatalError("no current interpreter");
- }
- return interp;
- }
- #endif
- // bpo-39947 added PyInterpreterState_Get() to Python 3.9.0a6
- #if 0x030700A1 <= PY_VERSION_HEX && PY_VERSION_HEX < 0x030900A6 && !defined(PYPY_VERSION)
- PYCAPI_COMPAT_STATIC_INLINE(uint64_t)
- PyThreadState_GetID(PyThreadState *tstate)
- {
- assert(tstate != _Py_NULL);
- return tstate->id;
- }
- #endif
- // bpo-43760 added PyThreadState_EnterTracing() to Python 3.11.0a2
- #if PY_VERSION_HEX < 0x030B00A2 && !defined(PYPY_VERSION)
- PYCAPI_COMPAT_STATIC_INLINE(void)
- PyThreadState_EnterTracing(PyThreadState *tstate)
- {
- tstate->tracing++;
- #if PY_VERSION_HEX >= 0x030A00A1
- tstate->cframe->use_tracing = 0;
- #else
- tstate->use_tracing = 0;
- #endif
- }
- #endif
- // bpo-43760 added PyThreadState_LeaveTracing() to Python 3.11.0a2
- #if PY_VERSION_HEX < 0x030B00A2 && !defined(PYPY_VERSION)
- PYCAPI_COMPAT_STATIC_INLINE(void)
- PyThreadState_LeaveTracing(PyThreadState *tstate)
- {
- int use_tracing = (tstate->c_tracefunc != _Py_NULL
- || tstate->c_profilefunc != _Py_NULL);
- tstate->tracing--;
- #if PY_VERSION_HEX >= 0x030A00A1
- tstate->cframe->use_tracing = use_tracing;
- #else
- tstate->use_tracing = use_tracing;
- #endif
- }
- #endif
- // bpo-37194 added PyObject_CallNoArgs() to Python 3.9.0a1
- #if PY_VERSION_HEX < 0x030900A1
- PYCAPI_COMPAT_STATIC_INLINE(PyObject*)
- PyObject_CallNoArgs(PyObject *func)
- {
- return PyObject_CallFunctionObjArgs(func, NULL);
- }
- #endif
- // bpo-39245 made PyObject_CallOneArg() public (previously called
- // _PyObject_CallOneArg) in Python 3.9.0a4
- #if PY_VERSION_HEX < 0x030900A4
- PYCAPI_COMPAT_STATIC_INLINE(PyObject*)
- PyObject_CallOneArg(PyObject *func, PyObject *arg)
- {
- return PyObject_CallFunctionObjArgs(func, arg, NULL);
- }
- #endif
- // bpo-1635741 added PyModule_AddObjectRef() to Python 3.10.0a3
- #if PY_VERSION_HEX < 0x030A00A3
- PYCAPI_COMPAT_STATIC_INLINE(int)
- PyModule_AddObjectRef(PyObject *module, const char *name, PyObject *value)
- {
- int res;
- Py_XINCREF(value);
- res = PyModule_AddObject(module, name, value);
- if (res < 0) {
- Py_XDECREF(value);
- }
- return res;
- }
- #endif
- // bpo-40024 added PyModule_AddType() to Python 3.9.0a5
- #if PY_VERSION_HEX < 0x030900A5
- PYCAPI_COMPAT_STATIC_INLINE(int)
- PyModule_AddType(PyObject *module, PyTypeObject *type)
- {
- const char *name, *dot;
- if (PyType_Ready(type) < 0) {
- return -1;
- }
- // inline _PyType_Name()
- name = type->tp_name;
- assert(name != _Py_NULL);
- dot = strrchr(name, '.');
- if (dot != _Py_NULL) {
- name = dot + 1;
- }
- return PyModule_AddObjectRef(module, name, _PyObject_CAST(type));
- }
- #endif
- // bpo-40241 added PyObject_GC_IsTracked() to Python 3.9.0a6.
- // bpo-4688 added _PyObject_GC_IS_TRACKED() to Python 2.7.0a2.
- #if PY_VERSION_HEX < 0x030900A6 && !defined(PYPY_VERSION)
- PYCAPI_COMPAT_STATIC_INLINE(int)
- PyObject_GC_IsTracked(PyObject* obj)
- {
- return (PyObject_IS_GC(obj) && _PyObject_GC_IS_TRACKED(obj));
- }
- #endif
- // bpo-40241 added PyObject_GC_IsFinalized() to Python 3.9.0a6.
- // bpo-18112 added _PyGCHead_FINALIZED() to Python 3.4.0 final.
- #if PY_VERSION_HEX < 0x030900A6 && PY_VERSION_HEX >= 0x030400F0 && !defined(PYPY_VERSION)
- PYCAPI_COMPAT_STATIC_INLINE(int)
- PyObject_GC_IsFinalized(PyObject *obj)
- {
- PyGC_Head *gc = _Py_CAST(PyGC_Head*, obj) - 1;
- return (PyObject_IS_GC(obj) && _PyGCHead_FINALIZED(gc));
- }
- #endif
- // bpo-39573 added Py_IS_TYPE() to Python 3.9.0a4
- #if PY_VERSION_HEX < 0x030900A4 && !defined(Py_IS_TYPE)
- PYCAPI_COMPAT_STATIC_INLINE(int)
- _Py_IS_TYPE(PyObject *ob, PyTypeObject *type) {
- return Py_TYPE(ob) == type;
- }
- #define Py_IS_TYPE(ob, type) _Py_IS_TYPE(_PyObject_CAST(ob), type)
- #endif
- // bpo-46906 added PyFloat_Pack2() and PyFloat_Unpack2() to Python 3.11a7.
- // bpo-11734 added _PyFloat_Pack2() and _PyFloat_Unpack2() to Python 3.6.0b1.
- // Python 3.11a2 moved _PyFloat_Pack2() and _PyFloat_Unpack2() to the internal
- // C API: Python 3.11a2-3.11a6 versions are not supported.
- #if 0x030600B1 <= PY_VERSION_HEX && PY_VERSION_HEX <= 0x030B00A1 && !defined(PYPY_VERSION)
- PYCAPI_COMPAT_STATIC_INLINE(int)
- PyFloat_Pack2(double x, char *p, int le)
- { return _PyFloat_Pack2(x, (unsigned char*)p, le); }
- PYCAPI_COMPAT_STATIC_INLINE(double)
- PyFloat_Unpack2(const char *p, int le)
- { return _PyFloat_Unpack2((const unsigned char *)p, le); }
- #endif
- // bpo-46906 added PyFloat_Pack4(), PyFloat_Pack8(), PyFloat_Unpack4() and
- // PyFloat_Unpack8() to Python 3.11a7.
- // Python 3.11a2 moved _PyFloat_Pack4(), _PyFloat_Pack8(), _PyFloat_Unpack4()
- // and _PyFloat_Unpack8() to the internal C API: Python 3.11a2-3.11a6 versions
- // are not supported.
- #if PY_VERSION_HEX <= 0x030B00A1 && !defined(PYPY_VERSION)
- PYCAPI_COMPAT_STATIC_INLINE(int)
- PyFloat_Pack4(double x, char *p, int le)
- { return _PyFloat_Pack4(x, (unsigned char*)p, le); }
- PYCAPI_COMPAT_STATIC_INLINE(int)
- PyFloat_Pack8(double x, char *p, int le)
- { return _PyFloat_Pack8(x, (unsigned char*)p, le); }
- PYCAPI_COMPAT_STATIC_INLINE(double)
- PyFloat_Unpack4(const char *p, int le)
- { return _PyFloat_Unpack4((const unsigned char *)p, le); }
- PYCAPI_COMPAT_STATIC_INLINE(double)
- PyFloat_Unpack8(const char *p, int le)
- { return _PyFloat_Unpack8((const unsigned char *)p, le); }
- #endif
- // gh-92154 added PyCode_GetCode() to Python 3.11.0b1
- #if PY_VERSION_HEX < 0x030B00B1 && !defined(PYPY_VERSION)
- PYCAPI_COMPAT_STATIC_INLINE(PyObject*)
- PyCode_GetCode(PyCodeObject *code)
- {
- return Py_NewRef(code->co_code);
- }
- #endif
- // Py_UNUSED() was added to Python 3.4.0b2.
- #if PY_VERSION_HEX < 0x030400B2 && !defined(Py_UNUSED)
- # if defined(__GNUC__) || defined(__clang__)
- # define Py_UNUSED(name) _unused_ ## name __attribute__((unused))
- # else
- # define Py_UNUSED(name) _unused_ ## name
- # endif
- #endif
- #ifdef __cplusplus
- }
- #endif
- #endif // PYTHONCAPI_COMPAT
|