Include/intobject.h

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