Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 1 | /* Definitions for bytecode */ |
| 2 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 3 | #ifndef Py_LIMITED_API |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 4 | #ifndef Py_CODE_H |
| 5 | #define Py_CODE_H |
| 6 | #ifdef __cplusplus |
| 7 | extern "C" { |
| 8 | #endif |
| 9 | |
| 10 | /* Bytecode object */ |
| 11 | typedef struct { |
| 12 | PyObject_HEAD |
| 13 | int co_argcount; /* #arguments, except *args */ |
Guido van Rossum | 4f72a78 | 2006-10-27 23:31:49 +0000 | [diff] [blame] | 14 | int co_kwonlyargcount; /* #keyword only arguments */ |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 15 | int co_nlocals; /* #local variables */ |
| 16 | int co_stacksize; /* #entries needed for evaluation stack */ |
| 17 | int co_flags; /* CO_..., see below */ |
| 18 | PyObject *co_code; /* instruction opcodes */ |
| 19 | PyObject *co_consts; /* list (constants used) */ |
| 20 | PyObject *co_names; /* list of strings (names used) */ |
| 21 | PyObject *co_varnames; /* tuple of strings (local variable names) */ |
| 22 | PyObject *co_freevars; /* tuple of strings (free variable names) */ |
| 23 | PyObject *co_cellvars; /* tuple of strings (cell variable names) */ |
Andrew Kuchling | 6283691 | 2014-04-14 14:19:52 -0400 | [diff] [blame] | 24 | /* The rest aren't used in either hash or comparisons, except for |
| 25 | co_name (used in both) and co_firstlineno (used only in |
| 26 | comparisons). This is done to preserve the name and line number |
| 27 | for tracebacks and debuggers; otherwise, constant de-duplication |
| 28 | would collapse identical functions/lambdas defined on different lines. |
| 29 | */ |
Benjamin Peterson | 9003760 | 2011-06-25 22:54:45 -0500 | [diff] [blame] | 30 | unsigned char *co_cell2arg; /* Maps cell vars which are arguments. */ |
Guido van Rossum | 00bc0e0 | 2007-10-15 02:52:41 +0000 | [diff] [blame] | 31 | PyObject *co_filename; /* unicode (where it was loaded from) */ |
| 32 | PyObject *co_name; /* unicode (name, for reference) */ |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 33 | int co_firstlineno; /* first source line number */ |
Alexandre Vassalotti | 7b82b40 | 2009-07-21 04:30:03 +0000 | [diff] [blame] | 34 | PyObject *co_lnotab; /* string (encoding addr<->lineno mapping) See |
| 35 | Objects/lnotab_notes.txt for details. */ |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 36 | void *co_zombieframe; /* for optimization only (see frameobject.c) */ |
Collin Winter | 4222e9c | 2010-03-18 22:46:40 +0000 | [diff] [blame] | 37 | PyObject *co_weakreflist; /* to support weakrefs to code objects */ |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 38 | } PyCodeObject; |
| 39 | |
| 40 | /* Masks for co_flags above */ |
| 41 | #define CO_OPTIMIZED 0x0001 |
| 42 | #define CO_NEWLOCALS 0x0002 |
| 43 | #define CO_VARARGS 0x0004 |
| 44 | #define CO_VARKEYWORDS 0x0008 |
| 45 | #define CO_NESTED 0x0010 |
| 46 | #define CO_GENERATOR 0x0020 |
| 47 | /* The CO_NOFREE flag is set if there are no free or cell variables. |
| 48 | This information is redundant, but it allows a single flag test |
| 49 | to determine whether there is any extra work to be done when the |
| 50 | call frame it setup. |
| 51 | */ |
| 52 | #define CO_NOFREE 0x0040 |
Neal Norwitz | 0090a4c | 2006-02-19 18:49:30 +0000 | [diff] [blame] | 53 | |
Guido van Rossum | 45aecf4 | 2006-03-15 04:58:47 +0000 | [diff] [blame] | 54 | /* These are no longer used. */ |
Benjamin Peterson | ffeaa88 | 2009-07-02 21:54:36 +0000 | [diff] [blame] | 55 | #if 0 |
Neal Norwitz | ab51f5f | 2006-02-25 15:43:10 +0000 | [diff] [blame] | 56 | #define CO_GENERATOR_ALLOWED 0x1000 |
Benjamin Peterson | ffeaa88 | 2009-07-02 21:54:36 +0000 | [diff] [blame] | 57 | #endif |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 58 | #define CO_FUTURE_DIVISION 0x2000 |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 59 | #define CO_FUTURE_ABSOLUTE_IMPORT 0x4000 /* do absolute imports by default */ |
Thomas Wouters | 34aa7ba | 2006-02-28 19:02:24 +0000 | [diff] [blame] | 60 | #define CO_FUTURE_WITH_STATEMENT 0x8000 |
Eric Smith | 8782408 | 2008-03-20 23:02:08 +0000 | [diff] [blame] | 61 | #define CO_FUTURE_PRINT_FUNCTION 0x10000 |
Christian Heimes | 4d6ec85 | 2008-03-26 22:34:47 +0000 | [diff] [blame] | 62 | #define CO_FUTURE_UNICODE_LITERALS 0x20000 |
Thomas Wouters | 34aa7ba | 2006-02-28 19:02:24 +0000 | [diff] [blame] | 63 | |
Brett Cannon | e3944a5 | 2009-04-01 05:08:41 +0000 | [diff] [blame] | 64 | #define CO_FUTURE_BARRY_AS_BDFL 0x40000 |
| 65 | |
Benjamin Peterson | 9003760 | 2011-06-25 22:54:45 -0500 | [diff] [blame] | 66 | /* This value is found in the co_cell2arg array when the associated cell |
| 67 | variable does not correspond to an argument. The maximum number of |
| 68 | arguments is 255 (indexed up to 254), so 255 work as a special flag.*/ |
| 69 | #define CO_CELL_NOT_AN_ARG 255 |
| 70 | |
Thomas Wouters | 34aa7ba | 2006-02-28 19:02:24 +0000 | [diff] [blame] | 71 | /* This should be defined if a future statement modifies the syntax. |
| 72 | For example, when a keyword is added. |
| 73 | */ |
Brett Cannon | e3944a5 | 2009-04-01 05:08:41 +0000 | [diff] [blame] | 74 | #define PY_PARSER_REQUIRES_FUTURE_KEYWORD |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 75 | |
| 76 | #define CO_MAXBLOCKS 20 /* Max static block nesting within a function */ |
| 77 | |
Neal Norwitz | 58a7985 | 2005-10-21 04:23:36 +0000 | [diff] [blame] | 78 | PyAPI_DATA(PyTypeObject) PyCode_Type; |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 79 | |
Christian Heimes | 90aa764 | 2007-12-19 02:45:37 +0000 | [diff] [blame] | 80 | #define PyCode_Check(op) (Py_TYPE(op) == &PyCode_Type) |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 81 | #define PyCode_GetNumFree(op) (PyTuple_GET_SIZE((op)->co_freevars)) |
| 82 | |
| 83 | /* Public interface */ |
Neal Norwitz | 58a7985 | 2005-10-21 04:23:36 +0000 | [diff] [blame] | 84 | PyAPI_FUNC(PyCodeObject *) PyCode_New( |
Guido van Rossum | 4f72a78 | 2006-10-27 23:31:49 +0000 | [diff] [blame] | 85 | int, int, int, int, int, PyObject *, PyObject *, |
| 86 | PyObject *, PyObject *, PyObject *, PyObject *, |
Victor Stinner | f3170cc | 2010-10-15 12:04:23 +0000 | [diff] [blame] | 87 | PyObject *, PyObject *, int, PyObject *); |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 88 | /* same as struct above */ |
Alexandre Vassalotti | 7b82b40 | 2009-07-21 04:30:03 +0000 | [diff] [blame] | 89 | |
| 90 | /* Creates a new empty code object with the specified source location. */ |
| 91 | PyAPI_FUNC(PyCodeObject *) |
| 92 | PyCode_NewEmpty(const char *filename, const char *funcname, int firstlineno); |
| 93 | |
| 94 | /* Return the line number associated with the specified bytecode index |
| 95 | in this code object. If you just need the line number of a frame, |
| 96 | use PyFrame_GetLineNumber() instead. */ |
Neal Norwitz | 58a7985 | 2005-10-21 04:23:36 +0000 | [diff] [blame] | 97 | PyAPI_FUNC(int) PyCode_Addr2Line(PyCodeObject *, int); |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 98 | |
| 99 | /* for internal use only */ |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 100 | typedef struct _addr_pair { |
| 101 | int ap_lower; |
| 102 | int ap_upper; |
| 103 | } PyAddrPair; |
| 104 | |
Alexandre Vassalotti | 7b82b40 | 2009-07-21 04:30:03 +0000 | [diff] [blame] | 105 | /* Update *bounds to describe the first and one-past-the-last instructions in the |
| 106 | same line as lasti. Return the number of that line. |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 107 | */ |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 108 | #ifndef Py_LIMITED_API |
Alexandre Vassalotti | 7b82b40 | 2009-07-21 04:30:03 +0000 | [diff] [blame] | 109 | PyAPI_FUNC(int) _PyCode_CheckLineNumber(PyCodeObject* co, |
| 110 | int lasti, PyAddrPair *bounds); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 111 | #endif |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 112 | |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 113 | PyAPI_FUNC(PyObject*) PyCode_Optimize(PyObject *code, PyObject* consts, |
| 114 | PyObject *names, PyObject *lineno_obj); |
| 115 | |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 116 | #ifdef __cplusplus |
| 117 | } |
| 118 | #endif |
| 119 | #endif /* !Py_CODE_H */ |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 120 | #endif /* Py_LIMITED_API */ |