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