Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 1 | /* Definitions for bytecode */ |
| 2 | |
| 3 | #ifndef Py_CODE_H |
| 4 | #define Py_CODE_H |
| 5 | #ifdef __cplusplus |
| 6 | extern "C" { |
| 7 | #endif |
| 8 | |
| 9 | /* Bytecode object */ |
| 10 | typedef struct { |
| 11 | PyObject_HEAD |
| 12 | int co_argcount; /* #arguments, except *args */ |
| 13 | int co_nlocals; /* #local variables */ |
| 14 | int co_stacksize; /* #entries needed for evaluation stack */ |
| 15 | int co_flags; /* CO_..., see below */ |
| 16 | PyObject *co_code; /* instruction opcodes */ |
| 17 | PyObject *co_consts; /* list (constants used) */ |
| 18 | PyObject *co_names; /* list of strings (names used) */ |
| 19 | PyObject *co_varnames; /* tuple of strings (local variable names) */ |
| 20 | PyObject *co_freevars; /* tuple of strings (free variable names) */ |
| 21 | PyObject *co_cellvars; /* tuple of strings (cell variable names) */ |
| 22 | /* The rest doesn't count for hash/cmp */ |
| 23 | PyObject *co_filename; /* string (where it was loaded from) */ |
| 24 | PyObject *co_name; /* string (name, for reference) */ |
| 25 | int co_firstlineno; /* first source line number */ |
| 26 | PyObject *co_lnotab; /* string (encoding addr<->lineno mapping) */ |
Richard Jones | 7c88dcc | 2006-05-23 10:37:38 +0000 | [diff] [blame] | 27 | void *co_zombieframe; /* for optimization only (see frameobject.c) */ |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 28 | } PyCodeObject; |
| 29 | |
| 30 | /* Masks for co_flags above */ |
| 31 | #define CO_OPTIMIZED 0x0001 |
| 32 | #define CO_NEWLOCALS 0x0002 |
| 33 | #define CO_VARARGS 0x0004 |
| 34 | #define CO_VARKEYWORDS 0x0008 |
| 35 | #define CO_NESTED 0x0010 |
| 36 | #define CO_GENERATOR 0x0020 |
| 37 | /* The CO_NOFREE flag is set if there are no free or cell variables. |
| 38 | This information is redundant, but it allows a single flag test |
| 39 | to determine whether there is any extra work to be done when the |
| 40 | call frame it setup. |
| 41 | */ |
| 42 | #define CO_NOFREE 0x0040 |
Neal Norwitz | 0090a4c | 2006-02-19 18:49:30 +0000 | [diff] [blame] | 43 | |
Neal Norwitz | ab51f5f | 2006-02-25 15:43:10 +0000 | [diff] [blame] | 44 | #if 0 |
| 45 | /* This is no longer used. Stopped defining in 2.5, do not re-use. */ |
| 46 | #define CO_GENERATOR_ALLOWED 0x1000 |
| 47 | #endif |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 48 | #define CO_FUTURE_DIVISION 0x2000 |
Neal Norwitz | cbce280 | 2006-04-03 06:26:32 +0000 | [diff] [blame] | 49 | #define CO_FUTURE_ABSOLUTE_IMPORT 0x4000 /* do absolute imports by default */ |
Thomas Wouters | 34aa7ba | 2006-02-28 19:02:24 +0000 | [diff] [blame] | 50 | #define CO_FUTURE_WITH_STATEMENT 0x8000 |
Eric Smith | 7c47894 | 2008-03-18 23:45:49 +0000 | [diff] [blame] | 51 | #define CO_FUTURE_PRINT_FUNCTION 0x10000 |
Christian Heimes | 3c60833 | 2008-03-26 22:01:37 +0000 | [diff] [blame] | 52 | #define CO_FUTURE_UNICODE_LITERALS 0x20000 |
Thomas Wouters | 34aa7ba | 2006-02-28 19:02:24 +0000 | [diff] [blame] | 53 | |
| 54 | /* This should be defined if a future statement modifies the syntax. |
| 55 | For example, when a keyword is added. |
| 56 | */ |
Eric Smith | 7c47894 | 2008-03-18 23:45:49 +0000 | [diff] [blame] | 57 | #if 1 |
Thomas Wouters | 34aa7ba | 2006-02-28 19:02:24 +0000 | [diff] [blame] | 58 | #define PY_PARSER_REQUIRES_FUTURE_KEYWORD |
Neal Norwitz | ca460d9 | 2006-09-06 06:28:06 +0000 | [diff] [blame] | 59 | #endif |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 60 | |
| 61 | #define CO_MAXBLOCKS 20 /* Max static block nesting within a function */ |
| 62 | |
Neal Norwitz | 58a7985 | 2005-10-21 04:23:36 +0000 | [diff] [blame] | 63 | PyAPI_DATA(PyTypeObject) PyCode_Type; |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 64 | |
Christian Heimes | e93237d | 2007-12-19 02:37:44 +0000 | [diff] [blame] | 65 | #define PyCode_Check(op) (Py_TYPE(op) == &PyCode_Type) |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 66 | #define PyCode_GetNumFree(op) (PyTuple_GET_SIZE((op)->co_freevars)) |
| 67 | |
| 68 | /* Public interface */ |
Neal Norwitz | 58a7985 | 2005-10-21 04:23:36 +0000 | [diff] [blame] | 69 | PyAPI_FUNC(PyCodeObject *) PyCode_New( |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 70 | int, int, int, int, PyObject *, PyObject *, PyObject *, PyObject *, |
| 71 | PyObject *, PyObject *, PyObject *, PyObject *, int, PyObject *); |
| 72 | /* same as struct above */ |
Neal Norwitz | 58a7985 | 2005-10-21 04:23:36 +0000 | [diff] [blame] | 73 | PyAPI_FUNC(int) PyCode_Addr2Line(PyCodeObject *, int); |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 74 | |
| 75 | /* for internal use only */ |
| 76 | #define _PyCode_GETCODEPTR(co, pp) \ |
Christian Heimes | e93237d | 2007-12-19 02:37:44 +0000 | [diff] [blame] | 77 | ((*Py_TYPE((co)->co_code)->tp_as_buffer->bf_getreadbuffer) \ |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 78 | ((co)->co_code, 0, (void **)(pp))) |
| 79 | |
Jeremy Hylton | a4ebc13 | 2006-04-18 14:47:00 +0000 | [diff] [blame] | 80 | typedef struct _addr_pair { |
| 81 | int ap_lower; |
| 82 | int ap_upper; |
| 83 | } PyAddrPair; |
| 84 | |
| 85 | /* Check whether lasti (an instruction offset) falls outside bounds |
| 86 | and whether it is a line number that should be traced. Returns |
| 87 | a line number if it should be traced or -1 if the line should not. |
| 88 | |
| 89 | If lasti is not within bounds, updates bounds. |
| 90 | */ |
| 91 | |
| 92 | PyAPI_FUNC(int) PyCode_CheckLineNumber(PyCodeObject* co, |
| 93 | int lasti, PyAddrPair *bounds); |
| 94 | |
Jeremy Hylton | 271d593 | 2006-08-21 16:20:29 +0000 | [diff] [blame] | 95 | PyAPI_FUNC(PyObject*) PyCode_Optimize(PyObject *code, PyObject* consts, |
| 96 | PyObject *names, PyObject *lineno_obj); |
| 97 | |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 98 | #ifdef __cplusplus |
| 99 | } |
| 100 | #endif |
| 101 | #endif /* !Py_CODE_H */ |