[mirror_edk2.git] / AppPkg / Applications / Python / Python-2.7.2 / Include / longobject.h

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