Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1 | //===-- CommandLine.cpp - Command line parser implementation --------------===// |
Misha Brukman | 10468d8 | 2005-04-21 22:55:34 +0000 | [diff] [blame] | 2 | // |
John Criswell | 482202a | 2003-10-20 19:43:21 +0000 | [diff] [blame] | 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
Chris Lattner | f3ebc3f | 2007-12-29 20:36:04 +0000 | [diff] [blame] | 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
Misha Brukman | 10468d8 | 2005-04-21 22:55:34 +0000 | [diff] [blame] | 7 | // |
John Criswell | 482202a | 2003-10-20 19:43:21 +0000 | [diff] [blame] | 8 | //===----------------------------------------------------------------------===// |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 9 | // |
| 10 | // This class implements a command line argument processor that is useful when |
| 11 | // creating a tool. It provides a simple, minimalistic interface that is easily |
| 12 | // extensible and supports nonlocal (library) command line options. |
| 13 | // |
Chris Lattner | 81cc83d | 2001-07-23 23:04:07 +0000 | [diff] [blame] | 14 | // Note that rather than trying to figure out what this code does, you could try |
| 15 | // reading the library documentation located in docs/CommandLine.html |
| 16 | // |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 17 | //===----------------------------------------------------------------------===// |
| 18 | |
Reid Spencer | 7c16caa | 2004-09-01 22:55:40 +0000 | [diff] [blame] | 19 | #include "llvm/Support/CommandLine.h" |
Peter Collingbourne | e186319 | 2014-10-16 22:47:52 +0000 | [diff] [blame] | 20 | #include "llvm-c/Support.h" |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 21 | #include "llvm/ADT/ArrayRef.h" |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 22 | #include "llvm/ADT/DenseMap.h" |
David Majnemer | afb38af | 2016-07-24 17:19:59 +0000 | [diff] [blame] | 23 | #include "llvm/ADT/Optional.h" |
Benjamin Kramer | bd5ee50 | 2015-03-14 00:20:13 +0000 | [diff] [blame] | 24 | #include "llvm/ADT/STLExtras.h" |
Chris Lattner | 41f8b0b | 2009-09-20 05:12:14 +0000 | [diff] [blame] | 25 | #include "llvm/ADT/SmallPtrSet.h" |
Chris Lattner | fa9c6f4 | 2009-09-19 23:59:02 +0000 | [diff] [blame] | 26 | #include "llvm/ADT/SmallString.h" |
Pavel Labath | ec000f4 | 2017-06-23 12:55:02 +0000 | [diff] [blame] | 27 | #include "llvm/ADT/StringExtras.h" |
Chris Lattner | 41f8b0b | 2009-09-20 05:12:14 +0000 | [diff] [blame] | 28 | #include "llvm/ADT/StringMap.h" |
Chris Lattner | aecd74d | 2009-09-19 18:55:05 +0000 | [diff] [blame] | 29 | #include "llvm/ADT/Twine.h" |
Chris Lattner | 36b3caf | 2009-08-23 18:09:02 +0000 | [diff] [blame] | 30 | #include "llvm/Config/config.h" |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 31 | #include "llvm/Support/ConvertUTF.h" |
Chandler Carruth | ed0881b | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 32 | #include "llvm/Support/Debug.h" |
| 33 | #include "llvm/Support/ErrorHandling.h" |
Serge Pavlov | f258ff1 | 2016-11-20 06:25:07 +0000 | [diff] [blame] | 34 | #include "llvm/Support/FileSystem.h" |
Chandler Carruth | ed0881b | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 35 | #include "llvm/Support/Host.h" |
| 36 | #include "llvm/Support/ManagedStatic.h" |
| 37 | #include "llvm/Support/MemoryBuffer.h" |
| 38 | #include "llvm/Support/Path.h" |
David Majnemer | afb38af | 2016-07-24 17:19:59 +0000 | [diff] [blame] | 39 | #include "llvm/Support/Process.h" |
Rafael Espindola | 454adf6 | 2015-06-13 12:49:52 +0000 | [diff] [blame] | 40 | #include "llvm/Support/StringSaver.h" |
Chandler Carruth | ed0881b | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 41 | #include "llvm/Support/raw_ostream.h" |
Chris Lattner | 36b3caf | 2009-08-23 18:09:02 +0000 | [diff] [blame] | 42 | #include <cstdlib> |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 43 | #include <map> |
Chris Lattner | c9499b6 | 2003-12-14 21:35:53 +0000 | [diff] [blame] | 44 | using namespace llvm; |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 45 | using namespace cl; |
| 46 | |
Chandler Carruth | e96dd89 | 2014-04-21 22:55:11 +0000 | [diff] [blame] | 47 | #define DEBUG_TYPE "commandline" |
| 48 | |
Chris Lattner | 3e5d60f | 2006-08-27 12:45:47 +0000 | [diff] [blame] | 49 | //===----------------------------------------------------------------------===// |
| 50 | // Template instantiations and anchors. |
| 51 | // |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 52 | namespace llvm { |
| 53 | namespace cl { |
Benjamin Kramer | a667d1a | 2015-07-13 17:21:31 +0000 | [diff] [blame] | 54 | template class basic_parser<bool>; |
| 55 | template class basic_parser<boolOrDefault>; |
| 56 | template class basic_parser<int>; |
| 57 | template class basic_parser<unsigned>; |
| 58 | template class basic_parser<unsigned long long>; |
| 59 | template class basic_parser<double>; |
| 60 | template class basic_parser<float>; |
| 61 | template class basic_parser<std::string>; |
| 62 | template class basic_parser<char>; |
Chris Lattner | 3e5d60f | 2006-08-27 12:45:47 +0000 | [diff] [blame] | 63 | |
Benjamin Kramer | a667d1a | 2015-07-13 17:21:31 +0000 | [diff] [blame] | 64 | template class opt<unsigned>; |
| 65 | template class opt<int>; |
| 66 | template class opt<std::string>; |
| 67 | template class opt<char>; |
| 68 | template class opt<bool>; |
Alexander Kornienko | f00654e | 2015-06-23 09:49:53 +0000 | [diff] [blame] | 69 | } |
| 70 | } // end namespace llvm::cl |
Chris Lattner | 3e5d60f | 2006-08-27 12:45:47 +0000 | [diff] [blame] | 71 | |
Juergen Ributzka | d12ccbd | 2013-11-19 00:57:56 +0000 | [diff] [blame] | 72 | // Pin the vtables to this file. |
| 73 | void GenericOptionValue::anchor() {} |
David Blaikie | 3a15e14 | 2011-12-01 08:00:17 +0000 | [diff] [blame] | 74 | void OptionValue<boolOrDefault>::anchor() {} |
| 75 | void OptionValue<std::string>::anchor() {} |
Chris Lattner | 3e5d60f | 2006-08-27 12:45:47 +0000 | [diff] [blame] | 76 | void Option::anchor() {} |
| 77 | void basic_parser_impl::anchor() {} |
| 78 | void parser<bool>::anchor() {} |
Dale Johannesen | 82810c8 | 2007-05-22 17:14:46 +0000 | [diff] [blame] | 79 | void parser<boolOrDefault>::anchor() {} |
Chris Lattner | 3e5d60f | 2006-08-27 12:45:47 +0000 | [diff] [blame] | 80 | void parser<int>::anchor() {} |
| 81 | void parser<unsigned>::anchor() {} |
Benjamin Kramer | 49fc9dd | 2011-09-15 21:17:37 +0000 | [diff] [blame] | 82 | void parser<unsigned long long>::anchor() {} |
Chris Lattner | 3e5d60f | 2006-08-27 12:45:47 +0000 | [diff] [blame] | 83 | void parser<double>::anchor() {} |
| 84 | void parser<float>::anchor() {} |
| 85 | void parser<std::string>::anchor() {} |
Bill Wendling | db59fda | 2009-04-29 23:26:16 +0000 | [diff] [blame] | 86 | void parser<char>::anchor() {} |
Chris Lattner | 3e5d60f | 2006-08-27 12:45:47 +0000 | [diff] [blame] | 87 | |
| 88 | //===----------------------------------------------------------------------===// |
| 89 | |
Benjamin Kramer | 970eac4 | 2015-02-06 17:51:54 +0000 | [diff] [blame] | 90 | namespace { |
| 91 | |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 92 | class CommandLineParser { |
| 93 | public: |
| 94 | // Globals for name and overview of program. Program name is not a string to |
| 95 | // avoid static ctor/dtor issues. |
Chris Bieneman | b686642 | 2015-01-28 22:25:00 +0000 | [diff] [blame] | 96 | std::string ProgramName; |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 97 | StringRef ProgramOverview; |
Reid Spencer | 9501b9b | 2004-09-01 04:41:28 +0000 | [diff] [blame] | 98 | |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 99 | // This collects additional help to be printed. |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 100 | std::vector<StringRef> MoreHelp; |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 101 | |
Chris Bieneman | 67e426a | 2015-02-13 22:54:32 +0000 | [diff] [blame] | 102 | // This collects the different option categories that have been registered. |
| 103 | SmallPtrSet<OptionCategory *, 16> RegisteredOptionCategories; |
| 104 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 105 | // This collects the different subcommands that have been registered. |
| 106 | SmallPtrSet<SubCommand *, 4> RegisteredSubCommands; |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 107 | |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 108 | CommandLineParser() : ActiveSubCommand(nullptr) { |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 109 | registerSubCommand(&*TopLevelSubCommand); |
| 110 | registerSubCommand(&*AllSubCommands); |
| 111 | } |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 112 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 113 | void ResetAllOptionOccurrences(); |
| 114 | |
| 115 | bool ParseCommandLineOptions(int argc, const char *const *argv, |
Eric Liu | e51ee06 | 2017-03-15 08:41:00 +0000 | [diff] [blame] | 116 | StringRef Overview, raw_ostream *Errs = nullptr); |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 117 | |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 118 | void addLiteralOption(Option &Opt, SubCommand *SC, StringRef Name) { |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 119 | if (Opt.hasArgStr()) |
| 120 | return; |
| 121 | if (!SC->OptionsMap.insert(std::make_pair(Name, &Opt)).second) { |
| 122 | errs() << ProgramName << ": CommandLine Error: Option '" << Name |
| 123 | << "' registered more than once!\n"; |
| 124 | report_fatal_error("inconsistency in registered CommandLine options"); |
| 125 | } |
| 126 | |
| 127 | // If we're adding this to all sub-commands, add it to the ones that have |
| 128 | // already been registered. |
| 129 | if (SC == &*AllSubCommands) { |
| 130 | for (const auto &Sub : RegisteredSubCommands) { |
| 131 | if (SC == Sub) |
| 132 | continue; |
| 133 | addLiteralOption(Opt, Sub, Name); |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 134 | } |
| 135 | } |
| 136 | } |
| 137 | |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 138 | void addLiteralOption(Option &Opt, StringRef Name) { |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 139 | if (Opt.Subs.empty()) |
| 140 | addLiteralOption(Opt, &*TopLevelSubCommand, Name); |
| 141 | else { |
| 142 | for (auto SC : Opt.Subs) |
| 143 | addLiteralOption(Opt, SC, Name); |
| 144 | } |
| 145 | } |
| 146 | |
| 147 | void addOption(Option *O, SubCommand *SC) { |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 148 | bool HadErrors = false; |
David Blaikie | ff43d69 | 2015-11-17 19:00:52 +0000 | [diff] [blame] | 149 | if (O->hasArgStr()) { |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 150 | // Add argument to the argument map! |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 151 | if (!SC->OptionsMap.insert(std::make_pair(O->ArgStr, O)).second) { |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 152 | errs() << ProgramName << ": CommandLine Error: Option '" << O->ArgStr |
| 153 | << "' registered more than once!\n"; |
| 154 | HadErrors = true; |
| 155 | } |
| 156 | } |
| 157 | |
| 158 | // Remember information about positional options. |
| 159 | if (O->getFormattingFlag() == cl::Positional) |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 160 | SC->PositionalOpts.push_back(O); |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 161 | else if (O->getMiscFlags() & cl::Sink) // Remember sink options |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 162 | SC->SinkOpts.push_back(O); |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 163 | else if (O->getNumOccurrencesFlag() == cl::ConsumeAfter) { |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 164 | if (SC->ConsumeAfterOpt) { |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 165 | O->error("Cannot specify more than one option with cl::ConsumeAfter!"); |
| 166 | HadErrors = true; |
| 167 | } |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 168 | SC->ConsumeAfterOpt = O; |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 169 | } |
| 170 | |
| 171 | // Fail hard if there were errors. These are strictly unrecoverable and |
| 172 | // indicate serious issues such as conflicting option names or an |
| 173 | // incorrectly |
| 174 | // linked LLVM distribution. |
| 175 | if (HadErrors) |
| 176 | report_fatal_error("inconsistency in registered CommandLine options"); |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 177 | |
| 178 | // If we're adding this to all sub-commands, add it to the ones that have |
| 179 | // already been registered. |
| 180 | if (SC == &*AllSubCommands) { |
| 181 | for (const auto &Sub : RegisteredSubCommands) { |
| 182 | if (SC == Sub) |
| 183 | continue; |
| 184 | addOption(O, Sub); |
| 185 | } |
| 186 | } |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 187 | } |
| 188 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 189 | void addOption(Option *O) { |
| 190 | if (O->Subs.empty()) { |
| 191 | addOption(O, &*TopLevelSubCommand); |
| 192 | } else { |
| 193 | for (auto SC : O->Subs) |
| 194 | addOption(O, SC); |
| 195 | } |
| 196 | } |
| 197 | |
| 198 | void removeOption(Option *O, SubCommand *SC) { |
David Blaikie | ff43d69 | 2015-11-17 19:00:52 +0000 | [diff] [blame] | 199 | SmallVector<StringRef, 16> OptionNames; |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 200 | O->getExtraOptionNames(OptionNames); |
David Blaikie | ff43d69 | 2015-11-17 19:00:52 +0000 | [diff] [blame] | 201 | if (O->hasArgStr()) |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 202 | OptionNames.push_back(O->ArgStr); |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 203 | |
| 204 | SubCommand &Sub = *SC; |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 205 | for (auto Name : OptionNames) |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 206 | Sub.OptionsMap.erase(Name); |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 207 | |
| 208 | if (O->getFormattingFlag() == cl::Positional) |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 209 | for (auto Opt = Sub.PositionalOpts.begin(); |
| 210 | Opt != Sub.PositionalOpts.end(); ++Opt) { |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 211 | if (*Opt == O) { |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 212 | Sub.PositionalOpts.erase(Opt); |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 213 | break; |
| 214 | } |
| 215 | } |
| 216 | else if (O->getMiscFlags() & cl::Sink) |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 217 | for (auto Opt = Sub.SinkOpts.begin(); Opt != Sub.SinkOpts.end(); ++Opt) { |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 218 | if (*Opt == O) { |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 219 | Sub.SinkOpts.erase(Opt); |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 220 | break; |
| 221 | } |
| 222 | } |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 223 | else if (O == Sub.ConsumeAfterOpt) |
| 224 | Sub.ConsumeAfterOpt = nullptr; |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 225 | } |
| 226 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 227 | void removeOption(Option *O) { |
| 228 | if (O->Subs.empty()) |
| 229 | removeOption(O, &*TopLevelSubCommand); |
| 230 | else { |
| 231 | if (O->isInAllSubCommands()) { |
| 232 | for (auto SC : RegisteredSubCommands) |
| 233 | removeOption(O, SC); |
| 234 | } else { |
| 235 | for (auto SC : O->Subs) |
| 236 | removeOption(O, SC); |
| 237 | } |
| 238 | } |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 239 | } |
| 240 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 241 | bool hasOptions(const SubCommand &Sub) const { |
| 242 | return (!Sub.OptionsMap.empty() || !Sub.PositionalOpts.empty() || |
| 243 | nullptr != Sub.ConsumeAfterOpt); |
| 244 | } |
| 245 | |
| 246 | bool hasOptions() const { |
| 247 | for (const auto &S : RegisteredSubCommands) { |
| 248 | if (hasOptions(*S)) |
| 249 | return true; |
| 250 | } |
| 251 | return false; |
| 252 | } |
| 253 | |
| 254 | SubCommand *getActiveSubCommand() { return ActiveSubCommand; } |
| 255 | |
| 256 | void updateArgStr(Option *O, StringRef NewName, SubCommand *SC) { |
| 257 | SubCommand &Sub = *SC; |
| 258 | if (!Sub.OptionsMap.insert(std::make_pair(NewName, O)).second) { |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 259 | errs() << ProgramName << ": CommandLine Error: Option '" << O->ArgStr |
| 260 | << "' registered more than once!\n"; |
| 261 | report_fatal_error("inconsistency in registered CommandLine options"); |
| 262 | } |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 263 | Sub.OptionsMap.erase(O->ArgStr); |
| 264 | } |
| 265 | |
| 266 | void updateArgStr(Option *O, StringRef NewName) { |
| 267 | if (O->Subs.empty()) |
| 268 | updateArgStr(O, NewName, &*TopLevelSubCommand); |
| 269 | else { |
| 270 | for (auto SC : O->Subs) |
| 271 | updateArgStr(O, NewName, SC); |
| 272 | } |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 273 | } |
Chris Bieneman | d77bbab | 2015-01-30 22:16:01 +0000 | [diff] [blame] | 274 | |
| 275 | void printOptionValues(); |
Chris Bieneman | 542f56a | 2015-02-13 22:54:27 +0000 | [diff] [blame] | 276 | |
Chris Bieneman | 67e426a | 2015-02-13 22:54:32 +0000 | [diff] [blame] | 277 | void registerCategory(OptionCategory *cat) { |
Sanjoy Das | 39c226f | 2016-06-10 21:18:39 +0000 | [diff] [blame] | 278 | assert(count_if(RegisteredOptionCategories, |
| 279 | [cat](const OptionCategory *Category) { |
| 280 | return cat->getName() == Category->getName(); |
| 281 | }) == 0 && |
Chris Bieneman | 67e426a | 2015-02-13 22:54:32 +0000 | [diff] [blame] | 282 | "Duplicate option categories"); |
| 283 | |
| 284 | RegisteredOptionCategories.insert(cat); |
| 285 | } |
| 286 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 287 | void registerSubCommand(SubCommand *sub) { |
| 288 | assert(count_if(RegisteredSubCommands, |
| 289 | [sub](const SubCommand *Sub) { |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 290 | return (!sub->getName().empty()) && |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 291 | (Sub->getName() == sub->getName()); |
| 292 | }) == 0 && |
| 293 | "Duplicate subcommands"); |
| 294 | RegisteredSubCommands.insert(sub); |
| 295 | |
| 296 | // For all options that have been registered for all subcommands, add the |
| 297 | // option to this subcommand now. |
| 298 | if (sub != &*AllSubCommands) { |
| 299 | for (auto &E : AllSubCommands->OptionsMap) { |
| 300 | Option *O = E.second; |
| 301 | if ((O->isPositional() || O->isSink() || O->isConsumeAfter()) || |
| 302 | O->hasArgStr()) |
| 303 | addOption(O, sub); |
| 304 | else |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 305 | addLiteralOption(*O, sub, E.first()); |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 306 | } |
| 307 | } |
| 308 | } |
| 309 | |
| 310 | void unregisterSubCommand(SubCommand *sub) { |
| 311 | RegisteredSubCommands.erase(sub); |
| 312 | } |
| 313 | |
Dean Michael Berris | 27358cf | 2016-10-05 05:20:08 +0000 | [diff] [blame] | 314 | iterator_range<typename SmallPtrSet<SubCommand *, 4>::iterator> |
| 315 | getRegisteredSubcommands() { |
| 316 | return make_range(RegisteredSubCommands.begin(), |
| 317 | RegisteredSubCommands.end()); |
| 318 | } |
| 319 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 320 | void reset() { |
| 321 | ActiveSubCommand = nullptr; |
| 322 | ProgramName.clear(); |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 323 | ProgramOverview = StringRef(); |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 324 | |
| 325 | MoreHelp.clear(); |
| 326 | RegisteredOptionCategories.clear(); |
| 327 | |
| 328 | ResetAllOptionOccurrences(); |
| 329 | RegisteredSubCommands.clear(); |
| 330 | |
| 331 | TopLevelSubCommand->reset(); |
| 332 | AllSubCommands->reset(); |
| 333 | registerSubCommand(&*TopLevelSubCommand); |
| 334 | registerSubCommand(&*AllSubCommands); |
| 335 | } |
| 336 | |
Chris Bieneman | 542f56a | 2015-02-13 22:54:27 +0000 | [diff] [blame] | 337 | private: |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 338 | SubCommand *ActiveSubCommand; |
| 339 | |
| 340 | Option *LookupOption(SubCommand &Sub, StringRef &Arg, StringRef &Value); |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 341 | SubCommand *LookupSubCommand(StringRef Name); |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 342 | }; |
| 343 | |
Benjamin Kramer | 970eac4 | 2015-02-06 17:51:54 +0000 | [diff] [blame] | 344 | } // namespace |
| 345 | |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 346 | static ManagedStatic<CommandLineParser> GlobalParser; |
| 347 | |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 348 | void cl::AddLiteralOption(Option &O, StringRef Name) { |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 349 | GlobalParser->addLiteralOption(O, Name); |
| 350 | } |
Chris Lattner | 37bcd99 | 2004-11-19 17:08:15 +0000 | [diff] [blame] | 351 | |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 352 | extrahelp::extrahelp(StringRef Help) : morehelp(Help) { |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 353 | GlobalParser->MoreHelp.push_back(Help); |
Chris Lattner | 37bcd99 | 2004-11-19 17:08:15 +0000 | [diff] [blame] | 354 | } |
| 355 | |
Chris Lattner | 5247f60 | 2007-04-06 21:06:55 +0000 | [diff] [blame] | 356 | void Option::addArgument() { |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 357 | GlobalParser->addOption(this); |
| 358 | FullyInitialized = true; |
Chris Lattner | 5247f60 | 2007-04-06 21:06:55 +0000 | [diff] [blame] | 359 | } |
| 360 | |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 361 | void Option::removeArgument() { GlobalParser->removeOption(this); } |
| 362 | |
David Blaikie | ff43d69 | 2015-11-17 19:00:52 +0000 | [diff] [blame] | 363 | void Option::setArgStr(StringRef S) { |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 364 | if (FullyInitialized) |
| 365 | GlobalParser->updateArgStr(this, S); |
Mehdi Amini | e4c7f12 | 2017-01-08 22:30:43 +0000 | [diff] [blame] | 366 | assert((S.empty() || S[0] != '-') && "Option can't start with '-"); |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 367 | ArgStr = S; |
Jordan Rose | c25b0c7 | 2014-01-29 18:54:17 +0000 | [diff] [blame] | 368 | } |
| 369 | |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 370 | // Initialise the general option category. |
| 371 | OptionCategory llvm::cl::GeneralCategory("General options"); |
| 372 | |
Benjamin Kramer | 3a377bc | 2014-03-01 11:47:00 +0000 | [diff] [blame] | 373 | void OptionCategory::registerCategory() { |
Chris Bieneman | 67e426a | 2015-02-13 22:54:32 +0000 | [diff] [blame] | 374 | GlobalParser->registerCategory(this); |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 375 | } |
Chris Lattner | af039c5 | 2007-04-12 00:36:29 +0000 | [diff] [blame] | 376 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 377 | // A special subcommand representing no subcommand |
| 378 | ManagedStatic<SubCommand> llvm::cl::TopLevelSubCommand; |
| 379 | |
| 380 | // A special subcommand that can be used to put an option into all subcommands. |
| 381 | ManagedStatic<SubCommand> llvm::cl::AllSubCommands; |
| 382 | |
| 383 | void SubCommand::registerSubCommand() { |
| 384 | GlobalParser->registerSubCommand(this); |
| 385 | } |
| 386 | |
| 387 | void SubCommand::unregisterSubCommand() { |
| 388 | GlobalParser->unregisterSubCommand(this); |
| 389 | } |
| 390 | |
| 391 | void SubCommand::reset() { |
| 392 | PositionalOpts.clear(); |
| 393 | SinkOpts.clear(); |
| 394 | OptionsMap.clear(); |
| 395 | |
| 396 | ConsumeAfterOpt = nullptr; |
| 397 | } |
| 398 | |
| 399 | SubCommand::operator bool() const { |
| 400 | return (GlobalParser->getActiveSubCommand() == this); |
| 401 | } |
| 402 | |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 403 | //===----------------------------------------------------------------------===// |
Chris Lattner | 3e5d60f | 2006-08-27 12:45:47 +0000 | [diff] [blame] | 404 | // Basic, shared command line option processing machinery. |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 405 | // |
| 406 | |
Chris Lattner | 2031b02 | 2007-04-05 21:58:17 +0000 | [diff] [blame] | 407 | /// LookupOption - Lookup the option specified by the specified option on the |
| 408 | /// command line. If there is a value specified (after an equal sign) return |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 409 | /// that as well. This assumes that leading dashes have already been stripped. |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 410 | Option *CommandLineParser::LookupOption(SubCommand &Sub, StringRef &Arg, |
| 411 | StringRef &Value) { |
Chris Lattner | 5a3fa4e | 2009-09-20 02:02:24 +0000 | [diff] [blame] | 412 | // Reject all dashes. |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 413 | if (Arg.empty()) |
| 414 | return nullptr; |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 415 | assert(&Sub != &*AllSubCommands); |
Mikhail Glushenkov | 1d9f1fe | 2009-11-19 17:29:36 +0000 | [diff] [blame] | 416 | |
Chris Lattner | 5a3fa4e | 2009-09-20 02:02:24 +0000 | [diff] [blame] | 417 | size_t EqualPos = Arg.find('='); |
Mikhail Glushenkov | 1d9f1fe | 2009-11-19 17:29:36 +0000 | [diff] [blame] | 418 | |
Chris Lattner | 0a40a97 | 2009-09-20 01:53:12 +0000 | [diff] [blame] | 419 | // If we have an equals sign, remember the value. |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 420 | if (EqualPos == StringRef::npos) { |
| 421 | // Look up the option. |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 422 | auto I = Sub.OptionsMap.find(Arg); |
| 423 | if (I == Sub.OptionsMap.end()) |
| 424 | return nullptr; |
| 425 | |
| 426 | return I != Sub.OptionsMap.end() ? I->second : nullptr; |
Chris Lattner | 5a3fa4e | 2009-09-20 02:02:24 +0000 | [diff] [blame] | 427 | } |
Mikhail Glushenkov | 5653d3b | 2008-04-28 16:44:25 +0000 | [diff] [blame] | 428 | |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 429 | // If the argument before the = is a valid option name, we match. If not, |
| 430 | // return Arg unmolested. |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 431 | auto I = Sub.OptionsMap.find(Arg.substr(0, EqualPos)); |
| 432 | if (I == Sub.OptionsMap.end()) |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 433 | return nullptr; |
Mikhail Glushenkov | 1d9f1fe | 2009-11-19 17:29:36 +0000 | [diff] [blame] | 434 | |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 435 | Value = Arg.substr(EqualPos + 1); |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 436 | Arg = Arg.substr(0, EqualPos); |
| 437 | return I->second; |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 438 | } |
| 439 | |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 440 | SubCommand *CommandLineParser::LookupSubCommand(StringRef Name) { |
| 441 | if (Name.empty()) |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 442 | return &*TopLevelSubCommand; |
| 443 | for (auto S : RegisteredSubCommands) { |
| 444 | if (S == &*AllSubCommands) |
| 445 | continue; |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 446 | if (S->getName().empty()) |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 447 | continue; |
| 448 | |
| 449 | if (StringRef(S->getName()) == StringRef(Name)) |
| 450 | return S; |
| 451 | } |
| 452 | return &*TopLevelSubCommand; |
| 453 | } |
| 454 | |
Daniel Dunbar | f413213 | 2011-01-18 01:59:24 +0000 | [diff] [blame] | 455 | /// LookupNearestOption - Lookup the closest match to the option specified by |
| 456 | /// the specified option on the command line. If there is a value specified |
| 457 | /// (after an equal sign) return that as well. This assumes that leading dashes |
| 458 | /// have already been stripped. |
| 459 | static Option *LookupNearestOption(StringRef Arg, |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 460 | const StringMap<Option *> &OptionsMap, |
Nick Lewycky | e75ffa1 | 2011-05-02 05:24:47 +0000 | [diff] [blame] | 461 | std::string &NearestString) { |
Daniel Dunbar | f413213 | 2011-01-18 01:59:24 +0000 | [diff] [blame] | 462 | // Reject all dashes. |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 463 | if (Arg.empty()) |
| 464 | return nullptr; |
Daniel Dunbar | f413213 | 2011-01-18 01:59:24 +0000 | [diff] [blame] | 465 | |
| 466 | // Split on any equal sign. |
Nick Lewycky | e75ffa1 | 2011-05-02 05:24:47 +0000 | [diff] [blame] | 467 | std::pair<StringRef, StringRef> SplitArg = Arg.split('='); |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 468 | StringRef &LHS = SplitArg.first; // LHS == Arg when no '=' is present. |
Nick Lewycky | e75ffa1 | 2011-05-02 05:24:47 +0000 | [diff] [blame] | 469 | StringRef &RHS = SplitArg.second; |
Daniel Dunbar | f413213 | 2011-01-18 01:59:24 +0000 | [diff] [blame] | 470 | |
| 471 | // Find the closest match. |
Craig Topper | c10719f | 2014-04-07 04:17:22 +0000 | [diff] [blame] | 472 | Option *Best = nullptr; |
Daniel Dunbar | f413213 | 2011-01-18 01:59:24 +0000 | [diff] [blame] | 473 | unsigned BestDistance = 0; |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 474 | for (StringMap<Option *>::const_iterator it = OptionsMap.begin(), |
| 475 | ie = OptionsMap.end(); |
| 476 | it != ie; ++it) { |
Daniel Dunbar | 72d523b | 2011-01-24 17:27:17 +0000 | [diff] [blame] | 477 | Option *O = it->second; |
David Blaikie | ff43d69 | 2015-11-17 19:00:52 +0000 | [diff] [blame] | 478 | SmallVector<StringRef, 16> OptionNames; |
Daniel Dunbar | 72d523b | 2011-01-24 17:27:17 +0000 | [diff] [blame] | 479 | O->getExtraOptionNames(OptionNames); |
David Blaikie | ff43d69 | 2015-11-17 19:00:52 +0000 | [diff] [blame] | 480 | if (O->hasArgStr()) |
Daniel Dunbar | 72d523b | 2011-01-24 17:27:17 +0000 | [diff] [blame] | 481 | OptionNames.push_back(O->ArgStr); |
| 482 | |
Nick Lewycky | e75ffa1 | 2011-05-02 05:24:47 +0000 | [diff] [blame] | 483 | bool PermitValue = O->getValueExpectedFlag() != cl::ValueDisallowed; |
| 484 | StringRef Flag = PermitValue ? LHS : Arg; |
David Blaikie | ff43d69 | 2015-11-17 19:00:52 +0000 | [diff] [blame] | 485 | for (auto Name : OptionNames) { |
Daniel Dunbar | 72d523b | 2011-01-24 17:27:17 +0000 | [diff] [blame] | 486 | unsigned Distance = StringRef(Name).edit_distance( |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 487 | Flag, /*AllowReplacements=*/true, /*MaxEditDistance=*/BestDistance); |
Daniel Dunbar | 72d523b | 2011-01-24 17:27:17 +0000 | [diff] [blame] | 488 | if (!Best || Distance < BestDistance) { |
| 489 | Best = O; |
Daniel Dunbar | 72d523b | 2011-01-24 17:27:17 +0000 | [diff] [blame] | 490 | BestDistance = Distance; |
Bill Wendling | 318f03f | 2012-07-19 00:15:11 +0000 | [diff] [blame] | 491 | if (RHS.empty() || !PermitValue) |
David Blaikie | ff43d69 | 2015-11-17 19:00:52 +0000 | [diff] [blame] | 492 | NearestString = Name; |
Bill Wendling | 318f03f | 2012-07-19 00:15:11 +0000 | [diff] [blame] | 493 | else |
David Blaikie | ff43d69 | 2015-11-17 19:00:52 +0000 | [diff] [blame] | 494 | NearestString = (Twine(Name) + "=" + RHS).str(); |
Daniel Dunbar | 72d523b | 2011-01-24 17:27:17 +0000 | [diff] [blame] | 495 | } |
Daniel Dunbar | f413213 | 2011-01-18 01:59:24 +0000 | [diff] [blame] | 496 | } |
| 497 | } |
| 498 | |
| 499 | return Best; |
| 500 | } |
| 501 | |
Alp Toker | cb40291 | 2014-01-24 17:20:08 +0000 | [diff] [blame] | 502 | /// CommaSeparateAndAddOccurrence - A wrapper around Handler->addOccurrence() |
| 503 | /// that does special handling of cl::CommaSeparated options. |
| 504 | static bool CommaSeparateAndAddOccurrence(Option *Handler, unsigned pos, |
| 505 | StringRef ArgName, StringRef Value, |
| 506 | bool MultiArg = false) { |
Mikhail Glushenkov | 5551c20 | 2009-11-20 17:23:17 +0000 | [diff] [blame] | 507 | // Check to see if this option accepts a comma separated list of values. If |
| 508 | // it does, we have to split up the value into multiple values. |
| 509 | if (Handler->getMiscFlags() & CommaSeparated) { |
| 510 | StringRef Val(Value); |
| 511 | StringRef::size_type Pos = Val.find(','); |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 512 | |
Mikhail Glushenkov | 5551c20 | 2009-11-20 17:23:17 +0000 | [diff] [blame] | 513 | while (Pos != StringRef::npos) { |
| 514 | // Process the portion before the comma. |
| 515 | if (Handler->addOccurrence(pos, ArgName, Val.substr(0, Pos), MultiArg)) |
| 516 | return true; |
| 517 | // Erase the portion before the comma, AND the comma. |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 518 | Val = Val.substr(Pos + 1); |
Mikhail Glushenkov | 5551c20 | 2009-11-20 17:23:17 +0000 | [diff] [blame] | 519 | // Check for another comma. |
| 520 | Pos = Val.find(','); |
| 521 | } |
| 522 | |
| 523 | Value = Val; |
| 524 | } |
| 525 | |
Alexander Kornienko | 66da20a | 2015-12-28 15:46:15 +0000 | [diff] [blame] | 526 | return Handler->addOccurrence(pos, ArgName, Value, MultiArg); |
Mikhail Glushenkov | 5551c20 | 2009-11-20 17:23:17 +0000 | [diff] [blame] | 527 | } |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 528 | |
Chris Lattner | 40fef80 | 2009-09-20 01:49:31 +0000 | [diff] [blame] | 529 | /// ProvideOption - For Value, this differentiates between an empty value ("") |
| 530 | /// and a null value (StringRef()). The later is accepted for arguments that |
| 531 | /// don't allow a value (-foo) the former is rejected (-foo=). |
Chris Lattner | 3b8adaf | 2009-09-20 00:40:49 +0000 | [diff] [blame] | 532 | static inline bool ProvideOption(Option *Handler, StringRef ArgName, |
David Blaikie | 0210e97 | 2012-02-07 19:36:01 +0000 | [diff] [blame] | 533 | StringRef Value, int argc, |
| 534 | const char *const *argv, int &i) { |
Mikhail Glushenkov | cbc26fd | 2009-01-16 22:54:19 +0000 | [diff] [blame] | 535 | // Is this a multi-argument option? |
| 536 | unsigned NumAdditionalVals = Handler->getNumAdditionalVals(); |
| 537 | |
Chris Lattner | e81c409 | 2001-10-27 05:54:17 +0000 | [diff] [blame] | 538 | // Enforce value requirements |
| 539 | switch (Handler->getValueExpectedFlag()) { |
| 540 | case ValueRequired: |
Craig Topper | 8d399f8 | 2014-04-09 04:20:00 +0000 | [diff] [blame] | 541 | if (!Value.data()) { // No value specified? |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 542 | if (i + 1 >= argc) |
Benjamin Kramer | 666cf9d | 2009-08-02 12:13:02 +0000 | [diff] [blame] | 543 | return Handler->error("requires a value!"); |
Chris Lattner | ca2552d | 2009-09-20 00:07:40 +0000 | [diff] [blame] | 544 | // Steal the next argument, like for '-o filename' |
Michael Ilseman | 4e654cd | 2014-12-11 19:46:38 +0000 | [diff] [blame] | 545 | assert(argv && "null check"); |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 546 | Value = StringRef(argv[++i]); |
Chris Lattner | e81c409 | 2001-10-27 05:54:17 +0000 | [diff] [blame] | 547 | } |
| 548 | break; |
| 549 | case ValueDisallowed: |
Mikhail Glushenkov | cbc26fd | 2009-01-16 22:54:19 +0000 | [diff] [blame] | 550 | if (NumAdditionalVals > 0) |
Benjamin Kramer | 666cf9d | 2009-08-02 12:13:02 +0000 | [diff] [blame] | 551 | return Handler->error("multi-valued option specified" |
Chris Lattner | ca2552d | 2009-09-20 00:07:40 +0000 | [diff] [blame] | 552 | " with ValueDisallowed modifier!"); |
Mikhail Glushenkov | cbc26fd | 2009-01-16 22:54:19 +0000 | [diff] [blame] | 553 | |
Chris Lattner | 40fef80 | 2009-09-20 01:49:31 +0000 | [diff] [blame] | 554 | if (Value.data()) |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 555 | return Handler->error("does not allow a value! '" + Twine(Value) + |
| 556 | "' specified."); |
Chris Lattner | e81c409 | 2001-10-27 05:54:17 +0000 | [diff] [blame] | 557 | break; |
Misha Brukman | 10468d8 | 2005-04-21 22:55:34 +0000 | [diff] [blame] | 558 | case ValueOptional: |
Reid Spencer | 9501b9b | 2004-09-01 04:41:28 +0000 | [diff] [blame] | 559 | break; |
Chris Lattner | e81c409 | 2001-10-27 05:54:17 +0000 | [diff] [blame] | 560 | } |
| 561 | |
Mikhail Glushenkov | cbc26fd | 2009-01-16 22:54:19 +0000 | [diff] [blame] | 562 | // If this isn't a multi-arg option, just run the handler. |
Chris Lattner | aecd74d | 2009-09-19 18:55:05 +0000 | [diff] [blame] | 563 | if (NumAdditionalVals == 0) |
Alp Toker | cb40291 | 2014-01-24 17:20:08 +0000 | [diff] [blame] | 564 | return CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value); |
Chris Lattner | aecd74d | 2009-09-19 18:55:05 +0000 | [diff] [blame] | 565 | |
Mikhail Glushenkov | cbc26fd | 2009-01-16 22:54:19 +0000 | [diff] [blame] | 566 | // If it is, run the handle several times. |
Chris Lattner | aecd74d | 2009-09-19 18:55:05 +0000 | [diff] [blame] | 567 | bool MultiArg = false; |
Mikhail Glushenkov | cbc26fd | 2009-01-16 22:54:19 +0000 | [diff] [blame] | 568 | |
Chris Lattner | 40fef80 | 2009-09-20 01:49:31 +0000 | [diff] [blame] | 569 | if (Value.data()) { |
Alp Toker | cb40291 | 2014-01-24 17:20:08 +0000 | [diff] [blame] | 570 | if (CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value, MultiArg)) |
Chris Lattner | aecd74d | 2009-09-19 18:55:05 +0000 | [diff] [blame] | 571 | return true; |
| 572 | --NumAdditionalVals; |
| 573 | MultiArg = true; |
Mikhail Glushenkov | cbc26fd | 2009-01-16 22:54:19 +0000 | [diff] [blame] | 574 | } |
Chris Lattner | aecd74d | 2009-09-19 18:55:05 +0000 | [diff] [blame] | 575 | |
| 576 | while (NumAdditionalVals > 0) { |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 577 | if (i + 1 >= argc) |
Chris Lattner | aecd74d | 2009-09-19 18:55:05 +0000 | [diff] [blame] | 578 | return Handler->error("not enough values!"); |
Michael Ilseman | 4e654cd | 2014-12-11 19:46:38 +0000 | [diff] [blame] | 579 | assert(argv && "null check"); |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 580 | Value = StringRef(argv[++i]); |
Mikhail Glushenkov | 1d9f1fe | 2009-11-19 17:29:36 +0000 | [diff] [blame] | 581 | |
Alp Toker | cb40291 | 2014-01-24 17:20:08 +0000 | [diff] [blame] | 582 | if (CommaSeparateAndAddOccurrence(Handler, i, ArgName, Value, MultiArg)) |
Chris Lattner | aecd74d | 2009-09-19 18:55:05 +0000 | [diff] [blame] | 583 | return true; |
| 584 | MultiArg = true; |
| 585 | --NumAdditionalVals; |
| 586 | } |
| 587 | return false; |
Chris Lattner | e81c409 | 2001-10-27 05:54:17 +0000 | [diff] [blame] | 588 | } |
| 589 | |
Chris Lattner | ca2552d | 2009-09-20 00:07:40 +0000 | [diff] [blame] | 590 | static bool ProvidePositionalOption(Option *Handler, StringRef Arg, int i) { |
Reid Spencer | 2027a6f | 2004-08-13 19:47:30 +0000 | [diff] [blame] | 591 | int Dummy = i; |
Craig Topper | c10719f | 2014-04-07 04:17:22 +0000 | [diff] [blame] | 592 | return ProvideOption(Handler, Handler->ArgStr, Arg, 0, nullptr, Dummy); |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 593 | } |
Chris Lattner | f0f9105 | 2001-11-26 18:58:34 +0000 | [diff] [blame] | 594 | |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 595 | // Option predicates... |
| 596 | static inline bool isGrouping(const Option *O) { |
| 597 | return O->getFormattingFlag() == cl::Grouping; |
| 598 | } |
| 599 | static inline bool isPrefixedOrGrouping(const Option *O) { |
| 600 | return isGrouping(O) || O->getFormattingFlag() == cl::Prefix; |
| 601 | } |
| 602 | |
| 603 | // getOptionPred - Check to see if there are any options that satisfy the |
| 604 | // specified predicate with names that are the prefixes in Name. This is |
| 605 | // checked by progressively stripping characters off of the name, checking to |
| 606 | // see if there options that satisfy the predicate. If we find one, return it, |
| 607 | // otherwise return null. |
| 608 | // |
Chris Lattner | 3b8adaf | 2009-09-20 00:40:49 +0000 | [diff] [blame] | 609 | static Option *getOptionPred(StringRef Name, size_t &Length, |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 610 | bool (*Pred)(const Option *), |
| 611 | const StringMap<Option *> &OptionsMap) { |
Misha Brukman | 10468d8 | 2005-04-21 22:55:34 +0000 | [diff] [blame] | 612 | |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 613 | StringMap<Option *>::const_iterator OMI = OptionsMap.find(Name); |
Chris Lattner | f0f9105 | 2001-11-26 18:58:34 +0000 | [diff] [blame] | 614 | |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 615 | // Loop while we haven't found an option and Name still has at least two |
| 616 | // characters in it (so that the next iteration will not be the empty |
| 617 | // string. |
| 618 | while (OMI == OptionsMap.end() && Name.size() > 1) { |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 619 | Name = Name.substr(0, Name.size() - 1); // Chop off the last character. |
Chris Lattner | 5247f60 | 2007-04-06 21:06:55 +0000 | [diff] [blame] | 620 | OMI = OptionsMap.find(Name); |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 621 | } |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 622 | |
Chris Lattner | 5247f60 | 2007-04-06 21:06:55 +0000 | [diff] [blame] | 623 | if (OMI != OptionsMap.end() && Pred(OMI->second)) { |
Chris Lattner | 3b8adaf | 2009-09-20 00:40:49 +0000 | [diff] [blame] | 624 | Length = Name.size(); |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 625 | return OMI->second; // Found one! |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 626 | } |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 627 | return nullptr; // No option found! |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 628 | } |
| 629 | |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 630 | /// HandlePrefixedOrGroupedOption - The specified argument string (which started |
| 631 | /// with at least one '-') does not fully match an available option. Check to |
| 632 | /// see if this is a prefix or grouped option. If so, split arg into output an |
| 633 | /// Arg/Value pair and return the Option to parse it with. |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 634 | static Option * |
| 635 | HandlePrefixedOrGroupedOption(StringRef &Arg, StringRef &Value, |
| 636 | bool &ErrorParsing, |
| 637 | const StringMap<Option *> &OptionsMap) { |
| 638 | if (Arg.size() == 1) |
| 639 | return nullptr; |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 640 | |
| 641 | // Do the lookup! |
| 642 | size_t Length = 0; |
| 643 | Option *PGOpt = getOptionPred(Arg, Length, isPrefixedOrGrouping, OptionsMap); |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 644 | if (!PGOpt) |
| 645 | return nullptr; |
Mikhail Glushenkov | 1d9f1fe | 2009-11-19 17:29:36 +0000 | [diff] [blame] | 646 | |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 647 | // If the option is a prefixed option, then the value is simply the |
| 648 | // rest of the name... so fall through to later processing, by |
| 649 | // setting up the argument name flags and value fields. |
| 650 | if (PGOpt->getFormattingFlag() == cl::Prefix) { |
| 651 | Value = Arg.substr(Length); |
| 652 | Arg = Arg.substr(0, Length); |
| 653 | assert(OptionsMap.count(Arg) && OptionsMap.find(Arg)->second == PGOpt); |
| 654 | return PGOpt; |
| 655 | } |
Mikhail Glushenkov | 1d9f1fe | 2009-11-19 17:29:36 +0000 | [diff] [blame] | 656 | |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 657 | // This must be a grouped option... handle them now. Grouping options can't |
| 658 | // have values. |
| 659 | assert(isGrouping(PGOpt) && "Broken getOptionPred!"); |
Mikhail Glushenkov | 1d9f1fe | 2009-11-19 17:29:36 +0000 | [diff] [blame] | 660 | |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 661 | do { |
| 662 | // Move current arg name out of Arg into OneArgName. |
| 663 | StringRef OneArgName = Arg.substr(0, Length); |
| 664 | Arg = Arg.substr(Length); |
Mikhail Glushenkov | 1d9f1fe | 2009-11-19 17:29:36 +0000 | [diff] [blame] | 665 | |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 666 | // Because ValueRequired is an invalid flag for grouped arguments, |
| 667 | // we don't need to pass argc/argv in. |
| 668 | assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired && |
| 669 | "Option can not be cl::Grouping AND cl::ValueRequired!"); |
Duncan Sands | a230552 | 2010-01-09 08:30:33 +0000 | [diff] [blame] | 670 | int Dummy = 0; |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 671 | ErrorParsing |= |
| 672 | ProvideOption(PGOpt, OneArgName, StringRef(), 0, nullptr, Dummy); |
Mikhail Glushenkov | 1d9f1fe | 2009-11-19 17:29:36 +0000 | [diff] [blame] | 673 | |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 674 | // Get the next grouping option. |
| 675 | PGOpt = getOptionPred(Arg, Length, isGrouping, OptionsMap); |
| 676 | } while (PGOpt && Length != Arg.size()); |
Mikhail Glushenkov | 1d9f1fe | 2009-11-19 17:29:36 +0000 | [diff] [blame] | 677 | |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 678 | // Return the last option with Arg cut down to just the last one. |
| 679 | return PGOpt; |
| 680 | } |
| 681 | |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 682 | static bool RequiresValue(const Option *O) { |
Misha Brukman | 069e6b5 | 2003-07-10 16:49:51 +0000 | [diff] [blame] | 683 | return O->getNumOccurrencesFlag() == cl::Required || |
| 684 | O->getNumOccurrencesFlag() == cl::OneOrMore; |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 685 | } |
| 686 | |
| 687 | static bool EatsUnboundedNumberOfValues(const Option *O) { |
Misha Brukman | 069e6b5 | 2003-07-10 16:49:51 +0000 | [diff] [blame] | 688 | return O->getNumOccurrencesFlag() == cl::ZeroOrMore || |
| 689 | O->getNumOccurrencesFlag() == cl::OneOrMore; |
Chris Lattner | f0f9105 | 2001-11-26 18:58:34 +0000 | [diff] [blame] | 690 | } |
Chris Lattner | e81c409 | 2001-10-27 05:54:17 +0000 | [diff] [blame] | 691 | |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 692 | static bool isWhitespace(char C) { return strchr(" \t\n\r\f\v", C); } |
Brian Gaeke | 497216d | 2003-08-15 21:05:57 +0000 | [diff] [blame] | 693 | |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 694 | static bool isQuote(char C) { return C == '\"' || C == '\''; } |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 695 | |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 696 | void cl::TokenizeGNUCommandLine(StringRef Src, StringSaver &Saver, |
Reid Kleckner | e3f146d | 2014-08-22 19:29:17 +0000 | [diff] [blame] | 697 | SmallVectorImpl<const char *> &NewArgv, |
| 698 | bool MarkEOLs) { |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 699 | SmallString<128> Token; |
| 700 | for (size_t I = 0, E = Src.size(); I != E; ++I) { |
| 701 | // Consume runs of whitespace. |
| 702 | if (Token.empty()) { |
Reid Kleckner | e3f146d | 2014-08-22 19:29:17 +0000 | [diff] [blame] | 703 | while (I != E && isWhitespace(Src[I])) { |
| 704 | // Mark the end of lines in response files |
| 705 | if (MarkEOLs && Src[I] == '\n') |
| 706 | NewArgv.push_back(nullptr); |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 707 | ++I; |
Reid Kleckner | e3f146d | 2014-08-22 19:29:17 +0000 | [diff] [blame] | 708 | } |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 709 | if (I == E) |
| 710 | break; |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 711 | } |
| 712 | |
Nico Weber | fa7f489 | 2016-04-26 13:53:56 +0000 | [diff] [blame] | 713 | // Backslash escapes the next character. |
| 714 | if (I + 1 < E && Src[I] == '\\') { |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 715 | ++I; // Skip the escape. |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 716 | Token.push_back(Src[I]); |
Chris Lattner | 4e37f87 | 2009-09-24 05:38:36 +0000 | [diff] [blame] | 717 | continue; |
Brian Gaeke | 497216d | 2003-08-15 21:05:57 +0000 | [diff] [blame] | 718 | } |
Mikhail Glushenkov | 1d9f1fe | 2009-11-19 17:29:36 +0000 | [diff] [blame] | 719 | |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 720 | // Consume a quoted string. |
| 721 | if (isQuote(Src[I])) { |
| 722 | char Quote = Src[I++]; |
| 723 | while (I != E && Src[I] != Quote) { |
Nico Weber | fa7f489 | 2016-04-26 13:53:56 +0000 | [diff] [blame] | 724 | // Backslash escapes the next character. |
| 725 | if (Src[I] == '\\' && I + 1 != E) |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 726 | ++I; |
| 727 | Token.push_back(Src[I]); |
| 728 | ++I; |
| 729 | } |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 730 | if (I == E) |
| 731 | break; |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 732 | continue; |
| 733 | } |
Mikhail Glushenkov | 1d9f1fe | 2009-11-19 17:29:36 +0000 | [diff] [blame] | 734 | |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 735 | // End the token if this is whitespace. |
| 736 | if (isWhitespace(Src[I])) { |
| 737 | if (!Token.empty()) |
Mehdi Amini | ec4fb5b | 2016-10-05 01:32:41 +0000 | [diff] [blame] | 738 | NewArgv.push_back(Saver.save(StringRef(Token)).data()); |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 739 | Token.clear(); |
| 740 | continue; |
| 741 | } |
Mikhail Glushenkov | 1d9f1fe | 2009-11-19 17:29:36 +0000 | [diff] [blame] | 742 | |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 743 | // This is a normal character. Append it. |
| 744 | Token.push_back(Src[I]); |
Brian Gaeke | 497216d | 2003-08-15 21:05:57 +0000 | [diff] [blame] | 745 | } |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 746 | |
| 747 | // Append the last token after hitting EOF with no whitespace. |
| 748 | if (!Token.empty()) |
Mehdi Amini | ec4fb5b | 2016-10-05 01:32:41 +0000 | [diff] [blame] | 749 | NewArgv.push_back(Saver.save(StringRef(Token)).data()); |
Reid Kleckner | e3f146d | 2014-08-22 19:29:17 +0000 | [diff] [blame] | 750 | // Mark the end of response files |
| 751 | if (MarkEOLs) |
| 752 | NewArgv.push_back(nullptr); |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 753 | } |
| 754 | |
Rui Ueyama | a2222b5 | 2013-07-30 19:03:20 +0000 | [diff] [blame] | 755 | /// Backslashes are interpreted in a rather complicated way in the Windows-style |
| 756 | /// command line, because backslashes are used both to separate path and to |
| 757 | /// escape double quote. This method consumes runs of backslashes as well as the |
| 758 | /// following double quote if it's escaped. |
| 759 | /// |
| 760 | /// * If an even number of backslashes is followed by a double quote, one |
| 761 | /// backslash is output for every pair of backslashes, and the last double |
| 762 | /// quote remains unconsumed. The double quote will later be interpreted as |
| 763 | /// the start or end of a quoted string in the main loop outside of this |
| 764 | /// function. |
| 765 | /// |
| 766 | /// * If an odd number of backslashes is followed by a double quote, one |
| 767 | /// backslash is output for every pair of backslashes, and a double quote is |
| 768 | /// output for the last pair of backslash-double quote. The double quote is |
| 769 | /// consumed in this case. |
| 770 | /// |
| 771 | /// * Otherwise, backslashes are interpreted literally. |
| 772 | static size_t parseBackslash(StringRef Src, size_t I, SmallString<128> &Token) { |
| 773 | size_t E = Src.size(); |
| 774 | int BackslashCount = 0; |
| 775 | // Skip the backslashes. |
| 776 | do { |
| 777 | ++I; |
| 778 | ++BackslashCount; |
| 779 | } while (I != E && Src[I] == '\\'); |
| 780 | |
| 781 | bool FollowedByDoubleQuote = (I != E && Src[I] == '"'); |
| 782 | if (FollowedByDoubleQuote) { |
| 783 | Token.append(BackslashCount / 2, '\\'); |
| 784 | if (BackslashCount % 2 == 0) |
| 785 | return I - 1; |
| 786 | Token.push_back('"'); |
| 787 | return I; |
| 788 | } |
| 789 | Token.append(BackslashCount, '\\'); |
| 790 | return I - 1; |
| 791 | } |
| 792 | |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 793 | void cl::TokenizeWindowsCommandLine(StringRef Src, StringSaver &Saver, |
Reid Kleckner | e3f146d | 2014-08-22 19:29:17 +0000 | [diff] [blame] | 794 | SmallVectorImpl<const char *> &NewArgv, |
| 795 | bool MarkEOLs) { |
Rui Ueyama | a2222b5 | 2013-07-30 19:03:20 +0000 | [diff] [blame] | 796 | SmallString<128> Token; |
| 797 | |
| 798 | // This is a small state machine to consume characters until it reaches the |
| 799 | // end of the source string. |
| 800 | enum { INIT, UNQUOTED, QUOTED } State = INIT; |
| 801 | for (size_t I = 0, E = Src.size(); I != E; ++I) { |
| 802 | // INIT state indicates that the current input index is at the start of |
| 803 | // the string or between tokens. |
| 804 | if (State == INIT) { |
Reid Kleckner | e3f146d | 2014-08-22 19:29:17 +0000 | [diff] [blame] | 805 | if (isWhitespace(Src[I])) { |
| 806 | // Mark the end of lines in response files |
| 807 | if (MarkEOLs && Src[I] == '\n') |
| 808 | NewArgv.push_back(nullptr); |
Rui Ueyama | a2222b5 | 2013-07-30 19:03:20 +0000 | [diff] [blame] | 809 | continue; |
Reid Kleckner | e3f146d | 2014-08-22 19:29:17 +0000 | [diff] [blame] | 810 | } |
Rui Ueyama | a2222b5 | 2013-07-30 19:03:20 +0000 | [diff] [blame] | 811 | if (Src[I] == '"') { |
| 812 | State = QUOTED; |
| 813 | continue; |
| 814 | } |
| 815 | if (Src[I] == '\\') { |
| 816 | I = parseBackslash(Src, I, Token); |
| 817 | State = UNQUOTED; |
| 818 | continue; |
| 819 | } |
| 820 | Token.push_back(Src[I]); |
| 821 | State = UNQUOTED; |
| 822 | continue; |
| 823 | } |
| 824 | |
| 825 | // UNQUOTED state means that it's reading a token not quoted by double |
| 826 | // quotes. |
| 827 | if (State == UNQUOTED) { |
| 828 | // Whitespace means the end of the token. |
| 829 | if (isWhitespace(Src[I])) { |
Mehdi Amini | ec4fb5b | 2016-10-05 01:32:41 +0000 | [diff] [blame] | 830 | NewArgv.push_back(Saver.save(StringRef(Token)).data()); |
Rui Ueyama | a2222b5 | 2013-07-30 19:03:20 +0000 | [diff] [blame] | 831 | Token.clear(); |
| 832 | State = INIT; |
Reid Kleckner | e3f146d | 2014-08-22 19:29:17 +0000 | [diff] [blame] | 833 | // Mark the end of lines in response files |
| 834 | if (MarkEOLs && Src[I] == '\n') |
| 835 | NewArgv.push_back(nullptr); |
Rui Ueyama | a2222b5 | 2013-07-30 19:03:20 +0000 | [diff] [blame] | 836 | continue; |
| 837 | } |
| 838 | if (Src[I] == '"') { |
| 839 | State = QUOTED; |
| 840 | continue; |
| 841 | } |
| 842 | if (Src[I] == '\\') { |
| 843 | I = parseBackslash(Src, I, Token); |
| 844 | continue; |
| 845 | } |
| 846 | Token.push_back(Src[I]); |
| 847 | continue; |
| 848 | } |
| 849 | |
| 850 | // QUOTED state means that it's reading a token quoted by double quotes. |
| 851 | if (State == QUOTED) { |
| 852 | if (Src[I] == '"') { |
| 853 | State = UNQUOTED; |
| 854 | continue; |
| 855 | } |
| 856 | if (Src[I] == '\\') { |
| 857 | I = parseBackslash(Src, I, Token); |
| 858 | continue; |
| 859 | } |
| 860 | Token.push_back(Src[I]); |
| 861 | } |
| 862 | } |
| 863 | // Append the last token after hitting EOF with no whitespace. |
| 864 | if (!Token.empty()) |
Mehdi Amini | ec4fb5b | 2016-10-05 01:32:41 +0000 | [diff] [blame] | 865 | NewArgv.push_back(Saver.save(StringRef(Token)).data()); |
Reid Kleckner | e3f146d | 2014-08-22 19:29:17 +0000 | [diff] [blame] | 866 | // Mark the end of response files |
| 867 | if (MarkEOLs) |
| 868 | NewArgv.push_back(nullptr); |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 869 | } |
| 870 | |
Yunzhong Gao | a8cf495 | 2015-01-24 04:23:08 +0000 | [diff] [blame] | 871 | // It is called byte order marker but the UTF-8 BOM is actually not affected |
| 872 | // by the host system's endianness. |
| 873 | static bool hasUTF8ByteOrderMark(ArrayRef<char> S) { |
Chris Bieneman | ceaf5f6 | 2015-02-13 22:54:29 +0000 | [diff] [blame] | 874 | return (S.size() >= 3 && S[0] == '\xef' && S[1] == '\xbb' && S[2] == '\xbf'); |
Yunzhong Gao | a8cf495 | 2015-01-24 04:23:08 +0000 | [diff] [blame] | 875 | } |
| 876 | |
Serge Pavlov | 6ac8e03 | 2016-11-01 06:53:29 +0000 | [diff] [blame] | 877 | static bool ExpandResponseFile(StringRef FName, StringSaver &Saver, |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 878 | TokenizerCallback Tokenizer, |
Reid Kleckner | e3f146d | 2014-08-22 19:29:17 +0000 | [diff] [blame] | 879 | SmallVectorImpl<const char *> &NewArgv, |
Serge Pavlov | 6ac8e03 | 2016-11-01 06:53:29 +0000 | [diff] [blame] | 880 | bool MarkEOLs, bool RelativeNames) { |
Rafael Espindola | adf21f2 | 2014-07-06 17:43:13 +0000 | [diff] [blame] | 881 | ErrorOr<std::unique_ptr<MemoryBuffer>> MemBufOrErr = |
| 882 | MemoryBuffer::getFile(FName); |
| 883 | if (!MemBufOrErr) |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 884 | return false; |
Rafael Espindola | 3f6481d | 2014-08-01 14:31:55 +0000 | [diff] [blame] | 885 | MemoryBuffer &MemBuf = *MemBufOrErr.get(); |
| 886 | StringRef Str(MemBuf.getBufferStart(), MemBuf.getBufferSize()); |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 887 | |
| 888 | // If we have a UTF-16 byte order mark, convert to UTF-8 for parsing. |
Rafael Espindola | 3f6481d | 2014-08-01 14:31:55 +0000 | [diff] [blame] | 889 | ArrayRef<char> BufRef(MemBuf.getBufferStart(), MemBuf.getBufferEnd()); |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 890 | std::string UTF8Buf; |
| 891 | if (hasUTF16ByteOrderMark(BufRef)) { |
| 892 | if (!convertUTF16ToUTF8String(BufRef, UTF8Buf)) |
| 893 | return false; |
| 894 | Str = StringRef(UTF8Buf); |
| 895 | } |
Yunzhong Gao | a8cf495 | 2015-01-24 04:23:08 +0000 | [diff] [blame] | 896 | // If we see UTF-8 BOM sequence at the beginning of a file, we shall remove |
| 897 | // these bytes before parsing. |
| 898 | // Reference: http://en.wikipedia.org/wiki/UTF-8#Byte_order_mark |
| 899 | else if (hasUTF8ByteOrderMark(BufRef)) |
| 900 | Str = StringRef(BufRef.data() + 3, BufRef.size() - 3); |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 901 | |
| 902 | // Tokenize the contents into NewArgv. |
Reid Kleckner | e3f146d | 2014-08-22 19:29:17 +0000 | [diff] [blame] | 903 | Tokenizer(Str, Saver, NewArgv, MarkEOLs); |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 904 | |
Serge Pavlov | 6ac8e03 | 2016-11-01 06:53:29 +0000 | [diff] [blame] | 905 | // If names of nested response files should be resolved relative to including |
| 906 | // file, replace the included response file names with their full paths |
| 907 | // obtained by required resolution. |
| 908 | if (RelativeNames) |
| 909 | for (unsigned I = 0; I < NewArgv.size(); ++I) |
| 910 | if (NewArgv[I]) { |
| 911 | StringRef Arg = NewArgv[I]; |
| 912 | if (Arg.front() == '@') { |
| 913 | StringRef FileName = Arg.drop_front(); |
| 914 | if (llvm::sys::path::is_relative(FileName)) { |
| 915 | SmallString<128> ResponseFile; |
| 916 | ResponseFile.append(1, '@'); |
Serge Pavlov | f258ff1 | 2016-11-20 06:25:07 +0000 | [diff] [blame] | 917 | if (llvm::sys::path::is_relative(FName)) { |
| 918 | SmallString<128> curr_dir; |
| 919 | llvm::sys::fs::current_path(curr_dir); |
| 920 | ResponseFile.append(curr_dir.str()); |
| 921 | } |
Serge Pavlov | 6ac8e03 | 2016-11-01 06:53:29 +0000 | [diff] [blame] | 922 | llvm::sys::path::append( |
| 923 | ResponseFile, llvm::sys::path::parent_path(FName), FileName); |
| 924 | NewArgv[I] = Saver.save(ResponseFile.c_str()).data(); |
| 925 | } |
| 926 | } |
| 927 | } |
| 928 | |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 929 | return true; |
| 930 | } |
| 931 | |
| 932 | /// \brief Expand response files on a command line recursively using the given |
| 933 | /// StringSaver and tokenization strategy. |
| 934 | bool cl::ExpandResponseFiles(StringSaver &Saver, TokenizerCallback Tokenizer, |
Reid Kleckner | e3f146d | 2014-08-22 19:29:17 +0000 | [diff] [blame] | 935 | SmallVectorImpl<const char *> &Argv, |
Serge Pavlov | 6ac8e03 | 2016-11-01 06:53:29 +0000 | [diff] [blame] | 936 | bool MarkEOLs, bool RelativeNames) { |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 937 | unsigned RspFiles = 0; |
Reid Kleckner | 7c5fdaf | 2013-12-03 19:13:18 +0000 | [diff] [blame] | 938 | bool AllExpanded = true; |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 939 | |
| 940 | // Don't cache Argv.size() because it can change. |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 941 | for (unsigned I = 0; I != Argv.size();) { |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 942 | const char *Arg = Argv[I]; |
Reid Kleckner | e3f146d | 2014-08-22 19:29:17 +0000 | [diff] [blame] | 943 | // Check if it is an EOL marker |
| 944 | if (Arg == nullptr) { |
| 945 | ++I; |
| 946 | continue; |
| 947 | } |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 948 | if (Arg[0] != '@') { |
| 949 | ++I; |
| 950 | continue; |
| 951 | } |
| 952 | |
| 953 | // If we have too many response files, leave some unexpanded. This avoids |
| 954 | // crashing on self-referential response files. |
| 955 | if (RspFiles++ > 20) |
| 956 | return false; |
| 957 | |
| 958 | // Replace this response file argument with the tokenization of its |
| 959 | // contents. Nested response files are expanded in subsequent iterations. |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 960 | SmallVector<const char *, 0> ExpandedArgv; |
Reid Kleckner | e3f146d | 2014-08-22 19:29:17 +0000 | [diff] [blame] | 961 | if (!ExpandResponseFile(Arg + 1, Saver, Tokenizer, ExpandedArgv, |
Serge Pavlov | 6ac8e03 | 2016-11-01 06:53:29 +0000 | [diff] [blame] | 962 | MarkEOLs, RelativeNames)) { |
Justin Bogner | 67ae991 | 2013-12-06 22:56:19 +0000 | [diff] [blame] | 963 | // We couldn't read this file, so we leave it in the argument stream and |
| 964 | // move on. |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 965 | AllExpanded = false; |
Justin Bogner | 67ae991 | 2013-12-06 22:56:19 +0000 | [diff] [blame] | 966 | ++I; |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 967 | continue; |
| 968 | } |
| 969 | Argv.erase(Argv.begin() + I); |
| 970 | Argv.insert(Argv.begin() + I, ExpandedArgv.begin(), ExpandedArgv.end()); |
| 971 | } |
| 972 | return AllExpanded; |
| 973 | } |
| 974 | |
Brian Gaeke | ca782d9 | 2003-08-14 22:00:59 +0000 | [diff] [blame] | 975 | /// ParseEnvironmentOptions - An alternative entry point to the |
| 976 | /// CommandLine library, which allows you to read the program's name |
| 977 | /// from the caller (as PROGNAME) and its command-line arguments from |
| 978 | /// an environment variable (whose name is given in ENVVAR). |
| 979 | /// |
Chris Lattner | a60f355 | 2004-05-06 22:04:31 +0000 | [diff] [blame] | 980 | void cl::ParseEnvironmentOptions(const char *progName, const char *envVar, |
Rafael Espindola | be5613c | 2012-10-09 19:52:10 +0000 | [diff] [blame] | 981 | const char *Overview) { |
Brian Gaeke | 497216d | 2003-08-15 21:05:57 +0000 | [diff] [blame] | 982 | // Check args. |
Chris Lattner | a60f355 | 2004-05-06 22:04:31 +0000 | [diff] [blame] | 983 | assert(progName && "Program name not specified"); |
| 984 | assert(envVar && "Environment variable name missing"); |
Misha Brukman | 10468d8 | 2005-04-21 22:55:34 +0000 | [diff] [blame] | 985 | |
Brian Gaeke | 497216d | 2003-08-15 21:05:57 +0000 | [diff] [blame] | 986 | // Get the environment variable they want us to parse options out of. |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 987 | llvm::Optional<std::string> envValue = sys::Process::GetEnv(StringRef(envVar)); |
Brian Gaeke | 497216d | 2003-08-15 21:05:57 +0000 | [diff] [blame] | 988 | if (!envValue) |
| 989 | return; |
| 990 | |
Brian Gaeke | ca782d9 | 2003-08-14 22:00:59 +0000 | [diff] [blame] | 991 | // Get program's "name", which we wouldn't know without the caller |
| 992 | // telling us. |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 993 | SmallVector<const char *, 20> newArgv; |
Rafael Espindola | 454adf6 | 2015-06-13 12:49:52 +0000 | [diff] [blame] | 994 | BumpPtrAllocator A; |
Rafael Espindola | b82455d | 2015-08-13 01:07:02 +0000 | [diff] [blame] | 995 | StringSaver Saver(A); |
Mehdi Amini | ec4fb5b | 2016-10-05 01:32:41 +0000 | [diff] [blame] | 996 | newArgv.push_back(Saver.save(progName).data()); |
Brian Gaeke | ca782d9 | 2003-08-14 22:00:59 +0000 | [diff] [blame] | 997 | |
| 998 | // Parse the value of the environment variable into a "command line" |
| 999 | // and hand it off to ParseCommandLineOptions(). |
David Majnemer | afb38af | 2016-07-24 17:19:59 +0000 | [diff] [blame] | 1000 | TokenizeGNUCommandLine(*envValue, Saver, newArgv); |
Evan Cheng | 86cb318 | 2008-05-05 18:30:58 +0000 | [diff] [blame] | 1001 | int newArgc = static_cast<int>(newArgv.size()); |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1002 | ParseCommandLineOptions(newArgc, &newArgv[0], StringRef(Overview)); |
Mikhail Glushenkov | 5653d3b | 2008-04-28 16:44:25 +0000 | [diff] [blame] | 1003 | } |
| 1004 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1005 | bool cl::ParseCommandLineOptions(int argc, const char *const *argv, |
Eric Liu | e51ee06 | 2017-03-15 08:41:00 +0000 | [diff] [blame] | 1006 | StringRef Overview, raw_ostream *Errs) { |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1007 | return GlobalParser->ParseCommandLineOptions(argc, argv, Overview, |
Eric Liu | e51ee06 | 2017-03-15 08:41:00 +0000 | [diff] [blame] | 1008 | Errs); |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 1009 | } |
Mikhail Glushenkov | 5653d3b | 2008-04-28 16:44:25 +0000 | [diff] [blame] | 1010 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1011 | void CommandLineParser::ResetAllOptionOccurrences() { |
| 1012 | // So that we can parse different command lines multiple times in succession |
| 1013 | // we reset all option values to look like they have never been seen before. |
| 1014 | for (auto SC : RegisteredSubCommands) { |
| 1015 | for (auto &O : SC->OptionsMap) |
| 1016 | O.second->reset(); |
| 1017 | } |
| 1018 | } |
| 1019 | |
| 1020 | bool CommandLineParser::ParseCommandLineOptions(int argc, |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 1021 | const char *const *argv, |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1022 | StringRef Overview, |
Eric Liu | e51ee06 | 2017-03-15 08:41:00 +0000 | [diff] [blame] | 1023 | raw_ostream *Errs) { |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 1024 | assert(hasOptions() && "No options specified!"); |
Mikhail Glushenkov | 5653d3b | 2008-04-28 16:44:25 +0000 | [diff] [blame] | 1025 | |
| 1026 | // Expand response files. |
Benjamin Kramer | 6cd780f | 2015-02-17 15:29:18 +0000 | [diff] [blame] | 1027 | SmallVector<const char *, 20> newArgv(argv, argv + argc); |
Rafael Espindola | 454adf6 | 2015-06-13 12:49:52 +0000 | [diff] [blame] | 1028 | BumpPtrAllocator A; |
Rafael Espindola | b82455d | 2015-08-13 01:07:02 +0000 | [diff] [blame] | 1029 | StringSaver Saver(A); |
Reid Kleckner | a73c778 | 2013-07-18 16:52:05 +0000 | [diff] [blame] | 1030 | ExpandResponseFiles(Saver, TokenizeGNUCommandLine, newArgv); |
Rafael Espindola | be5613c | 2012-10-09 19:52:10 +0000 | [diff] [blame] | 1031 | argv = &newArgv[0]; |
| 1032 | argc = static_cast<int>(newArgv.size()); |
Mikhail Glushenkov | 5653d3b | 2008-04-28 16:44:25 +0000 | [diff] [blame] | 1033 | |
Chris Lattner | 5af1cbc | 2006-10-13 00:06:24 +0000 | [diff] [blame] | 1034 | // Copy the program name into ProgName, making sure not to overflow it. |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1035 | ProgramName = sys::path::filename(StringRef(argv[0])); |
Mikhail Glushenkov | 5653d3b | 2008-04-28 16:44:25 +0000 | [diff] [blame] | 1036 | |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1037 | ProgramOverview = Overview; |
Eric Liu | e51ee06 | 2017-03-15 08:41:00 +0000 | [diff] [blame] | 1038 | bool IgnoreErrors = Errs; |
| 1039 | if (!Errs) |
| 1040 | Errs = &errs(); |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1041 | bool ErrorParsing = false; |
| 1042 | |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1043 | // Check out the positional arguments to collect information about them. |
| 1044 | unsigned NumPositionalRequired = 0; |
Mikhail Glushenkov | 5653d3b | 2008-04-28 16:44:25 +0000 | [diff] [blame] | 1045 | |
Chris Lattner | d380d84 | 2005-08-08 17:25:38 +0000 | [diff] [blame] | 1046 | // Determine whether or not there are an unlimited number of positionals |
| 1047 | bool HasUnlimitedPositionals = false; |
Mikhail Glushenkov | 5653d3b | 2008-04-28 16:44:25 +0000 | [diff] [blame] | 1048 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1049 | int FirstArg = 1; |
| 1050 | SubCommand *ChosenSubCommand = &*TopLevelSubCommand; |
| 1051 | if (argc >= 2 && argv[FirstArg][0] != '-') { |
| 1052 | // If the first argument specifies a valid subcommand, start processing |
| 1053 | // options from the second argument. |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1054 | ChosenSubCommand = LookupSubCommand(StringRef(argv[FirstArg])); |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1055 | if (ChosenSubCommand != &*TopLevelSubCommand) |
| 1056 | FirstArg = 2; |
| 1057 | } |
| 1058 | GlobalParser->ActiveSubCommand = ChosenSubCommand; |
| 1059 | |
| 1060 | assert(ChosenSubCommand); |
| 1061 | auto &ConsumeAfterOpt = ChosenSubCommand->ConsumeAfterOpt; |
| 1062 | auto &PositionalOpts = ChosenSubCommand->PositionalOpts; |
| 1063 | auto &SinkOpts = ChosenSubCommand->SinkOpts; |
| 1064 | auto &OptionsMap = ChosenSubCommand->OptionsMap; |
| 1065 | |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 1066 | if (ConsumeAfterOpt) { |
| 1067 | assert(PositionalOpts.size() > 0 && |
| 1068 | "Cannot specify cl::ConsumeAfter without a positional argument!"); |
| 1069 | } |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1070 | if (!PositionalOpts.empty()) { |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1071 | |
| 1072 | // Calculate how many positional values are _required_. |
| 1073 | bool UnboundedFound = false; |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 1074 | for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) { |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1075 | Option *Opt = PositionalOpts[i]; |
| 1076 | if (RequiresValue(Opt)) |
| 1077 | ++NumPositionalRequired; |
| 1078 | else if (ConsumeAfterOpt) { |
| 1079 | // ConsumeAfter cannot be combined with "optional" positional options |
Chris Lattner | d49ea88 | 2002-07-22 02:21:57 +0000 | [diff] [blame] | 1080 | // unless there is only one positional argument... |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1081 | if (PositionalOpts.size() > 1) { |
| 1082 | if (!IgnoreErrors) |
| 1083 | Opt->error("error - this positional option will never be matched, " |
| 1084 | "because it does not Require a value, and a " |
| 1085 | "cl::ConsumeAfter option is active!"); |
| 1086 | ErrorParsing = true; |
| 1087 | } |
David Blaikie | ff43d69 | 2015-11-17 19:00:52 +0000 | [diff] [blame] | 1088 | } else if (UnboundedFound && !Opt->hasArgStr()) { |
Chris Lattner | 2da046f | 2003-07-30 17:34:02 +0000 | [diff] [blame] | 1089 | // This option does not "require" a value... Make sure this option is |
| 1090 | // not specified after an option that eats all extra arguments, or this |
| 1091 | // one will never get any! |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1092 | // |
Eric Liu | e51ee06 | 2017-03-15 08:41:00 +0000 | [diff] [blame] | 1093 | if (!IgnoreErrors) |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1094 | Opt->error("error - option can never match, because " |
| 1095 | "another positional argument will match an " |
| 1096 | "unbounded number of values, and this option" |
| 1097 | " does not require a value!"); |
Eric Liu | e51ee06 | 2017-03-15 08:41:00 +0000 | [diff] [blame] | 1098 | *Errs << ProgramName << ": CommandLine Error: Option '" << Opt->ArgStr |
| 1099 | << "' is all messed up!\n"; |
| 1100 | *Errs << PositionalOpts.size(); |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1101 | ErrorParsing = true; |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1102 | } |
| 1103 | UnboundedFound |= EatsUnboundedNumberOfValues(Opt); |
| 1104 | } |
Chris Lattner | d09a9a7 | 2005-08-08 21:57:27 +0000 | [diff] [blame] | 1105 | HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt; |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1106 | } |
| 1107 | |
Reid Spencer | 2027a6f | 2004-08-13 19:47:30 +0000 | [diff] [blame] | 1108 | // PositionalVals - A vector of "positional" arguments we accumulate into |
Chris Lattner | ca2552d | 2009-09-20 00:07:40 +0000 | [diff] [blame] | 1109 | // the process at the end. |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1110 | // |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1111 | SmallVector<std::pair<StringRef, unsigned>, 4> PositionalVals; |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1112 | |
Chris Lattner | 2da046f | 2003-07-30 17:34:02 +0000 | [diff] [blame] | 1113 | // If the program has named positional arguments, and the name has been run |
| 1114 | // across, keep track of which positional argument was named. Otherwise put |
| 1115 | // the positional args into the PositionalVals list... |
Craig Topper | c10719f | 2014-04-07 04:17:22 +0000 | [diff] [blame] | 1116 | Option *ActivePositionalArg = nullptr; |
Chris Lattner | 2da046f | 2003-07-30 17:34:02 +0000 | [diff] [blame] | 1117 | |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1118 | // Loop over all of the arguments... processing them. |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1119 | bool DashDashFound = false; // Have we read '--'? |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1120 | for (int i = FirstArg; i < argc; ++i) { |
Craig Topper | c10719f | 2014-04-07 04:17:22 +0000 | [diff] [blame] | 1121 | Option *Handler = nullptr; |
| 1122 | Option *NearestHandler = nullptr; |
Nick Lewycky | e75ffa1 | 2011-05-02 05:24:47 +0000 | [diff] [blame] | 1123 | std::string NearestHandlerString; |
Chris Lattner | 0a40a97 | 2009-09-20 01:53:12 +0000 | [diff] [blame] | 1124 | StringRef Value; |
Chris Lattner | 5a3fa4e | 2009-09-20 02:02:24 +0000 | [diff] [blame] | 1125 | StringRef ArgName = ""; |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1126 | |
| 1127 | // Check to see if this is a positional argument. This argument is |
| 1128 | // considered to be positional if it doesn't start with '-', if it is "-" |
Misha Brukman | 5258e59 | 2003-07-10 21:38:28 +0000 | [diff] [blame] | 1129 | // itself, or if we have seen "--" already. |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1130 | // |
| 1131 | if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) { |
| 1132 | // Positional argument! |
Chris Lattner | 2da046f | 2003-07-30 17:34:02 +0000 | [diff] [blame] | 1133 | if (ActivePositionalArg) { |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1134 | ProvidePositionalOption(ActivePositionalArg, StringRef(argv[i]), i); |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1135 | continue; // We are done! |
Chris Lattner | 3b8adaf | 2009-09-20 00:40:49 +0000 | [diff] [blame] | 1136 | } |
Mikhail Glushenkov | 1d9f1fe | 2009-11-19 17:29:36 +0000 | [diff] [blame] | 1137 | |
Chris Lattner | 3b8adaf | 2009-09-20 00:40:49 +0000 | [diff] [blame] | 1138 | if (!PositionalOpts.empty()) { |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1139 | PositionalVals.push_back(std::make_pair(StringRef(argv[i]), i)); |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1140 | |
| 1141 | // All of the positional arguments have been fulfulled, give the rest to |
| 1142 | // the consume after option... if it's specified... |
| 1143 | // |
Craig Topper | 8d399f8 | 2014-04-09 04:20:00 +0000 | [diff] [blame] | 1144 | if (PositionalVals.size() >= NumPositionalRequired && ConsumeAfterOpt) { |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1145 | for (++i; i < argc; ++i) |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1146 | PositionalVals.push_back(std::make_pair(StringRef(argv[i]), i)); |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1147 | break; // Handle outside of the argument processing loop... |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1148 | } |
| 1149 | |
| 1150 | // Delay processing positional arguments until the end... |
| 1151 | continue; |
| 1152 | } |
Chris Lattner | a60f355 | 2004-05-06 22:04:31 +0000 | [diff] [blame] | 1153 | } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 && |
| 1154 | !DashDashFound) { |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1155 | DashDashFound = true; // This is the mythical "--"? |
| 1156 | continue; // Don't try to process it as an argument itself. |
Chris Lattner | a60f355 | 2004-05-06 22:04:31 +0000 | [diff] [blame] | 1157 | } else if (ActivePositionalArg && |
| 1158 | (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) { |
| 1159 | // If there is a positional argument eating options, check to see if this |
| 1160 | // option is another positional argument. If so, treat it as an argument, |
| 1161 | // otherwise feed it to the eating positional. |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1162 | ArgName = StringRef(argv[i] + 1); |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 1163 | // Eat leading dashes. |
| 1164 | while (!ArgName.empty() && ArgName[0] == '-') |
| 1165 | ArgName = ArgName.substr(1); |
Mikhail Glushenkov | 1d9f1fe | 2009-11-19 17:29:36 +0000 | [diff] [blame] | 1166 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1167 | Handler = LookupOption(*ChosenSubCommand, ArgName, Value); |
Chris Lattner | a60f355 | 2004-05-06 22:04:31 +0000 | [diff] [blame] | 1168 | if (!Handler || Handler->getFormattingFlag() != cl::Positional) { |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1169 | ProvidePositionalOption(ActivePositionalArg, StringRef(argv[i]), i); |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1170 | continue; // We are done! |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1171 | } |
| 1172 | |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1173 | } else { // We start with a '-', must be an argument. |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1174 | ArgName = StringRef(argv[i] + 1); |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 1175 | // Eat leading dashes. |
| 1176 | while (!ArgName.empty() && ArgName[0] == '-') |
| 1177 | ArgName = ArgName.substr(1); |
Mikhail Glushenkov | 1d9f1fe | 2009-11-19 17:29:36 +0000 | [diff] [blame] | 1178 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1179 | Handler = LookupOption(*ChosenSubCommand, ArgName, Value); |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1180 | |
Chris Lattner | a60f355 | 2004-05-06 22:04:31 +0000 | [diff] [blame] | 1181 | // Check to see if this "option" is really a prefixed or grouped argument. |
Craig Topper | 8d399f8 | 2014-04-09 04:20:00 +0000 | [diff] [blame] | 1182 | if (!Handler) |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 1183 | Handler = HandlePrefixedOrGroupedOption(ArgName, Value, ErrorParsing, |
| 1184 | OptionsMap); |
Daniel Dunbar | f413213 | 2011-01-18 01:59:24 +0000 | [diff] [blame] | 1185 | |
| 1186 | // Otherwise, look for the closest available option to report to the user |
| 1187 | // in the upcoming error. |
Craig Topper | 8d399f8 | 2014-04-09 04:20:00 +0000 | [diff] [blame] | 1188 | if (!Handler && SinkOpts.empty()) |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1189 | NearestHandler = |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 1190 | LookupNearestOption(ArgName, OptionsMap, NearestHandlerString); |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1191 | } |
| 1192 | |
Craig Topper | 8d399f8 | 2014-04-09 04:20:00 +0000 | [diff] [blame] | 1193 | if (!Handler) { |
Anton Korobeynikov | f275a49 | 2008-02-20 12:38:07 +0000 | [diff] [blame] | 1194 | if (SinkOpts.empty()) { |
Eric Liu | e51ee06 | 2017-03-15 08:41:00 +0000 | [diff] [blame] | 1195 | *Errs << ProgramName << ": Unknown command line argument '" << argv[i] |
| 1196 | << "'. Try: '" << argv[0] << " -help'\n"; |
Daniel Dunbar | f413213 | 2011-01-18 01:59:24 +0000 | [diff] [blame] | 1197 | |
Eric Liu | e51ee06 | 2017-03-15 08:41:00 +0000 | [diff] [blame] | 1198 | if (NearestHandler) { |
| 1199 | // If we know a near match, report it as well. |
| 1200 | *Errs << ProgramName << ": Did you mean '-" << NearestHandlerString |
| 1201 | << "'?\n"; |
Daniel Dunbar | 72d523b | 2011-01-24 17:27:17 +0000 | [diff] [blame] | 1202 | } |
Daniel Dunbar | f413213 | 2011-01-18 01:59:24 +0000 | [diff] [blame] | 1203 | |
Anton Korobeynikov | f275a49 | 2008-02-20 12:38:07 +0000 | [diff] [blame] | 1204 | ErrorParsing = true; |
| 1205 | } else { |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1206 | for (SmallVectorImpl<Option *>::iterator I = SinkOpts.begin(), |
| 1207 | E = SinkOpts.end(); |
| 1208 | I != E; ++I) |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1209 | (*I)->addOccurrence(i, "", StringRef(argv[i])); |
Anton Korobeynikov | f275a49 | 2008-02-20 12:38:07 +0000 | [diff] [blame] | 1210 | } |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1211 | continue; |
| 1212 | } |
| 1213 | |
Chris Lattner | 2da046f | 2003-07-30 17:34:02 +0000 | [diff] [blame] | 1214 | // If this is a named positional argument, just remember that it is the |
| 1215 | // active one... |
| 1216 | if (Handler->getFormattingFlag() == cl::Positional) |
| 1217 | ActivePositionalArg = Handler; |
Chris Lattner | 40fef80 | 2009-09-20 01:49:31 +0000 | [diff] [blame] | 1218 | else |
Chris Lattner | 0a40a97 | 2009-09-20 01:53:12 +0000 | [diff] [blame] | 1219 | ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i); |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1220 | } |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1221 | |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1222 | // Check and handle positional arguments now... |
| 1223 | if (NumPositionalRequired > PositionalVals.size()) { |
Eric Liu | e51ee06 | 2017-03-15 08:41:00 +0000 | [diff] [blame] | 1224 | *Errs << ProgramName |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1225 | << ": Not enough positional command line arguments specified!\n" |
| 1226 | << "Must specify at least " << NumPositionalRequired |
Ying Yi | 60a3da3 | 2016-07-22 10:52:21 +0000 | [diff] [blame] | 1227 | << " positional argument" << (NumPositionalRequired > 1 ? "s" : "") |
Don Hinton | e15fa33 | 2017-07-12 01:15:46 +0000 | [diff] [blame] | 1228 | << ": See: " << argv[0] << " -help\n"; |
Mikhail Glushenkov | 5653d3b | 2008-04-28 16:44:25 +0000 | [diff] [blame] | 1229 | |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1230 | ErrorParsing = true; |
Dan Gohman | b452d4e | 2010-03-24 19:38:02 +0000 | [diff] [blame] | 1231 | } else if (!HasUnlimitedPositionals && |
| 1232 | PositionalVals.size() > PositionalOpts.size()) { |
Eric Liu | e51ee06 | 2017-03-15 08:41:00 +0000 | [diff] [blame] | 1233 | *Errs << ProgramName << ": Too many positional arguments specified!\n" |
| 1234 | << "Can specify at most " << PositionalOpts.size() |
| 1235 | << " positional arguments: See: " << argv[0] << " -help\n"; |
Chris Lattner | d380d84 | 2005-08-08 17:25:38 +0000 | [diff] [blame] | 1236 | ErrorParsing = true; |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1237 | |
Craig Topper | 8d399f8 | 2014-04-09 04:20:00 +0000 | [diff] [blame] | 1238 | } else if (!ConsumeAfterOpt) { |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 1239 | // Positional args have already been handled if ConsumeAfter is specified. |
Evan Cheng | 86cb318 | 2008-05-05 18:30:58 +0000 | [diff] [blame] | 1240 | unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size()); |
| 1241 | for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) { |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1242 | if (RequiresValue(PositionalOpts[i])) { |
Misha Brukman | 10468d8 | 2005-04-21 22:55:34 +0000 | [diff] [blame] | 1243 | ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first, |
Reid Spencer | 2027a6f | 2004-08-13 19:47:30 +0000 | [diff] [blame] | 1244 | PositionalVals[ValNo].second); |
| 1245 | ValNo++; |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1246 | --NumPositionalRequired; // We fulfilled our duty... |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1247 | } |
| 1248 | |
| 1249 | // If we _can_ give this option more arguments, do so now, as long as we |
| 1250 | // do not give it values that others need. 'Done' controls whether the |
| 1251 | // option even _WANTS_ any more. |
| 1252 | // |
Misha Brukman | 069e6b5 | 2003-07-10 16:49:51 +0000 | [diff] [blame] | 1253 | bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required; |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1254 | while (NumVals - ValNo > NumPositionalRequired && !Done) { |
Misha Brukman | 069e6b5 | 2003-07-10 16:49:51 +0000 | [diff] [blame] | 1255 | switch (PositionalOpts[i]->getNumOccurrencesFlag()) { |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1256 | case cl::Optional: |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1257 | Done = true; // Optional arguments want _at most_ one value |
Justin Bogner | cd1d5aa | 2016-08-17 20:30:52 +0000 | [diff] [blame] | 1258 | LLVM_FALLTHROUGH; |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1259 | case cl::ZeroOrMore: // Zero or more will take all they can get... |
| 1260 | case cl::OneOrMore: // One or more will take all they can get... |
Reid Spencer | 2027a6f | 2004-08-13 19:47:30 +0000 | [diff] [blame] | 1261 | ProvidePositionalOption(PositionalOpts[i], |
| 1262 | PositionalVals[ValNo].first, |
| 1263 | PositionalVals[ValNo].second); |
| 1264 | ValNo++; |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1265 | break; |
| 1266 | default: |
Torok Edwin | fbcc663 | 2009-07-14 16:55:14 +0000 | [diff] [blame] | 1267 | llvm_unreachable("Internal error, unexpected NumOccurrences flag in " |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1268 | "positional argument processing!"); |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1269 | } |
| 1270 | } |
Chris Lattner | e81c409 | 2001-10-27 05:54:17 +0000 | [diff] [blame] | 1271 | } |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1272 | } else { |
| 1273 | assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size()); |
| 1274 | unsigned ValNo = 0; |
Evan Cheng | 86cb318 | 2008-05-05 18:30:58 +0000 | [diff] [blame] | 1275 | for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j) |
Reid Spencer | 2027a6f | 2004-08-13 19:47:30 +0000 | [diff] [blame] | 1276 | if (RequiresValue(PositionalOpts[j])) { |
Chris Lattner | ca0e79e | 2002-07-24 20:15:13 +0000 | [diff] [blame] | 1277 | ErrorParsing |= ProvidePositionalOption(PositionalOpts[j], |
Reid Spencer | 2027a6f | 2004-08-13 19:47:30 +0000 | [diff] [blame] | 1278 | PositionalVals[ValNo].first, |
| 1279 | PositionalVals[ValNo].second); |
| 1280 | ValNo++; |
| 1281 | } |
Chris Lattner | ca0e79e | 2002-07-24 20:15:13 +0000 | [diff] [blame] | 1282 | |
| 1283 | // Handle the case where there is just one positional option, and it's |
| 1284 | // optional. In this case, we want to give JUST THE FIRST option to the |
| 1285 | // positional option and keep the rest for the consume after. The above |
| 1286 | // loop would have assigned no values to positional options in this case. |
| 1287 | // |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 1288 | if (PositionalOpts.size() == 1 && ValNo == 0 && !PositionalVals.empty()) { |
| 1289 | ErrorParsing |= ProvidePositionalOption(PositionalOpts[0], |
Reid Spencer | 2027a6f | 2004-08-13 19:47:30 +0000 | [diff] [blame] | 1290 | PositionalVals[ValNo].first, |
| 1291 | PositionalVals[ValNo].second); |
| 1292 | ValNo++; |
| 1293 | } |
Misha Brukman | 10468d8 | 2005-04-21 22:55:34 +0000 | [diff] [blame] | 1294 | |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1295 | // Handle over all of the rest of the arguments to the |
| 1296 | // cl::ConsumeAfter command line option... |
| 1297 | for (; ValNo != PositionalVals.size(); ++ValNo) |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1298 | ErrorParsing |= |
| 1299 | ProvidePositionalOption(ConsumeAfterOpt, PositionalVals[ValNo].first, |
| 1300 | PositionalVals[ValNo].second); |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1301 | } |
| 1302 | |
Chris Lattner | 4fdde2c | 2001-07-23 23:02:45 +0000 | [diff] [blame] | 1303 | // Loop over args and make sure all required args are specified! |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 1304 | for (const auto &Opt : OptionsMap) { |
Justin Bogner | 973b2ff | 2014-07-14 19:24:13 +0000 | [diff] [blame] | 1305 | switch (Opt.second->getNumOccurrencesFlag()) { |
Chris Lattner | 4fdde2c | 2001-07-23 23:02:45 +0000 | [diff] [blame] | 1306 | case Required: |
| 1307 | case OneOrMore: |
Justin Bogner | 973b2ff | 2014-07-14 19:24:13 +0000 | [diff] [blame] | 1308 | if (Opt.second->getNumOccurrences() == 0) { |
| 1309 | Opt.second->error("must be specified at least once!"); |
Chris Lattner | d4617cd | 2001-10-24 06:21:56 +0000 | [diff] [blame] | 1310 | ErrorParsing = true; |
| 1311 | } |
Justin Bogner | cd1d5aa | 2016-08-17 20:30:52 +0000 | [diff] [blame] | 1312 | LLVM_FALLTHROUGH; |
Chris Lattner | 4fdde2c | 2001-07-23 23:02:45 +0000 | [diff] [blame] | 1313 | default: |
| 1314 | break; |
| 1315 | } |
| 1316 | } |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1317 | |
Rafael Espindola | cf14a38 | 2010-11-19 21:14:29 +0000 | [diff] [blame] | 1318 | // Now that we know if -debug is specified, we can use it. |
| 1319 | // Note that if ReadResponseFiles == true, this must be done before the |
| 1320 | // memory allocated for the expanded command line is free()d below. |
| 1321 | DEBUG(dbgs() << "Args: "; |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1322 | for (int i = 0; i < argc; ++i) dbgs() << argv[i] << ' '; |
| 1323 | dbgs() << '\n';); |
Rafael Espindola | cf14a38 | 2010-11-19 21:14:29 +0000 | [diff] [blame] | 1324 | |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1325 | // Free all of the memory allocated to the map. Command line options may only |
| 1326 | // be processed once! |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 1327 | MoreHelp.clear(); |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1328 | |
| 1329 | // If we had an error processing our arguments, don't let the program execute |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1330 | if (ErrorParsing) { |
| 1331 | if (!IgnoreErrors) |
| 1332 | exit(1); |
| 1333 | return false; |
| 1334 | } |
| 1335 | return true; |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1336 | } |
| 1337 | |
| 1338 | //===----------------------------------------------------------------------===// |
| 1339 | // Option Base class implementation |
| 1340 | // |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1341 | |
Chris Lattner | 3b8adaf | 2009-09-20 00:40:49 +0000 | [diff] [blame] | 1342 | bool Option::error(const Twine &Message, StringRef ArgName) { |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1343 | if (!ArgName.data()) |
| 1344 | ArgName = ArgStr; |
Chris Lattner | 3b8adaf | 2009-09-20 00:40:49 +0000 | [diff] [blame] | 1345 | if (ArgName.empty()) |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1346 | errs() << HelpStr; // Be nice for positional arguments |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1347 | else |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 1348 | errs() << GlobalParser->ProgramName << ": for the -" << ArgName; |
Mikhail Glushenkov | 5653d3b | 2008-04-28 16:44:25 +0000 | [diff] [blame] | 1349 | |
Benjamin Kramer | c9aa480 | 2009-08-23 10:01:13 +0000 | [diff] [blame] | 1350 | errs() << " option: " << Message << "\n"; |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1351 | return true; |
| 1352 | } |
| 1353 | |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1354 | bool Option::addOccurrence(unsigned pos, StringRef ArgName, StringRef Value, |
| 1355 | bool MultiArg) { |
Mikhail Glushenkov | cbc26fd | 2009-01-16 22:54:19 +0000 | [diff] [blame] | 1356 | if (!MultiArg) |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1357 | NumOccurrences++; // Increment the number of times we have been seen |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1358 | |
Misha Brukman | 069e6b5 | 2003-07-10 16:49:51 +0000 | [diff] [blame] | 1359 | switch (getNumOccurrencesFlag()) { |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1360 | case Optional: |
Misha Brukman | 069e6b5 | 2003-07-10 16:49:51 +0000 | [diff] [blame] | 1361 | if (NumOccurrences > 1) |
Benjamin Kramer | 666cf9d | 2009-08-02 12:13:02 +0000 | [diff] [blame] | 1362 | return error("may only occur zero or one times!", ArgName); |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1363 | break; |
| 1364 | case Required: |
Misha Brukman | 069e6b5 | 2003-07-10 16:49:51 +0000 | [diff] [blame] | 1365 | if (NumOccurrences > 1) |
Benjamin Kramer | 666cf9d | 2009-08-02 12:13:02 +0000 | [diff] [blame] | 1366 | return error("must occur exactly one time!", ArgName); |
Justin Bogner | cd1d5aa | 2016-08-17 20:30:52 +0000 | [diff] [blame] | 1367 | LLVM_FALLTHROUGH; |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1368 | case OneOrMore: |
Chris Lattner | e81c409 | 2001-10-27 05:54:17 +0000 | [diff] [blame] | 1369 | case ZeroOrMore: |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1370 | case ConsumeAfter: |
| 1371 | break; |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1372 | } |
| 1373 | |
Reid Spencer | 2027a6f | 2004-08-13 19:47:30 +0000 | [diff] [blame] | 1374 | return handleOccurrence(pos, ArgName, Value); |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1375 | } |
| 1376 | |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1377 | // getValueStr - Get the value description string, using "DefaultMsg" if nothing |
| 1378 | // has been specified yet. |
| 1379 | // |
David Blaikie | ff43d69 | 2015-11-17 19:00:52 +0000 | [diff] [blame] | 1380 | static StringRef getValueStr(const Option &O, StringRef DefaultMsg) { |
| 1381 | if (O.ValueStr.empty()) |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1382 | return DefaultMsg; |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1383 | return O.ValueStr; |
| 1384 | } |
| 1385 | |
| 1386 | //===----------------------------------------------------------------------===// |
| 1387 | // cl::alias class implementation |
| 1388 | // |
| 1389 | |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1390 | // Return the width of the option tag for printing... |
David Blaikie | ff43d69 | 2015-11-17 19:00:52 +0000 | [diff] [blame] | 1391 | size_t alias::getOptionWidth() const { return ArgStr.size() + 6; } |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1392 | |
Daniel Berlin | 25f1db1 | 2017-02-19 04:28:56 +0000 | [diff] [blame] | 1393 | void Option::printHelpStr(StringRef HelpStr, size_t Indent, |
| 1394 | size_t FirstLineIndentedBy) { |
Alexander Kornienko | 72a196a | 2013-05-10 17:15:51 +0000 | [diff] [blame] | 1395 | std::pair<StringRef, StringRef> Split = HelpStr.split('\n'); |
| 1396 | outs().indent(Indent - FirstLineIndentedBy) << " - " << Split.first << "\n"; |
| 1397 | while (!Split.second.empty()) { |
| 1398 | Split = Split.second.split('\n'); |
| 1399 | outs().indent(Indent) << Split.first << "\n"; |
| 1400 | } |
| 1401 | } |
| 1402 | |
Chris Lattner | 1b7a515 | 2006-04-28 05:36:25 +0000 | [diff] [blame] | 1403 | // Print out the option for the alias. |
Evan Cheng | 86cb318 | 2008-05-05 18:30:58 +0000 | [diff] [blame] | 1404 | void alias::printOptionInfo(size_t GlobalWidth) const { |
Evan Cheng | 871b712 | 2011-06-13 20:45:54 +0000 | [diff] [blame] | 1405 | outs() << " -" << ArgStr; |
David Blaikie | ff43d69 | 2015-11-17 19:00:52 +0000 | [diff] [blame] | 1406 | printHelpStr(HelpStr, GlobalWidth, ArgStr.size() + 6); |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1407 | } |
| 1408 | |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1409 | //===----------------------------------------------------------------------===// |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1410 | // Parser Implementation code... |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1411 | // |
| 1412 | |
Chris Lattner | b4101b1 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 1413 | // basic_parser implementation |
| 1414 | // |
| 1415 | |
| 1416 | // Return the width of the option tag for printing... |
Evan Cheng | 86cb318 | 2008-05-05 18:30:58 +0000 | [diff] [blame] | 1417 | size_t basic_parser_impl::getOptionWidth(const Option &O) const { |
David Blaikie | ff43d69 | 2015-11-17 19:00:52 +0000 | [diff] [blame] | 1418 | size_t Len = O.ArgStr.size(); |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1419 | auto ValName = getValueName(); |
| 1420 | if (!ValName.empty()) |
David Blaikie | ff43d69 | 2015-11-17 19:00:52 +0000 | [diff] [blame] | 1421 | Len += getValueStr(O, ValName).size() + 3; |
Chris Lattner | b4101b1 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 1422 | |
| 1423 | return Len + 6; |
| 1424 | } |
| 1425 | |
Misha Brukman | 10468d8 | 2005-04-21 22:55:34 +0000 | [diff] [blame] | 1426 | // printOptionInfo - Print out information about this option. The |
Chris Lattner | b4101b1 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 1427 | // to-be-maintained width is specified. |
| 1428 | // |
| 1429 | void basic_parser_impl::printOptionInfo(const Option &O, |
Evan Cheng | 86cb318 | 2008-05-05 18:30:58 +0000 | [diff] [blame] | 1430 | size_t GlobalWidth) const { |
Chris Lattner | 471ba48 | 2009-08-23 08:43:55 +0000 | [diff] [blame] | 1431 | outs() << " -" << O.ArgStr; |
Chris Lattner | b4101b1 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 1432 | |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1433 | auto ValName = getValueName(); |
| 1434 | if (!ValName.empty()) |
Chris Lattner | 471ba48 | 2009-08-23 08:43:55 +0000 | [diff] [blame] | 1435 | outs() << "=<" << getValueStr(O, ValName) << '>'; |
Chris Lattner | b4101b1 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 1436 | |
Daniel Berlin | 25f1db1 | 2017-02-19 04:28:56 +0000 | [diff] [blame] | 1437 | Option::printHelpStr(O.HelpStr, GlobalWidth, getOptionWidth(O)); |
Chris Lattner | b4101b1 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 1438 | } |
| 1439 | |
Andrew Trick | 1200401 | 2011-04-05 18:54:36 +0000 | [diff] [blame] | 1440 | void basic_parser_impl::printOptionName(const Option &O, |
| 1441 | size_t GlobalWidth) const { |
| 1442 | outs() << " -" << O.ArgStr; |
David Blaikie | ff43d69 | 2015-11-17 19:00:52 +0000 | [diff] [blame] | 1443 | outs().indent(GlobalWidth - O.ArgStr.size()); |
Andrew Trick | 1200401 | 2011-04-05 18:54:36 +0000 | [diff] [blame] | 1444 | } |
Chris Lattner | b4101b1 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 1445 | |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1446 | // parser<bool> implementation |
| 1447 | // |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1448 | bool parser<bool>::parse(Option &O, StringRef ArgName, StringRef Arg, |
| 1449 | bool &Value) { |
Misha Brukman | 10468d8 | 2005-04-21 22:55:34 +0000 | [diff] [blame] | 1450 | if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" || |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1451 | Arg == "1") { |
| 1452 | Value = true; |
Chris Lattner | aecd74d | 2009-09-19 18:55:05 +0000 | [diff] [blame] | 1453 | return false; |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1454 | } |
Mikhail Glushenkov | 1d9f1fe | 2009-11-19 17:29:36 +0000 | [diff] [blame] | 1455 | |
Chris Lattner | aecd74d | 2009-09-19 18:55:05 +0000 | [diff] [blame] | 1456 | if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") { |
| 1457 | Value = false; |
| 1458 | return false; |
| 1459 | } |
| 1460 | return O.error("'" + Arg + |
| 1461 | "' is invalid value for boolean argument! Try 0 or 1"); |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1462 | } |
| 1463 | |
Dale Johannesen | 82810c8 | 2007-05-22 17:14:46 +0000 | [diff] [blame] | 1464 | // parser<boolOrDefault> implementation |
| 1465 | // |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1466 | bool parser<boolOrDefault>::parse(Option &O, StringRef ArgName, StringRef Arg, |
| 1467 | boolOrDefault &Value) { |
Dale Johannesen | 82810c8 | 2007-05-22 17:14:46 +0000 | [diff] [blame] | 1468 | if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" || |
| 1469 | Arg == "1") { |
| 1470 | Value = BOU_TRUE; |
Chris Lattner | aecd74d | 2009-09-19 18:55:05 +0000 | [diff] [blame] | 1471 | return false; |
Dale Johannesen | 82810c8 | 2007-05-22 17:14:46 +0000 | [diff] [blame] | 1472 | } |
Chris Lattner | aecd74d | 2009-09-19 18:55:05 +0000 | [diff] [blame] | 1473 | if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") { |
| 1474 | Value = BOU_FALSE; |
| 1475 | return false; |
| 1476 | } |
Mikhail Glushenkov | 1d9f1fe | 2009-11-19 17:29:36 +0000 | [diff] [blame] | 1477 | |
Chris Lattner | aecd74d | 2009-09-19 18:55:05 +0000 | [diff] [blame] | 1478 | return O.error("'" + Arg + |
| 1479 | "' is invalid value for boolean argument! Try 0 or 1"); |
Dale Johannesen | 82810c8 | 2007-05-22 17:14:46 +0000 | [diff] [blame] | 1480 | } |
| 1481 | |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1482 | // parser<int> implementation |
| 1483 | // |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1484 | bool parser<int>::parse(Option &O, StringRef ArgName, StringRef Arg, |
| 1485 | int &Value) { |
Chris Lattner | fa9c6f4 | 2009-09-19 23:59:02 +0000 | [diff] [blame] | 1486 | if (Arg.getAsInteger(0, Value)) |
Benjamin Kramer | 666cf9d | 2009-08-02 12:13:02 +0000 | [diff] [blame] | 1487 | return O.error("'" + Arg + "' value invalid for integer argument!"); |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1488 | return false; |
| 1489 | } |
| 1490 | |
Chris Lattner | 719c715 | 2003-06-28 15:47:20 +0000 | [diff] [blame] | 1491 | // parser<unsigned> implementation |
| 1492 | // |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1493 | bool parser<unsigned>::parse(Option &O, StringRef ArgName, StringRef Arg, |
| 1494 | unsigned &Value) { |
Chris Lattner | fa9c6f4 | 2009-09-19 23:59:02 +0000 | [diff] [blame] | 1495 | |
| 1496 | if (Arg.getAsInteger(0, Value)) |
Benjamin Kramer | 666cf9d | 2009-08-02 12:13:02 +0000 | [diff] [blame] | 1497 | return O.error("'" + Arg + "' value invalid for uint argument!"); |
Chris Lattner | 719c715 | 2003-06-28 15:47:20 +0000 | [diff] [blame] | 1498 | return false; |
| 1499 | } |
| 1500 | |
Benjamin Kramer | 49fc9dd | 2011-09-15 21:17:37 +0000 | [diff] [blame] | 1501 | // parser<unsigned long long> implementation |
| 1502 | // |
| 1503 | bool parser<unsigned long long>::parse(Option &O, StringRef ArgName, |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1504 | StringRef Arg, |
| 1505 | unsigned long long &Value) { |
Benjamin Kramer | 49fc9dd | 2011-09-15 21:17:37 +0000 | [diff] [blame] | 1506 | |
| 1507 | if (Arg.getAsInteger(0, Value)) |
| 1508 | return O.error("'" + Arg + "' value invalid for uint argument!"); |
| 1509 | return false; |
| 1510 | } |
| 1511 | |
Chris Lattner | b4101b1 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 1512 | // parser<double>/parser<float> implementation |
Chris Lattner | 675db8d | 2001-10-13 06:53:19 +0000 | [diff] [blame] | 1513 | // |
Chris Lattner | aecd74d | 2009-09-19 18:55:05 +0000 | [diff] [blame] | 1514 | static bool parseDouble(Option &O, StringRef Arg, double &Value) { |
Pavel Labath | ec000f4 | 2017-06-23 12:55:02 +0000 | [diff] [blame] | 1515 | if (to_float(Arg, Value)) |
| 1516 | return false; |
| 1517 | return O.error("'" + Arg + "' value invalid for floating point argument!"); |
Chris Lattner | 675db8d | 2001-10-13 06:53:19 +0000 | [diff] [blame] | 1518 | } |
| 1519 | |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1520 | bool parser<double>::parse(Option &O, StringRef ArgName, StringRef Arg, |
| 1521 | double &Val) { |
Chris Lattner | b4101b1 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 1522 | return parseDouble(O, Arg, Val); |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1523 | } |
| 1524 | |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1525 | bool parser<float>::parse(Option &O, StringRef ArgName, StringRef Arg, |
| 1526 | float &Val) { |
Chris Lattner | b4101b1 | 2002-08-07 18:36:37 +0000 | [diff] [blame] | 1527 | double dVal; |
| 1528 | if (parseDouble(O, Arg, dVal)) |
| 1529 | return true; |
| 1530 | Val = (float)dVal; |
| 1531 | return false; |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1532 | } |
| 1533 | |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1534 | // generic_parser_base implementation |
| 1535 | // |
| 1536 | |
Chris Lattner | 494c0b0 | 2002-07-23 17:15:12 +0000 | [diff] [blame] | 1537 | // findOption - Return the option number corresponding to the specified |
| 1538 | // argument string. If the option is not found, getNumOptions() is returned. |
| 1539 | // |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1540 | unsigned generic_parser_base::findOption(StringRef Name) { |
Benjamin Kramer | 543d9b2 | 2009-09-19 10:01:45 +0000 | [diff] [blame] | 1541 | unsigned e = getNumOptions(); |
Chris Lattner | 494c0b0 | 2002-07-23 17:15:12 +0000 | [diff] [blame] | 1542 | |
Benjamin Kramer | 543d9b2 | 2009-09-19 10:01:45 +0000 | [diff] [blame] | 1543 | for (unsigned i = 0; i != e; ++i) { |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1544 | if (getOption(i) == Name) |
Chris Lattner | 494c0b0 | 2002-07-23 17:15:12 +0000 | [diff] [blame] | 1545 | return i; |
Benjamin Kramer | 543d9b2 | 2009-09-19 10:01:45 +0000 | [diff] [blame] | 1546 | } |
Chris Lattner | 494c0b0 | 2002-07-23 17:15:12 +0000 | [diff] [blame] | 1547 | return e; |
| 1548 | } |
| 1549 | |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1550 | // Return the width of the option tag for printing... |
Evan Cheng | 86cb318 | 2008-05-05 18:30:58 +0000 | [diff] [blame] | 1551 | size_t generic_parser_base::getOptionWidth(const Option &O) const { |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1552 | if (O.hasArgStr()) { |
David Blaikie | ff43d69 | 2015-11-17 19:00:52 +0000 | [diff] [blame] | 1553 | size_t Size = O.ArgStr.size() + 6; |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1554 | for (unsigned i = 0, e = getNumOptions(); i != e; ++i) |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1555 | Size = std::max(Size, getOption(i).size() + 8); |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1556 | return Size; |
| 1557 | } else { |
Evan Cheng | 86cb318 | 2008-05-05 18:30:58 +0000 | [diff] [blame] | 1558 | size_t BaseSize = 0; |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1559 | for (unsigned i = 0, e = getNumOptions(); i != e; ++i) |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1560 | BaseSize = std::max(BaseSize, getOption(i).size() + 8); |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1561 | return BaseSize; |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1562 | } |
| 1563 | } |
| 1564 | |
Misha Brukman | 10468d8 | 2005-04-21 22:55:34 +0000 | [diff] [blame] | 1565 | // printOptionInfo - Print out information about this option. The |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1566 | // to-be-maintained width is specified. |
| 1567 | // |
| 1568 | void generic_parser_base::printOptionInfo(const Option &O, |
Evan Cheng | 86cb318 | 2008-05-05 18:30:58 +0000 | [diff] [blame] | 1569 | size_t GlobalWidth) const { |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1570 | if (O.hasArgStr()) { |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 1571 | outs() << " -" << O.ArgStr; |
Daniel Berlin | 25f1db1 | 2017-02-19 04:28:56 +0000 | [diff] [blame] | 1572 | Option::printHelpStr(O.HelpStr, GlobalWidth, O.ArgStr.size() + 6); |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1573 | |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1574 | for (unsigned i = 0, e = getNumOptions(); i != e; ++i) { |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1575 | size_t NumSpaces = GlobalWidth - getOption(i).size() - 8; |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 1576 | outs() << " =" << getOption(i); |
| 1577 | outs().indent(NumSpaces) << " - " << getDescription(i) << '\n'; |
Chris Lattner | c2ef08c | 2002-01-31 00:42:56 +0000 | [diff] [blame] | 1578 | } |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1579 | } else { |
David Blaikie | ff43d69 | 2015-11-17 19:00:52 +0000 | [diff] [blame] | 1580 | if (!O.HelpStr.empty()) |
Chris Lattner | e7c1e21 | 2009-09-20 05:03:30 +0000 | [diff] [blame] | 1581 | outs() << " " << O.HelpStr << '\n'; |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1582 | for (unsigned i = 0, e = getNumOptions(); i != e; ++i) { |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1583 | auto Option = getOption(i); |
Alexander Kornienko | 72a196a | 2013-05-10 17:15:51 +0000 | [diff] [blame] | 1584 | outs() << " -" << Option; |
Daniel Berlin | 25f1db1 | 2017-02-19 04:28:56 +0000 | [diff] [blame] | 1585 | Option::printHelpStr(getDescription(i), GlobalWidth, Option.size() + 8); |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1586 | } |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1587 | } |
| 1588 | } |
| 1589 | |
Andrew Trick | 1200401 | 2011-04-05 18:54:36 +0000 | [diff] [blame] | 1590 | static const size_t MaxOptWidth = 8; // arbitrary spacing for printOptionDiff |
| 1591 | |
| 1592 | // printGenericOptionDiff - Print the value of this option and it's default. |
| 1593 | // |
| 1594 | // "Generic" options have each value mapped to a name. |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1595 | void generic_parser_base::printGenericOptionDiff( |
| 1596 | const Option &O, const GenericOptionValue &Value, |
| 1597 | const GenericOptionValue &Default, size_t GlobalWidth) const { |
Andrew Trick | 1200401 | 2011-04-05 18:54:36 +0000 | [diff] [blame] | 1598 | outs() << " -" << O.ArgStr; |
David Blaikie | ff43d69 | 2015-11-17 19:00:52 +0000 | [diff] [blame] | 1599 | outs().indent(GlobalWidth - O.ArgStr.size()); |
Andrew Trick | 1200401 | 2011-04-05 18:54:36 +0000 | [diff] [blame] | 1600 | |
| 1601 | unsigned NumOpts = getNumOptions(); |
| 1602 | for (unsigned i = 0; i != NumOpts; ++i) { |
| 1603 | if (Value.compare(getOptionValue(i))) |
| 1604 | continue; |
| 1605 | |
| 1606 | outs() << "= " << getOption(i); |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1607 | size_t L = getOption(i).size(); |
Andrew Trick | 1200401 | 2011-04-05 18:54:36 +0000 | [diff] [blame] | 1608 | size_t NumSpaces = MaxOptWidth > L ? MaxOptWidth - L : 0; |
| 1609 | outs().indent(NumSpaces) << " (default: "; |
| 1610 | for (unsigned j = 0; j != NumOpts; ++j) { |
| 1611 | if (Default.compare(getOptionValue(j))) |
| 1612 | continue; |
| 1613 | outs() << getOption(j); |
| 1614 | break; |
| 1615 | } |
| 1616 | outs() << ")\n"; |
| 1617 | return; |
| 1618 | } |
| 1619 | outs() << "= *unknown option value*\n"; |
| 1620 | } |
| 1621 | |
| 1622 | // printOptionDiff - Specializations for printing basic value types. |
| 1623 | // |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1624 | #define PRINT_OPT_DIFF(T) \ |
| 1625 | void parser<T>::printOptionDiff(const Option &O, T V, OptionValue<T> D, \ |
| 1626 | size_t GlobalWidth) const { \ |
| 1627 | printOptionName(O, GlobalWidth); \ |
| 1628 | std::string Str; \ |
| 1629 | { \ |
| 1630 | raw_string_ostream SS(Str); \ |
| 1631 | SS << V; \ |
| 1632 | } \ |
| 1633 | outs() << "= " << Str; \ |
| 1634 | size_t NumSpaces = \ |
| 1635 | MaxOptWidth > Str.size() ? MaxOptWidth - Str.size() : 0; \ |
| 1636 | outs().indent(NumSpaces) << " (default: "; \ |
| 1637 | if (D.hasValue()) \ |
| 1638 | outs() << D.getValue(); \ |
| 1639 | else \ |
| 1640 | outs() << "*no default*"; \ |
| 1641 | outs() << ")\n"; \ |
| 1642 | } |
Andrew Trick | 1200401 | 2011-04-05 18:54:36 +0000 | [diff] [blame] | 1643 | |
Frits van Bommel | 87e3367 | 2011-04-06 12:29:56 +0000 | [diff] [blame] | 1644 | PRINT_OPT_DIFF(bool) |
| 1645 | PRINT_OPT_DIFF(boolOrDefault) |
| 1646 | PRINT_OPT_DIFF(int) |
| 1647 | PRINT_OPT_DIFF(unsigned) |
Benjamin Kramer | 49fc9dd | 2011-09-15 21:17:37 +0000 | [diff] [blame] | 1648 | PRINT_OPT_DIFF(unsigned long long) |
Frits van Bommel | 87e3367 | 2011-04-06 12:29:56 +0000 | [diff] [blame] | 1649 | PRINT_OPT_DIFF(double) |
| 1650 | PRINT_OPT_DIFF(float) |
| 1651 | PRINT_OPT_DIFF(char) |
Andrew Trick | 1200401 | 2011-04-05 18:54:36 +0000 | [diff] [blame] | 1652 | |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1653 | void parser<std::string>::printOptionDiff(const Option &O, StringRef V, |
Benjamin Kramer | c321e53 | 2016-06-08 19:09:22 +0000 | [diff] [blame] | 1654 | const OptionValue<std::string> &D, |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1655 | size_t GlobalWidth) const { |
Andrew Trick | 1200401 | 2011-04-05 18:54:36 +0000 | [diff] [blame] | 1656 | printOptionName(O, GlobalWidth); |
| 1657 | outs() << "= " << V; |
| 1658 | size_t NumSpaces = MaxOptWidth > V.size() ? MaxOptWidth - V.size() : 0; |
| 1659 | outs().indent(NumSpaces) << " (default: "; |
| 1660 | if (D.hasValue()) |
| 1661 | outs() << D.getValue(); |
| 1662 | else |
| 1663 | outs() << "*no default*"; |
| 1664 | outs() << ")\n"; |
| 1665 | } |
| 1666 | |
| 1667 | // Print a placeholder for options that don't yet support printOptionDiff(). |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1668 | void basic_parser_impl::printOptionNoValue(const Option &O, |
| 1669 | size_t GlobalWidth) const { |
Andrew Trick | 1200401 | 2011-04-05 18:54:36 +0000 | [diff] [blame] | 1670 | printOptionName(O, GlobalWidth); |
| 1671 | outs() << "= *cannot print option value*\n"; |
| 1672 | } |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1673 | |
| 1674 | //===----------------------------------------------------------------------===// |
Duncan Sands | 142b9ed | 2010-02-18 14:08:13 +0000 | [diff] [blame] | 1675 | // -help and -help-hidden option implementation |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1676 | // |
Reid Spencer | 1f4ab8b | 2004-11-14 22:04:00 +0000 | [diff] [blame] | 1677 | |
Benjamin Kramer | bd5ee50 | 2015-03-14 00:20:13 +0000 | [diff] [blame] | 1678 | static int OptNameCompare(const std::pair<const char *, Option *> *LHS, |
| 1679 | const std::pair<const char *, Option *> *RHS) { |
| 1680 | return strcmp(LHS->first, RHS->first); |
Chris Lattner | 6ec8caf | 2009-09-20 05:37:24 +0000 | [diff] [blame] | 1681 | } |
| 1682 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1683 | static int SubNameCompare(const std::pair<const char *, SubCommand *> *LHS, |
| 1684 | const std::pair<const char *, SubCommand *> *RHS) { |
| 1685 | return strcmp(LHS->first, RHS->first); |
| 1686 | } |
| 1687 | |
Andrew Trick | 1200401 | 2011-04-05 18:54:36 +0000 | [diff] [blame] | 1688 | // Copy Options into a vector so we can sort them as we like. |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1689 | static void sortOpts(StringMap<Option *> &OptMap, |
| 1690 | SmallVectorImpl<std::pair<const char *, Option *>> &Opts, |
| 1691 | bool ShowHidden) { |
Matthias Braun | b30f2f51 | 2016-01-30 01:24:31 +0000 | [diff] [blame] | 1692 | SmallPtrSet<Option *, 32> OptionSet; // Duplicate option detection. |
Andrew Trick | 1200401 | 2011-04-05 18:54:36 +0000 | [diff] [blame] | 1693 | |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1694 | for (StringMap<Option *>::iterator I = OptMap.begin(), E = OptMap.end(); |
Andrew Trick | 1200401 | 2011-04-05 18:54:36 +0000 | [diff] [blame] | 1695 | I != E; ++I) { |
| 1696 | // Ignore really-hidden options. |
| 1697 | if (I->second->getOptionHiddenFlag() == ReallyHidden) |
| 1698 | continue; |
| 1699 | |
| 1700 | // Unless showhidden is set, ignore hidden flags. |
| 1701 | if (I->second->getOptionHiddenFlag() == Hidden && !ShowHidden) |
| 1702 | continue; |
| 1703 | |
| 1704 | // If we've already seen this option, don't add it to the list again. |
David Blaikie | 70573dc | 2014-11-19 07:49:26 +0000 | [diff] [blame] | 1705 | if (!OptionSet.insert(I->second).second) |
Andrew Trick | 1200401 | 2011-04-05 18:54:36 +0000 | [diff] [blame] | 1706 | continue; |
| 1707 | |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1708 | Opts.push_back( |
| 1709 | std::pair<const char *, Option *>(I->getKey().data(), I->second)); |
Andrew Trick | 1200401 | 2011-04-05 18:54:36 +0000 | [diff] [blame] | 1710 | } |
| 1711 | |
| 1712 | // Sort the options list alphabetically. |
Benjamin Kramer | bd5ee50 | 2015-03-14 00:20:13 +0000 | [diff] [blame] | 1713 | array_pod_sort(Opts.begin(), Opts.end(), OptNameCompare); |
Andrew Trick | 1200401 | 2011-04-05 18:54:36 +0000 | [diff] [blame] | 1714 | } |
| 1715 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1716 | static void |
| 1717 | sortSubCommands(const SmallPtrSetImpl<SubCommand *> &SubMap, |
| 1718 | SmallVectorImpl<std::pair<const char *, SubCommand *>> &Subs) { |
| 1719 | for (const auto &S : SubMap) { |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1720 | if (S->getName().empty()) |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1721 | continue; |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1722 | Subs.push_back(std::make_pair(S->getName().data(), S)); |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1723 | } |
| 1724 | array_pod_sort(Subs.begin(), Subs.end(), SubNameCompare); |
| 1725 | } |
| 1726 | |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1727 | namespace { |
| 1728 | |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1729 | class HelpPrinter { |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1730 | protected: |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1731 | const bool ShowHidden; |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1732 | typedef SmallVector<std::pair<const char *, Option *>, 128> |
| 1733 | StrOptionPairVector; |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1734 | typedef SmallVector<std::pair<const char *, SubCommand *>, 128> |
| 1735 | StrSubCommandPairVector; |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1736 | // Print the options. Opts is assumed to be alphabetically sorted. |
| 1737 | virtual void printOptions(StrOptionPairVector &Opts, size_t MaxArgLen) { |
| 1738 | for (size_t i = 0, e = Opts.size(); i != e; ++i) |
| 1739 | Opts[i].second->printOptionInfo(MaxArgLen); |
| 1740 | } |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1741 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1742 | void printSubCommands(StrSubCommandPairVector &Subs, size_t MaxSubLen) { |
| 1743 | for (const auto &S : Subs) { |
| 1744 | outs() << " " << S.first; |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1745 | if (!S.second->getDescription().empty()) { |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1746 | outs().indent(MaxSubLen - strlen(S.first)); |
| 1747 | outs() << " - " << S.second->getDescription(); |
| 1748 | } |
| 1749 | outs() << "\n"; |
| 1750 | } |
| 1751 | } |
| 1752 | |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1753 | public: |
Craig Topper | fa9888f | 2013-03-09 23:29:37 +0000 | [diff] [blame] | 1754 | explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {} |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1755 | virtual ~HelpPrinter() {} |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1756 | |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1757 | // Invoke the printer. |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1758 | void operator=(bool Value) { |
David Blaikie | dc3f01e | 2015-03-09 01:57:13 +0000 | [diff] [blame] | 1759 | if (!Value) |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1760 | return; |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1761 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1762 | SubCommand *Sub = GlobalParser->getActiveSubCommand(); |
| 1763 | auto &OptionsMap = Sub->OptionsMap; |
| 1764 | auto &PositionalOpts = Sub->PositionalOpts; |
| 1765 | auto &ConsumeAfterOpt = Sub->ConsumeAfterOpt; |
| 1766 | |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1767 | StrOptionPairVector Opts; |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1768 | sortOpts(OptionsMap, Opts, ShowHidden); |
| 1769 | |
| 1770 | StrSubCommandPairVector Subs; |
| 1771 | sortSubCommands(GlobalParser->RegisteredSubCommands, Subs); |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1772 | |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1773 | if (!GlobalParser->ProgramOverview.empty()) |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 1774 | outs() << "OVERVIEW: " << GlobalParser->ProgramOverview << "\n"; |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1775 | |
Zachary Turner | 79f3333 | 2016-10-11 15:58:48 +0000 | [diff] [blame] | 1776 | if (Sub == &*TopLevelSubCommand) { |
| 1777 | outs() << "USAGE: " << GlobalParser->ProgramName; |
| 1778 | if (Subs.size() > 2) |
| 1779 | outs() << " [subcommand]"; |
| 1780 | outs() << " [options]"; |
| 1781 | } else { |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1782 | if (!Sub->getDescription().empty()) { |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1783 | outs() << "SUBCOMMAND '" << Sub->getName() |
| 1784 | << "': " << Sub->getDescription() << "\n\n"; |
| 1785 | } |
| 1786 | outs() << "USAGE: " << GlobalParser->ProgramName << " " << Sub->getName() |
| 1787 | << " [options]"; |
| 1788 | } |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1789 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1790 | for (auto Opt : PositionalOpts) { |
David Blaikie | ff43d69 | 2015-11-17 19:00:52 +0000 | [diff] [blame] | 1791 | if (Opt->hasArgStr()) |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 1792 | outs() << " --" << Opt->ArgStr; |
| 1793 | outs() << " " << Opt->HelpStr; |
Chris Lattner | 2da046f | 2003-07-30 17:34:02 +0000 | [diff] [blame] | 1794 | } |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1795 | |
| 1796 | // Print the consume after option info if it exists... |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1797 | if (ConsumeAfterOpt) |
| 1798 | outs() << " " << ConsumeAfterOpt->HelpStr; |
| 1799 | |
Alex Lorenz | d680287 | 2016-10-12 10:04:35 +0000 | [diff] [blame] | 1800 | if (Sub == &*TopLevelSubCommand && !Subs.empty()) { |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1801 | // Compute the maximum subcommand length... |
| 1802 | size_t MaxSubLen = 0; |
| 1803 | for (size_t i = 0, e = Subs.size(); i != e; ++i) |
| 1804 | MaxSubLen = std::max(MaxSubLen, strlen(Subs[i].first)); |
| 1805 | |
| 1806 | outs() << "\n\n"; |
| 1807 | outs() << "SUBCOMMANDS:\n\n"; |
| 1808 | printSubCommands(Subs, MaxSubLen); |
| 1809 | outs() << "\n"; |
| 1810 | outs() << " Type \"" << GlobalParser->ProgramName |
| 1811 | << " <subcommand> -help\" to get more help on a specific " |
| 1812 | "subcommand"; |
| 1813 | } |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1814 | |
Chris Lattner | 471ba48 | 2009-08-23 08:43:55 +0000 | [diff] [blame] | 1815 | outs() << "\n\n"; |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1816 | |
| 1817 | // Compute the maximum argument length... |
Craig Topper | fa9888f | 2013-03-09 23:29:37 +0000 | [diff] [blame] | 1818 | size_t MaxArgLen = 0; |
Evan Cheng | 86cb318 | 2008-05-05 18:30:58 +0000 | [diff] [blame] | 1819 | for (size_t i = 0, e = Opts.size(); i != e; ++i) |
Chris Lattner | 6ec8caf | 2009-09-20 05:37:24 +0000 | [diff] [blame] | 1820 | MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth()); |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1821 | |
Chris Lattner | 471ba48 | 2009-08-23 08:43:55 +0000 | [diff] [blame] | 1822 | outs() << "OPTIONS:\n"; |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1823 | printOptions(Opts, MaxArgLen); |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1824 | |
Chris Lattner | 37bcd99 | 2004-11-19 17:08:15 +0000 | [diff] [blame] | 1825 | // Print any extra help the user has declared. |
Chris Bieneman | d1d9430 | 2015-01-28 19:00:25 +0000 | [diff] [blame] | 1826 | for (auto I : GlobalParser->MoreHelp) |
| 1827 | outs() << I; |
| 1828 | GlobalParser->MoreHelp.clear(); |
Reid Spencer | 1f4ab8b | 2004-11-14 22:04:00 +0000 | [diff] [blame] | 1829 | |
Reid Spencer | 5e55470 | 2004-11-16 06:11:52 +0000 | [diff] [blame] | 1830 | // Halt the program since help information was printed |
Justin Bogner | 02b9584 | 2014-02-28 19:08:01 +0000 | [diff] [blame] | 1831 | exit(0); |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1832 | } |
| 1833 | }; |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1834 | |
| 1835 | class CategorizedHelpPrinter : public HelpPrinter { |
| 1836 | public: |
| 1837 | explicit CategorizedHelpPrinter(bool showHidden) : HelpPrinter(showHidden) {} |
| 1838 | |
| 1839 | // Helper function for printOptions(). |
Benjamin Kramer | bd5ee50 | 2015-03-14 00:20:13 +0000 | [diff] [blame] | 1840 | // It shall return a negative value if A's name should be lexicographically |
Daniel Sanders | 513c3e4 | 2017-03-27 13:43:24 +0000 | [diff] [blame] | 1841 | // ordered before B's name. It returns a value greater than zero if B's name |
| 1842 | // should be ordered before A's name, and it returns 0 otherwise. |
Benjamin Kramer | bd5ee50 | 2015-03-14 00:20:13 +0000 | [diff] [blame] | 1843 | static int OptionCategoryCompare(OptionCategory *const *A, |
| 1844 | OptionCategory *const *B) { |
Daniel Sanders | 513c3e4 | 2017-03-27 13:43:24 +0000 | [diff] [blame] | 1845 | return (*A)->getName().compare((*B)->getName()); |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1846 | } |
| 1847 | |
| 1848 | // Make sure we inherit our base class's operator=() |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1849 | using HelpPrinter::operator=; |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1850 | |
| 1851 | protected: |
Craig Topper | 32ea826 | 2014-03-04 06:24:11 +0000 | [diff] [blame] | 1852 | void printOptions(StrOptionPairVector &Opts, size_t MaxArgLen) override { |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1853 | std::vector<OptionCategory *> SortedCategories; |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1854 | std::map<OptionCategory *, std::vector<Option *>> CategorizedOptions; |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1855 | |
Alp Toker | cb40291 | 2014-01-24 17:20:08 +0000 | [diff] [blame] | 1856 | // Collect registered option categories into vector in preparation for |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1857 | // sorting. |
Chris Bieneman | 67e426a | 2015-02-13 22:54:32 +0000 | [diff] [blame] | 1858 | for (auto I = GlobalParser->RegisteredOptionCategories.begin(), |
| 1859 | E = GlobalParser->RegisteredOptionCategories.end(); |
Alexander Kornienko | d772d72 | 2014-02-07 17:42:30 +0000 | [diff] [blame] | 1860 | I != E; ++I) { |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1861 | SortedCategories.push_back(*I); |
Alexander Kornienko | d772d72 | 2014-02-07 17:42:30 +0000 | [diff] [blame] | 1862 | } |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1863 | |
| 1864 | // Sort the different option categories alphabetically. |
| 1865 | assert(SortedCategories.size() > 0 && "No option categories registered!"); |
Benjamin Kramer | bd5ee50 | 2015-03-14 00:20:13 +0000 | [diff] [blame] | 1866 | array_pod_sort(SortedCategories.begin(), SortedCategories.end(), |
| 1867 | OptionCategoryCompare); |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1868 | |
| 1869 | // Create map to empty vectors. |
| 1870 | for (std::vector<OptionCategory *>::const_iterator |
| 1871 | I = SortedCategories.begin(), |
| 1872 | E = SortedCategories.end(); |
| 1873 | I != E; ++I) |
| 1874 | CategorizedOptions[*I] = std::vector<Option *>(); |
| 1875 | |
| 1876 | // Walk through pre-sorted options and assign into categories. |
| 1877 | // Because the options are already alphabetically sorted the |
| 1878 | // options within categories will also be alphabetically sorted. |
| 1879 | for (size_t I = 0, E = Opts.size(); I != E; ++I) { |
| 1880 | Option *Opt = Opts[I].second; |
| 1881 | assert(CategorizedOptions.count(Opt->Category) > 0 && |
| 1882 | "Option has an unregistered category"); |
| 1883 | CategorizedOptions[Opt->Category].push_back(Opt); |
| 1884 | } |
| 1885 | |
| 1886 | // Now do printing. |
| 1887 | for (std::vector<OptionCategory *>::const_iterator |
| 1888 | Category = SortedCategories.begin(), |
| 1889 | E = SortedCategories.end(); |
| 1890 | Category != E; ++Category) { |
| 1891 | // Hide empty categories for -help, but show for -help-hidden. |
Benjamin Kramer | 4dea8f5 | 2016-06-17 18:59:41 +0000 | [diff] [blame] | 1892 | const auto &CategoryOptions = CategorizedOptions[*Category]; |
| 1893 | bool IsEmptyCategory = CategoryOptions.empty(); |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1894 | if (!ShowHidden && IsEmptyCategory) |
| 1895 | continue; |
| 1896 | |
| 1897 | // Print category information. |
| 1898 | outs() << "\n"; |
| 1899 | outs() << (*Category)->getName() << ":\n"; |
| 1900 | |
| 1901 | // Check if description is set. |
Mehdi Amini | e11b745 | 2016-10-01 03:43:20 +0000 | [diff] [blame] | 1902 | if (!(*Category)->getDescription().empty()) |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1903 | outs() << (*Category)->getDescription() << "\n\n"; |
| 1904 | else |
| 1905 | outs() << "\n"; |
| 1906 | |
| 1907 | // When using -help-hidden explicitly state if the category has no |
| 1908 | // options associated with it. |
| 1909 | if (IsEmptyCategory) { |
| 1910 | outs() << " This option category has no options.\n"; |
| 1911 | continue; |
| 1912 | } |
| 1913 | // Loop over the options in the category and print. |
Benjamin Kramer | 4dea8f5 | 2016-06-17 18:59:41 +0000 | [diff] [blame] | 1914 | for (const Option *Opt : CategoryOptions) |
| 1915 | Opt->printOptionInfo(MaxArgLen); |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1916 | } |
| 1917 | } |
| 1918 | }; |
| 1919 | |
| 1920 | // This wraps the Uncategorizing and Categorizing printers and decides |
| 1921 | // at run time which should be invoked. |
| 1922 | class HelpPrinterWrapper { |
| 1923 | private: |
| 1924 | HelpPrinter &UncategorizedPrinter; |
| 1925 | CategorizedHelpPrinter &CategorizedPrinter; |
| 1926 | |
| 1927 | public: |
| 1928 | explicit HelpPrinterWrapper(HelpPrinter &UncategorizedPrinter, |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1929 | CategorizedHelpPrinter &CategorizedPrinter) |
| 1930 | : UncategorizedPrinter(UncategorizedPrinter), |
| 1931 | CategorizedPrinter(CategorizedPrinter) {} |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1932 | |
| 1933 | // Invoke the printer. |
| 1934 | void operator=(bool Value); |
| 1935 | }; |
| 1936 | |
Chris Lattner | adb19d6 | 2006-10-12 22:09:17 +0000 | [diff] [blame] | 1937 | } // End anonymous namespace |
Chris Lattner | 36a57d3 | 2001-07-23 17:17:47 +0000 | [diff] [blame] | 1938 | |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1939 | // Declare the four HelpPrinter instances that are used to print out help, or |
| 1940 | // help-hidden as an uncategorized list or in categories. |
| 1941 | static HelpPrinter UncategorizedNormalPrinter(false); |
| 1942 | static HelpPrinter UncategorizedHiddenPrinter(true); |
| 1943 | static CategorizedHelpPrinter CategorizedNormalPrinter(false); |
| 1944 | static CategorizedHelpPrinter CategorizedHiddenPrinter(true); |
| 1945 | |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1946 | // Declare HelpPrinter wrappers that will decide whether or not to invoke |
| 1947 | // a categorizing help printer |
| 1948 | static HelpPrinterWrapper WrappedNormalPrinter(UncategorizedNormalPrinter, |
| 1949 | CategorizedNormalPrinter); |
| 1950 | static HelpPrinterWrapper WrappedHiddenPrinter(UncategorizedHiddenPrinter, |
| 1951 | CategorizedHiddenPrinter); |
| 1952 | |
Chris Bieneman | 831fc5e | 2015-01-26 16:56:00 +0000 | [diff] [blame] | 1953 | // Define a category for generic options that all tools should have. |
| 1954 | static cl::OptionCategory GenericCategory("Generic Options"); |
| 1955 | |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1956 | // Define uncategorized help printers. |
| 1957 | // -help-list is hidden by default because if Option categories are being used |
| 1958 | // then -help behaves the same as -help-list. |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1959 | static cl::opt<HelpPrinter, true, parser<bool>> HLOp( |
| 1960 | "help-list", |
| 1961 | cl::desc("Display list of available options (-help-list-hidden for more)"), |
Chris Bieneman | 831fc5e | 2015-01-26 16:56:00 +0000 | [diff] [blame] | 1962 | cl::location(UncategorizedNormalPrinter), cl::Hidden, cl::ValueDisallowed, |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1963 | cl::cat(GenericCategory), cl::sub(*AllSubCommands)); |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1964 | |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1965 | static cl::opt<HelpPrinter, true, parser<bool>> |
| 1966 | HLHOp("help-list-hidden", cl::desc("Display list of all available options"), |
| 1967 | cl::location(UncategorizedHiddenPrinter), cl::Hidden, |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1968 | cl::ValueDisallowed, cl::cat(GenericCategory), |
| 1969 | cl::sub(*AllSubCommands)); |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1970 | |
| 1971 | // Define uncategorized/categorized help printers. These printers change their |
| 1972 | // behaviour at runtime depending on whether one or more Option categories have |
| 1973 | // been declared. |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1974 | static cl::opt<HelpPrinterWrapper, true, parser<bool>> |
| 1975 | HOp("help", cl::desc("Display available options (-help-hidden for more)"), |
Chris Bieneman | 831fc5e | 2015-01-26 16:56:00 +0000 | [diff] [blame] | 1976 | cl::location(WrappedNormalPrinter), cl::ValueDisallowed, |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1977 | cl::cat(GenericCategory), cl::sub(*AllSubCommands)); |
Chris Lattner | 5df56c4 | 2002-07-22 02:07:59 +0000 | [diff] [blame] | 1978 | |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1979 | static cl::opt<HelpPrinterWrapper, true, parser<bool>> |
| 1980 | HHOp("help-hidden", cl::desc("Display all available options"), |
Chris Bieneman | 831fc5e | 2015-01-26 16:56:00 +0000 | [diff] [blame] | 1981 | cl::location(WrappedHiddenPrinter), cl::Hidden, cl::ValueDisallowed, |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1982 | cl::cat(GenericCategory), cl::sub(*AllSubCommands)); |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1983 | |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1984 | static cl::opt<bool> PrintOptions( |
| 1985 | "print-options", |
| 1986 | cl::desc("Print non-default options after command line parsing"), |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1987 | cl::Hidden, cl::init(false), cl::cat(GenericCategory), |
| 1988 | cl::sub(*AllSubCommands)); |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1989 | |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 1990 | static cl::opt<bool> PrintAllOptions( |
| 1991 | "print-all-options", |
| 1992 | cl::desc("Print all option values after command line parsing"), cl::Hidden, |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 1993 | cl::init(false), cl::cat(GenericCategory), cl::sub(*AllSubCommands)); |
Andrew Trick | 1200401 | 2011-04-05 18:54:36 +0000 | [diff] [blame] | 1994 | |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1995 | void HelpPrinterWrapper::operator=(bool Value) { |
David Blaikie | dc3f01e | 2015-03-09 01:57:13 +0000 | [diff] [blame] | 1996 | if (!Value) |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 1997 | return; |
| 1998 | |
| 1999 | // Decide which printer to invoke. If more than one option category is |
| 2000 | // registered then it is useful to show the categorized help instead of |
| 2001 | // uncategorized help. |
Chris Bieneman | 67e426a | 2015-02-13 22:54:32 +0000 | [diff] [blame] | 2002 | if (GlobalParser->RegisteredOptionCategories.size() > 1) { |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 2003 | // unhide -help-list option so user can have uncategorized output if they |
| 2004 | // want it. |
| 2005 | HLOp.setHiddenFlag(NotHidden); |
| 2006 | |
| 2007 | CategorizedPrinter = true; // Invoke categorized printer |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 2008 | } else |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 2009 | UncategorizedPrinter = true; // Invoke uncategorized printer |
| 2010 | } |
| 2011 | |
Andrew Trick | 1200401 | 2011-04-05 18:54:36 +0000 | [diff] [blame] | 2012 | // Print the value of each option. |
Chris Bieneman | d77bbab | 2015-01-30 22:16:01 +0000 | [diff] [blame] | 2013 | void cl::PrintOptionValues() { GlobalParser->printOptionValues(); } |
| 2014 | |
| 2015 | void CommandLineParser::printOptionValues() { |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 2016 | if (!PrintOptions && !PrintAllOptions) |
| 2017 | return; |
Andrew Trick | 1200401 | 2011-04-05 18:54:36 +0000 | [diff] [blame] | 2018 | |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 2019 | SmallVector<std::pair<const char *, Option *>, 128> Opts; |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 2020 | sortOpts(ActiveSubCommand->OptionsMap, Opts, /*ShowHidden*/ true); |
Andrew Trick | 1200401 | 2011-04-05 18:54:36 +0000 | [diff] [blame] | 2021 | |
| 2022 | // Compute the maximum argument length... |
| 2023 | size_t MaxArgLen = 0; |
| 2024 | for (size_t i = 0, e = Opts.size(); i != e; ++i) |
| 2025 | MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth()); |
| 2026 | |
| 2027 | for (size_t i = 0, e = Opts.size(); i != e; ++i) |
| 2028 | Opts[i].second->printOptionValue(MaxArgLen, PrintAllOptions); |
| 2029 | } |
| 2030 | |
Dimitry Andric | bc3feaa | 2017-06-06 21:54:04 +0000 | [diff] [blame] | 2031 | static VersionPrinterTy OverrideVersionPrinter = nullptr; |
Reid Spencer | b317167 | 2006-06-05 16:22:56 +0000 | [diff] [blame] | 2032 | |
Dimitry Andric | bc3feaa | 2017-06-06 21:54:04 +0000 | [diff] [blame] | 2033 | static std::vector<VersionPrinterTy> *ExtraVersionPrinters = nullptr; |
Chandler Carruth | ea7e552 | 2011-07-22 07:50:40 +0000 | [diff] [blame] | 2034 | |
Chris Lattner | adb19d6 | 2006-10-12 22:09:17 +0000 | [diff] [blame] | 2035 | namespace { |
Reid Spencer | b317167 | 2006-06-05 16:22:56 +0000 | [diff] [blame] | 2036 | class VersionPrinter { |
| 2037 | public: |
Devang Patel | 9eb2caae | 2007-02-01 01:43:37 +0000 | [diff] [blame] | 2038 | void print() { |
Chris Lattner | 131dca9 | 2009-09-20 06:18:38 +0000 | [diff] [blame] | 2039 | raw_ostream &OS = outs(); |
Chris Bieneman | ef43d44 | 2016-03-15 18:07:46 +0000 | [diff] [blame] | 2040 | #ifdef PACKAGE_VENDOR |
| 2041 | OS << PACKAGE_VENDOR << " "; |
| 2042 | #else |
| 2043 | OS << "LLVM (http://llvm.org/):\n "; |
| 2044 | #endif |
| 2045 | OS << PACKAGE_NAME << " version " << PACKAGE_VERSION; |
Chris Lattner | 8ac22e7 | 2006-07-06 18:33:03 +0000 | [diff] [blame] | 2046 | #ifdef LLVM_VERSION_INFO |
Justin Bogner | 581b592 | 2014-06-17 06:52:41 +0000 | [diff] [blame] | 2047 | OS << " " << LLVM_VERSION_INFO; |
Reid Spencer | b317167 | 2006-06-05 16:22:56 +0000 | [diff] [blame] | 2048 | #endif |
Chris Lattner | 131dca9 | 2009-09-20 06:18:38 +0000 | [diff] [blame] | 2049 | OS << "\n "; |
Chris Lattner | 8ac22e7 | 2006-07-06 18:33:03 +0000 | [diff] [blame] | 2050 | #ifndef __OPTIMIZE__ |
Chris Lattner | 131dca9 | 2009-09-20 06:18:38 +0000 | [diff] [blame] | 2051 | OS << "DEBUG build"; |
Chris Lattner | 8ac22e7 | 2006-07-06 18:33:03 +0000 | [diff] [blame] | 2052 | #else |
Chris Lattner | 131dca9 | 2009-09-20 06:18:38 +0000 | [diff] [blame] | 2053 | OS << "Optimized build"; |
Chris Lattner | 8ac22e7 | 2006-07-06 18:33:03 +0000 | [diff] [blame] | 2054 | #endif |
| 2055 | #ifndef NDEBUG |
Chris Lattner | 131dca9 | 2009-09-20 06:18:38 +0000 | [diff] [blame] | 2056 | OS << " with assertions"; |
Chris Lattner | 8ac22e7 | 2006-07-06 18:33:03 +0000 | [diff] [blame] | 2057 | #endif |
Xin Tong | 59cb778 | 2017-04-19 00:03:36 +0000 | [diff] [blame] | 2058 | #if LLVM_VERSION_PRINTER_SHOW_HOST_TARGET_INFO |
Daniel Dunbar | d90a9a0 | 2009-11-14 21:36:07 +0000 | [diff] [blame] | 2059 | std::string CPU = sys::getHostCPUName(); |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 2060 | if (CPU == "generic") |
| 2061 | CPU = "(unknown)"; |
Chris Lattner | 131dca9 | 2009-09-20 06:18:38 +0000 | [diff] [blame] | 2062 | OS << ".\n" |
Sebastian Pop | 94441fb | 2011-11-01 21:32:20 +0000 | [diff] [blame] | 2063 | << " Default target: " << sys::getDefaultTargetTriple() << '\n' |
Xin Tong | 59cb778 | 2017-04-19 00:03:36 +0000 | [diff] [blame] | 2064 | << " Host CPU: " << CPU; |
| 2065 | #endif |
| 2066 | OS << '\n'; |
Devang Patel | 9eb2caae | 2007-02-01 01:43:37 +0000 | [diff] [blame] | 2067 | } |
| 2068 | void operator=(bool OptionWasSpecified) { |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 2069 | if (!OptionWasSpecified) |
| 2070 | return; |
Mikhail Glushenkov | 1d9f1fe | 2009-11-19 17:29:36 +0000 | [diff] [blame] | 2071 | |
Craig Topper | c10719f | 2014-04-07 04:17:22 +0000 | [diff] [blame] | 2072 | if (OverrideVersionPrinter != nullptr) { |
Dimitry Andric | bc3feaa | 2017-06-06 21:54:04 +0000 | [diff] [blame] | 2073 | OverrideVersionPrinter(outs()); |
Justin Bogner | 02b9584 | 2014-02-28 19:08:01 +0000 | [diff] [blame] | 2074 | exit(0); |
Reid Spencer | b317167 | 2006-06-05 16:22:56 +0000 | [diff] [blame] | 2075 | } |
Chandler Carruth | ea7e552 | 2011-07-22 07:50:40 +0000 | [diff] [blame] | 2076 | print(); |
| 2077 | |
| 2078 | // Iterate over any registered extra printers and call them to add further |
| 2079 | // information. |
Craig Topper | c10719f | 2014-04-07 04:17:22 +0000 | [diff] [blame] | 2080 | if (ExtraVersionPrinters != nullptr) { |
Chandler Carruth | 2d71c42 | 2011-07-22 07:50:48 +0000 | [diff] [blame] | 2081 | outs() << '\n'; |
Dimitry Andric | bc3feaa | 2017-06-06 21:54:04 +0000 | [diff] [blame] | 2082 | for (auto I : *ExtraVersionPrinters) |
| 2083 | I(outs()); |
Chandler Carruth | ea7e552 | 2011-07-22 07:50:40 +0000 | [diff] [blame] | 2084 | } |
| 2085 | |
Justin Bogner | 02b9584 | 2014-02-28 19:08:01 +0000 | [diff] [blame] | 2086 | exit(0); |
Reid Spencer | b317167 | 2006-06-05 16:22:56 +0000 | [diff] [blame] | 2087 | } |
| 2088 | }; |
Chris Lattner | adb19d6 | 2006-10-12 22:09:17 +0000 | [diff] [blame] | 2089 | } // End anonymous namespace |
Reid Spencer | b317167 | 2006-06-05 16:22:56 +0000 | [diff] [blame] | 2090 | |
Reid Spencer | ff6cc12 | 2004-08-04 00:36:06 +0000 | [diff] [blame] | 2091 | // Define the --version option that prints out the LLVM version for the tool |
Chris Lattner | adb19d6 | 2006-10-12 22:09:17 +0000 | [diff] [blame] | 2092 | static VersionPrinter VersionPrinterInstance; |
| 2093 | |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 2094 | static cl::opt<VersionPrinter, true, parser<bool>> |
| 2095 | VersOp("version", cl::desc("Display the version of this program"), |
Chris Bieneman | 831fc5e | 2015-01-26 16:56:00 +0000 | [diff] [blame] | 2096 | cl::location(VersionPrinterInstance), cl::ValueDisallowed, |
| 2097 | cl::cat(GenericCategory)); |
Reid Spencer | ff6cc12 | 2004-08-04 00:36:06 +0000 | [diff] [blame] | 2098 | |
Reid Spencer | 5e55470 | 2004-11-16 06:11:52 +0000 | [diff] [blame] | 2099 | // Utility function for printing the help message. |
Andrew Trick | 0537a98 | 2013-05-06 21:56:23 +0000 | [diff] [blame] | 2100 | void cl::PrintHelpMessage(bool Hidden, bool Categorized) { |
| 2101 | // This looks weird, but it actually prints the help message. The Printers are |
| 2102 | // types of HelpPrinter and the help gets printed when its operator= is |
| 2103 | // invoked. That's because the "normal" usages of the help printer is to be |
| 2104 | // assigned true/false depending on whether -help or -help-hidden was given or |
| 2105 | // not. Since we're circumventing that we have to make it look like -help or |
| 2106 | // -help-hidden were given, so we assign true. |
| 2107 | |
| 2108 | if (!Hidden && !Categorized) |
| 2109 | UncategorizedNormalPrinter = true; |
| 2110 | else if (!Hidden && Categorized) |
| 2111 | CategorizedNormalPrinter = true; |
| 2112 | else if (Hidden && !Categorized) |
| 2113 | UncategorizedHiddenPrinter = true; |
| 2114 | else |
| 2115 | CategorizedHiddenPrinter = true; |
Reid Spencer | 5e55470 | 2004-11-16 06:11:52 +0000 | [diff] [blame] | 2116 | } |
Reid Spencer | b317167 | 2006-06-05 16:22:56 +0000 | [diff] [blame] | 2117 | |
Devang Patel | 9eb2caae | 2007-02-01 01:43:37 +0000 | [diff] [blame] | 2118 | /// Utility function for printing version number. |
Chris Bieneman | 5d23224 | 2015-01-13 19:14:20 +0000 | [diff] [blame] | 2119 | void cl::PrintVersionMessage() { VersionPrinterInstance.print(); } |
Devang Patel | 9eb2caae | 2007-02-01 01:43:37 +0000 | [diff] [blame] | 2120 | |
Dimitry Andric | bc3feaa | 2017-06-06 21:54:04 +0000 | [diff] [blame] | 2121 | void cl::SetVersionPrinter(VersionPrinterTy func) { OverrideVersionPrinter = func; } |
Chandler Carruth | ea7e552 | 2011-07-22 07:50:40 +0000 | [diff] [blame] | 2122 | |
Dimitry Andric | bc3feaa | 2017-06-06 21:54:04 +0000 | [diff] [blame] | 2123 | void cl::AddExtraVersionPrinter(VersionPrinterTy func) { |
Craig Topper | 8d399f8 | 2014-04-09 04:20:00 +0000 | [diff] [blame] | 2124 | if (!ExtraVersionPrinters) |
Dimitry Andric | bc3feaa | 2017-06-06 21:54:04 +0000 | [diff] [blame] | 2125 | ExtraVersionPrinters = new std::vector<VersionPrinterTy>; |
Chandler Carruth | ea7e552 | 2011-07-22 07:50:40 +0000 | [diff] [blame] | 2126 | |
| 2127 | ExtraVersionPrinters->push_back(func); |
| 2128 | } |
Andrew Trick | 7cb710d | 2013-05-06 21:56:35 +0000 | [diff] [blame] | 2129 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 2130 | StringMap<Option *> &cl::getRegisteredOptions(SubCommand &Sub) { |
| 2131 | auto &Subs = GlobalParser->RegisteredSubCommands; |
| 2132 | (void)Subs; |
David Majnemer | 0d955d0 | 2016-08-11 22:21:41 +0000 | [diff] [blame] | 2133 | assert(is_contained(Subs, &Sub)); |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 2134 | return Sub.OptionsMap; |
Andrew Trick | 7cb710d | 2013-05-06 21:56:35 +0000 | [diff] [blame] | 2135 | } |
Peter Collingbourne | e186319 | 2014-10-16 22:47:52 +0000 | [diff] [blame] | 2136 | |
Dean Michael Berris | 27358cf | 2016-10-05 05:20:08 +0000 | [diff] [blame] | 2137 | iterator_range<typename SmallPtrSet<SubCommand *, 4>::iterator> |
| 2138 | cl::getRegisteredSubcommands() { |
| 2139 | return GlobalParser->getRegisteredSubcommands(); |
| 2140 | } |
| 2141 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 2142 | void cl::HideUnrelatedOptions(cl::OptionCategory &Category, SubCommand &Sub) { |
| 2143 | for (auto &I : Sub.OptionsMap) { |
Chris Bieneman | 831fc5e | 2015-01-26 16:56:00 +0000 | [diff] [blame] | 2144 | if (I.second->Category != &Category && |
| 2145 | I.second->Category != &GenericCategory) |
Chris Bieneman | 9e13af7 | 2015-01-21 22:45:52 +0000 | [diff] [blame] | 2146 | I.second->setHiddenFlag(cl::ReallyHidden); |
| 2147 | } |
| 2148 | } |
| 2149 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 2150 | void cl::HideUnrelatedOptions(ArrayRef<const cl::OptionCategory *> Categories, |
| 2151 | SubCommand &Sub) { |
Chris Bieneman | 0104325 | 2015-01-26 21:57:29 +0000 | [diff] [blame] | 2152 | auto CategoriesBegin = Categories.begin(); |
| 2153 | auto CategoriesEnd = Categories.end(); |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 2154 | for (auto &I : Sub.OptionsMap) { |
Chris Bieneman | 0104325 | 2015-01-26 21:57:29 +0000 | [diff] [blame] | 2155 | if (std::find(CategoriesBegin, CategoriesEnd, I.second->Category) == |
| 2156 | CategoriesEnd && |
| 2157 | I.second->Category != &GenericCategory) |
| 2158 | I.second->setHiddenFlag(cl::ReallyHidden); |
| 2159 | } |
| 2160 | } |
| 2161 | |
Zachary Turner | 07670b3 | 2016-06-29 21:48:26 +0000 | [diff] [blame] | 2162 | void cl::ResetCommandLineParser() { GlobalParser->reset(); } |
| 2163 | void cl::ResetAllOptionOccurrences() { |
| 2164 | GlobalParser->ResetAllOptionOccurrences(); |
| 2165 | } |
| 2166 | |
Peter Collingbourne | e186319 | 2014-10-16 22:47:52 +0000 | [diff] [blame] | 2167 | void LLVMParseCommandLineOptions(int argc, const char *const *argv, |
| 2168 | const char *Overview) { |
Eric Liu | e51ee06 | 2017-03-15 08:41:00 +0000 | [diff] [blame] | 2169 | llvm::cl::ParseCommandLineOptions(argc, argv, StringRef(Overview), |
| 2170 | &llvm::nulls()); |
Peter Collingbourne | e186319 | 2014-10-16 22:47:52 +0000 | [diff] [blame] | 2171 | } |