Mercurial > repos > rliterman > csp2

annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/python3.8/code.h @ 69:33d812a61356

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 17:55:14 -0400
parents
children
rev   line source
jpayne@69 1 /* Definitions for bytecode */
jpayne@69 2
jpayne@69 3 #ifndef Py_LIMITED_API
jpayne@69 4 #ifndef Py_CODE_H
jpayne@69 5 #define Py_CODE_H
jpayne@69 6 #ifdef __cplusplus
jpayne@69 7 extern "C" {
jpayne@69 8 #endif
jpayne@69 9
jpayne@69 10 typedef uint16_t _Py_CODEUNIT;
jpayne@69 11
jpayne@69 12 #ifdef WORDS_BIGENDIAN
jpayne@69 13 # define _Py_OPCODE(word) ((word) >> 8)
jpayne@69 14 # define _Py_OPARG(word) ((word) & 255)
jpayne@69 15 #else
jpayne@69 16 # define _Py_OPCODE(word) ((word) & 255)
jpayne@69 17 # define _Py_OPARG(word) ((word) >> 8)
jpayne@69 18 #endif
jpayne@69 19
jpayne@69 20 typedef struct _PyOpcache _PyOpcache;
jpayne@69 21
jpayne@69 22 /* Bytecode object */
jpayne@69 23 typedef struct {
jpayne@69 24 PyObject_HEAD
jpayne@69 25 int co_argcount; /* #arguments, except *args */
jpayne@69 26 int co_posonlyargcount; /* #positional only arguments */
jpayne@69 27 int co_kwonlyargcount; /* #keyword only arguments */
jpayne@69 28 int co_nlocals; /* #local variables */
jpayne@69 29 int co_stacksize; /* #entries needed for evaluation stack */
jpayne@69 30 int co_flags; /* CO_..., see below */
jpayne@69 31 int co_firstlineno; /* first source line number */
jpayne@69 32 PyObject *co_code; /* instruction opcodes */
jpayne@69 33 PyObject *co_consts; /* list (constants used) */
jpayne@69 34 PyObject *co_names; /* list of strings (names used) */
jpayne@69 35 PyObject *co_varnames; /* tuple of strings (local variable names) */
jpayne@69 36 PyObject *co_freevars; /* tuple of strings (free variable names) */
jpayne@69 37 PyObject *co_cellvars; /* tuple of strings (cell variable names) */
jpayne@69 38 /* The rest aren't used in either hash or comparisons, except for co_name,
jpayne@69 39 used in both. This is done to preserve the name and line number
jpayne@69 40 for tracebacks and debuggers; otherwise, constant de-duplication
jpayne@69 41 would collapse identical functions/lambdas defined on different lines.
jpayne@69 42 */
jpayne@69 43 Py_ssize_t *co_cell2arg; /* Maps cell vars which are arguments. */
jpayne@69 44 PyObject *co_filename; /* unicode (where it was loaded from) */
jpayne@69 45 PyObject *co_name; /* unicode (name, for reference) */
jpayne@69 46 PyObject *co_lnotab; /* string (encoding addr<->lineno mapping) See
jpayne@69 47 Objects/lnotab_notes.txt for details. */
jpayne@69 48 void *co_zombieframe; /* for optimization only (see frameobject.c) */
jpayne@69 49 PyObject *co_weakreflist; /* to support weakrefs to code objects */
jpayne@69 50 /* Scratch space for extra data relating to the code object.
jpayne@69 51 Type is a void* to keep the format private in codeobject.c to force
jpayne@69 52 people to go through the proper APIs. */
jpayne@69 53 void *co_extra;
jpayne@69 54
jpayne@69 55 /* Per opcodes just-in-time cache
jpayne@69 56 *
jpayne@69 57 * To reduce cache size, we use indirect mapping from opcode index to
jpayne@69 58 * cache object:
jpayne@69 59 * cache = co_opcache[co_opcache_map[next_instr - first_instr] - 1]
jpayne@69 60 */
jpayne@69 61
jpayne@69 62 // co_opcache_map is indexed by (next_instr - first_instr).
jpayne@69 63 // * 0 means there is no cache for this opcode.
jpayne@69 64 // * n > 0 means there is cache in co_opcache[n-1].
jpayne@69 65 unsigned char *co_opcache_map;
jpayne@69 66 _PyOpcache *co_opcache;
jpayne@69 67 int co_opcache_flag; // used to determine when create a cache.
jpayne@69 68 unsigned char co_opcache_size; // length of co_opcache.
jpayne@69 69 } PyCodeObject;
jpayne@69 70
jpayne@69 71 /* Masks for co_flags above */
jpayne@69 72 #define CO_OPTIMIZED 0x0001
jpayne@69 73 #define CO_NEWLOCALS 0x0002
jpayne@69 74 #define CO_VARARGS 0x0004
jpayne@69 75 #define CO_VARKEYWORDS 0x0008
jpayne@69 76 #define CO_NESTED 0x0010
jpayne@69 77 #define CO_GENERATOR 0x0020
jpayne@69 78 /* The CO_NOFREE flag is set if there are no free or cell variables.
jpayne@69 79 This information is redundant, but it allows a single flag test
jpayne@69 80 to determine whether there is any extra work to be done when the
jpayne@69 81 call frame it setup.
jpayne@69 82 */
jpayne@69 83 #define CO_NOFREE 0x0040
jpayne@69 84
jpayne@69 85 /* The CO_COROUTINE flag is set for coroutine functions (defined with
jpayne@69 86 ``async def`` keywords) */
jpayne@69 87 #define CO_COROUTINE 0x0080
jpayne@69 88 #define CO_ITERABLE_COROUTINE 0x0100
jpayne@69 89 #define CO_ASYNC_GENERATOR 0x0200
jpayne@69 90
jpayne@69 91 /* These are no longer used. */
jpayne@69 92 #if 0
jpayne@69 93 #define CO_GENERATOR_ALLOWED 0x1000
jpayne@69 94 #endif
jpayne@69 95 #define CO_FUTURE_DIVISION 0x2000
jpayne@69 96 #define CO_FUTURE_ABSOLUTE_IMPORT 0x4000 /* do absolute imports by default */
jpayne@69 97 #define CO_FUTURE_WITH_STATEMENT 0x8000
jpayne@69 98 #define CO_FUTURE_PRINT_FUNCTION 0x10000
jpayne@69 99 #define CO_FUTURE_UNICODE_LITERALS 0x20000
jpayne@69 100
jpayne@69 101 #define CO_FUTURE_BARRY_AS_BDFL 0x40000
jpayne@69 102 #define CO_FUTURE_GENERATOR_STOP 0x80000
jpayne@69 103 #define CO_FUTURE_ANNOTATIONS 0x100000
jpayne@69 104
jpayne@69 105 /* This value is found in the co_cell2arg array when the associated cell
jpayne@69 106 variable does not correspond to an argument. */
jpayne@69 107 #define CO_CELL_NOT_AN_ARG (-1)
jpayne@69 108
jpayne@69 109 /* This should be defined if a future statement modifies the syntax.
jpayne@69 110 For example, when a keyword is added.
jpayne@69 111 */
jpayne@69 112 #define PY_PARSER_REQUIRES_FUTURE_KEYWORD
jpayne@69 113
jpayne@69 114 #define CO_MAXBLOCKS 20 /* Max static block nesting within a function */
jpayne@69 115
jpayne@69 116 PyAPI_DATA(PyTypeObject) PyCode_Type;
jpayne@69 117
jpayne@69 118 #define PyCode_Check(op) (Py_TYPE(op) == &PyCode_Type)
jpayne@69 119 #define PyCode_GetNumFree(op) (PyTuple_GET_SIZE((op)->co_freevars))
jpayne@69 120
jpayne@69 121 /* Public interface */
jpayne@69 122 PyAPI_FUNC(PyCodeObject *) PyCode_New(
jpayne@69 123 int, int, int, int, int, PyObject *, PyObject *,
jpayne@69 124 PyObject *, PyObject *, PyObject *, PyObject *,
jpayne@69 125 PyObject *, PyObject *, int, PyObject *);
jpayne@69 126
jpayne@69 127 PyAPI_FUNC(PyCodeObject *) PyCode_NewWithPosOnlyArgs(
jpayne@69 128 int, int, int, int, int, int, PyObject *, PyObject *,
jpayne@69 129 PyObject *, PyObject *, PyObject *, PyObject *,
jpayne@69 130 PyObject *, PyObject *, int, PyObject *);
jpayne@69 131 /* same as struct above */
jpayne@69 132
jpayne@69 133 /* Creates a new empty code object with the specified source location. */
jpayne@69 134 PyAPI_FUNC(PyCodeObject *)
jpayne@69 135 PyCode_NewEmpty(const char *filename, const char *funcname, int firstlineno);
jpayne@69 136
jpayne@69 137 /* Return the line number associated with the specified bytecode index
jpayne@69 138 in this code object. If you just need the line number of a frame,
jpayne@69 139 use PyFrame_GetLineNumber() instead. */
jpayne@69 140 PyAPI_FUNC(int) PyCode_Addr2Line(PyCodeObject *, int);
jpayne@69 141
jpayne@69 142 /* for internal use only */
jpayne@69 143 typedef struct _addr_pair {
jpayne@69 144 int ap_lower;
jpayne@69 145 int ap_upper;
jpayne@69 146 } PyAddrPair;
jpayne@69 147
jpayne@69 148 #ifndef Py_LIMITED_API
jpayne@69 149 /* Update *bounds to describe the first and one-past-the-last instructions in the
jpayne@69 150 same line as lasti. Return the number of that line.
jpayne@69 151 */
jpayne@69 152 PyAPI_FUNC(int) _PyCode_CheckLineNumber(PyCodeObject* co,
jpayne@69 153 int lasti, PyAddrPair *bounds);
jpayne@69 154
jpayne@69 155 /* Create a comparable key used to compare constants taking in account the
jpayne@69 156 * object type. It is used to make sure types are not coerced (e.g., float and
jpayne@69 157 * complex) _and_ to distinguish 0.0 from -0.0 e.g. on IEEE platforms
jpayne@69 158 *
jpayne@69 159 * Return (type(obj), obj, ...): a tuple with variable size (at least 2 items)
jpayne@69 160 * depending on the type and the value. The type is the first item to not
jpayne@69 161 * compare bytes and str which can raise a BytesWarning exception. */
jpayne@69 162 PyAPI_FUNC(PyObject*) _PyCode_ConstantKey(PyObject *obj);
jpayne@69 163 #endif
jpayne@69 164
jpayne@69 165 PyAPI_FUNC(PyObject*) PyCode_Optimize(PyObject *code, PyObject* consts,
jpayne@69 166 PyObject *names, PyObject *lnotab);
jpayne@69 167
jpayne@69 168
jpayne@69 169 #ifndef Py_LIMITED_API
jpayne@69 170 PyAPI_FUNC(int) _PyCode_GetExtra(PyObject *code, Py_ssize_t index,
jpayne@69 171 void **extra);
jpayne@69 172 PyAPI_FUNC(int) _PyCode_SetExtra(PyObject *code, Py_ssize_t index,
jpayne@69 173 void *extra);
jpayne@69 174 #endif
jpayne@69 175
jpayne@69 176 #ifdef __cplusplus
jpayne@69 177 }
jpayne@69 178 #endif
jpayne@69 179 #endif /* !Py_CODE_H */
jpayne@69 180 #endif /* Py_LIMITED_API */