lib/VMCore/TypeSymbolTable.cpp

   1 //===-- TypeSymbolTable.cpp - Implement the TypeSymbolTable class ---------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the TypeSymbolTable class for the VMCore library.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/TypeSymbolTable.h"
  15 #include "llvm/DerivedTypes.h"
  16 #include "llvm/ADT/StringExtras.h"
  17 #include "llvm/Support/Streams.h"
  18 #include <algorithm>
  19 using namespace llvm;
  20
  21 #define DEBUG_SYMBOL_TABLE 0
  22 #define DEBUG_ABSTYPE 0
  23
  24 TypeSymbolTable::~TypeSymbolTable() {
  25   // Drop all abstract type references in the type plane...
  26   for (iterator TI = tmap.begin(), TE = tmap.end(); TI != TE; ++TI) {
  27     if (TI->second->isAbstract())   // If abstract, drop the reference...
  28       cast<DerivedType>(TI->second)->removeAbstractTypeUser(this);
  29   }
  30 }
  31
  32 std::string TypeSymbolTable::getUniqueName(const std::string &BaseName) const {
  33   std::string TryName = BaseName;
  34   const_iterator End = tmap.end();
  35
  36   // See if the name exists
  37   while (tmap.find(TryName) != End)            // Loop until we find a free
  38     TryName = BaseName + utostr(++LastUnique); // name in the symbol table
  39   return TryName;
  40 }
  41
  42 // lookup a type by name - returns null on failure
  43 Type* TypeSymbolTable::lookup(const std::string& Name) const {
  44   const_iterator TI = tmap.find(Name);
  45   if (TI != tmap.end())
  46     return const_cast<Type*>(TI->second);
  47   return 0;
  48 }
  49
  50 // remove - Remove a type from the symbol table...
  51 Type* TypeSymbolTable::remove(iterator Entry) {
  52   assert(Entry != tmap.end() && "Invalid entry to remove!");
  53
  54   const Type* Result = Entry->second;
  55
  56 #if DEBUG_SYMBOL_TABLE
  57   dump();
  58   cerr << " Removing Value: " << Result->getName() << "\n";
  59 #endif
  60
  61   tmap.erase(Entry);
  62
  63   // If we are removing an abstract type, remove the symbol table from it's use
  64   // list...
  65   if (Result->isAbstract()) {
  66 #if DEBUG_ABSTYPE
  67     cerr << "Removing abstract type from symtab"
  68          << Result->getDescription()
  69          << "\n";
  70 #endif
  71     cast<DerivedType>(Result)->removeAbstractTypeUser(this);
  72   }
  73
  74   return const_cast<Type*>(Result);
  75 }
  76
  77
  78 // insert - Insert a type into the symbol table with the specified name...
  79 void TypeSymbolTable::insert(const std::string& Name, const Type* T) {
  80   assert(T && "Can't insert null type into symbol table!");
  81
  82   if (tmap.insert(make_pair(Name, T)).second) {
  83     // Type inserted fine with no conflict.
  84
  85 #if DEBUG_SYMBOL_TABLE
  86     dump();
  87     cerr << " Inserted type: " << Name << ": " << T->getDescription() << "\n";
  88 #endif
  89   } else {
  90     // If there is a name conflict...
  91
  92     // Check to see if there is a naming conflict.  If so, rename this type!
  93     std::string UniqueName = Name;
  94     if (lookup(Name))
  95       UniqueName = getUniqueName(Name);
  96
  97 #if DEBUG_SYMBOL_TABLE
  98     dump();
  99     cerr << " Inserting type: " << UniqueName << ": "
 100         << T->getDescription() << "\n";
 101 #endif
 102
 103     // Insert the tmap entry
 104     tmap.insert(make_pair(UniqueName, T));
 105   }
 106
 107   // If we are adding an abstract type, add the symbol table to it's use list.
 108   if (T->isAbstract()) {
 109     cast<DerivedType>(T)->addAbstractTypeUser(this);
 110 #if DEBUG_ABSTYPE
 111     cerr << "Added abstract type to ST: " << T->getDescription() << "\n";
 112 #endif
 113   }
 114 }
 115
 116 // This function is called when one of the types in the type plane are refined
 117 void TypeSymbolTable::refineAbstractType(const DerivedType *OldType,
 118                                          const Type *NewType) {
 119
 120   // Loop over all of the types in the symbol table, replacing any references
 121   // to OldType with references to NewType.  Note that there may be multiple
 122   // occurrences, and although we only need to remove one at a time, it's
 123   // faster to remove them all in one pass.
 124   //
 125   for (iterator I = begin(), E = end(); I != E; ++I) {
 126     if (I->second == (Type*)OldType) {  // FIXME when Types aren't const.
 127 #if DEBUG_ABSTYPE
 128       cerr << "Removing type " << OldType->getDescription() << "\n";
 129 #endif
 130       OldType->removeAbstractTypeUser(this);
 131
 132       I->second = (Type*)NewType;  // TODO FIXME when types aren't const
 133       if (NewType->isAbstract()) {
 134 #if DEBUG_ABSTYPE
 135         cerr << "Added type " << NewType->getDescription() << "\n";
 136 #endif
 137         cast<DerivedType>(NewType)->addAbstractTypeUser(this);
 138       }
 139     }
 140   }
 141 }
 142
 143
 144 // Handle situation where type becomes Concreate from Abstract
 145 void TypeSymbolTable::typeBecameConcrete(const DerivedType *AbsTy) {
 146   // Loop over all of the types in the symbol table, dropping any abstract
 147   // type user entries for AbsTy which occur because there are names for the
 148   // type.
 149   for (iterator TI = begin(), TE = end(); TI != TE; ++TI)
 150     if (TI->second == const_cast<Type*>(static_cast<const Type*>(AbsTy)))
 151       AbsTy->removeAbstractTypeUser(this);
 152 }
 153
 154 static void DumpTypes(const std::pair<const std::string, const Type*>& T ) {
 155   cerr << "  '" << T.first << "' = ";
 156   T.second->dump();
 157   cerr << "\n";
 158 }
 159
 160 void TypeSymbolTable::dump() const {
 161   cerr << "TypeSymbolPlane: ";
 162   for_each(tmap.begin(), tmap.end(), DumpTypes);
 163 }
 164
 165 // vim: sw=2 ai