blob: 6ed3a2b06ce6c35f82b1c851d7ec63a6e8cd59c2 [file] [log] [blame]
Martin v. Löwis4d0d4712010-12-03 20:14:31 +00001#ifndef Py_LIMITED_API
Jeremy Hylton4b38da62001-02-02 18:19:15 +00002#ifndef Py_SYMTABLE_H
3#define Py_SYMTABLE_H
Neal Norwitz090b3dd2006-02-28 22:36:46 +00004
Jeremy Hylton4b38da62001-02-02 18:19:15 +00005#ifdef __cplusplus
6extern "C" {
7#endif
8
Nick Coghlan650f0d02007-04-15 12:05:43 +00009/* XXX(ncoghlan): This is a weird mix of public names and interpreter internal
10 * names.
11 */
12
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000013typedef enum _block_type { FunctionBlock, ClassBlock, ModuleBlock }
Neal Norwitz62c2fac2005-10-24 00:30:44 +000014 _Py_block_ty;
Jeremy Hylton4b38da62001-02-02 18:19:15 +000015
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000016struct _symtable_entry;
17
Jeremy Hylton4b38da62001-02-02 18:19:15 +000018struct symtable {
Victor Stinner00676d12010-12-27 01:49:31 +000019 const char *st_filename; /* name of file being compiled,
20 decoded from the filesystem encoding */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000021 struct _symtable_entry *st_cur; /* current symbol table entry */
22 struct _symtable_entry *st_top; /* symbol table entry for module */
23 PyObject *st_blocks; /* dict: map AST node addresses
24 * to symbol table entries */
25 PyObject *st_stack; /* list: stack of namespace info */
Eli Benderskydd97fbb2011-04-10 07:37:26 +030026 PyObject *st_global; /* borrowed ref to st_top->ste_symbols */
27 int st_nblocks; /* number of blocks used. kept for
28 consistency with the corresponding
29 compiler structure */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000030 PyObject *st_private; /* name of current class or NULL */
Eli Benderskydd97fbb2011-04-10 07:37:26 +030031 PyFutureFeatures *st_future; /* module's future features that affect
32 the symbol table */
Nick Coghlanaab9c2b2012-11-04 23:14:34 +100033 int recursion_depth; /* current recursion depth */
34 int recursion_limit; /* recursion limit */
Jeremy Hylton4b38da62001-02-02 18:19:15 +000035};
36
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000037typedef struct _symtable_entry {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000038 PyObject_HEAD
39 PyObject *ste_id; /* int: key in ste_table->st_blocks */
40 PyObject *ste_symbols; /* dict: variable names to flags */
41 PyObject *ste_name; /* string: name of current block */
Eli Benderskydd97fbb2011-04-10 07:37:26 +030042 PyObject *ste_varnames; /* list of function parameters */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000043 PyObject *ste_children; /* list of child blocks */
44 _Py_block_ty ste_type; /* module, class, or function */
45 int ste_unoptimized; /* false if namespace is optimized */
46 int ste_nested; /* true if block is nested */
47 unsigned ste_free : 1; /* true if block has free variables */
48 unsigned ste_child_free : 1; /* true if a child block has free vars,
49 including free refs to globals */
50 unsigned ste_generator : 1; /* true if namespace is a generator */
51 unsigned ste_varargs : 1; /* true if block has varargs */
52 unsigned ste_varkeywords : 1; /* true if block has varkeywords */
53 unsigned ste_returns_value : 1; /* true if namespace uses return with
54 an argument */
55 int ste_lineno; /* first line of block */
Benjamin Petersond4efd9e2010-09-20 23:02:10 +000056 int ste_col_offset; /* offset of first line of block */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000057 int ste_opt_lineno; /* lineno of last exec or import * */
Benjamin Petersond4efd9e2010-09-20 23:02:10 +000058 int ste_opt_col_offset; /* offset of last exec or import * */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000059 int ste_tmpname; /* counter for listcomp temp vars */
60 struct symtable *ste_table;
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000061} PySTEntryObject;
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000062
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000063PyAPI_DATA(PyTypeObject) PySTEntry_Type;
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000064
Christian Heimes90aa7642007-12-19 02:45:37 +000065#define PySTEntry_Check(op) (Py_TYPE(op) == &PySTEntry_Type)
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000066
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000067PyAPI_FUNC(int) PyST_GetScope(PySTEntryObject *, PyObject *);
Jeremy Hyltoncb17ae82001-02-09 22:22:18 +000068
Victor Stinner00676d12010-12-27 01:49:31 +000069PyAPI_FUNC(struct symtable *) PySymtable_Build(
70 mod_ty mod,
71 const char *filename, /* decoded from the filesystem encoding */
72 PyFutureFeatures *future);
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000073PyAPI_FUNC(PySTEntryObject *) PySymtable_Lookup(struct symtable *, void *);
74
Mark Hammond91a681d2002-08-12 07:21:58 +000075PyAPI_FUNC(void) PySymtable_Free(struct symtable *);
Jeremy Hylton4b38da62001-02-02 18:19:15 +000076
Jeremy Hylton4b38da62001-02-02 18:19:15 +000077/* Flags for def-use information */
78
79#define DEF_GLOBAL 1 /* global stmt */
80#define DEF_LOCAL 2 /* assignment in code block */
81#define DEF_PARAM 2<<1 /* formal parameter */
Jeremy Hylton81e95022007-02-27 06:50:52 +000082#define DEF_NONLOCAL 2<<2 /* nonlocal stmt */
83#define USE 2<<3 /* name is used */
Benjamin Peterson78565b22009-06-28 19:19:51 +000084#define DEF_FREE 2<<4 /* name used but not defined in nested block */
85#define DEF_FREE_CLASS 2<<5 /* free variable from class's method */
86#define DEF_IMPORT 2<<6 /* assignment occurred via import */
Jeremy Hylton4b38da62001-02-02 18:19:15 +000087
Jeremy Hylton99858b52001-02-28 23:03:39 +000088#define DEF_BOUND (DEF_LOCAL | DEF_PARAM | DEF_IMPORT)
89
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000090/* GLOBAL_EXPLICIT and GLOBAL_IMPLICIT are used internally by the symbol
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000091 table. GLOBAL is returned from PyST_GetScope() for either of them.
Jeremy Hylton81e95022007-02-27 06:50:52 +000092 It is stored in ste_symbols at bits 12-15.
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000093*/
Nick Coghlan650f0d02007-04-15 12:05:43 +000094#define SCOPE_OFFSET 11
Jeremy Hylton81e95022007-02-27 06:50:52 +000095#define SCOPE_MASK (DEF_GLOBAL | DEF_LOCAL | DEF_PARAM | DEF_NONLOCAL)
Jeremy Hylton4b38da62001-02-02 18:19:15 +000096
97#define LOCAL 1
98#define GLOBAL_EXPLICIT 2
99#define GLOBAL_IMPLICIT 3
100#define FREE 4
101#define CELL 5
102
Georg Brandl7cae87c2006-09-06 06:51:57 +0000103/* The following two names are used for the ste_unoptimized bit field */
Jeremy Hylton29906ee2001-02-27 04:23:34 +0000104#define OPT_IMPORT_STAR 1
Georg Brandl7cae87c2006-09-06 06:51:57 +0000105#define OPT_TOPLEVEL 2 /* top-level names, including eval and exec */
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000106
107#define GENERATOR 1
108#define GENERATOR_EXPRESSION 2
Jeremy Hylton29906ee2001-02-27 04:23:34 +0000109
Jeremy Hylton4b38da62001-02-02 18:19:15 +0000110#ifdef __cplusplus
111}
112#endif
113#endif /* !Py_SYMTABLE_H */
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000114#endif /* Py_LIMITED_API */