Include/frameobject.h

   1 #ifndef Py_FRAMEOBJECT_H
   2 #define Py_FRAMEOBJECT_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 /* Frame object interface */
  32
  33 typedef struct {
  34         int b_type;             /* what kind of block this is */
  35         int b_handler;          /* where to jump to find handler */
  36         int b_level;            /* value stack level to pop to */
  37 } PyTryBlock;
  38
  39 typedef struct _frame {
  40         PyObject_HEAD
  41         struct _frame *f_back;  /* previous frame, or NULL */
  42         PyCodeObject *f_code;   /* code segment */
  43         PyObject *f_builtins;   /* builtin symbol table (PyDictObject) */
  44         PyObject *f_globals;    /* global symbol table (PyDictObject) */
  45         PyObject *f_locals;     /* local symbol table (PyDictObject) */
  46         PyObject *f_owner;      /* owner (e.g. class or module) or NULL */
  47         PyObject *f_fastlocals; /* fast local variables (PyListObject) */
  48         PyObject *f_localmap;   /* local variable names (PyDictObject) */
  49         PyObject **f_valuestack;        /* malloc'ed array */
  50         PyTryBlock *f_blockstack;       /* malloc'ed array */
  51         int f_nvalues;          /* size of f_valuestack */
  52         int f_nblocks;          /* size of f_blockstack */
  53         int f_iblock;           /* index in f_blockstack */
  54         int f_lasti;            /* Last instruction if called */
  55         int f_lineno;           /* Current line number */
  56         int f_restricted;       /* Flag set if restricted operations
  57                                    in this scope */
  58         PyObject *f_trace;      /* Trace function */
  59 } PyFrameObject;
  60
  61
  62 /* Standard object interface */
  63
  64 extern DL_IMPORT PyTypeObject PyFrame_Type;
  65
  66 #define PyFrame_Check(op) ((op)->ob_type == &PyFrame_Type)
  67
  68 PyFrameObject * PyFrame_New
  69         Py_PROTO((PyFrameObject *, PyCodeObject *,
  70                   PyObject *, PyObject *, PyObject *, int, int));
  71
  72
  73 /* The rest of the interface is specific for frame objects */
  74
  75 /* List access macros */
  76
  77 #ifdef NDEBUG
  78 #define GETITEM(v, i) PyTuple_GET_ITEM((PyTupleObject *)(v), (i))
  79 #define GETITEMNAME(v, i) \
  80         PyString_AS_STRING((PyStringObject *)GETITEM((v), (i)))
  81 #else
  82 #define GETITEM(v, i) PyTuple_GetItem((v), (i))
  83 #define GETITEMNAME(v, i) PyString_AsString(GETITEM(v, i))
  84 #endif
  85
  86 #define GETUSTRINGVALUE(s) ((unsigned char *)PyString_AS_STRING(s))
  87
  88 /* Code access macros */
  89
  90 #define Getconst(f, i)  (GETITEM((f)->f_code->co_consts, (i)))
  91 #define Getname(f, i)   (GETITEMNAME((f)->f_code->co_names, (i)))
  92 #define Getnamev(f, i)  (GETITEM((f)->f_code->co_names, (i)))
  93
  94
  95 /* Block management functions */
  96
  97 void PyFrame_BlockSetup Py_PROTO((PyFrameObject *, int, int, int));
  98 PyTryBlock *PyFrame_BlockPop Py_PROTO((PyFrameObject *));
  99
 100 /* Extend the value stack */
 101
 102 PyObject **PyFrame_ExtendStack Py_PROTO((PyFrameObject *, int, int));
 103
 104 /* Conversions between "fast locals" and locals in dictionary */
 105
 106 void locals_2_fast Py_PROTO((PyFrameObject *, int));
 107 void fast_2_locals Py_PROTO((PyFrameObject *));
 108
 109 #ifdef __cplusplus
 110 }
 111 #endif
 112 #endif /* !Py_FRAMEOBJECT_H */