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 |
Armin Rigo | 89a3946 | 2004-10-28 16:32:00 +0000 | [diff] [blame] | 14 | _Py_TrueStruct and _Py_ZeroStruct in boolobject.h; 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 | ddefaf3 | 2007-01-14 03:31:43 +0000 | [diff] [blame] | 23 | /* |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 24 | typedef struct { |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 25 | PyObject_HEAD |
| 26 | long ob_ival; |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 27 | } PyIntObject; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 28 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 29 | PyAPI_DATA(PyTypeObject) PyInt_Type; |
Guido van Rossum | ddefaf3 | 2007-01-14 03:31:43 +0000 | [diff] [blame] | 30 | */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 31 | |
Guido van Rossum | ddefaf3 | 2007-01-14 03:31:43 +0000 | [diff] [blame] | 32 | #define PyInt_Check(op) PyLong_Check(op) |
| 33 | #define PyInt_CheckExact(op) (PyLong_CheckExact(op) && _PyLong_FitsInLong(op)) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 34 | |
Guido van Rossum | ddefaf3 | 2007-01-14 03:31:43 +0000 | [diff] [blame] | 35 | #define PyInt_FromString PyLong_FromString |
| 36 | #define PyInt_FromUnicode PyLong_FromUnicode |
| 37 | #define PyInt_FromLong PyLong_FromLong |
| 38 | #define PyInt_FromSize_t PyLong_FromSize_t |
| 39 | #define PyInt_FromSsize_t PyLong_FromSsize_t |
| 40 | #define PyInt_AsLong PyLong_AsLong |
| 41 | #define PyInt_AsSsize_t PyLong_AsSsize_t |
| 42 | #define PyInt_AsUnsignedLongMask PyLong_AsUnsignedLongMask |
| 43 | #define PyInt_AsUnsignedLongLongMask PyLong_AsUnsignedLongLongMask |
Thomas Heller | a4ea603 | 2003-04-17 18:55:45 +0000 | [diff] [blame] | 44 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 45 | PyAPI_FUNC(long) PyInt_GetMax(void); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 46 | |
Guido van Rossum | ddefaf3 | 2007-01-14 03:31:43 +0000 | [diff] [blame] | 47 | #define PyInt_AS_LONG(op) PyLong_AsLong(op) |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 48 | |
Guido van Rossum | cc34faa | 1998-12-10 16:54:17 +0000 | [diff] [blame] | 49 | /* These aren't really part of the Int object, but they're handy; the protos |
Guido van Rossum | ebe3e16 | 2007-05-17 18:20:34 +0000 | [diff] [blame] | 50 | * are necessary for systems that need the magic of PyAPI_FUNC. |
Guido van Rossum | cc34faa | 1998-12-10 16:54:17 +0000 | [diff] [blame] | 51 | */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 52 | PyAPI_FUNC(unsigned long) PyOS_strtoul(char *, char **, int); |
| 53 | PyAPI_FUNC(long) PyOS_strtol(char *, char **, int); |
Guido van Rossum | cc34faa | 1998-12-10 16:54:17 +0000 | [diff] [blame] | 54 | |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 55 | #ifdef __cplusplus |
| 56 | } |
| 57 | #endif |
| 58 | #endif /* !Py_INTOBJECT_H */ |