*** empty log message ***
[oota-llvm.git] / include / llvm / Module.h
index 8223f6f61257e406af66c3bc6ad5e0422b0bbbfe..b34c06b9f57a0b07fc81d929a1f4933a81df76cc 100644 (file)
 #ifndef LLVM_MODULE_H
 #define LLVM_MODULE_H
 
-#include "llvm/Value.h"
-#include "llvm/SymTabValue.h"
-#include "llvm/ValueHolder.h"
+#include "llvm/Function.h"
+#include "llvm/GlobalVariable.h"
 class GlobalVariable;
 class GlobalValueRefMap;   // Used by ConstantVals.cpp
 class ConstantPointerRef;
+class FunctionType;
+class SymbolTable;
+
+template<> struct ilist_traits<Function>
+  : public SymbolTableListTraits<Function, Module, Module> {
+  // createNode is used to create a node that marks the end of the list...
+  static Function *createNode();
+  static iplist<Function> &getList(Module *M);
+};
+template<> struct ilist_traits<GlobalVariable>
+  : public SymbolTableListTraits<GlobalVariable, Module, Module> {
+  // createNode is used to create a node that marks the end of the list...
+  static GlobalVariable *createNode();
+  static iplist<GlobalVariable> &getList(Module *M);
+};
 
-class Module : public Value, public SymTabValue {
+class Module : public Annotable {
 public:
-  typedef ValueHolder<GlobalVariable, Module, Module> GlobalListType;
-  typedef ValueHolder<Function, Module, Module> FunctionListType;
+  typedef iplist<GlobalVariable> GlobalListType;
+  typedef iplist<Function> FunctionListType;
 
   // Global Variable iterators...
   typedef GlobalListType::iterator                             giterator;
@@ -42,30 +56,68 @@ private:
 
   GlobalValueRefMap *GVRefMap;
 
+  SymbolTable *SymTab;
+
   // Accessor for the underlying GlobalValRefMap... only through the
   // ConstantPointerRef class...
   friend class ConstantPointerRef;
   void mutateConstantPointerRef(GlobalValue *OldGV, GlobalValue *NewGV);
   ConstantPointerRef *getConstantPointerRef(GlobalValue *GV);
+  void destroyConstantPointerRef(ConstantPointerRef *CPR);
 
 public:
   Module();
   ~Module();
 
-  // reduceApply - Apply the specified function to all of the methods in this 
-  // module.  The result values are or'd together and the result is returned.
-  //
-  bool reduceApply(bool (*Func)(GlobalVariable*));
-  bool reduceApply(bool (*Func)(const GlobalVariable*)) const;
-  bool reduceApply(bool (*Func)(Function*));
-  bool reduceApply(bool (*Func)(const Function*)) const;
+  /// getOrInsertFunction - Look up the specified function in the module symbol
+  /// table.  If it does not exist, add a prototype for the function and return
+  /// it.
+  Function *getOrInsertFunction(const std::string &Name, const FunctionType *T);
+
+  /// getFunction - Look up the specified function in the module symbol table.
+  /// If it does not exist, return null.
+  ///
+  Function *getFunction(const std::string &Name, const FunctionType *Ty);
+
+  /// addTypeName - Insert an entry in the symbol table mapping Str to Type.  If
+  /// there is already an entry for this name, true is returned and the symbol
+  /// table is not modified.
+  ///
+  bool addTypeName(const std::string &Name, const Type *Ty);
+
+  /// getTypeName - If there is at least one entry in the symbol table for the
+  /// specified type, return it.
+  ///
+  std::string getTypeName(const Type *Ty);
 
-  // Get the underlying elements of the Module...
+  /// Get the underlying elements of the Module...
   inline const GlobalListType &getGlobalList() const  { return GlobalList; }
   inline       GlobalListType &getGlobalList()        { return GlobalList; }
   inline const FunctionListType &getFunctionList() const { return FunctionList;}
   inline       FunctionListType &getFunctionList()       { return FunctionList;}
 
+
+  //===--------------------------------------------------------------------===//
+  // Symbol table support functions...
+  
+  /// hasSymbolTable() - Returns true if there is a symbol table allocated to
+  /// this object AND if there is at least one name in it!
+  ///
+  bool hasSymbolTable() const;
+
+  /// getSymbolTable() - CAUTION: The current symbol table may be null if there
+  /// are no names (ie, the symbol table is empty)
+  ///
+  inline       SymbolTable *getSymbolTable()       { return SymTab; }
+  inline const SymbolTable *getSymbolTable() const { return SymTab; }
+  
+  /// getSymbolTableSure is guaranteed to not return a null pointer, because if
+  /// the method does not already have a symtab, one is created.  Use this if
+  /// you intend to put something into the symbol table for the method.
+  ///
+  SymbolTable *getSymbolTableSure();
+
+
   //===--------------------------------------------------------------------===//
   // Module iterator forwarding functions
   //
@@ -81,10 +133,10 @@ public:
 
   inline unsigned                  gsize() const { return GlobalList.size(); }
   inline bool                     gempty() const { return GlobalList.empty(); }
-  inline const GlobalVariable    *gfront() const { return GlobalList.front(); }
-  inline       GlobalVariable    *gfront()       { return GlobalList.front(); }
-  inline const GlobalVariable     *gback() const { return GlobalList.back(); }
-  inline       GlobalVariable     *gback()       { return GlobalList.back(); }
+  inline const GlobalVariable    &gfront() const { return GlobalList.front(); }
+  inline       GlobalVariable    &gfront()       { return GlobalList.front(); }
+  inline const GlobalVariable     &gback() const { return GlobalList.back(); }
+  inline       GlobalVariable     &gback()       { return GlobalList.back(); }
 
 
 
@@ -100,26 +152,33 @@ public:
 
   inline unsigned                 size() const { return FunctionList.size(); }
   inline bool                    empty() const { return FunctionList.empty(); }
-  inline const Function         *front() const { return FunctionList.front(); }
-  inline       Function         *front()       { return FunctionList.front(); }
-  inline const Function          *back() const { return FunctionList.back(); }
-  inline       Function          *back()       { return FunctionList.back(); }
-
-  // Methods for support type inquiry through isa, cast, and dyn_cast:
-  static inline bool classof(const Module *T) { return true; }
-  static inline bool classof(const Value *V) {
-    return V->getValueType() == Value::ModuleVal;
-  }
-
-  // dropAllReferences() - This function causes all the subinstructions to "let
-  // go" of all references that they are maintaining.  This allows one to
-  // 'delete' a whole class at a time, even though there may be circular
-  // references... first all references are dropped, and all use counts go to
-  // zero.  Then everything is delete'd for real.  Note that no operations are
-  // valid on an object that has "dropped all references", except operator 
-  // delete.
-  //
+  inline const Function         &front() const { return FunctionList.front(); }
+  inline       Function         &front()       { return FunctionList.front(); }
+  inline const Function          &back() const { return FunctionList.back(); }
+  inline       Function          &back()       { return FunctionList.back(); }
+
+  void print(std::ostream &OS) const;
+  void dump() const;
+
+  /// dropAllReferences() - This function causes all the subinstructions to "let
+  /// go" of all references that they are maintaining.  This allows one to
+  /// 'delete' a whole class at a time, even though there may be circular
+  /// references... first all references are dropped, and all use counts go to
+  /// zero.  Then everything is delete'd for real.  Note that no operations are
+  /// valid on an object that has "dropped all references", except operator 
+  /// delete.
+  ///
   void dropAllReferences();
 };
 
+inline std::ostream &operator<<(std::ostream &O, const Module *M) {
+  M->print(O);
+  return O;
+}
+
+inline std::ostream &operator<<(std::ostream &O, const Module &M) {
+  M.print(O);
+  return O;
+}
+
 #endif