include/llvm/SymbolTable.h

   1 //===-- llvm/SymbolTable.h - Implement a type plane'd symtab ------*- C++ -*-=//
   2 //
   3 // This file implements a symbol table that has planed broken up by type.
   4 // Identical types may have overlapping symbol names as long as they are
   5 // distinct.
   6 //
   7 // Note that this implements a chained symbol table.  If a name being 'lookup'd
   8 // isn't found in the current symbol table, then the parent symbol table is
   9 // searched.
  10 //
  11 // This chaining behavior does NOT affect iterators though: only the lookup
  12 // method
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_SYMBOL_TABLE_H
  17 #define LLVM_SYMBOL_TABLE_H
  18
  19 #include "llvm/Value.h"
  20 #include "llvm/Type.h"              // FIXME: Remove
  21 #include "llvm/ConstantVals.h"      // FIXME: Remove
  22 #include <map>
  23
  24 class SymbolTable : public AbstractTypeUser,
  25                     public std::map<const Type *,
  26                                     std::map<const std::string, Value *> > {
  27 public:
  28   typedef std::map<const std::string, Value *> VarMap;
  29   typedef std::map<const Type *, VarMap> super;
  30 private:
  31
  32   SymbolTable *ParentSymTab;
  33
  34   friend class SymTabValue;
  35   inline void setParentSymTab(SymbolTable *P) { ParentSymTab = P; }
  36
  37 public:
  38   typedef VarMap::iterator type_iterator;
  39   typedef VarMap::const_iterator type_const_iterator;
  40
  41   inline SymbolTable(SymbolTable *P = 0) {
  42     ParentSymTab = P;
  43     InternallyInconsistent = false;
  44   }
  45   ~SymbolTable();
  46
  47   SymbolTable *getParentSymTab() { return ParentSymTab; }
  48
  49   // lookup - Returns null on failure...
  50   Value *lookup(const Type *Ty, const std::string &name);
  51
  52   // localLookup - Look in this symbol table without falling back on parent,
  53   // if non-existing.  Returns null on failure...
  54   //
  55   Value *localLookup(const Type *Ty, const std::string &name);
  56
  57   // insert - Add named definition to the symbol table...
  58   inline void insert(Value *N) {
  59     assert(N->hasName() && "Value must be named to go into symbol table!");
  60     insertEntry(N->getName(), N->getType(), N);
  61   }
  62
  63   // insert - Insert a constant or type into the symbol table with the specified
  64   // name...  There can be a many to one mapping between names and
  65   // (constant/type)s.
  66   //
  67   inline void insert(const std::string &Name, Value *V) {
  68     assert((isa<Type>(V) || isa<Constant>(V)) &&
  69            "Can only insert types and constants here!");
  70     insertEntry(Name, V->getType(), V);
  71   }
  72
  73   void remove(Value *N);
  74   Value *type_remove(const type_iterator &It) {
  75     return removeEntry(find(It->second->getType()), It);
  76   }
  77
  78   // getUniqueName - Given a base name, return a string that is either equal to
  79   // it (or derived from it) that does not already occur in the symbol table for
  80   // the specified type.
  81   //
  82   std::string getUniqueName(const Type *Ty, const std::string &BaseName);
  83
  84   inline unsigned type_size(const Type *TypeID) const {
  85     return find(TypeID)->second.size();
  86   }
  87
  88   // Note that type_begin / type_end only work if you know that an element of
  89   // TypeID is already in the symbol table!!!
  90   //
  91   inline type_iterator type_begin(const Type *TypeID) {
  92     return find(TypeID)->second.begin();
  93   }
  94   inline type_const_iterator type_begin(const Type *TypeID) const {
  95     return find(TypeID)->second.begin();
  96   }
  97
  98   inline type_iterator type_end(const Type *TypeID) {
  99     return find(TypeID)->second.end();
 100   }
 101   inline type_const_iterator type_end(const Type *TypeID) const {
 102     return find(TypeID)->second.end();
 103   }
 104
 105   void dump() const;  // Debug method, print out symbol table
 106
 107 private:
 108   // InternallyInconsistent - There are times when the symbol table is
 109   // internally inconsistent with the rest of the program.  In this one case, a
 110   // value exists with a Name, and it's not in the symbol table.  When we call
 111   // V->setName(""), it tries to remove itself from the symbol table and dies.
 112   // We know this is happening, and so if the flag InternallyInconsistent is
 113   // set, removal from the symbol table is a noop.
 114   //
 115   bool InternallyInconsistent;
 116
 117   inline super::value_type operator[](const Type *Ty) {
 118     assert(0 && "Should not use this operator to access symbol table!");
 119     return super::value_type();
 120   }
 121
 122   // insertEntry - Insert a value into the symbol table with the specified
 123   // name...
 124   //
 125   void insertEntry(const std::string &Name, const Type *Ty, Value *V);
 126
 127   // removeEntry - Remove a value from the symbol table...
 128   //
 129   Value *removeEntry(iterator Plane, type_iterator Entry);
 130
 131   // This function is called when one of the types in the type plane are refined
 132   virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
 133 };
 134
 135 #endif