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) PyObject_TypeCheck(op, &PyLong_Type)
  15 #define PyLong_CheckExact(op) ((op)->ob_type == &PyLong_Type)
  16
  17 PyAPI_FUNC(PyObject *) PyLong_FromLong(long);
  18 PyAPI_FUNC(PyObject *) PyLong_FromUnsignedLong(unsigned long);
  19 PyAPI_FUNC(PyObject *) PyLong_FromDouble(double);
  20 PyAPI_FUNC(long) PyLong_AsLong(PyObject *);
  21 PyAPI_FUNC(unsigned long) PyLong_AsUnsignedLong(PyObject *);
  22
  23 /* _PyLong_AsScaledDouble returns a double x and an exponent e such that
  24    the true value is approximately equal to x * 2**(SHIFT*e).  e is >= 0.
  25    x is 0.0 if and only if the input is 0 (in which case, e and x are both
  26    zeroes).  Overflow is impossible.  Note that the exponent returned must
  27    be multiplied by SHIFT!  There may not be enough room in an int to store
  28    e*SHIFT directly. */
  29 PyAPI_FUNC(double) _PyLong_AsScaledDouble(PyObject *vv, int *e);
  30
  31 PyAPI_FUNC(double) PyLong_AsDouble(PyObject *);
  32 PyAPI_FUNC(PyObject *) PyLong_FromVoidPtr(void *);
  33 PyAPI_FUNC(void *) PyLong_AsVoidPtr(PyObject *);
  34
  35 #ifdef HAVE_LONG_LONG
  36 PyAPI_FUNC(PyObject *) PyLong_FromLongLong(LONG_LONG);
  37 PyAPI_FUNC(PyObject *) PyLong_FromUnsignedLongLong(unsigned LONG_LONG);
  38 PyAPI_FUNC(LONG_LONG) PyLong_AsLongLong(PyObject *);
  39 PyAPI_FUNC(unsigned LONG_LONG) PyLong_AsUnsignedLongLong(PyObject *);
  40 #endif /* HAVE_LONG_LONG */
  41
  42 PyAPI_FUNC(PyObject *) PyLong_FromString(char *, char **, int);
  43 #ifdef Py_USING_UNICODE
  44 PyAPI_FUNC(PyObject *) PyLong_FromUnicode(Py_UNICODE*, int, int);
  45 #endif
  46
  47 /* _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 */
  60 PyAPI_FUNC(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 */
  83 PyAPI_FUNC(int) _PyLong_AsByteArray(PyLongObject* v,
  84         unsigned char* bytes, size_t n,
  85         int little_endian, int is_signed);
  86
  87 #ifdef __cplusplus
  88 }
  89 #endif
  90 #endif /* !Py_LONGOBJECT_H */