blob: a5f7652f9f02755cd2fc958bf3bcfd96b524cb93 [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 {
Martin v. Löwis95292d62002-12-11 14:04:59 +000014 const char *st_filename; /* name of file being compiled */
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000015 struct _symtable_entry *st_cur; /* current symbol table entry */
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000016 struct _symtable_entry *st_top; /* module entry */
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000017 PyObject *st_symbols; /* dictionary of symbol table entries */
Jeremy Hylton4b38da62001-02-02 18:19:15 +000018 PyObject *st_stack; /* stack of namespace info */
Jeremy Hylton4b38da62001-02-02 18:19:15 +000019 PyObject *st_global; /* borrowed ref to MODULE in st_symbols */
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000020 int st_nblocks; /* number of blocks */
Neil Schemenauer8b528b22005-10-23 18:37:42 +000021 PyObject *st_private; /* name of current class or NULL */
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 */
Benjamin Peterson025d9392008-08-17 01:27:30 +000034 int ste_nested; /* true if block is nested */
Neal Norwitz8208b642006-01-07 21:25:23 +000035 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 */
Georg Brandlddbaa662006-06-04 21:56:52 +000041 unsigned ste_returns_value : 1; /* true if namespace uses return with
42 an argument */
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000043 int ste_lineno; /* first line of block */
Jeremy Hylton2e2cded2001-03-22 03:57:58 +000044 int ste_opt_lineno; /* lineno of last exec or import * */
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000045 struct symtable *ste_table;
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000046} PySTEntryObject;
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000047
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000048PyAPI_DATA(PyTypeObject) PySTEntry_Type;
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000049
Christian Heimese93237d2007-12-19 02:37:44 +000050#define PySTEntry_Check(op) (Py_TYPE(op) == &PySTEntry_Type)
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000051
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000052PyAPI_FUNC(int) PyST_GetScope(PySTEntryObject *, PyObject *);
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000053
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000054PyAPI_FUNC(struct symtable *) PySymtable_Build(mod_ty, const char *,
55 PyFutureFeatures *);
56PyAPI_FUNC(PySTEntryObject *) PySymtable_Lookup(struct symtable *, void *);
57
Mark Hammond91a681d2002-08-12 07:21:58 +000058PyAPI_FUNC(void) PySymtable_Free(struct symtable *);
Jeremy Hylton4b38da62001-02-02 18:19:15 +000059
Jeremy Hylton4b38da62001-02-02 18:19:15 +000060/* Flags for def-use information */
61
62#define DEF_GLOBAL 1 /* global stmt */
63#define DEF_LOCAL 2 /* assignment in code block */
64#define DEF_PARAM 2<<1 /* formal parameter */
65#define USE 2<<2 /* name is used */
Benjamin Peterson94819cf2009-06-23 03:01:56 +000066#define DEF_FREE 2<<3 /* name used but not defined in nested block */
67#define DEF_FREE_CLASS 2<<4 /* free variable from class's method */
68#define DEF_IMPORT 2<<5 /* assignment occurred via import */
Jeremy Hylton4b38da62001-02-02 18:19:15 +000069
Jeremy Hylton99858b52001-02-28 23:03:39 +000070#define DEF_BOUND (DEF_LOCAL | DEF_PARAM | DEF_IMPORT)
71
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000072/* GLOBAL_EXPLICIT and GLOBAL_IMPLICIT are used internally by the symbol
73 table. GLOBAL is returned from PyST_GetScope() for either of them.
74 It is stored in ste_symbols at bits 12-14.
75*/
76#define SCOPE_OFF 11
77#define SCOPE_MASK 7
Jeremy Hylton4b38da62001-02-02 18:19:15 +000078
79#define LOCAL 1
80#define GLOBAL_EXPLICIT 2
81#define GLOBAL_IMPLICIT 3
82#define FREE 4
83#define CELL 5
84
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000085/* The following three names are used for the ste_unoptimized bit field */
Jeremy Hylton29906ee2001-02-27 04:23:34 +000086#define OPT_IMPORT_STAR 1
87#define OPT_EXEC 2
88#define OPT_BARE_EXEC 4
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000089#define OPT_TOPLEVEL 8 /* top-level names, including eval and exec */
90
91#define GENERATOR 1
92#define GENERATOR_EXPRESSION 2
Jeremy Hylton29906ee2001-02-27 04:23:34 +000093
Jeremy Hylton4b38da62001-02-02 18:19:15 +000094#ifdef __cplusplus
95}
96#endif
97#endif /* !Py_SYMTABLE_H */