blob: b39d6bd511df20dc2cee40f77437b83671730cb7 [file] [log] [blame]
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001/* Definitions for bytecode */
2
Martin v. Löwis4d0d4712010-12-03 20:14:31 +00003#ifndef Py_LIMITED_API
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00004#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 */
Guido van Rossum4f72a782006-10-27 23:31:49 +000014 int co_kwonlyargcount; /* #keyword only arguments */
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000015 int co_nlocals; /* #local variables */
16 int co_stacksize; /* #entries needed for evaluation stack */
17 int co_flags; /* CO_..., see below */
Brett Cannon5c4de282016-09-07 11:16:41 -070018 int co_firstlineno; /* first source line number */
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000019 PyObject *co_code; /* instruction opcodes */
20 PyObject *co_consts; /* list (constants used) */
21 PyObject *co_names; /* list of strings (names used) */
22 PyObject *co_varnames; /* tuple of strings (local variable names) */
23 PyObject *co_freevars; /* tuple of strings (free variable names) */
24 PyObject *co_cellvars; /* tuple of strings (cell variable names) */
Andrew Kuchling62836912014-04-14 14:19:52 -040025 /* The rest aren't used in either hash or comparisons, except for
26 co_name (used in both) and co_firstlineno (used only in
27 comparisons). This is done to preserve the name and line number
28 for tracebacks and debuggers; otherwise, constant de-duplication
29 would collapse identical functions/lambdas defined on different lines.
30 */
Benjamin Peterson90037602011-06-25 22:54:45 -050031 unsigned char *co_cell2arg; /* Maps cell vars which are arguments. */
Guido van Rossum00bc0e02007-10-15 02:52:41 +000032 PyObject *co_filename; /* unicode (where it was loaded from) */
33 PyObject *co_name; /* unicode (name, for reference) */
Alexandre Vassalotti7b82b402009-07-21 04:30:03 +000034 PyObject *co_lnotab; /* string (encoding addr<->lineno mapping) See
35 Objects/lnotab_notes.txt for details. */
Thomas Wouters477c8d52006-05-27 19:21:47 +000036 void *co_zombieframe; /* for optimization only (see frameobject.c) */
Collin Winter4222e9c2010-03-18 22:46:40 +000037 PyObject *co_weakreflist; /* to support weakrefs to code objects */
Brett Cannond0600ed2016-09-07 14:30:39 -070038 /* Scratch space for extra data relating to the code object.__icc_nan
39 Type is a void* to keep the format private in codeobject.c to force
40 people to go through the proper APIs. */
41 void *co_extra;
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000042} PyCodeObject;
43
44/* Masks for co_flags above */
45#define CO_OPTIMIZED 0x0001
46#define CO_NEWLOCALS 0x0002
47#define CO_VARARGS 0x0004
48#define CO_VARKEYWORDS 0x0008
49#define CO_NESTED 0x0010
50#define CO_GENERATOR 0x0020
51/* The CO_NOFREE flag is set if there are no free or cell variables.
52 This information is redundant, but it allows a single flag test
53 to determine whether there is any extra work to be done when the
54 call frame it setup.
55*/
56#define CO_NOFREE 0x0040
Neal Norwitz0090a4c2006-02-19 18:49:30 +000057
Yury Selivanov75445082015-05-11 22:57:16 -040058/* The CO_COROUTINE flag is set for coroutine functions (defined with
59 ``async def`` keywords) */
60#define CO_COROUTINE 0x0080
61#define CO_ITERABLE_COROUTINE 0x0100
62
Guido van Rossum45aecf42006-03-15 04:58:47 +000063/* These are no longer used. */
Benjamin Petersonffeaa882009-07-02 21:54:36 +000064#if 0
Neal Norwitzab51f5f2006-02-25 15:43:10 +000065#define CO_GENERATOR_ALLOWED 0x1000
Benjamin Petersonffeaa882009-07-02 21:54:36 +000066#endif
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000067#define CO_FUTURE_DIVISION 0x2000
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000068#define CO_FUTURE_ABSOLUTE_IMPORT 0x4000 /* do absolute imports by default */
Thomas Wouters34aa7ba2006-02-28 19:02:24 +000069#define CO_FUTURE_WITH_STATEMENT 0x8000
Eric Smith87824082008-03-20 23:02:08 +000070#define CO_FUTURE_PRINT_FUNCTION 0x10000
Christian Heimes4d6ec852008-03-26 22:34:47 +000071#define CO_FUTURE_UNICODE_LITERALS 0x20000
Thomas Wouters34aa7ba2006-02-28 19:02:24 +000072
Brett Cannone3944a52009-04-01 05:08:41 +000073#define CO_FUTURE_BARRY_AS_BDFL 0x40000
Yury Selivanov8170e8c2015-05-09 11:44:30 -040074#define CO_FUTURE_GENERATOR_STOP 0x80000
Brett Cannone3944a52009-04-01 05:08:41 +000075
Benjamin Peterson90037602011-06-25 22:54:45 -050076/* This value is found in the co_cell2arg array when the associated cell
77 variable does not correspond to an argument. The maximum number of
78 arguments is 255 (indexed up to 254), so 255 work as a special flag.*/
79#define CO_CELL_NOT_AN_ARG 255
80
Thomas Wouters34aa7ba2006-02-28 19:02:24 +000081/* This should be defined if a future statement modifies the syntax.
82 For example, when a keyword is added.
83*/
Brett Cannone3944a52009-04-01 05:08:41 +000084#define PY_PARSER_REQUIRES_FUTURE_KEYWORD
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000085
86#define CO_MAXBLOCKS 20 /* Max static block nesting within a function */
87
Neal Norwitz58a79852005-10-21 04:23:36 +000088PyAPI_DATA(PyTypeObject) PyCode_Type;
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000089
Christian Heimes90aa7642007-12-19 02:45:37 +000090#define PyCode_Check(op) (Py_TYPE(op) == &PyCode_Type)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000091#define PyCode_GetNumFree(op) (PyTuple_GET_SIZE((op)->co_freevars))
92
93/* Public interface */
Neal Norwitz58a79852005-10-21 04:23:36 +000094PyAPI_FUNC(PyCodeObject *) PyCode_New(
Guido van Rossum4f72a782006-10-27 23:31:49 +000095 int, int, int, int, int, PyObject *, PyObject *,
96 PyObject *, PyObject *, PyObject *, PyObject *,
Victor Stinnerf3170cc2010-10-15 12:04:23 +000097 PyObject *, PyObject *, int, PyObject *);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000098 /* same as struct above */
Alexandre Vassalotti7b82b402009-07-21 04:30:03 +000099
100/* Creates a new empty code object with the specified source location. */
101PyAPI_FUNC(PyCodeObject *)
102PyCode_NewEmpty(const char *filename, const char *funcname, int firstlineno);
103
104/* Return the line number associated with the specified bytecode index
105 in this code object. If you just need the line number of a frame,
106 use PyFrame_GetLineNumber() instead. */
Neal Norwitz58a79852005-10-21 04:23:36 +0000107PyAPI_FUNC(int) PyCode_Addr2Line(PyCodeObject *, int);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000108
109/* for internal use only */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000110typedef struct _addr_pair {
111 int ap_lower;
112 int ap_upper;
113} PyAddrPair;
114
Victor Stinnerefb24132016-01-22 12:33:12 +0100115#ifndef Py_LIMITED_API
Alexandre Vassalotti7b82b402009-07-21 04:30:03 +0000116/* Update *bounds to describe the first and one-past-the-last instructions in the
117 same line as lasti. Return the number of that line.
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000118*/
Alexandre Vassalotti7b82b402009-07-21 04:30:03 +0000119PyAPI_FUNC(int) _PyCode_CheckLineNumber(PyCodeObject* co,
120 int lasti, PyAddrPair *bounds);
Victor Stinnerefb24132016-01-22 12:33:12 +0100121
122/* Create a comparable key used to compare constants taking in account the
123 * object type. It is used to make sure types are not coerced (e.g., float and
124 * complex) _and_ to distinguish 0.0 from -0.0 e.g. on IEEE platforms
125 *
126 * Return (type(obj), obj, ...): a tuple with variable size (at least 2 items)
127 * depending on the type and the value. The type is the first item to not
128 * compare bytes and str which can raise a BytesWarning exception. */
129PyAPI_FUNC(PyObject*) _PyCode_ConstantKey(PyObject *obj);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000130#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000131
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000132PyAPI_FUNC(PyObject*) PyCode_Optimize(PyObject *code, PyObject* consts,
Victor Stinnerf3914eb2016-01-20 12:16:21 +0100133 PyObject *names, PyObject *lnotab);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000134
Brett Cannon5c4de282016-09-07 11:16:41 -0700135
136#ifndef Py_LIMITED_API
137PyAPI_FUNC(int) _PyCode_GetExtra(PyObject *code, Py_ssize_t index,
138 void **extra);
139PyAPI_FUNC(int) _PyCode_SetExtra(PyObject *code, Py_ssize_t index,
140 void *extra);
141#endif
142
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000143#ifdef __cplusplus
144}
145#endif
146#endif /* !Py_CODE_H */
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000147#endif /* Py_LIMITED_API */