Include/symtable.h

   1 #ifndef Py_SYMTABLE_H
   2 #define Py_SYMTABLE_H
   3
   4 #ifdef __cplusplus
   5 extern "C" {
   6 #endif
   7
   8 typedef enum _block_type { FunctionBlock, ClassBlock, ModuleBlock }
   9     _Py_block_ty;
  10
  11 struct _symtable_entry;
  12
  13 struct symtable {
  14         const char *st_filename; /* name of file being compiled */
  15         struct _symtable_entry *st_cur; /* current symbol table entry */
  16         struct _symtable_entry *st_top; /* module entry */
  17         PyObject *st_symbols;    /* dictionary of symbol table entries */
  18         PyObject *st_stack;      /* stack of namespace info */
  19         PyObject *st_global;     /* borrowed ref to MODULE in st_symbols */
  20         int st_nblocks;          /* number of blocks */
  21         PyObject *st_private;        /* name of current class or NULL */
  22         PyFutureFeatures *st_future; /* module's future features */
  23 };
  24
  25 typedef struct _symtable_entry {
  26         PyObject_HEAD
  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 */
  30         PyObject *ste_varnames;  /* list of variable names */
  31         PyObject *ste_children;  /* list of child ids */
  32         _Py_block_ty ste_type;   /* module, class, or function */
  33         int ste_unoptimized;     /* false if namespace is optimized */
  34         int ste_nested;      /* 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 */
  41         unsigned ste_returns_value : 1;  /* true if namespace uses return with
  42                                             an argument */
  43         int ste_lineno;          /* first line of block */
  44         int ste_opt_lineno;      /* lineno of last exec or import * */
  45         struct symtable *ste_table;
  46 } PySTEntryObject;
  47
  48 PyAPI_DATA(PyTypeObject) PySTEntry_Type;
  49
  50 #define PySTEntry_Check(op) (Py_TYPE(op) == &PySTEntry_Type)
  51
  52 PyAPI_FUNC(int) PyST_GetScope(PySTEntryObject *, PyObject *);
  53
  54 PyAPI_FUNC(struct symtable *) PySymtable_Build(mod_ty, const char *,
  55                                               PyFutureFeatures *);
  56 PyAPI_FUNC(PySTEntryObject *) PySymtable_Lookup(struct symtable *, void *);
  57
  58 PyAPI_FUNC(void) PySymtable_Free(struct symtable *);
  59
  60 /* 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 */
  66 #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 */
  69
  70 #define DEF_BOUND (DEF_LOCAL | DEF_PARAM | DEF_IMPORT)
  71
  72 /* 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
  78
  79 #define LOCAL 1
  80 #define GLOBAL_EXPLICIT 2
  81 #define GLOBAL_IMPLICIT 3
  82 #define FREE 4
  83 #define CELL 5
  84
  85 /* The following three names are used for the ste_unoptimized bit field */
  86 #define OPT_IMPORT_STAR 1
  87 #define OPT_EXEC 2
  88 #define OPT_BARE_EXEC 4
  89 #define OPT_TOPLEVEL 8  /* top-level names, including eval and exec */
  90
  91 #define GENERATOR 1
  92 #define GENERATOR_EXPRESSION 2
  93
  94 #ifdef __cplusplus
  95 }
  96 #endif
  97 #endif /* !Py_SYMTABLE_H */