Coverage Report

Created: 2020-02-25 14:32

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/include/clang/Frontend/CompilerInvocation.h
Line
Count
Source (jump to first uncovered line)
1
//===- CompilerInvocation.h - Compiler Invocation Helper Data ---*- C++ -*-===//
2
//
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
6
//
7
//===----------------------------------------------------------------------===//
8
9
#ifndef LLVM_CLANG_FRONTEND_COMPILERINVOCATION_H
10
#define LLVM_CLANG_FRONTEND_COMPILERINVOCATION_H
11
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/Basic/LangStandard.h"
18
#include "clang/Frontend/DependencyOutputOptions.h"
19
#include "clang/Frontend/FrontendOptions.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"
24
#include "llvm/ADT/ArrayRef.h"
25
#include <memory>
26
#include <string>
27
28
namespace llvm {
29
30
class Triple;
31
32
namespace opt {
33
34
class ArgList;
35
36
} // namespace opt
37
38
namespace vfs {
39
40
class FileSystem;
41
42
} // namespace vfs
43
44
} // namespace llvm
45
46
namespace clang {
47
48
class DiagnosticsEngine;
49
class HeaderSearchOptions;
50
class PreprocessorOptions;
51
class TargetOptions;
52
53
/// Fill out Opts based on the options given in Args.
54
///
55
/// Args must have been created from the OptTable returned by
56
/// createCC1OptTable().
57
///
58
/// When errors are encountered, return false and, if Diags is non-null,
59
/// report the error(s).
60
bool ParseDiagnosticArgs(DiagnosticOptions &Opts, llvm::opt::ArgList &Args,
61
                         DiagnosticsEngine *Diags = nullptr,
62
                         bool DefaultDiagColor = true,
63
                         bool DefaultShowOpt = true);
64
65
class CompilerInvocationBase {
66
public:
67
  /// Options controlling the language variant.
68
  std::shared_ptr<LangOptions> LangOpts;
69
70
  /// Options controlling the target.
71
  std::shared_ptr<TargetOptions> TargetOpts;
72
73
  /// Options controlling the diagnostic engine.
74
  IntrusiveRefCntPtr<DiagnosticOptions> DiagnosticOpts;
75
76
  /// Options controlling the \#include directive.
77
  std::shared_ptr<HeaderSearchOptions> HeaderSearchOpts;
78
79
  /// Options controlling the preprocessor (aside from \#include handling).
80
  std::shared_ptr<PreprocessorOptions> PreprocessorOpts;
81
82
  CompilerInvocationBase();
83
  CompilerInvocationBase(const CompilerInvocationBase &X);
84
  CompilerInvocationBase &operator=(const CompilerInvocationBase &) = delete;
85
  ~CompilerInvocationBase();
86
87
768k
  LangOptions *getLangOpts() { return LangOpts.get(); }
88
9.88k
  const LangOptions *getLangOpts() const { return LangOpts.get(); }
89
90
323k
  TargetOptions &getTargetOpts() { return *TargetOpts.get(); }
91
9.88k
  const TargetOptions &getTargetOpts() const { return *TargetOpts.get(); }
92
93
161k
  DiagnosticOptions &getDiagnosticOpts() const { return *DiagnosticOpts; }
94
95
397k
  HeaderSearchOptions &getHeaderSearchOpts() { return *HeaderSearchOpts; }
96
97
53.8k
  const HeaderSearchOptions &getHeaderSearchOpts() const {
98
53.8k
    return *HeaderSearchOpts;
99
53.8k
  }
100
101
59.3k
  std::shared_ptr<HeaderSearchOptions> getHeaderSearchOptsPtr() const {
102
59.3k
    return HeaderSearchOpts;
103
59.3k
  }
104
105
59.3k
  std::shared_ptr<PreprocessorOptions> getPreprocessorOptsPtr() {
106
59.3k
    return PreprocessorOpts;
107
59.3k
  }
108
109
376k
  PreprocessorOptions &getPreprocessorOpts() { return *PreprocessorOpts; }
110
111
28.4k
  const PreprocessorOptions &getPreprocessorOpts() const {
112
28.4k
    return *PreprocessorOpts;
113
28.4k
  }
114
};
115
116
/// Helper class for holding the data necessary to invoke the compiler.
117
///
118
/// This class is designed to represent an abstract "invocation" of the
119
/// compiler, including data such as the include paths, the code generation
120
/// options, the warning flags, and so on.
121
class CompilerInvocation : public CompilerInvocationBase {
122
  /// Options controlling the static analyzer.
123
  AnalyzerOptionsRef AnalyzerOpts;
124
125
  MigratorOptions MigratorOpts;
126
127
  /// Options controlling IRgen and the backend.
128
  CodeGenOptions CodeGenOpts;
129
130
  /// Options controlling dependency output.
131
  DependencyOutputOptions DependencyOutputOpts;
132
133
  /// Options controlling file system operations.
134
  FileSystemOptions FileSystemOpts;
135
136
  /// Options controlling the frontend itself.
137
  FrontendOptions FrontendOpts;
138
139
  /// Options controlling preprocessed output.
140
  PreprocessorOutputOptions PreprocessorOutputOpts;
141
142
public:
143
71.1k
  CompilerInvocation() : AnalyzerOpts(new AnalyzerOptions()) {}
144
145
  /// @name Utility Methods
146
  /// @{
147
148
  /// Create a compiler invocation from a list of input options.
149
  /// \returns true on success.
150
  ///
151
  /// \returns false if an error was encountered while parsing the arguments
152
  /// and attempts to recover and continue parsing the rest of the arguments.
153
  /// The recovery is best-effort and only guarantees that \p Res will end up in
154
  /// one of the vaild-to-access (albeit arbitrary) states.
155
  ///
156
  /// \param [out] Res - The resulting invocation.
157
  static bool CreateFromArgs(CompilerInvocation &Res,
158
                             ArrayRef<const char *> CommandLineArgs,
159
                             DiagnosticsEngine &Diags);
160
161
  /// Get the directory where the compiler headers
162
  /// reside, relative to the compiler binary (found by the passed in
163
  /// arguments).
164
  ///
165
  /// \param Argv0 - The program path (from argv[0]), for finding the builtin
166
  /// compiler path.
167
  /// \param MainAddr - The address of main (or some other function in the main
168
  /// executable), for finding the builtin compiler path.
169
  static std::string GetResourcesPath(const char *Argv0, void *MainAddr);
170
171
  /// Set language defaults for the given input language and
172
  /// language standard in the given LangOptions object.
173
  ///
174
  /// \param Opts - The LangOptions object to set up.
175
  /// \param IK - The input language.
176
  /// \param T - The target triple.
177
  /// \param PPOpts - The PreprocessorOptions affected.
178
  /// \param LangStd - The input language standard.
179
  static void setLangDefaults(LangOptions &Opts, InputKind IK,
180
                   const llvm::Triple &T, PreprocessorOptions &PPOpts,
181
                   LangStandard::Kind LangStd = LangStandard::lang_unspecified);
182
183
  /// Retrieve a module hash string that is suitable for uniquely
184
  /// identifying the conditions under which the module was built.
185
  std::string getModuleHash() const;
186
187
  /// @}
188
  /// @name Option Subgroups
189
  /// @{
190
191
95.5k
  AnalyzerOptionsRef getAnalyzerOpts() const { return AnalyzerOpts; }
192
193
45.0k
  MigratorOptions &getMigratorOpts() { return MigratorOpts; }
194
0
  const MigratorOptions &getMigratorOpts() const { return MigratorOpts; }
195
196
362k
  CodeGenOptions &getCodeGenOpts() { return CodeGenOpts; }
197
11.4k
  const CodeGenOptions &getCodeGenOpts() const { return CodeGenOpts; }
198
199
201k
  DependencyOutputOptions &getDependencyOutputOpts() {
200
201k
    return DependencyOutputOpts;
201
201k
  }
202
203
0
  const DependencyOutputOptions &getDependencyOutputOpts() const {
204
0
    return DependencyOutputOpts;
205
0
  }
206
207
156k
  FileSystemOptions &getFileSystemOpts() { return FileSystemOpts; }
208
209
0
  const FileSystemOptions &getFileSystemOpts() const {
210
0
    return FileSystemOpts;
211
0
  }
212
213
1.79M
  FrontendOptions &getFrontendOpts() { return FrontendOpts; }
214
9.01k
  const FrontendOptions &getFrontendOpts() const { return FrontendOpts; }
215
216
109k
  PreprocessorOutputOptions &getPreprocessorOutputOpts() {
217
109k
    return PreprocessorOutputOpts;
218
109k
  }
219
220
0
  const PreprocessorOutputOptions &getPreprocessorOutputOpts() const {
221
0
    return PreprocessorOutputOpts;
222
0
  }
223
224
  /// @}
225
};
226
227
IntrusiveRefCntPtr<llvm::vfs::FileSystem>
228
createVFSFromCompilerInvocation(const CompilerInvocation &CI,
229
                                DiagnosticsEngine &Diags);
230
231
IntrusiveRefCntPtr<llvm::vfs::FileSystem> createVFSFromCompilerInvocation(
232
    const CompilerInvocation &CI, DiagnosticsEngine &Diags,
233
    IntrusiveRefCntPtr<llvm::vfs::FileSystem> BaseFS);
234
235
} // namespace clang
236
237
#endif // LLVM_CLANG_FRONTEND_COMPILERINVOCATION_H