blob: f2d1a9a83e5414b88a969f3c0742bd53646452df [file] [log] [blame]
Guido van Rossuma3309961993-07-28 09:05:47 +00001#ifndef Py_COMPILE_H
2#define Py_COMPILE_H
3#ifdef __cplusplus
4extern "C" {
5#endif
6
Guido van Rossumf70e43a1991-02-19 12:39:46 +00007/***********************************************************
Guido van Rossum5799b521995-01-04 19:06:22 +00008Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
9The Netherlands.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000010
11 All Rights Reserved
12
Guido van Rossumd266eb41996-10-25 14:44:06 +000013Permission to use, copy, modify, and distribute this software and its
14documentation for any purpose and without fee is hereby granted,
Guido van Rossumf70e43a1991-02-19 12:39:46 +000015provided that the above copyright notice appear in all copies and that
Guido van Rossumd266eb41996-10-25 14:44:06 +000016both that copyright notice and this permission notice appear in
Guido van Rossumf70e43a1991-02-19 12:39:46 +000017supporting documentation, and that the names of Stichting Mathematisch
Guido van Rossumd266eb41996-10-25 14:44:06 +000018Centrum or CWI or Corporation for National Research Initiatives or
19CNRI not be used in advertising or publicity pertaining to
20distribution of the software without specific, written prior
21permission.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000022
Guido van Rossumd266eb41996-10-25 14:44:06 +000023While CWI is the initial source for this software, a modified version
24is made available by the Corporation for National Research Initiatives
25(CNRI) at the Internet address ftp://ftp.python.org.
26
27STICHTING MATHEMATISCH CENTRUM AND CNRI DISCLAIM ALL WARRANTIES WITH
28REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
29MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH
30CENTRUM OR CNRI BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
31DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
32PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
33TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
34PERFORMANCE OF THIS SOFTWARE.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000035
36******************************************************************/
37
Guido van Rossum884afd61995-07-18 14:21:06 +000038/* Definitions for bytecode */
Guido van Rossum3f5da241990-12-20 15:06:42 +000039
Guido van Rossum884afd61995-07-18 14:21:06 +000040/* Bytecode object */
Guido van Rossum3f5da241990-12-20 15:06:42 +000041typedef struct {
Guido van Rossumcaa63801995-01-12 11:45:45 +000042 PyObject_HEAD
Guido van Rossum884afd61995-07-18 14:21:06 +000043 int co_argcount; /* #arguments, except *args */
44 int co_nlocals; /* #local variables */
Guido van Rossum3f6e4081997-01-17 20:59:26 +000045 int co_stacksize; /* #entries needed for evaluation stack */
Guido van Rossum884afd61995-07-18 14:21:06 +000046 int co_flags; /* CO_..., see below */
Guido van Rossumd076c731998-10-07 19:42:25 +000047 PyObject *co_code; /* instruction opcodes */
Guido van Rossum884afd61995-07-18 14:21:06 +000048 PyObject *co_consts; /* list (constants used) */
49 PyObject *co_names; /* list of strings (names used) */
50 PyObject *co_varnames; /* tuple of strings (local variable names) */
51 /* The rest doesn't count for hash/cmp */
52 PyObject *co_filename; /* string (where it was loaded from) */
53 PyObject *co_name; /* string (name, for reference) */
Guido van Rossum76757981997-01-24 03:41:09 +000054 int co_firstlineno; /* first source line number */
55 PyObject *co_lnotab; /* string (encoding addr<->lineno mapping) */
Guido van Rossumcaa63801995-01-12 11:45:45 +000056} PyCodeObject;
Guido van Rossum3f5da241990-12-20 15:06:42 +000057
Guido van Rossum884afd61995-07-18 14:21:06 +000058/* Masks for co_flags above */
59#define CO_OPTIMIZED 0x0001
60#define CO_NEWLOCALS 0x0002
61#define CO_VARARGS 0x0004
62#define CO_VARKEYWORDS 0x0008
63
Guido van Rossum051ab121995-02-27 10:17:52 +000064extern DL_IMPORT(PyTypeObject) PyCode_Type;
Guido van Rossum3f5da241990-12-20 15:06:42 +000065
Guido van Rossumcaa63801995-01-12 11:45:45 +000066#define PyCode_Check(op) ((op)->ob_type == &PyCode_Type)
Guido van Rossum3f5da241990-12-20 15:06:42 +000067
Guido van Rossum3f6e4081997-01-17 20:59:26 +000068#define CO_MAXBLOCKS 20 /* Max static block nesting within a function */
Guido van Rossum3f5da241990-12-20 15:06:42 +000069
70/* Public interface */
Guido van Rossume543a941991-04-03 19:00:55 +000071struct _node; /* Declare the existence of this type */
Guido van Rossum43466ec1998-12-04 18:48:25 +000072DL_IMPORT(PyCodeObject *) PyNode_Compile Py_PROTO((struct _node *, char *));
73DL_IMPORT(PyCodeObject *) PyCode_New Py_PROTO((
Guido van Rossum3f6e4081997-01-17 20:59:26 +000074 int, int, int, int, PyObject *, PyObject *, PyObject *, PyObject *,
Guido van Rossum76757981997-01-24 03:41:09 +000075 PyObject *, PyObject *, int, PyObject *)); /* same as struct above */
Guido van Rossum43466ec1998-12-04 18:48:25 +000076DL_IMPORT(int) PyCode_Addr2Line Py_PROTO((PyCodeObject *, int));
Guido van Rossuma3309961993-07-28 09:05:47 +000077
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 */