Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 1 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 2 | /* Integer object interface */ |
| 3 | |
| 4 | /* |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 5 | PyIntObject represents a (long) integer. This is an immutable object; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 6 | an integer cannot change its value after creation. |
| 7 | |
| 8 | There are functions to create new integer objects, to test an object |
| 9 | for integer-ness, and to get the integer value. The latter functions |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 10 | returns -1 and sets errno to EBADF if the object is not an PyIntObject. |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 11 | None of the functions should be applied to nil objects. |
| 12 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 13 | The type PyIntObject is (unfortunately) exposed here so we can declare |
| 14 | _Py_TrueStruct and _Py_ZeroStruct below; don't use this. |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 15 | */ |
| 16 | |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 17 | #ifndef Py_INTOBJECT_H |
| 18 | #define Py_INTOBJECT_H |
| 19 | #ifdef __cplusplus |
| 20 | extern "C" { |
| 21 | #endif |
| 22 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 23 | typedef struct { |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 24 | PyObject_HEAD |
| 25 | long ob_ival; |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 26 | } PyIntObject; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 27 | |
Guido van Rossum | 051ab12 | 1995-02-27 10:17:52 +0000 | [diff] [blame] | 28 | extern DL_IMPORT(PyTypeObject) PyInt_Type; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 29 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 30 | #define PyInt_Check(op) ((op)->ob_type == &PyInt_Type) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 31 | |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 32 | extern DL_IMPORT(PyObject *) PyInt_FromString(char*, char**, int); |
| 33 | extern DL_IMPORT(PyObject *) PyInt_FromUnicode(Py_UNICODE*, int, int); |
| 34 | extern DL_IMPORT(PyObject *) PyInt_FromLong(long); |
| 35 | extern DL_IMPORT(long) PyInt_AsLong(PyObject *); |
| 36 | extern DL_IMPORT(long) PyInt_GetMax(void); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 37 | |
| 38 | |
| 39 | /* |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 40 | False and True are special intobjects used by Boolean expressions. |
| 41 | All values of type Boolean must point to either of these; but in |
| 42 | contexts where integers are required they are integers (valued 0 and 1). |
| 43 | Hope these macros don't conflict with other people's. |
| 44 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 45 | Don't forget to apply Py_INCREF() when returning True or False!!! |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 46 | */ |
| 47 | |
Guido van Rossum | 051ab12 | 1995-02-27 10:17:52 +0000 | [diff] [blame] | 48 | extern DL_IMPORT(PyIntObject) _Py_ZeroStruct, _Py_TrueStruct; /* Don't use these directly */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 49 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 50 | #define Py_False ((PyObject *) &_Py_ZeroStruct) |
| 51 | #define Py_True ((PyObject *) &_Py_TrueStruct) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 52 | |
| 53 | /* Macro, trading safety for speed */ |
Guido van Rossum | 7a2d611 | 1997-08-02 02:41:13 +0000 | [diff] [blame] | 54 | #define PyInt_AS_LONG(op) (((PyIntObject *)(op))->ob_ival) |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 55 | |
Guido van Rossum | cc34faa | 1998-12-10 16:54:17 +0000 | [diff] [blame] | 56 | /* These aren't really part of the Int object, but they're handy; the protos |
| 57 | * are necessary for systems that need the magic of DL_IMPORT and that want |
| 58 | * to have stropmodule as a dynamically loaded module instead of building it |
| 59 | * into the main Python shared library/DLL. Guido thinks I'm weird for |
| 60 | * building it this way. :-) [cjh] |
| 61 | */ |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 62 | extern DL_IMPORT(unsigned long) PyOS_strtoul(char *, char **, int); |
| 63 | extern DL_IMPORT(long) PyOS_strtol(char *, char **, int); |
Guido van Rossum | cc34faa | 1998-12-10 16:54:17 +0000 | [diff] [blame] | 64 | |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 65 | #ifdef __cplusplus |
| 66 | } |
| 67 | #endif |
| 68 | #endif /* !Py_INTOBJECT_H */ |