blob: e773b6a47ce83793c44de1017273787a000baac2 [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 */
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) */
Mark Dickinsonc008a172009-02-01 13:59:22 +000024 /* The rest doesn't count for hash or comparisons */
Guido van Rossum00bc0e02007-10-15 02:52:41 +000025 PyObject *co_filename; /* unicode (where it was loaded from) */
26 PyObject *co_name; /* unicode (name, for reference) */
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000027 int co_firstlineno; /* first source line number */
Alexandre Vassalotti7b82b402009-07-21 04:30:03 +000028 PyObject *co_lnotab; /* string (encoding addr<->lineno mapping) See
29 Objects/lnotab_notes.txt for details. */
Thomas Wouters477c8d52006-05-27 19:21:47 +000030 void *co_zombieframe; /* for optimization only (see frameobject.c) */
Collin Winter4222e9c2010-03-18 22:46:40 +000031 PyObject *co_weakreflist; /* to support weakrefs to code objects */
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000032} PyCodeObject;
33
34/* Masks for co_flags above */
35#define CO_OPTIMIZED 0x0001
36#define CO_NEWLOCALS 0x0002
37#define CO_VARARGS 0x0004
38#define CO_VARKEYWORDS 0x0008
39#define CO_NESTED 0x0010
40#define CO_GENERATOR 0x0020
41/* The CO_NOFREE flag is set if there are no free or cell variables.
42 This information is redundant, but it allows a single flag test
43 to determine whether there is any extra work to be done when the
44 call frame it setup.
45*/
46#define CO_NOFREE 0x0040
Neal Norwitz0090a4c2006-02-19 18:49:30 +000047
Guido van Rossum45aecf42006-03-15 04:58:47 +000048/* These are no longer used. */
Benjamin Petersonffeaa882009-07-02 21:54:36 +000049#if 0
Neal Norwitzab51f5f2006-02-25 15:43:10 +000050#define CO_GENERATOR_ALLOWED 0x1000
Benjamin Petersonffeaa882009-07-02 21:54:36 +000051#endif
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000052#define CO_FUTURE_DIVISION 0x2000
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000053#define CO_FUTURE_ABSOLUTE_IMPORT 0x4000 /* do absolute imports by default */
Thomas Wouters34aa7ba2006-02-28 19:02:24 +000054#define CO_FUTURE_WITH_STATEMENT 0x8000
Eric Smith87824082008-03-20 23:02:08 +000055#define CO_FUTURE_PRINT_FUNCTION 0x10000
Christian Heimes4d6ec852008-03-26 22:34:47 +000056#define CO_FUTURE_UNICODE_LITERALS 0x20000
Thomas Wouters34aa7ba2006-02-28 19:02:24 +000057
Brett Cannone3944a52009-04-01 05:08:41 +000058#define CO_FUTURE_BARRY_AS_BDFL 0x40000
59
Thomas Wouters34aa7ba2006-02-28 19:02:24 +000060/* This should be defined if a future statement modifies the syntax.
61 For example, when a keyword is added.
62*/
Brett Cannone3944a52009-04-01 05:08:41 +000063#define PY_PARSER_REQUIRES_FUTURE_KEYWORD
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000064
65#define CO_MAXBLOCKS 20 /* Max static block nesting within a function */
66
Neal Norwitz58a79852005-10-21 04:23:36 +000067PyAPI_DATA(PyTypeObject) PyCode_Type;
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000068
Christian Heimes90aa7642007-12-19 02:45:37 +000069#define PyCode_Check(op) (Py_TYPE(op) == &PyCode_Type)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000070#define PyCode_GetNumFree(op) (PyTuple_GET_SIZE((op)->co_freevars))
71
72/* Public interface */
Neal Norwitz58a79852005-10-21 04:23:36 +000073PyAPI_FUNC(PyCodeObject *) PyCode_New(
Guido van Rossum4f72a782006-10-27 23:31:49 +000074 int, int, int, int, int, PyObject *, PyObject *,
75 PyObject *, PyObject *, PyObject *, PyObject *,
Victor Stinnerf3170cc2010-10-15 12:04:23 +000076 PyObject *, PyObject *, int, PyObject *);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000077 /* same as struct above */
Alexandre Vassalotti7b82b402009-07-21 04:30:03 +000078
79/* Creates a new empty code object with the specified source location. */
80PyAPI_FUNC(PyCodeObject *)
81PyCode_NewEmpty(const char *filename, const char *funcname, int firstlineno);
82
83/* Return the line number associated with the specified bytecode index
84 in this code object. If you just need the line number of a frame,
85 use PyFrame_GetLineNumber() instead. */
Neal Norwitz58a79852005-10-21 04:23:36 +000086PyAPI_FUNC(int) PyCode_Addr2Line(PyCodeObject *, int);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000087
88/* for internal use only */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000089typedef struct _addr_pair {
90 int ap_lower;
91 int ap_upper;
92} PyAddrPair;
93
Alexandre Vassalotti7b82b402009-07-21 04:30:03 +000094/* Update *bounds to describe the first and one-past-the-last instructions in the
95 same line as lasti. Return the number of that line.
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000096*/
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000097#ifndef Py_LIMITED_API
Alexandre Vassalotti7b82b402009-07-21 04:30:03 +000098PyAPI_FUNC(int) _PyCode_CheckLineNumber(PyCodeObject* co,
99 int lasti, PyAddrPair *bounds);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000100#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000101
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000102PyAPI_FUNC(PyObject*) PyCode_Optimize(PyObject *code, PyObject* consts,
103 PyObject *names, PyObject *lineno_obj);
104
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000105#ifdef __cplusplus
106}
107#endif
108#endif /* !Py_CODE_H */
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000109#endif /* Py_LIMITED_API */