blob: 1f4846e86f222427ec21f74e86ac359160a4a28e [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 Rossum85a5fbb1990-10-14 12:07:46 +000023typedef struct {
Fred Drakeea9cb5a2000-07-09 00:20:36 +000024 PyObject_HEAD
25 long ob_ival;
Guido van Rossumcaa63801995-01-12 11:45:45 +000026} PyIntObject;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000027
Mark Hammond91a681d2002-08-12 07:21:58 +000028PyAPI_DATA(PyTypeObject) PyInt_Type;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000029
Guido van Rossumc16fcdf2001-08-29 15:45:32 +000030#define PyInt_Check(op) PyObject_TypeCheck(op, &PyInt_Type)
Tim Peters64b5ce32001-09-10 20:52:51 +000031#define PyInt_CheckExact(op) ((op)->ob_type == &PyInt_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000032
Mark Hammond91a681d2002-08-12 07:21:58 +000033PyAPI_FUNC(PyObject *) PyInt_FromString(char*, char**, int);
Martin v. Löwis339d0f72001-08-17 18:39:25 +000034#ifdef Py_USING_UNICODE
Martin v. Löwis18e16552006-02-15 17:27:45 +000035PyAPI_FUNC(PyObject *) PyInt_FromUnicode(Py_UNICODE*, Py_ssize_t, int);
Martin v. Löwis339d0f72001-08-17 18:39:25 +000036#endif
Mark Hammond91a681d2002-08-12 07:21:58 +000037PyAPI_FUNC(PyObject *) PyInt_FromLong(long);
Martin v. Löwis18e16552006-02-15 17:27:45 +000038PyAPI_FUNC(PyObject *) PyInt_FromSize_t(size_t);
39PyAPI_FUNC(PyObject *) PyInt_FromSsize_t(Py_ssize_t);
Mark Hammond91a681d2002-08-12 07:21:58 +000040PyAPI_FUNC(long) PyInt_AsLong(PyObject *);
Martin v. Löwis18e16552006-02-15 17:27:45 +000041PyAPI_FUNC(Py_ssize_t) PyInt_AsSsize_t(PyObject *);
Thomas Hellera4ea6032003-04-17 18:55:45 +000042PyAPI_FUNC(unsigned long) PyInt_AsUnsignedLongMask(PyObject *);
43#ifdef HAVE_LONG_LONG
44PyAPI_FUNC(unsigned PY_LONG_LONG) PyInt_AsUnsignedLongLongMask(PyObject *);
45#endif
46
Mark Hammond91a681d2002-08-12 07:21:58 +000047PyAPI_FUNC(long) PyInt_GetMax(void);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000048
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000049/* Macro, trading safety for speed */
Guido van Rossum7a2d6111997-08-02 02:41:13 +000050#define PyInt_AS_LONG(op) (((PyIntObject *)(op))->ob_ival)
Guido van Rossuma3309961993-07-28 09:05:47 +000051
Guido van Rossumcc34faa1998-12-10 16:54:17 +000052/* These aren't really part of the Int object, but they're handy; the protos
Mark Hammond91a681d2002-08-12 07:21:58 +000053 * are necessary for systems that need the magic of PyAPI_FUNC and that want
Guido van Rossumcc34faa1998-12-10 16:54:17 +000054 * to have stropmodule as a dynamically loaded module instead of building it
55 * into the main Python shared library/DLL. Guido thinks I'm weird for
56 * building it this way. :-) [cjh]
57 */
Mark Hammond91a681d2002-08-12 07:21:58 +000058PyAPI_FUNC(unsigned long) PyOS_strtoul(char *, char **, int);
59PyAPI_FUNC(long) PyOS_strtol(char *, char **, int);
Guido van Rossumcc34faa1998-12-10 16:54:17 +000060
Guido van Rossuma3309961993-07-28 09:05:47 +000061#ifdef __cplusplus
62}
63#endif
64#endif /* !Py_INTOBJECT_H */