Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 1 | |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 2 | /* Frame object interface */ |
| 3 | |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 4 | #ifndef Py_FRAMEOBJECT_H |
| 5 | #define Py_FRAMEOBJECT_H |
| 6 | #ifdef __cplusplus |
| 7 | extern "C" { |
| 8 | #endif |
| 9 | |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 10 | typedef struct { |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 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 */ |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 14 | } PyTryBlock; |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 15 | |
| 16 | typedef struct _frame { |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 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 */ |
Tim Peters | 8c96369 | 2001-06-23 05:26:56 +0000 | [diff] [blame] | 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; |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 28 | 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 */ |
| 32 | int f_lineno; /* Current line number */ |
| 33 | int f_restricted; /* Flag set if restricted operations |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 34 | in this scope */ |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 35 | int f_iblock; /* index in f_blockstack */ |
| 36 | PyTryBlock f_blockstack[CO_MAXBLOCKS]; /* for try and loop blocks */ |
Jeremy Hylton | 2b724da | 2001-01-29 22:51:52 +0000 | [diff] [blame] | 37 | int f_size; /* size of localsplus */ |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 38 | int f_nlocals; /* number of locals */ |
Jeremy Hylton | 2b724da | 2001-01-29 22:51:52 +0000 | [diff] [blame] | 39 | int f_ncells; |
| 40 | int f_nfreevars; |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 41 | int f_stacksize; /* size of value stack */ |
| 42 | PyObject *f_localsplus[1]; /* locals+stack, dynamically sized */ |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 43 | } PyFrameObject; |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 44 | |
| 45 | |
| 46 | /* Standard object interface */ |
| 47 | |
Guido van Rossum | 051ab12 | 1995-02-27 10:17:52 +0000 | [diff] [blame] | 48 | extern DL_IMPORT(PyTypeObject) PyFrame_Type; |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 49 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 50 | #define PyFrame_Check(op) ((op)->ob_type == &PyFrame_Type) |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 51 | |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 52 | DL_IMPORT(PyFrameObject *) PyFrame_New(PyThreadState *, PyCodeObject *, |
Jeremy Hylton | 30c9f39 | 2001-03-13 01:58:22 +0000 | [diff] [blame] | 53 | PyObject *, PyObject *); |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 54 | |
| 55 | |
| 56 | /* The rest of the interface is specific for frame objects */ |
| 57 | |
Guido van Rossum | 9381782 | 1995-01-17 16:01:01 +0000 | [diff] [blame] | 58 | /* Tuple access macros */ |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 59 | |
Guido van Rossum | 408027e | 1996-12-30 16:17:54 +0000 | [diff] [blame] | 60 | #ifndef Py_DEBUG |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 61 | #define GETITEM(v, i) PyTuple_GET_ITEM((PyTupleObject *)(v), (i)) |
| 62 | #define GETITEMNAME(v, i) \ |
| 63 | PyString_AS_STRING((PyStringObject *)GETITEM((v), (i))) |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 64 | #else |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 65 | #define GETITEM(v, i) PyTuple_GetItem((v), (i)) |
| 66 | #define GETITEMNAME(v, i) PyString_AsString(GETITEM(v, i)) |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 67 | #endif |
| 68 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 69 | #define GETUSTRINGVALUE(s) ((unsigned char *)PyString_AS_STRING(s)) |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 70 | |
| 71 | /* Code access macros */ |
| 72 | |
| 73 | #define Getconst(f, i) (GETITEM((f)->f_code->co_consts, (i))) |
| 74 | #define Getname(f, i) (GETITEMNAME((f)->f_code->co_names, (i))) |
Guido van Rossum | d594c91 | 1991-04-03 19:03:22 +0000 | [diff] [blame] | 75 | #define Getnamev(f, i) (GETITEM((f)->f_code->co_names, (i))) |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 76 | |
| 77 | |
| 78 | /* Block management functions */ |
| 79 | |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 80 | DL_IMPORT(void) PyFrame_BlockSetup(PyFrameObject *, int, int, int); |
| 81 | DL_IMPORT(PyTryBlock *) PyFrame_BlockPop(PyFrameObject *); |
Guido van Rossum | a9e7dc1 | 1992-10-18 18:53:57 +0000 | [diff] [blame] | 82 | |
| 83 | /* Extend the value stack */ |
| 84 | |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 85 | DL_IMPORT(PyObject **) PyFrame_ExtendStack(PyFrameObject *, int, int); |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 86 | |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 87 | /* Conversions between "fast locals" and locals in dictionary */ |
| 88 | |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 89 | DL_IMPORT(void) PyFrame_LocalsToFast(PyFrameObject *, int); |
| 90 | DL_IMPORT(void) PyFrame_FastToLocals(PyFrameObject *); |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 91 | |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 92 | #ifdef __cplusplus |
| 93 | } |
| 94 | #endif |
| 95 | #endif /* !Py_FRAMEOBJECT_H */ |