1 //===--- CodeGen/ModuleBuilder.h - Build LLVM from ASTs ---------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the ModuleBuilder interface.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_CODEGEN_MODULEBUILDER_H
15 #define LLVM_CLANG_CODEGEN_MODULEBUILDER_H
17 #include "clang/AST/ASTConsumer.h"
27 class CoverageSourceInfo;
29 class DiagnosticsEngine;
31 class HeaderSearchOptions;
33 class PreprocessorOptions;
39 /// The primary public interface to the Clang code generator.
41 /// This is not really an abstract interface.
42 class CodeGenerator : public ASTConsumer {
43 virtual void anchor();
46 /// Return an opaque reference to the CodeGenModule object, which can
47 /// be used in various secondary APIs. It is valid as long as the
48 /// CodeGenerator exists.
49 CodeGen::CodeGenModule &CGM();
51 /// Return the module that this code generator is building into.
53 /// This may return null after HandleTranslationUnit is called;
54 /// this signifies that there was an error generating code. A
55 /// diagnostic will have been generated in this case, and the module
58 /// It will also return null if the module is released.
59 llvm::Module *GetModule();
61 /// Release ownership of the module to the caller.
63 /// It is illegal to call methods other than GetModule on the
64 /// CodeGenerator after releasing its module.
65 llvm::Module *ReleaseModule();
67 /// Given a mangled name, return a declaration which mangles that way
68 /// which has been added to this code generator via a Handle method.
70 /// This may return null if there was no matching declaration.
71 const Decl *GetDeclForMangledName(llvm::StringRef MangledName);
73 /// Return the LLVM address of the given global entity.
75 /// \param isForDefinition If true, the caller intends to define the
76 /// entity; the object returned will be an llvm::GlobalValue of
77 /// some sort. If false, the caller just intends to use the entity;
78 /// the object returned may be any sort of constant value, and the
79 /// code generator will schedule the entity for emission if a
80 /// definition has been registered with this code generator.
81 llvm::Constant *GetAddrOfGlobal(GlobalDecl decl, bool isForDefinition);
84 /// CreateLLVMCodeGen - Create a CodeGenerator instance.
85 /// It is the responsibility of the caller to call delete on
86 /// the allocated CodeGenerator instance.
87 CodeGenerator *CreateLLVMCodeGen(DiagnosticsEngine &Diags,
88 llvm::StringRef ModuleName,
89 const HeaderSearchOptions &HeaderSearchOpts,
90 const PreprocessorOptions &PreprocessorOpts,
91 const CodeGenOptions &CGO,
93 CoverageSourceInfo *CoverageInfo = nullptr);
95 } // end namespace clang