blob: 209c082fe9680ecb7cdecccd89a5fa0213f4b1ce [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
Guido van Rossumc16fcdf2001-08-29 15:45:32 +000014#define PyLong_Check(op) PyObject_TypeCheck(op, &PyLong_Type)
Tim Peters64b5ce32001-09-10 20:52:51 +000015#define PyLong_CheckExact(op) ((op)->ob_type == &PyLong_Type)
Guido van Rossumedcc38a1991-05-05 20:09:44 +000016
Mark Hammond91a681d2002-08-12 07:21:58 +000017PyAPI_FUNC(PyObject *) PyLong_FromLong(long);
18PyAPI_FUNC(PyObject *) PyLong_FromUnsignedLong(unsigned long);
19PyAPI_FUNC(PyObject *) PyLong_FromDouble(double);
20PyAPI_FUNC(long) PyLong_AsLong(PyObject *);
21PyAPI_FUNC(unsigned long) PyLong_AsUnsignedLong(PyObject *);
Thomas Hellera4ea6032003-04-17 18:55:45 +000022PyAPI_FUNC(unsigned long) PyLong_AsUnsignedLongMask(PyObject *);
Tim Petersa1c1b0f2001-09-04 02:50:49 +000023
24/* _PyLong_AsScaledDouble returns a double x and an exponent e such that
25 the true value is approximately equal to x * 2**(SHIFT*e). e is >= 0.
26 x is 0.0 if and only if the input is 0 (in which case, e and x are both
27 zeroes). Overflow is impossible. Note that the exponent returned must
28 be multiplied by SHIFT! There may not be enough room in an int to store
29 e*SHIFT directly. */
Mark Hammond91a681d2002-08-12 07:21:58 +000030PyAPI_FUNC(double) _PyLong_AsScaledDouble(PyObject *vv, int *e);
Tim Petersa1c1b0f2001-09-04 02:50:49 +000031
Mark Hammond91a681d2002-08-12 07:21:58 +000032PyAPI_FUNC(double) PyLong_AsDouble(PyObject *);
33PyAPI_FUNC(PyObject *) PyLong_FromVoidPtr(void *);
34PyAPI_FUNC(void *) PyLong_AsVoidPtr(PyObject *);
Guido van Rossum44c8f691992-01-19 16:31:28 +000035
Guido van Rossum1a8791e1998-08-04 22:46:29 +000036#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000037PyAPI_FUNC(PyObject *) PyLong_FromLongLong(PY_LONG_LONG);
38PyAPI_FUNC(PyObject *) PyLong_FromUnsignedLongLong(unsigned PY_LONG_LONG);
39PyAPI_FUNC(PY_LONG_LONG) PyLong_AsLongLong(PyObject *);
40PyAPI_FUNC(unsigned PY_LONG_LONG) PyLong_AsUnsignedLongLong(PyObject *);
Thomas Hellera4ea6032003-04-17 18:55:45 +000041PyAPI_FUNC(unsigned PY_LONG_LONG) PyLong_AsUnsignedLongLongMask(PyObject *);
Guido van Rossum3293b071998-08-25 16:07:15 +000042#endif /* HAVE_LONG_LONG */
Guido van Rossum1a8791e1998-08-04 22:46:29 +000043
Mark Hammond91a681d2002-08-12 07:21:58 +000044PyAPI_FUNC(PyObject *) PyLong_FromString(char *, char **, int);
Martin v. Löwis339d0f72001-08-17 18:39:25 +000045#ifdef Py_USING_UNICODE
Mark Hammond91a681d2002-08-12 07:21:58 +000046PyAPI_FUNC(PyObject *) PyLong_FromUnicode(Py_UNICODE*, int, int);
Martin v. Löwis339d0f72001-08-17 18:39:25 +000047#endif
Guido van Rossuma3309961993-07-28 09:05:47 +000048
Tim Peters5b8132f2003-01-31 15:52:05 +000049/* _PyLong_Sign. Return 0 if v is 0, -1 if v < 0, +1 if v > 0.
50 v must not be NULL, and must be a normalized long.
51 There are no error cases.
52*/
53PyAPI_FUNC(int) _PyLong_Sign(PyObject *v);
54
55
Tim Peters5b8132f2003-01-31 15:52:05 +000056/* _PyLong_NumBits. Return the number of bits needed to represent the
57 absolute value of a long. For example, this returns 1 for 1 and -1, 2
58 for 2 and -2, and 2 for 3 and -3. It returns 0 for 0.
Tim Petersbaefd9e2003-01-28 20:37:45 +000059 v must not be NULL, and must be a normalized long.
60 (size_t)-1 is returned and OverflowError set if the true result doesn't
61 fit in a size_t.
62*/
63PyAPI_FUNC(size_t) _PyLong_NumBits(PyObject *v);
64
Tim Peters2a9b3672001-06-11 21:23:58 +000065/* _PyLong_FromByteArray: View the n unsigned bytes as a binary integer in
66 base 256, and return a Python long with the same numeric value.
67 If n is 0, the integer is 0. Else:
68 If little_endian is 1/true, bytes[n-1] is the MSB and bytes[0] the LSB;
69 else (little_endian is 0/false) bytes[0] is the MSB and bytes[n-1] the
70 LSB.
71 If is_signed is 0/false, view the bytes as a non-negative integer.
72 If is_signed is 1/true, view the bytes as a 2's-complement integer,
73 non-negative if bit 0x80 of the MSB is clear, negative if set.
74 Error returns:
75 + Return NULL with the appropriate exception set if there's not
76 enough memory to create the Python long.
77*/
Mark Hammond91a681d2002-08-12 07:21:58 +000078PyAPI_FUNC(PyObject *) _PyLong_FromByteArray(
Tim Peters2a9b3672001-06-11 21:23:58 +000079 const unsigned char* bytes, size_t n,
80 int little_endian, int is_signed);
81
82/* _PyLong_AsByteArray: Convert the least-significant 8*n bits of long
83 v to a base-256 integer, stored in array bytes. Normally return 0,
84 return -1 on error.
85 If little_endian is 1/true, store the MSB at bytes[n-1] and the LSB at
86 bytes[0]; else (little_endian is 0/false) store the MSB at bytes[0] and
87 the LSB at bytes[n-1].
88 If is_signed is 0/false, it's an error if v < 0; else (v >= 0) n bytes
89 are filled and there's nothing special about bit 0x80 of the MSB.
90 If is_signed is 1/true, bytes is filled with the 2's-complement
91 representation of v's value. Bit 0x80 of the MSB is the sign bit.
92 Error returns (-1):
93 + is_signed is 0 and v < 0. TypeError is set in this case, and bytes
94 isn't altered.
95 + n isn't big enough to hold the full mathematical value of v. For
96 example, if is_signed is 0 and there are more digits in the v than
97 fit in n; or if is_signed is 1, v < 0, and n is just 1 bit shy of
98 being large enough to hold a sign bit. OverflowError is set in this
99 case, but bytes holds the least-signficant n bytes of the true value.
100*/
Mark Hammond91a681d2002-08-12 07:21:58 +0000101PyAPI_FUNC(int) _PyLong_AsByteArray(PyLongObject* v,
Tim Peters2a9b3672001-06-11 21:23:58 +0000102 unsigned char* bytes, size_t n,
103 int little_endian, int is_signed);
104
Guido van Rossuma3309961993-07-28 09:05:47 +0000105#ifdef __cplusplus
106}
107#endif
108#endif /* !Py_LONGOBJECT_H */