1 //===-- llvm/ValueSymbolTable.h - Implement a Value Symtab ------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the name/Value symbol table for LLVM.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_VALUE_SYMBOL_TABLE_H
15 #define LLVM_VALUE_SYMBOL_TABLE_H
17 #include "llvm/Value.h"
18 #include "llvm/ADT/StringMap.h"
19 #include "llvm/Support/DataTypes.h"
22 template<typename ValueSubClass, typename ItemParentClass>
23 class SymbolTableListTraits;
28 /// This class provides a symbol table of name/value pairs. It is essentially
29 /// a std::map<std::string,Value*> but has a controlled interface provided by
30 /// LLVM as well as ensuring uniqueness of names.
32 class ValueSymbolTable {
34 friend class SymbolTableListTraits<Argument, Function>;
35 friend class SymbolTableListTraits<BasicBlock, Function>;
36 friend class SymbolTableListTraits<Instruction, BasicBlock>;
37 friend class SymbolTableListTraits<Function, Module>;
38 friend class SymbolTableListTraits<GlobalVariable, Module>;
39 friend class SymbolTableListTraits<GlobalAlias, Module>;
43 /// @brief A mapping of names to values.
44 typedef StringMap<Value*> ValueMap;
46 /// @brief An iterator over a ValueMap.
47 typedef ValueMap::iterator iterator;
49 /// @brief A const_iterator over a ValueMap.
50 typedef ValueMap::const_iterator const_iterator;
53 /// @name Constructors
57 ValueSymbolTable() : vmap(0), LastUnique(0) {}
65 /// This method finds the value with the given \p name in the
67 /// @returns the value associated with the \p name
68 /// @brief Lookup a named Value.
69 Value *lookup(const std::string &name) const;
71 /// @returns true iff the symbol table is empty
72 /// @brief Determine if the symbol table is empty
73 inline bool empty() const { return vmap.empty(); }
75 /// @brief The number of name/type pairs is returned.
76 inline unsigned size() const { return unsigned(vmap.size()); }
78 /// Given a base name, return a string that is either equal to it or
79 /// derived from it that does not already occur in the symbol table
80 /// for the specified type.
81 /// @brief Get a name unique to this symbol table
82 std::string getUniqueName(const std::string &BaseName) const;
84 /// This function can be used from the debugger to display the
85 /// content of the symbol table while debugging.
86 /// @brief Print out symbol table on stderr
93 /// @brief Get an iterator that from the beginning of the symbol table.
94 inline iterator begin() { return vmap.begin(); }
96 /// @brief Get a const_iterator that from the beginning of the symbol table.
97 inline const_iterator begin() const { return vmap.begin(); }
99 /// @brief Get an iterator to the end of the symbol table.
100 inline iterator end() { return vmap.end(); }
102 /// @brief Get a const_iterator to the end of the symbol table.
103 inline const_iterator end() const { return vmap.end(); }
109 /// This method adds the provided value \p N to the symbol table. The Value
110 /// must have a name which is used to place the value in the symbol table.
111 /// If the inserted name conflicts, this renames the value.
112 /// @brief Add a named value to the symbol table
113 void reinsertValue(Value *V);
115 /// createValueName - This method attempts to create a value name and insert
116 /// it into the symbol table with the specified name. If it conflicts, it
117 /// auto-renames the name and returns that instead.
118 ValueName *createValueName(const char *NameStart, unsigned NameLen, Value *V);
120 /// This method removes a value from the symbol table. It leaves the
121 /// ValueName attached to the value, but it is no longer inserted in the
123 void removeValueName(ValueName *V);
126 /// @name Internal Data
129 ValueMap vmap; ///< The map that holds the symbol table.
130 mutable uint32_t LastUnique; ///< Counter for tracking unique names
135 } // End llvm namespace