blob: e592891687a6ff649f9fdc3d50781b2444583de6 [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
Guido van Rossum051ab121995-02-27 10:17:52 +000012extern DL_IMPORT(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)
Guido van Rossumedcc38a1991-05-05 20:09:44 +000015
Tim Peters9f688bf2000-07-07 15:53:28 +000016extern DL_IMPORT(PyObject *) PyLong_FromLong(long);
17extern DL_IMPORT(PyObject *) PyLong_FromUnsignedLong(unsigned long);
18extern DL_IMPORT(PyObject *) PyLong_FromDouble(double);
19extern DL_IMPORT(long) PyLong_AsLong(PyObject *);
20extern DL_IMPORT(unsigned long) PyLong_AsUnsignedLong(PyObject *);
Tim Petersa1c1b0f2001-09-04 02:50:49 +000021
22/* _PyLong_AsScaledDouble returns a double x and an exponent e such that
23 the true value is approximately equal to x * 2**(SHIFT*e). e is >= 0.
24 x is 0.0 if and only if the input is 0 (in which case, e and x are both
25 zeroes). Overflow is impossible. Note that the exponent returned must
26 be multiplied by SHIFT! There may not be enough room in an int to store
27 e*SHIFT directly. */
28extern DL_IMPORT(double) _PyLong_AsScaledDouble(PyObject *vv, int *e);
29
Tim Peters9f688bf2000-07-07 15:53:28 +000030extern DL_IMPORT(double) PyLong_AsDouble(PyObject *);
31extern DL_IMPORT(PyObject *) PyLong_FromVoidPtr(void *);
32extern DL_IMPORT(void *) PyLong_AsVoidPtr(PyObject *);
Guido van Rossum44c8f691992-01-19 16:31:28 +000033
Guido van Rossum1a8791e1998-08-04 22:46:29 +000034#ifdef HAVE_LONG_LONG
Guido van Rossum2e6e7d41999-01-06 18:39:42 +000035
Guido van Rossum2e6e7d41999-01-06 18:39:42 +000036/* Hopefully this is portable... */
Guido van Rossum2e6e7d41999-01-06 18:39:42 +000037#ifndef ULONG_MAX
38#define ULONG_MAX 4294967295U
39#endif
40#ifndef LONGLONG_MAX
41#define LONGLONG_MAX 9223372036854775807LL
42#endif
43#ifndef ULONGLONG_MAX
44#define ULONGLONG_MAX 0xffffffffffffffffULL
45#endif
Guido van Rossum2e6e7d41999-01-06 18:39:42 +000046
Tim Peters9f688bf2000-07-07 15:53:28 +000047extern DL_IMPORT(PyObject *) PyLong_FromLongLong(LONG_LONG);
48extern DL_IMPORT(PyObject *) PyLong_FromUnsignedLongLong(unsigned LONG_LONG);
49extern DL_IMPORT(LONG_LONG) PyLong_AsLongLong(PyObject *);
50extern DL_IMPORT(unsigned LONG_LONG) PyLong_AsUnsignedLongLong(PyObject *);
Guido van Rossum3293b071998-08-25 16:07:15 +000051#endif /* HAVE_LONG_LONG */
Guido van Rossum1a8791e1998-08-04 22:46:29 +000052
Tim Peters9f688bf2000-07-07 15:53:28 +000053DL_IMPORT(PyObject *) PyLong_FromString(char *, char **, int);
Martin v. Löwis339d0f72001-08-17 18:39:25 +000054#ifdef Py_USING_UNICODE
Tim Peters9f688bf2000-07-07 15:53:28 +000055DL_IMPORT(PyObject *) PyLong_FromUnicode(Py_UNICODE*, int, int);
Martin v. Löwis339d0f72001-08-17 18:39:25 +000056#endif
Guido van Rossuma3309961993-07-28 09:05:47 +000057
Tim Peters2a9b3672001-06-11 21:23:58 +000058/* _PyLong_FromByteArray: View the n unsigned bytes as a binary integer in
59 base 256, and return a Python long with the same numeric value.
60 If n is 0, the integer is 0. Else:
61 If little_endian is 1/true, bytes[n-1] is the MSB and bytes[0] the LSB;
62 else (little_endian is 0/false) bytes[0] is the MSB and bytes[n-1] the
63 LSB.
64 If is_signed is 0/false, view the bytes as a non-negative integer.
65 If is_signed is 1/true, view the bytes as a 2's-complement integer,
66 non-negative if bit 0x80 of the MSB is clear, negative if set.
67 Error returns:
68 + Return NULL with the appropriate exception set if there's not
69 enough memory to create the Python long.
70*/
71extern DL_IMPORT(PyObject *) _PyLong_FromByteArray(
72 const unsigned char* bytes, size_t n,
73 int little_endian, int is_signed);
74
75/* _PyLong_AsByteArray: Convert the least-significant 8*n bits of long
76 v to a base-256 integer, stored in array bytes. Normally return 0,
77 return -1 on error.
78 If little_endian is 1/true, store the MSB at bytes[n-1] and the LSB at
79 bytes[0]; else (little_endian is 0/false) store the MSB at bytes[0] and
80 the LSB at bytes[n-1].
81 If is_signed is 0/false, it's an error if v < 0; else (v >= 0) n bytes
82 are filled and there's nothing special about bit 0x80 of the MSB.
83 If is_signed is 1/true, bytes is filled with the 2's-complement
84 representation of v's value. Bit 0x80 of the MSB is the sign bit.
85 Error returns (-1):
86 + is_signed is 0 and v < 0. TypeError is set in this case, and bytes
87 isn't altered.
88 + n isn't big enough to hold the full mathematical value of v. For
89 example, if is_signed is 0 and there are more digits in the v than
90 fit in n; or if is_signed is 1, v < 0, and n is just 1 bit shy of
91 being large enough to hold a sign bit. OverflowError is set in this
92 case, but bytes holds the least-signficant n bytes of the true value.
93*/
94extern DL_IMPORT(int) _PyLong_AsByteArray(PyLongObject* v,
95 unsigned char* bytes, size_t n,
96 int little_endian, int is_signed);
97
Guido van Rossuma3309961993-07-28 09:05:47 +000098#ifdef __cplusplus
99}
100#endif
101#endif /* !Py_LONGOBJECT_H */