source: python/vendor/Python-2.6.5/Include/longobject.h

Last change on this file was 2, checked in by Yuri Dario, 15 years ago

Initial import for vendor code.

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