blob: e0a0be41b5ac7cf973778fd139ce11588ed821b5 [file] [log] [blame]
Jeremy Hylton4b38da62001-02-02 18:19:15 +00001#ifndef Py_SYMTABLE_H
2#define Py_SYMTABLE_H
Neal Norwitz090b3dd2006-02-28 22:36:46 +00003
Jeremy Hylton4b38da62001-02-02 18:19:15 +00004#ifdef __cplusplus
5extern "C" {
6#endif
7
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00008typedef enum _block_type { FunctionBlock, ClassBlock, ModuleBlock }
Neal Norwitz62c2fac2005-10-24 00:30:44 +00009 _Py_block_ty;
Jeremy Hylton4b38da62001-02-02 18:19:15 +000010
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000011struct _symtable_entry;
12
Jeremy Hylton4b38da62001-02-02 18:19:15 +000013struct symtable {
Antoine Pitrouc83ea132010-05-09 14:46:46 +000014 const char *st_filename; /* name of file being compiled */
15 struct _symtable_entry *st_cur; /* current symbol table entry */
16 struct _symtable_entry *st_top; /* module entry */
17 PyObject *st_symbols; /* dictionary of symbol table entries */
18 PyObject *st_stack; /* stack of namespace info */
19 PyObject *st_global; /* borrowed ref to MODULE in st_symbols */
20 int st_nblocks; /* number of blocks */
21 PyObject *st_private; /* name of current class or NULL */
22 PyFutureFeatures *st_future; /* module's future features */
Jeremy Hylton4b38da62001-02-02 18:19:15 +000023};
24
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000025typedef struct _symtable_entry {
Antoine Pitrouc83ea132010-05-09 14:46:46 +000026 PyObject_HEAD
27 PyObject *ste_id; /* int: key in st_symbols */
28 PyObject *ste_symbols; /* dict: name to flags */
29 PyObject *ste_name; /* string: name of block */
30 PyObject *ste_varnames; /* list of variable names */
31 PyObject *ste_children; /* list of child ids */
32 _Py_block_ty ste_type; /* module, class, or function */
33 int ste_unoptimized; /* false if namespace is optimized */
34 int ste_nested; /* true if block is nested */
35 unsigned ste_free : 1; /* true if block has free variables */
36 unsigned ste_child_free : 1; /* true if a child block has free vars,
37 including free refs to globals */
38 unsigned ste_generator : 1; /* true if namespace is a generator */
39 unsigned ste_varargs : 1; /* true if block has varargs */
40 unsigned ste_varkeywords : 1; /* true if block has varkeywords */
41 unsigned ste_returns_value : 1; /* true if namespace uses return with
42 an argument */
43 int ste_lineno; /* first line of block */
44 int ste_opt_lineno; /* lineno of last exec or import * */
45 int ste_tmpname; /* counter for listcomp temp vars */
46 struct symtable *ste_table;
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000047} PySTEntryObject;
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000048
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000049PyAPI_DATA(PyTypeObject) PySTEntry_Type;
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000050
Christian Heimese93237d2007-12-19 02:37:44 +000051#define PySTEntry_Check(op) (Py_TYPE(op) == &PySTEntry_Type)
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000052
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000053PyAPI_FUNC(int) PyST_GetScope(PySTEntryObject *, PyObject *);
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000054
Antoine Pitrouc83ea132010-05-09 14:46:46 +000055PyAPI_FUNC(struct symtable *) PySymtable_Build(mod_ty, const char *,
56 PyFutureFeatures *);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000057PyAPI_FUNC(PySTEntryObject *) PySymtable_Lookup(struct symtable *, void *);
58
Mark Hammond91a681d2002-08-12 07:21:58 +000059PyAPI_FUNC(void) PySymtable_Free(struct symtable *);
Jeremy Hylton4b38da62001-02-02 18:19:15 +000060
Jeremy Hylton4b38da62001-02-02 18:19:15 +000061/* Flags for def-use information */
62
63#define DEF_GLOBAL 1 /* global stmt */
64#define DEF_LOCAL 2 /* assignment in code block */
65#define DEF_PARAM 2<<1 /* formal parameter */
66#define USE 2<<2 /* name is used */
Benjamin Peterson94819cf2009-06-23 03:01:56 +000067#define DEF_FREE 2<<3 /* name used but not defined in nested block */
68#define DEF_FREE_CLASS 2<<4 /* free variable from class's method */
69#define DEF_IMPORT 2<<5 /* assignment occurred via import */
Jeremy Hylton4b38da62001-02-02 18:19:15 +000070
Jeremy Hylton99858b52001-02-28 23:03:39 +000071#define DEF_BOUND (DEF_LOCAL | DEF_PARAM | DEF_IMPORT)
72
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000073/* GLOBAL_EXPLICIT and GLOBAL_IMPLICIT are used internally by the symbol
Antoine Pitrouc83ea132010-05-09 14:46:46 +000074 table. GLOBAL is returned from PyST_GetScope() for either of them.
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000075 It is stored in ste_symbols at bits 12-14.
76*/
77#define SCOPE_OFF 11
78#define SCOPE_MASK 7
Jeremy Hylton4b38da62001-02-02 18:19:15 +000079
80#define LOCAL 1
81#define GLOBAL_EXPLICIT 2
82#define GLOBAL_IMPLICIT 3
83#define FREE 4
84#define CELL 5
85
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000086/* The following three names are used for the ste_unoptimized bit field */
Jeremy Hylton29906ee2001-02-27 04:23:34 +000087#define OPT_IMPORT_STAR 1
88#define OPT_EXEC 2
89#define OPT_BARE_EXEC 4
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000090#define OPT_TOPLEVEL 8 /* top-level names, including eval and exec */
91
92#define GENERATOR 1
93#define GENERATOR_EXPRESSION 2
Jeremy Hylton29906ee2001-02-27 04:23:34 +000094
Jeremy Hylton4b38da62001-02-02 18:19:15 +000095#ifdef __cplusplus
96}
97#endif
98#endif /* !Py_SYMTABLE_H */