1/* Definitions for bytecode */
2
3#ifndef Py_LIMITED_API
4#ifndef Py_CODE_H
5#define Py_CODE_H
6#ifdef __cplusplus
7extern "C" {
8#endif
9
10/* Bytecode object */
11typedef struct {
12 PyObject_HEAD
13 int co_argcount; /* #arguments, except *args */
14 int co_kwonlyargcount; /* #keyword only arguments */
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) */
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 */
30 unsigned char *co_cell2arg; /* Maps cell vars which are arguments. */
31 PyObject *co_filename; /* unicode (where it was loaded from) */
32 PyObject *co_name; /* unicode (name, for reference) */
33 int co_firstlineno; /* first source line number */
34 PyObject *co_lnotab; /* string (encoding addr<->lineno mapping) See
35 Objects/lnotab_notes.txt for details. */
36 void *co_zombieframe; /* for optimization only (see frameobject.c) */
37 PyObject *co_weakreflist; /* to support weakrefs to code objects */
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
53
54/* The CO_COROUTINE flag is set for coroutine functions (defined with
55 ``async def`` keywords) */
56#define CO_COROUTINE 0x0080
57#define CO_ITERABLE_COROUTINE 0x0100
58
59/* These are no longer used. */
60#if 0
61#define CO_GENERATOR_ALLOWED 0x1000
62#endif
63#define CO_FUTURE_DIVISION 0x2000
64#define CO_FUTURE_ABSOLUTE_IMPORT 0x4000 /* do absolute imports by default */
65#define CO_FUTURE_WITH_STATEMENT 0x8000
66#define CO_FUTURE_PRINT_FUNCTION 0x10000
67#define CO_FUTURE_UNICODE_LITERALS 0x20000
68
69#define CO_FUTURE_BARRY_AS_BDFL 0x40000
70#define CO_FUTURE_GENERATOR_STOP 0x80000
71
72/* This value is found in the co_cell2arg array when the associated cell
73 variable does not correspond to an argument. The maximum number of
74 arguments is 255 (indexed up to 254), so 255 work as a special flag.*/
75#define CO_CELL_NOT_AN_ARG 255
76
77/* This should be defined if a future statement modifies the syntax.
78 For example, when a keyword is added.
79*/
80#define PY_PARSER_REQUIRES_FUTURE_KEYWORD
81
82#define CO_MAXBLOCKS 20 /* Max static block nesting within a function */
83
84PyAPI_DATA(PyTypeObject) PyCode_Type;
85
86#define PyCode_Check(op) (Py_TYPE(op) == &PyCode_Type)
87#define PyCode_GetNumFree(op) (PyTuple_GET_SIZE((op)->co_freevars))
88
89/* Public interface */
90PyAPI_FUNC(PyCodeObject *) PyCode_New(
91 int, int, int, int, int, PyObject *, PyObject *,
92 PyObject *, PyObject *, PyObject *, PyObject *,
93 PyObject *, PyObject *, int, PyObject *);
94 /* same as struct above */
95
96/* Creates a new empty code object with the specified source location. */
97PyAPI_FUNC(PyCodeObject *)
98PyCode_NewEmpty(const char *filename, const char *funcname, int firstlineno);
99
100/* Return the line number associated with the specified bytecode index
101 in this code object. If you just need the line number of a frame,
102 use PyFrame_GetLineNumber() instead. */
103PyAPI_FUNC(int) PyCode_Addr2Line(PyCodeObject *, int);
104
105/* for internal use only */
106typedef struct _addr_pair {
107 int ap_lower;
108 int ap_upper;
109} PyAddrPair;
110
111#ifndef Py_LIMITED_API
112/* Update *bounds to describe the first and one-past-the-last instructions in the
113 same line as lasti. Return the number of that line.
114*/
115PyAPI_FUNC(int) _PyCode_CheckLineNumber(PyCodeObject* co,
116 int lasti, PyAddrPair *bounds);
117
118/* Create a comparable key used to compare constants taking in account the
119 * object type. It is used to make sure types are not coerced (e.g., float and
120 * complex) _and_ to distinguish 0.0 from -0.0 e.g. on IEEE platforms
121 *
122 * Return (type(obj), obj, ...): a tuple with variable size (at least 2 items)
123 * depending on the type and the value. The type is the first item to not
124 * compare bytes and str which can raise a BytesWarning exception. */
125PyAPI_FUNC(PyObject*) _PyCode_ConstantKey(PyObject *obj);
126#endif
127
128PyAPI_FUNC(PyObject*) PyCode_Optimize(PyObject *code, PyObject* consts,
129 PyObject *names, PyObject *lineno_obj);
130
131#ifdef __cplusplus
132}
133#endif
134#endif /* !Py_CODE_H */
135#endif /* Py_LIMITED_API */
136