code.h revision 45aecf451a64fb1ebe5e74d0b00965ac8d99dff6 
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_nlocals;		/* #local variables */
14    int co_stacksize;		/* #entries needed for evaluation stack */
15    int co_flags;		/* CO_..., see below */
16    PyObject *co_code;		/* instruction opcodes */
17    PyObject *co_consts;	/* list (constants used) */
18    PyObject *co_names;		/* list of strings (names used) */
19    PyObject *co_varnames;	/* tuple of strings (local variable names) */
20    PyObject *co_freevars;	/* tuple of strings (free variable names) */
21    PyObject *co_cellvars;      /* tuple of strings (cell variable names) */
22    /* The rest doesn't count for hash/cmp */
23    PyObject *co_filename;	/* string (where it was loaded from) */
24    PyObject *co_name;		/* string (name, for reference) */
25    int co_firstlineno;		/* first source line number */
26    PyObject *co_lnotab;	/* string (encoding addr<->lineno mapping) */
27} PyCodeObject;
28
29/* Masks for co_flags above */
30#define CO_OPTIMIZED	0x0001
31#define CO_NEWLOCALS	0x0002
32#define CO_VARARGS	0x0004
33#define CO_VARKEYWORDS	0x0008
34#define CO_NESTED       0x0010
35#define CO_GENERATOR    0x0020
36/* The CO_NOFREE flag is set if there are no free or cell variables.
37   This information is redundant, but it allows a single flag test
38   to determine whether there is any extra work to be done when the
39   call frame it setup.
40*/
41#define CO_NOFREE       0x0040
42
43#if 0
44/* These are no longer used. */
45#define CO_GENERATOR_ALLOWED    0x1000
46#define CO_FUTURE_DIVISION    	0x2000
47#define CO_FUTURE_ABSIMPORT	0x4000 /* absolute import by default */
48#define CO_FUTURE_WITH_STATEMENT  0x8000
49#endif
50
51/* This should be defined if a future statement modifies the syntax.
52   For example, when a keyword is added.
53*/
54/* #define PY_PARSER_REQUIRES_FUTURE_KEYWORD */
55
56#define CO_MAXBLOCKS 20 /* Max static block nesting within a function */
57
58PyAPI_DATA(PyTypeObject) PyCode_Type;
59
60#define PyCode_Check(op) ((op)->ob_type == &PyCode_Type)
61#define PyCode_GetNumFree(op) (PyTuple_GET_SIZE((op)->co_freevars))
62
63/* Public interface */
64PyAPI_FUNC(PyCodeObject *) PyCode_New(
65	int, int, int, int, PyObject *, PyObject *, PyObject *, PyObject *,
66	PyObject *, PyObject *, PyObject *, PyObject *, int, PyObject *);
67        /* same as struct above */
68PyAPI_FUNC(int) PyCode_Addr2Line(PyCodeObject *, int);
69
70/* for internal use only */
71#define _PyCode_GETCODEPTR(co, pp) \
72	((*(co)->co_code->ob_type->tp_as_buffer->bf_getreadbuffer) \
73	 ((co)->co_code, 0, (void **)(pp)))
74
75#ifdef __cplusplus
76}
77#endif
78#endif /* !Py_CODE_H */
79