Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1 | #ifndef Py_ABSTRACTOBJECT_H |
| 2 | #define Py_ABSTRACTOBJECT_H |
| 3 | #ifdef __cplusplus |
| 4 | extern "C" { |
| 5 | #endif |
| 6 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 7 | #ifdef PY_SSIZE_T_CLEAN |
| 8 | #define PyObject_CallFunction _PyObject_CallFunction_SizeT |
| 9 | #define PyObject_CallMethod _PyObject_CallMethod_SizeT |
| 10 | #endif |
| 11 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 12 | /* Abstract Object Interface (many thanks to Jim Fulton) */ |
| 13 | |
| 14 | /* |
| 15 | PROPOSAL: A Generic Python Object Interface for Python C Modules |
| 16 | |
| 17 | Problem |
| 18 | |
| 19 | Python modules written in C that must access Python objects must do |
| 20 | so through routines whose interfaces are described by a set of |
| 21 | include files. Unfortunately, these routines vary according to the |
| 22 | object accessed. To use these routines, the C programmer must check |
| 23 | the type of the object being used and must call a routine based on |
| 24 | the object type. For example, to access an element of a sequence, |
| 25 | the programmer must determine whether the sequence is a list or a |
| 26 | tuple: |
| 27 | |
| 28 | if(is_tupleobject(o)) |
| 29 | e=gettupleitem(o,i) |
| 30 | else if(is_listitem(o)) |
| 31 | e=getlistitem(o,i) |
| 32 | |
| 33 | If the programmer wants to get an item from another type of object |
| 34 | that provides sequence behavior, there is no clear way to do it |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 35 | correctly. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 36 | |
| 37 | The persistent programmer may peruse object.h and find that the |
| 38 | _typeobject structure provides a means of invoking up to (currently |
| 39 | about) 41 special operators. So, for example, a routine can get an |
| 40 | item from any object that provides sequence behavior. However, to |
| 41 | use this mechanism, the programmer must make their code dependent on |
| 42 | the current Python implementation. |
| 43 | |
| 44 | Also, certain semantics, especially memory management semantics, may |
| 45 | differ by the type of object being used. Unfortunately, these |
| 46 | semantics are not clearly described in the current include files. |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 47 | An abstract interface providing more consistent semantics is needed. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 48 | |
| 49 | Proposal |
| 50 | |
| 51 | I propose the creation of a standard interface (with an associated |
| 52 | library of routines and/or macros) for generically obtaining the |
| 53 | services of Python objects. This proposal can be viewed as one |
| 54 | components of a Python C interface consisting of several components. |
| 55 | |
Raymond Hettinger | a72e2f9 | 2003-02-28 05:11:03 +0000 | [diff] [blame] | 56 | From the viewpoint of C access to Python services, we have (as |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 57 | suggested by Guido in off-line discussions): |
| 58 | |
| 59 | - "Very high level layer": two or three functions that let you exec or |
| 60 | eval arbitrary Python code given as a string in a module whose name is |
| 61 | given, passing C values in and getting C values out using |
| 62 | mkvalue/getargs style format strings. This does not require the user |
| 63 | to declare any variables of type "PyObject *". This should be enough |
| 64 | to write a simple application that gets Python code from the user, |
| 65 | execs it, and returns the output or errors. (Error handling must also |
| 66 | be part of this API.) |
| 67 | |
| 68 | - "Abstract objects layer": which is the subject of this proposal. |
| 69 | It has many functions operating on objects, and lest you do many |
| 70 | things from C that you can also write in Python, without going |
| 71 | through the Python parser. |
| 72 | |
| 73 | - "Concrete objects layer": This is the public type-dependent |
| 74 | interface provided by the standard built-in types, such as floats, |
| 75 | strings, and lists. This interface exists and is currently |
Raymond Hettinger | a72e2f9 | 2003-02-28 05:11:03 +0000 | [diff] [blame] | 76 | documented by the collection of include files provided with the |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 77 | Python distributions. |
| 78 | |
| 79 | From the point of view of Python accessing services provided by C |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 80 | modules: |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 81 | |
| 82 | - "Python module interface": this interface consist of the basic |
| 83 | routines used to define modules and their members. Most of the |
| 84 | current extensions-writing guide deals with this interface. |
| 85 | |
| 86 | - "Built-in object interface": this is the interface that a new |
| 87 | built-in type must provide and the mechanisms and rules that a |
| 88 | developer of a new built-in type must use and follow. |
| 89 | |
| 90 | This proposal is a "first-cut" that is intended to spur |
| 91 | discussion. See especially the lists of notes. |
| 92 | |
| 93 | The Python C object interface will provide four protocols: object, |
| 94 | numeric, sequence, and mapping. Each protocol consists of a |
| 95 | collection of related operations. If an operation that is not |
| 96 | provided by a particular type is invoked, then a standard exception, |
| 97 | NotImplementedError is raised with a operation name as an argument. |
| 98 | In addition, for convenience this interface defines a set of |
| 99 | constructors for building objects of built-in types. This is needed |
| 100 | so new objects can be returned from C functions that otherwise treat |
| 101 | objects generically. |
| 102 | |
| 103 | Memory Management |
| 104 | |
| 105 | For all of the functions described in this proposal, if a function |
| 106 | retains a reference to a Python object passed as an argument, then the |
| 107 | function will increase the reference count of the object. It is |
| 108 | unnecessary for the caller to increase the reference count of an |
| 109 | argument in anticipation of the object's retention. |
| 110 | |
| 111 | All Python objects returned from functions should be treated as new |
| 112 | objects. Functions that return objects assume that the caller will |
| 113 | retain a reference and the reference count of the object has already |
| 114 | been incremented to account for this fact. A caller that does not |
| 115 | retain a reference to an object that is returned from a function |
| 116 | must decrement the reference count of the object (using |
| 117 | DECREF(object)) to prevent memory leaks. |
| 118 | |
| 119 | Note that the behavior mentioned here is different from the current |
| 120 | behavior for some objects (e.g. lists and tuples) when certain |
| 121 | type-specific routines are called directly (e.g. setlistitem). The |
| 122 | proposed abstraction layer will provide a consistent memory |
| 123 | management interface, correcting for inconsistent behavior for some |
| 124 | built-in types. |
| 125 | |
| 126 | Protocols |
| 127 | |
| 128 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx*/ |
| 129 | |
| 130 | /* Object Protocol: */ |
| 131 | |
| 132 | /* Implemented elsewhere: |
| 133 | |
| 134 | int PyObject_Print(PyObject *o, FILE *fp, int flags); |
| 135 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 136 | Print an object, o, on file, fp. Returns -1 on |
| 137 | error. The flags argument is used to enable certain printing |
| 138 | options. The only option currently supported is Py_Print_RAW. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 139 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 140 | (What should be said about Py_Print_RAW?) |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 141 | |
| 142 | */ |
| 143 | |
| 144 | /* Implemented elsewhere: |
| 145 | |
| 146 | int PyObject_HasAttrString(PyObject *o, char *attr_name); |
| 147 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 148 | Returns 1 if o has the attribute attr_name, and 0 otherwise. |
| 149 | This is equivalent to the Python expression: |
| 150 | hasattr(o,attr_name). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 151 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 152 | This function always succeeds. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 153 | |
| 154 | */ |
| 155 | |
| 156 | /* Implemented elsewhere: |
| 157 | |
| 158 | PyObject* PyObject_GetAttrString(PyObject *o, char *attr_name); |
| 159 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 160 | Retrieve an attributed named attr_name form object o. |
| 161 | Returns the attribute value on success, or NULL on failure. |
| 162 | This is the equivalent of the Python expression: o.attr_name. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 163 | |
| 164 | */ |
| 165 | |
| 166 | /* Implemented elsewhere: |
| 167 | |
| 168 | int PyObject_HasAttr(PyObject *o, PyObject *attr_name); |
| 169 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 170 | Returns 1 if o has the attribute attr_name, and 0 otherwise. |
| 171 | This is equivalent to the Python expression: |
| 172 | hasattr(o,attr_name). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 173 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 174 | This function always succeeds. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 175 | |
| 176 | */ |
| 177 | |
| 178 | /* Implemented elsewhere: |
| 179 | |
| 180 | PyObject* PyObject_GetAttr(PyObject *o, PyObject *attr_name); |
| 181 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 182 | Retrieve an attributed named attr_name form object o. |
| 183 | Returns the attribute value on success, or NULL on failure. |
| 184 | This is the equivalent of the Python expression: o.attr_name. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 185 | |
| 186 | */ |
| 187 | |
| 188 | |
| 189 | /* Implemented elsewhere: |
| 190 | |
| 191 | int PyObject_SetAttrString(PyObject *o, char *attr_name, PyObject *v); |
| 192 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 193 | Set the value of the attribute named attr_name, for object o, |
| 194 | to the value, v. Returns -1 on failure. This is |
| 195 | the equivalent of the Python statement: o.attr_name=v. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 196 | |
| 197 | */ |
| 198 | |
| 199 | /* Implemented elsewhere: |
| 200 | |
| 201 | int PyObject_SetAttr(PyObject *o, PyObject *attr_name, PyObject *v); |
| 202 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 203 | Set the value of the attribute named attr_name, for object o, |
| 204 | to the value, v. Returns -1 on failure. This is |
| 205 | the equivalent of the Python statement: o.attr_name=v. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 206 | |
| 207 | */ |
| 208 | |
| 209 | /* implemented as a macro: |
| 210 | |
| 211 | int PyObject_DelAttrString(PyObject *o, char *attr_name); |
| 212 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 213 | Delete attribute named attr_name, for object o. Returns |
| 214 | -1 on failure. This is the equivalent of the Python |
| 215 | statement: del o.attr_name. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 216 | |
| 217 | */ |
| 218 | #define PyObject_DelAttrString(O,A) PyObject_SetAttrString((O),(A),NULL) |
| 219 | |
| 220 | /* implemented as a macro: |
| 221 | |
| 222 | int PyObject_DelAttr(PyObject *o, PyObject *attr_name); |
| 223 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 224 | Delete attribute named attr_name, for object o. Returns -1 |
| 225 | on failure. This is the equivalent of the Python |
| 226 | statement: del o.attr_name. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 227 | |
| 228 | */ |
| 229 | #define PyObject_DelAttr(O,A) PyObject_SetAttr((O),(A),NULL) |
| 230 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 231 | /* Implemented elsewhere: |
| 232 | |
| 233 | PyObject *PyObject_Repr(PyObject *o); |
| 234 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 235 | Compute the string representation of object, o. Returns the |
| 236 | string representation on success, NULL on failure. This is |
| 237 | the equivalent of the Python expression: repr(o). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 238 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 239 | Called by the repr() built-in function. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 240 | |
| 241 | */ |
| 242 | |
| 243 | /* Implemented elsewhere: |
| 244 | |
| 245 | PyObject *PyObject_Str(PyObject *o); |
| 246 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 247 | Compute the string representation of object, o. Returns the |
| 248 | string representation on success, NULL on failure. This is |
| 249 | the equivalent of the Python expression: str(o).) |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 250 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 251 | Called by the str() and print() built-in functions. |
Marc-André Lemburg | ad7c98e | 2001-01-17 17:09:53 +0000 | [diff] [blame] | 252 | |
| 253 | */ |
| 254 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 255 | /* Declared elsewhere |
| 256 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 257 | PyAPI_FUNC(int) PyCallable_Check(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 258 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 259 | Determine if the object, o, is callable. Return 1 if the |
| 260 | object is callable and 0 otherwise. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 261 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 262 | This function always succeeds. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 263 | */ |
| 264 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 265 | PyAPI_FUNC(PyObject *) PyObject_Call(PyObject *callable_object, |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 266 | PyObject *args, PyObject *kw); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 267 | |
| 268 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 269 | Call a callable Python object, callable_object, with |
| 270 | arguments and keywords arguments. The 'args' argument can not be |
| 271 | NULL, but the 'kw' argument can be NULL. |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 272 | */ |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 273 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 274 | PyAPI_FUNC(PyObject *) PyObject_CallObject(PyObject *callable_object, |
Neal Norwitz | fe55464 | 2006-03-17 06:58:45 +0000 | [diff] [blame] | 275 | PyObject *args); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 276 | |
| 277 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 278 | Call a callable Python object, callable_object, with |
| 279 | arguments given by the tuple, args. If no arguments are |
| 280 | needed, then args may be NULL. Returns the result of the |
| 281 | call on success, or NULL on failure. This is the equivalent |
| 282 | of the Python expression: o(*args). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 283 | */ |
| 284 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 285 | PyAPI_FUNC(PyObject *) PyObject_CallFunction(PyObject *callable_object, |
Neal Norwitz | fe55464 | 2006-03-17 06:58:45 +0000 | [diff] [blame] | 286 | char *format, ...); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 287 | |
| 288 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 289 | Call a callable Python object, callable_object, with a |
| 290 | variable number of C arguments. The C arguments are described |
| 291 | using a mkvalue-style format string. The format may be NULL, |
| 292 | indicating that no arguments are provided. Returns the |
| 293 | result of the call on success, or NULL on failure. This is |
| 294 | the equivalent of the Python expression: o(*args). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 295 | */ |
| 296 | |
| 297 | |
Neal Norwitz | fe55464 | 2006-03-17 06:58:45 +0000 | [diff] [blame] | 298 | PyAPI_FUNC(PyObject *) PyObject_CallMethod(PyObject *o, char *method, |
| 299 | char *format, ...); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 300 | |
| 301 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 302 | Call the method named m of object o with a variable number of |
| 303 | C arguments. The C arguments are described by a mkvalue |
| 304 | format string. The format may be NULL, indicating that no |
| 305 | arguments are provided. Returns the result of the call on |
| 306 | success, or NULL on failure. This is the equivalent of the |
| 307 | Python expression: o.method(args). |
Fred Drake | b421b8c | 2001-10-26 16:21:32 +0000 | [diff] [blame] | 308 | */ |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 309 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 310 | PyAPI_FUNC(PyObject *) _PyObject_CallFunction_SizeT(PyObject *callable, |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 311 | char *format, ...); |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 312 | PyAPI_FUNC(PyObject *) _PyObject_CallMethod_SizeT(PyObject *o, |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 313 | char *name, |
| 314 | char *format, ...); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 315 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 316 | PyAPI_FUNC(PyObject *) PyObject_CallFunctionObjArgs(PyObject *callable, |
Neal Norwitz | fe55464 | 2006-03-17 06:58:45 +0000 | [diff] [blame] | 317 | ...); |
Fred Drake | b421b8c | 2001-10-26 16:21:32 +0000 | [diff] [blame] | 318 | |
| 319 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 320 | Call a callable Python object, callable_object, with a |
| 321 | variable number of C arguments. The C arguments are provided |
| 322 | as PyObject * values, terminated by a NULL. Returns the |
| 323 | result of the call on success, or NULL on failure. This is |
| 324 | the equivalent of the Python expression: o(*args). |
Fred Drake | b421b8c | 2001-10-26 16:21:32 +0000 | [diff] [blame] | 325 | */ |
| 326 | |
| 327 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 328 | PyAPI_FUNC(PyObject *) PyObject_CallMethodObjArgs(PyObject *o, |
Neal Norwitz | fe55464 | 2006-03-17 06:58:45 +0000 | [diff] [blame] | 329 | PyObject *method, ...); |
Fred Drake | b421b8c | 2001-10-26 16:21:32 +0000 | [diff] [blame] | 330 | |
| 331 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 332 | Call the method named m of object o with a variable number of |
| 333 | C arguments. The C arguments are provided as PyObject * |
| 334 | values, terminated by NULL. Returns the result of the call |
| 335 | on success, or NULL on failure. This is the equivalent of |
| 336 | the Python expression: o.method(args). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 337 | */ |
| 338 | |
| 339 | |
| 340 | /* Implemented elsewhere: |
| 341 | |
| 342 | long PyObject_Hash(PyObject *o); |
| 343 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 344 | Compute and return the hash, hash_value, of an object, o. On |
| 345 | failure, return -1. This is the equivalent of the Python |
| 346 | expression: hash(o). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 347 | */ |
| 348 | |
| 349 | |
| 350 | /* Implemented elsewhere: |
| 351 | |
| 352 | int PyObject_IsTrue(PyObject *o); |
| 353 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 354 | Returns 1 if the object, o, is considered to be true, 0 if o is |
| 355 | considered to be false and -1 on failure. This is equivalent to the |
| 356 | Python expression: not not o |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 357 | */ |
| 358 | |
Guido van Rossum | c3d3f96 | 1998-04-09 17:53:59 +0000 | [diff] [blame] | 359 | /* Implemented elsewhere: |
| 360 | |
| 361 | int PyObject_Not(PyObject *o); |
| 362 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 363 | Returns 0 if the object, o, is considered to be true, 1 if o is |
| 364 | considered to be false and -1 on failure. This is equivalent to the |
| 365 | Python expression: not o |
Guido van Rossum | c3d3f96 | 1998-04-09 17:53:59 +0000 | [diff] [blame] | 366 | */ |
| 367 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 368 | PyAPI_FUNC(PyObject *) PyObject_Type(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 369 | |
| 370 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 371 | On success, returns a type object corresponding to the object |
| 372 | type of object o. On failure, returns NULL. This is |
| 373 | equivalent to the Python expression: type(o). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 374 | */ |
| 375 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 376 | PyAPI_FUNC(Py_ssize_t) PyObject_Size(PyObject *o); |
Jeremy Hylton | 6253f83 | 2000-07-12 12:56:19 +0000 | [diff] [blame] | 377 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 378 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 379 | Return the size of object o. If the object, o, provides |
| 380 | both sequence and mapping protocols, the sequence size is |
| 381 | returned. On error, -1 is returned. This is the equivalent |
| 382 | to the Python expression: len(o). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 383 | */ |
| 384 | |
Marc-André Lemburg | cf5f358 | 2000-07-17 09:22:55 +0000 | [diff] [blame] | 385 | /* For DLL compatibility */ |
| 386 | #undef PyObject_Length |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 387 | PyAPI_FUNC(Py_ssize_t) PyObject_Length(PyObject *o); |
Marc-André Lemburg | cf5f358 | 2000-07-17 09:22:55 +0000 | [diff] [blame] | 388 | #define PyObject_Length PyObject_Size |
| 389 | |
Christian Heimes | 255f53b | 2007-12-08 15:33:56 +0000 | [diff] [blame] | 390 | PyAPI_FUNC(Py_ssize_t) _PyObject_LengthHint(PyObject *o, Py_ssize_t); |
Raymond Hettinger | 6b27cda | 2005-09-24 21:23:05 +0000 | [diff] [blame] | 391 | |
| 392 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 393 | Guess the size of object o using len(o) or o.__length_hint__(). |
| 394 | If neither of those return a non-negative value, then return the |
| 395 | default value. If one of the calls fails, this function returns -1. |
Raymond Hettinger | 6b27cda | 2005-09-24 21:23:05 +0000 | [diff] [blame] | 396 | */ |
Marc-André Lemburg | cf5f358 | 2000-07-17 09:22:55 +0000 | [diff] [blame] | 397 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 398 | PyAPI_FUNC(PyObject *) PyObject_GetItem(PyObject *o, PyObject *key); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 399 | |
| 400 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 401 | Return element of o corresponding to the object, key, or NULL |
| 402 | on failure. This is the equivalent of the Python expression: |
| 403 | o[key]. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 404 | */ |
| 405 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 406 | PyAPI_FUNC(int) PyObject_SetItem(PyObject *o, PyObject *key, PyObject *v); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 407 | |
| 408 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 409 | Map the object, key, to the value, v. Returns |
| 410 | -1 on failure. This is the equivalent of the Python |
| 411 | statement: o[key]=v. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 412 | */ |
| 413 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 414 | PyAPI_FUNC(int) PyObject_DelItemString(PyObject *o, char *key); |
Martin v. Löwis | b0d71d0 | 2002-01-05 10:50:30 +0000 | [diff] [blame] | 415 | |
| 416 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 417 | Remove the mapping for object, key, from the object *o. |
| 418 | Returns -1 on failure. This is equivalent to |
| 419 | the Python statement: del o[key]. |
Martin v. Löwis | b0d71d0 | 2002-01-05 10:50:30 +0000 | [diff] [blame] | 420 | */ |
| 421 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 422 | PyAPI_FUNC(int) PyObject_DelItem(PyObject *o, PyObject *key); |
Guido van Rossum | 6cdc6f4 | 1996-08-21 17:41:54 +0000 | [diff] [blame] | 423 | |
| 424 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 425 | Delete the mapping for key from *o. Returns -1 on failure. |
| 426 | This is the equivalent of the Python statement: del o[key]. |
Guido van Rossum | 6cdc6f4 | 1996-08-21 17:41:54 +0000 | [diff] [blame] | 427 | */ |
| 428 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 429 | /* old buffer API |
| 430 | FIXME: usage of these should all be replaced in Python itself |
| 431 | but for backwards compatibility we will implement them. |
| 432 | Their usage without a corresponding "unlock" mechansim |
| 433 | may create issues (but they would already be there). */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 434 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 435 | PyAPI_FUNC(int) PyObject_AsCharBuffer(PyObject *obj, |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 436 | const char **buffer, |
| 437 | Py_ssize_t *buffer_len); |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 438 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 439 | /* |
| 440 | Takes an arbitrary object which must support the (character, |
| 441 | single segment) buffer interface and returns a pointer to a |
| 442 | read-only memory location useable as character based input |
| 443 | for subsequent processing. |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 444 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 445 | 0 is returned on success. buffer and buffer_len are only |
| 446 | set in case no error occurs. Otherwise, -1 is returned and |
| 447 | an exception set. |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 448 | */ |
| 449 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 450 | PyAPI_FUNC(int) PyObject_CheckReadBuffer(PyObject *obj); |
Jeremy Hylton | 89c3a22 | 2001-11-09 21:59:42 +0000 | [diff] [blame] | 451 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 452 | /* |
| 453 | Checks whether an arbitrary object supports the (character, |
| 454 | single segment) buffer interface. Returns 1 on success, 0 |
| 455 | on failure. |
Jeremy Hylton | 89c3a22 | 2001-11-09 21:59:42 +0000 | [diff] [blame] | 456 | */ |
| 457 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 458 | PyAPI_FUNC(int) PyObject_AsReadBuffer(PyObject *obj, |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 459 | const void **buffer, |
| 460 | Py_ssize_t *buffer_len); |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 461 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 462 | /* |
| 463 | Same as PyObject_AsCharBuffer() except that this API expects |
| 464 | (readable, single segment) buffer interface and returns a |
| 465 | pointer to a read-only memory location which can contain |
| 466 | arbitrary data. |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 467 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 468 | 0 is returned on success. buffer and buffer_len are only |
| 469 | set in case no error occurrs. Otherwise, -1 is returned and |
| 470 | an exception set. |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 471 | */ |
| 472 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 473 | PyAPI_FUNC(int) PyObject_AsWriteBuffer(PyObject *obj, |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 474 | void **buffer, |
| 475 | Py_ssize_t *buffer_len); |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 476 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 477 | /* |
| 478 | Takes an arbitrary object which must support the (writable, |
| 479 | single segment) buffer interface and returns a pointer to a |
| 480 | writable memory location in buffer of size buffer_len. |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 481 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 482 | 0 is returned on success. buffer and buffer_len are only |
| 483 | set in case no error occurrs. Otherwise, -1 is returned and |
| 484 | an exception set. |
Guido van Rossum | fd9eed3 | 2000-03-10 22:35:06 +0000 | [diff] [blame] | 485 | */ |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 486 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 487 | /* new buffer API */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 488 | |
| 489 | #define PyObject_CheckBuffer(obj) \ |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 490 | (((obj)->ob_type->tp_as_buffer != NULL) && \ |
| 491 | ((obj)->ob_type->tp_as_buffer->bf_getbuffer != NULL)) |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 492 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 493 | /* Return 1 if the getbuffer function is available, otherwise |
| 494 | return 0 */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 495 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 496 | PyAPI_FUNC(int) PyObject_GetBuffer(PyObject *obj, Py_buffer *view, |
| 497 | int flags); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 498 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 499 | /* This is a C-API version of the getbuffer function call. It checks |
| 500 | to make sure object has the required function pointer and issues the |
| 501 | call. Returns -1 and raises an error on failure and returns 0 on |
| 502 | success |
| 503 | */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 504 | |
| 505 | |
Travis E. Oliphant | 8ae62b6 | 2007-09-23 02:00:13 +0000 | [diff] [blame] | 506 | PyAPI_FUNC(void *) PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices); |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 507 | |
| 508 | /* Get the memory area pointed to by the indices for the buffer given. |
| 509 | Note that view->ndim is the assumed size of indices |
| 510 | */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 511 | |
| 512 | PyAPI_FUNC(int) PyBuffer_SizeFromFormat(const char *); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 513 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 514 | /* Return the implied itemsize of the data-format area from a |
| 515 | struct-style description */ |
| 516 | |
| 517 | |
| 518 | |
Travis E. Oliphant | 8ae62b6 | 2007-09-23 02:00:13 +0000 | [diff] [blame] | 519 | PyAPI_FUNC(int) PyBuffer_ToContiguous(void *buf, Py_buffer *view, |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 520 | Py_ssize_t len, char fort); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 521 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 522 | PyAPI_FUNC(int) PyBuffer_FromContiguous(Py_buffer *view, void *buf, |
| 523 | Py_ssize_t len, char fort); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 524 | |
| 525 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 526 | /* Copy len bytes of data from the contiguous chunk of memory |
| 527 | pointed to by buf into the buffer exported by obj. Return |
| 528 | 0 on success and return -1 and raise a PyBuffer_Error on |
| 529 | error (i.e. the object does not have a buffer interface or |
| 530 | it is not working). |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 531 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 532 | If fort is 'F', then if the object is multi-dimensional, |
| 533 | then the data will be copied into the array in |
| 534 | Fortran-style (first dimension varies the fastest). If |
| 535 | fort is 'C', then the data will be copied into the array |
| 536 | in C-style (last dimension varies the fastest). If fort |
| 537 | is 'A', then it does not matter and the copy will be made |
| 538 | in whatever way is more efficient. |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 539 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 540 | */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 541 | |
| 542 | PyAPI_FUNC(int) PyObject_CopyData(PyObject *dest, PyObject *src); |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 543 | |
| 544 | /* Copy the data from the src buffer to the buffer of destination |
| 545 | */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 546 | |
Christian Heimes | c36625b | 2008-01-04 13:33:00 +0000 | [diff] [blame] | 547 | PyAPI_FUNC(int) PyBuffer_IsContiguous(Py_buffer *view, char fort); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 548 | |
| 549 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 550 | PyAPI_FUNC(void) PyBuffer_FillContiguousStrides(int ndims, |
| 551 | Py_ssize_t *shape, |
| 552 | Py_ssize_t *strides, |
| 553 | int itemsize, |
| 554 | char fort); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 555 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 556 | /* Fill the strides array with byte-strides of a contiguous |
| 557 | (Fortran-style if fort is 'F' or C-style otherwise) |
| 558 | array of the given shape with the given number of bytes |
| 559 | per element. |
| 560 | */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 561 | |
Martin v. Löwis | 423be95 | 2008-08-13 15:53:07 +0000 | [diff] [blame] | 562 | PyAPI_FUNC(int) PyBuffer_FillInfo(Py_buffer *view, PyObject *o, void *buf, |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 563 | Py_ssize_t len, int readonly, |
| 564 | int flags); |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 565 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 566 | /* Fills in a buffer-info structure correctly for an exporter |
| 567 | that can only share a contiguous chunk of memory of |
| 568 | "unsigned bytes" of the given length. Returns 0 on success |
| 569 | and -1 (with raising an error) on error. |
| 570 | */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 571 | |
Martin v. Löwis | 423be95 | 2008-08-13 15:53:07 +0000 | [diff] [blame] | 572 | PyAPI_FUNC(void) PyBuffer_Release(Py_buffer *view); |
| 573 | |
| 574 | /* Releases a Py_buffer obtained from getbuffer ParseTuple's s*. |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 575 | */ |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 576 | |
Eric Smith | 8fd3eba | 2008-02-17 19:48:00 +0000 | [diff] [blame] | 577 | PyAPI_FUNC(PyObject *) PyObject_Format(PyObject* obj, |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 578 | PyObject *format_spec); |
Eric Smith | 8fd3eba | 2008-02-17 19:48:00 +0000 | [diff] [blame] | 579 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 580 | Takes an arbitrary object and returns the result of |
| 581 | calling obj.__format__(format_spec). |
Eric Smith | 8fd3eba | 2008-02-17 19:48:00 +0000 | [diff] [blame] | 582 | */ |
| 583 | |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 584 | /* Iterators */ |
| 585 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 586 | PyAPI_FUNC(PyObject *) PyObject_GetIter(PyObject *); |
Guido van Rossum | 59d1d2b | 2001-04-20 19:13:02 +0000 | [diff] [blame] | 587 | /* Takes an object and returns an iterator for it. |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 588 | This is typically a new iterator but if the argument |
| 589 | is an iterator, this returns itself. */ |
Guido van Rossum | 59d1d2b | 2001-04-20 19:13:02 +0000 | [diff] [blame] | 590 | |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 591 | #define PyIter_Check(obj) \ |
Amaury Forgeot d'Arc | f343e01 | 2009-01-12 23:58:21 +0000 | [diff] [blame] | 592 | ((obj)->ob_type->tp_iternext != NULL && \ |
| 593 | (obj)->ob_type->tp_iternext != &_PyObject_NextNotImplemented) |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 594 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 595 | PyAPI_FUNC(PyObject *) PyIter_Next(PyObject *); |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 596 | /* Takes an iterator object and calls its tp_iternext slot, |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 597 | returning the next value. If the iterator is exhausted, |
| 598 | this returns NULL without setting an exception. |
| 599 | NULL with an exception means an error occurred. */ |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 600 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 601 | /* Number Protocol:*/ |
| 602 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 603 | PyAPI_FUNC(int) PyNumber_Check(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 604 | |
| 605 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 606 | Returns 1 if the object, o, provides numeric protocols, and |
| 607 | false otherwise. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 608 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 609 | This function always succeeds. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 610 | */ |
| 611 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 612 | PyAPI_FUNC(PyObject *) PyNumber_Add(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 613 | |
| 614 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 615 | Returns the result of adding o1 and o2, or null on failure. |
| 616 | This is the equivalent of the Python expression: o1+o2. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 617 | */ |
| 618 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 619 | PyAPI_FUNC(PyObject *) PyNumber_Subtract(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 620 | |
| 621 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 622 | Returns the result of subtracting o2 from o1, or null on |
| 623 | failure. This is the equivalent of the Python expression: |
| 624 | o1-o2. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 625 | */ |
| 626 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 627 | PyAPI_FUNC(PyObject *) PyNumber_Multiply(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 628 | |
| 629 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 630 | Returns the result of multiplying o1 and o2, or null on |
| 631 | failure. This is the equivalent of the Python expression: |
| 632 | o1*o2. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 633 | */ |
| 634 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 635 | PyAPI_FUNC(PyObject *) PyNumber_FloorDivide(PyObject *o1, PyObject *o2); |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 636 | |
| 637 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 638 | Returns the result of dividing o1 by o2 giving an integral result, |
| 639 | or null on failure. |
| 640 | This is the equivalent of the Python expression: o1//o2. |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 641 | */ |
| 642 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 643 | PyAPI_FUNC(PyObject *) PyNumber_TrueDivide(PyObject *o1, PyObject *o2); |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 644 | |
| 645 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 646 | Returns the result of dividing o1 by o2 giving a float result, |
| 647 | or null on failure. |
| 648 | This is the equivalent of the Python expression: o1/o2. |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 649 | */ |
| 650 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 651 | PyAPI_FUNC(PyObject *) PyNumber_Remainder(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 652 | |
| 653 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 654 | Returns the remainder of dividing o1 by o2, or null on |
| 655 | failure. This is the equivalent of the Python expression: |
| 656 | o1%o2. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 657 | */ |
| 658 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 659 | PyAPI_FUNC(PyObject *) PyNumber_Divmod(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 660 | |
| 661 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 662 | See the built-in function divmod. Returns NULL on failure. |
| 663 | This is the equivalent of the Python expression: |
| 664 | divmod(o1,o2). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 665 | */ |
| 666 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 667 | PyAPI_FUNC(PyObject *) PyNumber_Power(PyObject *o1, PyObject *o2, |
Neal Norwitz | fe55464 | 2006-03-17 06:58:45 +0000 | [diff] [blame] | 668 | PyObject *o3); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 669 | |
| 670 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 671 | See the built-in function pow. Returns NULL on failure. |
| 672 | This is the equivalent of the Python expression: |
| 673 | pow(o1,o2,o3), where o3 is optional. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 674 | */ |
| 675 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 676 | PyAPI_FUNC(PyObject *) PyNumber_Negative(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 677 | |
| 678 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 679 | Returns the negation of o on success, or null on failure. |
| 680 | This is the equivalent of the Python expression: -o. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 681 | */ |
| 682 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 683 | PyAPI_FUNC(PyObject *) PyNumber_Positive(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 684 | |
| 685 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 686 | Returns the (what?) of o on success, or NULL on failure. |
| 687 | This is the equivalent of the Python expression: +o. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 688 | */ |
| 689 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 690 | PyAPI_FUNC(PyObject *) PyNumber_Absolute(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 691 | |
| 692 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 693 | Returns the absolute value of o, or null on failure. This is |
| 694 | the equivalent of the Python expression: abs(o). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 695 | */ |
| 696 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 697 | PyAPI_FUNC(PyObject *) PyNumber_Invert(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 698 | |
| 699 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 700 | Returns the bitwise negation of o on success, or NULL on |
| 701 | failure. This is the equivalent of the Python expression: |
| 702 | ~o. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 703 | */ |
| 704 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 705 | PyAPI_FUNC(PyObject *) PyNumber_Lshift(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 706 | |
| 707 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 708 | Returns the result of left shifting o1 by o2 on success, or |
| 709 | NULL on failure. This is the equivalent of the Python |
| 710 | expression: o1 << o2. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 711 | */ |
| 712 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 713 | PyAPI_FUNC(PyObject *) PyNumber_Rshift(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 714 | |
| 715 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 716 | Returns the result of right shifting o1 by o2 on success, or |
| 717 | NULL on failure. This is the equivalent of the Python |
| 718 | expression: o1 >> o2. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 719 | */ |
| 720 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 721 | PyAPI_FUNC(PyObject *) PyNumber_And(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 722 | |
| 723 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 724 | Returns the result of bitwise and of o1 and o2 on success, or |
| 725 | NULL on failure. This is the equivalent of the Python |
| 726 | expression: o1&o2. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 727 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 728 | */ |
| 729 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 730 | PyAPI_FUNC(PyObject *) PyNumber_Xor(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 731 | |
| 732 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 733 | Returns the bitwise exclusive or of o1 by o2 on success, or |
| 734 | NULL on failure. This is the equivalent of the Python |
| 735 | expression: o1^o2. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 736 | */ |
| 737 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 738 | PyAPI_FUNC(PyObject *) PyNumber_Or(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 739 | |
| 740 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 741 | Returns the result of bitwise or on o1 and o2 on success, or |
| 742 | NULL on failure. This is the equivalent of the Python |
| 743 | expression: o1|o2. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 744 | */ |
| 745 | |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 746 | #define PyIndex_Check(obj) \ |
| 747 | ((obj)->ob_type->tp_as_number != NULL && \ |
| 748 | (obj)->ob_type->tp_as_number->nb_index != NULL) |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 749 | |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 750 | PyAPI_FUNC(PyObject *) PyNumber_Index(PyObject *o); |
Guido van Rossum | 38fff8c | 2006-03-07 18:50:55 +0000 | [diff] [blame] | 751 | |
| 752 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 753 | Returns the object converted to a Python long or int |
| 754 | or NULL with an error raised on failure. |
Guido van Rossum | 38fff8c | 2006-03-07 18:50:55 +0000 | [diff] [blame] | 755 | */ |
| 756 | |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 757 | PyAPI_FUNC(Py_ssize_t) PyNumber_AsSsize_t(PyObject *o, PyObject *exc); |
| 758 | |
| 759 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 760 | Returns the Integral instance converted to an int. The |
| 761 | instance is expected to be int or long or have an __int__ |
| 762 | method. Steals integral's reference. error_format will be |
| 763 | used to create the TypeError if integral isn't actually an |
| 764 | Integral instance. error_format should be a format string |
| 765 | that can accept a char* naming integral's type. |
Christian Heimes | 15ebc88 | 2008-02-04 18:48:49 +0000 | [diff] [blame] | 766 | */ |
| 767 | |
| 768 | PyAPI_FUNC(PyObject *) _PyNumber_ConvertIntegralToInt( |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 769 | PyObject *integral, |
| 770 | const char* error_format); |
Christian Heimes | 15ebc88 | 2008-02-04 18:48:49 +0000 | [diff] [blame] | 771 | |
| 772 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 773 | Returns the object converted to Py_ssize_t by going through |
| 774 | PyNumber_Index first. If an overflow error occurs while |
| 775 | converting the int-or-long to Py_ssize_t, then the second argument |
| 776 | is the error-type to return. If it is NULL, then the overflow error |
| 777 | is cleared and the value is clipped. |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 778 | */ |
Guido van Rossum | 38fff8c | 2006-03-07 18:50:55 +0000 | [diff] [blame] | 779 | |
Mark Dickinson | d746768 | 2009-01-10 22:14:33 +0000 | [diff] [blame] | 780 | PyAPI_FUNC(PyObject *) PyNumber_Long(PyObject *o); |
| 781 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 782 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 783 | Returns the o converted to an integer object on success, or |
| 784 | NULL on failure. This is the equivalent of the Python |
| 785 | expression: int(o). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 786 | */ |
| 787 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 788 | PyAPI_FUNC(PyObject *) PyNumber_Float(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 789 | |
| 790 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 791 | Returns the o converted to a float object on success, or NULL |
| 792 | on failure. This is the equivalent of the Python expression: |
| 793 | float(o). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 794 | */ |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 795 | |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 796 | /* In-place variants of (some of) the above number protocol functions */ |
| 797 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 798 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceAdd(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 799 | |
| 800 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 801 | Returns the result of adding o2 to o1, possibly in-place, or null |
| 802 | on failure. This is the equivalent of the Python expression: |
| 803 | o1 += o2. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 804 | */ |
| 805 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 806 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceSubtract(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 807 | |
| 808 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 809 | Returns the result of subtracting o2 from o1, possibly in-place or |
| 810 | null on failure. This is the equivalent of the Python expression: |
| 811 | o1 -= o2. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 812 | */ |
| 813 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 814 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceMultiply(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 815 | |
| 816 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 817 | Returns the result of multiplying o1 by o2, possibly in-place, or |
| 818 | null on failure. This is the equivalent of the Python expression: |
| 819 | o1 *= o2. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 820 | */ |
| 821 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 822 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceFloorDivide(PyObject *o1, |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 823 | PyObject *o2); |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 824 | |
| 825 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 826 | Returns the result of dividing o1 by o2 giving an integral result, |
| 827 | possibly in-place, or null on failure. |
| 828 | This is the equivalent of the Python expression: |
| 829 | o1 /= o2. |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 830 | */ |
| 831 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 832 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceTrueDivide(PyObject *o1, |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 833 | PyObject *o2); |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 834 | |
| 835 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 836 | Returns the result of dividing o1 by o2 giving a float result, |
| 837 | possibly in-place, or null on failure. |
| 838 | This is the equivalent of the Python expression: |
| 839 | o1 /= o2. |
Guido van Rossum | 4668b00 | 2001-08-08 05:00:18 +0000 | [diff] [blame] | 840 | */ |
| 841 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 842 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceRemainder(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 843 | |
| 844 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 845 | Returns the remainder of dividing o1 by o2, possibly in-place, or |
| 846 | null on failure. This is the equivalent of the Python expression: |
| 847 | o1 %= o2. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 848 | */ |
| 849 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 850 | PyAPI_FUNC(PyObject *) PyNumber_InPlacePower(PyObject *o1, PyObject *o2, |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 851 | PyObject *o3); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 852 | |
| 853 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 854 | Returns the result of raising o1 to the power of o2, possibly |
| 855 | in-place, or null on failure. This is the equivalent of the Python |
| 856 | expression: o1 **= o2, or pow(o1, o2, o3) if o3 is present. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 857 | */ |
| 858 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 859 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceLshift(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 860 | |
| 861 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 862 | Returns the result of left shifting o1 by o2, possibly in-place, or |
| 863 | null on failure. This is the equivalent of the Python expression: |
| 864 | o1 <<= o2. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 865 | */ |
| 866 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 867 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceRshift(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 868 | |
| 869 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 870 | Returns the result of right shifting o1 by o2, possibly in-place or |
| 871 | null on failure. This is the equivalent of the Python expression: |
| 872 | o1 >>= o2. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 873 | */ |
| 874 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 875 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceAnd(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 876 | |
| 877 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 878 | Returns the result of bitwise and of o1 and o2, possibly in-place, |
| 879 | or null on failure. This is the equivalent of the Python |
| 880 | expression: o1 &= o2. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 881 | */ |
| 882 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 883 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceXor(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 884 | |
| 885 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 886 | Returns the bitwise exclusive or of o1 by o2, possibly in-place, or |
| 887 | null on failure. This is the equivalent of the Python expression: |
| 888 | o1 ^= o2. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 889 | */ |
| 890 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 891 | PyAPI_FUNC(PyObject *) PyNumber_InPlaceOr(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 892 | |
| 893 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 894 | Returns the result of bitwise or of o1 and o2, possibly in-place, |
| 895 | or null on failure. This is the equivalent of the Python |
| 896 | expression: o1 |= o2. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 897 | */ |
| 898 | |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 899 | PyAPI_FUNC(PyObject *) PyNumber_ToBase(PyObject *n, int base); |
| 900 | |
| 901 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 902 | Returns the integer n converted to a string with a base, with a base |
| 903 | marker of 0b, 0o or 0x prefixed if applicable. |
| 904 | If n is not an int object, it is converted with PyNumber_Index first. |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 905 | */ |
| 906 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 907 | |
| 908 | /* Sequence protocol:*/ |
| 909 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 910 | PyAPI_FUNC(int) PySequence_Check(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 911 | |
| 912 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 913 | Return 1 if the object provides sequence protocol, and zero |
| 914 | otherwise. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 915 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 916 | This function always succeeds. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 917 | */ |
| 918 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 919 | PyAPI_FUNC(Py_ssize_t) PySequence_Size(PyObject *o); |
Jeremy Hylton | 6253f83 | 2000-07-12 12:56:19 +0000 | [diff] [blame] | 920 | |
Guido van Rossum | 4f4ce68 | 1996-07-21 02:22:56 +0000 | [diff] [blame] | 921 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 922 | Return the size of sequence object o, or -1 on failure. |
Guido van Rossum | 4f4ce68 | 1996-07-21 02:22:56 +0000 | [diff] [blame] | 923 | */ |
| 924 | |
Marc-André Lemburg | cf5f358 | 2000-07-17 09:22:55 +0000 | [diff] [blame] | 925 | /* For DLL compatibility */ |
| 926 | #undef PySequence_Length |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 927 | PyAPI_FUNC(Py_ssize_t) PySequence_Length(PyObject *o); |
Marc-André Lemburg | cf5f358 | 2000-07-17 09:22:55 +0000 | [diff] [blame] | 928 | #define PySequence_Length PySequence_Size |
| 929 | |
| 930 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 931 | PyAPI_FUNC(PyObject *) PySequence_Concat(PyObject *o1, PyObject *o2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 932 | |
| 933 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 934 | Return the concatenation of o1 and o2 on success, and NULL on |
| 935 | failure. This is the equivalent of the Python |
| 936 | expression: o1+o2. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 937 | */ |
| 938 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 939 | PyAPI_FUNC(PyObject *) PySequence_Repeat(PyObject *o, Py_ssize_t count); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 940 | |
| 941 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 942 | Return the result of repeating sequence object o count times, |
| 943 | or NULL on failure. This is the equivalent of the Python |
| 944 | expression: o1*count. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 945 | */ |
| 946 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 947 | PyAPI_FUNC(PyObject *) PySequence_GetItem(PyObject *o, Py_ssize_t i); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 948 | |
| 949 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 950 | Return the ith element of o, or NULL on failure. This is the |
| 951 | equivalent of the Python expression: o[i]. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 952 | */ |
| 953 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 954 | PyAPI_FUNC(PyObject *) PySequence_GetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 955 | |
| 956 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 957 | Return the slice of sequence object o between i1 and i2, or |
| 958 | NULL on failure. This is the equivalent of the Python |
| 959 | expression: o[i1:i2]. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 960 | */ |
| 961 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 962 | PyAPI_FUNC(int) PySequence_SetItem(PyObject *o, Py_ssize_t i, PyObject *v); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 963 | |
| 964 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 965 | Assign object v to the ith element of o. Returns |
| 966 | -1 on failure. This is the equivalent of the Python |
| 967 | statement: o[i]=v. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 968 | */ |
| 969 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 970 | PyAPI_FUNC(int) PySequence_DelItem(PyObject *o, Py_ssize_t i); |
Guido van Rossum | 6cdc6f4 | 1996-08-21 17:41:54 +0000 | [diff] [blame] | 971 | |
| 972 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 973 | Delete the ith element of object v. Returns |
| 974 | -1 on failure. This is the equivalent of the Python |
| 975 | statement: del o[i]. |
Guido van Rossum | 6cdc6f4 | 1996-08-21 17:41:54 +0000 | [diff] [blame] | 976 | */ |
| 977 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 978 | PyAPI_FUNC(int) PySequence_SetSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2, |
Neal Norwitz | fe55464 | 2006-03-17 06:58:45 +0000 | [diff] [blame] | 979 | PyObject *v); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 980 | |
| 981 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 982 | Assign the sequence object, v, to the slice in sequence |
| 983 | object, o, from i1 to i2. Returns -1 on failure. This is the |
| 984 | equivalent of the Python statement: o[i1:i2]=v. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 985 | */ |
| 986 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 987 | PyAPI_FUNC(int) PySequence_DelSlice(PyObject *o, Py_ssize_t i1, Py_ssize_t i2); |
Guido van Rossum | 6cdc6f4 | 1996-08-21 17:41:54 +0000 | [diff] [blame] | 988 | |
| 989 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 990 | Delete the slice in sequence object, o, from i1 to i2. |
| 991 | Returns -1 on failure. This is the equivalent of the Python |
| 992 | statement: del o[i1:i2]. |
Guido van Rossum | 6cdc6f4 | 1996-08-21 17:41:54 +0000 | [diff] [blame] | 993 | */ |
| 994 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 995 | PyAPI_FUNC(PyObject *) PySequence_Tuple(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 996 | |
| 997 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 998 | Returns the sequence, o, as a tuple on success, and NULL on failure. |
| 999 | This is equivalent to the Python expression: tuple(o) |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1000 | */ |
| 1001 | |
Andrew M. Kuchling | 74042d6 | 2000-06-18 18:43:14 +0000 | [diff] [blame] | 1002 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1003 | PyAPI_FUNC(PyObject *) PySequence_List(PyObject *o); |
Guido van Rossum | 2adf06b | 1996-12-05 21:48:50 +0000 | [diff] [blame] | 1004 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1005 | Returns the sequence, o, as a list on success, and NULL on failure. |
| 1006 | This is equivalent to the Python expression: list(o) |
Guido van Rossum | 2adf06b | 1996-12-05 21:48:50 +0000 | [diff] [blame] | 1007 | */ |
Guido van Rossum | f39fc43 | 1997-03-04 18:31:47 +0000 | [diff] [blame] | 1008 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1009 | PyAPI_FUNC(PyObject *) PySequence_Fast(PyObject *o, const char* m); |
Andrew M. Kuchling | 74042d6 | 2000-06-18 18:43:14 +0000 | [diff] [blame] | 1010 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1011 | Returns the sequence, o, as a tuple, unless it's already a |
| 1012 | tuple or list. Use PySequence_Fast_GET_ITEM to access the |
| 1013 | members of this list, and PySequence_Fast_GET_SIZE to get its length. |
Andrew M. Kuchling | 74042d6 | 2000-06-18 18:43:14 +0000 | [diff] [blame] | 1014 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1015 | Returns NULL on failure. If the object does not support iteration, |
| 1016 | raises a TypeError exception with m as the message text. |
Andrew M. Kuchling | 74042d6 | 2000-06-18 18:43:14 +0000 | [diff] [blame] | 1017 | */ |
| 1018 | |
Tim Peters | 1fc240e | 2001-10-26 05:06:50 +0000 | [diff] [blame] | 1019 | #define PySequence_Fast_GET_SIZE(o) \ |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1020 | (PyList_Check(o) ? PyList_GET_SIZE(o) : PyTuple_GET_SIZE(o)) |
Tim Peters | 1fc240e | 2001-10-26 05:06:50 +0000 | [diff] [blame] | 1021 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1022 | Return the size of o, assuming that o was returned by |
| 1023 | PySequence_Fast and is not NULL. |
Tim Peters | 1fc240e | 2001-10-26 05:06:50 +0000 | [diff] [blame] | 1024 | */ |
| 1025 | |
Andrew M. Kuchling | 74042d6 | 2000-06-18 18:43:14 +0000 | [diff] [blame] | 1026 | #define PySequence_Fast_GET_ITEM(o, i)\ |
| 1027 | (PyList_Check(o) ? PyList_GET_ITEM(o, i) : PyTuple_GET_ITEM(o, i)) |
Andrew M. Kuchling | 74042d6 | 2000-06-18 18:43:14 +0000 | [diff] [blame] | 1028 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1029 | Return the ith element of o, assuming that o was returned by |
| 1030 | PySequence_Fast, and that i is within bounds. |
Andrew M. Kuchling | 74042d6 | 2000-06-18 18:43:14 +0000 | [diff] [blame] | 1031 | */ |
| 1032 | |
Martin v. Löwis | 01f94bd | 2002-05-08 08:44:21 +0000 | [diff] [blame] | 1033 | #define PySequence_ITEM(o, i)\ |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1034 | ( Py_TYPE(o)->tp_as_sequence->sq_item(o, i) ) |
Martin v. Löwis | 01f94bd | 2002-05-08 08:44:21 +0000 | [diff] [blame] | 1035 | /* Assume tp_as_sequence and sq_item exist and that i does not |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1036 | need to be corrected for a negative index |
| 1037 | */ |
Martin v. Löwis | 01f94bd | 2002-05-08 08:44:21 +0000 | [diff] [blame] | 1038 | |
Raymond Hettinger | 42bec93 | 2004-03-12 16:38:17 +0000 | [diff] [blame] | 1039 | #define PySequence_Fast_ITEMS(sf) \ |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1040 | (PyList_Check(sf) ? ((PyListObject *)(sf))->ob_item \ |
| 1041 | : ((PyTupleObject *)(sf))->ob_item) |
| 1042 | /* Return a pointer to the underlying item array for |
| 1043 | an object retured by PySequence_Fast */ |
Raymond Hettinger | c1e4f9d | 2004-03-12 08:04:00 +0000 | [diff] [blame] | 1044 | |
Neal Norwitz | 1fc4b77 | 2006-03-04 18:49:58 +0000 | [diff] [blame] | 1045 | PyAPI_FUNC(Py_ssize_t) PySequence_Count(PyObject *o, PyObject *value); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1046 | |
| 1047 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1048 | Return the number of occurrences on value on o, that is, |
| 1049 | return the number of keys for which o[key]==value. On |
| 1050 | failure, return -1. This is equivalent to the Python |
| 1051 | expression: o.count(value). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1052 | */ |
| 1053 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1054 | PyAPI_FUNC(int) PySequence_Contains(PyObject *seq, PyObject *ob); |
Tim Peters | cb8d368 | 2001-05-05 21:05:01 +0000 | [diff] [blame] | 1055 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1056 | Return -1 if error; 1 if ob in seq; 0 if ob not in seq. |
| 1057 | Use __contains__ if possible, else _PySequence_IterSearch(). |
Tim Peters | cb8d368 | 2001-05-05 21:05:01 +0000 | [diff] [blame] | 1058 | */ |
| 1059 | |
Tim Peters | 16a77ad | 2001-09-08 04:00:12 +0000 | [diff] [blame] | 1060 | #define PY_ITERSEARCH_COUNT 1 |
| 1061 | #define PY_ITERSEARCH_INDEX 2 |
| 1062 | #define PY_ITERSEARCH_CONTAINS 3 |
Neal Norwitz | 1fc4b77 | 2006-03-04 18:49:58 +0000 | [diff] [blame] | 1063 | PyAPI_FUNC(Py_ssize_t) _PySequence_IterSearch(PyObject *seq, |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1064 | PyObject *obj, int operation); |
| 1065 | /* |
| 1066 | Iterate over seq. Result depends on the operation: |
| 1067 | PY_ITERSEARCH_COUNT: return # of times obj appears in seq; -1 if |
| 1068 | error. |
| 1069 | PY_ITERSEARCH_INDEX: return 0-based index of first occurrence of |
| 1070 | obj in seq; set ValueError and return -1 if none found; |
| 1071 | also return -1 on error. |
| 1072 | PY_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on |
| 1073 | error. |
| 1074 | */ |
Guido van Rossum | 8368453 | 1999-03-17 18:44:39 +0000 | [diff] [blame] | 1075 | |
| 1076 | /* For DLL-level backwards compatibility */ |
| 1077 | #undef PySequence_In |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1078 | PyAPI_FUNC(int) PySequence_In(PyObject *o, PyObject *value); |
Guido van Rossum | 8368453 | 1999-03-17 18:44:39 +0000 | [diff] [blame] | 1079 | |
| 1080 | /* For source-level backwards compatibility */ |
Guido van Rossum | f1536db | 1998-08-23 22:06:59 +0000 | [diff] [blame] | 1081 | #define PySequence_In PySequence_Contains |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1082 | |
| 1083 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1084 | Determine if o contains value. If an item in o is equal to |
| 1085 | X, return 1, otherwise return 0. On error, return -1. This |
| 1086 | is equivalent to the Python expression: value in o. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1087 | */ |
| 1088 | |
Neal Norwitz | 1fc4b77 | 2006-03-04 18:49:58 +0000 | [diff] [blame] | 1089 | PyAPI_FUNC(Py_ssize_t) PySequence_Index(PyObject *o, PyObject *value); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1090 | |
| 1091 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1092 | Return the first index for which o[i]=value. On error, |
| 1093 | return -1. This is equivalent to the Python |
| 1094 | expression: o.index(value). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1095 | */ |
| 1096 | |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 1097 | /* In-place versions of some of the above Sequence functions. */ |
| 1098 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1099 | PyAPI_FUNC(PyObject *) PySequence_InPlaceConcat(PyObject *o1, PyObject *o2); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 1100 | |
| 1101 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1102 | Append o2 to o1, in-place when possible. Return the resulting |
| 1103 | object, which could be o1, or NULL on failure. This is the |
| 1104 | equivalent of the Python expression: o1 += o2. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 1105 | |
| 1106 | */ |
| 1107 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1108 | PyAPI_FUNC(PyObject *) PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count); |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 1109 | |
| 1110 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1111 | Repeat o1 by count, in-place when possible. Return the resulting |
| 1112 | object, which could be o1, or NULL on failure. This is the |
| 1113 | equivalent of the Python expression: o1 *= count. |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 1114 | |
| 1115 | */ |
| 1116 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1117 | /* Mapping protocol:*/ |
| 1118 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1119 | PyAPI_FUNC(int) PyMapping_Check(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1120 | |
| 1121 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1122 | Return 1 if the object provides mapping protocol, and zero |
| 1123 | otherwise. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1124 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1125 | This function always succeeds. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1126 | */ |
| 1127 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1128 | PyAPI_FUNC(Py_ssize_t) PyMapping_Size(PyObject *o); |
Jeremy Hylton | 6253f83 | 2000-07-12 12:56:19 +0000 | [diff] [blame] | 1129 | |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1130 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1131 | Returns the number of keys in object o on success, and -1 on |
| 1132 | failure. For objects that do not provide sequence protocol, |
| 1133 | this is equivalent to the Python expression: len(o). |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1134 | */ |
| 1135 | |
Marc-André Lemburg | cf5f358 | 2000-07-17 09:22:55 +0000 | [diff] [blame] | 1136 | /* For DLL compatibility */ |
| 1137 | #undef PyMapping_Length |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1138 | PyAPI_FUNC(Py_ssize_t) PyMapping_Length(PyObject *o); |
Marc-André Lemburg | cf5f358 | 2000-07-17 09:22:55 +0000 | [diff] [blame] | 1139 | #define PyMapping_Length PyMapping_Size |
| 1140 | |
| 1141 | |
Guido van Rossum | a25e5e9 | 1996-09-06 13:48:38 +0000 | [diff] [blame] | 1142 | /* implemented as a macro: |
| 1143 | |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 1144 | int PyMapping_DelItemString(PyObject *o, char *key); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1145 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1146 | Remove the mapping for object, key, from the object *o. |
| 1147 | Returns -1 on failure. This is equivalent to |
| 1148 | the Python statement: del o[key]. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1149 | */ |
Jeremy Hylton | 7c7ee5f | 2001-11-28 16:20:07 +0000 | [diff] [blame] | 1150 | #define PyMapping_DelItemString(O,K) PyObject_DelItemString((O),(K)) |
Guido van Rossum | a25e5e9 | 1996-09-06 13:48:38 +0000 | [diff] [blame] | 1151 | |
| 1152 | /* implemented as a macro: |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1153 | |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 1154 | int PyMapping_DelItem(PyObject *o, PyObject *key); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1155 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1156 | Remove the mapping for object, key, from the object *o. |
| 1157 | Returns -1 on failure. This is equivalent to |
| 1158 | the Python statement: del o[key]. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1159 | */ |
Jeremy Hylton | 7c7ee5f | 2001-11-28 16:20:07 +0000 | [diff] [blame] | 1160 | #define PyMapping_DelItem(O,K) PyObject_DelItem((O),(K)) |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1161 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1162 | PyAPI_FUNC(int) PyMapping_HasKeyString(PyObject *o, char *key); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1163 | |
| 1164 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1165 | On success, return 1 if the mapping object has the key, key, |
| 1166 | and 0 otherwise. This is equivalent to the Python expression: |
| 1167 | key in o. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1168 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1169 | This function always succeeds. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1170 | */ |
| 1171 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1172 | PyAPI_FUNC(int) PyMapping_HasKey(PyObject *o, PyObject *key); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1173 | |
| 1174 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1175 | Return 1 if the mapping object has the key, key, |
| 1176 | and 0 otherwise. This is equivalent to the Python expression: |
| 1177 | key in o. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1178 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1179 | This function always succeeds. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1180 | |
| 1181 | */ |
| 1182 | |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 1183 | PyAPI_FUNC(PyObject *) PyMapping_Keys(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1184 | |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 1185 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1186 | On success, return a list or tuple of the keys in object o. |
| 1187 | On failure, return NULL. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1188 | */ |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1189 | |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 1190 | PyAPI_FUNC(PyObject *) PyMapping_Values(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1191 | |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 1192 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1193 | On success, return a list or tuple of the values in object o. |
| 1194 | On failure, return NULL. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1195 | */ |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1196 | |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 1197 | PyAPI_FUNC(PyObject *) PyMapping_Items(PyObject *o); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1198 | |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 1199 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1200 | On success, return a list or tuple of the items in object o, |
| 1201 | where each item is a tuple containing a key-value pair. |
| 1202 | On failure, return NULL. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1203 | |
| 1204 | */ |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1205 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1206 | PyAPI_FUNC(PyObject *) PyMapping_GetItemString(PyObject *o, char *key); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1207 | |
| 1208 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1209 | Return element of o corresponding to the object, key, or NULL |
| 1210 | on failure. This is the equivalent of the Python expression: |
| 1211 | o[key]. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1212 | */ |
| 1213 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1214 | PyAPI_FUNC(int) PyMapping_SetItemString(PyObject *o, char *key, |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 1215 | PyObject *value); |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1216 | |
| 1217 | /* |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 1218 | Map the object, key, to the value, v. Returns |
| 1219 | -1 on failure. This is the equivalent of the Python |
| 1220 | statement: o[key]=v. |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1221 | */ |
| 1222 | |
| 1223 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1224 | PyAPI_FUNC(int) PyObject_IsInstance(PyObject *object, PyObject *typeorclass); |
Guido van Rossum | 823649d | 2001-03-21 18:40:58 +0000 | [diff] [blame] | 1225 | /* isinstance(object, typeorclass) */ |
| 1226 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 1227 | PyAPI_FUNC(int) PyObject_IsSubclass(PyObject *object, PyObject *typeorclass); |
Guido van Rossum | 823649d | 2001-03-21 18:40:58 +0000 | [diff] [blame] | 1228 | /* issubclass(object, typeorclass) */ |
| 1229 | |
| 1230 | |
Antoine Pitrou | ec569b7 | 2008-08-26 22:40:48 +0000 | [diff] [blame] | 1231 | PyAPI_FUNC(int) _PyObject_RealIsInstance(PyObject *inst, PyObject *cls); |
| 1232 | |
| 1233 | PyAPI_FUNC(int) _PyObject_RealIsSubclass(PyObject *derived, PyObject *cls); |
| 1234 | |
| 1235 | |
Antoine Pitrou | b83df8f | 2010-09-01 13:01:35 +0000 | [diff] [blame] | 1236 | /* For internal use by buffer API functions */ |
| 1237 | PyAPI_FUNC(void) _Py_add_one_to_index_F(int nd, Py_ssize_t *index, |
| 1238 | const Py_ssize_t *shape); |
| 1239 | PyAPI_FUNC(void) _Py_add_one_to_index_C(int nd, Py_ssize_t *index, |
| 1240 | const Py_ssize_t *shape); |
| 1241 | |
| 1242 | |
Guido van Rossum | 8ca687a | 1995-09-18 21:20:02 +0000 | [diff] [blame] | 1243 | #ifdef __cplusplus |
| 1244 | } |
| 1245 | #endif |
Guido van Rossum | a827537 | 1995-07-18 14:07:00 +0000 | [diff] [blame] | 1246 | #endif /* Py_ABSTRACTOBJECT_H */ |