| 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_VAR_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 (any mapping) */
|
|---|
| 23 | PyObject **f_valuestack; /* points after the last local */
|
|---|
| 24 | /* Next free slot in f_valuestack. Frame creation sets to f_valuestack.
|
|---|
| 25 | Frame evaluation usually NULLs it, but a frame that yields sets it
|
|---|
| 26 | to the current stack top. */
|
|---|
| 27 | PyObject **f_stacktop;
|
|---|
| 28 | PyObject *f_trace; /* Trace function */
|
|---|
| 29 |
|
|---|
| 30 | /* If an exception is raised in this frame, the next three are used to
|
|---|
| 31 | * record the exception info (if any) originally in the thread state. See
|
|---|
| 32 | * comments before set_exc_info() -- it's not obvious.
|
|---|
| 33 | * Invariant: if _type is NULL, then so are _value and _traceback.
|
|---|
| 34 | * Desired invariant: all three are NULL, or all three are non-NULL. That
|
|---|
| 35 | * one isn't currently true, but "should be".
|
|---|
| 36 | */
|
|---|
| 37 | PyObject *f_exc_type, *f_exc_value, *f_exc_traceback;
|
|---|
| 38 |
|
|---|
| 39 | PyThreadState *f_tstate;
|
|---|
| 40 | int f_lasti; /* Last instruction if called */
|
|---|
| 41 | /* As of 2.3 f_lineno is only valid when tracing is active (i.e. when
|
|---|
| 42 | f_trace is set) -- at other times use PyCode_Addr2Line instead. */
|
|---|
| 43 | int f_lineno; /* Current line number */
|
|---|
| 44 | int f_iblock; /* index in f_blockstack */
|
|---|
| 45 | PyTryBlock f_blockstack[CO_MAXBLOCKS]; /* for try and loop blocks */
|
|---|
| 46 | PyObject *f_localsplus[1]; /* locals+stack, dynamically sized */
|
|---|
| 47 | } PyFrameObject;
|
|---|
| 48 |
|
|---|
| 49 |
|
|---|
| 50 | /* Standard object interface */
|
|---|
| 51 |
|
|---|
| 52 | PyAPI_DATA(PyTypeObject) PyFrame_Type;
|
|---|
| 53 |
|
|---|
| 54 | #define PyFrame_Check(op) ((op)->ob_type == &PyFrame_Type)
|
|---|
| 55 | #define PyFrame_IsRestricted(f) \
|
|---|
| 56 | ((f)->f_builtins != (f)->f_tstate->interp->builtins)
|
|---|
| 57 |
|
|---|
| 58 | PyAPI_FUNC(PyFrameObject *) PyFrame_New(PyThreadState *, PyCodeObject *,
|
|---|
| 59 | PyObject *, PyObject *);
|
|---|
| 60 |
|
|---|
| 61 |
|
|---|
| 62 | /* The rest of the interface is specific for frame objects */
|
|---|
| 63 |
|
|---|
| 64 | /* Block management functions */
|
|---|
| 65 |
|
|---|
| 66 | PyAPI_FUNC(void) PyFrame_BlockSetup(PyFrameObject *, int, int, int);
|
|---|
| 67 | PyAPI_FUNC(PyTryBlock *) PyFrame_BlockPop(PyFrameObject *);
|
|---|
| 68 |
|
|---|
| 69 | /* Extend the value stack */
|
|---|
| 70 |
|
|---|
| 71 | PyAPI_FUNC(PyObject **) PyFrame_ExtendStack(PyFrameObject *, int, int);
|
|---|
| 72 |
|
|---|
| 73 | /* Conversions between "fast locals" and locals in dictionary */
|
|---|
| 74 |
|
|---|
| 75 | PyAPI_FUNC(void) PyFrame_LocalsToFast(PyFrameObject *, int);
|
|---|
| 76 | PyAPI_FUNC(void) PyFrame_FastToLocals(PyFrameObject *);
|
|---|
| 77 |
|
|---|
| 78 | PyAPI_FUNC(int) PyFrame_ClearFreeList(void);
|
|---|
| 79 |
|
|---|
| 80 | #ifdef __cplusplus
|
|---|
| 81 | }
|
|---|
| 82 | #endif
|
|---|
| 83 | #endif /* !Py_FRAMEOBJECT_H */
|
|---|
