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"
28 class CoverageSourceInfo;
30 class DiagnosticsEngine;
32 class HeaderSearchOptions;
34 class PreprocessorOptions;
40 /// The primary public interface to the Clang code generator.
42 /// This is not really an abstract interface.
43 class CodeGenerator : public ASTConsumer {
44 virtual void anchor();
47 /// Return an opaque reference to the CodeGenModule object, which can
48 /// be used in various secondary APIs. It is valid as long as the
49 /// CodeGenerator exists.
50 CodeGen::CodeGenModule &CGM();
52 /// Return the module that this code generator is building into.
54 /// This may return null after HandleTranslationUnit is called;
55 /// this signifies that there was an error generating code. A
56 /// diagnostic will have been generated in this case, and the module
59 /// It will also return null if the module is released.
60 llvm::Module *GetModule();
62 /// Release ownership of the module to the caller.
64 /// It is illegal to call methods other than GetModule on the
65 /// CodeGenerator after releasing its module.
66 llvm::Module *ReleaseModule();
68 /// Given a mangled name, return a declaration which mangles that way
69 /// which has been added to this code generator via a Handle method.
71 /// This may return null if there was no matching declaration.
72 const Decl *GetDeclForMangledName(llvm::StringRef MangledName);
74 /// Return the LLVM address of the given global entity.
76 /// \param isForDefinition If true, the caller intends to define the
77 /// entity; the object returned will be an llvm::GlobalValue of
78 /// some sort. If false, the caller just intends to use the entity;
79 /// the object returned may be any sort of constant value, and the
80 /// code generator will schedule the entity for emission if a
81 /// definition has been registered with this code generator.
82 llvm::Constant *GetAddrOfGlobal(GlobalDecl decl, bool isForDefinition);
85 /// CreateLLVMCodeGen - Create a CodeGenerator instance.
86 /// It is the responsibility of the caller to call delete on
87 /// the allocated CodeGenerator instance.
88 CodeGenerator *CreateLLVMCodeGen(DiagnosticsEngine &Diags,
89 llvm::StringRef ModuleName,
90 const HeaderSearchOptions &HeaderSearchOpts,
91 const PreprocessorOptions &PreprocessorOpts,
92 const CodeGenOptions &CGO,
94 CoverageSourceInfo *CoverageInfo = nullptr);
96 } // end namespace clang