| Jeremy Hylton | 4b38da6 | 2001-02-02 18:19:15 +0000 | [diff] [blame] | 1 | #ifndef Py_SYMTABLE_H | 
|  | 2 | #define Py_SYMTABLE_H | 
|  | 3 | #ifdef __cplusplus | 
|  | 4 | extern "C" { | 
|  | 5 | #endif | 
|  | 6 |  | 
| Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 7 | typedef enum _block_type { FunctionBlock, ClassBlock, ModuleBlock } | 
| Neal Norwitz | 62c2fac | 2005-10-24 00:30:44 +0000 | [diff] [blame] | 8 | _Py_block_ty; | 
| Jeremy Hylton | 4b38da6 | 2001-02-02 18:19:15 +0000 | [diff] [blame] | 9 |  | 
| Jeremy Hylton | cb17ae8 | 2001-02-09 22:22:18 +0000 | [diff] [blame] | 10 | struct _symtable_entry; | 
|  | 11 |  | 
| Jeremy Hylton | 4b38da6 | 2001-02-02 18:19:15 +0000 | [diff] [blame] | 12 | struct symtable { | 
| Martin v. Löwis | 95292d6 | 2002-12-11 14:04:59 +0000 | [diff] [blame] | 13 | const char *st_filename; /* name of file being compiled */ | 
| Jeremy Hylton | cb17ae8 | 2001-02-09 22:22:18 +0000 | [diff] [blame] | 14 | struct _symtable_entry *st_cur; /* current symbol table entry */ | 
| Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 15 | struct _symtable_entry *st_top; /* module entry */ | 
| Jeremy Hylton | cb17ae8 | 2001-02-09 22:22:18 +0000 | [diff] [blame] | 16 | PyObject *st_symbols;    /* dictionary of symbol table entries */ | 
| Jeremy Hylton | 4b38da6 | 2001-02-02 18:19:15 +0000 | [diff] [blame] | 17 | PyObject *st_stack;      /* stack of namespace info */ | 
| Jeremy Hylton | 4b38da6 | 2001-02-02 18:19:15 +0000 | [diff] [blame] | 18 | PyObject *st_global;     /* borrowed ref to MODULE in st_symbols */ | 
| Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 19 | int st_nblocks;          /* number of blocks */ | 
| Neil Schemenauer | 8b528b2 | 2005-10-23 18:37:42 +0000 | [diff] [blame] | 20 | PyObject *st_private;        /* name of current class or NULL */ | 
| Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 21 | int st_tmpname;          /* temporary name counter */ | 
| Jeremy Hylton | 4db62b1 | 2001-02-27 19:07:02 +0000 | [diff] [blame] | 22 | PyFutureFeatures *st_future; /* module's future features */ | 
| Jeremy Hylton | 4b38da6 | 2001-02-02 18:19:15 +0000 | [diff] [blame] | 23 | }; | 
|  | 24 |  | 
| Jeremy Hylton | cb17ae8 | 2001-02-09 22:22:18 +0000 | [diff] [blame] | 25 | typedef struct _symtable_entry { | 
|  | 26 | PyObject_HEAD | 
| Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 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 */ | 
| Jeremy Hylton | cb17ae8 | 2001-02-09 22:22:18 +0000 | [diff] [blame] | 30 | PyObject *ste_varnames;  /* list of variable names */ | 
|  | 31 | PyObject *ste_children;  /* list of child ids */ | 
| Neal Norwitz | 62c2fac | 2005-10-24 00:30:44 +0000 | [diff] [blame] | 32 | _Py_block_ty ste_type;   /* module, class, or function */ | 
| Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 33 | int ste_unoptimized;     /* false if namespace is optimized */ | 
| Neal Norwitz | 8208b64 | 2006-01-07 21:25:23 +0000 | [diff] [blame^] | 34 | 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 Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 41 | int ste_lineno;          /* first line of block */ | 
| Jeremy Hylton | 2e2cded | 2001-03-22 03:57:58 +0000 | [diff] [blame] | 42 | int ste_opt_lineno;      /* lineno of last exec or import * */ | 
| Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 43 | int ste_tmpname;         /* counter for listcomp temp vars */ | 
| Jeremy Hylton | cb17ae8 | 2001-02-09 22:22:18 +0000 | [diff] [blame] | 44 | struct symtable *ste_table; | 
| Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 45 | } PySTEntryObject; | 
| Jeremy Hylton | cb17ae8 | 2001-02-09 22:22:18 +0000 | [diff] [blame] | 46 |  | 
| Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 47 | PyAPI_DATA(PyTypeObject) PySTEntry_Type; | 
| Jeremy Hylton | cb17ae8 | 2001-02-09 22:22:18 +0000 | [diff] [blame] | 48 |  | 
| Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 49 | #define PySTEntry_Check(op) ((op)->ob_type == &PySTEntry_Type) | 
| Jeremy Hylton | cb17ae8 | 2001-02-09 22:22:18 +0000 | [diff] [blame] | 50 |  | 
| Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 51 | PyAPI_FUNC(PySTEntryObject *) \ | 
| Neal Norwitz | 62c2fac | 2005-10-24 00:30:44 +0000 | [diff] [blame] | 52 | PySTEntry_New(struct symtable *, identifier, _Py_block_ty, void *, int); | 
| Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 53 | PyAPI_FUNC(int) PyST_GetScope(PySTEntryObject *, PyObject *); | 
| Jeremy Hylton | cb17ae8 | 2001-02-09 22:22:18 +0000 | [diff] [blame] | 54 |  | 
| Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 55 | PyAPI_FUNC(struct symtable *) PySymtable_Build(mod_ty, const char *, | 
|  | 56 | PyFutureFeatures *); | 
|  | 57 | PyAPI_FUNC(PySTEntryObject *) PySymtable_Lookup(struct symtable *, void *); | 
|  | 58 |  | 
| Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 59 | PyAPI_FUNC(void) PySymtable_Free(struct symtable *); | 
| Jeremy Hylton | 4b38da6 | 2001-02-02 18:19:15 +0000 | [diff] [blame] | 60 |  | 
| Jeremy Hylton | 4b38da6 | 2001-02-02 18:19:15 +0000 | [diff] [blame] | 61 | /* 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 Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 70 | #define DEF_FREE 2<<6          /* name used but not defined in nested block */ | 
| Jeremy Hylton | 4b38da6 | 2001-02-02 18:19:15 +0000 | [diff] [blame] | 71 | #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 Hylton | 99858b5 | 2001-02-28 23:03:39 +0000 | [diff] [blame] | 75 | #define DEF_BOUND (DEF_LOCAL | DEF_PARAM | DEF_IMPORT) | 
|  | 76 |  | 
| Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 77 | /* 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 Hylton | 4b38da6 | 2001-02-02 18:19:15 +0000 | [diff] [blame] | 83 |  | 
|  | 84 | #define LOCAL 1 | 
|  | 85 | #define GLOBAL_EXPLICIT 2 | 
|  | 86 | #define GLOBAL_IMPLICIT 3 | 
|  | 87 | #define FREE 4 | 
|  | 88 | #define CELL 5 | 
|  | 89 |  | 
| Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 90 | /* The following three names are used for the ste_unoptimized bit field */ | 
| Jeremy Hylton | 29906ee | 2001-02-27 04:23:34 +0000 | [diff] [blame] | 91 | #define OPT_IMPORT_STAR 1 | 
|  | 92 | #define OPT_EXEC 2 | 
|  | 93 | #define OPT_BARE_EXEC 4 | 
| Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 94 | #define OPT_TOPLEVEL 8  /* top-level names, including eval and exec */ | 
|  | 95 |  | 
|  | 96 | #define GENERATOR 1 | 
|  | 97 | #define GENERATOR_EXPRESSION 2 | 
| Jeremy Hylton | 29906ee | 2001-02-27 04:23:34 +0000 | [diff] [blame] | 98 |  | 
| Jeremy Hylton | 4b38da6 | 2001-02-02 18:19:15 +0000 | [diff] [blame] | 99 | #ifdef __cplusplus | 
|  | 100 | } | 
|  | 101 | #endif | 
|  | 102 | #endif /* !Py_SYMTABLE_H */ |