blob: a4b2f55f80d9db9a84f86a792e0216f2bb96913e [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum884afd61995-07-18 14:21:06 +00002/* Definitions for bytecode */
Guido van Rossum3f5da241990-12-20 15:06:42 +00003
Fred Drakeea9cb5a2000-07-09 00:20:36 +00004#ifndef Py_COMPILE_H
5#define Py_COMPILE_H
6#ifdef __cplusplus
7extern "C" {
8#endif
9
Guido van Rossum884afd61995-07-18 14:21:06 +000010/* Bytecode object */
Guido van Rossum3f5da241990-12-20 15:06:42 +000011typedef struct {
Fred Drakeea9cb5a2000-07-09 00:20:36 +000012 PyObject_HEAD
13 int co_argcount; /* #arguments, except *args */
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) */
Jeremy Hylton64949cb2001-01-25 20:06:59 +000021 PyObject *co_freevars; /* tuple of strings (free variable names) */
22 PyObject *co_cellvars; /* tuple of strings (cell variable names) */
Fred Drakeea9cb5a2000-07-09 00:20:36 +000023 /* 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) */
Guido van Rossumcaa63801995-01-12 11:45:45 +000028} PyCodeObject;
Guido van Rossum3f5da241990-12-20 15:06:42 +000029
Guido van Rossum884afd61995-07-18 14:21:06 +000030/* Masks for co_flags above */
31#define CO_OPTIMIZED 0x0001
32#define CO_NEWLOCALS 0x0002
33#define CO_VARARGS 0x0004
34#define CO_VARKEYWORDS 0x0008
Jeremy Hylton061d1062001-03-22 02:32:48 +000035#define CO_NESTED 0x0010
Tim Peters5ca576e2001-06-18 22:08:13 +000036#define CO_GENERATOR 0x0020
Tim Peters5ba58662001-07-16 02:29:45 +000037/* XXX Temporary hack. Until generators are a permanent part of the
38 language, we need a way for a code object to record that generators
39 were *possible* when it was compiled. This is so code dynamically
40 compiled *by* a code object knows whether to allow yield stmts. In
41 effect, this passes on the "from __future__ import generators" state
42 in effect when the code block was compiled. */
Tim Peters2bbdba32002-04-12 01:20:10 +000043#define CO_GENERATOR_ALLOWED 0x1000 /* no longer used in an essential way */
Guido van Rossum4668b002001-08-08 05:00:18 +000044#define CO_FUTURE_DIVISION 0x2000
Guido van Rossum884afd61995-07-18 14:21:06 +000045
Mark Hammond91a681d2002-08-12 07:21:58 +000046PyAPI_DATA(PyTypeObject) PyCode_Type;
Guido van Rossum3f5da241990-12-20 15:06:42 +000047
Guido van Rossumcaa63801995-01-12 11:45:45 +000048#define PyCode_Check(op) ((op)->ob_type == &PyCode_Type)
Jeremy Hylton12ce4852001-12-13 19:47:02 +000049#define PyCode_GetNumFree(op) (PyTuple_GET_SIZE((op)->co_freevars))
Guido van Rossum3f5da241990-12-20 15:06:42 +000050
Guido van Rossum3f6e4081997-01-17 20:59:26 +000051#define CO_MAXBLOCKS 20 /* Max static block nesting within a function */
Guido van Rossum3f5da241990-12-20 15:06:42 +000052
53/* Public interface */
Guido van Rossume543a941991-04-03 19:00:55 +000054struct _node; /* Declare the existence of this type */
Mark Hammond91a681d2002-08-12 07:21:58 +000055PyAPI_FUNC(PyCodeObject *) PyNode_Compile(struct _node *, char *);
56PyAPI_FUNC(PyCodeObject *) PyCode_New(
Guido van Rossum3f6e4081997-01-17 20:59:26 +000057 int, int, int, int, PyObject *, PyObject *, PyObject *, PyObject *,
Jeremy Hylton64949cb2001-01-25 20:06:59 +000058 PyObject *, PyObject *, PyObject *, PyObject *, int, PyObject *);
59 /* same as struct above */
Mark Hammond91a681d2002-08-12 07:21:58 +000060PyAPI_FUNC(int) PyCode_Addr2Line(PyCodeObject *, int);
Guido van Rossuma3309961993-07-28 09:05:47 +000061
Jeremy Hylton4db62b12001-02-27 19:07:02 +000062/* Future feature support */
63
64typedef struct {
Jeremy Hylton39e2f3f2001-02-28 01:58:08 +000065 int ff_found_docstring;
Jeremy Hylton4db62b12001-02-27 19:07:02 +000066 int ff_last_lineno;
Jeremy Hyltonfdd12f62001-08-10 21:38:04 +000067 int ff_features;
Jeremy Hylton4db62b12001-02-27 19:07:02 +000068} PyFutureFeatures;
69
Mark Hammond91a681d2002-08-12 07:21:58 +000070PyAPI_FUNC(PyFutureFeatures *) PyNode_Future(struct _node *, char *);
71PyAPI_FUNC(PyCodeObject *) PyNode_CompileFlags(struct _node *, char *,
Jeremy Hylton9f324e92001-03-01 22:59:14 +000072 PyCompilerFlags *);
Jeremy Hylton4db62b12001-02-27 19:07:02 +000073
Jeremy Hylton4db62b12001-02-27 19:07:02 +000074#define FUTURE_NESTED_SCOPES "nested_scopes"
Guido van Rossumb09f7ed2001-07-15 21:08:29 +000075#define FUTURE_GENERATORS "generators"
Guido van Rossum4668b002001-08-08 05:00:18 +000076#define FUTURE_DIVISION "division"
77
Guido van Rossumd076c731998-10-07 19:42:25 +000078/* for internal use only */
79#define _PyCode_GETCODEPTR(co, pp) \
80 ((*(co)->co_code->ob_type->tp_as_buffer->bf_getreadbuffer) \
81 ((co)->co_code, 0, (void **)(pp)))
82
Guido van Rossuma3309961993-07-28 09:05:47 +000083#ifdef __cplusplus
84}
85#endif
86#endif /* !Py_COMPILE_H */