Include/longobject.h

   1 #ifndef Py_LONGOBJECT_H
   2 #define Py_LONGOBJECT_H
   3 #ifdef __cplusplus
   4 extern "C" {
   5 #endif
   6
   7
   8 /* Long (arbitrary precision) integer object interface */
   9
  10 typedef struct _longobject PyLongObject; /* Revealed in longintrepr.h */
  11
  12 PyAPI_DATA(PyTypeObject) PyLong_Type;
  13
  14 #define PyLong_Check(op) \
  15                 PyType_FastSubclass((op)->ob_type, Py_TPFLAGS_LONG_SUBCLASS)
  16 #define PyLong_CheckExact(op) ((op)->ob_type == &PyLong_Type)
  17
  18 PyAPI_FUNC(PyObject *) PyLong_FromLong(long);
  19 PyAPI_FUNC(PyObject *) PyLong_FromUnsignedLong(unsigned long);
  20 PyAPI_FUNC(PyObject *) PyLong_FromDouble(double);
  21 PyAPI_FUNC(long) PyLong_AsLong(PyObject *);
  22 PyAPI_FUNC(unsigned long) PyLong_AsUnsignedLong(PyObject *);
  23 PyAPI_FUNC(unsigned long) PyLong_AsUnsignedLongMask(PyObject *);
  24
  25 /* For use by intobject.c only */
  26 PyAPI_FUNC(Py_ssize_t) _PyLong_AsSsize_t(PyObject *);
  27 PyAPI_FUNC(PyObject *) _PyLong_FromSize_t(size_t);
  28 PyAPI_FUNC(PyObject *) _PyLong_FromSsize_t(Py_ssize_t);
  29 PyAPI_DATA(int) _PyLong_DigitValue[256];
  30
  31 /* _PyLong_AsScaledDouble returns a double x and an exponent e such that
  32    the true value is approximately equal to x * 2**(SHIFT*e).  e is >= 0.
  33    x is 0.0 if and only if the input is 0 (in which case, e and x are both
  34    zeroes).  Overflow is impossible.  Note that the exponent returned must
  35    be multiplied by SHIFT!  There may not be enough room in an int to store
  36    e*SHIFT directly. */
  37 PyAPI_FUNC(double) _PyLong_AsScaledDouble(PyObject *vv, int *e);
  38
  39 PyAPI_FUNC(double) PyLong_AsDouble(PyObject *);
  40 PyAPI_FUNC(PyObject *) PyLong_FromVoidPtr(void *);
  41 PyAPI_FUNC(void *) PyLong_AsVoidPtr(PyObject *);
  42
  43 #ifdef HAVE_LONG_LONG
  44 PyAPI_FUNC(PyObject *) PyLong_FromLongLong(PY_LONG_LONG);
  45 PyAPI_FUNC(PyObject *) PyLong_FromUnsignedLongLong(unsigned PY_LONG_LONG);
  46 PyAPI_FUNC(PY_LONG_LONG) PyLong_AsLongLong(PyObject *);
  47 PyAPI_FUNC(unsigned PY_LONG_LONG) PyLong_AsUnsignedLongLong(PyObject *);
  48 PyAPI_FUNC(unsigned PY_LONG_LONG) PyLong_AsUnsignedLongLongMask(PyObject *);
  49 #endif /* HAVE_LONG_LONG */
  50
  51 PyAPI_FUNC(PyObject *) PyLong_FromString(char *, char **, int);
  52 #ifdef Py_USING_UNICODE
  53 PyAPI_FUNC(PyObject *) PyLong_FromUnicode(Py_UNICODE*, Py_ssize_t, int);
  54 #endif
  55
  56 /* _PyLong_Sign.  Return 0 if v is 0, -1 if v < 0, +1 if v > 0.
  57    v must not be NULL, and must be a normalized long.
  58    There are no error cases.
  59 */
  60 PyAPI_FUNC(int) _PyLong_Sign(PyObject *v);
  61
  62
  63 /* _PyLong_NumBits.  Return the number of bits needed to represent the
  64    absolute value of a long.  For example, this returns 1 for 1 and -1, 2
  65    for 2 and -2, and 2 for 3 and -3.  It returns 0 for 0.
  66    v must not be NULL, and must be a normalized long.
  67    (size_t)-1 is returned and OverflowError set if the true result doesn't
  68    fit in a size_t.
  69 */
  70 PyAPI_FUNC(size_t) _PyLong_NumBits(PyObject *v);
  71
  72 /* _PyLong_FromByteArray:  View the n unsigned bytes as a binary integer in
  73    base 256, and return a Python long with the same numeric value.
  74    If n is 0, the integer is 0.  Else:
  75    If little_endian is 1/true, bytes[n-1] is the MSB and bytes[0] the LSB;
  76    else (little_endian is 0/false) bytes[0] is the MSB and bytes[n-1] the
  77    LSB.
  78    If is_signed is 0/false, view the bytes as a non-negative integer.
  79    If is_signed is 1/true, view the bytes as a 2's-complement integer,
  80    non-negative if bit 0x80 of the MSB is clear, negative if set.
  81    Error returns:
  82    + Return NULL with the appropriate exception set if there's not
  83      enough memory to create the Python long.
  84 */
  85 PyAPI_FUNC(PyObject *) _PyLong_FromByteArray(
  86         const unsigned char* bytes, size_t n,
  87         int little_endian, int is_signed);
  88
  89 /* _PyLong_AsByteArray: Convert the least-significant 8*n bits of long
  90    v to a base-256 integer, stored in array bytes.  Normally return 0,
  91    return -1 on error.
  92    If little_endian is 1/true, store the MSB at bytes[n-1] and the LSB at
  93    bytes[0]; else (little_endian is 0/false) store the MSB at bytes[0] and
  94    the LSB at bytes[n-1].
  95    If is_signed is 0/false, it's an error if v < 0; else (v >= 0) n bytes
  96    are filled and there's nothing special about bit 0x80 of the MSB.
  97    If is_signed is 1/true, bytes is filled with the 2's-complement
  98    representation of v's value.  Bit 0x80 of the MSB is the sign bit.
  99    Error returns (-1):
 100    + is_signed is 0 and v < 0.  TypeError is set in this case, and bytes
 101      isn't altered.
 102    + n isn't big enough to hold the full mathematical value of v.  For
 103      example, if is_signed is 0 and there are more digits in the v than
 104      fit in n; or if is_signed is 1, v < 0, and n is just 1 bit shy of
 105      being large enough to hold a sign bit.  OverflowError is set in this
 106      case, but bytes holds the least-signficant n bytes of the true value.
 107 */
 108 PyAPI_FUNC(int) _PyLong_AsByteArray(PyLongObject* v,
 109         unsigned char* bytes, size_t n,
 110         int little_endian, int is_signed);
 111
 112 #ifdef __cplusplus
 113 }
 114 #endif
 115 #endif /* !Py_LONGOBJECT_H */