annotate Include/longobject.h @ 25838:8540887bcec6 2.2

Backport of 2.183: Fix memory leak in add_subclass() found by NealN with valgrind.
author Guido van Rossum <guido@python.org>
date Fri, 18 Oct 2002 13:42:21 +0000
parents 5158e4789459
children 25367c7c40a4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1329
519c25039c6a * Added support for X11 modules.
Guido van Rossum <guido@python.org>
parents: 1257
diff changeset
1 #ifndef Py_LONGOBJECT_H
519c25039c6a * Added support for X11 modules.
Guido van Rossum <guido@python.org>
parents: 1257
diff changeset
2 #define Py_LONGOBJECT_H
519c25039c6a * Added support for X11 modules.
Guido van Rossum <guido@python.org>
parents: 1257
diff changeset
3 #ifdef __cplusplus
519c25039c6a * Added support for X11 modules.
Guido van Rossum <guido@python.org>
parents: 1257
diff changeset
4 extern "C" {
519c25039c6a * Added support for X11 modules.
Guido van Rossum <guido@python.org>
parents: 1257
diff changeset
5 #endif
519c25039c6a * Added support for X11 modules.
Guido van Rossum <guido@python.org>
parents: 1257
diff changeset
6
230
7ba9612058a4 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
7
7ba9612058a4 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
8 /* Long (arbitrary precision) integer object interface */
7ba9612058a4 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
9
2129
05360cd616ae The great renaming, phase two: all header files have been updated to
Guido van Rossum <guido@python.org>
parents: 2058
diff changeset
10 typedef struct _longobject PyLongObject; /* Revealed in longintrepr.h */
614
11e86270ed0d Added typedef for longobject and declarations for long_{format,scan}.
Guido van Rossum <guido@python.org>
parents: 255
diff changeset
11
2436
fa98dda07877 make the type a parameter of the DL_IMPORT macro, for Borland C
Guido van Rossum <guido@python.org>
parents: 2146
diff changeset
12 extern DL_IMPORT(PyTypeObject) PyLong_Type;
230
7ba9612058a4 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
13
19550
19d271f297dc Make the PyXXX_Check() macros for the numeric types inheritance-aware.
Guido van Rossum <guido@python.org>
parents: 19343
diff changeset
14 #define PyLong_Check(op) PyObject_TypeCheck(op, &PyLong_Type)
19837
5158e4789459 SF bug #460020: bug or feature: unicode() and subclasses.
Tim Peters <tim.peters@gmail.com>
parents: 19671
diff changeset
15 #define PyLong_CheckExact(op) ((op)->ob_type == &PyLong_Type)
230
7ba9612058a4 Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
16
13406
a503af7e7fb7 Some cleanup of longs in prepartion for Cray J90 fixes: got
Tim Peters <tim.peters@gmail.com>
parents: 13256
diff changeset
17 extern DL_IMPORT(PyObject *) PyLong_FromLong(long);
a503af7e7fb7 Some cleanup of longs in prepartion for Cray J90 fixes: got
Tim Peters <tim.peters@gmail.com>
parents: 13256
diff changeset
18 extern DL_IMPORT(PyObject *) PyLong_FromUnsignedLong(unsigned long);
a503af7e7fb7 Some cleanup of longs in prepartion for Cray J90 fixes: got
Tim Peters <tim.peters@gmail.com>
parents: 13256
diff changeset
19 extern DL_IMPORT(PyObject *) PyLong_FromDouble(double);
a503af7e7fb7 Some cleanup of longs in prepartion for Cray J90 fixes: got
Tim Peters <tim.peters@gmail.com>
parents: 13256
diff changeset
20 extern DL_IMPORT(long) PyLong_AsLong(PyObject *);
a503af7e7fb7 Some cleanup of longs in prepartion for Cray J90 fixes: got
Tim Peters <tim.peters@gmail.com>
parents: 13256
diff changeset
21 extern DL_IMPORT(unsigned long) PyLong_AsUnsignedLong(PyObject *);
19671
7df300d284c6 Introduce new private API function _PyLong_AsScaledDouble. Not used yet,
Tim Peters <tim.peters@gmail.com>
parents: 19550
diff changeset
22
7df300d284c6 Introduce new private API function _PyLong_AsScaledDouble. Not used yet,
Tim Peters <tim.peters@gmail.com>
parents: 19550
diff changeset
23 /* _PyLong_AsScaledDouble returns a double x and an exponent e such that
7df300d284c6 Introduce new private API function _PyLong_AsScaledDouble. Not used yet,
Tim Peters <tim.peters@gmail.com>
parents: 19550
diff changeset
24 the true value is approximately equal to x * 2**(SHIFT*e). e is >= 0.
7df300d284c6 Introduce new private API function _PyLong_AsScaledDouble. Not used yet,
Tim Peters <tim.peters@gmail.com>
parents: 19550
diff changeset
25 x is 0.0 if and only if the input is 0 (in which case, e and x are both
7df300d284c6 Introduce new private API function _PyLong_AsScaledDouble. Not used yet,
Tim Peters <tim.peters@gmail.com>
parents: 19550
diff changeset
26 zeroes). Overflow is impossible. Note that the exponent returned must
7df300d284c6 Introduce new private API function _PyLong_AsScaledDouble. Not used yet,
Tim Peters <tim.peters@gmail.com>
parents: 19550
diff changeset
27 be multiplied by SHIFT! There may not be enough room in an int to store
7df300d284c6 Introduce new private API function _PyLong_AsScaledDouble. Not used yet,
Tim Peters <tim.peters@gmail.com>
parents: 19550
diff changeset
28 e*SHIFT directly. */
7df300d284c6 Introduce new private API function _PyLong_AsScaledDouble. Not used yet,
Tim Peters <tim.peters@gmail.com>
parents: 19550
diff changeset
29 extern DL_IMPORT(double) _PyLong_AsScaledDouble(PyObject *vv, int *e);
7df300d284c6 Introduce new private API function _PyLong_AsScaledDouble. Not used yet,
Tim Peters <tim.peters@gmail.com>
parents: 19550
diff changeset
30
13406
a503af7e7fb7 Some cleanup of longs in prepartion for Cray J90 fixes: got
Tim Peters <tim.peters@gmail.com>
parents: 13256
diff changeset
31 extern DL_IMPORT(double) PyLong_AsDouble(PyObject *);
a503af7e7fb7 Some cleanup of longs in prepartion for Cray J90 fixes: got
Tim Peters <tim.peters@gmail.com>
parents: 13256
diff changeset
32 extern DL_IMPORT(PyObject *) PyLong_FromVoidPtr(void *);
a503af7e7fb7 Some cleanup of longs in prepartion for Cray J90 fixes: got
Tim Peters <tim.peters@gmail.com>
parents: 13256
diff changeset
33 extern DL_IMPORT(void *) PyLong_AsVoidPtr(PyObject *);
614
11e86270ed0d Added typedef for longobject and declarations for long_{format,scan}.
Guido van Rossum <guido@python.org>
parents: 255
diff changeset
34
8822
bd47ee068b83 Changes for BeOS, QNX and long long, by Chris Herborth.
Guido van Rossum <guido@python.org>
parents: 4870
diff changeset
35 #ifdef HAVE_LONG_LONG
9784
8dba08223deb Changes for long file support by Steve Clift.
Guido van Rossum <guido@python.org>
parents: 9586
diff changeset
36
8dba08223deb Changes for long file support by Steve Clift.
Guido van Rossum <guido@python.org>
parents: 9586
diff changeset
37 /* Hopefully this is portable... */
8dba08223deb Changes for long file support by Steve Clift.
Guido van Rossum <guido@python.org>
parents: 9586
diff changeset
38 #ifndef ULONG_MAX
8dba08223deb Changes for long file support by Steve Clift.
Guido van Rossum <guido@python.org>
parents: 9586
diff changeset
39 #define ULONG_MAX 4294967295U
8dba08223deb Changes for long file support by Steve Clift.
Guido van Rossum <guido@python.org>
parents: 9586
diff changeset
40 #endif
8dba08223deb Changes for long file support by Steve Clift.
Guido van Rossum <guido@python.org>
parents: 9586
diff changeset
41 #ifndef LONGLONG_MAX
8dba08223deb Changes for long file support by Steve Clift.
Guido van Rossum <guido@python.org>
parents: 9586
diff changeset
42 #define LONGLONG_MAX 9223372036854775807LL
8dba08223deb Changes for long file support by Steve Clift.
Guido van Rossum <guido@python.org>
parents: 9586
diff changeset
43 #endif
8dba08223deb Changes for long file support by Steve Clift.
Guido van Rossum <guido@python.org>
parents: 9586
diff changeset
44 #ifndef ULONGLONG_MAX
8dba08223deb Changes for long file support by Steve Clift.
Guido van Rossum <guido@python.org>
parents: 9586
diff changeset
45 #define ULONGLONG_MAX 0xffffffffffffffffULL
8dba08223deb Changes for long file support by Steve Clift.
Guido van Rossum <guido@python.org>
parents: 9586
diff changeset
46 #endif
8dba08223deb Changes for long file support by Steve Clift.
Guido van Rossum <guido@python.org>
parents: 9586
diff changeset
47
13406
a503af7e7fb7 Some cleanup of longs in prepartion for Cray J90 fixes: got
Tim Peters <tim.peters@gmail.com>
parents: 13256
diff changeset
48 extern DL_IMPORT(PyObject *) PyLong_FromLongLong(LONG_LONG);
a503af7e7fb7 Some cleanup of longs in prepartion for Cray J90 fixes: got
Tim Peters <tim.peters@gmail.com>
parents: 13256
diff changeset
49 extern DL_IMPORT(PyObject *) PyLong_FromUnsignedLongLong(unsigned LONG_LONG);
a503af7e7fb7 Some cleanup of longs in prepartion for Cray J90 fixes: got
Tim Peters <tim.peters@gmail.com>
parents: 13256
diff changeset
50 extern DL_IMPORT(LONG_LONG) PyLong_AsLongLong(PyObject *);
a503af7e7fb7 Some cleanup of longs in prepartion for Cray J90 fixes: got
Tim Peters <tim.peters@gmail.com>
parents: 13256
diff changeset
51 extern DL_IMPORT(unsigned LONG_LONG) PyLong_AsUnsignedLongLong(PyObject *);
9044
d437b6683e24 Patch by Mark Hammond to support 64-bit ints on MS platforms.
Guido van Rossum <guido@python.org>
parents: 8822
diff changeset
52 #endif /* HAVE_LONG_LONG */
8822
bd47ee068b83 Changes for BeOS, QNX and long long, by Chris Herborth.
Guido van Rossum <guido@python.org>
parents: 4870
diff changeset
53
13406
a503af7e7fb7 Some cleanup of longs in prepartion for Cray J90 fixes: got
Tim Peters <tim.peters@gmail.com>
parents: 13256
diff changeset
54 DL_IMPORT(PyObject *) PyLong_FromString(char *, char **, int);
19343
7257e87e0720 Patch #445762: Support --disable-unicode
Martin v. Löwis <martin@v.loewis.de>
parents: 18082
diff changeset
55 #ifdef Py_USING_UNICODE
13406
a503af7e7fb7 Some cleanup of longs in prepartion for Cray J90 fixes: got
Tim Peters <tim.peters@gmail.com>
parents: 13256
diff changeset
56 DL_IMPORT(PyObject *) PyLong_FromUnicode(Py_UNICODE*, int, int);
19343
7257e87e0720 Patch #445762: Support --disable-unicode
Martin v. Löwis <martin@v.loewis.de>
parents: 18082
diff changeset
57 #endif
1329
519c25039c6a * Added support for X11 modules.
Guido van Rossum <guido@python.org>
parents: 1257
diff changeset
58
18082
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
59 /* _PyLong_FromByteArray: View the n unsigned bytes as a binary integer in
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
60 base 256, and return a Python long with the same numeric value.
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
61 If n is 0, the integer is 0. Else:
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
62 If little_endian is 1/true, bytes[n-1] is the MSB and bytes[0] the LSB;
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
63 else (little_endian is 0/false) bytes[0] is the MSB and bytes[n-1] the
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
64 LSB.
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
65 If is_signed is 0/false, view the bytes as a non-negative integer.
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
66 If is_signed is 1/true, view the bytes as a 2's-complement integer,
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
67 non-negative if bit 0x80 of the MSB is clear, negative if set.
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
68 Error returns:
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
69 + Return NULL with the appropriate exception set if there's not
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
70 enough memory to create the Python long.
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
71 */
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
72 extern DL_IMPORT(PyObject *) _PyLong_FromByteArray(
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
73 const unsigned char* bytes, size_t n,
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
74 int little_endian, int is_signed);
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
75
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
76 /* _PyLong_AsByteArray: Convert the least-significant 8*n bits of long
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
77 v to a base-256 integer, stored in array bytes. Normally return 0,
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
78 return -1 on error.
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
79 If little_endian is 1/true, store the MSB at bytes[n-1] and the LSB at
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
80 bytes[0]; else (little_endian is 0/false) store the MSB at bytes[0] and
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
81 the LSB at bytes[n-1].
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
82 If is_signed is 0/false, it's an error if v < 0; else (v >= 0) n bytes
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
83 are filled and there's nothing special about bit 0x80 of the MSB.
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
84 If is_signed is 1/true, bytes is filled with the 2's-complement
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
85 representation of v's value. Bit 0x80 of the MSB is the sign bit.
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
86 Error returns (-1):
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
87 + is_signed is 0 and v < 0. TypeError is set in this case, and bytes
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
88 isn't altered.
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
89 + n isn't big enough to hold the full mathematical value of v. For
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
90 example, if is_signed is 0 and there are more digits in the v than
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
91 fit in n; or if is_signed is 1, v < 0, and n is just 1 bit shy of
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
92 being large enough to hold a sign bit. OverflowError is set in this
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
93 case, but bytes holds the least-signficant n bytes of the true value.
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
94 */
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
95 extern DL_IMPORT(int) _PyLong_AsByteArray(PyLongObject* v,
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
96 unsigned char* bytes, size_t n,
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
97 int little_endian, int is_signed);
dd09f11fa40d Two new private longobject API functions,
Tim Peters <tim.peters@gmail.com>
parents: 14869
diff changeset
98
1329
519c25039c6a * Added support for X11 modules.
Guido van Rossum <guido@python.org>
parents: 1257
diff changeset
99 #ifdef __cplusplus
519c25039c6a * Added support for X11 modules.
Guido van Rossum <guido@python.org>
parents: 1257
diff changeset
100 }
519c25039c6a * Added support for X11 modules.
Guido van Rossum <guido@python.org>
parents: 1257
diff changeset
101 #endif
519c25039c6a * Added support for X11 modules.
Guido van Rossum <guido@python.org>
parents: 1257
diff changeset
102 #endif /* !Py_LONGOBJECT_H */