Fix spelling.
[oota-llvm.git] / include / llvm / SymbolTable.h
index bae9eb148122f345e5ccc23d567b55a0669476a8..7e13402064971e37310eecf4789c8d5089345509 100644 (file)
@@ -1,4 +1,4 @@
-//===-- llvm/SymbolTable.h - Implement a type planned symtab ------*- C++ -*-=//
+//===-- llvm/SymbolTable.h - Implement a type plane'd symtab ----*- C++ -*-===//
 //
 // This file implements a symbol table that has planed broken up by type.  
 // Identical types may have overlapping symbol names as long as they are 
@@ -9,7 +9,7 @@
 // searched.
 //
 // This chaining behavior does NOT affect iterators though: only the lookup 
-// method
+// method.
 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm/Value.h"
 #include <map>
 
-#ifndef NDEBUG             // Only for assertions
-#include "llvm/Type.h"
-#include "llvm/ConstPoolVals.h"
-#endif
-
-class Value;
-class Type;
-
-// TODO: Change this back to vector<map<const string, Value *> >
-// Make the vector be a data member, and base it on UniqueID's
-// That should be much more efficient!
-//
 class SymbolTable : public AbstractTypeUser,
-                   public map<const Type *, map<const string, Value *> > {
-  typedef map<const string, Value *> VarMap;
-  typedef map<const Type *, VarMap> super;
-
-  SymbolTable *ParentSymTab;
-
-  friend class SymTabValue;
-  inline void setParentSymTab(SymbolTable *P) { ParentSymTab = P; }
-
+                   public std::map<const Type *, 
+                                    std::map<const std::string, Value *> > {
 public:
+  typedef std::map<const std::string, Value *> VarMap;
+  typedef std::map<const Type *, VarMap> super;
+
   typedef VarMap::iterator type_iterator;
   typedef VarMap::const_iterator type_const_iterator;
 
-  inline SymbolTable(SymbolTable *P = 0) { ParentSymTab = P; }
+  inline SymbolTable() : InternallyInconsistent(false) {}
   ~SymbolTable();
 
-  SymbolTable *getParentSymTab() { return ParentSymTab; }
-
   // lookup - Returns null on failure...
-  Value *lookup(const Type *Ty, const string &name);
-
-  // find - returns end(Ty->getIDNumber()) on failure...
-  type_iterator type_find(const Type *Ty, const string &name);
-  type_iterator type_find(const Value *D);
+  Value *lookup(const Type *Ty, const std::string &name);
 
   // insert - Add named definition to the symbol table...
   inline void insert(Value *N) {
     assert(N->hasName() && "Value must be named to go into symbol table!");
-    insertEntry(N->getName(), N);
+    insertEntry(N->getName(), N->getType(), N);
+  }
+
+  void remove(Value *N);
+  Value *type_remove(const type_iterator &It) {
+    return removeEntry(find(It->second->getType()), It);
   }
 
   // insert - Insert a constant or type into the symbol table with the specified
   // name...  There can be a many to one mapping between names and
   // (constant/type)s.
   //
-  inline void insert(const string &Name, Value *V) {
-    assert((isa<Type>(V) || isa<ConstPoolVal>(V)) &&
+  inline void insert(const std::string &Name, Value *V) {
+    assert((isa<Type>(V) || isa<Constant>(V)) &&
           "Can only insert types and constants here!");
-    insertEntry(Name, V);
+    insertEntry(Name, V->getType(), V);
   }
 
-  void remove(Value *N);
-  Value *type_remove(const type_iterator &It);
+  /// remove - Remove a constant or type from the symbol table with the
+  /// specified name.
+  Value *remove(const std::string &Name, Value *V) {
+    iterator TI = find(V->getType());
+    return removeEntry(TI, TI->second.find(Name));
+  }
 
   // getUniqueName - Given a base name, return a string that is either equal to
   // it (or derived from it) that does not already occur in the symbol table for
   // the specified type.
   //
-  string getUniqueName(const Type *Ty, const string &BaseName);
+  std::string getUniqueName(const Type *Ty, const std::string &BaseName);
 
   inline unsigned type_size(const Type *TypeID) const {
     return find(TypeID)->second.size();
@@ -103,14 +90,35 @@ public:
     return find(TypeID)->second.end(); 
   }
 
+  void dump() const;  // Debug method, print out symbol table
+
 private:
+  // InternallyInconsistent - There are times when the symbol table is
+  // internally inconsistent with the rest of the program.  In this one case, a
+  // value exists with a Name, and it's not in the symbol table.  When we call
+  // V->setName(""), it tries to remove itself from the symbol table and dies.
+  // We know this is happening, and so if the flag InternallyInconsistent is
+  // set, removal from the symbol table is a noop.
+  //
+  bool InternallyInconsistent;
+
+  inline super::value_type operator[](const Type *Ty) {
+    assert(0 && "Should not use this operator to access symbol table!");
+    return super::value_type();
+  }
+
   // insertEntry - Insert a value into the symbol table with the specified
   // name...
   //
-  void insertEntry(const string &Name, Value *V);
+  void insertEntry(const std::string &Name, const Type *Ty, Value *V);
+
+  // removeEntry - Remove a value from the symbol table...
+  //
+  Value *removeEntry(iterator Plane, type_iterator Entry);
 
   // This function is called when one of the types in the type plane are refined
   virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
+  virtual void typeBecameConcrete(const DerivedType *AbsTy);
 };
 
 #endif