blob: 3c6fde01ad8292ccb6134205fb853de6609d06ba [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 Rossumcaa63801995-01-12 11:45:45 +000014#define PyLong_Check(op) ((op)->ob_type == &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 *);
21extern DL_IMPORT(double) PyLong_AsDouble(PyObject *);
22extern DL_IMPORT(PyObject *) PyLong_FromVoidPtr(void *);
23extern DL_IMPORT(void *) PyLong_AsVoidPtr(PyObject *);
Guido van Rossum44c8f691992-01-19 16:31:28 +000024
Guido van Rossum1a8791e1998-08-04 22:46:29 +000025#ifdef HAVE_LONG_LONG
Guido van Rossum2e6e7d41999-01-06 18:39:42 +000026
Guido van Rossum2e6e7d41999-01-06 18:39:42 +000027/* Hopefully this is portable... */
Guido van Rossum2e6e7d41999-01-06 18:39:42 +000028#ifndef ULONG_MAX
29#define ULONG_MAX 4294967295U
30#endif
31#ifndef LONGLONG_MAX
32#define LONGLONG_MAX 9223372036854775807LL
33#endif
34#ifndef ULONGLONG_MAX
35#define ULONGLONG_MAX 0xffffffffffffffffULL
36#endif
Guido van Rossum2e6e7d41999-01-06 18:39:42 +000037
Tim Peters9f688bf2000-07-07 15:53:28 +000038extern DL_IMPORT(PyObject *) PyLong_FromLongLong(LONG_LONG);
39extern DL_IMPORT(PyObject *) PyLong_FromUnsignedLongLong(unsigned LONG_LONG);
40extern DL_IMPORT(LONG_LONG) PyLong_AsLongLong(PyObject *);
41extern DL_IMPORT(unsigned LONG_LONG) PyLong_AsUnsignedLongLong(PyObject *);
Guido van Rossum3293b071998-08-25 16:07:15 +000042#endif /* HAVE_LONG_LONG */
Guido van Rossum1a8791e1998-08-04 22:46:29 +000043
Tim Peters9f688bf2000-07-07 15:53:28 +000044DL_IMPORT(PyObject *) PyLong_FromString(char *, char **, int);
45DL_IMPORT(PyObject *) PyLong_FromUnicode(Py_UNICODE*, int, int);
Guido van Rossuma3309961993-07-28 09:05:47 +000046
Tim Peters2a9b3672001-06-11 21:23:58 +000047/* _PyLong_FromByteArray: View the n unsigned bytes as a binary integer in
48 base 256, and return a Python long with the same numeric value.
49 If n is 0, the integer is 0. Else:
50 If little_endian is 1/true, bytes[n-1] is the MSB and bytes[0] the LSB;
51 else (little_endian is 0/false) bytes[0] is the MSB and bytes[n-1] the
52 LSB.
53 If is_signed is 0/false, view the bytes as a non-negative integer.
54 If is_signed is 1/true, view the bytes as a 2's-complement integer,
55 non-negative if bit 0x80 of the MSB is clear, negative if set.
56 Error returns:
57 + Return NULL with the appropriate exception set if there's not
58 enough memory to create the Python long.
59*/
60extern DL_IMPORT(PyObject *) _PyLong_FromByteArray(
61 const unsigned char* bytes, size_t n,
62 int little_endian, int is_signed);
63
64/* _PyLong_AsByteArray: Convert the least-significant 8*n bits of long
65 v to a base-256 integer, stored in array bytes. Normally return 0,
66 return -1 on error.
67 If little_endian is 1/true, store the MSB at bytes[n-1] and the LSB at
68 bytes[0]; else (little_endian is 0/false) store the MSB at bytes[0] and
69 the LSB at bytes[n-1].
70 If is_signed is 0/false, it's an error if v < 0; else (v >= 0) n bytes
71 are filled and there's nothing special about bit 0x80 of the MSB.
72 If is_signed is 1/true, bytes is filled with the 2's-complement
73 representation of v's value. Bit 0x80 of the MSB is the sign bit.
74 Error returns (-1):
75 + is_signed is 0 and v < 0. TypeError is set in this case, and bytes
76 isn't altered.
77 + n isn't big enough to hold the full mathematical value of v. For
78 example, if is_signed is 0 and there are more digits in the v than
79 fit in n; or if is_signed is 1, v < 0, and n is just 1 bit shy of
80 being large enough to hold a sign bit. OverflowError is set in this
81 case, but bytes holds the least-signficant n bytes of the true value.
82*/
83extern DL_IMPORT(int) _PyLong_AsByteArray(PyLongObject* v,
84 unsigned char* bytes, size_t n,
85 int little_endian, int is_signed);
86
Guido van Rossuma3309961993-07-28 09:05:47 +000087#ifdef __cplusplus
88}
89#endif
90#endif /* !Py_LONGOBJECT_H */