1#ifndef Py_LONGOBJECT_H
2#define Py_LONGOBJECT_H
3#ifdef __cplusplus
4extern "C" {
5#endif
6
7
8/* Long (arbitrary precision) integer object interface */
9
10typedef struct _longobject PyLongObject; /* Revealed in longintrepr.h */
11
12PyAPI_DATA(PyTypeObject) PyLong_Type;
13
14#define PyLong_Check(op) \
15 PyType_FastSubclass(Py_TYPE(op), Py_TPFLAGS_LONG_SUBCLASS)
16#define PyLong_CheckExact(op) (Py_TYPE(op) == &PyLong_Type)
17
18PyAPI_FUNC(PyObject *) PyLong_FromLong(long);
19PyAPI_FUNC(PyObject *) PyLong_FromUnsignedLong(unsigned long);
20PyAPI_FUNC(PyObject *) PyLong_FromSize_t(size_t);
21PyAPI_FUNC(PyObject *) PyLong_FromSsize_t(Py_ssize_t);
22PyAPI_FUNC(PyObject *) PyLong_FromDouble(double);
23PyAPI_FUNC(long) PyLong_AsLong(PyObject *);
24PyAPI_FUNC(long) PyLong_AsLongAndOverflow(PyObject *, int *);
25PyAPI_FUNC(Py_ssize_t) PyLong_AsSsize_t(PyObject *);
26PyAPI_FUNC(size_t) PyLong_AsSize_t(PyObject *);
27PyAPI_FUNC(unsigned long) PyLong_AsUnsignedLong(PyObject *);
28PyAPI_FUNC(unsigned long) PyLong_AsUnsignedLongMask(PyObject *);
29#ifndef Py_LIMITED_API
30PyAPI_FUNC(int) _PyLong_AsInt(PyObject *);
31#endif
32PyAPI_FUNC(PyObject *) PyLong_GetInfo(void);
33
34/* It may be useful in the future. I've added it in the PyInt -> PyLong
35 cleanup to keep the extra information. [CH] */
36#define PyLong_AS_LONG(op) PyLong_AsLong(op)
37
38/* Issue #1983: pid_t can be longer than a C long on some systems */
39#if !defined(SIZEOF_PID_T) || SIZEOF_PID_T == SIZEOF_INT
40#define _Py_PARSE_PID "i"
41#define PyLong_FromPid PyLong_FromLong
42#define PyLong_AsPid PyLong_AsLong
43#elif SIZEOF_PID_T == SIZEOF_LONG
44#define _Py_PARSE_PID "l"
45#define PyLong_FromPid PyLong_FromLong
46#define PyLong_AsPid PyLong_AsLong
47#elif defined(SIZEOF_LONG_LONG) && SIZEOF_PID_T == SIZEOF_LONG_LONG
48#define _Py_PARSE_PID "L"
49#define PyLong_FromPid PyLong_FromLongLong
50#define PyLong_AsPid PyLong_AsLongLong
51#else
52#error "sizeof(pid_t) is neither sizeof(int), sizeof(long) or sizeof(long long)"
53#endif /* SIZEOF_PID_T */
54
55#if SIZEOF_VOID_P == SIZEOF_INT
56# define _Py_PARSE_INTPTR "i"
57# define _Py_PARSE_UINTPTR "I"
58#elif SIZEOF_VOID_P == SIZEOF_LONG
59# define _Py_PARSE_INTPTR "l"
60# define _Py_PARSE_UINTPTR "k"
61#elif defined(SIZEOF_LONG_LONG) && SIZEOF_VOID_P == SIZEOF_LONG_LONG
62# define _Py_PARSE_INTPTR "L"
63# define _Py_PARSE_UINTPTR "K"
64#else
65# error "void* different in size from int, long and long long"
66#endif /* SIZEOF_VOID_P */
67
68/* Used by Python/mystrtoul.c. */
69#ifndef Py_LIMITED_API
70PyAPI_DATA(unsigned char) _PyLong_DigitValue[256];
71#endif
72
73/* _PyLong_Frexp returns a double x and an exponent e such that the
74 true value is approximately equal to x * 2**e. e is >= 0. x is
75 0.0 if and only if the input is 0 (in which case, e and x are both
76 zeroes); otherwise, 0.5 <= abs(x) < 1.0. On overflow, which is
77 possible if the number of bits doesn't fit into a Py_ssize_t, sets
78 OverflowError and returns -1.0 for x, 0 for e. */
79#ifndef Py_LIMITED_API
80PyAPI_FUNC(double) _PyLong_Frexp(PyLongObject *a, Py_ssize_t *e);
81#endif
82
83PyAPI_FUNC(double) PyLong_AsDouble(PyObject *);
84PyAPI_FUNC(PyObject *) PyLong_FromVoidPtr(void *);
85PyAPI_FUNC(void *) PyLong_AsVoidPtr(PyObject *);
86
87#ifdef HAVE_LONG_LONG
88PyAPI_FUNC(PyObject *) PyLong_FromLongLong(PY_LONG_LONG);
89PyAPI_FUNC(PyObject *) PyLong_FromUnsignedLongLong(unsigned PY_LONG_LONG);
90PyAPI_FUNC(PY_LONG_LONG) PyLong_AsLongLong(PyObject *);
91PyAPI_FUNC(unsigned PY_LONG_LONG) PyLong_AsUnsignedLongLong(PyObject *);
92PyAPI_FUNC(unsigned PY_LONG_LONG) PyLong_AsUnsignedLongLongMask(PyObject *);
93PyAPI_FUNC(PY_LONG_LONG) PyLong_AsLongLongAndOverflow(PyObject *, int *);
94#endif /* HAVE_LONG_LONG */
95
96PyAPI_FUNC(PyObject *) PyLong_FromString(const char *, char **, int);
97#ifndef Py_LIMITED_API
98PyAPI_FUNC(PyObject *) PyLong_FromUnicode(Py_UNICODE*, Py_ssize_t, int);
99PyAPI_FUNC(PyObject *) PyLong_FromUnicodeObject(PyObject *u, int base);
100PyAPI_FUNC(PyObject *) _PyLong_FromBytes(const char *, Py_ssize_t, int);
101#endif
102
103#ifndef Py_LIMITED_API
104/* _PyLong_Sign. Return 0 if v is 0, -1 if v < 0, +1 if v > 0.
105 v must not be NULL, and must be a normalized long.
106 There are no error cases.
107*/
108PyAPI_FUNC(int) _PyLong_Sign(PyObject *v);
109
110
111/* _PyLong_NumBits. Return the number of bits needed to represent the
112 absolute value of a long. For example, this returns 1 for 1 and -1, 2
113 for 2 and -2, and 2 for 3 and -3. It returns 0 for 0.
114 v must not be NULL, and must be a normalized long.
115 (size_t)-1 is returned and OverflowError set if the true result doesn't
116 fit in a size_t.
117*/
118PyAPI_FUNC(size_t) _PyLong_NumBits(PyObject *v);
119
120/* _PyLong_DivmodNear. Given integers a and b, compute the nearest
121 integer q to the exact quotient a / b, rounding to the nearest even integer
122 in the case of a tie. Return (q, r), where r = a - q*b. The remainder r
123 will satisfy abs(r) <= abs(b)/2, with equality possible only if q is
124 even.
125*/
126PyAPI_FUNC(PyObject *) _PyLong_DivmodNear(PyObject *, PyObject *);
127
128/* _PyLong_FromByteArray: View the n unsigned bytes as a binary integer in
129 base 256, and return a Python int with the same numeric value.
130 If n is 0, the integer is 0. Else:
131 If little_endian is 1/true, bytes[n-1] is the MSB and bytes[0] the LSB;
132 else (little_endian is 0/false) bytes[0] is the MSB and bytes[n-1] the
133 LSB.
134 If is_signed is 0/false, view the bytes as a non-negative integer.
135 If is_signed is 1/true, view the bytes as a 2's-complement integer,
136 non-negative if bit 0x80 of the MSB is clear, negative if set.
137 Error returns:
138 + Return NULL with the appropriate exception set if there's not
139 enough memory to create the Python int.
140*/
141PyAPI_FUNC(PyObject *) _PyLong_FromByteArray(
142 const unsigned char* bytes, size_t n,
143 int little_endian, int is_signed);
144
145/* _PyLong_AsByteArray: Convert the least-significant 8*n bits of long
146 v to a base-256 integer, stored in array bytes. Normally return 0,
147 return -1 on error.
148 If little_endian is 1/true, store the MSB at bytes[n-1] and the LSB at
149 bytes[0]; else (little_endian is 0/false) store the MSB at bytes[0] and
150 the LSB at bytes[n-1].
151 If is_signed is 0/false, it's an error if v < 0; else (v >= 0) n bytes
152 are filled and there's nothing special about bit 0x80 of the MSB.
153 If is_signed is 1/true, bytes is filled with the 2's-complement
154 representation of v's value. Bit 0x80 of the MSB is the sign bit.
155 Error returns (-1):
156 + is_signed is 0 and v < 0. TypeError is set in this case, and bytes
157 isn't altered.
158 + n isn't big enough to hold the full mathematical value of v. For
159 example, if is_signed is 0 and there are more digits in the v than
160 fit in n; or if is_signed is 1, v < 0, and n is just 1 bit shy of
161 being large enough to hold a sign bit. OverflowError is set in this
162 case, but bytes holds the least-signficant n bytes of the true value.
163*/
164PyAPI_FUNC(int) _PyLong_AsByteArray(PyLongObject* v,
165 unsigned char* bytes, size_t n,
166 int little_endian, int is_signed);
167
168/* _PyLong_FromNbInt: Convert the given object to a PyLongObject
169 using the nb_int slot, if available. Raise TypeError if either the
170 nb_int slot is not available or the result of the call to nb_int
171 returns something not of type int.
172*/
173PyAPI_FUNC(PyLongObject *)_PyLong_FromNbInt(PyObject *);
174
175/* _PyLong_Format: Convert the long to a string object with given base,
176 appending a base prefix of 0[box] if base is 2, 8 or 16. */
177PyAPI_FUNC(PyObject *) _PyLong_Format(PyObject *obj, int base);
178
179PyAPI_FUNC(int) _PyLong_FormatWriter(
180 _PyUnicodeWriter *writer,
181 PyObject *obj,
182 int base,
183 int alternate);
184
185/* Format the object based on the format_spec, as defined in PEP 3101
186 (Advanced String Formatting). */
187PyAPI_FUNC(int) _PyLong_FormatAdvancedWriter(
188 _PyUnicodeWriter *writer,
189 PyObject *obj,
190 PyObject *format_spec,
191 Py_ssize_t start,
192 Py_ssize_t end);
193#endif /* Py_LIMITED_API */
194
195/* These aren't really part of the int object, but they're handy. The
196 functions are in Python/mystrtoul.c.
197 */
198PyAPI_FUNC(unsigned long) PyOS_strtoul(const char *, char **, int);
199PyAPI_FUNC(long) PyOS_strtol(const char *, char **, int);
200
201/* For use by the gcd function in mathmodule.c */
202PyAPI_FUNC(PyObject *) _PyLong_GCD(PyObject *, PyObject *);
203
204#ifdef __cplusplus
205}
206#endif
207#endif /* !Py_LONGOBJECT_H */
208