Sort the #include lines for the include/... tree with the script.

[oota-llvm.git] / include / llvm / ValueSymbolTable.h

diff --git a/include/llvm/ValueSymbolTable.h b/include/llvm/ValueSymbolTable.h
index 515e054d5c53dacfcec2d3cd4a3f1d866334d137..7493736fee57a06d0c1cdabebb20a8bfa7c611b3 100644 (file)
--- a/include/llvm/ValueSymbolTable.h
+++ b/include/llvm/ValueSymbolTable.h
@@ -2,10 +2,8 @@
 //
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by Reid Spencer based on the original SymbolTable.h
-// written by the LLVM research group and re-written by Reid Spencer.
-// It is distributed under the University of Illinois Open Source License. 
-// See LICENSE.TXT for details.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
@@ -16,23 +14,36 @@
 #ifndef LLVM_VALUE_SYMBOL_TABLE_H
 #define LLVM_VALUE_SYMBOL_TABLE_H
 
+#include "llvm/ADT/StringMap.h"
+#include "llvm/Support/DataTypes.h"
 #include "llvm/Value.h"
-#include <map>
 
 namespace llvm {
+  template<typename ValueSubClass, typename ItemParentClass>
+        class SymbolTableListTraits;
+  class BasicBlock;
+  class Function;
+  class NamedMDNode;
+  class Module;
+  class StringRef;
 
 /// This class provides a symbol table of name/value pairs. It is essentially
 /// a std::map<std::string,Value*> but has a controlled interface provided by
 /// LLVM as well as ensuring uniqueness of names.
 ///
 class ValueSymbolTable {
-
+  friend class Value;
+  friend class SymbolTableListTraits<Argument, Function>;
+  friend class SymbolTableListTraits<BasicBlock, Function>;
+  friend class SymbolTableListTraits<Instruction, BasicBlock>;
+  friend class SymbolTableListTraits<Function, Module>;
+  friend class SymbolTableListTraits<GlobalVariable, Module>;
+  friend class SymbolTableListTraits<GlobalAlias, Module>;
 /// @name Types
 /// @{
 public:
-
   /// @brief A mapping of names to values.
-  typedef std::map<const std::string, Value *> ValueMap;
+  typedef StringMap<Value*> ValueMap;
 
   /// @brief An iterator over a ValueMap.
   typedef ValueMap::iterator iterator;
@@ -45,7 +56,7 @@ public:
 /// @{
 public:
 
-  ValueSymbolTable() : LastUnique(0) {}
+  ValueSymbolTable() : vmap(0), LastUnique(0) {}
   ~ValueSymbolTable();
 
 /// @}
@@ -53,11 +64,11 @@ public:
 /// @{
 public:
 
-  /// This method finds the value with the given \p name in the
+  /// This method finds the value with the given \p Name in the
   /// the symbol table. 
-  /// @returns the value associated with the \p name
+  /// @returns the value associated with the \p Name
   /// @brief Lookup a named Value.
-  Value *lookup(const std::string &name) const;
+  Value *lookup(StringRef Name) const { return vmap.lookup(Name); }
 
   /// @returns true iff the symbol table is empty
   /// @brief Determine if the symbol table is empty
@@ -66,12 +77,6 @@ public:
   /// @brief The number of name/type pairs is returned.
   inline unsigned size() const { return unsigned(vmap.size()); }
 
-  /// 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.
-  /// @brief Get a name unique to this symbol table
-  std::string getUniqueName(const std::string &BaseName) const;
-
   /// This function can be used from the debugger to display the
   /// content of the symbol table while debugging.
   /// @brief Print out symbol table on stderr
@@ -81,7 +86,6 @@ public:
 /// @name Iteration
 /// @{
 public:
-
   /// @brief Get an iterator that from the beginning of the symbol table.
   inline iterator begin() { return vmap.begin(); }
 
@@ -93,35 +97,27 @@ public:
 
   /// @brief Get a const_iterator to the end of the symbol table.
   inline const_iterator end() const { return vmap.end(); }
-
+  
 /// @}
 /// @name Mutators
 /// @{
-public:
-
-  /// This method will strip the symbol table of its names.
-  /// @brief Strip the symbol table.
-  bool strip();
-
+private:
   /// This method adds the provided value \p N to the symbol table.  The Value
   /// must have a name which is used to place the value in the symbol table. 
+  /// If the inserted name conflicts, this renames the value.
   /// @brief Add a named value to the symbol table
-  void insert(Value *Val);
-
-  /// This method removes a value from the symbol table. The name of the
-  /// Value is extracted from \p Val and used to lookup the Value in the
-  /// symbol table. If the Value is not in the symbol table, this method
-  /// returns false.
-  /// @returns true if \p Val was successfully erased, false otherwise
-  /// @brief Remove a value from the symbol table.
-  bool erase(Value* Val);
-
-  /// Given a value with a non-empty name, remove its existing
-  /// entry from the symbol table and insert a new one for Name.  This is
-  /// equivalent to doing "remove(V), V->Name = Name, insert(V)".
-  /// @brief Rename a value in the symbol table
-  bool rename(Value *V, const std::string &Name);
-
+  void reinsertValue(Value *V);
+    
+  /// createValueName - This method attempts to create a value name and insert
+  /// it into the symbol table with the specified name.  If it conflicts, it
+  /// auto-renames the name and returns that instead.
+  ValueName *createValueName(StringRef Name, Value *V);
+  
+  /// This method removes a value from the symbol table.  It leaves the
+  /// ValueName attached to the value, but it is no longer inserted in the
+  /// symtab.
+  void removeValueName(ValueName *V);
+  
 /// @}
 /// @name Internal Data
 /// @{
@@ -130,7 +126,6 @@ private:
   mutable uint32_t LastUnique; ///< Counter for tracking unique names
 
 /// @}
-
 };
 
 } // End llvm namespace