blob: e6eb49deca0d3fc343e22a50f430cebf7e0dcb08 [file] [log] [blame]
Guido van Rossuma3309961993-07-28 09:05:47 +00001#ifndef Py_INTOBJECT_H
2#define Py_INTOBJECT_H
3#ifdef __cplusplus
4extern "C" {
5#endif
6
Guido van Rossumf70e43a1991-02-19 12:39:46 +00007/***********************************************************
Guido van Rossum5799b521995-01-04 19:06:22 +00008Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
9The Netherlands.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000010
11 All Rights Reserved
12
Guido van Rossumd266eb41996-10-25 14:44:06 +000013Permission to use, copy, modify, and distribute this software and its
14documentation for any purpose and without fee is hereby granted,
Guido van Rossumf70e43a1991-02-19 12:39:46 +000015provided that the above copyright notice appear in all copies and that
Guido van Rossumd266eb41996-10-25 14:44:06 +000016both that copyright notice and this permission notice appear in
Guido van Rossumf70e43a1991-02-19 12:39:46 +000017supporting documentation, and that the names of Stichting Mathematisch
Guido van Rossumd266eb41996-10-25 14:44:06 +000018Centrum or CWI or Corporation for National Research Initiatives or
19CNRI not be used in advertising or publicity pertaining to
20distribution of the software without specific, written prior
21permission.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000022
Guido van Rossumd266eb41996-10-25 14:44:06 +000023While CWI is the initial source for this software, a modified version
24is made available by the Corporation for National Research Initiatives
25(CNRI) at the Internet address ftp://ftp.python.org.
26
27STICHTING MATHEMATISCH CENTRUM AND CNRI DISCLAIM ALL WARRANTIES WITH
28REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
29MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH
30CENTRUM OR CNRI BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
31DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
32PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
33TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
34PERFORMANCE OF THIS SOFTWARE.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000035
36******************************************************************/
37
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000038/* Integer object interface */
39
40/*
41123456789-123456789-123456789-123456789-123456789-123456789-123456789-12
42
Guido van Rossumcaa63801995-01-12 11:45:45 +000043PyIntObject represents a (long) integer. This is an immutable object;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000044an integer cannot change its value after creation.
45
46There are functions to create new integer objects, to test an object
47for integer-ness, and to get the integer value. The latter functions
Guido van Rossumcaa63801995-01-12 11:45:45 +000048returns -1 and sets errno to EBADF if the object is not an PyIntObject.
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000049None of the functions should be applied to nil objects.
50
Guido van Rossumcaa63801995-01-12 11:45:45 +000051The type PyIntObject is (unfortunately) exposed here so we can declare
52_Py_TrueStruct and _Py_ZeroStruct below; don't use this.
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000053*/
54
55typedef struct {
Guido van Rossumcaa63801995-01-12 11:45:45 +000056 PyObject_HEAD
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000057 long ob_ival;
Guido van Rossumcaa63801995-01-12 11:45:45 +000058} PyIntObject;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000059
Guido van Rossum051ab121995-02-27 10:17:52 +000060extern DL_IMPORT(PyTypeObject) PyInt_Type;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000061
Guido van Rossumcaa63801995-01-12 11:45:45 +000062#define PyInt_Check(op) ((op)->ob_type == &PyInt_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000063
Guido van Rossum43466ec1998-12-04 18:48:25 +000064extern DL_IMPORT(PyObject *) PyInt_FromLong Py_PROTO((long));
65extern DL_IMPORT(long) PyInt_AsLong Py_PROTO((PyObject *));
66extern DL_IMPORT(long) PyInt_GetMax Py_PROTO((void));
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000067
68
69/*
70123456789-123456789-123456789-123456789-123456789-123456789-123456789-12
71
72False and True are special intobjects used by Boolean expressions.
73All values of type Boolean must point to either of these; but in
74contexts where integers are required they are integers (valued 0 and 1).
75Hope these macros don't conflict with other people's.
76
Guido van Rossumcaa63801995-01-12 11:45:45 +000077Don't forget to apply Py_INCREF() when returning True or False!!!
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000078*/
79
Guido van Rossum051ab121995-02-27 10:17:52 +000080extern DL_IMPORT(PyIntObject) _Py_ZeroStruct, _Py_TrueStruct; /* Don't use these directly */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000081
Guido van Rossumcaa63801995-01-12 11:45:45 +000082#define Py_False ((PyObject *) &_Py_ZeroStruct)
83#define Py_True ((PyObject *) &_Py_TrueStruct)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000084
85/* Macro, trading safety for speed */
Guido van Rossum7a2d6111997-08-02 02:41:13 +000086#define PyInt_AS_LONG(op) (((PyIntObject *)(op))->ob_ival)
Guido van Rossuma3309961993-07-28 09:05:47 +000087
Guido van Rossumcc34faa1998-12-10 16:54:17 +000088/* These aren't really part of the Int object, but they're handy; the protos
89 * are necessary for systems that need the magic of DL_IMPORT and that want
90 * to have stropmodule as a dynamically loaded module instead of building it
91 * into the main Python shared library/DLL. Guido thinks I'm weird for
92 * building it this way. :-) [cjh]
93 */
94extern DL_IMPORT(unsigned long) PyOS_strtoul Py_PROTO((char *, char **, int));
95extern DL_IMPORT(long) PyOS_strtol Py_PROTO((char *, char **, int));
96
Guido van Rossuma3309961993-07-28 09:05:47 +000097#ifdef __cplusplus
98}
99#endif
100#endif /* !Py_INTOBJECT_H */