clang  10.0.0svn
FrontendOptions.h
Go to the documentation of this file.
1 //===- FrontendOptions.h ----------------------------------------*- 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_FRONTENDOPTIONS_H
10 #define LLVM_CLANG_FRONTEND_FRONTENDOPTIONS_H
11 
17 #include "llvm/ADT/StringRef.h"
18 #include <cassert>
19 #include <memory>
20 #include <string>
21 #include <unordered_map>
22 #include <vector>
23 
24 namespace llvm {
25 
26 class MemoryBuffer;
27 
28 } // namespace llvm
29 
30 namespace clang {
31 
32 namespace frontend {
33 
34 enum ActionKind {
35  /// Parse ASTs and list Decl nodes.
37 
38  /// Parse ASTs and dump them.
40 
41  /// Parse ASTs and print them.
43 
44  /// Parse ASTs and view them in Graphviz.
46 
47  /// Dump the compiler configuration.
49 
50  /// Dump out raw tokens.
52 
53  /// Dump out preprocessed tokens.
55 
56  /// Emit a .s file.
58 
59  /// Emit a .bc file.
61 
62  /// Translate input source into HTML.
64 
65  /// Emit a .ll file.
67 
68  /// Generate LLVM IR, but do not emit anything.
70 
71  /// Generate machine code, but don't emit anything.
73 
74  /// Emit a .o file.
76 
77  /// Parse and apply any fixits to the source.
79 
80  /// Generate pre-compiled module from a module map.
82 
83  /// Generate pre-compiled module from a C++ module interface file.
85 
86  /// Generate pre-compiled module from a set of header files.
88 
89  /// Generate pre-compiled header.
91 
92  /// Generate Interface Stub Files.
94 
95  /// Only execute frontend initialization.
97 
98  /// Dump information about a module file.
100 
101  /// Load and verify that a PCH file is usable.
103 
104  /// Parse and perform semantic analysis.
106 
107  /// Run a plugin action, \see ActionName.
109 
110  /// Print the "preamble" of the input file
112 
113  /// -E mode.
115 
116  /// Expand macros but not \#includes.
118 
119  /// ObjC->C Rewriter.
121 
122  /// Rewriter playground
124 
125  /// Run one or more source code analyses.
127 
128  /// Dump template instantiations
130 
131  /// Run migrator.
133 
134  /// Just lex, no output.
136 
137  /// Print the output of the dependency directives source minimizer.
139 };
140 
141 } // namespace frontend
142 
143 /// The kind of a file that we've been handed as an input.
144 class InputKind {
145 private:
146  Language Lang;
147  unsigned Fmt : 3;
148  unsigned Preprocessed : 1;
149 
150 public:
151  /// The input file format.
152  enum Format {
155  Precompiled
156  };
157 
158  constexpr InputKind(Language L = Language::Unknown, Format F = Source,
159  bool PP = false)
160  : Lang(L), Fmt(F), Preprocessed(PP) {}
161 
162  Language getLanguage() const { return static_cast<Language>(Lang); }
163  Format getFormat() const { return static_cast<Format>(Fmt); }
164  bool isPreprocessed() const { return Preprocessed; }
165 
166  /// Is the input kind fully-unknown?
167  bool isUnknown() const { return Lang == Language::Unknown && Fmt == Source; }
168 
169  /// Is the language of the input some dialect of Objective-C?
170  bool isObjectiveC() const {
171  return Lang == Language::ObjC || Lang == Language::ObjCXX;
172  }
173 
175  return InputKind(getLanguage(), getFormat(), true);
176  }
177 
179  return InputKind(getLanguage(), F, isPreprocessed());
180  }
181 };
182 
183 /// An input file for the front end.
185  /// The file name, or "-" to read from standard input.
186  std::string File;
187 
188  /// The input, if it comes from a buffer rather than a file. This object
189  /// does not own the buffer, and the caller is responsible for ensuring
190  /// that it outlives any users.
191  const llvm::MemoryBuffer *Buffer = nullptr;
192 
193  /// The kind of input, e.g., C source, AST file, LLVM IR.
194  InputKind Kind;
195 
196  /// Whether we're dealing with a 'system' input (vs. a 'user' input).
197  bool IsSystem = false;
198 
199 public:
200  FrontendInputFile() = default;
201  FrontendInputFile(StringRef File, InputKind Kind, bool IsSystem = false)
202  : File(File.str()), Kind(Kind), IsSystem(IsSystem) {}
203  FrontendInputFile(const llvm::MemoryBuffer *Buffer, InputKind Kind,
204  bool IsSystem = false)
205  : Buffer(Buffer), Kind(Kind), IsSystem(IsSystem) {}
206 
207  InputKind getKind() const { return Kind; }
208  bool isSystem() const { return IsSystem; }
209 
210  bool isEmpty() const { return File.empty() && Buffer == nullptr; }
211  bool isFile() const { return !isBuffer(); }
212  bool isBuffer() const { return Buffer != nullptr; }
213  bool isPreprocessed() const { return Kind.isPreprocessed(); }
214 
215  StringRef getFile() const {
216  assert(isFile());
217  return File;
218  }
219 
220  const llvm::MemoryBuffer *getBuffer() const {
221  assert(isBuffer());
222  return Buffer;
223  }
224 };
225 
226 /// FrontendOptions - Options for controlling the behavior of the frontend.
228 public:
229  /// Disable memory freeing on exit.
230  unsigned DisableFree : 1;
231 
232  /// When generating PCH files, instruct the AST writer to create relocatable
233  /// PCH files.
234  unsigned RelocatablePCH : 1;
235 
236  /// Show the -help text.
237  unsigned ShowHelp : 1;
238 
239  /// Show frontend performance metrics and statistics.
240  unsigned ShowStats : 1;
241 
242  /// Show timers for individual actions.
243  unsigned ShowTimers : 1;
244 
245  /// print the supported cpus for the current target
246  unsigned PrintSupportedCPUs : 1;
247 
248  /// Output time trace profile.
249  unsigned TimeTrace : 1;
250 
251  /// Show the -version text.
252  unsigned ShowVersion : 1;
253 
254  /// Apply fixes even if there are unfixable errors.
255  unsigned FixWhatYouCan : 1;
256 
257  /// Apply fixes only for warnings.
258  unsigned FixOnlyWarnings : 1;
259 
260  /// Apply fixes and recompile.
261  unsigned FixAndRecompile : 1;
262 
263  /// Apply fixes to temporary files.
264  unsigned FixToTemporaries : 1;
265 
266  /// Emit ARC errors even if the migrator can fix them.
268 
269  /// Skip over function bodies to speed up parsing in cases you do not need
270  /// them (e.g. with code completion).
271  unsigned SkipFunctionBodies : 1;
272 
273  /// Whether we can use the global module index if available.
274  unsigned UseGlobalModuleIndex : 1;
275 
276  /// Whether we can generate the global module index if needed.
278 
279  /// Whether we include declaration dumps in AST dumps.
280  unsigned ASTDumpDecls : 1;
281 
282  /// Whether we deserialize all decls when forming AST dumps.
283  unsigned ASTDumpAll : 1;
284 
285  /// Whether we include lookup table dumps in AST dumps.
286  unsigned ASTDumpLookups : 1;
287 
288  /// Whether we are performing an implicit module build.
290 
291  /// Whether we should embed all used files into the PCM file.
292  unsigned ModulesEmbedAllFiles : 1;
293 
294  /// Whether timestamps should be written to the produced PCH file.
295  unsigned IncludeTimestamps : 1;
296 
298 
299  /// Specifies the output format of the AST.
301 
302  enum {
306  ARCMT_Migrate
307  } ARCMTAction = ARCMT_None;
308 
309  enum {
310  ObjCMT_None = 0,
311 
312  /// Enable migration to modern ObjC literals.
313  ObjCMT_Literals = 0x1,
314 
315  /// Enable migration to modern ObjC subscripting.
316  ObjCMT_Subscripting = 0x2,
317 
318  /// Enable migration to modern ObjC readonly property.
319  ObjCMT_ReadonlyProperty = 0x4,
320 
321  /// Enable migration to modern ObjC readwrite property.
322  ObjCMT_ReadwriteProperty = 0x8,
323 
324  /// Enable migration to modern ObjC property.
325  ObjCMT_Property = (ObjCMT_ReadonlyProperty | ObjCMT_ReadwriteProperty),
326 
327  /// Enable annotation of ObjCMethods of all kinds.
328  ObjCMT_Annotation = 0x10,
329 
330  /// Enable migration of ObjC methods to 'instancetype'.
331  ObjCMT_Instancetype = 0x20,
332 
333  /// Enable migration to NS_ENUM/NS_OPTIONS macros.
334  ObjCMT_NsMacros = 0x40,
335 
336  /// Enable migration to add conforming protocols.
337  ObjCMT_ProtocolConformance = 0x80,
338 
339  /// prefer 'atomic' property over 'nonatomic'.
340  ObjCMT_AtomicProperty = 0x100,
341 
342  /// annotate property with NS_RETURNS_INNER_POINTER
343  ObjCMT_ReturnsInnerPointerProperty = 0x200,
344 
345  /// use NS_NONATOMIC_IOSONLY for property 'atomic' attribute
346  ObjCMT_NsAtomicIOSOnlyProperty = 0x400,
347 
348  /// Enable inferring NS_DESIGNATED_INITIALIZER for ObjC methods.
349  ObjCMT_DesignatedInitializer = 0x800,
350 
351  /// Enable converting setter/getter expressions to property-dot syntx.
352  ObjCMT_PropertyDotSyntax = 0x1000,
353 
354  ObjCMT_MigrateDecls = (ObjCMT_ReadonlyProperty | ObjCMT_ReadwriteProperty |
355  ObjCMT_Annotation | ObjCMT_Instancetype |
356  ObjCMT_NsMacros | ObjCMT_ProtocolConformance |
357  ObjCMT_NsAtomicIOSOnlyProperty |
358  ObjCMT_DesignatedInitializer),
359  ObjCMT_MigrateAll = (ObjCMT_Literals | ObjCMT_Subscripting |
360  ObjCMT_MigrateDecls | ObjCMT_PropertyDotSyntax)
361  };
362  unsigned ObjCMTAction = ObjCMT_None;
363  std::string ObjCMTWhiteListPath;
364 
365  std::string MTMigrateDir;
367 
368  /// The input files and their types.
369  std::vector<FrontendInputFile> Inputs;
370 
371  /// When the input is a module map, the original module map file from which
372  /// that map was inferred, if any (for umbrella modules).
373  std::string OriginalModuleMap;
374 
375  /// The output file, if any.
376  std::string OutputFile;
377 
378  /// If given, the new suffix for fix-it rewritten files.
379  std::string FixItSuffix;
380 
381  /// If given, filter dumped AST Decl nodes by this substring.
382  std::string ASTDumpFilter;
383 
384  /// If given, enable code completion at the provided location.
386 
387  /// The frontend action to perform.
389 
390  /// The name of the action to run when using a plugin action.
391  std::string ActionName;
392 
393  /// Args to pass to the plugins
394  std::unordered_map<std::string,std::vector<std::string>> PluginArgs;
395 
396  /// The list of plugin actions to run in addition to the normal action.
397  std::vector<std::string> AddPluginActions;
398 
399  /// The list of plugins to load.
400  std::vector<std::string> Plugins;
401 
402  /// The list of module file extensions.
403  std::vector<std::shared_ptr<ModuleFileExtension>> ModuleFileExtensions;
404 
405  /// The list of module map files to load before processing the input.
406  std::vector<std::string> ModuleMapFiles;
407 
408  /// The list of additional prebuilt module files to load before
409  /// processing the input.
410  std::vector<std::string> ModuleFiles;
411 
412  /// The list of files to embed into the compiled module file.
413  std::vector<std::string> ModulesEmbedFiles;
414 
415  /// The list of AST files to merge.
416  std::vector<std::string> ASTMergeFiles;
417 
418  /// A list of arguments to forward to LLVM's option processing; this
419  /// should only be used for debugging and experimental features.
420  std::vector<std::string> LLVMArgs;
421 
422  /// File name of the file that will provide record layouts
423  /// (in the format produced by -fdump-record-layouts).
425 
426  /// Auxiliary triple for CUDA compilation.
427  std::string AuxTriple;
428 
429  /// Filename to write statistics to.
430  std::string StatsFile;
431 
432  /// Minimum time granularity (in microseconds) traced by time profiler.
434 
435 public:
437  : DisableFree(false), RelocatablePCH(false), ShowHelp(false),
438  ShowStats(false), ShowTimers(false), TimeTrace(false),
439  ShowVersion(false), FixWhatYouCan(false), FixOnlyWarnings(false),
440  FixAndRecompile(false), FixToTemporaries(false),
441  ARCMTMigrateEmitARCErrors(false), SkipFunctionBodies(false),
442  UseGlobalModuleIndex(true), GenerateGlobalModuleIndex(true),
443  ASTDumpDecls(false), ASTDumpLookups(false),
444  BuildingImplicitModule(false), ModulesEmbedAllFiles(false),
445  IncludeTimestamps(true), TimeTraceGranularity(500) {}
446 
447  /// getInputKindForExtension - Return the appropriate input kind for a file
448  /// extension. For example, "c" would return Language::C.
449  ///
450  /// \return The input kind for the extension, or Language::Unknown if the
451  /// extension is not recognized.
452  static InputKind getInputKindForExtension(StringRef Extension);
453 };
454 
455 } // namespace clang
456 
457 #endif // LLVM_CLANG_FRONTEND_FRONTENDOPTIONS_H
Expand macros but not #includes.
std::string OutputFile
The output file, if any.
std::string OriginalModuleMap
When the input is a module map, the original module map file from which that map was inferred...
std::string ObjCMTWhiteListPath
Generate pre-compiled module from a module map.
Print the output of the dependency directives source minimizer.
Parse and perform semantic analysis.
Specialize PointerLikeTypeTraits to allow LazyGenerationalUpdatePtr to be placed into a PointerUnion...
Definition: Dominators.h:30
Emit a .bc file.
Format getFormat() const
Parse ASTs and print them.
bool isObjectiveC() const
Is the language of the input some dialect of Objective-C?
Format
The input file format.
std::string ASTDumpFilter
If given, filter dumped AST Decl nodes by this substring.
std::string FixItSuffix
If given, the new suffix for fix-it rewritten files.
unsigned TimeTraceGranularity
Minimum time granularity (in microseconds) traced by time profiler.
Parse and apply any fixits to the source.
unsigned TimeTrace
Output time trace profile.
const llvm::MemoryBuffer * getBuffer() const
Translate input source into HTML.
A source location that has been parsed on the command line.
FrontendInputFile(StringRef File, InputKind Kind, bool IsSystem=false)
InputKind withFormat(Format F) const
std::vector< std::string > ASTMergeFiles
The list of AST files to merge.
unsigned BuildingImplicitModule
Whether we are performing an implicit module build.
std::vector< std::string > ModulesEmbedFiles
The list of files to embed into the compiled module file.
unsigned RelocatablePCH
When generating PCH files, instruct the AST writer to create relocatable PCH files.
Generate LLVM IR, but do not emit anything.
unsigned ShowStats
Show frontend performance metrics and statistics.
unsigned FixWhatYouCan
Apply fixes even if there are unfixable errors.
unsigned SkipFunctionBodies
Skip over function bodies to speed up parsing in cases you do not need them (e.g. ...
InputKind getKind() const
unsigned FixAndRecompile
Apply fixes and recompile.
Language
The language for the input, used to select and validate the language standard and possible actions...
Definition: LangStandard.h:19
Dump the compiler configuration.
bool isPreprocessed() const
Dump template instantiations.
Dump out preprocessed tokens.
unsigned ASTDumpAll
Whether we deserialize all decls when forming AST dumps.
Generate pre-compiled module from a C++ module interface file.
std::vector< std::string > Plugins
The list of plugins to load.
StringRef getFile() const
ASTDumpOutputFormat
Used to specify the format for printing AST dump information.
unsigned ShowTimers
Show timers for individual actions.
Generate Interface Stub Files.
Only execute frontend initialization.
Print the "preamble" of the input file.
Rewriter playground.
unsigned ModulesEmbedAllFiles
Whether we should embed all used files into the PCM file.
unsigned FixOnlyWarnings
Apply fixes only for warnings.
An input file for the front end.
std::string AuxTriple
Auxiliary triple for CUDA compilation.
unsigned ARCMTMigrateEmitARCErrors
Emit ARC errors even if the migrator can fix them.
#define false
Definition: stdbool.h:17
Kind
InputKind getPreprocessed() const
Generate machine code, but don&#39;t emit anything.
std::vector< std::string > ModuleFiles
The list of additional prebuilt module files to load before processing the input. ...
ParsedSourceLocation CodeCompletionAt
If given, enable code completion at the provided location.
std::vector< FrontendInputFile > Inputs
The input files and their types.
The kind of a file that we&#39;ve been handed as an input.
unsigned IncludeTimestamps
Whether timestamps should be written to the produced PCH file.
Parse ASTs and view them in Graphviz.
Parse ASTs and list Decl nodes.
std::unordered_map< std::string, std::vector< std::string > > PluginArgs
Args to pass to the plugins.
unsigned ASTDumpLookups
Whether we include lookup table dumps in AST dumps.
Load and verify that a PCH file is usable.
unsigned ShowVersion
Show the -version text.
unsigned GenerateGlobalModuleIndex
Whether we can generate the global module index if needed.
unsigned ShowHelp
Show the -help text.
std::string OverrideRecordLayoutsFile
File name of the file that will provide record layouts (in the format produced by -fdump-record-layou...
unsigned FixToTemporaries
Apply fixes to temporary files.
Options controlling the behavior of code completion.
Dataflow Directional Tag Classes.
Language getLanguage() const
std::string ARCMTMigrateReportOut
unsigned UseGlobalModuleIndex
Whether we can use the global module index if available.
constexpr InputKind(Language L=Language::Unknown, Format F=Source, bool PP=false)
FrontendOptions - Options for controlling the behavior of the frontend.
Run a plugin action,.
std::string StatsFile
Filename to write statistics to.
Parse ASTs and dump them.
std::vector< std::shared_ptr< ModuleFileExtension > > ModuleFileExtensions
The list of module file extensions.
CodeCompleteOptions CodeCompleteOpts
std::vector< std::string > AddPluginActions
The list of plugin actions to run in addition to the normal action.
unsigned DisableFree
Disable memory freeing on exit.
Generate pre-compiled header.
Generate pre-compiled module from a set of header files.
unsigned PrintSupportedCPUs
print the supported cpus for the current target
bool isUnknown() const
Is the input kind fully-unknown?
unsigned ASTDumpDecls
Whether we include declaration dumps in AST dumps.
std::string ActionName
The name of the action to run when using a plugin action.
Run one or more source code analyses.
std::vector< std::string > LLVMArgs
A list of arguments to forward to LLVM&#39;s option processing; this should only be used for debugging an...
Dump information about a module file.
FrontendInputFile(const llvm::MemoryBuffer *Buffer, InputKind Kind, bool IsSystem=false)
#define true
Definition: stdbool.h:16
std::vector< std::string > ModuleMapFiles
The list of module map files to load before processing the input.