Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 1 | #ifndef Py_LONGOBJECT_H |
| 2 | #define Py_LONGOBJECT_H |
| 3 | #ifdef __cplusplus |
| 4 | extern "C" { |
| 5 | #endif |
| 6 | |
Guido van Rossum | edcc38a | 1991-05-05 20:09:44 +0000 | [diff] [blame] | 7 | |
| 8 | /* Long (arbitrary precision) integer object interface */ |
| 9 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 10 | typedef struct _longobject PyLongObject; /* Revealed in longintrepr.h */ |
Guido van Rossum | 44c8f69 | 1992-01-19 16:31:28 +0000 | [diff] [blame] | 11 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 12 | PyAPI_DATA(PyTypeObject) PyLong_Type; |
Guido van Rossum | edcc38a | 1991-05-05 20:09:44 +0000 | [diff] [blame] | 13 | |
Thomas Wouters | 27d517b | 2007-02-25 20:39:11 +0000 | [diff] [blame] | 14 | #define PyLong_Check(op) \ |
Ezio Melotti | 2aa2b3b | 2011-09-29 00:58:57 +0300 | [diff] [blame] | 15 | PyType_FastSubclass(Py_TYPE(op), Py_TPFLAGS_LONG_SUBCLASS) |
Christian Heimes | 90aa764 | 2007-12-19 02:45:37 +0000 | [diff] [blame] | 16 | #define PyLong_CheckExact(op) (Py_TYPE(op) == &PyLong_Type) |
Guido van Rossum | edcc38a | 1991-05-05 20:09:44 +0000 | [diff] [blame] | 17 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 18 | PyAPI_FUNC(PyObject *) PyLong_FromLong(long); |
| 19 | PyAPI_FUNC(PyObject *) PyLong_FromUnsignedLong(unsigned long); |
Guido van Rossum | ddefaf3 | 2007-01-14 03:31:43 +0000 | [diff] [blame] | 20 | PyAPI_FUNC(PyObject *) PyLong_FromSize_t(size_t); |
| 21 | PyAPI_FUNC(PyObject *) PyLong_FromSsize_t(Py_ssize_t); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 22 | PyAPI_FUNC(PyObject *) PyLong_FromDouble(double); |
| 23 | PyAPI_FUNC(long) PyLong_AsLong(PyObject *); |
Martin v. Löwis | d1a1d1e | 2007-12-04 22:10:37 +0000 | [diff] [blame] | 24 | PyAPI_FUNC(long) PyLong_AsLongAndOverflow(PyObject *, int *); |
Neal Norwitz | 88d65bd | 2007-02-27 06:57:32 +0000 | [diff] [blame] | 25 | PyAPI_FUNC(Py_ssize_t) PyLong_AsSsize_t(PyObject *); |
Guido van Rossum | ddefaf3 | 2007-01-14 03:31:43 +0000 | [diff] [blame] | 26 | PyAPI_FUNC(size_t) PyLong_AsSize_t(PyObject *); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 27 | PyAPI_FUNC(unsigned long) PyLong_AsUnsignedLong(PyObject *); |
Thomas Heller | a4ea603 | 2003-04-17 18:55:45 +0000 | [diff] [blame] | 28 | PyAPI_FUNC(unsigned long) PyLong_AsUnsignedLongMask(PyObject *); |
Serhiy Storchaka | 7898043 | 2013-01-15 01:12:17 +0200 | [diff] [blame] | 29 | #ifndef Py_LIMITED_API |
| 30 | PyAPI_FUNC(int) _PyLong_AsInt(PyObject *); |
| 31 | #endif |
Mark Dickinson | bd79264 | 2009-03-18 20:06:12 +0000 | [diff] [blame] | 32 | PyAPI_FUNC(PyObject *) PyLong_GetInfo(void); |
Tim Peters | a1c1b0f | 2001-09-04 02:50:49 +0000 | [diff] [blame] | 33 | |
Christian Heimes | 217cfd1 | 2007-12-02 14:31:20 +0000 | [diff] [blame] | 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 | |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 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 |
Gregory P. Smith | 8450857 | 2010-03-14 18:56:11 +0000 | [diff] [blame] | 40 | #define _Py_PARSE_PID "i" |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 41 | #define PyLong_FromPid PyLong_FromLong |
| 42 | #define PyLong_AsPid PyLong_AsLong |
| 43 | #elif SIZEOF_PID_T == SIZEOF_LONG |
Gregory P. Smith | 8450857 | 2010-03-14 18:56:11 +0000 | [diff] [blame] | 44 | #define _Py_PARSE_PID "l" |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 45 | #define PyLong_FromPid PyLong_FromLong |
| 46 | #define PyLong_AsPid PyLong_AsLong |
| 47 | #elif defined(SIZEOF_LONG_LONG) && SIZEOF_PID_T == SIZEOF_LONG_LONG |
Gregory P. Smith | 8450857 | 2010-03-14 18:56:11 +0000 | [diff] [blame] | 48 | #define _Py_PARSE_PID "L" |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 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 | |
Richard Oudkerk | ac0ad88 | 2013-06-05 23:29:30 +0100 | [diff] [blame] | 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 | |
Mark Dickinson | d19052c | 2010-06-27 18:19:09 +0000 | [diff] [blame] | 68 | /* Used by Python/mystrtoul.c. */ |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 69 | #ifndef Py_LIMITED_API |
Raymond Hettinger | 3563153 | 2009-01-09 03:58:09 +0000 | [diff] [blame] | 70 | PyAPI_DATA(unsigned char) _PyLong_DigitValue[256]; |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 71 | #endif |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 72 | |
Mark Dickinson | 6ecd9e5 | 2010-01-02 15:33:56 +0000 | [diff] [blame] | 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. */ |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 79 | #ifndef Py_LIMITED_API |
Mark Dickinson | 6ecd9e5 | 2010-01-02 15:33:56 +0000 | [diff] [blame] | 80 | PyAPI_FUNC(double) _PyLong_Frexp(PyLongObject *a, Py_ssize_t *e); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 81 | #endif |
Tim Peters | a1c1b0f | 2001-09-04 02:50:49 +0000 | [diff] [blame] | 82 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 83 | PyAPI_FUNC(double) PyLong_AsDouble(PyObject *); |
| 84 | PyAPI_FUNC(PyObject *) PyLong_FromVoidPtr(void *); |
| 85 | PyAPI_FUNC(void *) PyLong_AsVoidPtr(PyObject *); |
Guido van Rossum | 44c8f69 | 1992-01-19 16:31:28 +0000 | [diff] [blame] | 86 | |
Guido van Rossum | 1a8791e | 1998-08-04 22:46:29 +0000 | [diff] [blame] | 87 | #ifdef HAVE_LONG_LONG |
Martin v. Löwis | b9a0f91 | 2003-03-29 10:06:18 +0000 | [diff] [blame] | 88 | PyAPI_FUNC(PyObject *) PyLong_FromLongLong(PY_LONG_LONG); |
| 89 | PyAPI_FUNC(PyObject *) PyLong_FromUnsignedLongLong(unsigned PY_LONG_LONG); |
| 90 | PyAPI_FUNC(PY_LONG_LONG) PyLong_AsLongLong(PyObject *); |
| 91 | PyAPI_FUNC(unsigned PY_LONG_LONG) PyLong_AsUnsignedLongLong(PyObject *); |
Thomas Heller | a4ea603 | 2003-04-17 18:55:45 +0000 | [diff] [blame] | 92 | PyAPI_FUNC(unsigned PY_LONG_LONG) PyLong_AsUnsignedLongLongMask(PyObject *); |
Mark Dickinson | 93f562c | 2010-01-30 10:30:15 +0000 | [diff] [blame] | 93 | PyAPI_FUNC(PY_LONG_LONG) PyLong_AsLongLongAndOverflow(PyObject *, int *); |
Guido van Rossum | 3293b07 | 1998-08-25 16:07:15 +0000 | [diff] [blame] | 94 | #endif /* HAVE_LONG_LONG */ |
Guido van Rossum | 1a8791e | 1998-08-04 22:46:29 +0000 | [diff] [blame] | 95 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 96 | PyAPI_FUNC(PyObject *) PyLong_FromString(char *, char **, int); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 97 | #ifndef Py_LIMITED_API |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 98 | PyAPI_FUNC(PyObject *) PyLong_FromUnicode(Py_UNICODE*, Py_ssize_t, int); |
Martin v. Löwis | d63a3b8 | 2011-09-28 07:41:54 +0200 | [diff] [blame] | 99 | PyAPI_FUNC(PyObject *) PyLong_FromUnicodeObject(PyObject *u, int base); |
Serhiy Storchaka | f6d0aee | 2013-08-03 20:55:06 +0300 | [diff] [blame] | 100 | PyAPI_FUNC(PyObject *) _PyLong_FromBytes(const char *, Py_ssize_t, int); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 101 | #endif |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 102 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 103 | #ifndef Py_LIMITED_API |
Tim Peters | 5b8132f | 2003-01-31 15:52:05 +0000 | [diff] [blame] | 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 | */ |
| 108 | PyAPI_FUNC(int) _PyLong_Sign(PyObject *v); |
| 109 | |
| 110 | |
Tim Peters | 5b8132f | 2003-01-31 15:52:05 +0000 | [diff] [blame] | 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. |
Tim Peters | baefd9e | 2003-01-28 20:37:45 +0000 | [diff] [blame] | 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 | */ |
| 118 | PyAPI_FUNC(size_t) _PyLong_NumBits(PyObject *v); |
| 119 | |
Mark Dickinson | fa68a61 | 2010-06-07 18:47:09 +0000 | [diff] [blame] | 120 | /* _PyLong_DivmodNear. Given integers a and b, compute the nearest |
Mark Dickinson | 7f1bf80 | 2010-05-26 16:02:59 +0000 | [diff] [blame] | 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 | */ |
Mark Dickinson | fa68a61 | 2010-06-07 18:47:09 +0000 | [diff] [blame] | 126 | PyAPI_FUNC(PyObject *) _PyLong_DivmodNear(PyObject *, PyObject *); |
Mark Dickinson | 7f1bf80 | 2010-05-26 16:02:59 +0000 | [diff] [blame] | 127 | |
Tim Peters | 2a9b367 | 2001-06-11 21:23:58 +0000 | [diff] [blame] | 128 | /* _PyLong_FromByteArray: View the n unsigned bytes as a binary integer in |
Serhiy Storchaka | 9594942 | 2013-08-27 19:40:23 +0300 | [diff] [blame] | 129 | base 256, and return a Python int with the same numeric value. |
Tim Peters | 2a9b367 | 2001-06-11 21:23:58 +0000 | [diff] [blame] | 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 |
Serhiy Storchaka | 9594942 | 2013-08-27 19:40:23 +0300 | [diff] [blame] | 139 | enough memory to create the Python int. |
Tim Peters | 2a9b367 | 2001-06-11 21:23:58 +0000 | [diff] [blame] | 140 | */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 141 | PyAPI_FUNC(PyObject *) _PyLong_FromByteArray( |
Ezio Melotti | 2aa2b3b | 2011-09-29 00:58:57 +0300 | [diff] [blame] | 142 | const unsigned char* bytes, size_t n, |
| 143 | int little_endian, int is_signed); |
Tim Peters | 2a9b367 | 2001-06-11 21:23:58 +0000 | [diff] [blame] | 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 | */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 164 | PyAPI_FUNC(int) _PyLong_AsByteArray(PyLongObject* v, |
Ezio Melotti | 2aa2b3b | 2011-09-29 00:58:57 +0300 | [diff] [blame] | 165 | unsigned char* bytes, size_t n, |
| 166 | int little_endian, int is_signed); |
Tim Peters | 2a9b367 | 2001-06-11 21:23:58 +0000 | [diff] [blame] | 167 | |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 168 | |
| 169 | /* _PyLong_Format: Convert the long to a string object with given base, |
| 170 | appending a base prefix of 0[box] if base is 2, 8 or 16. */ |
Victor Stinner | d3f0882 | 2012-05-29 12:57:52 +0200 | [diff] [blame] | 171 | PyAPI_FUNC(PyObject *) _PyLong_Format(PyObject *obj, int base); |
| 172 | |
| 173 | PyAPI_FUNC(int) _PyLong_FormatWriter( |
| 174 | _PyUnicodeWriter *writer, |
| 175 | PyObject *obj, |
| 176 | int base, |
| 177 | int alternate); |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 178 | |
Eric Smith | 4a7d76d | 2008-05-30 18:10:19 +0000 | [diff] [blame] | 179 | /* Format the object based on the format_spec, as defined in PEP 3101 |
| 180 | (Advanced String Formatting). */ |
Victor Stinner | d3f0882 | 2012-05-29 12:57:52 +0200 | [diff] [blame] | 181 | PyAPI_FUNC(int) _PyLong_FormatAdvancedWriter( |
| 182 | _PyUnicodeWriter *writer, |
| 183 | PyObject *obj, |
| 184 | PyObject *format_spec, |
| 185 | Py_ssize_t start, |
| 186 | Py_ssize_t end); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 187 | #endif /* Py_LIMITED_API */ |
Eric Smith | 4a7d76d | 2008-05-30 18:10:19 +0000 | [diff] [blame] | 188 | |
Serhiy Storchaka | 9594942 | 2013-08-27 19:40:23 +0300 | [diff] [blame] | 189 | /* These aren't really part of the int object, but they're handy. The |
Christian Heimes | f78b1c6 | 2007-12-02 16:52:32 +0000 | [diff] [blame] | 190 | functions are in Python/mystrtoul.c. |
| 191 | */ |
| 192 | PyAPI_FUNC(unsigned long) PyOS_strtoul(char *, char **, int); |
| 193 | PyAPI_FUNC(long) PyOS_strtol(char *, char **, int); |
| 194 | |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 195 | #ifdef __cplusplus |
| 196 | } |
| 197 | #endif |
| 198 | #endif /* !Py_LONGOBJECT_H */ |