Coverage Report

Created: 2018-11-16 02:38

/Users/buildslave/jenkins/workspace/clang-stage2-coverage-R/llvm/tools/clang/include/clang/Frontend/CompilerInvocation.h
Line
Count
Source (jump to first uncovered line)
1
//===- CompilerInvocation.h - Compiler Invocation Helper Data ---*- C++ -*-===//
2
//
3
//                     The LLVM Compiler Infrastructure
4
//
5
// This file is distributed under the University of Illinois Open Source
6
// License. See LICENSE.TXT for details.
7
//
8
//===----------------------------------------------------------------------===//
9
10
#ifndef LLVM_CLANG_FRONTEND_COMPILERINVOCATION_H
11
#define LLVM_CLANG_FRONTEND_COMPILERINVOCATION_H
12
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/CodeGenOptions.h"
18
#include "clang/Frontend/DependencyOutputOptions.h"
19
#include "clang/Frontend/FrontendOptions.h"
20
#include "clang/Frontend/LangStandard.h"
21
#include "clang/Frontend/MigratorOptions.h"
22
#include "clang/Frontend/PreprocessorOutputOptions.h"
23
#include "clang/StaticAnalyzer/Core/AnalyzerOptions.h"
24
#include "llvm/ADT/IntrusiveRefCntPtr.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
548k
  LangOptions *getLangOpts() { return LangOpts.get(); }
88
5.93k
  const LangOptions *getLangOpts() const { return LangOpts.get(); }
89
90
224k
  TargetOptions &getTargetOpts() { return *TargetOpts.get(); }
91
5.93k
  const TargetOptions &getTargetOpts() const { return *TargetOpts.get(); }
92
93
137k
  DiagnosticOptions &getDiagnosticOpts() const { return *DiagnosticOpts; }
94
95
309k
  HeaderSearchOptions &getHeaderSearchOpts() { return *HeaderSearchOpts; }
96
97
45.0k
  const HeaderSearchOptions &getHeaderSearchOpts() const {
98
45.0k
    return *HeaderSearchOpts;
99
45.0k
  }
100
101
40.2k
  std::shared_ptr<HeaderSearchOptions> getHeaderSearchOptsPtr() const {
102
40.2k
    return HeaderSearchOpts;
103
40.2k
  }
104
105
40.2k
  std::shared_ptr<PreprocessorOptions> getPreprocessorOptsPtr() {
106
40.2k
    return PreprocessorOpts;
107
40.2k
  }
108
109
296k
  PreprocessorOptions &getPreprocessorOpts() { return *PreprocessorOpts; }
110
111
10.4k
  const PreprocessorOptions &getPreprocessorOpts() const {
112
10.4k
    return *PreprocessorOpts;
113
10.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
50.5k
  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
  /// \param [out] Res - The resulting invocation.
152
  /// \param ArgBegin - The first element in the argument vector.
153
  /// \param ArgEnd - The last element in the argument vector.
154
  /// \param Diags - The diagnostic engine to use for errors.
155
  static bool CreateFromArgs(CompilerInvocation &Res,
156
                             const char* const *ArgBegin,
157
                             const char* const *ArgEnd,
158
                             DiagnosticsEngine &Diags);
159
160
  /// Get the directory where the compiler headers
161
  /// reside, relative to the compiler binary (found by the passed in
162
  /// arguments).
163
  ///
164
  /// \param Argv0 - The program path (from argv[0]), for finding the builtin
165
  /// compiler path.
166
  /// \param MainAddr - The address of main (or some other function in the main
167
  /// executable), for finding the builtin compiler path.
168
  static std::string GetResourcesPath(const char *Argv0, void *MainAddr);
169
170
  /// Set language defaults for the given input language and
171
  /// language standard in the given LangOptions object.
172
  ///
173
  /// \param Opts - The LangOptions object to set up.
174
  /// \param IK - The input language.
175
  /// \param T - The target triple.
176
  /// \param PPOpts - The PreprocessorOptions affected.
177
  /// \param LangStd - The input language standard.
178
  static void setLangDefaults(LangOptions &Opts, InputKind IK,
179
                   const llvm::Triple &T, PreprocessorOptions &PPOpts,
180
                   LangStandard::Kind LangStd = LangStandard::lang_unspecified);
181
182
  /// Retrieve a module hash string that is suitable for uniquely
183
  /// identifying the conditions under which the module was built.
184
  std::string getModuleHash() const;
185
186
  /// @}
187
  /// @name Option Subgroups
188
  /// @{
189
190
149k
  AnalyzerOptionsRef getAnalyzerOpts() const { return AnalyzerOpts; }
191
192
41.8k
  MigratorOptions &getMigratorOpts() { return MigratorOpts; }
193
0
  const MigratorOptions &getMigratorOpts() const { return MigratorOpts; }
194
195
293k
  CodeGenOptions &getCodeGenOpts() { return CodeGenOpts; }
196
0
  const CodeGenOptions &getCodeGenOpts() const { return CodeGenOpts; }
197
198
127k
  DependencyOutputOptions &getDependencyOutputOpts() {
199
127k
    return DependencyOutputOpts;
200
127k
  }
201
202
0
  const DependencyOutputOptions &getDependencyOutputOpts() const {
203
0
    return DependencyOutputOpts;
204
0
  }
205
206
124k
  FileSystemOptions &getFileSystemOpts() { return FileSystemOpts; }
207
208
0
  const FileSystemOptions &getFileSystemOpts() const {
209
0
    return FileSystemOpts;
210
0
  }
211
212
1.43M
  FrontendOptions &getFrontendOpts() { return FrontendOpts; }
213
2.02k
  const FrontendOptions &getFrontendOpts() const { return FrontendOpts; }
214
215
89.1k
  PreprocessorOutputOptions &getPreprocessorOutputOpts() {
216
89.1k
    return PreprocessorOutputOpts;
217
89.1k
  }
218
219
0
  const PreprocessorOutputOptions &getPreprocessorOutputOpts() const {
220
0
    return PreprocessorOutputOpts;
221
0
  }
222
223
  /// @}
224
};
225
226
IntrusiveRefCntPtr<llvm::vfs::FileSystem>
227
createVFSFromCompilerInvocation(const CompilerInvocation &CI,
228
                                DiagnosticsEngine &Diags);
229
230
IntrusiveRefCntPtr<llvm::vfs::FileSystem> createVFSFromCompilerInvocation(
231
    const CompilerInvocation &CI, DiagnosticsEngine &Diags,
232
    IntrusiveRefCntPtr<llvm::vfs::FileSystem> BaseFS);
233
234
} // namespace clang
235
236
#endif // LLVM_CLANG_FRONTEND_COMPILERINVOCATION_H