blob: 7b778e984f737a23e90b13aee934ff6471ce8d21 [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 Rossum9bfef441993-03-29 10:43:31 +00008Copyright 1991, 1992, 1993 by Stichting Mathematisch Centrum,
9Amsterdam, The Netherlands.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000010
11 All Rights Reserved
12
13Permission to use, copy, modify, and distribute this software and its
14documentation for any purpose and without fee is hereby granted,
15provided that the above copyright notice appear in all copies and that
16both that copyright notice and this permission notice appear in
17supporting documentation, and that the names of Stichting Mathematisch
18Centrum or CWI not be used in advertising or publicity pertaining to
19distribution of the software without specific, written prior permission.
20
21STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
22THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
23FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
24FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
25WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
26ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
27OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
28
29******************************************************************/
30
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000031/* Integer object interface */
32
33/*
34123456789-123456789-123456789-123456789-123456789-123456789-123456789-12
35
36intobject represents a (long) integer. This is an immutable object;
37an integer cannot change its value after creation.
38
39There are functions to create new integer objects, to test an object
40for integer-ness, and to get the integer value. The latter functions
41returns -1 and sets errno to EBADF if the object is not an intobject.
42None of the functions should be applied to nil objects.
43
44The type intobject is (unfortunately) exposed bere so we can declare
45TrueObject and FalseObject below; don't use this.
46*/
47
48typedef struct {
49 OB_HEAD
50 long ob_ival;
51} intobject;
52
53extern typeobject Inttype;
54
55#define is_intobject(op) ((op)->ob_type == &Inttype)
56
57extern object *newintobject PROTO((long));
58extern long getintvalue PROTO((object *));
59
60
61/*
62123456789-123456789-123456789-123456789-123456789-123456789-123456789-12
63
64False and True are special intobjects used by Boolean expressions.
65All values of type Boolean must point to either of these; but in
66contexts where integers are required they are integers (valued 0 and 1).
67Hope these macros don't conflict with other people's.
68
69Don't forget to apply INCREF() when returning True or False!!!
70*/
71
72extern intobject FalseObject, TrueObject; /* Don't use these directly */
73
74#define False ((object *) &FalseObject)
75#define True ((object *) &TrueObject)
76
77/* Macro, trading safety for speed */
78#define GETINTVALUE(op) ((op)->ob_ival)
Guido van Rossuma3309961993-07-28 09:05:47 +000079
80#ifdef __cplusplus
81}
82#endif
83#endif /* !Py_INTOBJECT_H */