blob: fefe08bb31b3b9637b00a1fe5d86e95d73e42974 [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
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00007typedef enum _block_type { FunctionBlock, ClassBlock, ModuleBlock }
Neal Norwitz62c2fac2005-10-24 00:30:44 +00008 _Py_block_ty;
Jeremy Hylton4b38da62001-02-02 18:19:15 +00009
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000010struct _symtable_entry;
11
Jeremy Hylton4b38da62001-02-02 18:19:15 +000012struct symtable {
Martin v. Löwis95292d62002-12-11 14:04:59 +000013 const char *st_filename; /* name of file being compiled */
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000014 struct _symtable_entry *st_cur; /* current symbol table entry */
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000015 struct _symtable_entry *st_top; /* module entry */
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000016 PyObject *st_symbols; /* dictionary of symbol table entries */
Jeremy Hylton4b38da62001-02-02 18:19:15 +000017 PyObject *st_stack; /* stack of namespace info */
Jeremy Hylton4b38da62001-02-02 18:19:15 +000018 PyObject *st_global; /* borrowed ref to MODULE in st_symbols */
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000019 int st_nblocks; /* number of blocks */
Neil Schemenauer8b528b22005-10-23 18:37:42 +000020 PyObject *st_private; /* name of current class or NULL */
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000021 int st_tmpname; /* temporary name counter */
Jeremy Hylton4db62b12001-02-27 19:07:02 +000022 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 {
26 PyObject_HEAD
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000027 PyObject *ste_id; /* int: key in st_symbols */
28 PyObject *ste_symbols; /* dict: name to flags */
29 PyObject *ste_name; /* string: name of block */
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000030 PyObject *ste_varnames; /* list of variable names */
31 PyObject *ste_children; /* list of child ids */
Neal Norwitz62c2fac2005-10-24 00:30:44 +000032 _Py_block_ty ste_type; /* module, class, or function */
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000033 int ste_unoptimized; /* false if namespace is optimized */
Neal Norwitz8208b642006-01-07 21:25:23 +000034 unsigned ste_nested : 1; /* 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 */
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000041 int ste_lineno; /* first line of block */
Jeremy Hylton2e2cded2001-03-22 03:57:58 +000042 int ste_opt_lineno; /* lineno of last exec or import * */
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000043 int ste_tmpname; /* counter for listcomp temp vars */
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000044 struct symtable *ste_table;
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000045} PySTEntryObject;
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000046
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000047PyAPI_DATA(PyTypeObject) PySTEntry_Type;
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000048
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000049#define PySTEntry_Check(op) ((op)->ob_type == &PySTEntry_Type)
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000050
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000051PyAPI_FUNC(PySTEntryObject *) \
Neal Norwitz62c2fac2005-10-24 00:30:44 +000052 PySTEntry_New(struct symtable *, identifier, _Py_block_ty, void *, int);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000053PyAPI_FUNC(int) PyST_GetScope(PySTEntryObject *, PyObject *);
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000054
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000055PyAPI_FUNC(struct symtable *) PySymtable_Build(mod_ty, const char *,
56 PyFutureFeatures *);
57PyAPI_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 */
67#define DEF_STAR 2<<3 /* parameter is star arg */
68#define DEF_DOUBLESTAR 2<<4 /* parameter is star-star arg */
69#define DEF_INTUPLE 2<<5 /* name defined in tuple in parameters */
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000070#define DEF_FREE 2<<6 /* name used but not defined in nested block */
Jeremy Hylton4b38da62001-02-02 18:19:15 +000071#define DEF_FREE_GLOBAL 2<<7 /* free variable is actually implicit global */
72#define DEF_FREE_CLASS 2<<8 /* free variable from class's method */
73#define DEF_IMPORT 2<<9 /* assignment occurred via import */
74
Jeremy Hylton99858b52001-02-28 23:03:39 +000075#define DEF_BOUND (DEF_LOCAL | DEF_PARAM | DEF_IMPORT)
76
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000077/* GLOBAL_EXPLICIT and GLOBAL_IMPLICIT are used internally by the symbol
78 table. GLOBAL is returned from PyST_GetScope() for either of them.
79 It is stored in ste_symbols at bits 12-14.
80*/
81#define SCOPE_OFF 11
82#define SCOPE_MASK 7
Jeremy Hylton4b38da62001-02-02 18:19:15 +000083
84#define LOCAL 1
85#define GLOBAL_EXPLICIT 2
86#define GLOBAL_IMPLICIT 3
87#define FREE 4
88#define CELL 5
89
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000090/* The following three names are used for the ste_unoptimized bit field */
Jeremy Hylton29906ee2001-02-27 04:23:34 +000091#define OPT_IMPORT_STAR 1
92#define OPT_EXEC 2
93#define OPT_BARE_EXEC 4
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000094#define OPT_TOPLEVEL 8 /* top-level names, including eval and exec */
95
96#define GENERATOR 1
97#define GENERATOR_EXPRESSION 2
Jeremy Hylton29906ee2001-02-27 04:23:34 +000098
Jeremy Hylton4b38da62001-02-02 18:19:15 +000099#ifdef __cplusplus
100}
101#endif
102#endif /* !Py_SYMTABLE_H */