[llvm-commits] CVS: llvm/include/llvm/TypeSymbolTable.h ValueSymbolTable.h
Reid Spencer
reid at x10sys.com
Tue Jan 10 01:52:01 PST 2006
Changes in directory llvm/include/llvm:
TypeSymbolTable.h added (r1.1)
ValueSymbolTable.h added (r1.1)
---
Log message:
For PR411: http://llvm.cs.uiuc.edu/PR411 :
First step in refactoring the SymbolTable is to split it into two classes,
one for a symbol table of types and one for a symbol table of Values.
---
Diffs of the changes: (+290 -0)
TypeSymbolTable.h | 152 +++++++++++++++++++++++++++++++++++++++++++++++++++++
ValueSymbolTable.h | 138 ++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 290 insertions(+)
Index: llvm/include/llvm/TypeSymbolTable.h
diff -c /dev/null llvm/include/llvm/TypeSymbolTable.h:1.1
*** /dev/null Tue Jan 10 03:51:58 2006
--- llvm/include/llvm/TypeSymbolTable.h Tue Jan 10 03:51:48 2006
***************
*** 0 ****
--- 1,152 ----
+ //===-- llvm/TypeSymbolTable.h - Implement a Type Symtab --------*- C++ -*-===//
+ //
+ // The LLVM Compiler Infrastructure
+ //
+ // This file was developed by Reid Spencer based on the original SymbolTable
+ // implemented 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 implements the name/type symbol table for LLVM.
+ //
+ //===----------------------------------------------------------------------===//
+
+ #ifndef LLVM_TYPE_SYMBOL_TABLE_H
+ #define LLVM_TYPE_SYMBOL_TABLE_H
+
+ #include "llvm/Type.h"
+ #include <map>
+
+ namespace llvm {
+
+ /// This class provides a symbol table of name/type pairs with operations to
+ /// support constructing, searching and iterating over the symbol table. The
+ /// class derives from AbstractTypeUser so that the contents of the symbol
+ /// table can be updated when abstract types become concrete.
+ class TypeSymbolTable : public AbstractTypeUser {
+
+ /// @name Types
+ /// @{
+ public:
+
+ /// @brief A mapping of names to types.
+ typedef std::map<const std::string, const Type*> TypeMap;
+
+ /// @brief An iterator over the TypeMap.
+ typedef TypeMap::iterator iterator;
+
+ /// @brief A const_iterator over the TypeMap.
+ typedef TypeMap::const_iterator const_iterator;
+
+ /// @}
+ /// @name Constructors
+ /// @{
+ public:
+
+ TypeSymbolTable() {}
+ ~TypeSymbolTable();
+
+ /// @}
+ /// @name Accessors
+ /// @{
+ public:
+
+ /// Generates a unique name for a type based on the \p BaseName by
+ /// incrementing an integer and appending it to the name, if necessary
+ /// @returns the unique name
+ /// @brief Get a unique name for a type
+ std::string getUniqueName(const std::string &BaseName) const;
+
+ /// This method finds the type with the given \p name in the type map
+ /// and returns it.
+ /// @returns null if the name is not found, otherwise the Type
+ /// associated with the \p name.
+ /// @brief Lookup a type by name.
+ Type* lookup(const std::string& name) const;
+
+ /// @returns true iff the symbol table is empty.
+ /// @brief Determine if the symbol table is empty
+ inline bool empty() const { return tmap.empty(); }
+
+ /// @returns the size of the symbol table
+ /// @brief The number of name/type pairs is returned.
+ inline unsigned size() const { return unsigned(tmap.size()); }
+
+ /// 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
+ void dump() const;
+
+ /// @}
+ /// @name Iteration
+ /// @{
+ public:
+ /// Get an iterator to the start of the symbol table
+ inline iterator begin() { return tmap.begin(); }
+
+ /// @brief Get a const_iterator to the start of the symbol table
+ inline const_iterator begin() const { return tmap.begin(); }
+
+ /// Get an iterator to the end of the symbol talbe.
+ inline iterator end() { return tmap.end(); }
+
+ /// Get a const_iterator to the end of the symbol table.
+ inline const_iterator end() const { return tmap.end(); }
+
+ /// @}
+ /// @name Mutators
+ /// @{
+ public:
+
+ /// This method will strip the symbol table of its names
+ /// @brief Strip the symbol table.
+ bool strip();
+
+ /// Inserts a type into the symbol table with the specified name. There can be
+ /// a many-to-one mapping between names and types. This method allows a type
+ /// with an existing entry in the symbol table to get a new name.
+ /// @brief Insert a type under a new name.
+ void insert(const std::string &Name, const Type *Typ);
+
+ /// Remove a type at the specified position in the symbol table.
+ /// @returns the removed Type.
+ /// @returns the Type that was erased from the symbol table.
+ Type* erase(iterator TI);
+
+ /// Remove a specific Type from the symbol table. This isn't fast, linear
+ /// search, O(n), algorithm.
+ /// @returns true if the erase was successful (TI was found)
+ bool erase(Type* TI);
+
+ /// Rename a type. This ain't fast, we have to linearly search for it first.
+ /// @returns true if the rename was successful (type was found)
+ bool rename(Type* T, const std::string& new_name);
+
+ /// @}
+ /// @name AbstractTypeUser Methods
+ /// @{
+ private:
+ /// This function is called when one of the types in the type plane
+ /// is refined.
+ virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
+
+ /// This function markes a type as being concrete (defined).
+ virtual void typeBecameConcrete(const DerivedType *AbsTy);
+
+ /// @}
+ /// @name Internal Data
+ /// @{
+ private:
+ TypeMap tmap; ///< This is the mapping of names to types.
+ mutable unsigned long LastUnique; ///< Counter for tracking unique names
+
+ /// @}
+
+ };
+
+ } // End llvm namespace
+
+ #endif
+
Index: llvm/include/llvm/ValueSymbolTable.h
diff -c /dev/null llvm/include/llvm/ValueSymbolTable.h:1.1
*** /dev/null Tue Jan 10 03:52:01 2006
--- llvm/include/llvm/ValueSymbolTable.h Tue Jan 10 03:51:48 2006
***************
*** 0 ****
--- 1,138 ----
+ //===-- llvm/ValueSymbolTable.h - Implement a Value Symtab ------*- C++ -*-===//
+ //
+ // 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 implements the name/Value symbol table for LLVM.
+ //
+ //===----------------------------------------------------------------------===//
+
+ #ifndef LLVM_VALUE_SYMBOL_TABLE_H
+ #define LLVM_VALUE_SYMBOL_TABLE_H
+
+ #include "llvm/Value.h"
+ #include <map>
+
+ namespace llvm {
+
+ /// 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 {
+
+ /// @name Types
+ /// @{
+ public:
+
+ /// @brief A mapping of names to values.
+ typedef std::map<const std::string, Value *> ValueMap;
+
+ /// @brief An iterator over a ValueMap.
+ typedef ValueMap::iterator iterator;
+
+ /// @brief A const_iterator over a ValueMap.
+ typedef ValueMap::const_iterator const_iterator;
+
+ /// @}
+ /// @name Constructors
+ /// @{
+ public:
+
+ ValueSymbolTable() : LastUnique(0) {}
+ ~ValueSymbolTable();
+
+ /// @}
+ /// @name Accessors
+ /// @{
+ public:
+
+ /// This method finds the value with the given \p name in the
+ /// the symbol table.
+ /// @returns the value associated with the \p name
+ /// @brief Lookup a named Value.
+ Value *lookup(const std::string &name) const;
+
+ /// @returns true iff the symbol table is empty
+ /// @brief Determine if the symbol table is empty
+ inline bool empty() const { return vmap.empty(); }
+
+ /// @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
+ void dump() const;
+
+ /// @}
+ /// @name Iteration
+ /// @{
+ public:
+
+ /// @brief Get an iterator that from the beginning of the symbol table.
+ inline iterator begin() { return vmap.begin(); }
+
+ /// @brief Get a const_iterator that from the beginning of the symbol table.
+ inline const_iterator begin() const { return vmap.begin(); }
+
+ /// @brief Get an iterator to the end of the symbol table.
+ inline iterator end() { return vmap.end(); }
+
+ /// @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();
+
+ /// 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.
+ /// @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);
+
+ /// @}
+ /// @name Internal Data
+ /// @{
+ private:
+ ValueMap vmap; ///< The map that holds the symbol table.
+ mutable unsigned long LastUnique; ///< Counter for tracking unique names
+
+ /// @}
+
+ };
+
+ } // End llvm namespace
+
+ #endif
More information about the llvm-commits
mailing list