code.h 4.13 KB
Newer Older
Jeremy Hylton's avatar
Jeremy Hylton committed
1 2
/* Definitions for bytecode */

3
#ifndef Py_LIMITED_API
Jeremy Hylton's avatar
Jeremy Hylton committed
4 5 6 7 8 9 10 11 12 13
#ifndef Py_CODE_H
#define Py_CODE_H
#ifdef __cplusplus
extern "C" {
#endif

/* Bytecode object */
typedef struct {
    PyObject_HEAD
    int co_argcount;		/* #arguments, except *args */
14
    int co_kwonlyargcount;	/* #keyword only arguments */
Jeremy Hylton's avatar
Jeremy Hylton committed
15 16 17 18 19 20 21 22 23
    int co_nlocals;		/* #local variables */
    int co_stacksize;		/* #entries needed for evaluation stack */
    int co_flags;		/* CO_..., see below */
    PyObject *co_code;		/* instruction opcodes */
    PyObject *co_consts;	/* list (constants used) */
    PyObject *co_names;		/* list of strings (names used) */
    PyObject *co_varnames;	/* tuple of strings (local variable names) */
    PyObject *co_freevars;	/* tuple of strings (free variable names) */
    PyObject *co_cellvars;      /* tuple of strings (cell variable names) */
24
    /* The rest doesn't count for hash or comparisons */
25
    unsigned char *co_cell2arg; /* Maps cell vars which are arguments. */
26 27
    PyObject *co_filename;	/* unicode (where it was loaded from) */
    PyObject *co_name;		/* unicode (name, for reference) */
Jeremy Hylton's avatar
Jeremy Hylton committed
28
    int co_firstlineno;		/* first source line number */
29 30
    PyObject *co_lnotab;	/* string (encoding addr<->lineno mapping) See
				   Objects/lnotab_notes.txt for details. */
31
    void *co_zombieframe;     /* for optimization only (see frameobject.c) */
32
    PyObject *co_weakreflist;   /* to support weakrefs to code objects */
Jeremy Hylton's avatar
Jeremy Hylton committed
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
} PyCodeObject;

/* Masks for co_flags above */
#define CO_OPTIMIZED	0x0001
#define CO_NEWLOCALS	0x0002
#define CO_VARARGS	0x0004
#define CO_VARKEYWORDS	0x0008
#define CO_NESTED       0x0010
#define CO_GENERATOR    0x0020
/* The CO_NOFREE flag is set if there are no free or cell variables.
   This information is redundant, but it allows a single flag test
   to determine whether there is any extra work to be done when the
   call frame it setup.
*/
#define CO_NOFREE       0x0040
48

49
/* These are no longer used. */
50
#if 0
51
#define CO_GENERATOR_ALLOWED    0x1000
52
#endif
Jeremy Hylton's avatar
Jeremy Hylton committed
53
#define CO_FUTURE_DIVISION    	0x2000
54
#define CO_FUTURE_ABSOLUTE_IMPORT 0x4000 /* do absolute imports by default */
55
#define CO_FUTURE_WITH_STATEMENT  0x8000
56
#define CO_FUTURE_PRINT_FUNCTION  0x10000
57
#define CO_FUTURE_UNICODE_LITERALS 0x20000
58

59 60
#define CO_FUTURE_BARRY_AS_BDFL  0x40000

61 62 63 64 65
/* This value is found in the co_cell2arg array when the associated cell
   variable does not correspond to an argument. The maximum number of
   arguments is 255 (indexed up to 254), so 255 work as a special flag.*/
#define CO_CELL_NOT_AN_ARG 255

66 67 68
/* This should be defined if a future statement modifies the syntax.
   For example, when a keyword is added.
*/
69
#define PY_PARSER_REQUIRES_FUTURE_KEYWORD
Jeremy Hylton's avatar
Jeremy Hylton committed
70 71 72

#define CO_MAXBLOCKS 20 /* Max static block nesting within a function */

73
PyAPI_DATA(PyTypeObject) PyCode_Type;
Jeremy Hylton's avatar
Jeremy Hylton committed
74

75
#define PyCode_Check(op) (Py_TYPE(op) == &PyCode_Type)
Jeremy Hylton's avatar
Jeremy Hylton committed
76 77 78
#define PyCode_GetNumFree(op) (PyTuple_GET_SIZE((op)->co_freevars))

/* Public interface */
79
PyAPI_FUNC(PyCodeObject *) PyCode_New(
80 81
	int, int, int, int, int, PyObject *, PyObject *,
	PyObject *, PyObject *, PyObject *, PyObject *,
82
	PyObject *, PyObject *, int, PyObject *);
Jeremy Hylton's avatar
Jeremy Hylton committed
83
        /* same as struct above */
84 85 86 87 88 89 90 91

/* Creates a new empty code object with the specified source location. */
PyAPI_FUNC(PyCodeObject *)
PyCode_NewEmpty(const char *filename, const char *funcname, int firstlineno);

/* Return the line number associated with the specified bytecode index
   in this code object.  If you just need the line number of a frame,
   use PyFrame_GetLineNumber() instead. */
92
PyAPI_FUNC(int) PyCode_Addr2Line(PyCodeObject *, int);
Jeremy Hylton's avatar
Jeremy Hylton committed
93 94

/* for internal use only */
95 96 97 98 99
typedef struct _addr_pair {
        int ap_lower;
        int ap_upper;
} PyAddrPair;

100 101
/* Update *bounds to describe the first and one-past-the-last instructions in the
   same line as lasti.  Return the number of that line.
102
*/
103
#ifndef Py_LIMITED_API
104 105
PyAPI_FUNC(int) _PyCode_CheckLineNumber(PyCodeObject* co,
                                        int lasti, PyAddrPair *bounds);
106
#endif
107

108 109 110
PyAPI_FUNC(PyObject*) PyCode_Optimize(PyObject *code, PyObject* consts,
                                      PyObject *names, PyObject *lineno_obj);

Jeremy Hylton's avatar
Jeremy Hylton committed
111 112 113 114
#ifdef __cplusplus
}
#endif
#endif /* !Py_CODE_H */
115
#endif /* Py_LIMITED_API */