blob: 3a555d69b3fc5aeacbc79d246b4ae581ef448b5b [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Integer object interface */
3
4/*
Guido van Rossumcaa63801995-01-12 11:45:45 +00005PyIntObject represents a (long) integer. This is an immutable object;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00006an integer cannot change its value after creation.
7
8There are functions to create new integer objects, to test an object
9for integer-ness, and to get the integer value. The latter functions
Guido van Rossumcaa63801995-01-12 11:45:45 +000010returns -1 and sets errno to EBADF if the object is not an PyIntObject.
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000011None of the functions should be applied to nil objects.
12
Guido van Rossumcaa63801995-01-12 11:45:45 +000013The type PyIntObject is (unfortunately) exposed here so we can declare
Armin Rigo89a39462004-10-28 16:32:00 +000014_Py_TrueStruct and _Py_ZeroStruct in boolobject.h; don't use this.
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000015*/
16
Fred Drakeea9cb5a2000-07-09 00:20:36 +000017#ifndef Py_INTOBJECT_H
18#define Py_INTOBJECT_H
19#ifdef __cplusplus
20extern "C" {
21#endif
22
Guido van Rossumddefaf32007-01-14 03:31:43 +000023/*
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000024typedef struct {
Fred Drakeea9cb5a2000-07-09 00:20:36 +000025 PyObject_HEAD
26 long ob_ival;
Guido van Rossumcaa63801995-01-12 11:45:45 +000027} PyIntObject;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000028
Mark Hammond91a681d2002-08-12 07:21:58 +000029PyAPI_DATA(PyTypeObject) PyInt_Type;
Guido van Rossumddefaf32007-01-14 03:31:43 +000030*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000031
Guido van Rossumddefaf32007-01-14 03:31:43 +000032#define PyInt_Check(op) PyLong_Check(op)
33#define PyInt_CheckExact(op) (PyLong_CheckExact(op) && _PyLong_FitsInLong(op))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000034
Guido van Rossumddefaf32007-01-14 03:31:43 +000035#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 Hellera4ea6032003-04-17 18:55:45 +000044
Mark Hammond91a681d2002-08-12 07:21:58 +000045PyAPI_FUNC(long) PyInt_GetMax(void);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000046
Guido van Rossumddefaf32007-01-14 03:31:43 +000047#define PyInt_AS_LONG(op) PyLong_AsLong(op)
Guido van Rossuma3309961993-07-28 09:05:47 +000048
Guido van Rossumcc34faa1998-12-10 16:54:17 +000049/* These aren't really part of the Int object, but they're handy; the protos
Mark Hammond91a681d2002-08-12 07:21:58 +000050 * are necessary for systems that need the magic of PyAPI_FUNC and that want
Guido van Rossumcc34faa1998-12-10 16:54:17 +000051 * to have stropmodule as a dynamically loaded module instead of building it
52 * into the main Python shared library/DLL. Guido thinks I'm weird for
53 * building it this way. :-) [cjh]
54 */
Mark Hammond91a681d2002-08-12 07:21:58 +000055PyAPI_FUNC(unsigned long) PyOS_strtoul(char *, char **, int);
56PyAPI_FUNC(long) PyOS_strtol(char *, char **, int);
Guido van Rossumcc34faa1998-12-10 16:54:17 +000057
Guido van Rossuma3309961993-07-28 09:05:47 +000058#ifdef __cplusplus
59}
60#endif
61#endif /* !Py_INTOBJECT_H */