blob: 28fb707aa8f3d89da9337efbd3b6a8757deace2b [file] [log] [blame]
Guido van Rossuma3309961993-07-28 09:05:47 +00001#ifndef Py_LONGOBJECT_H
2#define Py_LONGOBJECT_H
3#ifdef __cplusplus
4extern "C" {
5#endif
6
Guido van Rossumedcc38a1991-05-05 20:09:44 +00007
8/* Long (arbitrary precision) integer object interface */
9
Guido van Rossumcaa63801995-01-12 11:45:45 +000010typedef struct _longobject PyLongObject; /* Revealed in longintrepr.h */
Guido van Rossum44c8f691992-01-19 16:31:28 +000011
Mark Hammond91a681d2002-08-12 07:21:58 +000012PyAPI_DATA(PyTypeObject) PyLong_Type;
Guido van Rossumedcc38a1991-05-05 20:09:44 +000013
Thomas Wouters27d517b2007-02-25 20:39:11 +000014#define PyLong_Check(op) \
Christian Heimes90aa7642007-12-19 02:45:37 +000015 PyType_FastSubclass(Py_TYPE(op), Py_TPFLAGS_LONG_SUBCLASS)
16#define PyLong_CheckExact(op) (Py_TYPE(op) == &PyLong_Type)
Guido van Rossumedcc38a1991-05-05 20:09:44 +000017
Mark Hammond91a681d2002-08-12 07:21:58 +000018PyAPI_FUNC(PyObject *) PyLong_FromLong(long);
19PyAPI_FUNC(PyObject *) PyLong_FromUnsignedLong(unsigned long);
Guido van Rossumddefaf32007-01-14 03:31:43 +000020PyAPI_FUNC(PyObject *) PyLong_FromSize_t(size_t);
21PyAPI_FUNC(PyObject *) PyLong_FromSsize_t(Py_ssize_t);
Mark Hammond91a681d2002-08-12 07:21:58 +000022PyAPI_FUNC(PyObject *) PyLong_FromDouble(double);
23PyAPI_FUNC(long) PyLong_AsLong(PyObject *);
Martin v. Löwisd1a1d1e2007-12-04 22:10:37 +000024PyAPI_FUNC(long) PyLong_AsLongAndOverflow(PyObject *, int *);
Neal Norwitz88d65bd2007-02-27 06:57:32 +000025PyAPI_FUNC(Py_ssize_t) PyLong_AsSsize_t(PyObject *);
Guido van Rossumddefaf32007-01-14 03:31:43 +000026PyAPI_FUNC(size_t) PyLong_AsSize_t(PyObject *);
Mark Hammond91a681d2002-08-12 07:21:58 +000027PyAPI_FUNC(unsigned long) PyLong_AsUnsignedLong(PyObject *);
Thomas Hellera4ea6032003-04-17 18:55:45 +000028PyAPI_FUNC(unsigned long) PyLong_AsUnsignedLongMask(PyObject *);
Mark Dickinsonbd792642009-03-18 20:06:12 +000029PyAPI_FUNC(PyObject *) PyLong_GetInfo(void);
Tim Petersa1c1b0f2001-09-04 02:50:49 +000030
Christian Heimes217cfd12007-12-02 14:31:20 +000031/* 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)
34
Guido van Rossum39eb8fa2007-11-16 01:24:05 +000035/* 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)
39#else
40#define PyLong_FromSocket_t(fd) PyLong_FromLongLong(((SOCKET_T)(fd));
41#define PyLong_AsSocket_t(fd) (SOCKET_T)PyLong_AsLongLong(fd)
42#endif
43
Martin v. Löwis18e16552006-02-15 17:27:45 +000044/* For use by intobject.c only */
Raymond Hettinger35631532009-01-09 03:58:09 +000045PyAPI_DATA(unsigned char) _PyLong_DigitValue[256];
Martin v. Löwis18e16552006-02-15 17:27:45 +000046
Tim Petersa1c1b0f2001-09-04 02:50:49 +000047/* _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
52 e*SHIFT directly. */
Mark Hammond91a681d2002-08-12 07:21:58 +000053PyAPI_FUNC(double) _PyLong_AsScaledDouble(PyObject *vv, int *e);
Tim Petersa1c1b0f2001-09-04 02:50:49 +000054
Mark Hammond91a681d2002-08-12 07:21:58 +000055PyAPI_FUNC(double) PyLong_AsDouble(PyObject *);
56PyAPI_FUNC(PyObject *) PyLong_FromVoidPtr(void *);
57PyAPI_FUNC(void *) PyLong_AsVoidPtr(PyObject *);
Guido van Rossum44c8f691992-01-19 16:31:28 +000058
Guido van Rossum1a8791e1998-08-04 22:46:29 +000059#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000060PyAPI_FUNC(PyObject *) PyLong_FromLongLong(PY_LONG_LONG);
61PyAPI_FUNC(PyObject *) PyLong_FromUnsignedLongLong(unsigned PY_LONG_LONG);
62PyAPI_FUNC(PY_LONG_LONG) PyLong_AsLongLong(PyObject *);
63PyAPI_FUNC(unsigned PY_LONG_LONG) PyLong_AsUnsignedLongLong(PyObject *);
Thomas Hellera4ea6032003-04-17 18:55:45 +000064PyAPI_FUNC(unsigned PY_LONG_LONG) PyLong_AsUnsignedLongLongMask(PyObject *);
Guido van Rossum3293b071998-08-25 16:07:15 +000065#endif /* HAVE_LONG_LONG */
Guido van Rossum1a8791e1998-08-04 22:46:29 +000066
Mark Hammond91a681d2002-08-12 07:21:58 +000067PyAPI_FUNC(PyObject *) PyLong_FromString(char *, char **, int);
Martin v. Löwis18e16552006-02-15 17:27:45 +000068PyAPI_FUNC(PyObject *) PyLong_FromUnicode(Py_UNICODE*, Py_ssize_t, int);
Guido van Rossuma3309961993-07-28 09:05:47 +000069
Tim Peters5b8132f2003-01-31 15:52:05 +000070/* _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.
73*/
74PyAPI_FUNC(int) _PyLong_Sign(PyObject *v);
75
76
Tim Peters5b8132f2003-01-31 15:52:05 +000077/* _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.
Tim Petersbaefd9e2003-01-28 20:37:45 +000080 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
82 fit in a size_t.
83*/
84PyAPI_FUNC(size_t) _PyLong_NumBits(PyObject *v);
85
Tim Peters2a9b3672001-06-11 21:23:58 +000086/* _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
91 LSB.
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.
95 Error returns:
96 + Return NULL with the appropriate exception set if there's not
97 enough memory to create the Python long.
98*/
Mark Hammond91a681d2002-08-12 07:21:58 +000099PyAPI_FUNC(PyObject *) _PyLong_FromByteArray(
Tim Peters2a9b3672001-06-11 21:23:58 +0000100 const unsigned char* bytes, size_t n,
101 int little_endian, int is_signed);
102
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,
105 return -1 on error.
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.
113 Error returns (-1):
114 + is_signed is 0 and v < 0. TypeError is set in this case, and bytes
115 isn't altered.
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.
121*/
Mark Hammond91a681d2002-08-12 07:21:58 +0000122PyAPI_FUNC(int) _PyLong_AsByteArray(PyLongObject* v,
Tim Peters2a9b3672001-06-11 21:23:58 +0000123 unsigned char* bytes, size_t n,
124 int little_endian, int is_signed);
125
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000126
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. */
129PyAPI_FUNC(PyObject *) _PyLong_Format(PyObject *aa, int base);
130
Eric Smith4a7d76d2008-05-30 18:10:19 +0000131/* Format the object based on the format_spec, as defined in PEP 3101
132 (Advanced String Formatting). */
133PyAPI_FUNC(PyObject *) _PyLong_FormatAdvanced(PyObject *obj,
134 Py_UNICODE *format_spec,
135 Py_ssize_t format_spec_len);
136
Christian Heimesf78b1c62007-12-02 16:52:32 +0000137/* These aren't really part of the long object, but they're handy. The
138 functions are in Python/mystrtoul.c.
139 */
140PyAPI_FUNC(unsigned long) PyOS_strtoul(char *, char **, int);
141PyAPI_FUNC(long) PyOS_strtol(char *, char **, int);
142
Guido van Rossuma3309961993-07-28 09:05:47 +0000143#ifdef __cplusplus
144}
145#endif
146#endif /* !Py_LONGOBJECT_H */