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