blob: e2eb59d2447507cf973f04b2b5c9741d2569a757 [file] [log] [blame]
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001/* Definitions for bytecode */
2
3#ifndef Py_CODE_H
4#define Py_CODE_H
5#ifdef __cplusplus
6extern "C" {
7#endif
8
9/* Bytecode object */
10typedef struct {
11 PyObject_HEAD
12 int co_argcount; /* #arguments, except *args */
Guido van Rossum4f72a782006-10-27 23:31:49 +000013 int co_kwonlyargcount; /* #keyword only arguments */
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000014 int co_nlocals; /* #local variables */
15 int co_stacksize; /* #entries needed for evaluation stack */
16 int co_flags; /* CO_..., see below */
17 PyObject *co_code; /* instruction opcodes */
18 PyObject *co_consts; /* list (constants used) */
19 PyObject *co_names; /* list of strings (names used) */
20 PyObject *co_varnames; /* tuple of strings (local variable names) */
21 PyObject *co_freevars; /* tuple of strings (free variable names) */
22 PyObject *co_cellvars; /* tuple of strings (cell variable names) */
23 /* The rest doesn't count for hash/cmp */
24 PyObject *co_filename; /* string (where it was loaded from) */
25 PyObject *co_name; /* string (name, for reference) */
26 int co_firstlineno; /* first source line number */
27 PyObject *co_lnotab; /* string (encoding addr<->lineno mapping) */
Thomas Wouters477c8d52006-05-27 19:21:47 +000028 void *co_zombieframe; /* for optimization only (see frameobject.c) */
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000029} PyCodeObject;
30
31/* Masks for co_flags above */
32#define CO_OPTIMIZED 0x0001
33#define CO_NEWLOCALS 0x0002
34#define CO_VARARGS 0x0004
35#define CO_VARKEYWORDS 0x0008
36#define CO_NESTED 0x0010
37#define CO_GENERATOR 0x0020
38/* The CO_NOFREE flag is set if there are no free or cell variables.
39 This information is redundant, but it allows a single flag test
40 to determine whether there is any extra work to be done when the
41 call frame it setup.
42*/
43#define CO_NOFREE 0x0040
Neal Norwitz0090a4c2006-02-19 18:49:30 +000044
Neal Norwitzab51f5f2006-02-25 15:43:10 +000045#if 0
Guido van Rossum45aecf42006-03-15 04:58:47 +000046/* These are no longer used. */
Neal Norwitzab51f5f2006-02-25 15:43:10 +000047#define CO_GENERATOR_ALLOWED 0x1000
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000048#define CO_FUTURE_DIVISION 0x2000
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000049#define CO_FUTURE_ABSOLUTE_IMPORT 0x4000 /* do absolute imports by default */
Thomas Wouters34aa7ba2006-02-28 19:02:24 +000050#define CO_FUTURE_WITH_STATEMENT 0x8000
Guido van Rossum45aecf42006-03-15 04:58:47 +000051#endif
Thomas Wouters34aa7ba2006-02-28 19:02:24 +000052
53/* This should be defined if a future statement modifies the syntax.
54 For example, when a keyword is added.
55*/
Guido van Rossum45aecf42006-03-15 04:58:47 +000056/* #define PY_PARSER_REQUIRES_FUTURE_KEYWORD */
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000057
58#define CO_MAXBLOCKS 20 /* Max static block nesting within a function */
59
Neal Norwitz58a79852005-10-21 04:23:36 +000060PyAPI_DATA(PyTypeObject) PyCode_Type;
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000061
62#define PyCode_Check(op) ((op)->ob_type == &PyCode_Type)
63#define PyCode_GetNumFree(op) (PyTuple_GET_SIZE((op)->co_freevars))
64
65/* Public interface */
Neal Norwitz58a79852005-10-21 04:23:36 +000066PyAPI_FUNC(PyCodeObject *) PyCode_New(
Guido van Rossum4f72a782006-10-27 23:31:49 +000067 int, int, int, int, int, PyObject *, PyObject *,
68 PyObject *, PyObject *, PyObject *, PyObject *,
69 PyObject *, PyObject *, int, PyObject *);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000070 /* same as struct above */
Neal Norwitz58a79852005-10-21 04:23:36 +000071PyAPI_FUNC(int) PyCode_Addr2Line(PyCodeObject *, int);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000072
73/* for internal use only */
74#define _PyCode_GETCODEPTR(co, pp) \
75 ((*(co)->co_code->ob_type->tp_as_buffer->bf_getreadbuffer) \
76 ((co)->co_code, 0, (void **)(pp)))
77
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000078typedef struct _addr_pair {
79 int ap_lower;
80 int ap_upper;
81} PyAddrPair;
82
83/* Check whether lasti (an instruction offset) falls outside bounds
84 and whether it is a line number that should be traced. Returns
85 a line number if it should be traced or -1 if the line should not.
86
87 If lasti is not within bounds, updates bounds.
88*/
89
90PyAPI_FUNC(int) PyCode_CheckLineNumber(PyCodeObject* co,
91 int lasti, PyAddrPair *bounds);
92
Thomas Wouters00ee7ba2006-08-21 19:07:27 +000093PyAPI_FUNC(PyObject*) PyCode_Optimize(PyObject *code, PyObject* consts,
94 PyObject *names, PyObject *lineno_obj);
95
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000096#ifdef __cplusplus
97}
98#endif
99#endif /* !Py_CODE_H */