Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 1 | #ifndef Py_INTOBJECT_H |
| 2 | #define Py_INTOBJECT_H |
| 3 | #ifdef __cplusplus |
| 4 | extern "C" { |
| 5 | #endif |
| 6 | |
Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 7 | /*********************************************************** |
Guido van Rossum | fd71b9e | 2000-06-30 23:50:40 +0000 | [diff] [blame] | 8 | Copyright (c) 2000, BeOpen.com. |
| 9 | Copyright (c) 1995-2000, Corporation for National Research Initiatives. |
| 10 | Copyright (c) 1990-1995, Stichting Mathematisch Centrum. |
| 11 | All rights reserved. |
Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 12 | |
Guido van Rossum | fd71b9e | 2000-06-30 23:50:40 +0000 | [diff] [blame] | 13 | See the file "Misc/COPYRIGHT" for information on usage and |
| 14 | redistribution of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 15 | ******************************************************************/ |
| 16 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 17 | /* Integer object interface */ |
| 18 | |
| 19 | /* |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 20 | PyIntObject represents a (long) integer. This is an immutable object; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 21 | an integer cannot change its value after creation. |
| 22 | |
| 23 | There are functions to create new integer objects, to test an object |
| 24 | 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] | 25 | 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] | 26 | None of the functions should be applied to nil objects. |
| 27 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 28 | The type PyIntObject is (unfortunately) exposed here so we can declare |
| 29 | _Py_TrueStruct and _Py_ZeroStruct below; don't use this. |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 30 | */ |
| 31 | |
| 32 | typedef struct { |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 33 | PyObject_HEAD |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 34 | long ob_ival; |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 35 | } PyIntObject; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 36 | |
Guido van Rossum | 051ab12 | 1995-02-27 10:17:52 +0000 | [diff] [blame] | 37 | extern DL_IMPORT(PyTypeObject) PyInt_Type; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 38 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 39 | #define PyInt_Check(op) ((op)->ob_type == &PyInt_Type) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 40 | |
Barry Warsaw | 226ae6c | 1999-10-12 19:54:53 +0000 | [diff] [blame] | 41 | extern DL_IMPORT(PyObject *) PyInt_FromString Py_PROTO((char*, char**, int)); |
Guido van Rossum | 9e896b3 | 2000-04-05 20:11:21 +0000 | [diff] [blame] | 42 | extern DL_IMPORT(PyObject *) PyInt_FromUnicode Py_PROTO((Py_UNICODE*, int, int)); |
Guido van Rossum | 43466ec | 1998-12-04 18:48:25 +0000 | [diff] [blame] | 43 | extern DL_IMPORT(PyObject *) PyInt_FromLong Py_PROTO((long)); |
| 44 | extern DL_IMPORT(long) PyInt_AsLong Py_PROTO((PyObject *)); |
| 45 | extern DL_IMPORT(long) PyInt_GetMax Py_PROTO((void)); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 46 | |
| 47 | |
| 48 | /* |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 49 | False and True are special intobjects used by Boolean expressions. |
| 50 | All values of type Boolean must point to either of these; but in |
| 51 | contexts where integers are required they are integers (valued 0 and 1). |
| 52 | Hope these macros don't conflict with other people's. |
| 53 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 54 | 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] | 55 | */ |
| 56 | |
Guido van Rossum | 051ab12 | 1995-02-27 10:17:52 +0000 | [diff] [blame] | 57 | 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] | 58 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 59 | #define Py_False ((PyObject *) &_Py_ZeroStruct) |
| 60 | #define Py_True ((PyObject *) &_Py_TrueStruct) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 61 | |
| 62 | /* Macro, trading safety for speed */ |
Guido van Rossum | 7a2d611 | 1997-08-02 02:41:13 +0000 | [diff] [blame] | 63 | #define PyInt_AS_LONG(op) (((PyIntObject *)(op))->ob_ival) |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 64 | |
Guido van Rossum | cc34faa | 1998-12-10 16:54:17 +0000 | [diff] [blame] | 65 | /* These aren't really part of the Int object, but they're handy; the protos |
| 66 | * are necessary for systems that need the magic of DL_IMPORT and that want |
| 67 | * to have stropmodule as a dynamically loaded module instead of building it |
| 68 | * into the main Python shared library/DLL. Guido thinks I'm weird for |
| 69 | * building it this way. :-) [cjh] |
| 70 | */ |
| 71 | extern DL_IMPORT(unsigned long) PyOS_strtoul Py_PROTO((char *, char **, int)); |
| 72 | extern DL_IMPORT(long) PyOS_strtol Py_PROTO((char *, char **, int)); |
| 73 | |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 74 | #ifdef __cplusplus |
| 75 | } |
| 76 | #endif |
| 77 | #endif /* !Py_INTOBJECT_H */ |