llvm/IR/Module.h

1 //===-- llvm/Module.h - C++ class to represent a VM module ------*- C++ -*-===//
11 /// Module.h This file contains the declarations for the Module class.
36   : public SymbolTableListTraits<Function, Module> {
54   : public SymbolTableListTraits<GlobalVariable, Module> {
69   : public SymbolTableListTraits<GlobalAlias, Module> {
101 /// A Module instance is used to store all the information related to an
112 class Module {
206   std::string TargetTriple;       ///< Platform target triple Module compiled on
216   /// The Module constructor. Note that there is no default constructor. You
218   explicit Module(StringRef ModuleID, LLVMContext& C);
220   ~Module();
223 /// @name Module Level Accessors
256 /// @name Module Level Mutators
357     return const_cast<Module *>(this)->getGlobalVariable(Name, AllowInternal);
369     return const_cast<Module *>(this)->getNamedGlobal(Name);
409 /// @name Module Flags Accessors
444   /// GlobalValues.  Without destroying the Module, there is no way to detach or
448   /// getMaterializer - Retrieves the GVMaterializer, if any, for this Module.
454   /// isDematerializable - Returns true if this GV was loaded from this Module's
467   /// MaterializeAll - Make sure all GlobalValues in this Module are fully read.
473   /// MaterializeAllPermanently - Make sure all GlobalValues in this Module are
484   /// Get the Module's list of global variables (constant).
486   /// Get the Module's list of global variables.
488   static iplist<GlobalVariable> Module::*getSublistAccess(GlobalVariable*) {
489     return &Module::GlobalList;
491   /// Get the Module's list of functions (constant).
493   /// Get the Module's list of functions.
495   static iplist<Function> Module::*getSublistAccess(Function*) {
496     return &Module::FunctionList;
498   /// Get the Module's list of aliases (constant).
500   /// Get the Module's list of aliases.
502   static iplist<GlobalAlias> Module::*getSublistAccess(GlobalAlias*) {
503     return &Module::AliasList;
505   /// Get the Module's list of named metadata (constant).
507   /// Get the Module's list of named metadata.
509   static ilist<NamedMDNode> Module::*getSublistAccess(NamedMDNode*) {
510     return &Module::NamedMDList;
514   /// Get the Module's symbol table of global variable and function identifiers.
569 /// @name Utility functions for printing and dumping Module objects
590 inline raw_ostream &operator<<(raw_ostream &O, const Module &M) {
596 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef)
599  * Module.
601 inline Module *unwrap(LLVMModuleProviderRef MP) {
602   return reinterpret_cast<Module*>(MP);