Mercurial > repos > rliterman > csp2

comparison CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/python3.8/longobject.h @ 69:33d812a61356

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 17:55:14 -0400
parents
children
comparison
equal deleted inserted replaced
67:0e9998148a16 69:33d812a61356
1 #ifndef Py_LONGOBJECT_H
2 #define Py_LONGOBJECT_H
3 #ifdef __cplusplus
4 extern "C" {
5 #endif
6
7
8 /* Long (arbitrary precision) integer object interface */
9
10 typedef struct _longobject PyLongObject; /* Revealed in longintrepr.h */
11
12 PyAPI_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
18 PyAPI_FUNC(PyObject *) PyLong_FromLong(long);
19 PyAPI_FUNC(PyObject *) PyLong_FromUnsignedLong(unsigned long);
20 PyAPI_FUNC(PyObject *) PyLong_FromSize_t(size_t);
21 PyAPI_FUNC(PyObject *) PyLong_FromSsize_t(Py_ssize_t);
22 PyAPI_FUNC(PyObject *) PyLong_FromDouble(double);
23 PyAPI_FUNC(long) PyLong_AsLong(PyObject *);
24 PyAPI_FUNC(long) PyLong_AsLongAndOverflow(PyObject *, int *);
25 PyAPI_FUNC(Py_ssize_t) PyLong_AsSsize_t(PyObject *);
26 PyAPI_FUNC(size_t) PyLong_AsSize_t(PyObject *);
27 PyAPI_FUNC(unsigned long) PyLong_AsUnsignedLong(PyObject *);
28 PyAPI_FUNC(unsigned long) PyLong_AsUnsignedLongMask(PyObject *);
29 #ifndef Py_LIMITED_API
30 PyAPI_FUNC(int) _PyLong_AsInt(PyObject *);
31 #endif
32 PyAPI_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 #ifndef Py_LIMITED_API
69 PyAPI_FUNC(int) _PyLong_UnsignedShort_Converter(PyObject *, void *);
70 PyAPI_FUNC(int) _PyLong_UnsignedInt_Converter(PyObject *, void *);
71 PyAPI_FUNC(int) _PyLong_UnsignedLong_Converter(PyObject *, void *);
72 PyAPI_FUNC(int) _PyLong_UnsignedLongLong_Converter(PyObject *, void *);
73 PyAPI_FUNC(int) _PyLong_Size_t_Converter(PyObject *, void *);
74 #endif
75
76 /* Used by Python/mystrtoul.c, _PyBytes_FromHex(),
77 _PyBytes_DecodeEscapeRecode(), etc. */
78 #ifndef Py_LIMITED_API
79 PyAPI_DATA(unsigned char) _PyLong_DigitValue[256];
80 #endif
81
82 /* _PyLong_Frexp returns a double x and an exponent e such that the
83 true value is approximately equal to x * 2**e. e is >= 0. x is
84 0.0 if and only if the input is 0 (in which case, e and x are both
85 zeroes); otherwise, 0.5 <= abs(x) < 1.0. On overflow, which is
86 possible if the number of bits doesn't fit into a Py_ssize_t, sets
87 OverflowError and returns -1.0 for x, 0 for e. */
88 #ifndef Py_LIMITED_API
89 PyAPI_FUNC(double) _PyLong_Frexp(PyLongObject *a, Py_ssize_t *e);
90 #endif
91
92 PyAPI_FUNC(double) PyLong_AsDouble(PyObject *);
93 PyAPI_FUNC(PyObject *) PyLong_FromVoidPtr(void *);
94 PyAPI_FUNC(void *) PyLong_AsVoidPtr(PyObject *);
95
96 PyAPI_FUNC(PyObject *) PyLong_FromLongLong(long long);
97 PyAPI_FUNC(PyObject *) PyLong_FromUnsignedLongLong(unsigned long long);
98 PyAPI_FUNC(long long) PyLong_AsLongLong(PyObject *);
99 PyAPI_FUNC(unsigned long long) PyLong_AsUnsignedLongLong(PyObject *);
100 PyAPI_FUNC(unsigned long long) PyLong_AsUnsignedLongLongMask(PyObject *);
101 PyAPI_FUNC(long long) PyLong_AsLongLongAndOverflow(PyObject *, int *);
102
103 PyAPI_FUNC(PyObject *) PyLong_FromString(const char *, char **, int);
104 #ifndef Py_LIMITED_API
105 Py_DEPRECATED(3.3)
106 PyAPI_FUNC(PyObject *) PyLong_FromUnicode(Py_UNICODE*, Py_ssize_t, int);
107 PyAPI_FUNC(PyObject *) PyLong_FromUnicodeObject(PyObject *u, int base);
108 PyAPI_FUNC(PyObject *) _PyLong_FromBytes(const char *, Py_ssize_t, int);
109 #endif
110
111 #ifndef Py_LIMITED_API
112 /* _PyLong_Sign. Return 0 if v is 0, -1 if v < 0, +1 if v > 0.
113 v must not be NULL, and must be a normalized long.
114 There are no error cases.
115 */
116 PyAPI_FUNC(int) _PyLong_Sign(PyObject *v);
117
118
119 /* _PyLong_NumBits. Return the number of bits needed to represent the
120 absolute value of a long. For example, this returns 1 for 1 and -1, 2
121 for 2 and -2, and 2 for 3 and -3. It returns 0 for 0.
122 v must not be NULL, and must be a normalized long.
123 (size_t)-1 is returned and OverflowError set if the true result doesn't
124 fit in a size_t.
125 */
126 PyAPI_FUNC(size_t) _PyLong_NumBits(PyObject *v);
127
128 /* _PyLong_DivmodNear. Given integers a and b, compute the nearest
129 integer q to the exact quotient a / b, rounding to the nearest even integer
130 in the case of a tie. Return (q, r), where r = a - q*b. The remainder r
131 will satisfy abs(r) <= abs(b)/2, with equality possible only if q is
132 even.
133 */
134 PyAPI_FUNC(PyObject *) _PyLong_DivmodNear(PyObject *, PyObject *);
135
136 /* _PyLong_FromByteArray: View the n unsigned bytes as a binary integer in
137 base 256, and return a Python int with the same numeric value.
138 If n is 0, the integer is 0. Else:
139 If little_endian is 1/true, bytes[n-1] is the MSB and bytes[0] the LSB;
140 else (little_endian is 0/false) bytes[0] is the MSB and bytes[n-1] the
141 LSB.
142 If is_signed is 0/false, view the bytes as a non-negative integer.
143 If is_signed is 1/true, view the bytes as a 2's-complement integer,
144 non-negative if bit 0x80 of the MSB is clear, negative if set.
145 Error returns:
146 + Return NULL with the appropriate exception set if there's not
147 enough memory to create the Python int.
148 */
149 PyAPI_FUNC(PyObject *) _PyLong_FromByteArray(
150 const unsigned char* bytes, size_t n,
151 int little_endian, int is_signed);
152
153 /* _PyLong_AsByteArray: Convert the least-significant 8*n bits of long
154 v to a base-256 integer, stored in array bytes. Normally return 0,
155 return -1 on error.
156 If little_endian is 1/true, store the MSB at bytes[n-1] and the LSB at
157 bytes[0]; else (little_endian is 0/false) store the MSB at bytes[0] and
158 the LSB at bytes[n-1].
159 If is_signed is 0/false, it's an error if v < 0; else (v >= 0) n bytes
160 are filled and there's nothing special about bit 0x80 of the MSB.
161 If is_signed is 1/true, bytes is filled with the 2's-complement
162 representation of v's value. Bit 0x80 of the MSB is the sign bit.
163 Error returns (-1):
164 + is_signed is 0 and v < 0. TypeError is set in this case, and bytes
165 isn't altered.
166 + n isn't big enough to hold the full mathematical value of v. For
167 example, if is_signed is 0 and there are more digits in the v than
168 fit in n; or if is_signed is 1, v < 0, and n is just 1 bit shy of
169 being large enough to hold a sign bit. OverflowError is set in this
170 case, but bytes holds the least-significant n bytes of the true value.
171 */
172 PyAPI_FUNC(int) _PyLong_AsByteArray(PyLongObject* v,
173 unsigned char* bytes, size_t n,
174 int little_endian, int is_signed);
175
176 /* _PyLong_FromNbInt: Convert the given object to a PyLongObject
177 using the nb_int slot, if available. Raise TypeError if either the
178 nb_int slot is not available or the result of the call to nb_int
179 returns something not of type int.
180 */
181 PyAPI_FUNC(PyObject *) _PyLong_FromNbInt(PyObject *);
182
183 /* Convert the given object to a PyLongObject using the nb_index or
184 nb_int slots, if available (the latter is deprecated).
185 Raise TypeError if either nb_index and nb_int slots are not
186 available or the result of the call to nb_index or nb_int
187 returns something not of type int.
188 Should be replaced with PyNumber_Index after the end of the
189 deprecation period.
190 */
191 PyAPI_FUNC(PyObject *) _PyLong_FromNbIndexOrNbInt(PyObject *);
192
193 /* _PyLong_Format: Convert the long to a string object with given base,
194 appending a base prefix of 0[box] if base is 2, 8 or 16. */
195 PyAPI_FUNC(PyObject *) _PyLong_Format(PyObject *obj, int base);
196
197 PyAPI_FUNC(int) _PyLong_FormatWriter(
198 _PyUnicodeWriter *writer,
199 PyObject *obj,
200 int base,
201 int alternate);
202
203 PyAPI_FUNC(char*) _PyLong_FormatBytesWriter(
204 _PyBytesWriter *writer,
205 char *str,
206 PyObject *obj,
207 int base,
208 int alternate);
209
210 /* Format the object based on the format_spec, as defined in PEP 3101
211 (Advanced String Formatting). */
212 PyAPI_FUNC(int) _PyLong_FormatAdvancedWriter(
213 _PyUnicodeWriter *writer,
214 PyObject *obj,
215 PyObject *format_spec,
216 Py_ssize_t start,
217 Py_ssize_t end);
218 #endif /* Py_LIMITED_API */
219
220 /* These aren't really part of the int object, but they're handy. The
221 functions are in Python/mystrtoul.c.
222 */
223 PyAPI_FUNC(unsigned long) PyOS_strtoul(const char *, char **, int);
224 PyAPI_FUNC(long) PyOS_strtol(const char *, char **, int);
225
226 #ifndef Py_LIMITED_API
227 /* For use by the gcd function in mathmodule.c */
228 PyAPI_FUNC(PyObject *) _PyLong_GCD(PyObject *, PyObject *);
229 #endif /* !Py_LIMITED_API */
230
231 #ifndef Py_LIMITED_API
232 PyAPI_DATA(PyObject *) _PyLong_Zero;
233 PyAPI_DATA(PyObject *) _PyLong_One;
234
235 PyAPI_FUNC(PyObject *) _PyLong_Rshift(PyObject *, size_t);
236 PyAPI_FUNC(PyObject *) _PyLong_Lshift(PyObject *, size_t);
237 #endif
238
239 #ifdef __cplusplus
240 }
241 #endif
242 #endif /* !Py_LONGOBJECT_H */