blob: d1985748b3e3e16afeccaa0d468b6da02d3a5914 [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
Neal Norwitzee3a1b52007-02-25 19:44:48 +000030#define PyInt_Check(op) \
Benjamin Petersona72d15c2017-09-13 21:20:29 -070031 PyType_FastSubclass(Py_TYPE(op), Py_TPFLAGS_INT_SUBCLASS)
32#define PyInt_CheckExact(op) (Py_TYPE(op) == &PyInt_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000033
Serhiy Storchaka48c8bf22018-07-31 09:09:36 +030034#define _PyAnyInt_Check(op) (PyInt_Check(op) || PyLong_Check(op))
35#define _PyAnyInt_CheckExact(op) (PyInt_CheckExact(op) || PyLong_CheckExact(op))
36
Mark Hammond91a681d2002-08-12 07:21:58 +000037PyAPI_FUNC(PyObject *) PyInt_FromString(char*, char**, int);
Martin v. Löwis339d0f72001-08-17 18:39:25 +000038#ifdef Py_USING_UNICODE
Martin v. Löwis18e16552006-02-15 17:27:45 +000039PyAPI_FUNC(PyObject *) PyInt_FromUnicode(Py_UNICODE*, Py_ssize_t, int);
Martin v. Löwis339d0f72001-08-17 18:39:25 +000040#endif
Mark Hammond91a681d2002-08-12 07:21:58 +000041PyAPI_FUNC(PyObject *) PyInt_FromLong(long);
Martin v. Löwis18e16552006-02-15 17:27:45 +000042PyAPI_FUNC(PyObject *) PyInt_FromSize_t(size_t);
43PyAPI_FUNC(PyObject *) PyInt_FromSsize_t(Py_ssize_t);
Mark Hammond91a681d2002-08-12 07:21:58 +000044PyAPI_FUNC(long) PyInt_AsLong(PyObject *);
Martin v. Löwis18e16552006-02-15 17:27:45 +000045PyAPI_FUNC(Py_ssize_t) PyInt_AsSsize_t(PyObject *);
Serhiy Storchaka74f49ab2013-01-19 12:55:39 +020046PyAPI_FUNC(int) _PyInt_AsInt(PyObject *);
Thomas Hellera4ea6032003-04-17 18:55:45 +000047PyAPI_FUNC(unsigned long) PyInt_AsUnsignedLongMask(PyObject *);
48#ifdef HAVE_LONG_LONG
49PyAPI_FUNC(unsigned PY_LONG_LONG) PyInt_AsUnsignedLongLongMask(PyObject *);
50#endif
51
Mark Hammond91a681d2002-08-12 07:21:58 +000052PyAPI_FUNC(long) PyInt_GetMax(void);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000053
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000054/* Macro, trading safety for speed */
Guido van Rossum7a2d6111997-08-02 02:41:13 +000055#define PyInt_AS_LONG(op) (((PyIntObject *)(op))->ob_ival)
Guido van Rossuma3309961993-07-28 09:05:47 +000056
Guido van Rossumcc34faa1998-12-10 16:54:17 +000057/* These aren't really part of the Int object, but they're handy; the protos
Mark Hammond91a681d2002-08-12 07:21:58 +000058 * are necessary for systems that need the magic of PyAPI_FUNC and that want
Guido van Rossumcc34faa1998-12-10 16:54:17 +000059 * to have stropmodule as a dynamically loaded module instead of building it
60 * into the main Python shared library/DLL. Guido thinks I'm weird for
61 * building it this way. :-) [cjh]
62 */
Mark Hammond91a681d2002-08-12 07:21:58 +000063PyAPI_FUNC(unsigned long) PyOS_strtoul(char *, char **, int);
64PyAPI_FUNC(long) PyOS_strtol(char *, char **, int);
Guido van Rossumcc34faa1998-12-10 16:54:17 +000065
Christian Heimes422051a2008-02-04 18:00:12 +000066/* free list api */
Gregory P. Smith2fe77062008-07-06 03:35:58 +000067PyAPI_FUNC(int) PyInt_ClearFreeList(void);
Christian Heimes422051a2008-02-04 18:00:12 +000068
Eric Smith5e527eb2008-02-10 01:36:53 +000069/* Convert an integer to the given base. Returns a string.
70 If base is 2, 8 or 16, add the proper prefix '0b', '0o' or '0x'.
71 If newstyle is zero, then use the pre-2.6 behavior of octal having
72 a leading "0" */
73PyAPI_FUNC(PyObject*) _PyInt_Format(PyIntObject* v, int base, int newstyle);
74
Eric Smithdc13b792008-05-30 18:10:04 +000075/* Format the object based on the format_spec, as defined in PEP 3101
76 (Advanced String Formatting). */
77PyAPI_FUNC(PyObject *) _PyInt_FormatAdvanced(PyObject *obj,
78 char *format_spec,
79 Py_ssize_t format_spec_len);
80
Guido van Rossuma3309961993-07-28 09:05:47 +000081#ifdef __cplusplus
82}
83#endif
84#endif /* !Py_INTOBJECT_H */