compile.h 3.04 KB
Newer Older
1

2
/* Definitions for bytecode */
Guido van Rossum's avatar
Guido van Rossum committed
3

4 5 6 7 8 9
#ifndef Py_COMPILE_H
#define Py_COMPILE_H
#ifdef __cplusplus
extern "C" {
#endif

10
/* Bytecode object */
Guido van Rossum's avatar
Guido van Rossum committed
11
typedef struct {
12 13 14 15 16 17 18 19 20
    PyObject_HEAD
    int co_argcount;		/* #arguments, except *args */
    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) */
Jeremy Hylton's avatar
Jeremy Hylton committed
21 22
    PyObject *co_freevars;	/* tuple of strings (free variable names) */
    PyObject *co_cellvars;      /* tuple of strings (cell variable names) */
23 24 25 26 27
    /* The rest doesn't count for hash/cmp */
    PyObject *co_filename;	/* string (where it was loaded from) */
    PyObject *co_name;		/* string (name, for reference) */
    int co_firstlineno;		/* first source line number */
    PyObject *co_lnotab;	/* string (encoding addr<->lineno mapping) */
28
} PyCodeObject;
Guido van Rossum's avatar
Guido van Rossum committed
29

30 31 32 33 34
/* Masks for co_flags above */
#define CO_OPTIMIZED	0x0001
#define CO_NEWLOCALS	0x0002
#define CO_VARARGS	0x0004
#define CO_VARKEYWORDS	0x0008
35
#define CO_NESTED       0x0010
36
#define CO_GENERATOR    0x0020
37 38 39 40 41 42
/* XXX Temporary hack.  Until generators are a permanent part of the
   language, we need a way for a code object to record that generators
   were *possible* when it was compiled.  This is so code dynamically
   compiled *by* a code object knows whether to allow yield stmts.  In
   effect, this passes on the "from __future__ import generators" state
   in effect when the code block was compiled. */
43
#define CO_GENERATOR_ALLOWED    0x1000 /* no longer used in an essential way */
44
#define CO_FUTURE_DIVISION    	0x2000
45

46
PyAPI_DATA(PyTypeObject) PyCode_Type;
Guido van Rossum's avatar
Guido van Rossum committed
47

48
#define PyCode_Check(op) ((op)->ob_type == &PyCode_Type)
49
#define PyCode_GetNumFree(op) (PyTuple_GET_SIZE((op)->co_freevars))
Guido van Rossum's avatar
Guido van Rossum committed
50

51
#define CO_MAXBLOCKS 20 /* Max static block nesting within a function */
Guido van Rossum's avatar
Guido van Rossum committed
52 53

/* Public interface */
54
struct _node; /* Declare the existence of this type */
55 56
PyAPI_FUNC(PyCodeObject *) PyNode_Compile(struct _node *, char *);
PyAPI_FUNC(PyCodeObject *) PyCode_New(
57
	int, int, int, int, PyObject *, PyObject *, PyObject *, PyObject *,
Jeremy Hylton's avatar
Jeremy Hylton committed
58 59
	PyObject *, PyObject *, PyObject *, PyObject *, int, PyObject *); 
        /* same as struct above */
60
PyAPI_FUNC(int) PyCode_Addr2Line(PyCodeObject *, int);
61

62 63 64
/* Future feature support */

typedef struct {
65
    int ff_found_docstring;
66
    int ff_last_lineno;
67
    int ff_features;
68 69
} PyFutureFeatures;

70 71
PyAPI_FUNC(PyFutureFeatures *) PyNode_Future(struct _node *, char *);
PyAPI_FUNC(PyCodeObject *) PyNode_CompileFlags(struct _node *, char *,
72
					      PyCompilerFlags *);
73 74

#define FUTURE_NESTED_SCOPES "nested_scopes"
75
#define FUTURE_GENERATORS "generators"
76 77
#define FUTURE_DIVISION "division"

78 79 80 81 82
/* for internal use only */
#define _PyCode_GETCODEPTR(co, pp) \
	((*(co)->co_code->ob_type->tp_as_buffer->bf_getreadbuffer) \
	 ((co)->co_code, 0, (void **)(pp)))

83 84 85 86
#ifdef __cplusplus
}
#endif
#endif /* !Py_COMPILE_H */