Chris@87: #ifndef Py_LONGOBJECT_H Chris@87: #define Py_LONGOBJECT_H Chris@87: #ifdef __cplusplus Chris@87: extern "C" { Chris@87: #endif Chris@87: Chris@87: Chris@87: /* Long (arbitrary precision) integer object interface */ Chris@87: Chris@87: typedef struct _longobject PyLongObject; /* Revealed in longintrepr.h */ Chris@87: Chris@87: PyAPI_DATA(PyTypeObject) PyLong_Type; Chris@87: Chris@87: #define PyLong_Check(op) \ Chris@87: PyType_FastSubclass(Py_TYPE(op), Py_TPFLAGS_LONG_SUBCLASS) Chris@87: #define PyLong_CheckExact(op) (Py_TYPE(op) == &PyLong_Type) Chris@87: Chris@87: PyAPI_FUNC(PyObject *) PyLong_FromLong(long); Chris@87: PyAPI_FUNC(PyObject *) PyLong_FromUnsignedLong(unsigned long); Chris@87: PyAPI_FUNC(PyObject *) PyLong_FromDouble(double); Chris@87: PyAPI_FUNC(PyObject *) PyLong_FromSize_t(size_t); Chris@87: PyAPI_FUNC(PyObject *) PyLong_FromSsize_t(Py_ssize_t); Chris@87: PyAPI_FUNC(long) PyLong_AsLong(PyObject *); Chris@87: PyAPI_FUNC(long) PyLong_AsLongAndOverflow(PyObject *, int *); Chris@87: PyAPI_FUNC(unsigned long) PyLong_AsUnsignedLong(PyObject *); Chris@87: PyAPI_FUNC(unsigned long) PyLong_AsUnsignedLongMask(PyObject *); Chris@87: PyAPI_FUNC(Py_ssize_t) PyLong_AsSsize_t(PyObject *); Chris@87: PyAPI_FUNC(int) _PyLong_AsInt(PyObject *); Chris@87: PyAPI_FUNC(PyObject *) PyLong_GetInfo(void); Chris@87: Chris@87: /* For use by intobject.c only */ Chris@87: #define _PyLong_AsSsize_t PyLong_AsSsize_t Chris@87: #define _PyLong_FromSize_t PyLong_FromSize_t Chris@87: #define _PyLong_FromSsize_t PyLong_FromSsize_t Chris@87: PyAPI_DATA(int) _PyLong_DigitValue[256]; Chris@87: Chris@87: /* _PyLong_Frexp returns a double x and an exponent e such that the Chris@87: true value is approximately equal to x * 2**e. e is >= 0. x is Chris@87: 0.0 if and only if the input is 0 (in which case, e and x are both Chris@87: zeroes); otherwise, 0.5 <= abs(x) < 1.0. On overflow, which is Chris@87: possible if the number of bits doesn't fit into a Py_ssize_t, sets Chris@87: OverflowError and returns -1.0 for x, 0 for e. */ Chris@87: PyAPI_FUNC(double) _PyLong_Frexp(PyLongObject *a, Py_ssize_t *e); Chris@87: Chris@87: PyAPI_FUNC(double) PyLong_AsDouble(PyObject *); Chris@87: PyAPI_FUNC(PyObject *) PyLong_FromVoidPtr(void *); Chris@87: PyAPI_FUNC(void *) PyLong_AsVoidPtr(PyObject *); Chris@87: Chris@87: #ifdef HAVE_LONG_LONG Chris@87: PyAPI_FUNC(PyObject *) PyLong_FromLongLong(PY_LONG_LONG); Chris@87: PyAPI_FUNC(PyObject *) PyLong_FromUnsignedLongLong(unsigned PY_LONG_LONG); Chris@87: PyAPI_FUNC(PY_LONG_LONG) PyLong_AsLongLong(PyObject *); Chris@87: PyAPI_FUNC(unsigned PY_LONG_LONG) PyLong_AsUnsignedLongLong(PyObject *); Chris@87: PyAPI_FUNC(unsigned PY_LONG_LONG) PyLong_AsUnsignedLongLongMask(PyObject *); Chris@87: PyAPI_FUNC(PY_LONG_LONG) PyLong_AsLongLongAndOverflow(PyObject *, int *); Chris@87: #endif /* HAVE_LONG_LONG */ Chris@87: Chris@87: PyAPI_FUNC(PyObject *) PyLong_FromString(char *, char **, int); Chris@87: #ifdef Py_USING_UNICODE Chris@87: PyAPI_FUNC(PyObject *) PyLong_FromUnicode(Py_UNICODE*, Py_ssize_t, int); Chris@87: #endif Chris@87: Chris@87: /* _PyLong_Sign. Return 0 if v is 0, -1 if v < 0, +1 if v > 0. Chris@87: v must not be NULL, and must be a normalized long. Chris@87: There are no error cases. Chris@87: */ Chris@87: PyAPI_FUNC(int) _PyLong_Sign(PyObject *v); Chris@87: Chris@87: Chris@87: /* _PyLong_NumBits. Return the number of bits needed to represent the Chris@87: absolute value of a long. For example, this returns 1 for 1 and -1, 2 Chris@87: for 2 and -2, and 2 for 3 and -3. It returns 0 for 0. Chris@87: v must not be NULL, and must be a normalized long. Chris@87: (size_t)-1 is returned and OverflowError set if the true result doesn't Chris@87: fit in a size_t. Chris@87: */ Chris@87: PyAPI_FUNC(size_t) _PyLong_NumBits(PyObject *v); Chris@87: Chris@87: /* _PyLong_FromByteArray: View the n unsigned bytes as a binary integer in Chris@87: base 256, and return a Python long with the same numeric value. Chris@87: If n is 0, the integer is 0. Else: Chris@87: If little_endian is 1/true, bytes[n-1] is the MSB and bytes[0] the LSB; Chris@87: else (little_endian is 0/false) bytes[0] is the MSB and bytes[n-1] the Chris@87: LSB. Chris@87: If is_signed is 0/false, view the bytes as a non-negative integer. Chris@87: If is_signed is 1/true, view the bytes as a 2's-complement integer, Chris@87: non-negative if bit 0x80 of the MSB is clear, negative if set. Chris@87: Error returns: Chris@87: + Return NULL with the appropriate exception set if there's not Chris@87: enough memory to create the Python long. Chris@87: */ Chris@87: PyAPI_FUNC(PyObject *) _PyLong_FromByteArray( Chris@87: const unsigned char* bytes, size_t n, Chris@87: int little_endian, int is_signed); Chris@87: Chris@87: /* _PyLong_AsByteArray: Convert the least-significant 8*n bits of long Chris@87: v to a base-256 integer, stored in array bytes. Normally return 0, Chris@87: return -1 on error. Chris@87: If little_endian is 1/true, store the MSB at bytes[n-1] and the LSB at Chris@87: bytes[0]; else (little_endian is 0/false) store the MSB at bytes[0] and Chris@87: the LSB at bytes[n-1]. Chris@87: If is_signed is 0/false, it's an error if v < 0; else (v >= 0) n bytes Chris@87: are filled and there's nothing special about bit 0x80 of the MSB. Chris@87: If is_signed is 1/true, bytes is filled with the 2's-complement Chris@87: representation of v's value. Bit 0x80 of the MSB is the sign bit. Chris@87: Error returns (-1): Chris@87: + is_signed is 0 and v < 0. TypeError is set in this case, and bytes Chris@87: isn't altered. Chris@87: + n isn't big enough to hold the full mathematical value of v. For Chris@87: example, if is_signed is 0 and there are more digits in the v than Chris@87: fit in n; or if is_signed is 1, v < 0, and n is just 1 bit shy of Chris@87: being large enough to hold a sign bit. OverflowError is set in this Chris@87: case, but bytes holds the least-signficant n bytes of the true value. Chris@87: */ Chris@87: PyAPI_FUNC(int) _PyLong_AsByteArray(PyLongObject* v, Chris@87: unsigned char* bytes, size_t n, Chris@87: int little_endian, int is_signed); Chris@87: Chris@87: /* _PyLong_Format: Convert the long to a string object with given base, Chris@87: appending a base prefix of 0[box] if base is 2, 8 or 16. Chris@87: Add a trailing "L" if addL is non-zero. Chris@87: If newstyle is zero, then use the pre-2.6 behavior of octal having Chris@87: a leading "0", instead of the prefix "0o" */ Chris@87: PyAPI_FUNC(PyObject *) _PyLong_Format(PyObject *aa, int base, int addL, int newstyle); Chris@87: Chris@87: /* Format the object based on the format_spec, as defined in PEP 3101 Chris@87: (Advanced String Formatting). */ Chris@87: PyAPI_FUNC(PyObject *) _PyLong_FormatAdvanced(PyObject *obj, Chris@87: char *format_spec, Chris@87: Py_ssize_t format_spec_len); Chris@87: Chris@87: #ifdef __cplusplus Chris@87: } Chris@87: #endif Chris@87: #endif /* !Py_LONGOBJECT_H */