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