Materialize the module before releasing it.

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

diff --git a/include/llvm/Module.h b/include/llvm/Module.h
index 2b8c0ab5d0eb1c80cd7d06b3eea923a056a4d47d..4afcc4bd0fa95b6009762bca73974b9c5f3d9c83 100644 (file)
--- a/include/llvm/Module.h
+++ b/include/llvm/Module.h
@@ -33,8 +33,7 @@ template<> struct ilist_traits<GlobalVariable>
   static iplist<GlobalVariable> &getList(Module *M);
 };
 
-class Module : public Annotable {
-public:
+struct Module : public Annotable {
   typedef iplist<GlobalVariable> GlobalListType;
   typedef iplist<Function> FunctionListType;
 
@@ -45,21 +44,27 @@ public:
   typedef std::reverse_iterator<const_giterator> const_reverse_giterator;
 
   // Function iterators...
-  typedef FunctionListType::iterator                            iterator;
-  typedef FunctionListType::const_iterator                const_iterator;
+  typedef FunctionListType::iterator                          iterator;
+  typedef FunctionListType::const_iterator              const_iterator;
   typedef std::reverse_iterator<iterator>             reverse_iterator;
   typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
 
-private:
-  GlobalListType GlobalList;     // The Global Variables
-  FunctionListType FunctionList;     // The Functions
-
-  GlobalValueRefMap *GVRefMap;
+  enum Endianness  { AnyEndianness, LittleEndian, BigEndian };
+  enum PointerSize { AnyPointerSize, Pointer32, Pointer64 };
 
-  SymbolTable *SymTab;
-
-  // Accessor for the underlying GlobalValRefMap... only through the
-  // Constant class...
+private:
+  GlobalListType GlobalList;     // The Global Variables in the module
+  FunctionListType FunctionList; // The Functions in the module
+  GlobalValueRefMap *GVRefMap;   // Keep track of GlobalValueRef's
+  SymbolTable *SymTab;           // Symbol Table for the module
+  std::string ModuleID;    // Human readable identifier for the module
+
+  // These flags are probably not the right long-term way to handle this kind of
+  // target information, but it is sufficient for now.
+  Endianness  Endian;       // True if target is little endian
+  PointerSize PtrSize;    // True if target has 32-bit pointers (false = 64-bit)
+
+  // Accessor for the underlying GVRefMap... only through the Constant class...
   friend class Constant;
   friend class ConstantPointerRef;
   void mutateConstantPointerRef(GlobalValue *OldGV, GlobalValue *NewGV);
@@ -67,19 +72,47 @@ private:
   void destroyConstantPointerRef(ConstantPointerRef *CPR);
 
 public:
-  Module();
+  Module(const std::string &ModuleID);
   ~Module();
 
+  const std::string &getModuleIdentifier() const { return ModuleID; }
+
+  /// Target endian information...
+  Endianness getEndianness() const { return Endian; }
+  void setEndianness(Endianness E) { Endian = E; }
+
+  /// Target Pointer Size information...
+  PointerSize getPointerSize() const { return PtrSize; }
+  void setPointerSize(PointerSize PS) { PtrSize = PS; }
+
   /// 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);
 
+  /// 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.  This version of the method takes a null terminated list of function
+  /// arguments, which makes it easier for clients to use.
+  Function *getOrInsertFunction(const std::string &Name, const Type *RetTy,...);
+
   /// 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);
 
+  /// getMainFunction - This function looks up main efficiently.  This is such a
+  /// common case, that it is a method in Module.  If main cannot be found, a
+  /// null pointer is returned.
+  ///
+  Function *getMainFunction();
+
+  /// getNamedFunction - Return the first function in the module with the
+  /// specified name, of arbitrary type.  This method returns null if a function
+  /// with the specified name is not found.
+  ///
+  Function *getNamedFunction(const std::string &Name);
+
   /// 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.
@@ -101,22 +134,11 @@ public:
   //===--------------------------------------------------------------------===//
   // 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.
+  /// getSymbolTable() - Get access to the symbol table for the module, where
+  /// global variables and functions are identified.
   ///
-  SymbolTable *getSymbolTableSure();
+  inline       SymbolTable &getSymbolTable()       { return *SymTab; }
+  inline const SymbolTable &getSymbolTable() const { return *SymTab; }
 
 
   //===--------------------------------------------------------------------===//