blob: 2d244ecedd037a155b3a66c2fac3260cdb277d4e [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Integer object interface */
3
4/*
Guido van Rossumcaa63801995-01-12 11:45:45 +00005PyIntObject represents a (long) integer. This is an immutable object;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00006an 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
Guido van Rossumcaa63801995-01-12 11:45:45 +000010returns -1 and sets errno to EBADF if the object is not an PyIntObject.
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000011None of the functions should be applied to nil objects.
12
Guido van Rossumcaa63801995-01-12 11:45:45 +000013The type PyIntObject is (unfortunately) exposed here so we can declare
14_Py_TrueStruct and _Py_ZeroStruct below; don't use this.
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000015*/
16
Fred Drakeea9cb5a2000-07-09 00:20:36 +000017#ifndef Py_INTOBJECT_H
18#define Py_INTOBJECT_H
19#ifdef __cplusplus
20extern "C" {
21#endif
22
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000023typedef struct {
Fred Drakeea9cb5a2000-07-09 00:20:36 +000024 PyObject_HEAD
25 long ob_ival;
Guido van Rossumcaa63801995-01-12 11:45:45 +000026} PyIntObject;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000027
Guido van Rossum051ab121995-02-27 10:17:52 +000028extern DL_IMPORT(PyTypeObject) PyInt_Type;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000029
Guido van Rossumc16fcdf2001-08-29 15:45:32 +000030#define PyInt_Check(op) PyObject_TypeCheck(op, &PyInt_Type)
Tim Peters64b5ce32001-09-10 20:52:51 +000031#define PyInt_CheckExact(op) ((op)->ob_type == &PyInt_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000032
Fred Drakeea9cb5a2000-07-09 00:20:36 +000033extern DL_IMPORT(PyObject *) PyInt_FromString(char*, char**, int);
Martin v. Löwis339d0f72001-08-17 18:39:25 +000034#ifdef Py_USING_UNICODE
Fred Drakeea9cb5a2000-07-09 00:20:36 +000035extern DL_IMPORT(PyObject *) PyInt_FromUnicode(Py_UNICODE*, int, int);
Martin v. Löwis339d0f72001-08-17 18:39:25 +000036#endif
Fred Drakeea9cb5a2000-07-09 00:20:36 +000037extern DL_IMPORT(PyObject *) PyInt_FromLong(long);
38extern DL_IMPORT(long) PyInt_AsLong(PyObject *);
39extern DL_IMPORT(long) PyInt_GetMax(void);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000040
41
42/*
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000043False and True are special intobjects used by Boolean expressions.
44All values of type Boolean must point to either of these; but in
45contexts where integers are required they are integers (valued 0 and 1).
46Hope these macros don't conflict with other people's.
47
Guido van Rossumcaa63801995-01-12 11:45:45 +000048Don't forget to apply Py_INCREF() when returning True or False!!!
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000049*/
50
Guido van Rossum051ab121995-02-27 10:17:52 +000051extern DL_IMPORT(PyIntObject) _Py_ZeroStruct, _Py_TrueStruct; /* Don't use these directly */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000052
Guido van Rossumcaa63801995-01-12 11:45:45 +000053#define Py_False ((PyObject *) &_Py_ZeroStruct)
54#define Py_True ((PyObject *) &_Py_TrueStruct)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000055
56/* Macro, trading safety for speed */
Guido van Rossum7a2d6111997-08-02 02:41:13 +000057#define PyInt_AS_LONG(op) (((PyIntObject *)(op))->ob_ival)
Guido van Rossuma3309961993-07-28 09:05:47 +000058
Guido van Rossumcc34faa1998-12-10 16:54:17 +000059/* These aren't really part of the Int object, but they're handy; the protos
60 * are necessary for systems that need the magic of DL_IMPORT and that want
61 * to have stropmodule as a dynamically loaded module instead of building it
62 * into the main Python shared library/DLL. Guido thinks I'm weird for
63 * building it this way. :-) [cjh]
64 */
Fred Drakeea9cb5a2000-07-09 00:20:36 +000065extern DL_IMPORT(unsigned long) PyOS_strtoul(char *, char **, int);
66extern DL_IMPORT(long) PyOS_strtol(char *, char **, int);
Guido van Rossumcc34faa1998-12-10 16:54:17 +000067
Guido van Rossuma3309961993-07-28 09:05:47 +000068#ifdef __cplusplus
69}
70#endif
71#endif /* !Py_INTOBJECT_H */