xref: /llvm-project/flang/lib/Frontend/CompilerInvocation.cpp (revision 5597ec2dc4f888bf9704626c798ec6e50e5d1384)
1 //===- CompilerInvocation.cpp ---------------------------------------------===//
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 #include "flang/Frontend/CompilerInvocation.h"
10 #include "flang/Common/Fortran-features.h"
11 #include "flang/Frontend/PreprocessorOptions.h"
12 #include "flang/Semantics/semantics.h"
13 #include "flang/Version.inc"
14 #include "clang/Basic/AllDiagnostics.h"
15 #include "clang/Basic/DiagnosticDriver.h"
16 #include "clang/Basic/DiagnosticOptions.h"
17 #include "clang/Driver/DriverDiagnostic.h"
18 #include "clang/Driver/Options.h"
19 #include "llvm/ADT/StringRef.h"
20 #include "llvm/ADT/StringSwitch.h"
21 #include "llvm/Option/Arg.h"
22 #include "llvm/Option/ArgList.h"
23 #include "llvm/Option/OptTable.h"
24 #include "llvm/Support/FileSystem.h"
25 #include "llvm/Support/FileUtilities.h"
26 #include "llvm/Support/Path.h"
27 #include "llvm/Support/Process.h"
28 #include "llvm/Support/raw_ostream.h"
29 #include <memory>
30 
31 using namespace Fortran::frontend;
32 
33 //===----------------------------------------------------------------------===//
34 // Initialization.
35 //===----------------------------------------------------------------------===//
36 CompilerInvocationBase::CompilerInvocationBase()
37     : diagnosticOpts_(new clang::DiagnosticOptions()),
38       preprocessorOpts_(new PreprocessorOptions()) {}
39 
40 CompilerInvocationBase::CompilerInvocationBase(const CompilerInvocationBase &x)
41     : diagnosticOpts_(new clang::DiagnosticOptions(x.GetDiagnosticOpts())),
42       preprocessorOpts_(new PreprocessorOptions(x.preprocessorOpts())) {}
43 
44 CompilerInvocationBase::~CompilerInvocationBase() = default;
45 
46 //===----------------------------------------------------------------------===//
47 // Deserialization (from args)
48 //===----------------------------------------------------------------------===//
49 static bool parseShowColorsArgs(
50     const llvm::opt::ArgList &args, bool defaultColor) {
51   // Color diagnostics default to auto ("on" if terminal supports) in the driver
52   // but default to off in cc1, needing an explicit OPT_fdiagnostics_color.
53   // Support both clang's -f[no-]color-diagnostics and gcc's
54   // -f[no-]diagnostics-colors[=never|always|auto].
55   enum {
56     Colors_On,
57     Colors_Off,
58     Colors_Auto
59   } ShowColors = defaultColor ? Colors_Auto : Colors_Off;
60 
61   for (auto *a : args) {
62     const llvm::opt::Option &O = a->getOption();
63     if (O.matches(clang::driver::options::OPT_fcolor_diagnostics) ||
64         O.matches(clang::driver::options::OPT_fdiagnostics_color)) {
65       ShowColors = Colors_On;
66     } else if (O.matches(clang::driver::options::OPT_fno_color_diagnostics) ||
67         O.matches(clang::driver::options::OPT_fno_diagnostics_color)) {
68       ShowColors = Colors_Off;
69     } else if (O.matches(clang::driver::options::OPT_fdiagnostics_color_EQ)) {
70       llvm::StringRef value(a->getValue());
71       if (value == "always")
72         ShowColors = Colors_On;
73       else if (value == "never")
74         ShowColors = Colors_Off;
75       else if (value == "auto")
76         ShowColors = Colors_Auto;
77     }
78   }
79 
80   return ShowColors == Colors_On ||
81       (ShowColors == Colors_Auto && llvm::sys::Process::StandardErrHasColors());
82 }
83 
84 bool Fortran::frontend::ParseDiagnosticArgs(clang::DiagnosticOptions &opts,
85     llvm::opt::ArgList &args, bool defaultDiagColor) {
86   opts.ShowColors = parseShowColorsArgs(args, defaultDiagColor);
87 
88   return true;
89 }
90 
91 // Tweak the frontend configuration based on the frontend action
92 static void setUpFrontendBasedOnAction(FrontendOptions &opts) {
93   assert(opts.programAction != Fortran::frontend::InvalidAction &&
94       "Fortran frontend action not set!");
95 
96   if (opts.programAction == DebugDumpParsingLog)
97     opts.instrumentedParse = true;
98 
99   if (opts.programAction == DebugDumpProvenance ||
100       opts.programAction == Fortran::frontend::GetDefinition)
101     opts.needProvenanceRangeToCharBlockMappings = true;
102 }
103 
104 static bool ParseFrontendArgs(FrontendOptions &opts, llvm::opt::ArgList &args,
105     clang::DiagnosticsEngine &diags) {
106   unsigned numErrorsBefore = diags.getNumErrors();
107 
108   // By default the frontend driver creates a ParseSyntaxOnly action.
109   opts.programAction = ParseSyntaxOnly;
110 
111   // Treat multiple action options as an invocation error. Note that `clang
112   // -cc1` does accept multiple action options, but will only consider the
113   // rightmost one.
114   if (args.hasMultipleArgs(clang::driver::options::OPT_Action_Group)) {
115     const unsigned diagID = diags.getCustomDiagID(
116         clang::DiagnosticsEngine::Error, "Only one action option is allowed");
117     diags.Report(diagID);
118     return false;
119   }
120 
121   // Identify the action (i.e. opts.ProgramAction)
122   if (const llvm::opt::Arg *a =
123           args.getLastArg(clang::driver::options::OPT_Action_Group)) {
124     switch (a->getOption().getID()) {
125     default: {
126       llvm_unreachable("Invalid option in group!");
127     }
128     case clang::driver::options::OPT_test_io:
129       opts.programAction = InputOutputTest;
130       break;
131     case clang::driver::options::OPT_E:
132       opts.programAction = PrintPreprocessedInput;
133       break;
134     case clang::driver::options::OPT_fsyntax_only:
135       opts.programAction = ParseSyntaxOnly;
136       break;
137     case clang::driver::options::OPT_emit_obj:
138       opts.programAction = EmitObj;
139       break;
140     case clang::driver::options::OPT_fdebug_unparse:
141       opts.programAction = DebugUnparse;
142       break;
143     case clang::driver::options::OPT_fdebug_unparse_no_sema:
144       opts.programAction = DebugUnparseNoSema;
145       break;
146     case clang::driver::options::OPT_fdebug_unparse_with_symbols:
147       opts.programAction = DebugUnparseWithSymbols;
148       break;
149     case clang::driver::options::OPT_fdebug_dump_symbols:
150       opts.programAction = DebugDumpSymbols;
151       break;
152     case clang::driver::options::OPT_fdebug_dump_parse_tree:
153       opts.programAction = DebugDumpParseTree;
154       break;
155     case clang::driver::options::OPT_fdebug_dump_all:
156       opts.programAction = DebugDumpAll;
157       break;
158     case clang::driver::options::OPT_fdebug_dump_parse_tree_no_sema:
159       opts.programAction = DebugDumpParseTreeNoSema;
160       break;
161     case clang::driver::options::OPT_fdebug_dump_provenance:
162       opts.programAction = DebugDumpProvenance;
163       break;
164     case clang::driver::options::OPT_fdebug_dump_parsing_log:
165       opts.programAction = DebugDumpParsingLog;
166       break;
167     case clang::driver::options::OPT_fdebug_measure_parse_tree:
168       opts.programAction = DebugMeasureParseTree;
169       break;
170     case clang::driver::options::OPT_fdebug_pre_fir_tree:
171       opts.programAction = DebugPreFIRTree;
172       break;
173     case clang::driver::options::OPT_fget_symbols_sources:
174       opts.programAction = GetSymbolsSources;
175       break;
176     case clang::driver::options::OPT_fget_definition:
177       opts.programAction = GetDefinition;
178       break;
179     case clang::driver::options::OPT_init_only:
180       opts.programAction = InitOnly;
181       break;
182 
183       // TODO:
184       // case clang::driver::options::OPT_emit_llvm:
185       // case clang::driver::options::OPT_emit_llvm_only:
186       // case clang::driver::options::OPT_emit_codegen_only:
187       // case clang::driver::options::OPT_emit_module:
188       // (...)
189     }
190 
191     // Parse the values provided with `-fget-definition` (there should be 3
192     // integers)
193     if (llvm::opt::OptSpecifier(a->getOption().getID()) ==
194         clang::driver::options::OPT_fget_definition) {
195       unsigned optVals[3] = {0, 0, 0};
196 
197       for (unsigned i = 0; i < 3; i++) {
198         llvm::StringRef val = a->getValue(i);
199 
200         if (val.getAsInteger(10, optVals[i])) {
201           // A non-integer was encountered - that's an error.
202           diags.Report(clang::diag::err_drv_invalid_value)
203               << a->getOption().getName() << val;
204           break;
205         }
206       }
207       opts.getDefVals.line = optVals[0];
208       opts.getDefVals.startColumn = optVals[1];
209       opts.getDefVals.endColumn = optVals[2];
210     }
211   }
212 
213   // Parsing -load <dsopath> option and storing shared object path
214   if (llvm::opt::Arg *a = args.getLastArg(clang::driver::options::OPT_load)) {
215     opts.plugins.push_back(a->getValue());
216   }
217 
218   // Parsing -plugin <name> option and storing plugin name and setting action
219   if (const llvm::opt::Arg *a =
220           args.getLastArg(clang::driver::options::OPT_plugin)) {
221     opts.programAction = PluginAction;
222     opts.ActionName = a->getValue();
223   }
224 
225   opts.outputFile = args.getLastArgValue(clang::driver::options::OPT_o);
226   opts.showHelp = args.hasArg(clang::driver::options::OPT_help);
227   opts.showVersion = args.hasArg(clang::driver::options::OPT_version);
228 
229   // Get the input kind (from the value passed via `-x`)
230   InputKind dashX(Language::Unknown);
231   if (const llvm::opt::Arg *a =
232           args.getLastArg(clang::driver::options::OPT_x)) {
233     llvm::StringRef XValue = a->getValue();
234     // Principal languages.
235     dashX = llvm::StringSwitch<InputKind>(XValue)
236                 .Case("f90", Language::Fortran)
237                 .Default(Language::Unknown);
238 
239     // Some special cases cannot be combined with suffixes.
240     if (dashX.IsUnknown())
241       dashX = llvm::StringSwitch<InputKind>(XValue)
242                   .Case("ir", Language::LLVM_IR)
243                   .Default(Language::Unknown);
244 
245     if (dashX.IsUnknown())
246       diags.Report(clang::diag::err_drv_invalid_value)
247           << a->getAsString(args) << a->getValue();
248   }
249 
250   // Collect the input files and save them in our instance of FrontendOptions.
251   std::vector<std::string> inputs =
252       args.getAllArgValues(clang::driver::options::OPT_INPUT);
253   opts.inputs.clear();
254   if (inputs.empty())
255     // '-' is the default input if none is given.
256     inputs.push_back("-");
257   for (unsigned i = 0, e = inputs.size(); i != e; ++i) {
258     InputKind ik = dashX;
259     if (ik.IsUnknown()) {
260       ik = FrontendOptions::GetInputKindForExtension(
261           llvm::StringRef(inputs[i]).rsplit('.').second);
262       if (ik.IsUnknown())
263         ik = Language::Unknown;
264       if (i == 0)
265         dashX = ik;
266     }
267 
268     opts.inputs.emplace_back(std::move(inputs[i]), ik);
269   }
270 
271   // Set fortranForm based on options -ffree-form and -ffixed-form.
272   if (const auto *arg = args.getLastArg(clang::driver::options::OPT_ffixed_form,
273           clang::driver::options::OPT_ffree_form)) {
274     opts.fortranForm =
275         arg->getOption().matches(clang::driver::options::OPT_ffixed_form)
276         ? FortranForm::FixedForm
277         : FortranForm::FreeForm;
278   }
279 
280   // Set fixedFormColumns based on -ffixed-line-length=<value>
281   if (const auto *arg =
282           args.getLastArg(clang::driver::options::OPT_ffixed_line_length_EQ)) {
283     llvm::StringRef argValue = llvm::StringRef(arg->getValue());
284     std::int64_t columns = -1;
285     if (argValue == "none") {
286       columns = 0;
287     } else if (argValue.getAsInteger(/*Radix=*/10, columns)) {
288       columns = -1;
289     }
290     if (columns < 0) {
291       diags.Report(clang::diag::err_drv_negative_columns)
292           << arg->getOption().getName() << arg->getValue();
293     } else if (columns == 0) {
294       opts.fixedFormColumns = 1000000;
295     } else if (columns < 7) {
296       diags.Report(clang::diag::err_drv_small_columns)
297           << arg->getOption().getName() << arg->getValue() << "7";
298     } else {
299       opts.fixedFormColumns = columns;
300     }
301   }
302 
303   // -f{no-}implicit-none
304   opts.features.Enable(
305       Fortran::common::LanguageFeature::ImplicitNoneTypeAlways,
306       args.hasFlag(clang::driver::options::OPT_fimplicit_none,
307           clang::driver::options::OPT_fno_implicit_none, false));
308 
309   // -f{no-}backslash
310   opts.features.Enable(Fortran::common::LanguageFeature::BackslashEscapes,
311       args.hasFlag(clang::driver::options::OPT_fbackslash,
312           clang::driver::options::OPT_fno_backslash, false));
313 
314   // -f{no-}logical-abbreviations
315   opts.features.Enable(Fortran::common::LanguageFeature::LogicalAbbreviations,
316       args.hasFlag(clang::driver::options::OPT_flogical_abbreviations,
317           clang::driver::options::OPT_fno_logical_abbreviations, false));
318 
319   // -f{no-}xor-operator
320   opts.features.Enable(Fortran::common::LanguageFeature::XOROperator,
321       args.hasFlag(clang::driver::options::OPT_fxor_operator,
322           clang::driver::options::OPT_fno_xor_operator, false));
323 
324   // -fno-automatic
325   if (args.hasArg(clang::driver::options::OPT_fno_automatic)) {
326     opts.features.Enable(Fortran::common::LanguageFeature::DefaultSave);
327   }
328 
329   if (args.hasArg(
330           clang::driver::options::OPT_falternative_parameter_statement)) {
331     opts.features.Enable(Fortran::common::LanguageFeature::OldStyleParameter);
332   }
333   if (const llvm::opt::Arg *arg =
334           args.getLastArg(clang::driver::options::OPT_finput_charset_EQ)) {
335     llvm::StringRef argValue = arg->getValue();
336     if (argValue == "utf-8") {
337       opts.encoding = Fortran::parser::Encoding::UTF_8;
338     } else if (argValue == "latin-1") {
339       opts.encoding = Fortran::parser::Encoding::LATIN_1;
340     } else {
341       diags.Report(clang::diag::err_drv_invalid_value)
342           << arg->getAsString(args) << argValue;
343     }
344   }
345 
346   setUpFrontendBasedOnAction(opts);
347   opts.dashX = dashX;
348 
349   return diags.getNumErrors() == numErrorsBefore;
350 }
351 
352 // Generate the path to look for intrinsic modules
353 static std::string getIntrinsicDir() {
354   // TODO: Find a system independent API
355   llvm::SmallString<128> driverPath;
356   driverPath.assign(llvm::sys::fs::getMainExecutable(nullptr, nullptr));
357   llvm::sys::path::remove_filename(driverPath);
358   driverPath.append("/../include/flang/");
359   return std::string(driverPath);
360 }
361 
362 /// Parses all preprocessor input arguments and populates the preprocessor
363 /// options accordingly.
364 ///
365 /// \param [in] opts The preprocessor options instance
366 /// \param [out] args The list of input arguments
367 static void parsePreprocessorArgs(
368     Fortran::frontend::PreprocessorOptions &opts, llvm::opt::ArgList &args) {
369   // Add macros from the command line.
370   for (const auto *currentArg : args.filtered(
371            clang::driver::options::OPT_D, clang::driver::options::OPT_U)) {
372     if (currentArg->getOption().matches(clang::driver::options::OPT_D)) {
373       opts.addMacroDef(currentArg->getValue());
374     } else {
375       opts.addMacroUndef(currentArg->getValue());
376     }
377   }
378 
379   // Add the ordered list of -I's.
380   for (const auto *currentArg : args.filtered(clang::driver::options::OPT_I))
381     opts.searchDirectoriesFromDashI.emplace_back(currentArg->getValue());
382 
383   // Prepend the ordered list of -intrinsic-modules-path
384   // to the default location to search.
385   for (const auto *currentArg :
386       args.filtered(clang::driver::options::OPT_fintrinsic_modules_path))
387     opts.searchDirectoriesFromIntrModPath.emplace_back(currentArg->getValue());
388 
389   // -cpp/-nocpp
390   if (const auto *currentArg = args.getLastArg(
391           clang::driver::options::OPT_cpp, clang::driver::options::OPT_nocpp))
392     opts.macrosFlag =
393         (currentArg->getOption().matches(clang::driver::options::OPT_cpp))
394         ? PPMacrosFlag::Include
395         : PPMacrosFlag::Exclude;
396 
397   opts.noReformat = args.hasArg(clang::driver::options::OPT_fno_reformat);
398   opts.noLineDirectives = args.hasArg(clang::driver::options::OPT_P);
399 }
400 
401 /// Parses all semantic related arguments and populates the variables
402 /// options accordingly. Returns false if new errors are generated.
403 static bool parseSemaArgs(CompilerInvocation &res, llvm::opt::ArgList &args,
404     clang::DiagnosticsEngine &diags) {
405   unsigned numErrorsBefore = diags.getNumErrors();
406 
407   // -J/module-dir option
408   auto moduleDirList =
409       args.getAllArgValues(clang::driver::options::OPT_module_dir);
410   // User can only specify -J/-module-dir once
411   // https://gcc.gnu.org/onlinedocs/gfortran/Directory-Options.html
412   if (moduleDirList.size() > 1) {
413     const unsigned diagID =
414         diags.getCustomDiagID(clang::DiagnosticsEngine::Error,
415             "Only one '-module-dir/-J' option allowed");
416     diags.Report(diagID);
417   }
418   if (moduleDirList.size() == 1)
419     res.SetModuleDir(moduleDirList[0]);
420 
421   // -fdebug-module-writer option
422   if (args.hasArg(clang::driver::options::OPT_fdebug_module_writer)) {
423     res.SetDebugModuleDir(true);
424   }
425 
426   // -module-suffix
427   if (const auto *moduleSuffix =
428           args.getLastArg(clang::driver::options::OPT_module_suffix)) {
429     res.SetModuleFileSuffix(moduleSuffix->getValue());
430   }
431 
432   // -f{no-}analyzed-objects-for-unparse
433   res.SetUseAnalyzedObjectsForUnparse(
434       args.hasFlag(clang::driver::options::OPT_fanalyzed_objects_for_unparse,
435           clang::driver::options::OPT_fno_analyzed_objects_for_unparse, true));
436 
437   return diags.getNumErrors() == numErrorsBefore;
438 }
439 
440 /// Parses all diagnostics related arguments and populates the variables
441 /// options accordingly. Returns false if new errors are generated.
442 static bool parseDiagArgs(CompilerInvocation &res, llvm::opt::ArgList &args,
443     clang::DiagnosticsEngine &diags) {
444   unsigned numErrorsBefore = diags.getNumErrors();
445 
446   // -Werror option
447   // TODO: Currently throws a Diagnostic for anything other than -W<error>,
448   // this has to change when other -W<opt>'s are supported.
449   if (args.hasArg(clang::driver::options::OPT_W_Joined)) {
450     if (args.getLastArgValue(clang::driver::options::OPT_W_Joined)
451             .equals("error")) {
452       res.SetWarnAsErr(true);
453     } else {
454       const unsigned diagID =
455           diags.getCustomDiagID(clang::DiagnosticsEngine::Error,
456               "Only `-Werror` is supported currently.");
457       diags.Report(diagID);
458     }
459   }
460 
461   return diags.getNumErrors() == numErrorsBefore;
462 }
463 
464 /// Parses all Dialect related arguments and populates the variables
465 /// options accordingly. Returns false if new errors are generated.
466 static bool parseDialectArgs(CompilerInvocation &res, llvm::opt::ArgList &args,
467     clang::DiagnosticsEngine &diags) {
468   unsigned numErrorsBefore = diags.getNumErrors();
469 
470   // -fdefault* family
471   if (args.hasArg(clang::driver::options::OPT_fdefault_real_8)) {
472     res.defaultKinds().set_defaultRealKind(8);
473     res.defaultKinds().set_doublePrecisionKind(16);
474   }
475   if (args.hasArg(clang::driver::options::OPT_fdefault_integer_8)) {
476     res.defaultKinds().set_defaultIntegerKind(8);
477     res.defaultKinds().set_subscriptIntegerKind(8);
478     res.defaultKinds().set_sizeIntegerKind(8);
479   }
480   if (args.hasArg(clang::driver::options::OPT_fdefault_double_8)) {
481     if (!args.hasArg(clang::driver::options::OPT_fdefault_real_8)) {
482       // -fdefault-double-8 has to be used with -fdefault-real-8
483       // to be compatible with gfortran
484       const unsigned diagID =
485           diags.getCustomDiagID(clang::DiagnosticsEngine::Error,
486               "Use of `-fdefault-double-8` requires `-fdefault-real-8`");
487       diags.Report(diagID);
488     }
489     // https://gcc.gnu.org/onlinedocs/gfortran/Fortran-Dialect-Options.html
490     res.defaultKinds().set_doublePrecisionKind(8);
491   }
492   if (args.hasArg(clang::driver::options::OPT_flarge_sizes))
493     res.defaultKinds().set_sizeIntegerKind(8);
494 
495   // -fopenmp and -fopenacc
496   if (args.hasArg(clang::driver::options::OPT_fopenacc)) {
497     res.frontendOpts().features.Enable(
498         Fortran::common::LanguageFeature::OpenACC);
499   }
500   if (args.hasArg(clang::driver::options::OPT_fopenmp)) {
501     res.frontendOpts().features.Enable(
502         Fortran::common::LanguageFeature::OpenMP);
503   }
504 
505   // -pedantic
506   if (args.hasArg(clang::driver::options::OPT_pedantic)) {
507     res.set_EnableConformanceChecks();
508   }
509   // -std=f2018 (currently this implies -pedantic)
510   // TODO: Set proper options when more fortran standards
511   // are supported.
512   if (args.hasArg(clang::driver::options::OPT_std_EQ)) {
513     auto standard = args.getLastArgValue(clang::driver::options::OPT_std_EQ);
514     // We only allow f2018 as the given standard
515     if (standard.equals("f2018")) {
516       res.set_EnableConformanceChecks();
517     } else {
518       const unsigned diagID =
519           diags.getCustomDiagID(clang::DiagnosticsEngine::Error,
520               "Only -std=f2018 is allowed currently.");
521       diags.Report(diagID);
522     }
523   }
524   return diags.getNumErrors() == numErrorsBefore;
525 }
526 
527 bool CompilerInvocation::CreateFromArgs(CompilerInvocation &res,
528     llvm::ArrayRef<const char *> commandLineArgs,
529     clang::DiagnosticsEngine &diags) {
530 
531   bool success = true;
532 
533   // Parse the arguments
534   const llvm::opt::OptTable &opts = clang::driver::getDriverOptTable();
535   const unsigned includedFlagsBitmask = clang::driver::options::FC1Option;
536   unsigned missingArgIndex, missingArgCount;
537   llvm::opt::InputArgList args = opts.ParseArgs(
538       commandLineArgs, missingArgIndex, missingArgCount, includedFlagsBitmask);
539 
540   // Check for missing argument error.
541   if (missingArgCount) {
542     diags.Report(clang::diag::err_drv_missing_argument)
543         << args.getArgString(missingArgIndex) << missingArgCount;
544     success = false;
545   }
546 
547   // Issue errors on unknown arguments
548   for (const auto *a : args.filtered(clang::driver::options::OPT_UNKNOWN)) {
549     auto argString = a->getAsString(args);
550     std::string nearest;
551     if (opts.findNearest(argString, nearest, includedFlagsBitmask) > 1)
552       diags.Report(clang::diag::err_drv_unknown_argument) << argString;
553     else
554       diags.Report(clang::diag::err_drv_unknown_argument_with_suggestion)
555           << argString << nearest;
556     success = false;
557   }
558 
559   success &= ParseFrontendArgs(res.frontendOpts(), args, diags);
560   parsePreprocessorArgs(res.preprocessorOpts(), args);
561   success &= parseSemaArgs(res, args, diags);
562   success &= parseDialectArgs(res, args, diags);
563   success &= parseDiagArgs(res, args, diags);
564 
565   return success;
566 }
567 
568 void CompilerInvocation::collectMacroDefinitions() {
569   auto &ppOpts = this->preprocessorOpts();
570 
571   for (unsigned i = 0, n = ppOpts.macros.size(); i != n; ++i) {
572     llvm::StringRef macro = ppOpts.macros[i].first;
573     bool isUndef = ppOpts.macros[i].second;
574 
575     std::pair<llvm::StringRef, llvm::StringRef> macroPair = macro.split('=');
576     llvm::StringRef macroName = macroPair.first;
577     llvm::StringRef macroBody = macroPair.second;
578 
579     // For an #undef'd macro, we only care about the name.
580     if (isUndef) {
581       parserOpts_.predefinitions.emplace_back(
582           macroName.str(), std::optional<std::string>{});
583       continue;
584     }
585 
586     // For a #define'd macro, figure out the actual definition.
587     if (macroName.size() == macro.size())
588       macroBody = "1";
589     else {
590       // Note: GCC drops anything following an end-of-line character.
591       llvm::StringRef::size_type End = macroBody.find_first_of("\n\r");
592       macroBody = macroBody.substr(0, End);
593     }
594     parserOpts_.predefinitions.emplace_back(
595         macroName, std::optional<std::string>(macroBody.str()));
596   }
597 }
598 
599 void CompilerInvocation::SetDefaultFortranOpts() {
600   auto &fortranOptions = fortranOpts();
601 
602   std::vector<std::string> searchDirectories{"."s};
603   fortranOptions.searchDirectories = searchDirectories;
604   fortranOptions.isFixedForm = false;
605 }
606 
607 // TODO: When expanding this method, consider creating a dedicated API for
608 // this. Also at some point we will need to differentiate between different
609 // targets and add dedicated predefines for each.
610 void CompilerInvocation::setDefaultPredefinitions() {
611   auto &fortranOptions = fortranOpts();
612   const auto &frontendOptions = frontendOpts();
613 
614   // Populate the macro list with version numbers and other predefinitions.
615   fortranOptions.predefinitions.emplace_back("__flang__", "1");
616   fortranOptions.predefinitions.emplace_back(
617       "__flang_major__", FLANG_VERSION_MAJOR_STRING);
618   fortranOptions.predefinitions.emplace_back(
619       "__flang_minor__", FLANG_VERSION_MINOR_STRING);
620   fortranOptions.predefinitions.emplace_back(
621       "__flang_patchlevel__", FLANG_VERSION_PATCHLEVEL_STRING);
622 
623   // Add predefinitions based on extensions enabled
624   if (frontendOptions.features.IsEnabled(
625           Fortran::common::LanguageFeature::OpenACC)) {
626     fortranOptions.predefinitions.emplace_back("_OPENACC", "202011");
627   }
628   if (frontendOptions.features.IsEnabled(
629           Fortran::common::LanguageFeature::OpenMP)) {
630     fortranOptions.predefinitions.emplace_back("_OPENMP", "201511");
631   }
632 }
633 
634 void CompilerInvocation::setFortranOpts() {
635   auto &fortranOptions = fortranOpts();
636   const auto &frontendOptions = frontendOpts();
637   const auto &preprocessorOptions = preprocessorOpts();
638   auto &moduleDirJ = moduleDir();
639 
640   if (frontendOptions.fortranForm != FortranForm::Unknown) {
641     fortranOptions.isFixedForm =
642         frontendOptions.fortranForm == FortranForm::FixedForm;
643   }
644   fortranOptions.fixedFormColumns = frontendOptions.fixedFormColumns;
645 
646   fortranOptions.features = frontendOptions.features;
647   fortranOptions.encoding = frontendOptions.encoding;
648 
649   // Adding search directories specified by -I
650   fortranOptions.searchDirectories.insert(
651       fortranOptions.searchDirectories.end(),
652       preprocessorOptions.searchDirectoriesFromDashI.begin(),
653       preprocessorOptions.searchDirectoriesFromDashI.end());
654 
655   // Add the ordered list of -intrinsic-modules-path
656   fortranOptions.searchDirectories.insert(
657       fortranOptions.searchDirectories.end(),
658       preprocessorOptions.searchDirectoriesFromIntrModPath.begin(),
659       preprocessorOptions.searchDirectoriesFromIntrModPath.end());
660 
661   //  Add the default intrinsic module directory at the end
662   fortranOptions.searchDirectories.emplace_back(getIntrinsicDir());
663 
664   // Add the directory supplied through -J/-module-dir to the list of search
665   // directories
666   if (moduleDirJ.compare(".") != 0)
667     fortranOptions.searchDirectories.emplace_back(moduleDirJ);
668 
669   if (frontendOptions.instrumentedParse)
670     fortranOptions.instrumentedParse = true;
671 
672   if (frontendOptions.needProvenanceRangeToCharBlockMappings)
673     fortranOptions.needProvenanceRangeToCharBlockMappings = true;
674 
675   if (enableConformanceChecks()) {
676     fortranOptions.features.WarnOnAllNonstandard();
677   }
678 }
679 
680 void CompilerInvocation::setSemanticsOpts(
681     Fortran::parser::AllCookedSources &allCookedSources) {
682   const auto &fortranOptions = fortranOpts();
683 
684   semanticsContext_ = std::make_unique<semantics::SemanticsContext>(
685       defaultKinds(), fortranOptions.features, allCookedSources);
686 
687   semanticsContext_->set_moduleDirectory(moduleDir())
688       .set_searchDirectories(fortranOptions.searchDirectories)
689       .set_warnOnNonstandardUsage(enableConformanceChecks())
690       .set_warningsAreErrors(warnAsErr())
691       .set_moduleFileSuffix(moduleFileSuffix());
692 }
693