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 13 #include "clang/Frontend/CommandLineSourceLoc.h" 14 #include "clang/Sema/CodeCompleteOptions.h" 15 #include "llvm/ADT/StringRef.h" 16 #include <string> 17 #include <vector> 18 19 namespace llvm { 20 class MemoryBuffer; 21 } 22 23 namespace clang { 24 25 namespace frontend { 26 enum ActionKind { 27 ASTDeclList, ///< Parse ASTs and list Decl nodes. 28 ASTDump, ///< Parse ASTs and dump them. 29 ASTPrint, ///< Parse ASTs and print them. 30 ASTView, ///< Parse ASTs and view them in Graphviz. 31 DumpRawTokens, ///< Dump out raw tokens. 32 DumpTokens, ///< Dump out preprocessed tokens. 33 EmitAssembly, ///< Emit a .s file. 34 EmitBC, ///< Emit a .bc file. 35 EmitHTML, ///< Translate input source into HTML. 36 EmitLLVM, ///< Emit a .ll file. 37 EmitLLVMOnly, ///< Generate LLVM IR, but do not emit anything. 38 EmitCodeGenOnly, ///< Generate machine code, but don't emit anything. 39 EmitObj, ///< Emit a .o file. 40 FixIt, ///< Parse and apply any fixits to the source. 41 GenerateModule, ///< Generate pre-compiled module. 42 GeneratePCH, ///< Generate pre-compiled header. 43 GeneratePTH, ///< Generate pre-tokenized header. 44 InitOnly, ///< Only execute frontend initialization. 45 ModuleFileInfo, ///< Dump information about a module file. 46 VerifyPCH, ///< Load and verify that a PCH file is usable. 47 ParseSyntaxOnly, ///< Parse and perform semantic analysis. 48 PluginAction, ///< Run a plugin action, \see ActionName. 49 PrintDeclContext, ///< Print DeclContext and their Decls. 50 PrintPreamble, ///< Print the "preamble" of the input file 51 PrintPreprocessedInput, ///< -E mode. 52 RewriteMacros, ///< Expand macros but not \#includes. 53 RewriteObjC, ///< ObjC->C Rewriter. 54 RewriteTest, ///< Rewriter playground 55 RunAnalysis, ///< Run one or more source code analyses. 56 MigrateSource, ///< Run migrator. 57 RunPreprocessorOnly ///< Just lex, no output. 58 }; 59 } 60 61 enum InputKind { 62 IK_None, 63 IK_Asm, 64 IK_C, 65 IK_CXX, 66 IK_ObjC, 67 IK_ObjCXX, 68 IK_PreprocessedC, 69 IK_PreprocessedCXX, 70 IK_PreprocessedObjC, 71 IK_PreprocessedObjCXX, 72 IK_OpenCL, 73 IK_CUDA, 74 IK_AST, 75 IK_LLVM_IR 76 }; 77 78 79 /// \brief An input file for the front end. 80 class FrontendInputFile { 81 /// \brief The file name, or "-" to read from standard input. 82 std::string File; 83 84 llvm::MemoryBuffer *Buffer; 85 86 /// \brief The kind of input, e.g., C source, AST file, LLVM IR. 87 InputKind Kind; 88 89 /// \brief Whether we're dealing with a 'system' input (vs. a 'user' input). 90 bool IsSystem; 91 92 public: 93 FrontendInputFile() : Buffer(nullptr), Kind(IK_None) { } 94 FrontendInputFile(StringRef File, InputKind Kind, bool IsSystem = false) 95 : File(File.str()), Buffer(nullptr), Kind(Kind), IsSystem(IsSystem) { } 96 FrontendInputFile(llvm::MemoryBuffer *buffer, InputKind Kind, 97 bool IsSystem = false) 98 : Buffer(buffer), Kind(Kind), IsSystem(IsSystem) { } 99 100 InputKind getKind() const { return Kind; } 101 bool isSystem() const { return IsSystem; } 102 103 bool isEmpty() const { return File.empty() && Buffer == nullptr; } 104 bool isFile() const { return !isBuffer(); } 105 bool isBuffer() const { return Buffer != nullptr; } 106 107 StringRef getFile() const { 108 assert(isFile()); 109 return File; 110 } 111 llvm::MemoryBuffer *getBuffer() const { 112 assert(isBuffer()); 113 return Buffer; 114 } 115 }; 116 117 /// FrontendOptions - Options for controlling the behavior of the frontend. 118 class FrontendOptions { 119 public: 120 unsigned DisableFree : 1; ///< Disable memory freeing on exit. 121 unsigned RelocatablePCH : 1; ///< When generating PCH files, 122 /// instruct the AST writer to create 123 /// relocatable PCH files. 124 unsigned ShowHelp : 1; ///< Show the -help text. 125 unsigned ShowStats : 1; ///< Show frontend performance 126 /// metrics and statistics. 127 unsigned ShowTimers : 1; ///< Show timers for individual 128 /// actions. 129 unsigned ShowVersion : 1; ///< Show the -version text. 130 unsigned FixWhatYouCan : 1; ///< Apply fixes even if there are 131 /// unfixable errors. 132 unsigned FixOnlyWarnings : 1; ///< Apply fixes only for warnings. 133 unsigned FixAndRecompile : 1; ///< Apply fixes and recompile. 134 unsigned FixToTemporaries : 1; ///< Apply fixes to temporary files. 135 unsigned ARCMTMigrateEmitARCErrors : 1; /// Emit ARC errors even if the 136 /// migrator can fix them 137 unsigned SkipFunctionBodies : 1; ///< Skip over function bodies to 138 /// speed up parsing in cases you do 139 /// not need them (e.g. with code 140 /// completion). 141 unsigned UseGlobalModuleIndex : 1; ///< Whether we can use the 142 ///< global module index if available. 143 unsigned GenerateGlobalModuleIndex : 1; ///< Whether we can generate the 144 ///< global module index if needed. 145 unsigned ASTDumpLookups : 1; ///< Whether we include lookup table 146 ///< dumps in AST dumps. 147 148 CodeCompleteOptions CodeCompleteOpts; 149 150 enum { 151 ARCMT_None, 152 ARCMT_Check, 153 ARCMT_Modify, 154 ARCMT_Migrate 155 } ARCMTAction; 156 157 enum { 158 ObjCMT_None = 0, 159 /// \brief Enable migration to modern ObjC literals. 160 ObjCMT_Literals = 0x1, 161 /// \brief Enable migration to modern ObjC subscripting. 162 ObjCMT_Subscripting = 0x2, 163 /// \brief Enable migration to modern ObjC readonly property. 164 ObjCMT_ReadonlyProperty = 0x4, 165 /// \brief Enable migration to modern ObjC readwrite property. 166 ObjCMT_ReadwriteProperty = 0x8, 167 /// \brief Enable migration to modern ObjC property. 168 ObjCMT_Property = (ObjCMT_ReadonlyProperty | ObjCMT_ReadwriteProperty), 169 /// \brief Enable annotation of ObjCMethods of all kinds. 170 ObjCMT_Annotation = 0x10, 171 /// \brief Enable migration of ObjC methods to 'instancetype'. 172 ObjCMT_Instancetype = 0x20, 173 /// \brief Enable migration to NS_ENUM/NS_OPTIONS macros. 174 ObjCMT_NsMacros = 0x40, 175 /// \brief Enable migration to add conforming protocols. 176 ObjCMT_ProtocolConformance = 0x80, 177 /// \brief prefer 'atomic' property over 'nonatomic'. 178 ObjCMT_AtomicProperty = 0x100, 179 /// \brief annotate property with NS_RETURNS_INNER_POINTER 180 ObjCMT_ReturnsInnerPointerProperty = 0x200, 181 /// \brief use NS_NONATOMIC_IOSONLY for property 'atomic' attribute 182 ObjCMT_NsAtomicIOSOnlyProperty = 0x400, 183 /// \brief Enable inferring NS_DESIGNATED_INITIALIZER for ObjC methods. 184 ObjCMT_DesignatedInitializer = 0x800, 185 ObjCMT_MigrateDecls = (ObjCMT_ReadonlyProperty | ObjCMT_ReadwriteProperty | 186 ObjCMT_Annotation | ObjCMT_Instancetype | 187 ObjCMT_NsMacros | ObjCMT_ProtocolConformance | 188 ObjCMT_NsAtomicIOSOnlyProperty | 189 ObjCMT_DesignatedInitializer), 190 ObjCMT_MigrateAll = (ObjCMT_Literals | ObjCMT_Subscripting | ObjCMT_MigrateDecls) 191 }; 192 unsigned ObjCMTAction; 193 std::string ObjCMTWhiteListPath; 194 195 std::string MTMigrateDir; 196 std::string ARCMTMigrateReportOut; 197 198 /// The input files and their types. 199 std::vector<FrontendInputFile> Inputs; 200 201 /// The output file, if any. 202 std::string OutputFile; 203 204 /// If given, the new suffix for fix-it rewritten files. 205 std::string FixItSuffix; 206 207 /// If given, filter dumped AST Decl nodes by this substring. 208 std::string ASTDumpFilter; 209 210 /// If given, enable code completion at the provided location. 211 ParsedSourceLocation CodeCompletionAt; 212 213 /// The frontend action to perform. 214 frontend::ActionKind ProgramAction; 215 216 /// The name of the action to run when using a plugin action. 217 std::string ActionName; 218 219 /// Args to pass to the plugin 220 std::vector<std::string> PluginArgs; 221 222 /// The list of plugin actions to run in addition to the normal action. 223 std::vector<std::string> AddPluginActions; 224 225 /// Args to pass to the additional plugins 226 std::vector<std::vector<std::string> > AddPluginArgs; 227 228 /// The list of plugins to load. 229 std::vector<std::string> Plugins; 230 231 /// \brief The list of AST files to merge. 232 std::vector<std::string> ASTMergeFiles; 233 234 /// \brief A list of arguments to forward to LLVM's option processing; this 235 /// should only be used for debugging and experimental features. 236 std::vector<std::string> LLVMArgs; 237 238 /// \brief File name of the file that will provide record layouts 239 /// (in the format produced by -fdump-record-layouts). 240 std::string OverrideRecordLayoutsFile; 241 242 public: 243 FrontendOptions() : 244 DisableFree(false), RelocatablePCH(false), ShowHelp(false), 245 ShowStats(false), ShowTimers(false), ShowVersion(false), 246 FixWhatYouCan(false), FixOnlyWarnings(false), FixAndRecompile(false), 247 FixToTemporaries(false), ARCMTMigrateEmitARCErrors(false), 248 SkipFunctionBodies(false), UseGlobalModuleIndex(true), 249 GenerateGlobalModuleIndex(true), ASTDumpLookups(false), 250 ARCMTAction(ARCMT_None), ObjCMTAction(ObjCMT_None), 251 ProgramAction(frontend::ParseSyntaxOnly) 252 {} 253 254 /// getInputKindForExtension - Return the appropriate input kind for a file 255 /// extension. For example, "c" would return IK_C. 256 /// 257 /// \return The input kind for the extension, or IK_None if the extension is 258 /// not recognized. 259 static InputKind getInputKindForExtension(StringRef Extension); 260 }; 261 262 } // end namespace clang 263 264 #endif 265
