1
2/* Integer object interface */
3
4/*
5PyIntObject represents a (long) integer. This is an immutable object;
6an integer cannot change its value after creation.
7
8There are functions to create new integer objects, to test an object
9for integer-ness, and to get the integer value. The latter functions
10returns -1 and sets errno to EBADF if the object is not an PyIntObject.
11None of the functions should be applied to nil objects.
12
13The type PyIntObject is (unfortunately) exposed here so we can declare
14_Py_TrueStruct and _Py_ZeroStruct in boolobject.h; don't use this.
15*/
16
17#ifndef Py_INTOBJECT_H
18#define Py_INTOBJECT_H
19#ifdef __cplusplus
20extern "C" {
21#endif
22
23typedef struct {
24 PyObject_HEAD
25 long ob_ival;
26} PyIntObject;
27
28PyAPI_DATA(PyTypeObject) PyInt_Type;
29
30#define PyInt_Check(op) \
31 PyType_FastSubclass(Py_TYPE(op), Py_TPFLAGS_INT_SUBCLASS)
32#define PyInt_CheckExact(op) (Py_TYPE(op) == &PyInt_Type)
33
34#define _PyAnyInt_Check(op) (PyInt_Check(op) || PyLong_Check(op))
35#define _PyAnyInt_CheckExact(op) (PyInt_CheckExact(op) || PyLong_CheckExact(op))
36
37PyAPI_FUNC(PyObject *) PyInt_FromString(char*, char**, int);
38#ifdef Py_USING_UNICODE
39PyAPI_FUNC(PyObject *) PyInt_FromUnicode(Py_UNICODE*, Py_ssize_t, int);
40#endif
41PyAPI_FUNC(PyObject *) PyInt_FromLong(long);
42PyAPI_FUNC(PyObject *) PyInt_FromSize_t(size_t);
43PyAPI_FUNC(PyObject *) PyInt_FromSsize_t(Py_ssize_t);
44PyAPI_FUNC(long) PyInt_AsLong(PyObject *);
45PyAPI_FUNC(Py_ssize_t) PyInt_AsSsize_t(PyObject *);
46PyAPI_FUNC(int) _PyInt_AsInt(PyObject *);
47PyAPI_FUNC(unsigned long) PyInt_AsUnsignedLongMask(PyObject *);
48#ifdef HAVE_LONG_LONG
49PyAPI_FUNC(unsigned PY_LONG_LONG) PyInt_AsUnsignedLongLongMask(PyObject *);
50#endif
51
52PyAPI_FUNC(long) PyInt_GetMax(void);
53
54/* Macro, trading safety for speed */
55#define PyInt_AS_LONG(op) (((PyIntObject *)(op))->ob_ival)
56
57/* These aren't really part of the Int object, but they're handy; the protos
58 * are necessary for systems that need the magic of PyAPI_FUNC and that want
59 * to have stropmodule as a dynamically loaded module instead of building it
60 * into the main Python shared library/DLL. Guido thinks I'm weird for
61 * building it this way. :-) [cjh]
62 */
63PyAPI_FUNC(unsigned long) PyOS_strtoul(char *, char **, int);
64PyAPI_FUNC(long) PyOS_strtol(char *, char **, int);
65
66/* free list api */
67PyAPI_FUNC(int) PyInt_ClearFreeList(void);
68
69/* Convert an integer to the given base. Returns a string.
70 If base is 2, 8 or 16, add the proper prefix '0b', '0o' or '0x'.
71 If newstyle is zero, then use the pre-2.6 behavior of octal having
72 a leading "0" */
73PyAPI_FUNC(PyObject*) _PyInt_Format(PyIntObject* v, int base, int newstyle);
74
75/* Format the object based on the format_spec, as defined in PEP 3101
76 (Advanced String Formatting). */
77PyAPI_FUNC(PyObject *) _PyInt_FormatAdvanced(PyObject *obj,
78 char *format_spec,
79 Py_ssize_t format_spec_len);
80
81#ifdef __cplusplus
82}
83#endif
84#endif /* !Py_INTOBJECT_H */
85