EmbeddedPkg: Extend NvVarStoreFormattedLib LIBRARY_CLASS

[mirror_edk2.git] / AppPkg / Applications / Python / Python-2.7.2 / Include / cobject.h

/*\r
   CObjects are marked Pending Deprecation as of Python 2.7.\r
   The full schedule for 2.x is as follows:\r
     - CObjects are marked Pending Deprecation in Python 2.7.\r
     - CObjects will be marked Deprecated in Python 2.8\r
       (if there is one).\r
     - CObjects will be removed in Python 2.9 (if there is one).\r
\r
   Additionally, for the Python 3.x series:\r
     - CObjects were marked Deprecated in Python 3.1.\r
     - CObjects will be removed in Python 3.2.\r
\r
   You should switch all use of CObjects to capsules.  Capsules\r
   have a safer and more consistent API.  For more information,\r
   see Include/pycapsule.h, or read the "Capsules" topic in\r
   the "Python/C API Reference Manual".\r
\r
   Python 2.7 no longer uses CObjects itself; all objects which\r
   were formerly CObjects are now capsules.  Note that this change\r
   does not by itself break binary compatibility with extensions\r
   built for previous versions of Python--PyCObject_AsVoidPtr()\r
   has been changed to also understand capsules.\r
\r
*/\r
\r
/* original file header comment follows: */\r
\r
/* C objects to be exported from one extension module to another.\r
 \r
   C objects are used for communication between extension modules.\r
   They provide a way for an extension module to export a C interface\r
   to other extension modules, so that extension modules can use the\r
   Python import mechanism to link to one another.\r
\r
*/\r
\r
#ifndef Py_COBJECT_H\r
#define Py_COBJECT_H\r
#ifdef __cplusplus\r
extern "C" {\r
#endif\r
\r
PyAPI_DATA(PyTypeObject) PyCObject_Type;\r
\r
#define PyCObject_Check(op) (Py_TYPE(op) == &PyCObject_Type)\r
\r
/* Create a PyCObject from a pointer to a C object and an optional\r
   destructor function.  If the second argument is non-null, then it\r
   will be called with the first argument if and when the PyCObject is\r
   destroyed.\r
\r
*/\r
PyAPI_FUNC(PyObject *) PyCObject_FromVoidPtr(\r
	void *cobj, void (*destruct)(void*));\r
\r
\r
/* Create a PyCObject from a pointer to a C object, a description object,\r
   and an optional destructor function.  If the third argument is non-null,\r
   then it will be called with the first and second arguments if and when \r
   the PyCObject is destroyed.\r
*/\r
PyAPI_FUNC(PyObject *) PyCObject_FromVoidPtrAndDesc(\r
	void *cobj, void *desc, void (*destruct)(void*,void*));\r
\r
/* Retrieve a pointer to a C object from a PyCObject. */\r
PyAPI_FUNC(void *) PyCObject_AsVoidPtr(PyObject *);\r
\r
/* Retrieve a pointer to a description object from a PyCObject. */\r
PyAPI_FUNC(void *) PyCObject_GetDesc(PyObject *);\r
\r
/* Import a pointer to a C object from a module using a PyCObject. */\r
PyAPI_FUNC(void *) PyCObject_Import(char *module_name, char *cobject_name);\r
\r
/* Modify a C object. Fails (==0) if object has a destructor. */\r
PyAPI_FUNC(int) PyCObject_SetVoidPtr(PyObject *self, void *cobj);\r
\r
\r
typedef struct {\r
    PyObject_HEAD\r
    void *cobject;\r
    void *desc;\r
    void (*destructor)(void *);\r
} PyCObject;\r
\r
\r
#ifdef __cplusplus\r
}\r
#endif\r
#endif /* !Py_COBJECT_H */\r