1 #ifndef Py_LONGOBJECT_H
2 #define Py_LONGOBJECT_H
8 /* Long (arbitrary precision) integer object interface */
10 typedef struct _longobject PyLongObject
; /* Revealed in longintrepr.h */
12 PyAPI_DATA(PyTypeObject
) PyLong_Type
;
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)
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 PyAPI_FUNC(PyObject
*) PyLong_GetInfo(void);
31 /* It may be useful in the future. I've added it in the PyInt -> PyLong
32 cleanup to keep the extra information. [CH] */
33 #define PyLong_AS_LONG(op) PyLong_AsLong(op)
35 /* Used by socketmodule.c */
36 #if SIZEOF_SOCKET_T <= SIZEOF_LONG
37 #define PyLong_FromSocket_t(fd) PyLong_FromLong((SOCKET_T)(fd))
38 #define PyLong_AsSocket_t(fd) (SOCKET_T)PyLong_AsLong(fd)
40 #define PyLong_FromSocket_t(fd) PyLong_FromLongLong(((SOCKET_T)(fd));
41 #define PyLong_AsSocket_t(fd) (SOCKET_T)PyLong_AsLongLong(fd)
44 /* For use by intobject.c only */
45 PyAPI_DATA(unsigned char) _PyLong_DigitValue
[256];
47 /* _PyLong_AsScaledDouble returns a double x and an exponent e such that
48 the true value is approximately equal to x * 2**(SHIFT*e). e is >= 0.
49 x is 0.0 if and only if the input is 0 (in which case, e and x are both
50 zeroes). Overflow is impossible. Note that the exponent returned must
51 be multiplied by SHIFT! There may not be enough room in an int to store
53 PyAPI_FUNC(double) _PyLong_AsScaledDouble(PyObject
*vv
, int *e
);
55 PyAPI_FUNC(double) PyLong_AsDouble(PyObject
*);
56 PyAPI_FUNC(PyObject
*) PyLong_FromVoidPtr(void *);
57 PyAPI_FUNC(void *) PyLong_AsVoidPtr(PyObject
*);
60 PyAPI_FUNC(PyObject
*) PyLong_FromLongLong(PY_LONG_LONG
);
61 PyAPI_FUNC(PyObject
*) PyLong_FromUnsignedLongLong(unsigned PY_LONG_LONG
);
62 PyAPI_FUNC(PY_LONG_LONG
) PyLong_AsLongLong(PyObject
*);
63 PyAPI_FUNC(unsigned PY_LONG_LONG
) PyLong_AsUnsignedLongLong(PyObject
*);
64 PyAPI_FUNC(unsigned PY_LONG_LONG
) PyLong_AsUnsignedLongLongMask(PyObject
*);
65 #endif /* HAVE_LONG_LONG */
67 PyAPI_FUNC(PyObject
*) PyLong_FromString(char *, char **, int);
68 PyAPI_FUNC(PyObject
*) PyLong_FromUnicode(Py_UNICODE
*, Py_ssize_t
, int);
70 /* _PyLong_Sign. Return 0 if v is 0, -1 if v < 0, +1 if v > 0.
71 v must not be NULL, and must be a normalized long.
72 There are no error cases.
74 PyAPI_FUNC(int) _PyLong_Sign(PyObject
*v
);
77 /* _PyLong_NumBits. Return the number of bits needed to represent the
78 absolute value of a long. For example, this returns 1 for 1 and -1, 2
79 for 2 and -2, and 2 for 3 and -3. It returns 0 for 0.
80 v must not be NULL, and must be a normalized long.
81 (size_t)-1 is returned and OverflowError set if the true result doesn't
84 PyAPI_FUNC(size_t) _PyLong_NumBits(PyObject
*v
);
86 /* _PyLong_FromByteArray: View the n unsigned bytes as a binary integer in
87 base 256, and return a Python long with the same numeric value.
88 If n is 0, the integer is 0. Else:
89 If little_endian is 1/true, bytes[n-1] is the MSB and bytes[0] the LSB;
90 else (little_endian is 0/false) bytes[0] is the MSB and bytes[n-1] the
92 If is_signed is 0/false, view the bytes as a non-negative integer.
93 If is_signed is 1/true, view the bytes as a 2's-complement integer,
94 non-negative if bit 0x80 of the MSB is clear, negative if set.
96 + Return NULL with the appropriate exception set if there's not
97 enough memory to create the Python long.
99 PyAPI_FUNC(PyObject
*) _PyLong_FromByteArray(
100 const unsigned char* bytes
, size_t n
,
101 int little_endian
, int is_signed
);
103 /* _PyLong_AsByteArray: Convert the least-significant 8*n bits of long
104 v to a base-256 integer, stored in array bytes. Normally return 0,
106 If little_endian is 1/true, store the MSB at bytes[n-1] and the LSB at
107 bytes[0]; else (little_endian is 0/false) store the MSB at bytes[0] and
108 the LSB at bytes[n-1].
109 If is_signed is 0/false, it's an error if v < 0; else (v >= 0) n bytes
110 are filled and there's nothing special about bit 0x80 of the MSB.
111 If is_signed is 1/true, bytes is filled with the 2's-complement
112 representation of v's value. Bit 0x80 of the MSB is the sign bit.
114 + is_signed is 0 and v < 0. TypeError is set in this case, and bytes
116 + n isn't big enough to hold the full mathematical value of v. For
117 example, if is_signed is 0 and there are more digits in the v than
118 fit in n; or if is_signed is 1, v < 0, and n is just 1 bit shy of
119 being large enough to hold a sign bit. OverflowError is set in this
120 case, but bytes holds the least-signficant n bytes of the true value.
122 PyAPI_FUNC(int) _PyLong_AsByteArray(PyLongObject
* v
,
123 unsigned char* bytes
, size_t n
,
124 int little_endian
, int is_signed
);
127 /* _PyLong_Format: Convert the long to a string object with given base,
128 appending a base prefix of 0[box] if base is 2, 8 or 16. */
129 PyAPI_FUNC(PyObject
*) _PyLong_Format(PyObject
*aa
, int base
);
131 /* Format the object based on the format_spec, as defined in PEP 3101
132 (Advanced String Formatting). */
133 PyAPI_FUNC(PyObject
*) _PyLong_FormatAdvanced(PyObject
*obj
,
134 Py_UNICODE
*format_spec
,
135 Py_ssize_t format_spec_len
);
137 /* These aren't really part of the long object, but they're handy. The
138 functions are in Python/mystrtoul.c.
140 PyAPI_FUNC(unsigned long) PyOS_strtoul(char *, char **, int);
141 PyAPI_FUNC(long) PyOS_strtol(char *, char **, int);
146 #endif /* !Py_LONGOBJECT_H */