aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/tools/cython/Cython/Includes/cpython/cobject.pxd
blob: 497d8a92e803599715bd4f59b95aaafb2e9c0671 (plain) (blame)
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
cdef extern from "Python.h":

    ###########################################################################
    # Warning:
    #
    # The CObject API is deprecated as of Python 3.1. Please switch to
    # the new Capsules API.
    ###########################################################################

    int PyCObject_Check(object p)
    #     Return true if its argument is a PyCObject.

    object PyCObject_FromVoidPtr(void* cobj, void (*destr)(void *))
    #     Return value: New reference.
    #
    #     Create a PyCObject from the void * cobj. The destr function will
    #     be called when the object is reclaimed, unless it is NULL.

    object PyCObject_FromVoidPtrAndDesc(void* cobj, void* desc, void (*destr)(void *, void *))
    #     Return value: New reference.
    #
    #     Create a PyCObject from the void * cobj. The destr function will
    #     be called when the object is reclaimed. The desc argument can be
    #     used to pass extra callback data for the destructor function.

    void* PyCObject_AsVoidPtr(object self) except? NULL
    #     Return the object void * that the PyCObject self was created with.

    void* PyCObject_GetDesc(object self) except? NULL
    #     Return the description void * that the PyCObject self was created with.

    int PyCObject_SetVoidPtr(object self, void* cobj) except 0
    #     Set the void pointer inside self to cobj. The PyCObject must not
    #     have an associated destructor. Return true on success, false on
    #     failure.