blob: 7dc14e32040e4dbfba7f7055bfd069e0881a38a0 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum3f5da241990-12-20 15:06:42 +00002/* Frame object interface */
3
Fred Drakeea9cb5a2000-07-09 00:20:36 +00004#ifndef Py_FRAMEOBJECT_H
5#define Py_FRAMEOBJECT_H
6#ifdef __cplusplus
7extern "C" {
8#endif
9
Guido van Rossum3f5da241990-12-20 15:06:42 +000010typedef struct {
Fred Drakeea9cb5a2000-07-09 00:20:36 +000011 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 */
Guido van Rossumcaa63801995-01-12 11:45:45 +000014} PyTryBlock;
Guido van Rossum3f5da241990-12-20 15:06:42 +000015
16typedef struct _frame {
Neil Schemenauer251ead82001-08-29 23:45:25 +000017 PyObject_VAR_HEAD
Fred Drakeea9cb5a2000-07-09 00:20:36 +000018 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) */
Raymond Hettinger214b1c32004-07-02 06:41:07 +000022 PyObject *f_locals; /* local symbol table (any mapping) */
Fred Drakeea9cb5a2000-07-09 00:20:36 +000023 PyObject **f_valuestack; /* points after the last local */
Tim Peters8c963692001-06-23 05:26:56 +000024 /* 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;
Fred Drakeea9cb5a2000-07-09 00:20:36 +000028 PyObject *f_trace; /* Trace function */
29 PyObject *f_exc_type, *f_exc_value, *f_exc_traceback;
30 PyThreadState *f_tstate;
31 int f_lasti; /* Last instruction if called */
Michael W. Hudson02ff6a92002-09-11 15:36:32 +000032 /* As of 2.3 f_lineno is only valid when tracing is active (i.e. when
33 f_trace is set) -- at other times use PyCode_Addr2Line instead. */
Fred Drakeea9cb5a2000-07-09 00:20:36 +000034 int f_lineno; /* Current line number */
35 int f_restricted; /* Flag set if restricted operations
Guido van Rossumcaa63801995-01-12 11:45:45 +000036 in this scope */
Fred Drakeea9cb5a2000-07-09 00:20:36 +000037 int f_iblock; /* index in f_blockstack */
38 PyTryBlock f_blockstack[CO_MAXBLOCKS]; /* for try and loop blocks */
39 int f_nlocals; /* number of locals */
Jeremy Hylton2b724da2001-01-29 22:51:52 +000040 int f_ncells;
41 int f_nfreevars;
Fred Drakeea9cb5a2000-07-09 00:20:36 +000042 int f_stacksize; /* size of value stack */
43 PyObject *f_localsplus[1]; /* locals+stack, dynamically sized */
Guido van Rossumcaa63801995-01-12 11:45:45 +000044} PyFrameObject;
Guido van Rossum3f5da241990-12-20 15:06:42 +000045
46
47/* Standard object interface */
48
Mark Hammond91a681d2002-08-12 07:21:58 +000049PyAPI_DATA(PyTypeObject) PyFrame_Type;
Guido van Rossum3f5da241990-12-20 15:06:42 +000050
Guido van Rossumcaa63801995-01-12 11:45:45 +000051#define PyFrame_Check(op) ((op)->ob_type == &PyFrame_Type)
Guido van Rossum3f5da241990-12-20 15:06:42 +000052
Mark Hammond91a681d2002-08-12 07:21:58 +000053PyAPI_FUNC(PyFrameObject *) PyFrame_New(PyThreadState *, PyCodeObject *,
Jeremy Hylton30c9f392001-03-13 01:58:22 +000054 PyObject *, PyObject *);
Guido van Rossum3f5da241990-12-20 15:06:42 +000055
56
57/* The rest of the interface is specific for frame objects */
58
Guido van Rossum3f5da241990-12-20 15:06:42 +000059/* Block management functions */
60
Mark Hammond91a681d2002-08-12 07:21:58 +000061PyAPI_FUNC(void) PyFrame_BlockSetup(PyFrameObject *, int, int, int);
62PyAPI_FUNC(PyTryBlock *) PyFrame_BlockPop(PyFrameObject *);
Guido van Rossuma9e7dc11992-10-18 18:53:57 +000063
64/* Extend the value stack */
65
Mark Hammond91a681d2002-08-12 07:21:58 +000066PyAPI_FUNC(PyObject **) PyFrame_ExtendStack(PyFrameObject *, int, int);
Guido van Rossuma3309961993-07-28 09:05:47 +000067
Guido van Rossumb6775db1994-08-01 11:34:53 +000068/* Conversions between "fast locals" and locals in dictionary */
69
Mark Hammond91a681d2002-08-12 07:21:58 +000070PyAPI_FUNC(void) PyFrame_LocalsToFast(PyFrameObject *, int);
71PyAPI_FUNC(void) PyFrame_FastToLocals(PyFrameObject *);
Guido van Rossumb6775db1994-08-01 11:34:53 +000072
Guido van Rossuma3309961993-07-28 09:05:47 +000073#ifdef __cplusplus
74}
75#endif
76#endif /* !Py_FRAMEOBJECT_H */