code.h revision f3170ccef8809e4a3f82fe9f82dc7a4a486c28c1 
1/* 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 */
13    int co_kwonlyargcount;	/* #keyword only arguments */
14    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 or comparisons */
24    PyObject *co_filename;	/* unicode (where it was loaded from) */
25    PyObject *co_name;		/* unicode (name, for reference) */
26    int co_firstlineno;		/* first source line number */
27    PyObject *co_lnotab;	/* string (encoding addr<->lineno mapping) See
28				   Objects/lnotab_notes.txt for details. */
29    void *co_zombieframe;     /* for optimization only (see frameobject.c) */
30    PyObject *co_weakreflist;   /* to support weakrefs to code objects */
31} PyCodeObject;
32
33/* Masks for co_flags above */
34#define CO_OPTIMIZED	0x0001
35#define CO_NEWLOCALS	0x0002
36#define CO_VARARGS	0x0004
37#define CO_VARKEYWORDS	0x0008
38#define CO_NESTED       0x0010
39#define CO_GENERATOR    0x0020
40/* The CO_NOFREE flag is set if there are no free or cell variables.
41   This information is redundant, but it allows a single flag test
42   to determine whether there is any extra work to be done when the
43   call frame it setup.
44*/
45#define CO_NOFREE       0x0040
46
47/* These are no longer used. */
48#if 0
49#define CO_GENERATOR_ALLOWED    0x1000
50#endif
51#define CO_FUTURE_DIVISION    	0x2000
52#define CO_FUTURE_ABSOLUTE_IMPORT 0x4000 /* do absolute imports by default */
53#define CO_FUTURE_WITH_STATEMENT  0x8000
54#define CO_FUTURE_PRINT_FUNCTION  0x10000
55#define CO_FUTURE_UNICODE_LITERALS 0x20000
56
57#define CO_FUTURE_BARRY_AS_BDFL  0x40000
58
59/* This should be defined if a future statement modifies the syntax.
60   For example, when a keyword is added.
61*/
62#define PY_PARSER_REQUIRES_FUTURE_KEYWORD
63
64#define CO_MAXBLOCKS 20 /* Max static block nesting within a function */
65
66PyAPI_DATA(PyTypeObject) PyCode_Type;
67
68#define PyCode_Check(op) (Py_TYPE(op) == &PyCode_Type)
69#define PyCode_GetNumFree(op) (PyTuple_GET_SIZE((op)->co_freevars))
70
71/* Public interface */
72PyAPI_FUNC(PyCodeObject *) PyCode_New(
73	int, int, int, int, int, PyObject *, PyObject *,
74	PyObject *, PyObject *, PyObject *, PyObject *,
75	PyObject *, PyObject *, int, PyObject *);
76        /* same as struct above */
77
78/* Creates a new empty code object with the specified source location. */
79PyAPI_FUNC(PyCodeObject *)
80PyCode_NewEmpty(const char *filename, const char *funcname, int firstlineno);
81
82/* Return the line number associated with the specified bytecode index
83   in this code object.  If you just need the line number of a frame,
84   use PyFrame_GetLineNumber() instead. */
85PyAPI_FUNC(int) PyCode_Addr2Line(PyCodeObject *, int);
86
87/* for internal use only */
88typedef struct _addr_pair {
89        int ap_lower;
90        int ap_upper;
91} PyAddrPair;
92
93/* Update *bounds to describe the first and one-past-the-last instructions in the
94   same line as lasti.  Return the number of that line.
95*/
96PyAPI_FUNC(int) _PyCode_CheckLineNumber(PyCodeObject* co,
97                                        int lasti, PyAddrPair *bounds);
98
99PyAPI_FUNC(PyObject*) PyCode_Optimize(PyObject *code, PyObject* consts,
100                                      PyObject *names, PyObject *lineno_obj);
101
102#ifdef __cplusplus
103}
104#endif
105#endif /* !Py_CODE_H */
106