1 //===- CompilerInvocation.h - Compiler Invocation Helper Data ---*- C++ -*-===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 #ifndef LLVM_CLANG_FRONTEND_COMPILERINVOCATION_H
10 #define LLVM_CLANG_FRONTEND_COMPILERINVOCATION_H
12 #include "clang/Basic/CodeGenOptions.h"
13 #include "clang/Basic/DiagnosticOptions.h"
14 #include "clang/Basic/FileSystemOptions.h"
15 #include "clang/Basic/LLVM.h"
16 #include "clang/Basic/LangOptions.h"
17 #include "clang/Frontend/DependencyOutputOptions.h"
18 #include "clang/Frontend/FrontendOptions.h"
19 #include "clang/Frontend/LangStandard.h"
20 #include "clang/Frontend/MigratorOptions.h"
21 #include "clang/Frontend/PreprocessorOutputOptions.h"
22 #include "clang/StaticAnalyzer/Core/AnalyzerOptions.h"
23 #include "llvm/ADT/IntrusiveRefCntPtr.h"
47 class DiagnosticsEngine;
48 class HeaderSearchOptions;
49 class PreprocessorOptions;
52 /// Fill out Opts based on the options given in Args.
54 /// Args must have been created from the OptTable returned by
55 /// createCC1OptTable().
57 /// When errors are encountered, return false and, if Diags is non-null,
58 /// report the error(s).
59 bool ParseDiagnosticArgs(DiagnosticOptions &Opts, llvm::opt::ArgList &Args,
60 DiagnosticsEngine *Diags = nullptr,
61 bool DefaultDiagColor = true,
62 bool DefaultShowOpt = true);
64 class CompilerInvocationBase {
66 /// Options controlling the language variant.
67 std::shared_ptr<LangOptions> LangOpts;
69 /// Options controlling the target.
70 std::shared_ptr<TargetOptions> TargetOpts;
72 /// Options controlling the diagnostic engine.
73 IntrusiveRefCntPtr<DiagnosticOptions> DiagnosticOpts;
75 /// Options controlling the \#include directive.
76 std::shared_ptr<HeaderSearchOptions> HeaderSearchOpts;
78 /// Options controlling the preprocessor (aside from \#include handling).
79 std::shared_ptr<PreprocessorOptions> PreprocessorOpts;
81 CompilerInvocationBase();
82 CompilerInvocationBase(const CompilerInvocationBase &X);
83 CompilerInvocationBase &operator=(const CompilerInvocationBase &) = delete;
84 ~CompilerInvocationBase();
86 LangOptions *getLangOpts() { return LangOpts.get(); }
87 const LangOptions *getLangOpts() const { return LangOpts.get(); }
89 TargetOptions &getTargetOpts() { return *TargetOpts.get(); }
90 const TargetOptions &getTargetOpts() const { return *TargetOpts.get(); }
92 DiagnosticOptions &getDiagnosticOpts() const { return *DiagnosticOpts; }
94 HeaderSearchOptions &getHeaderSearchOpts() { return *HeaderSearchOpts; }
96 const HeaderSearchOptions &getHeaderSearchOpts() const {
97 return *HeaderSearchOpts;
100 std::shared_ptr<HeaderSearchOptions> getHeaderSearchOptsPtr() const {
101 return HeaderSearchOpts;
104 std::shared_ptr<PreprocessorOptions> getPreprocessorOptsPtr() {
105 return PreprocessorOpts;
108 PreprocessorOptions &getPreprocessorOpts() { return *PreprocessorOpts; }
110 const PreprocessorOptions &getPreprocessorOpts() const {
111 return *PreprocessorOpts;
115 /// Helper class for holding the data necessary to invoke the compiler.
117 /// This class is designed to represent an abstract "invocation" of the
118 /// compiler, including data such as the include paths, the code generation
119 /// options, the warning flags, and so on.
120 class CompilerInvocation : public CompilerInvocationBase {
121 /// Options controlling the static analyzer.
122 AnalyzerOptionsRef AnalyzerOpts;
124 MigratorOptions MigratorOpts;
126 /// Options controlling IRgen and the backend.
127 CodeGenOptions CodeGenOpts;
129 /// Options controlling dependency output.
130 DependencyOutputOptions DependencyOutputOpts;
132 /// Options controlling file system operations.
133 FileSystemOptions FileSystemOpts;
135 /// Options controlling the frontend itself.
136 FrontendOptions FrontendOpts;
138 /// Options controlling preprocessed output.
139 PreprocessorOutputOptions PreprocessorOutputOpts;
142 CompilerInvocation() : AnalyzerOpts(new AnalyzerOptions()) {}
144 /// @name Utility Methods
147 /// Create a compiler invocation from a list of input options.
148 /// \returns true on success.
150 /// \param [out] Res - The resulting invocation.
151 /// \param ArgBegin - The first element in the argument vector.
152 /// \param ArgEnd - The last element in the argument vector.
153 /// \param Diags - The diagnostic engine to use for errors.
154 static bool CreateFromArgs(CompilerInvocation &Res,
155 const char* const *ArgBegin,
156 const char* const *ArgEnd,
157 DiagnosticsEngine &Diags);
159 /// Get the directory where the compiler headers
160 /// reside, relative to the compiler binary (found by the passed in
163 /// \param Argv0 - The program path (from argv[0]), for finding the builtin
165 /// \param MainAddr - The address of main (or some other function in the main
166 /// executable), for finding the builtin compiler path.
167 static std::string GetResourcesPath(const char *Argv0, void *MainAddr);
169 /// Set language defaults for the given input language and
170 /// language standard in the given LangOptions object.
172 /// \param Opts - The LangOptions object to set up.
173 /// \param IK - The input language.
174 /// \param T - The target triple.
175 /// \param PPOpts - The PreprocessorOptions affected.
176 /// \param LangStd - The input language standard.
177 static void setLangDefaults(LangOptions &Opts, InputKind IK,
178 const llvm::Triple &T, PreprocessorOptions &PPOpts,
179 LangStandard::Kind LangStd = LangStandard::lang_unspecified);
181 /// Retrieve a module hash string that is suitable for uniquely
182 /// identifying the conditions under which the module was built.
183 std::string getModuleHash() const;
186 /// @name Option Subgroups
189 AnalyzerOptionsRef getAnalyzerOpts() const { return AnalyzerOpts; }
191 MigratorOptions &getMigratorOpts() { return MigratorOpts; }
192 const MigratorOptions &getMigratorOpts() const { return MigratorOpts; }
194 CodeGenOptions &getCodeGenOpts() { return CodeGenOpts; }
195 const CodeGenOptions &getCodeGenOpts() const { return CodeGenOpts; }
197 DependencyOutputOptions &getDependencyOutputOpts() {
198 return DependencyOutputOpts;
201 const DependencyOutputOptions &getDependencyOutputOpts() const {
202 return DependencyOutputOpts;
205 FileSystemOptions &getFileSystemOpts() { return FileSystemOpts; }
207 const FileSystemOptions &getFileSystemOpts() const {
208 return FileSystemOpts;
211 FrontendOptions &getFrontendOpts() { return FrontendOpts; }
212 const FrontendOptions &getFrontendOpts() const { return FrontendOpts; }
214 PreprocessorOutputOptions &getPreprocessorOutputOpts() {
215 return PreprocessorOutputOpts;
218 const PreprocessorOutputOptions &getPreprocessorOutputOpts() const {
219 return PreprocessorOutputOpts;
225 IntrusiveRefCntPtr<llvm::vfs::FileSystem>
226 createVFSFromCompilerInvocation(const CompilerInvocation &CI,
227 DiagnosticsEngine &Diags);
229 IntrusiveRefCntPtr<llvm::vfs::FileSystem> createVFSFromCompilerInvocation(
230 const CompilerInvocation &CI, DiagnosticsEngine &Diags,
231 IntrusiveRefCntPtr<llvm::vfs::FileSystem> BaseFS);
235 #endif // LLVM_CLANG_FRONTEND_COMPILERINVOCATION_H