Include/frameobject.h

   1
   2 /* Frame object interface */
   3
   4 #ifndef Py_FRAMEOBJECT_H
   5 #define Py_FRAMEOBJECT_H
   6 #ifdef __cplusplus
   7 extern "C" {
   8 #endif
   9
  10 typedef struct {
  11     int b_type;                 /* what kind of block this is */
  12     int b_handler;              /* where to jump to find handler */
  13     int b_level;                /* value stack level to pop to */
  14 } PyTryBlock;
  15
  16 typedef struct _frame {
  17     PyObject_HEAD
  18     struct _frame *f_back;      /* previous frame, or NULL */
  19     PyCodeObject *f_code;       /* code segment */
  20     PyObject *f_builtins;       /* builtin symbol table (PyDictObject) */
  21     PyObject *f_globals;        /* global symbol table (PyDictObject) */
  22     PyObject *f_locals;         /* local symbol table (PyDictObject) */
  23     PyObject **f_valuestack;    /* points after the last local */
  24     PyObject *f_trace;          /* Trace function */
  25     PyObject *f_exc_type, *f_exc_value, *f_exc_traceback;
  26     PyThreadState *f_tstate;
  27     int f_lasti;                /* Last instruction if called */
  28     int f_lineno;               /* Current line number */
  29     int f_restricted;           /* Flag set if restricted operations
  30                                    in this scope */
  31     int f_iblock;               /* index in f_blockstack */
  32     PyTryBlock f_blockstack[CO_MAXBLOCKS]; /* for try and loop blocks */
  33     int f_size;                 /* size of localsplus */
  34     int f_nlocals;              /* number of locals */
  35     int f_ncells;
  36     int f_nfreevars;
  37     int f_stacksize;            /* size of value stack */
  38     PyObject *f_localsplus[1];  /* locals+stack, dynamically sized */
  39 } PyFrameObject;
  40
  41
  42 /* Standard object interface */
  43
  44 extern DL_IMPORT(PyTypeObject) PyFrame_Type;
  45
  46 #define PyFrame_Check(op) ((op)->ob_type == &PyFrame_Type)
  47
  48 DL_IMPORT(PyFrameObject *) PyFrame_New(PyThreadState *, PyCodeObject *,
  49                                        PyObject *, PyObject *,
  50                                        PyObject *);
  51
  52
  53 /* The rest of the interface is specific for frame objects */
  54
  55 /* Tuple access macros */
  56
  57 #ifndef Py_DEBUG
  58 #define GETITEM(v, i) PyTuple_GET_ITEM((PyTupleObject *)(v), (i))
  59 #define GETITEMNAME(v, i) \
  60         PyString_AS_STRING((PyStringObject *)GETITEM((v), (i)))
  61 #else
  62 #define GETITEM(v, i) PyTuple_GetItem((v), (i))
  63 #define GETITEMNAME(v, i) PyString_AsString(GETITEM(v, i))
  64 #endif
  65
  66 #define GETUSTRINGVALUE(s) ((unsigned char *)PyString_AS_STRING(s))
  67
  68 /* Code access macros */
  69
  70 #define Getconst(f, i)  (GETITEM((f)->f_code->co_consts, (i)))
  71 #define Getname(f, i)   (GETITEMNAME((f)->f_code->co_names, (i)))
  72 #define Getnamev(f, i)  (GETITEM((f)->f_code->co_names, (i)))
  73
  74
  75 /* Block management functions */
  76
  77 DL_IMPORT(void) PyFrame_BlockSetup(PyFrameObject *, int, int, int);
  78 DL_IMPORT(PyTryBlock *) PyFrame_BlockPop(PyFrameObject *);
  79
  80 /* Extend the value stack */
  81
  82 DL_IMPORT(PyObject **) PyFrame_ExtendStack(PyFrameObject *, int, int);
  83
  84 /* Conversions between "fast locals" and locals in dictionary */
  85
  86 DL_IMPORT(void) PyFrame_LocalsToFast(PyFrameObject *, int);
  87 DL_IMPORT(void) PyFrame_FastToLocals(PyFrameObject *);
  88
  89 #ifdef __cplusplus
  90 }
  91 #endif
  92 #endif /* !Py_FRAMEOBJECT_H */