--- /dev/null
+#ifndef Py_ABSTRACTOBJECT_H\r
+#define Py_ABSTRACTOBJECT_H\r
+#ifdef __cplusplus\r
+extern "C" {\r
+#endif\r
+\r
+#ifdef PY_SSIZE_T_CLEAN\r
+#define PyObject_CallFunction _PyObject_CallFunction_SizeT\r
+#define PyObject_CallMethod _PyObject_CallMethod_SizeT\r
+#endif\r
+\r
+/* Abstract Object Interface (many thanks to Jim Fulton) */\r
+\r
+/*\r
+ PROPOSAL: A Generic Python Object Interface for Python C Modules\r
+\r
+Problem\r
+\r
+ Python modules written in C that must access Python objects must do\r
+ so through routines whose interfaces are described by a set of\r
+ include files. Unfortunately, these routines vary according to the\r
+ object accessed. To use these routines, the C programmer must check\r
+ the type of the object being used and must call a routine based on\r
+ the object type. For example, to access an element of a sequence,\r
+ the programmer must determine whether the sequence is a list or a\r
+ tuple:\r
+\r
+ if(is_tupleobject(o))\r
+ e=gettupleitem(o,i)\r
+ else if(is_listitem(o))\r
+ e=getlistitem(o,i)\r
+\r
+ If the programmer wants to get an item from another type of object\r
+ that provides sequence behavior, there is no clear way to do it\r
+ correctly.\r
+\r
+ The persistent programmer may peruse object.h and find that the\r
+ _typeobject structure provides a means of invoking up to (currently\r
+ about) 41 special operators. So, for example, a routine can get an\r
+ item from any object that provides sequence behavior. However, to\r
+ use this mechanism, the programmer must make their code dependent on\r
+ the current Python implementation.\r
+\r
+ Also, certain semantics, especially memory management semantics, may\r
+ differ by the type of object being used. Unfortunately, these\r
+ semantics are not clearly described in the current include files.\r
+ An abstract interface providing more consistent semantics is needed.\r
+\r
+Proposal\r
+\r
+ I propose the creation of a standard interface (with an associated\r
+ library of routines and/or macros) for generically obtaining the\r
+ services of Python objects. This proposal can be viewed as one\r
+ components of a Python C interface consisting of several components.\r
+\r
+ From the viewpoint of C access to Python services, we have (as\r
+ suggested by Guido in off-line discussions):\r
+\r
+ - "Very high level layer": two or three functions that let you exec or\r
+ eval arbitrary Python code given as a string in a module whose name is\r
+ given, passing C values in and getting C values out using\r
+ mkvalue/getargs style format strings. This does not require the user\r
+ to declare any variables of type "PyObject *". This should be enough\r
+ to write a simple application that gets Python code from the user,\r
+ execs it, and returns the output or errors. (Error handling must also\r
+ be part of this API.)\r
+\r
+ - "Abstract objects layer": which is the subject of this proposal.\r
+ It has many functions operating on objects, and lest you do many\r
+ things from C that you can also write in Python, without going\r
+ through the Python parser.\r
+\r
+ - "Concrete objects layer": This is the public type-dependent\r
+ interface provided by the standard built-in types, such as floats,\r
+ strings, and lists. This interface exists and is currently\r
+ documented by the collection of include files provided with the\r
+ Python distributions.\r
+\r
+ From the point of view of Python accessing services provided by C\r
+ modules:\r
+\r
+ - "Python module interface": this interface consist of the basic\r
+ routines used to define modules and their members. Most of the\r
+ current extensions-writing guide deals with this interface.\r
+\r
+ - "Built-in object interface": this is the interface that a new\r
+ built-in type must provide and the mechanisms and rules that a\r
+ developer of a new built-in type must use and follow.\r
+\r
+ This proposal is a "first-cut" that is intended to spur\r
+ discussion. See especially the lists of notes.\r
+\r
+ The Python C object interface will provide four protocols: object,\r
+ numeric, sequence, and mapping. Each protocol consists of a\r
+ collection of related operations. If an operation that is not\r
+ provided by a particular type is invoked, then a standard exception,\r
+ NotImplementedError is raised with a operation name as an argument.\r
+ In addition, for convenience this interface defines a set of\r
+ constructors for building objects of built-in types. This is needed\r
+ so new objects can be returned from C functions that otherwise treat\r
+ objects generically.\r
+\r
+Memory Management\r
+\r
+ For all of the functions described in this proposal, if a function\r
+ retains a reference to a Python object passed as an argument, then the\r
+ function will increase the reference count of the object. It is\r
+ unnecessary for the caller to increase the reference count of an\r
+ argument in anticipation of the object's retention.\r
+\r
+ All Python objects returned from functions should be treated as new\r
+ objects. Functions that return objects assume that the caller will\r
+ retain a reference and the reference count of the object has already\r
+ been incremented to account for this fact. A caller that does not\r
+ retain a reference to an object that is returned from a function\r
+ must decrement the reference count of the object (using\r
+ DECREF(object)) to prevent memory leaks.\r
+\r
+ Note that the behavior mentioned here is different from the current\r
+ behavior for some objects (e.g. lists and tuples) when certain\r
+ type-specific routines are called directly (e.g. setlistitem). The\r
+ proposed abstraction layer will provide a consistent memory\r
+ management interface, correcting for inconsistent behavior for some\r
+ built-in types.\r
+\r
+Protocols\r
+\r
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/\r
+\r
+/* Object Protocol: */\r
+\r
+ /* Implemented elsewhere:\r
+\r
+ int PyObject_Print(PyObject *o, FILE *fp, int flags);\r
+\r
+ Print an object, o, on file, fp. Returns -1 on\r
+ error. The flags argument is used to enable certain printing\r
+ options. The only option currently supported is Py_Print_RAW.\r
+\r
+ (What should be said about Py_Print_RAW?)\r
+\r
+ */\r
+\r
+ /* Implemented elsewhere:\r
+\r
+ int PyObject_HasAttrString(PyObject *o, char *attr_name);\r
+\r
+ Returns 1 if o has the attribute attr_name, and 0 otherwise.\r
+ This is equivalent to the Python expression:\r
+ hasattr(o,attr_name).\r
+\r
+ This function always succeeds.\r
+\r
+ */\r
+\r
+ /* Implemented elsewhere:\r
+\r
+ PyObject* PyObject_GetAttrString(PyObject *o, char *attr_name);\r
+\r
+ Retrieve an attributed named attr_name form object o.\r
+ Returns the attribute value on success, or NULL on failure.\r
+ This is the equivalent of the Python expression: o.attr_name.\r
+\r
+ */\r
+\r
+ /* Implemented elsewhere:\r
+\r
+ int PyObject_HasAttr(PyObject *o, PyObject *attr_name);\r
+\r
+ Returns 1 if o has the attribute attr_name, and 0 otherwise.\r
+ This is equivalent to the Python expression:\r
+ hasattr(o,attr_name).\r
+\r
+ This function always succeeds.\r
+\r
+ */\r
+\r
+ /* Implemented elsewhere:\r
+\r
+ PyObject* PyObject_GetAttr(PyObject *o, PyObject *attr_name);\r
+\r
+ Retrieve an attributed named attr_name form object o.\r
+ Returns the attribute value on success, or NULL on failure.\r
+ This is the equivalent of the Python expression: o.attr_name.\r
+\r
+ */\r
+\r
+\r
+ /* Implemented elsewhere:\r
+\r
+ int PyObject_SetAttrString(PyObject *o, char *attr_name, PyObject *v);\r
+\r
+ Set the value of the attribute named attr_name, for object o,\r
+ to the value, v. Returns -1 on failure. This is\r
+ the equivalent of the Python statement: o.attr_name=v.\r
+\r
+ */\r
+\r
+ /* Implemented elsewhere:\r
+\r
+ int PyObject_SetAttr(PyObject *o, PyObject *attr_name, PyObject *v);\r
+\r
+ Set the value of the attribute named attr_name, for object o,\r
+ to the value, v. Returns -1 on failure. This is\r
+ the equivalent of the Python statement: o.attr_name=v.\r
+\r
+ */\r
+\r
+ /* implemented as a macro:\r
+\r
+ int PyObject_DelAttrString(PyObject *o, char *attr_name);\r
+\r
+ Delete attribute named attr_name, for object o. Returns\r
+ -1 on failure. This is the equivalent of the Python\r
+ statement: del o.attr_name.\r
+\r
+ */\r
+#define PyObject_DelAttrString(O,A) PyObject_SetAttrString((O),(A),NULL)\r
+\r
+ /* implemented as a macro:\r
+\r
+ int PyObject_DelAttr(PyObject *o, PyObject *attr_name);\r
+\r
+ Delete attribute named attr_name, for object o. Returns -1\r
+ on failure. This is the equivalent of the Python\r
+ statement: del o.attr_name.\r
+\r
+ */\r
+#define PyObject_DelAttr(O,A) PyObject_SetAttr((O),(A),NULL)\r
+\r
+ PyAPI_FUNC(int) PyObject_Cmp(PyObject *o1, PyObject *o2, int *result);\r
+\r
+ /*\r
+ Compare the values of o1 and o2 using a routine provided by\r
+ o1, if one exists, otherwise with a routine provided by o2.\r
+ The result of the comparison is returned in result. Returns\r
+ -1 on failure. This is the equivalent of the Python\r
+ statement: result=cmp(o1,o2).\r
+\r
+ */\r
+\r
+ /* Implemented elsewhere:\r
+\r
+ int PyObject_Compare(PyObject *o1, PyObject *o2);\r
+\r
+ Compare the values of o1 and o2 using a routine provided by\r
+ o1, if one exists, otherwise with a routine provided by o2.\r
+ Returns the result of the comparison on success. On error,\r
+ the value returned is undefined. This is equivalent to the\r
+ Python expression: cmp(o1,o2).\r
+\r
+ */\r
+\r
+ /* Implemented elsewhere:\r
+\r
+ PyObject *PyObject_Repr(PyObject *o);\r
+\r
+ Compute the string representation of object, o. Returns the\r
+ string representation on success, NULL on failure. This is\r
+ the equivalent of the Python expression: repr(o).\r
+\r
+ Called by the repr() built-in function and by reverse quotes.\r
+\r
+ */\r
+\r
+ /* Implemented elsewhere:\r
+\r
+ PyObject *PyObject_Str(PyObject *o);\r
+\r
+ Compute the string representation of object, o. Returns the\r
+ string representation on success, NULL on failure. This is\r
+ the equivalent of the Python expression: str(o).)\r
+\r
+ Called by the str() built-in function and by the print\r
+ statement.\r
+\r
+ */\r
+\r
+ /* Implemented elsewhere:\r
+\r
+ PyObject *PyObject_Unicode(PyObject *o);\r
+\r
+ Compute the unicode representation of object, o. Returns the\r
+ unicode representation on success, NULL on failure. This is\r
+ the equivalent of the Python expression: unistr(o).)\r
+\r
+ Called by the unistr() built-in function.\r
+\r
+ */\r
+\r
+ /* Declared elsewhere\r
+\r
+ PyAPI_FUNC(int) PyCallable_Check(PyObject *o);\r
+\r
+ Determine if the object, o, is callable. Return 1 if the\r
+ object is callable and 0 otherwise.\r
+\r
+ This function always succeeds.\r
+\r
+ */\r
+\r
+\r
+\r
+ PyAPI_FUNC(PyObject *) PyObject_Call(PyObject *callable_object,\r
+ PyObject *args, PyObject *kw);\r
+\r
+ /*\r
+ Call a callable Python object, callable_object, with\r
+ arguments and keywords arguments. The 'args' argument can not be\r
+ NULL, but the 'kw' argument can be NULL.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyObject_CallObject(PyObject *callable_object,\r
+ PyObject *args);\r
+\r
+ /*\r
+ Call a callable Python object, callable_object, with\r
+ arguments given by the tuple, args. If no arguments are\r
+ needed, then args may be NULL. Returns the result of the\r
+ call on success, or NULL on failure. This is the equivalent\r
+ of the Python expression: apply(o,args).\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyObject_CallFunction(PyObject *callable_object,\r
+ char *format, ...);\r
+\r
+ /*\r
+ Call a callable Python object, callable_object, with a\r
+ variable number of C arguments. The C arguments are described\r
+ using a mkvalue-style format string. The format may be NULL,\r
+ indicating that no arguments are provided. Returns the\r
+ result of the call on success, or NULL on failure. This is\r
+ the equivalent of the Python expression: apply(o,args).\r
+\r
+ */\r
+\r
+\r
+ PyAPI_FUNC(PyObject *) PyObject_CallMethod(PyObject *o, char *m,\r
+ char *format, ...);\r
+\r
+ /*\r
+ Call the method named m of object o with a variable number of\r
+ C arguments. The C arguments are described by a mkvalue\r
+ format string. The format may be NULL, indicating that no\r
+ arguments are provided. Returns the result of the call on\r
+ success, or NULL on failure. This is the equivalent of the\r
+ Python expression: o.method(args).\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) _PyObject_CallFunction_SizeT(PyObject *callable,\r
+ char *format, ...);\r
+ PyAPI_FUNC(PyObject *) _PyObject_CallMethod_SizeT(PyObject *o,\r
+ char *name,\r
+ char *format, ...);\r
+\r
+ PyAPI_FUNC(PyObject *) PyObject_CallFunctionObjArgs(PyObject *callable,\r
+ ...);\r
+\r
+ /*\r
+ Call a callable Python object, callable_object, with a\r
+ variable number of C arguments. The C arguments are provided\r
+ as PyObject * values, terminated by a NULL. Returns the\r
+ result of the call on success, or NULL on failure. This is\r
+ the equivalent of the Python expression: apply(o,args).\r
+ */\r
+\r
+\r
+ PyAPI_FUNC(PyObject *) PyObject_CallMethodObjArgs(PyObject *o,\r
+ PyObject *m, ...);\r
+\r
+ /*\r
+ Call the method named m of object o with a variable number of\r
+ C arguments. The C arguments are provided as PyObject *\r
+ values, terminated by NULL. Returns the result of the call\r
+ on success, or NULL on failure. This is the equivalent of\r
+ the Python expression: o.method(args).\r
+ */\r
+\r
+\r
+ /* Implemented elsewhere:\r
+\r
+ long PyObject_Hash(PyObject *o);\r
+\r
+ Compute and return the hash, hash_value, of an object, o. On\r
+ failure, return -1. This is the equivalent of the Python\r
+ expression: hash(o).\r
+\r
+ */\r
+\r
+\r
+ /* Implemented elsewhere:\r
+\r
+ int PyObject_IsTrue(PyObject *o);\r
+\r
+ Returns 1 if the object, o, is considered to be true, 0 if o is\r
+ considered to be false and -1 on failure. This is equivalent to the\r
+ Python expression: not not o\r
+\r
+ */\r
+\r
+ /* Implemented elsewhere:\r
+\r
+ int PyObject_Not(PyObject *o);\r
+\r
+ Returns 0 if the object, o, is considered to be true, 1 if o is\r
+ considered to be false and -1 on failure. This is equivalent to the\r
+ Python expression: not o\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyObject_Type(PyObject *o);\r
+\r
+ /*\r
+ On success, returns a type object corresponding to the object\r
+ type of object o. On failure, returns NULL. This is\r
+ equivalent to the Python expression: type(o).\r
+ */\r
+\r
+ PyAPI_FUNC(Py_ssize_t) PyObject_Size(PyObject *o);\r
+\r
+ /*\r
+ Return the size of object o. If the object, o, provides\r
+ both sequence and mapping protocols, the sequence size is\r
+ returned. On error, -1 is returned. This is the equivalent\r
+ to the Python expression: len(o).\r
+\r
+ */\r
+\r
+ /* For DLL compatibility */\r
+#undef PyObject_Length\r
+ PyAPI_FUNC(Py_ssize_t) PyObject_Length(PyObject *o);\r
+#define PyObject_Length PyObject_Size\r
+\r
+ PyAPI_FUNC(Py_ssize_t) _PyObject_LengthHint(PyObject *o, Py_ssize_t);\r
+\r
+ /*\r
+ Guess the size of object o using len(o) or o.__length_hint__().\r
+ If neither of those return a non-negative value, then return the\r
+ default value. If one of the calls fails, this function returns -1.\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyObject_GetItem(PyObject *o, PyObject *key);\r
+\r
+ /*\r
+ Return element of o corresponding to the object, key, or NULL\r
+ on failure. This is the equivalent of the Python expression:\r
+ o[key].\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(int) PyObject_SetItem(PyObject *o, PyObject *key, PyObject *v);\r
+\r
+ /*\r
+ Map the object, key, to the value, v. Returns\r
+ -1 on failure. This is the equivalent of the Python\r
+ statement: o[key]=v.\r
+ */\r
+\r
+ PyAPI_FUNC(int) PyObject_DelItemString(PyObject *o, char *key);\r
+\r
+ /*\r
+ Remove the mapping for object, key, from the object *o.\r
+ Returns -1 on failure. This is equivalent to\r
+ the Python statement: del o[key].\r
+ */\r
+\r
+ PyAPI_FUNC(int) PyObject_DelItem(PyObject *o, PyObject *key);\r
+\r
+ /*\r
+ Delete the mapping for key from *o. Returns -1 on failure.\r
+ This is the equivalent of the Python statement: del o[key].\r
+ */\r
+\r
+ PyAPI_FUNC(int) PyObject_AsCharBuffer(PyObject *obj,\r
+ const char **buffer,\r
+ Py_ssize_t *buffer_len);\r
+\r
+ /*\r
+ Takes an arbitrary object which must support the (character,\r
+ single segment) buffer interface and returns a pointer to a\r
+ read-only memory location useable as character based input\r
+ for subsequent processing.\r
+\r
+ 0 is returned on success. buffer and buffer_len are only\r
+ set in case no error occurs. Otherwise, -1 is returned and\r
+ an exception set.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(int) PyObject_CheckReadBuffer(PyObject *obj);\r
+\r
+ /*\r
+ Checks whether an arbitrary object supports the (character,\r
+ single segment) buffer interface. Returns 1 on success, 0\r
+ on failure.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(int) PyObject_AsReadBuffer(PyObject *obj,\r
+ const void **buffer,\r
+ Py_ssize_t *buffer_len);\r
+\r
+ /*\r
+ Same as PyObject_AsCharBuffer() except that this API expects\r
+ (readable, single segment) buffer interface and returns a\r
+ pointer to a read-only memory location which can contain\r
+ arbitrary data.\r
+\r
+ 0 is returned on success. buffer and buffer_len are only\r
+ set in case no error occurs. Otherwise, -1 is returned and\r
+ an exception set.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(int) PyObject_AsWriteBuffer(PyObject *obj,\r
+ void **buffer,\r
+ Py_ssize_t *buffer_len);\r
+\r
+ /*\r
+ Takes an arbitrary object which must support the (writeable,\r
+ single segment) buffer interface and returns a pointer to a\r
+ writeable memory location in buffer of size buffer_len.\r
+\r
+ 0 is returned on success. buffer and buffer_len are only\r
+ set in case no error occurs. Otherwise, -1 is returned and\r
+ an exception set.\r
+\r
+ */\r
+\r
+ /* new buffer API */\r
+\r
+#define PyObject_CheckBuffer(obj) \\r
+ (((obj)->ob_type->tp_as_buffer != NULL) && \\r
+ (PyType_HasFeature((obj)->ob_type, Py_TPFLAGS_HAVE_NEWBUFFER)) && \\r
+ ((obj)->ob_type->tp_as_buffer->bf_getbuffer != NULL))\r
+\r
+ /* Return 1 if the getbuffer function is available, otherwise\r
+ return 0 */\r
+\r
+ PyAPI_FUNC(int) PyObject_GetBuffer(PyObject *obj, Py_buffer *view,\r
+ int flags);\r
+\r
+ /* This is a C-API version of the getbuffer function call. It checks\r
+ to make sure object has the required function pointer and issues the\r
+ call. Returns -1 and raises an error on failure and returns 0 on\r
+ success\r
+ */\r
+\r
+\r
+ PyAPI_FUNC(void *) PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices);\r
+\r
+ /* Get the memory area pointed to by the indices for the buffer given.\r
+ Note that view->ndim is the assumed size of indices\r
+ */\r
+\r
+ PyAPI_FUNC(int) PyBuffer_SizeFromFormat(const char *);\r
+\r
+ /* Return the implied itemsize of the data-format area from a\r
+ struct-style description */\r
+\r
+\r
+\r
+ PyAPI_FUNC(int) PyBuffer_ToContiguous(void *buf, Py_buffer *view,\r
+ Py_ssize_t len, char fort);\r
+\r
+ PyAPI_FUNC(int) PyBuffer_FromContiguous(Py_buffer *view, void *buf,\r
+ Py_ssize_t len, char fort);\r
+\r
+\r
+ /* Copy len bytes of data from the contiguous chunk of memory\r
+ pointed to by buf into the buffer exported by obj. Return\r
+ 0 on success and return -1 and raise a PyBuffer_Error on\r
+ error (i.e. the object does not have a buffer interface or\r
+ it is not working).\r
+\r
+ If fort is 'F' and the object is multi-dimensional,\r
+ then the data will be copied into the array in\r
+ Fortran-style (first dimension varies the fastest). If\r
+ fort is 'C', then the data will be copied into the array\r
+ in C-style (last dimension varies the fastest). If fort\r
+ is 'A', then it does not matter and the copy will be made\r
+ in whatever way is more efficient.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(int) PyObject_CopyData(PyObject *dest, PyObject *src);\r
+\r
+ /* Copy the data from the src buffer to the buffer of destination\r
+ */\r
+\r
+ PyAPI_FUNC(int) PyBuffer_IsContiguous(Py_buffer *view, char fort);\r
+\r
+\r
+ PyAPI_FUNC(void) PyBuffer_FillContiguousStrides(int ndims,\r
+ Py_ssize_t *shape,\r
+ Py_ssize_t *strides,\r
+ int itemsize,\r
+ char fort);\r
+\r
+ /* Fill the strides array with byte-strides of a contiguous\r
+ (Fortran-style if fort is 'F' or C-style otherwise)\r
+ array of the given shape with the given number of bytes\r
+ per element.\r
+ */\r
+\r
+ PyAPI_FUNC(int) PyBuffer_FillInfo(Py_buffer *view, PyObject *o, void *buf,\r
+ Py_ssize_t len, int readonly,\r
+ int flags);\r
+\r
+ /* Fills in a buffer-info structure correctly for an exporter\r
+ that can only share a contiguous chunk of memory of\r
+ "unsigned bytes" of the given length. Returns 0 on success\r
+ and -1 (with raising an error) on error.\r
+ */\r
+\r
+ PyAPI_FUNC(void) PyBuffer_Release(Py_buffer *view);\r
+\r
+ /* Releases a Py_buffer obtained from getbuffer ParseTuple's s*.\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyObject_Format(PyObject* obj,\r
+ PyObject *format_spec);\r
+ /*\r
+ Takes an arbitrary object and returns the result of\r
+ calling obj.__format__(format_spec).\r
+ */\r
+\r
+/* Iterators */\r
+\r
+ PyAPI_FUNC(PyObject *) PyObject_GetIter(PyObject *);\r
+ /* Takes an object and returns an iterator for it.\r
+ This is typically a new iterator but if the argument\r
+ is an iterator, this returns itself. */\r
+\r
+#define PyIter_Check(obj) \\r
+ (PyType_HasFeature((obj)->ob_type, Py_TPFLAGS_HAVE_ITER) && \\r
+ (obj)->ob_type->tp_iternext != NULL && \\r
+ (obj)->ob_type->tp_iternext != &_PyObject_NextNotImplemented)\r
+\r
+ PyAPI_FUNC(PyObject *) PyIter_Next(PyObject *);\r
+ /* Takes an iterator object and calls its tp_iternext slot,\r
+ returning the next value. If the iterator is exhausted,\r
+ this returns NULL without setting an exception.\r
+ NULL with an exception means an error occurred. */\r
+\r
+/* Number Protocol:*/\r
+\r
+ PyAPI_FUNC(int) PyNumber_Check(PyObject *o);\r
+\r
+ /*\r
+ Returns 1 if the object, o, provides numeric protocols, and\r
+ false otherwise.\r
+\r
+ This function always succeeds.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_Add(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the result of adding o1 and o2, or null on failure.\r
+ This is the equivalent of the Python expression: o1+o2.\r
+\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_Subtract(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the result of subtracting o2 from o1, or null on\r
+ failure. This is the equivalent of the Python expression:\r
+ o1-o2.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_Multiply(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the result of multiplying o1 and o2, or null on\r
+ failure. This is the equivalent of the Python expression:\r
+ o1*o2.\r
+\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_Divide(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the result of dividing o1 by o2, or null on failure.\r
+ This is the equivalent of the Python expression: o1/o2.\r
+\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_FloorDivide(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the result of dividing o1 by o2 giving an integral result,\r
+ or null on failure.\r
+ This is the equivalent of the Python expression: o1//o2.\r
+\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_TrueDivide(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the result of dividing o1 by o2 giving a float result,\r
+ or null on failure.\r
+ This is the equivalent of the Python expression: o1/o2.\r
+\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_Remainder(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the remainder of dividing o1 by o2, or null on\r
+ failure. This is the equivalent of the Python expression:\r
+ o1%o2.\r
+\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_Divmod(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ See the built-in function divmod. Returns NULL on failure.\r
+ This is the equivalent of the Python expression:\r
+ divmod(o1,o2).\r
+\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_Power(PyObject *o1, PyObject *o2,\r
+ PyObject *o3);\r
+\r
+ /*\r
+ See the built-in function pow. Returns NULL on failure.\r
+ This is the equivalent of the Python expression:\r
+ pow(o1,o2,o3), where o3 is optional.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_Negative(PyObject *o);\r
+\r
+ /*\r
+ Returns the negation of o on success, or null on failure.\r
+ This is the equivalent of the Python expression: -o.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_Positive(PyObject *o);\r
+\r
+ /*\r
+ Returns the (what?) of o on success, or NULL on failure.\r
+ This is the equivalent of the Python expression: +o.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_Absolute(PyObject *o);\r
+\r
+ /*\r
+ Returns the absolute value of o, or null on failure. This is\r
+ the equivalent of the Python expression: abs(o).\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_Invert(PyObject *o);\r
+\r
+ /*\r
+ Returns the bitwise negation of o on success, or NULL on\r
+ failure. This is the equivalent of the Python expression:\r
+ ~o.\r
+\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_Lshift(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the result of left shifting o1 by o2 on success, or\r
+ NULL on failure. This is the equivalent of the Python\r
+ expression: o1 << o2.\r
+\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_Rshift(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the result of right shifting o1 by o2 on success, or\r
+ NULL on failure. This is the equivalent of the Python\r
+ expression: o1 >> o2.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_And(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the result of bitwise and of o1 and o2 on success, or\r
+ NULL on failure. This is the equivalent of the Python\r
+ expression: o1&o2.\r
+\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_Xor(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the bitwise exclusive or of o1 by o2 on success, or\r
+ NULL on failure. This is the equivalent of the Python\r
+ expression: o1^o2.\r
+\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_Or(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the result of bitwise or on o1 and o2 on success, or\r
+ NULL on failure. This is the equivalent of the Python\r
+ expression: o1|o2.\r
+\r
+ */\r
+\r
+ /* Implemented elsewhere:\r
+\r
+ int PyNumber_Coerce(PyObject **p1, PyObject **p2);\r
+\r
+ This function takes the addresses of two variables of type\r
+ PyObject*.\r
+\r
+ If the objects pointed to by *p1 and *p2 have the same type,\r
+ increment their reference count and return 0 (success).\r
+ If the objects can be converted to a common numeric type,\r
+ replace *p1 and *p2 by their converted value (with 'new'\r
+ reference counts), and return 0.\r
+ If no conversion is possible, or if some other error occurs,\r
+ return -1 (failure) and don't increment the reference counts.\r
+ The call PyNumber_Coerce(&o1, &o2) is equivalent to the Python\r
+ statement o1, o2 = coerce(o1, o2).\r
+\r
+ */\r
+\r
+#define PyIndex_Check(obj) \\r
+ ((obj)->ob_type->tp_as_number != NULL && \\r
+ PyType_HasFeature((obj)->ob_type, Py_TPFLAGS_HAVE_INDEX) && \\r
+ (obj)->ob_type->tp_as_number->nb_index != NULL)\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_Index(PyObject *o);\r
+\r
+ /*\r
+ Returns the object converted to a Python long or int\r
+ or NULL with an error raised on failure.\r
+ */\r
+\r
+ PyAPI_FUNC(Py_ssize_t) PyNumber_AsSsize_t(PyObject *o, PyObject *exc);\r
+\r
+ /*\r
+ Returns the Integral instance converted to an int. The\r
+ instance is expected to be int or long or have an __int__\r
+ method. Steals integral's reference. error_format will be\r
+ used to create the TypeError if integral isn't actually an\r
+ Integral instance. error_format should be a format string\r
+ that can accept a char* naming integral's type.\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) _PyNumber_ConvertIntegralToInt(\r
+ PyObject *integral,\r
+ const char* error_format);\r
+\r
+ /*\r
+ Returns the object converted to Py_ssize_t by going through\r
+ PyNumber_Index first. If an overflow error occurs while\r
+ converting the int-or-long to Py_ssize_t, then the second argument\r
+ is the error-type to return. If it is NULL, then the overflow error\r
+ is cleared and the value is clipped.\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_Int(PyObject *o);\r
+\r
+ /*\r
+ Returns the o converted to an integer object on success, or\r
+ NULL on failure. This is the equivalent of the Python\r
+ expression: int(o).\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_Long(PyObject *o);\r
+\r
+ /*\r
+ Returns the o converted to a long integer object on success,\r
+ or NULL on failure. This is the equivalent of the Python\r
+ expression: long(o).\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_Float(PyObject *o);\r
+\r
+ /*\r
+ Returns the o converted to a float object on success, or NULL\r
+ on failure. This is the equivalent of the Python expression:\r
+ float(o).\r
+ */\r
+\r
+/* In-place variants of (some of) the above number protocol functions */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_InPlaceAdd(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the result of adding o2 to o1, possibly in-place, or null\r
+ on failure. This is the equivalent of the Python expression:\r
+ o1 += o2.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_InPlaceSubtract(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the result of subtracting o2 from o1, possibly in-place or\r
+ null on failure. This is the equivalent of the Python expression:\r
+ o1 -= o2.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_InPlaceMultiply(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the result of multiplying o1 by o2, possibly in-place, or\r
+ null on failure. This is the equivalent of the Python expression:\r
+ o1 *= o2.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_InPlaceDivide(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the result of dividing o1 by o2, possibly in-place, or null\r
+ on failure. This is the equivalent of the Python expression:\r
+ o1 /= o2.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_InPlaceFloorDivide(PyObject *o1,\r
+ PyObject *o2);\r
+\r
+ /*\r
+ Returns the result of dividing o1 by o2 giving an integral result,\r
+ possibly in-place, or null on failure.\r
+ This is the equivalent of the Python expression:\r
+ o1 /= o2.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_InPlaceTrueDivide(PyObject *o1,\r
+ PyObject *o2);\r
+\r
+ /*\r
+ Returns the result of dividing o1 by o2 giving a float result,\r
+ possibly in-place, or null on failure.\r
+ This is the equivalent of the Python expression:\r
+ o1 /= o2.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_InPlaceRemainder(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the remainder of dividing o1 by o2, possibly in-place, or\r
+ null on failure. This is the equivalent of the Python expression:\r
+ o1 %= o2.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_InPlacePower(PyObject *o1, PyObject *o2,\r
+ PyObject *o3);\r
+\r
+ /*\r
+ Returns the result of raising o1 to the power of o2, possibly\r
+ in-place, or null on failure. This is the equivalent of the Python\r
+ expression: o1 **= o2, or pow(o1, o2, o3) if o3 is present.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_InPlaceLshift(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the result of left shifting o1 by o2, possibly in-place, or\r
+ null on failure. This is the equivalent of the Python expression:\r
+ o1 <<= o2.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_InPlaceRshift(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the result of right shifting o1 by o2, possibly in-place or\r
+ null on failure. This is the equivalent of the Python expression:\r
+ o1 >>= o2.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_InPlaceAnd(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the result of bitwise and of o1 and o2, possibly in-place,\r
+ or null on failure. This is the equivalent of the Python\r
+ expression: o1 &= o2.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_InPlaceXor(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the bitwise exclusive or of o1 by o2, possibly in-place, or\r
+ null on failure. This is the equivalent of the Python expression:\r
+ o1 ^= o2.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_InPlaceOr(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Returns the result of bitwise or of o1 and o2, possibly in-place,\r
+ or null on failure. This is the equivalent of the Python\r
+ expression: o1 |= o2.\r
+\r
+ */\r
+\r
+\r
+ PyAPI_FUNC(PyObject *) PyNumber_ToBase(PyObject *n, int base);\r
+\r
+ /*\r
+ Returns the integer n converted to a string with a base, with a base\r
+ marker of 0b, 0o or 0x prefixed if applicable.\r
+ If n is not an int object, it is converted with PyNumber_Index first.\r
+ */\r
+\r
+\r
+/* Sequence protocol:*/\r
+\r
+ PyAPI_FUNC(int) PySequence_Check(PyObject *o);\r
+\r
+ /*\r
+ Return 1 if the object provides sequence protocol, and zero\r
+ otherwise.\r
+\r
+ This function always succeeds.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(Py_ssize_t) PySequence_Size(PyObject *o);\r
+\r
+ /*\r
+ Return the size of sequence object o, or -1 on failure.\r
+\r
+ */\r
+\r
+ /* For DLL compatibility */\r
+#undef PySequence_Length\r
+ PyAPI_FUNC(Py_ssize_t) PySequence_Length(PyObject *o);\r
+#define PySequence_Length PySequence_Size\r
+\r
+\r
+ PyAPI_FUNC(PyObject *) PySequence_Concat(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Return the concatenation of o1 and o2 on success, and NULL on\r
+ failure. This is the equivalent of the Python\r
+ expression: o1+o2.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PySequence_Repeat(PyObject *o, Py_ssize_t count);\r
+\r
+ /*\r
+ Return the result of repeating sequence object o count times,\r
+ or NULL on failure. This is the equivalent of the Python\r
+ expression: o1*count.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PySequence_GetItem(PyObject *o, Py_ssize_t i);\r
+\r
+ /*\r
+ Return the ith element of o, or NULL on failure. This is the\r
+ equivalent of the Python expression: o[i].\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PySequence_GetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2);\r
+\r
+ /*\r
+ Return the slice of sequence object o between i1 and i2, or\r
+ NULL on failure. This is the equivalent of the Python\r
+ expression: o[i1:i2].\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(int) PySequence_SetItem(PyObject *o, Py_ssize_t i, PyObject *v);\r
+\r
+ /*\r
+ Assign object v to the ith element of o. Returns\r
+ -1 on failure. This is the equivalent of the Python\r
+ statement: o[i]=v.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(int) PySequence_DelItem(PyObject *o, Py_ssize_t i);\r
+\r
+ /*\r
+ Delete the ith element of object v. Returns\r
+ -1 on failure. This is the equivalent of the Python\r
+ statement: del o[i].\r
+ */\r
+\r
+ PyAPI_FUNC(int) PySequence_SetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2,\r
+ PyObject *v);\r
+\r
+ /*\r
+ Assign the sequence object, v, to the slice in sequence\r
+ object, o, from i1 to i2. Returns -1 on failure. This is the\r
+ equivalent of the Python statement: o[i1:i2]=v.\r
+ */\r
+\r
+ PyAPI_FUNC(int) PySequence_DelSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2);\r
+\r
+ /*\r
+ Delete the slice in sequence object, o, from i1 to i2.\r
+ Returns -1 on failure. This is the equivalent of the Python\r
+ statement: del o[i1:i2].\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PySequence_Tuple(PyObject *o);\r
+\r
+ /*\r
+ Returns the sequence, o, as a tuple on success, and NULL on failure.\r
+ This is equivalent to the Python expression: tuple(o)\r
+ */\r
+\r
+\r
+ PyAPI_FUNC(PyObject *) PySequence_List(PyObject *o);\r
+ /*\r
+ Returns the sequence, o, as a list on success, and NULL on failure.\r
+ This is equivalent to the Python expression: list(o)\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PySequence_Fast(PyObject *o, const char* m);\r
+ /*\r
+ Return the sequence, o, as a list, unless it's already a\r
+ tuple or list. Use PySequence_Fast_GET_ITEM to access the\r
+ members of this list, and PySequence_Fast_GET_SIZE to get its length.\r
+\r
+ Returns NULL on failure. If the object does not support iteration,\r
+ raises a TypeError exception with m as the message text.\r
+ */\r
+\r
+#define PySequence_Fast_GET_SIZE(o) \\r
+ (PyList_Check(o) ? PyList_GET_SIZE(o) : PyTuple_GET_SIZE(o))\r
+ /*\r
+ Return the size of o, assuming that o was returned by\r
+ PySequence_Fast and is not NULL.\r
+ */\r
+\r
+#define PySequence_Fast_GET_ITEM(o, i)\\r
+ (PyList_Check(o) ? PyList_GET_ITEM(o, i) : PyTuple_GET_ITEM(o, i))\r
+ /*\r
+ Return the ith element of o, assuming that o was returned by\r
+ PySequence_Fast, and that i is within bounds.\r
+ */\r
+\r
+#define PySequence_ITEM(o, i)\\r
+ ( Py_TYPE(o)->tp_as_sequence->sq_item(o, i) )\r
+ /* Assume tp_as_sequence and sq_item exist and that i does not\r
+ need to be corrected for a negative index\r
+ */\r
+\r
+#define PySequence_Fast_ITEMS(sf) \\r
+ (PyList_Check(sf) ? ((PyListObject *)(sf))->ob_item \\r
+ : ((PyTupleObject *)(sf))->ob_item)\r
+ /* Return a pointer to the underlying item array for\r
+ an object retured by PySequence_Fast */\r
+\r
+ PyAPI_FUNC(Py_ssize_t) PySequence_Count(PyObject *o, PyObject *value);\r
+\r
+ /*\r
+ Return the number of occurrences on value on o, that is,\r
+ return the number of keys for which o[key]==value. On\r
+ failure, return -1. This is equivalent to the Python\r
+ expression: o.count(value).\r
+ */\r
+\r
+ PyAPI_FUNC(int) PySequence_Contains(PyObject *seq, PyObject *ob);\r
+ /*\r
+ Return -1 if error; 1 if ob in seq; 0 if ob not in seq.\r
+ Use __contains__ if possible, else _PySequence_IterSearch().\r
+ */\r
+\r
+#define PY_ITERSEARCH_COUNT 1\r
+#define PY_ITERSEARCH_INDEX 2\r
+#define PY_ITERSEARCH_CONTAINS 3\r
+ PyAPI_FUNC(Py_ssize_t) _PySequence_IterSearch(PyObject *seq,\r
+ PyObject *obj, int operation);\r
+ /*\r
+ Iterate over seq. Result depends on the operation:\r
+ PY_ITERSEARCH_COUNT: return # of times obj appears in seq; -1 if\r
+ error.\r
+ PY_ITERSEARCH_INDEX: return 0-based index of first occurrence of\r
+ obj in seq; set ValueError and return -1 if none found;\r
+ also return -1 on error.\r
+ PY_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on\r
+ error.\r
+ */\r
+\r
+/* For DLL-level backwards compatibility */\r
+#undef PySequence_In\r
+ PyAPI_FUNC(int) PySequence_In(PyObject *o, PyObject *value);\r
+\r
+/* For source-level backwards compatibility */\r
+#define PySequence_In PySequence_Contains\r
+\r
+ /*\r
+ Determine if o contains value. If an item in o is equal to\r
+ X, return 1, otherwise return 0. On error, return -1. This\r
+ is equivalent to the Python expression: value in o.\r
+ */\r
+\r
+ PyAPI_FUNC(Py_ssize_t) PySequence_Index(PyObject *o, PyObject *value);\r
+\r
+ /*\r
+ Return the first index for which o[i]=value. On error,\r
+ return -1. This is equivalent to the Python\r
+ expression: o.index(value).\r
+ */\r
+\r
+/* In-place versions of some of the above Sequence functions. */\r
+\r
+ PyAPI_FUNC(PyObject *) PySequence_InPlaceConcat(PyObject *o1, PyObject *o2);\r
+\r
+ /*\r
+ Append o2 to o1, in-place when possible. Return the resulting\r
+ object, which could be o1, or NULL on failure. This is the\r
+ equivalent of the Python expression: o1 += o2.\r
+\r
+ */\r
+\r
+ PyAPI_FUNC(PyObject *) PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count);\r
+\r
+ /*\r
+ Repeat o1 by count, in-place when possible. Return the resulting\r
+ object, which could be o1, or NULL on failure. This is the\r
+ equivalent of the Python expression: o1 *= count.\r
+\r
+ */\r
+\r
+/* Mapping protocol:*/\r
+\r
+ PyAPI_FUNC(int) PyMapping_Check(PyObject *o);\r
+\r
+ /*\r
+ Return 1 if the object provides mapping protocol, and zero\r
+ otherwise.\r
+\r
+ This function always succeeds.\r
+ */\r
+\r
+ PyAPI_FUNC(Py_ssize_t) PyMapping_Size(PyObject *o);\r
+\r
+ /*\r
+ Returns the number of keys in object o on success, and -1 on\r
+ failure. For objects that do not provide sequence protocol,\r
+ this is equivalent to the Python expression: len(o).\r
+ */\r
+\r
+ /* For DLL compatibility */\r
+#undef PyMapping_Length\r
+ PyAPI_FUNC(Py_ssize_t) PyMapping_Length(PyObject *o);\r
+#define PyMapping_Length PyMapping_Size\r
+\r
+\r
+ /* implemented as a macro:\r
+\r
+ int PyMapping_DelItemString(PyObject *o, char *key);\r
+\r
+ Remove the mapping for object, key, from the object *o.\r
+ Returns -1 on failure. This is equivalent to\r
+ the Python statement: del o[key].\r
+ */\r
+#define PyMapping_DelItemString(O,K) PyObject_DelItemString((O),(K))\r
+\r
+ /* implemented as a macro:\r
+\r
+ int PyMapping_DelItem(PyObject *o, PyObject *key);\r
+\r
+ Remove the mapping for object, key, from the object *o.\r
+ Returns -1 on failure. This is equivalent to\r
+ the Python statement: del o[key].\r
+ */\r
+#define PyMapping_DelItem(O,K) PyObject_DelItem((O),(K))\r
+\r
+ PyAPI_FUNC(int) PyMapping_HasKeyString(PyObject *o, char *key);\r
+\r
+ /*\r
+ On success, return 1 if the mapping object has the key, key,\r
+ and 0 otherwise. This is equivalent to the Python expression:\r
+ o.has_key(key).\r
+\r
+ This function always succeeds.\r
+ */\r
+\r
+ PyAPI_FUNC(int) PyMapping_HasKey(PyObject *o, PyObject *key);\r
+\r
+ /*\r
+ Return 1 if the mapping object has the key, key,\r
+ and 0 otherwise. This is equivalent to the Python expression:\r
+ o.has_key(key).\r
+\r
+ This function always succeeds.\r
+\r
+ */\r
+\r
+ /* Implemented as macro:\r
+\r
+ PyObject *PyMapping_Keys(PyObject *o);\r
+\r
+ On success, return a list of the keys in object o. On\r
+ failure, return NULL. This is equivalent to the Python\r
+ expression: o.keys().\r
+ */\r
+#define PyMapping_Keys(O) PyObject_CallMethod(O,"keys",NULL)\r
+\r
+ /* Implemented as macro:\r
+\r
+ PyObject *PyMapping_Values(PyObject *o);\r
+\r
+ On success, return a list of the values in object o. On\r
+ failure, return NULL. This is equivalent to the Python\r
+ expression: o.values().\r
+ */\r
+#define PyMapping_Values(O) PyObject_CallMethod(O,"values",NULL)\r
+\r
+ /* Implemented as macro:\r
+\r
+ PyObject *PyMapping_Items(PyObject *o);\r
+\r
+ On success, return a list of the items in object o, where\r
+ each item is a tuple containing a key-value pair. On\r
+ failure, return NULL. This is equivalent to the Python\r
+ expression: o.items().\r
+\r
+ */\r
+#define PyMapping_Items(O) PyObject_CallMethod(O,"items",NULL)\r
+\r
+ PyAPI_FUNC(PyObject *) PyMapping_GetItemString(PyObject *o, char *key);\r
+\r
+ /*\r
+ Return element of o corresponding to the object, key, or NULL\r
+ on failure. This is the equivalent of the Python expression:\r
+ o[key].\r
+ */\r
+\r
+ PyAPI_FUNC(int) PyMapping_SetItemString(PyObject *o, char *key,\r
+ PyObject *value);\r
+\r
+ /*\r
+ Map the object, key, to the value, v. Returns\r
+ -1 on failure. This is the equivalent of the Python\r
+ statement: o[key]=v.\r
+ */\r
+\r
+\r
+PyAPI_FUNC(int) PyObject_IsInstance(PyObject *object, PyObject *typeorclass);\r
+ /* isinstance(object, typeorclass) */\r
+\r
+PyAPI_FUNC(int) PyObject_IsSubclass(PyObject *object, PyObject *typeorclass);\r
+ /* issubclass(object, typeorclass) */\r
+\r
+\r
+PyAPI_FUNC(int) _PyObject_RealIsInstance(PyObject *inst, PyObject *cls);\r
+\r
+PyAPI_FUNC(int) _PyObject_RealIsSubclass(PyObject *derived, PyObject *cls);\r
+\r
+\r
+/* For internal use by buffer API functions */\r
+PyAPI_FUNC(void) _Py_add_one_to_index_F(int nd, Py_ssize_t *index,\r
+ const Py_ssize_t *shape);\r
+PyAPI_FUNC(void) _Py_add_one_to_index_C(int nd, Py_ssize_t *index,\r
+ const Py_ssize_t *shape);\r
+\r
+\r
+#ifdef __cplusplus\r
+}\r
+#endif\r
+#endif /* Py_ABSTRACTOBJECT_H */\r
projects / mirror_edk2.git / blobdiff