Jeremy Hylton | 4b38da6 | 2001-02-02 18:19:15 +0000 | [diff] [blame] | 1 | #ifndef Py_SYMTABLE_H |
| 2 | #define Py_SYMTABLE_H |
Neal Norwitz | 090b3dd | 2006-02-28 22:36:46 +0000 | [diff] [blame] | 3 | |
Jeremy Hylton | 4b38da6 | 2001-02-02 18:19:15 +0000 | [diff] [blame] | 4 | #ifdef __cplusplus |
| 5 | extern "C" { |
| 6 | #endif |
| 7 | |
Nick Coghlan | 650f0d0 | 2007-04-15 12:05:43 +0000 | [diff] [blame] | 8 | /* XXX(ncoghlan): This is a weird mix of public names and interpreter internal |
| 9 | * names. |
| 10 | */ |
| 11 | |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 12 | typedef enum _block_type { FunctionBlock, ClassBlock, ModuleBlock } |
Neal Norwitz | 62c2fac | 2005-10-24 00:30:44 +0000 | [diff] [blame] | 13 | _Py_block_ty; |
Jeremy Hylton | 4b38da6 | 2001-02-02 18:19:15 +0000 | [diff] [blame] | 14 | |
Jeremy Hylton | cb17ae8 | 2001-02-09 22:22:18 +0000 | [diff] [blame] | 15 | struct _symtable_entry; |
| 16 | |
Jeremy Hylton | 4b38da6 | 2001-02-02 18:19:15 +0000 | [diff] [blame] | 17 | struct symtable { |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 18 | const char *st_filename; /* name of file being compiled */ |
| 19 | struct _symtable_entry *st_cur; /* current symbol table entry */ |
| 20 | struct _symtable_entry *st_top; /* symbol table entry for module */ |
| 21 | PyObject *st_blocks; /* dict: map AST node addresses |
| 22 | * to symbol table entries */ |
| 23 | PyObject *st_stack; /* list: stack of namespace info */ |
| 24 | PyObject *st_global; /* borrowed ref to st_top->st_symbols */ |
| 25 | int st_nblocks; /* number of blocks used */ |
| 26 | PyObject *st_private; /* name of current class or NULL */ |
| 27 | PyFutureFeatures *st_future; /* module's future features */ |
Jeremy Hylton | 4b38da6 | 2001-02-02 18:19:15 +0000 | [diff] [blame] | 28 | }; |
| 29 | |
Jeremy Hylton | cb17ae8 | 2001-02-09 22:22:18 +0000 | [diff] [blame] | 30 | typedef struct _symtable_entry { |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 31 | PyObject_HEAD |
| 32 | PyObject *ste_id; /* int: key in ste_table->st_blocks */ |
| 33 | PyObject *ste_symbols; /* dict: variable names to flags */ |
| 34 | PyObject *ste_name; /* string: name of current block */ |
| 35 | PyObject *ste_varnames; /* list of variable names */ |
| 36 | PyObject *ste_children; /* list of child blocks */ |
| 37 | _Py_block_ty ste_type; /* module, class, or function */ |
| 38 | int ste_unoptimized; /* false if namespace is optimized */ |
| 39 | int ste_nested; /* true if block is nested */ |
| 40 | unsigned ste_free : 1; /* true if block has free variables */ |
| 41 | unsigned ste_child_free : 1; /* true if a child block has free vars, |
| 42 | including free refs to globals */ |
| 43 | unsigned ste_generator : 1; /* true if namespace is a generator */ |
| 44 | unsigned ste_varargs : 1; /* true if block has varargs */ |
| 45 | unsigned ste_varkeywords : 1; /* true if block has varkeywords */ |
| 46 | unsigned ste_returns_value : 1; /* true if namespace uses return with |
| 47 | an argument */ |
| 48 | int ste_lineno; /* first line of block */ |
| 49 | int ste_opt_lineno; /* lineno of last exec or import * */ |
| 50 | int ste_tmpname; /* counter for listcomp temp vars */ |
| 51 | struct symtable *ste_table; |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 52 | } PySTEntryObject; |
Jeremy Hylton | cb17ae8 | 2001-02-09 22:22:18 +0000 | [diff] [blame] | 53 | |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 54 | PyAPI_DATA(PyTypeObject) PySTEntry_Type; |
Jeremy Hylton | cb17ae8 | 2001-02-09 22:22:18 +0000 | [diff] [blame] | 55 | |
Christian Heimes | 90aa764 | 2007-12-19 02:45:37 +0000 | [diff] [blame] | 56 | #define PySTEntry_Check(op) (Py_TYPE(op) == &PySTEntry_Type) |
Jeremy Hylton | cb17ae8 | 2001-02-09 22:22:18 +0000 | [diff] [blame] | 57 | |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 58 | PyAPI_FUNC(int) PyST_GetScope(PySTEntryObject *, PyObject *); |
Jeremy Hylton | cb17ae8 | 2001-02-09 22:22:18 +0000 | [diff] [blame] | 59 | |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 60 | PyAPI_FUNC(struct symtable *) PySymtable_Build(mod_ty, const char *, |
| 61 | PyFutureFeatures *); |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 62 | PyAPI_FUNC(PySTEntryObject *) PySymtable_Lookup(struct symtable *, void *); |
| 63 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 64 | PyAPI_FUNC(void) PySymtable_Free(struct symtable *); |
Jeremy Hylton | 4b38da6 | 2001-02-02 18:19:15 +0000 | [diff] [blame] | 65 | |
Jeremy Hylton | 4b38da6 | 2001-02-02 18:19:15 +0000 | [diff] [blame] | 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 */ |
Jeremy Hylton | 81e9502 | 2007-02-27 06:50:52 +0000 | [diff] [blame] | 71 | #define DEF_NONLOCAL 2<<2 /* nonlocal stmt */ |
| 72 | #define USE 2<<3 /* name is used */ |
| 73 | #define DEF_STAR 2<<4 /* parameter is star arg */ |
| 74 | #define DEF_DOUBLESTAR 2<<5 /* parameter is star-star arg */ |
| 75 | #define DEF_INTUPLE 2<<6 /* name defined in tuple in parameters */ |
| 76 | #define DEF_FREE 2<<7 /* name used but not defined in nested block */ |
| 77 | #define DEF_FREE_GLOBAL 2<<8 /* free variable is actually implicit global */ |
| 78 | #define DEF_FREE_CLASS 2<<9 /* free variable from class's method */ |
| 79 | #define DEF_IMPORT 2<<10 /* assignment occurred via import */ |
Jeremy Hylton | 4b38da6 | 2001-02-02 18:19:15 +0000 | [diff] [blame] | 80 | |
Jeremy Hylton | 99858b5 | 2001-02-28 23:03:39 +0000 | [diff] [blame] | 81 | #define DEF_BOUND (DEF_LOCAL | DEF_PARAM | DEF_IMPORT) |
| 82 | |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 83 | /* GLOBAL_EXPLICIT and GLOBAL_IMPLICIT are used internally by the symbol |
Antoine Pitrou | 7f14f0d | 2010-05-09 16:14:21 +0000 | [diff] [blame] | 84 | table. GLOBAL is returned from PyST_GetScope() for either of them. |
Jeremy Hylton | 81e9502 | 2007-02-27 06:50:52 +0000 | [diff] [blame] | 85 | It is stored in ste_symbols at bits 12-15. |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 86 | */ |
Nick Coghlan | 650f0d0 | 2007-04-15 12:05:43 +0000 | [diff] [blame] | 87 | #define SCOPE_OFFSET 11 |
Jeremy Hylton | 81e9502 | 2007-02-27 06:50:52 +0000 | [diff] [blame] | 88 | #define SCOPE_MASK (DEF_GLOBAL | DEF_LOCAL | DEF_PARAM | DEF_NONLOCAL) |
Jeremy Hylton | 4b38da6 | 2001-02-02 18:19:15 +0000 | [diff] [blame] | 89 | |
| 90 | #define LOCAL 1 |
| 91 | #define GLOBAL_EXPLICIT 2 |
| 92 | #define GLOBAL_IMPLICIT 3 |
| 93 | #define FREE 4 |
| 94 | #define CELL 5 |
| 95 | |
Georg Brandl | 7cae87c | 2006-09-06 06:51:57 +0000 | [diff] [blame] | 96 | /* The following two names are used for the ste_unoptimized bit field */ |
Jeremy Hylton | 29906ee | 2001-02-27 04:23:34 +0000 | [diff] [blame] | 97 | #define OPT_IMPORT_STAR 1 |
Georg Brandl | 7cae87c | 2006-09-06 06:51:57 +0000 | [diff] [blame] | 98 | #define OPT_TOPLEVEL 2 /* top-level names, including eval and exec */ |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 99 | |
| 100 | #define GENERATOR 1 |
| 101 | #define GENERATOR_EXPRESSION 2 |
Jeremy Hylton | 29906ee | 2001-02-27 04:23:34 +0000 | [diff] [blame] | 102 | |
Jeremy Hylton | 4b38da6 | 2001-02-02 18:19:15 +0000 | [diff] [blame] | 103 | #ifdef __cplusplus |
| 104 | } |
| 105 | #endif |
| 106 | #endif /* !Py_SYMTABLE_H */ |