blob: b7a29b589da0d0266dd9df9883120aa28acb765e [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) \
15 PyType_FastSubclass((op)->ob_type, Py_TPFLAGS_LONG_SUBCLASS)
Tim Peters64b5ce32001-09-10 20:52:51 +000016#define PyLong_CheckExact(op) ((op)->ob_type == &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 *);
Guido van Rossumddefaf32007-01-14 03:31:43 +000024PyAPI_FUNC(ssize_t) PyLong_AsSsize_t(PyObject *);
25PyAPI_FUNC(size_t) PyLong_AsSize_t(PyObject *);
Mark Hammond91a681d2002-08-12 07:21:58 +000026PyAPI_FUNC(unsigned long) PyLong_AsUnsignedLong(PyObject *);
Thomas Hellera4ea6032003-04-17 18:55:45 +000027PyAPI_FUNC(unsigned long) PyLong_AsUnsignedLongMask(PyObject *);
Tim Petersa1c1b0f2001-09-04 02:50:49 +000028
Martin v. Löwis18e16552006-02-15 17:27:45 +000029/* For use by intobject.c only */
Thomas Wouters477c8d52006-05-27 19:21:47 +000030PyAPI_DATA(int) _PyLong_DigitValue[256];
Martin v. Löwis18e16552006-02-15 17:27:45 +000031
Tim Petersa1c1b0f2001-09-04 02:50:49 +000032/* _PyLong_AsScaledDouble returns a double x and an exponent e such that
33 the true value is approximately equal to x * 2**(SHIFT*e). e is >= 0.
34 x is 0.0 if and only if the input is 0 (in which case, e and x are both
35 zeroes). Overflow is impossible. Note that the exponent returned must
36 be multiplied by SHIFT! There may not be enough room in an int to store
37 e*SHIFT directly. */
Mark Hammond91a681d2002-08-12 07:21:58 +000038PyAPI_FUNC(double) _PyLong_AsScaledDouble(PyObject *vv, int *e);
Guido van Rossumddefaf32007-01-14 03:31:43 +000039 PyAPI_FUNC(int) _PyLong_FitsInLong(PyObject* vv);
Tim Petersa1c1b0f2001-09-04 02:50:49 +000040
Mark Hammond91a681d2002-08-12 07:21:58 +000041PyAPI_FUNC(double) PyLong_AsDouble(PyObject *);
42PyAPI_FUNC(PyObject *) PyLong_FromVoidPtr(void *);
43PyAPI_FUNC(void *) PyLong_AsVoidPtr(PyObject *);
Guido van Rossum44c8f691992-01-19 16:31:28 +000044
Guido van Rossum1a8791e1998-08-04 22:46:29 +000045#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000046PyAPI_FUNC(PyObject *) PyLong_FromLongLong(PY_LONG_LONG);
47PyAPI_FUNC(PyObject *) PyLong_FromUnsignedLongLong(unsigned PY_LONG_LONG);
48PyAPI_FUNC(PY_LONG_LONG) PyLong_AsLongLong(PyObject *);
49PyAPI_FUNC(unsigned PY_LONG_LONG) PyLong_AsUnsignedLongLong(PyObject *);
Thomas Hellera4ea6032003-04-17 18:55:45 +000050PyAPI_FUNC(unsigned PY_LONG_LONG) PyLong_AsUnsignedLongLongMask(PyObject *);
Guido van Rossum3293b071998-08-25 16:07:15 +000051#endif /* HAVE_LONG_LONG */
Guido van Rossum1a8791e1998-08-04 22:46:29 +000052
Mark Hammond91a681d2002-08-12 07:21:58 +000053PyAPI_FUNC(PyObject *) PyLong_FromString(char *, char **, int);
Martin v. Löwis339d0f72001-08-17 18:39:25 +000054#ifdef Py_USING_UNICODE
Martin v. Löwis18e16552006-02-15 17:27:45 +000055PyAPI_FUNC(PyObject *) PyLong_FromUnicode(Py_UNICODE*, Py_ssize_t, int);
Martin v. Löwis339d0f72001-08-17 18:39:25 +000056#endif
Guido van Rossuma3309961993-07-28 09:05:47 +000057
Tim Peters5b8132f2003-01-31 15:52:05 +000058/* _PyLong_Sign. Return 0 if v is 0, -1 if v < 0, +1 if v > 0.
59 v must not be NULL, and must be a normalized long.
60 There are no error cases.
61*/
62PyAPI_FUNC(int) _PyLong_Sign(PyObject *v);
63
64
Tim Peters5b8132f2003-01-31 15:52:05 +000065/* _PyLong_NumBits. Return the number of bits needed to represent the
66 absolute value of a long. For example, this returns 1 for 1 and -1, 2
67 for 2 and -2, and 2 for 3 and -3. It returns 0 for 0.
Tim Petersbaefd9e2003-01-28 20:37:45 +000068 v must not be NULL, and must be a normalized long.
69 (size_t)-1 is returned and OverflowError set if the true result doesn't
70 fit in a size_t.
71*/
72PyAPI_FUNC(size_t) _PyLong_NumBits(PyObject *v);
73
Tim Peters2a9b3672001-06-11 21:23:58 +000074/* _PyLong_FromByteArray: View the n unsigned bytes as a binary integer in
75 base 256, and return a Python long with the same numeric value.
76 If n is 0, the integer is 0. Else:
77 If little_endian is 1/true, bytes[n-1] is the MSB and bytes[0] the LSB;
78 else (little_endian is 0/false) bytes[0] is the MSB and bytes[n-1] the
79 LSB.
80 If is_signed is 0/false, view the bytes as a non-negative integer.
81 If is_signed is 1/true, view the bytes as a 2's-complement integer,
82 non-negative if bit 0x80 of the MSB is clear, negative if set.
83 Error returns:
84 + Return NULL with the appropriate exception set if there's not
85 enough memory to create the Python long.
86*/
Mark Hammond91a681d2002-08-12 07:21:58 +000087PyAPI_FUNC(PyObject *) _PyLong_FromByteArray(
Tim Peters2a9b3672001-06-11 21:23:58 +000088 const unsigned char* bytes, size_t n,
89 int little_endian, int is_signed);
90
91/* _PyLong_AsByteArray: Convert the least-significant 8*n bits of long
92 v to a base-256 integer, stored in array bytes. Normally return 0,
93 return -1 on error.
94 If little_endian is 1/true, store the MSB at bytes[n-1] and the LSB at
95 bytes[0]; else (little_endian is 0/false) store the MSB at bytes[0] and
96 the LSB at bytes[n-1].
97 If is_signed is 0/false, it's an error if v < 0; else (v >= 0) n bytes
98 are filled and there's nothing special about bit 0x80 of the MSB.
99 If is_signed is 1/true, bytes is filled with the 2's-complement
100 representation of v's value. Bit 0x80 of the MSB is the sign bit.
101 Error returns (-1):
102 + is_signed is 0 and v < 0. TypeError is set in this case, and bytes
103 isn't altered.
104 + n isn't big enough to hold the full mathematical value of v. For
105 example, if is_signed is 0 and there are more digits in the v than
106 fit in n; or if is_signed is 1, v < 0, and n is just 1 bit shy of
107 being large enough to hold a sign bit. OverflowError is set in this
108 case, but bytes holds the least-signficant n bytes of the true value.
109*/
Mark Hammond91a681d2002-08-12 07:21:58 +0000110PyAPI_FUNC(int) _PyLong_AsByteArray(PyLongObject* v,
Tim Peters2a9b3672001-06-11 21:23:58 +0000111 unsigned char* bytes, size_t n,
112 int little_endian, int is_signed);
113
Guido van Rossuma3309961993-07-28 09:05:47 +0000114#ifdef __cplusplus
115}
116#endif
117#endif /* !Py_LONGOBJECT_H */