Definition of the Bytecode Handler interface. Subclasses can override just

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

diff --git a/include/llvm/Module.h b/include/llvm/Module.h
index b27a01209529f0877065720ccb5aaef49bad9ffe..a0f63fb852c6f6e9c56df06efffea52c5eb27256 100644 (file)
--- a/include/llvm/Module.h
+++ b/include/llvm/Module.h
@@ -1,4 +1,11 @@
 //===-- llvm/Module.h - C++ class to represent a VM module ------*- C++ -*-===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
+//===----------------------------------------------------------------------===//
 //
 // This file contains the declarations for the Module class that is used to 
 // maintain all the information related to a VM module.
@@ -14,6 +21,9 @@
 
 #include "llvm/Function.h"
 #include "llvm/GlobalVariable.h"
+
+namespace llvm {
+
 class GlobalVariable;
 class GlobalValueRefMap;   // Used by ConstantVals.cpp
 class ConstantPointerRef;
@@ -33,7 +43,8 @@ template<> struct ilist_traits<GlobalVariable>
   static iplist<GlobalVariable> &getList(Module *M);
 };
 
-struct Module : public Annotable {
+class Module {
+public:
   typedef iplist<GlobalVariable> GlobalListType;
   typedef iplist<Function> FunctionListType;
 
@@ -67,7 +78,6 @@ private:
   // Accessor for the underlying GVRefMap... only through the Constant class...
   friend class Constant;
   friend class ConstantPointerRef;
-  void mutateConstantPointerRef(GlobalValue *OldGV, GlobalValue *NewGV);
   ConstantPointerRef *getConstantPointerRef(GlobalValue *GV);
   void destroyConstantPointerRef(ConstantPointerRef *CPR);
 
@@ -85,6 +95,10 @@ public:
   PointerSize getPointerSize() const { return PtrSize; }
   void setPointerSize(PointerSize PS) { PtrSize = PS; }
 
+  //===--------------------------------------------------------------------===//
+  // Methods for easy access to the functions in the module.
+  //
+
   /// 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.
@@ -113,6 +127,24 @@ public:
   ///
   Function *getNamedFunction(const std::string &Name);
 
+  //===--------------------------------------------------------------------===//
+  // Methods for easy access to the global variables in the module.
+  //
+
+  /// getGlobalVariable - Look up the specified global variable in the module
+  /// symbol table.  If it does not exist, return null.  Note that this only
+  /// returns a global variable if it does not have internal linkage.  The type
+  /// argument should be the underlying type of the global, ie, it should not
+  /// have the top-level PointerType, which represents the address of the
+  /// global.
+  ///
+  GlobalVariable *getGlobalVariable(const std::string &Name, const Type *Ty);
+
+
+  //===--------------------------------------------------------------------===//
+  // Methods for easy access to the types in the module.
+  //
+
   /// 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.
@@ -122,7 +154,17 @@ public:
   /// getTypeName - If there is at least one entry in the symbol table for the
   /// specified type, return it.
   ///
-  std::string getTypeName(const Type *Ty);
+  std::string getTypeName(const Type *Ty) const;
+
+  /// getTypeByName - Return the type with the specified name in this module, or
+  /// null if there is none by that name.
+  const Type *getTypeByName(const std::string &Name) const;
+
+
+  //===--------------------------------------------------------------------===//
+  // Methods for direct access to the globals list, functions list, and symbol
+  // table.
+  //
 
   /// Get the underlying elements of the Module...
   inline const GlobalListType &getGlobalList() const  { return GlobalList; }
@@ -130,10 +172,6 @@ public:
   inline const FunctionListType &getFunctionList() const { return FunctionList;}
   inline       FunctionListType &getFunctionList()       { return FunctionList;}
 
-
-  //===--------------------------------------------------------------------===//
-  // Symbol table support functions...
-  
   /// getSymbolTable() - Get access to the symbol table for the module, where
   /// global variables and functions are identified.
   ///
@@ -180,7 +218,9 @@ public:
   inline const Function          &back() const { return FunctionList.back(); }
   inline       Function          &back()       { return FunctionList.back(); }
 
-  void print(std::ostream &OS) const;
+  void print(std::ostream &OS) const { print(OS, 0); }
+  void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
+
   void dump() const;
 
   /// dropAllReferences() - This function causes all the subinstructions to "let
@@ -204,4 +244,6 @@ inline std::ostream &operator<<(std::ostream &O, const Module &M) {
   return O;
 }
 
+} // End llvm namespace
+
 #endif