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 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 4 | #ifndef Py_LIMITED_API |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 5 | #ifndef Py_FRAMEOBJECT_H |
| 6 | #define Py_FRAMEOBJECT_H |
| 7 | #ifdef __cplusplus |
| 8 | extern "C" { |
| 9 | #endif |
| 10 | |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 11 | typedef struct { |
Nick Coghlan | 1f7ce62 | 2012-01-13 21:43:40 +1000 | [diff] [blame] | 12 | int b_type; /* what kind of block this is */ |
| 13 | int b_handler; /* where to jump to find handler */ |
| 14 | int b_level; /* value stack level to pop to */ |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 15 | } PyTryBlock; |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 16 | |
| 17 | typedef struct _frame { |
Neil Schemenauer | 251ead8 | 2001-08-29 23:45:25 +0000 | [diff] [blame] | 18 | PyObject_VAR_HEAD |
Nick Coghlan | 1f7ce62 | 2012-01-13 21:43:40 +1000 | [diff] [blame] | 19 | struct _frame *f_back; /* previous frame, or NULL */ |
| 20 | PyCodeObject *f_code; /* code segment */ |
| 21 | PyObject *f_builtins; /* builtin symbol table (PyDictObject) */ |
| 22 | PyObject *f_globals; /* global symbol table (PyDictObject) */ |
| 23 | PyObject *f_locals; /* local symbol table (any mapping) */ |
| 24 | PyObject **f_valuestack; /* points after the last local */ |
Tim Peters | 8c96369 | 2001-06-23 05:26:56 +0000 | [diff] [blame] | 25 | /* Next free slot in f_valuestack. Frame creation sets to f_valuestack. |
| 26 | Frame evaluation usually NULLs it, but a frame that yields sets it |
| 27 | to the current stack top. */ |
| 28 | PyObject **f_stacktop; |
Nick Coghlan | 1f7ce62 | 2012-01-13 21:43:40 +1000 | [diff] [blame] | 29 | PyObject *f_trace; /* Trace function */ |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 30 | |
Nick Coghlan | 1f7ce62 | 2012-01-13 21:43:40 +1000 | [diff] [blame] | 31 | /* In a generator, we need to be able to swap between the exception |
| 32 | state inside the generator and the exception state of the calling |
| 33 | frame (which shouldn't be impacted when the generator "yields" |
| 34 | from an except handler). |
| 35 | These three fields exist exactly for that, and are unused for |
Andrew Svetlov | c37cfd6 | 2012-12-05 17:59:10 +0200 | [diff] [blame] | 36 | non-generator frames. See the save_exc_state and swap_exc_state |
| 37 | functions in ceval.c for details of their use. */ |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 38 | PyObject *f_exc_type, *f_exc_value, *f_exc_traceback; |
Antoine Pitrou | 236a547 | 2013-08-06 23:06:59 +0200 | [diff] [blame] | 39 | /* Borrowed reference to a generator, or NULL */ |
Antoine Pitrou | 58720d6 | 2013-08-05 23:26:40 +0200 | [diff] [blame] | 40 | PyObject *f_gen; |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 41 | |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 42 | PyThreadState *f_tstate; |
Nick Coghlan | 1f7ce62 | 2012-01-13 21:43:40 +1000 | [diff] [blame] | 43 | int f_lasti; /* Last instruction if called */ |
Alexandre Vassalotti | 7b82b40 | 2009-07-21 04:30:03 +0000 | [diff] [blame] | 44 | /* Call PyFrame_GetLineNumber() instead of reading this field |
| 45 | directly. As of 2.3 f_lineno is only valid when tracing is |
| 46 | active (i.e. when f_trace is set). At other times we use |
| 47 | PyCode_Addr2Line to calculate the line from the current |
| 48 | bytecode index. */ |
Nick Coghlan | 1f7ce62 | 2012-01-13 21:43:40 +1000 | [diff] [blame] | 49 | int f_lineno; /* Current line number */ |
| 50 | int f_iblock; /* index in f_blockstack */ |
Antoine Pitrou | 58720d6 | 2013-08-05 23:26:40 +0200 | [diff] [blame] | 51 | char f_executing; /* whether the frame is still executing */ |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 52 | PyTryBlock f_blockstack[CO_MAXBLOCKS]; /* for try and loop blocks */ |
Nick Coghlan | 1f7ce62 | 2012-01-13 21:43:40 +1000 | [diff] [blame] | 53 | PyObject *f_localsplus[1]; /* locals+stack, dynamically sized */ |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 54 | } PyFrameObject; |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 55 | |
| 56 | |
| 57 | /* Standard object interface */ |
| 58 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 59 | PyAPI_DATA(PyTypeObject) PyFrame_Type; |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 60 | |
Christian Heimes | 90aa764 | 2007-12-19 02:45:37 +0000 | [diff] [blame] | 61 | #define PyFrame_Check(op) (Py_TYPE(op) == &PyFrame_Type) |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 62 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 63 | PyAPI_FUNC(PyFrameObject *) PyFrame_New(PyThreadState *, PyCodeObject *, |
Jeremy Hylton | 30c9f39 | 2001-03-13 01:58:22 +0000 | [diff] [blame] | 64 | PyObject *, PyObject *); |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 65 | |
| 66 | |
| 67 | /* The rest of the interface is specific for frame objects */ |
| 68 | |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 69 | /* Block management functions */ |
| 70 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 71 | PyAPI_FUNC(void) PyFrame_BlockSetup(PyFrameObject *, int, int, int); |
| 72 | PyAPI_FUNC(PyTryBlock *) PyFrame_BlockPop(PyFrameObject *); |
Guido van Rossum | a9e7dc1 | 1992-10-18 18:53:57 +0000 | [diff] [blame] | 73 | |
| 74 | /* Extend the value stack */ |
| 75 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 76 | PyAPI_FUNC(PyObject **) PyFrame_ExtendStack(PyFrameObject *, int, int); |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 77 | |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 78 | /* Conversions between "fast locals" and locals in dictionary */ |
| 79 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 80 | PyAPI_FUNC(void) PyFrame_LocalsToFast(PyFrameObject *, int); |
| 81 | PyAPI_FUNC(void) PyFrame_FastToLocals(PyFrameObject *); |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 82 | |
Christian Heimes | a156e09 | 2008-02-16 07:38:31 +0000 | [diff] [blame] | 83 | PyAPI_FUNC(int) PyFrame_ClearFreeList(void); |
| 84 | |
David Malcolm | 49526f4 | 2012-06-22 14:55:41 -0400 | [diff] [blame] | 85 | PyAPI_FUNC(void) _PyFrame_DebugMallocStats(FILE *out); |
| 86 | |
Alexandre Vassalotti | 7b82b40 | 2009-07-21 04:30:03 +0000 | [diff] [blame] | 87 | /* Return the line of code the frame is currently executing. */ |
| 88 | PyAPI_FUNC(int) PyFrame_GetLineNumber(PyFrameObject *); |
| 89 | |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 90 | #ifdef __cplusplus |
| 91 | } |
| 92 | #endif |
| 93 | #endif /* !Py_FRAMEOBJECT_H */ |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 94 | #endif /* Py_LIMITED_API */ |