blob: d2438921b0424c25727dcd240157082d33719ae1 [file] [log] [blame]
Jeremy Hylton4b38da62001-02-02 18:19:15 +00001#ifndef Py_SYMTABLE_H
2#define Py_SYMTABLE_H
3#ifdef __cplusplus
4extern "C" {
5#endif
6
7/* A symbol table is constructed each time PyNode_Compile() is
8 called. The table walks the entire parse tree and identifies each
9 use or definition of a variable.
10
11 The symbol table contains a dictionary for each code block in a
12 module: The symbol dictionary for the block. They keys of these
13 dictionaries are the name of all variables used or defined in the
14 block; the integer values are used to store several flags,
15 e.g. DEF_PARAM indicates that a variable is a parameter to a
16 function.
Jeremy Hylton4b38da62001-02-02 18:19:15 +000017*/
18
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000019struct _symtable_entry;
20
Jeremy Hylton4b38da62001-02-02 18:19:15 +000021struct symtable {
22 int st_pass; /* pass == 1 or 2 */
Martin v. Löwis95292d62002-12-11 14:04:59 +000023 const char *st_filename; /* name of file being compiled */
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000024 struct _symtable_entry *st_cur; /* current symbol table entry */
25 PyObject *st_symbols; /* dictionary of symbol table entries */
Jeremy Hylton4b38da62001-02-02 18:19:15 +000026 PyObject *st_stack; /* stack of namespace info */
Jeremy Hylton4b38da62001-02-02 18:19:15 +000027 PyObject *st_global; /* borrowed ref to MODULE in st_symbols */
28 int st_nscopes; /* number of scopes */
29 int st_errors; /* number of errors */
30 char *st_private; /* name of current class or NULL */
Jeremy Hylton4db62b12001-02-27 19:07:02 +000031 PyFutureFeatures *st_future; /* module's future features */
Jeremy Hylton4b38da62001-02-02 18:19:15 +000032};
33
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000034typedef struct _symtable_entry {
35 PyObject_HEAD
36 PyObject *ste_id; /* int: key in st_symbols) */
37 PyObject *ste_symbols; /* dict: name to flags) */
38 PyObject *ste_name; /* string: name of scope */
39 PyObject *ste_varnames; /* list of variable names */
40 PyObject *ste_children; /* list of child ids */
41 int ste_type; /* module, class, or function */
42 int ste_lineno; /* first line of scope */
Jeremy Hylton29906ee2001-02-27 04:23:34 +000043 int ste_optimized; /* true if namespace can't be optimized */
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000044 int ste_nested; /* true if scope is nested */
45 int ste_child_free; /* true if a child scope has free variables,
46 including free refs to globals */
Tim Peters5ca576e2001-06-18 22:08:13 +000047 int ste_generator; /* true if namespace is a generator */
Jeremy Hylton2e2cded2001-03-22 03:57:58 +000048 int ste_opt_lineno; /* lineno of last exec or import * */
Jeremy Hylton4d508ad2003-05-21 17:34:50 +000049 int ste_tmpname; /* temporary name counter */
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000050 struct symtable *ste_table;
51} PySymtableEntryObject;
52
Mark Hammond91a681d2002-08-12 07:21:58 +000053PyAPI_DATA(PyTypeObject) PySymtableEntry_Type;
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000054
55#define PySymtableEntry_Check(op) ((op)->ob_type == &PySymtableEntry_Type)
56
Mark Hammond91a681d2002-08-12 07:21:58 +000057PyAPI_FUNC(PyObject *) PySymtableEntry_New(struct symtable *,
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000058 char *, int, int);
59
Martin v. Löwis95292d62002-12-11 14:04:59 +000060PyAPI_FUNC(struct symtable *) PyNode_CompileSymtable(struct _node *, const char *);
Mark Hammond91a681d2002-08-12 07:21:58 +000061PyAPI_FUNC(void) PySymtable_Free(struct symtable *);
Jeremy Hylton4b38da62001-02-02 18:19:15 +000062
63
64#define TOP "global"
Jeremy Hylton4b38da62001-02-02 18:19:15 +000065
66/* Flags for def-use information */
67
68#define DEF_GLOBAL 1 /* global stmt */
69#define DEF_LOCAL 2 /* assignment in code block */
70#define DEF_PARAM 2<<1 /* formal parameter */
71#define USE 2<<2 /* name is used */
72#define DEF_STAR 2<<3 /* parameter is star arg */
73#define DEF_DOUBLESTAR 2<<4 /* parameter is star-star arg */
74#define DEF_INTUPLE 2<<5 /* name defined in tuple in parameters */
Jeremy Hylton99858b52001-02-28 23:03:39 +000075#define DEF_FREE 2<<6 /* name used but not defined in nested scope */
Jeremy Hylton4b38da62001-02-02 18:19:15 +000076#define DEF_FREE_GLOBAL 2<<7 /* free variable is actually implicit global */
77#define DEF_FREE_CLASS 2<<8 /* free variable from class's method */
78#define DEF_IMPORT 2<<9 /* assignment occurred via import */
79
Jeremy Hylton99858b52001-02-28 23:03:39 +000080#define DEF_BOUND (DEF_LOCAL | DEF_PARAM | DEF_IMPORT)
81
Jeremy Hylton4b38da62001-02-02 18:19:15 +000082#define TYPE_FUNCTION 1
83#define TYPE_CLASS 2
84#define TYPE_MODULE 3
85
86#define LOCAL 1
87#define GLOBAL_EXPLICIT 2
88#define GLOBAL_IMPLICIT 3
89#define FREE 4
90#define CELL 5
91
Jeremy Hylton29906ee2001-02-27 04:23:34 +000092#define OPT_IMPORT_STAR 1
93#define OPT_EXEC 2
94#define OPT_BARE_EXEC 4
95
Jeremy Hylton4b38da62001-02-02 18:19:15 +000096#ifdef __cplusplus
97}
98#endif
99#endif /* !Py_SYMTABLE_H */