Add a function for profiling to run at shutdown. Unlike the existing API, this
[llvm/stm8.git] / lib / Support / CommandLine.cpp
bloba1f2fce8bf1348c9dccca9aaa20f1177eda069c9
1 //===-- CommandLine.cpp - Command line parser implementation --------------===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // 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.
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
17 //===----------------------------------------------------------------------===//
19 #include "llvm/Support/CommandLine.h"
20 #include "llvm/Support/Debug.h"
21 #include "llvm/Support/ErrorHandling.h"
22 #include "llvm/Support/MemoryBuffer.h"
23 #include "llvm/Support/ManagedStatic.h"
24 #include "llvm/Support/raw_ostream.h"
25 #include "llvm/Support/system_error.h"
26 #include "llvm/Target/TargetRegistry.h"
27 #include "llvm/Support/Host.h"
28 #include "llvm/Support/Path.h"
29 #include "llvm/ADT/OwningPtr.h"
30 #include "llvm/ADT/SmallPtrSet.h"
31 #include "llvm/ADT/SmallString.h"
32 #include "llvm/ADT/StringMap.h"
33 #include "llvm/ADT/Twine.h"
34 #include "llvm/Config/config.h"
35 #include <cerrno>
36 #include <cstdlib>
37 using namespace llvm;
38 using namespace cl;
40 //===----------------------------------------------------------------------===//
41 // Template instantiations and anchors.
43 namespace llvm { namespace cl {
44 TEMPLATE_INSTANTIATION(class basic_parser<bool>);
45 TEMPLATE_INSTANTIATION(class basic_parser<boolOrDefault>);
46 TEMPLATE_INSTANTIATION(class basic_parser<int>);
47 TEMPLATE_INSTANTIATION(class basic_parser<unsigned>);
48 TEMPLATE_INSTANTIATION(class basic_parser<double>);
49 TEMPLATE_INSTANTIATION(class basic_parser<float>);
50 TEMPLATE_INSTANTIATION(class basic_parser<std::string>);
51 TEMPLATE_INSTANTIATION(class basic_parser<char>);
53 TEMPLATE_INSTANTIATION(class opt<unsigned>);
54 TEMPLATE_INSTANTIATION(class opt<int>);
55 TEMPLATE_INSTANTIATION(class opt<std::string>);
56 TEMPLATE_INSTANTIATION(class opt<char>);
57 TEMPLATE_INSTANTIATION(class opt<bool>);
58 } } // end namespace llvm::cl
60 void Option::anchor() {}
61 void basic_parser_impl::anchor() {}
62 void parser<bool>::anchor() {}
63 void parser<boolOrDefault>::anchor() {}
64 void parser<int>::anchor() {}
65 void parser<unsigned>::anchor() {}
66 void parser<double>::anchor() {}
67 void parser<float>::anchor() {}
68 void parser<std::string>::anchor() {}
69 void parser<char>::anchor() {}
71 //===----------------------------------------------------------------------===//
73 // Globals for name and overview of program. Program name is not a string to
74 // avoid static ctor/dtor issues.
75 static char ProgramName[80] = "<premain>";
76 static const char *ProgramOverview = 0;
78 // This collects additional help to be printed.
79 static ManagedStatic<std::vector<const char*> > MoreHelp;
81 extrahelp::extrahelp(const char *Help)
82 : morehelp(Help) {
83 MoreHelp->push_back(Help);
86 static bool OptionListChanged = false;
88 // MarkOptionsChanged - Internal helper function.
89 void cl::MarkOptionsChanged() {
90 OptionListChanged = true;
93 /// RegisteredOptionList - This is the list of the command line options that
94 /// have statically constructed themselves.
95 static Option *RegisteredOptionList = 0;
97 void Option::addArgument() {
98 assert(NextRegistered == 0 && "argument multiply registered!");
100 NextRegistered = RegisteredOptionList;
101 RegisteredOptionList = this;
102 MarkOptionsChanged();
106 //===----------------------------------------------------------------------===//
107 // Basic, shared command line option processing machinery.
110 /// GetOptionInfo - Scan the list of registered options, turning them into data
111 /// structures that are easier to handle.
112 static void GetOptionInfo(SmallVectorImpl<Option*> &PositionalOpts,
113 SmallVectorImpl<Option*> &SinkOpts,
114 StringMap<Option*> &OptionsMap) {
115 SmallVector<const char*, 16> OptionNames;
116 Option *CAOpt = 0; // The ConsumeAfter option if it exists.
117 for (Option *O = RegisteredOptionList; O; O = O->getNextRegisteredOption()) {
118 // If this option wants to handle multiple option names, get the full set.
119 // This handles enum options like "-O1 -O2" etc.
120 O->getExtraOptionNames(OptionNames);
121 if (O->ArgStr[0])
122 OptionNames.push_back(O->ArgStr);
124 // Handle named options.
125 for (size_t i = 0, e = OptionNames.size(); i != e; ++i) {
126 // Add argument to the argument map!
127 if (OptionsMap.GetOrCreateValue(OptionNames[i], O).second != O) {
128 errs() << ProgramName << ": CommandLine Error: Argument '"
129 << OptionNames[i] << "' defined more than once!\n";
133 OptionNames.clear();
135 // Remember information about positional options.
136 if (O->getFormattingFlag() == cl::Positional)
137 PositionalOpts.push_back(O);
138 else if (O->getMiscFlags() & cl::Sink) // Remember sink options
139 SinkOpts.push_back(O);
140 else if (O->getNumOccurrencesFlag() == cl::ConsumeAfter) {
141 if (CAOpt)
142 O->error("Cannot specify more than one option with cl::ConsumeAfter!");
143 CAOpt = O;
147 if (CAOpt)
148 PositionalOpts.push_back(CAOpt);
150 // Make sure that they are in order of registration not backwards.
151 std::reverse(PositionalOpts.begin(), PositionalOpts.end());
155 /// LookupOption - Lookup the option specified by the specified option on the
156 /// command line. If there is a value specified (after an equal sign) return
157 /// that as well. This assumes that leading dashes have already been stripped.
158 static Option *LookupOption(StringRef &Arg, StringRef &Value,
159 const StringMap<Option*> &OptionsMap) {
160 // Reject all dashes.
161 if (Arg.empty()) return 0;
163 size_t EqualPos = Arg.find('=');
165 // If we have an equals sign, remember the value.
166 if (EqualPos == StringRef::npos) {
167 // Look up the option.
168 StringMap<Option*>::const_iterator I = OptionsMap.find(Arg);
169 return I != OptionsMap.end() ? I->second : 0;
172 // If the argument before the = is a valid option name, we match. If not,
173 // return Arg unmolested.
174 StringMap<Option*>::const_iterator I =
175 OptionsMap.find(Arg.substr(0, EqualPos));
176 if (I == OptionsMap.end()) return 0;
178 Value = Arg.substr(EqualPos+1);
179 Arg = Arg.substr(0, EqualPos);
180 return I->second;
183 /// LookupNearestOption - Lookup the closest match to the option specified by
184 /// the specified option on the command line. If there is a value specified
185 /// (after an equal sign) return that as well. This assumes that leading dashes
186 /// have already been stripped.
187 static Option *LookupNearestOption(StringRef Arg,
188 const StringMap<Option*> &OptionsMap,
189 const char *&NearestString) {
190 // Reject all dashes.
191 if (Arg.empty()) return 0;
193 // Split on any equal sign.
194 StringRef LHS = Arg.split('=').first;
196 // Find the closest match.
197 Option *Best = 0;
198 unsigned BestDistance = 0;
199 for (StringMap<Option*>::const_iterator it = OptionsMap.begin(),
200 ie = OptionsMap.end(); it != ie; ++it) {
201 Option *O = it->second;
202 SmallVector<const char*, 16> OptionNames;
203 O->getExtraOptionNames(OptionNames);
204 if (O->ArgStr[0])
205 OptionNames.push_back(O->ArgStr);
207 for (size_t i = 0, e = OptionNames.size(); i != e; ++i) {
208 StringRef Name = OptionNames[i];
209 unsigned Distance = StringRef(Name).edit_distance(
210 Arg, /*AllowReplacements=*/true, /*MaxEditDistance=*/BestDistance);
211 if (!Best || Distance < BestDistance) {
212 Best = O;
213 NearestString = OptionNames[i];
214 BestDistance = Distance;
219 return Best;
222 /// CommaSeparateAndAddOccurence - A wrapper around Handler->addOccurence() that
223 /// does special handling of cl::CommaSeparated options.
224 static bool CommaSeparateAndAddOccurence(Option *Handler, unsigned pos,
225 StringRef ArgName,
226 StringRef Value, bool MultiArg = false)
228 // Check to see if this option accepts a comma separated list of values. If
229 // it does, we have to split up the value into multiple values.
230 if (Handler->getMiscFlags() & CommaSeparated) {
231 StringRef Val(Value);
232 StringRef::size_type Pos = Val.find(',');
234 while (Pos != StringRef::npos) {
235 // Process the portion before the comma.
236 if (Handler->addOccurrence(pos, ArgName, Val.substr(0, Pos), MultiArg))
237 return true;
238 // Erase the portion before the comma, AND the comma.
239 Val = Val.substr(Pos+1);
240 Value.substr(Pos+1); // Increment the original value pointer as well.
241 // Check for another comma.
242 Pos = Val.find(',');
245 Value = Val;
248 if (Handler->addOccurrence(pos, ArgName, Value, MultiArg))
249 return true;
251 return false;
254 /// ProvideOption - For Value, this differentiates between an empty value ("")
255 /// and a null value (StringRef()). The later is accepted for arguments that
256 /// don't allow a value (-foo) the former is rejected (-foo=).
257 static inline bool ProvideOption(Option *Handler, StringRef ArgName,
258 StringRef Value, int argc, char **argv,
259 int &i) {
260 // Is this a multi-argument option?
261 unsigned NumAdditionalVals = Handler->getNumAdditionalVals();
263 // Enforce value requirements
264 switch (Handler->getValueExpectedFlag()) {
265 case ValueRequired:
266 if (Value.data() == 0) { // No value specified?
267 if (i+1 >= argc)
268 return Handler->error("requires a value!");
269 // Steal the next argument, like for '-o filename'
270 Value = argv[++i];
272 break;
273 case ValueDisallowed:
274 if (NumAdditionalVals > 0)
275 return Handler->error("multi-valued option specified"
276 " with ValueDisallowed modifier!");
278 if (Value.data())
279 return Handler->error("does not allow a value! '" +
280 Twine(Value) + "' specified.");
281 break;
282 case ValueOptional:
283 break;
285 default:
286 errs() << ProgramName
287 << ": Bad ValueMask flag! CommandLine usage error:"
288 << Handler->getValueExpectedFlag() << "\n";
289 llvm_unreachable(0);
292 // If this isn't a multi-arg option, just run the handler.
293 if (NumAdditionalVals == 0)
294 return CommaSeparateAndAddOccurence(Handler, i, ArgName, Value);
296 // If it is, run the handle several times.
297 bool MultiArg = false;
299 if (Value.data()) {
300 if (CommaSeparateAndAddOccurence(Handler, i, ArgName, Value, MultiArg))
301 return true;
302 --NumAdditionalVals;
303 MultiArg = true;
306 while (NumAdditionalVals > 0) {
307 if (i+1 >= argc)
308 return Handler->error("not enough values!");
309 Value = argv[++i];
311 if (CommaSeparateAndAddOccurence(Handler, i, ArgName, Value, MultiArg))
312 return true;
313 MultiArg = true;
314 --NumAdditionalVals;
316 return false;
319 static bool ProvidePositionalOption(Option *Handler, StringRef Arg, int i) {
320 int Dummy = i;
321 return ProvideOption(Handler, Handler->ArgStr, Arg, 0, 0, Dummy);
325 // Option predicates...
326 static inline bool isGrouping(const Option *O) {
327 return O->getFormattingFlag() == cl::Grouping;
329 static inline bool isPrefixedOrGrouping(const Option *O) {
330 return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
333 // getOptionPred - Check to see if there are any options that satisfy the
334 // specified predicate with names that are the prefixes in Name. This is
335 // checked by progressively stripping characters off of the name, checking to
336 // see if there options that satisfy the predicate. If we find one, return it,
337 // otherwise return null.
339 static Option *getOptionPred(StringRef Name, size_t &Length,
340 bool (*Pred)(const Option*),
341 const StringMap<Option*> &OptionsMap) {
343 StringMap<Option*>::const_iterator OMI = OptionsMap.find(Name);
345 // Loop while we haven't found an option and Name still has at least two
346 // characters in it (so that the next iteration will not be the empty
347 // string.
348 while (OMI == OptionsMap.end() && Name.size() > 1) {
349 Name = Name.substr(0, Name.size()-1); // Chop off the last character.
350 OMI = OptionsMap.find(Name);
353 if (OMI != OptionsMap.end() && Pred(OMI->second)) {
354 Length = Name.size();
355 return OMI->second; // Found one!
357 return 0; // No option found!
360 /// HandlePrefixedOrGroupedOption - The specified argument string (which started
361 /// with at least one '-') does not fully match an available option. Check to
362 /// see if this is a prefix or grouped option. If so, split arg into output an
363 /// Arg/Value pair and return the Option to parse it with.
364 static Option *HandlePrefixedOrGroupedOption(StringRef &Arg, StringRef &Value,
365 bool &ErrorParsing,
366 const StringMap<Option*> &OptionsMap) {
367 if (Arg.size() == 1) return 0;
369 // Do the lookup!
370 size_t Length = 0;
371 Option *PGOpt = getOptionPred(Arg, Length, isPrefixedOrGrouping, OptionsMap);
372 if (PGOpt == 0) return 0;
374 // If the option is a prefixed option, then the value is simply the
375 // rest of the name... so fall through to later processing, by
376 // setting up the argument name flags and value fields.
377 if (PGOpt->getFormattingFlag() == cl::Prefix) {
378 Value = Arg.substr(Length);
379 Arg = Arg.substr(0, Length);
380 assert(OptionsMap.count(Arg) && OptionsMap.find(Arg)->second == PGOpt);
381 return PGOpt;
384 // This must be a grouped option... handle them now. Grouping options can't
385 // have values.
386 assert(isGrouping(PGOpt) && "Broken getOptionPred!");
388 do {
389 // Move current arg name out of Arg into OneArgName.
390 StringRef OneArgName = Arg.substr(0, Length);
391 Arg = Arg.substr(Length);
393 // Because ValueRequired is an invalid flag for grouped arguments,
394 // we don't need to pass argc/argv in.
395 assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
396 "Option can not be cl::Grouping AND cl::ValueRequired!");
397 int Dummy = 0;
398 ErrorParsing |= ProvideOption(PGOpt, OneArgName,
399 StringRef(), 0, 0, Dummy);
401 // Get the next grouping option.
402 PGOpt = getOptionPred(Arg, Length, isGrouping, OptionsMap);
403 } while (PGOpt && Length != Arg.size());
405 // Return the last option with Arg cut down to just the last one.
406 return PGOpt;
411 static bool RequiresValue(const Option *O) {
412 return O->getNumOccurrencesFlag() == cl::Required ||
413 O->getNumOccurrencesFlag() == cl::OneOrMore;
416 static bool EatsUnboundedNumberOfValues(const Option *O) {
417 return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
418 O->getNumOccurrencesFlag() == cl::OneOrMore;
421 /// ParseCStringVector - Break INPUT up wherever one or more
422 /// whitespace characters are found, and store the resulting tokens in
423 /// OUTPUT. The tokens stored in OUTPUT are dynamically allocated
424 /// using strdup(), so it is the caller's responsibility to free()
425 /// them later.
427 static void ParseCStringVector(std::vector<char *> &OutputVector,
428 const char *Input) {
429 // Characters which will be treated as token separators:
430 StringRef Delims = " \v\f\t\r\n";
432 StringRef WorkStr(Input);
433 while (!WorkStr.empty()) {
434 // If the first character is a delimiter, strip them off.
435 if (Delims.find(WorkStr[0]) != StringRef::npos) {
436 size_t Pos = WorkStr.find_first_not_of(Delims);
437 if (Pos == StringRef::npos) Pos = WorkStr.size();
438 WorkStr = WorkStr.substr(Pos);
439 continue;
442 // Find position of first delimiter.
443 size_t Pos = WorkStr.find_first_of(Delims);
444 if (Pos == StringRef::npos) Pos = WorkStr.size();
446 // Everything from 0 to Pos is the next word to copy.
447 char *NewStr = (char*)malloc(Pos+1);
448 memcpy(NewStr, WorkStr.data(), Pos);
449 NewStr[Pos] = 0;
450 OutputVector.push_back(NewStr);
452 WorkStr = WorkStr.substr(Pos);
456 /// ParseEnvironmentOptions - An alternative entry point to the
457 /// CommandLine library, which allows you to read the program's name
458 /// from the caller (as PROGNAME) and its command-line arguments from
459 /// an environment variable (whose name is given in ENVVAR).
461 void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
462 const char *Overview, bool ReadResponseFiles) {
463 // Check args.
464 assert(progName && "Program name not specified");
465 assert(envVar && "Environment variable name missing");
467 // Get the environment variable they want us to parse options out of.
468 const char *envValue = getenv(envVar);
469 if (!envValue)
470 return;
472 // Get program's "name", which we wouldn't know without the caller
473 // telling us.
474 std::vector<char*> newArgv;
475 newArgv.push_back(strdup(progName));
477 // Parse the value of the environment variable into a "command line"
478 // and hand it off to ParseCommandLineOptions().
479 ParseCStringVector(newArgv, envValue);
480 int newArgc = static_cast<int>(newArgv.size());
481 ParseCommandLineOptions(newArgc, &newArgv[0], Overview, ReadResponseFiles);
483 // Free all the strdup()ed strings.
484 for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
485 i != e; ++i)
486 free(*i);
490 /// ExpandResponseFiles - Copy the contents of argv into newArgv,
491 /// substituting the contents of the response files for the arguments
492 /// of type @file.
493 static void ExpandResponseFiles(unsigned argc, char** argv,
494 std::vector<char*>& newArgv) {
495 for (unsigned i = 1; i != argc; ++i) {
496 char *arg = argv[i];
498 if (arg[0] == '@') {
499 sys::PathWithStatus respFile(++arg);
501 // Check that the response file is not empty (mmap'ing empty
502 // files can be problematic).
503 const sys::FileStatus *FileStat = respFile.getFileStatus();
504 if (FileStat && FileStat->getSize() != 0) {
506 // If we could open the file, parse its contents, otherwise
507 // pass the @file option verbatim.
509 // TODO: we should also support recursive loading of response files,
510 // since this is how gcc behaves. (From their man page: "The file may
511 // itself contain additional @file options; any such options will be
512 // processed recursively.")
514 // Mmap the response file into memory.
515 OwningPtr<MemoryBuffer> respFilePtr;
516 if (!MemoryBuffer::getFile(respFile.c_str(), respFilePtr)) {
517 ParseCStringVector(newArgv, respFilePtr->getBufferStart());
518 continue;
522 newArgv.push_back(strdup(arg));
526 void cl::ParseCommandLineOptions(int argc, char **argv,
527 const char *Overview, bool ReadResponseFiles) {
528 // Process all registered options.
529 SmallVector<Option*, 4> PositionalOpts;
530 SmallVector<Option*, 4> SinkOpts;
531 StringMap<Option*> Opts;
532 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
534 assert((!Opts.empty() || !PositionalOpts.empty()) &&
535 "No options specified!");
537 // Expand response files.
538 std::vector<char*> newArgv;
539 if (ReadResponseFiles) {
540 newArgv.push_back(strdup(argv[0]));
541 ExpandResponseFiles(argc, argv, newArgv);
542 argv = &newArgv[0];
543 argc = static_cast<int>(newArgv.size());
546 // Copy the program name into ProgName, making sure not to overflow it.
547 std::string ProgName = sys::path::filename(argv[0]);
548 size_t Len = std::min(ProgName.size(), size_t(79));
549 memcpy(ProgramName, ProgName.data(), Len);
550 ProgramName[Len] = '\0';
552 ProgramOverview = Overview;
553 bool ErrorParsing = false;
555 // Check out the positional arguments to collect information about them.
556 unsigned NumPositionalRequired = 0;
558 // Determine whether or not there are an unlimited number of positionals
559 bool HasUnlimitedPositionals = false;
561 Option *ConsumeAfterOpt = 0;
562 if (!PositionalOpts.empty()) {
563 if (PositionalOpts[0]->getNumOccurrencesFlag() == cl::ConsumeAfter) {
564 assert(PositionalOpts.size() > 1 &&
565 "Cannot specify cl::ConsumeAfter without a positional argument!");
566 ConsumeAfterOpt = PositionalOpts[0];
569 // Calculate how many positional values are _required_.
570 bool UnboundedFound = false;
571 for (size_t i = ConsumeAfterOpt != 0, e = PositionalOpts.size();
572 i != e; ++i) {
573 Option *Opt = PositionalOpts[i];
574 if (RequiresValue(Opt))
575 ++NumPositionalRequired;
576 else if (ConsumeAfterOpt) {
577 // ConsumeAfter cannot be combined with "optional" positional options
578 // unless there is only one positional argument...
579 if (PositionalOpts.size() > 2)
580 ErrorParsing |=
581 Opt->error("error - this positional option will never be matched, "
582 "because it does not Require a value, and a "
583 "cl::ConsumeAfter option is active!");
584 } else if (UnboundedFound && !Opt->ArgStr[0]) {
585 // This option does not "require" a value... Make sure this option is
586 // not specified after an option that eats all extra arguments, or this
587 // one will never get any!
589 ErrorParsing |= Opt->error("error - option can never match, because "
590 "another positional argument will match an "
591 "unbounded number of values, and this option"
592 " does not require a value!");
594 UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
596 HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
599 // PositionalVals - A vector of "positional" arguments we accumulate into
600 // the process at the end.
602 SmallVector<std::pair<StringRef,unsigned>, 4> PositionalVals;
604 // If the program has named positional arguments, and the name has been run
605 // across, keep track of which positional argument was named. Otherwise put
606 // the positional args into the PositionalVals list...
607 Option *ActivePositionalArg = 0;
609 // Loop over all of the arguments... processing them.
610 bool DashDashFound = false; // Have we read '--'?
611 for (int i = 1; i < argc; ++i) {
612 Option *Handler = 0;
613 Option *NearestHandler = 0;
614 const char *NearestHandlerString = 0;
615 StringRef Value;
616 StringRef ArgName = "";
618 // If the option list changed, this means that some command line
619 // option has just been registered or deregistered. This can occur in
620 // response to things like -load, etc. If this happens, rescan the options.
621 if (OptionListChanged) {
622 PositionalOpts.clear();
623 SinkOpts.clear();
624 Opts.clear();
625 GetOptionInfo(PositionalOpts, SinkOpts, Opts);
626 OptionListChanged = false;
629 // Check to see if this is a positional argument. This argument is
630 // considered to be positional if it doesn't start with '-', if it is "-"
631 // itself, or if we have seen "--" already.
633 if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
634 // Positional argument!
635 if (ActivePositionalArg) {
636 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
637 continue; // We are done!
640 if (!PositionalOpts.empty()) {
641 PositionalVals.push_back(std::make_pair(argv[i],i));
643 // All of the positional arguments have been fulfulled, give the rest to
644 // the consume after option... if it's specified...
646 if (PositionalVals.size() >= NumPositionalRequired &&
647 ConsumeAfterOpt != 0) {
648 for (++i; i < argc; ++i)
649 PositionalVals.push_back(std::make_pair(argv[i],i));
650 break; // Handle outside of the argument processing loop...
653 // Delay processing positional arguments until the end...
654 continue;
656 } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
657 !DashDashFound) {
658 DashDashFound = true; // This is the mythical "--"?
659 continue; // Don't try to process it as an argument itself.
660 } else if (ActivePositionalArg &&
661 (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
662 // If there is a positional argument eating options, check to see if this
663 // option is another positional argument. If so, treat it as an argument,
664 // otherwise feed it to the eating positional.
665 ArgName = argv[i]+1;
666 // Eat leading dashes.
667 while (!ArgName.empty() && ArgName[0] == '-')
668 ArgName = ArgName.substr(1);
670 Handler = LookupOption(ArgName, Value, Opts);
671 if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
672 ProvidePositionalOption(ActivePositionalArg, argv[i], i);
673 continue; // We are done!
676 } else { // We start with a '-', must be an argument.
677 ArgName = argv[i]+1;
678 // Eat leading dashes.
679 while (!ArgName.empty() && ArgName[0] == '-')
680 ArgName = ArgName.substr(1);
682 Handler = LookupOption(ArgName, Value, Opts);
684 // Check to see if this "option" is really a prefixed or grouped argument.
685 if (Handler == 0)
686 Handler = HandlePrefixedOrGroupedOption(ArgName, Value,
687 ErrorParsing, Opts);
689 // Otherwise, look for the closest available option to report to the user
690 // in the upcoming error.
691 if (Handler == 0 && SinkOpts.empty())
692 NearestHandler = LookupNearestOption(ArgName, Opts,
693 NearestHandlerString);
696 if (Handler == 0) {
697 if (SinkOpts.empty()) {
698 errs() << ProgramName << ": Unknown command line argument '"
699 << argv[i] << "'. Try: '" << argv[0] << " -help'\n";
701 if (NearestHandler) {
702 // If we know a near match, report it as well.
703 errs() << ProgramName << ": Did you mean '-"
704 << NearestHandlerString << "'?\n";
707 ErrorParsing = true;
708 } else {
709 for (SmallVectorImpl<Option*>::iterator I = SinkOpts.begin(),
710 E = SinkOpts.end(); I != E ; ++I)
711 (*I)->addOccurrence(i, "", argv[i]);
713 continue;
716 // If this is a named positional argument, just remember that it is the
717 // active one...
718 if (Handler->getFormattingFlag() == cl::Positional)
719 ActivePositionalArg = Handler;
720 else
721 ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
724 // Check and handle positional arguments now...
725 if (NumPositionalRequired > PositionalVals.size()) {
726 errs() << ProgramName
727 << ": Not enough positional command line arguments specified!\n"
728 << "Must specify at least " << NumPositionalRequired
729 << " positional arguments: See: " << argv[0] << " -help\n";
731 ErrorParsing = true;
732 } else if (!HasUnlimitedPositionals &&
733 PositionalVals.size() > PositionalOpts.size()) {
734 errs() << ProgramName
735 << ": Too many positional arguments specified!\n"
736 << "Can specify at most " << PositionalOpts.size()
737 << " positional arguments: See: " << argv[0] << " -help\n";
738 ErrorParsing = true;
740 } else if (ConsumeAfterOpt == 0) {
741 // Positional args have already been handled if ConsumeAfter is specified.
742 unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
743 for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
744 if (RequiresValue(PositionalOpts[i])) {
745 ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
746 PositionalVals[ValNo].second);
747 ValNo++;
748 --NumPositionalRequired; // We fulfilled our duty...
751 // If we _can_ give this option more arguments, do so now, as long as we
752 // do not give it values that others need. 'Done' controls whether the
753 // option even _WANTS_ any more.
755 bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
756 while (NumVals-ValNo > NumPositionalRequired && !Done) {
757 switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
758 case cl::Optional:
759 Done = true; // Optional arguments want _at most_ one value
760 // FALL THROUGH
761 case cl::ZeroOrMore: // Zero or more will take all they can get...
762 case cl::OneOrMore: // One or more will take all they can get...
763 ProvidePositionalOption(PositionalOpts[i],
764 PositionalVals[ValNo].first,
765 PositionalVals[ValNo].second);
766 ValNo++;
767 break;
768 default:
769 llvm_unreachable("Internal error, unexpected NumOccurrences flag in "
770 "positional argument processing!");
774 } else {
775 assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
776 unsigned ValNo = 0;
777 for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
778 if (RequiresValue(PositionalOpts[j])) {
779 ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
780 PositionalVals[ValNo].first,
781 PositionalVals[ValNo].second);
782 ValNo++;
785 // Handle the case where there is just one positional option, and it's
786 // optional. In this case, we want to give JUST THE FIRST option to the
787 // positional option and keep the rest for the consume after. The above
788 // loop would have assigned no values to positional options in this case.
790 if (PositionalOpts.size() == 2 && ValNo == 0 && !PositionalVals.empty()) {
791 ErrorParsing |= ProvidePositionalOption(PositionalOpts[1],
792 PositionalVals[ValNo].first,
793 PositionalVals[ValNo].second);
794 ValNo++;
797 // Handle over all of the rest of the arguments to the
798 // cl::ConsumeAfter command line option...
799 for (; ValNo != PositionalVals.size(); ++ValNo)
800 ErrorParsing |= ProvidePositionalOption(ConsumeAfterOpt,
801 PositionalVals[ValNo].first,
802 PositionalVals[ValNo].second);
805 // Loop over args and make sure all required args are specified!
806 for (StringMap<Option*>::iterator I = Opts.begin(),
807 E = Opts.end(); I != E; ++I) {
808 switch (I->second->getNumOccurrencesFlag()) {
809 case Required:
810 case OneOrMore:
811 if (I->second->getNumOccurrences() == 0) {
812 I->second->error("must be specified at least once!");
813 ErrorParsing = true;
815 // Fall through
816 default:
817 break;
821 // Now that we know if -debug is specified, we can use it.
822 // Note that if ReadResponseFiles == true, this must be done before the
823 // memory allocated for the expanded command line is free()d below.
824 DEBUG(dbgs() << "Args: ";
825 for (int i = 0; i < argc; ++i)
826 dbgs() << argv[i] << ' ';
827 dbgs() << '\n';
830 // Free all of the memory allocated to the map. Command line options may only
831 // be processed once!
832 Opts.clear();
833 PositionalOpts.clear();
834 MoreHelp->clear();
836 // Free the memory allocated by ExpandResponseFiles.
837 if (ReadResponseFiles) {
838 // Free all the strdup()ed strings.
839 for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
840 i != e; ++i)
841 free(*i);
844 // If we had an error processing our arguments, don't let the program execute
845 if (ErrorParsing) exit(1);
848 //===----------------------------------------------------------------------===//
849 // Option Base class implementation
852 bool Option::error(const Twine &Message, StringRef ArgName) {
853 if (ArgName.data() == 0) ArgName = ArgStr;
854 if (ArgName.empty())
855 errs() << HelpStr; // Be nice for positional arguments
856 else
857 errs() << ProgramName << ": for the -" << ArgName;
859 errs() << " option: " << Message << "\n";
860 return true;
863 bool Option::addOccurrence(unsigned pos, StringRef ArgName,
864 StringRef Value, bool MultiArg) {
865 if (!MultiArg)
866 NumOccurrences++; // Increment the number of times we have been seen
868 switch (getNumOccurrencesFlag()) {
869 case Optional:
870 if (NumOccurrences > 1)
871 return error("may only occur zero or one times!", ArgName);
872 break;
873 case Required:
874 if (NumOccurrences > 1)
875 return error("must occur exactly one time!", ArgName);
876 // Fall through
877 case OneOrMore:
878 case ZeroOrMore:
879 case ConsumeAfter: break;
880 default: return error("bad num occurrences flag value!");
883 return handleOccurrence(pos, ArgName, Value);
887 // getValueStr - Get the value description string, using "DefaultMsg" if nothing
888 // has been specified yet.
890 static const char *getValueStr(const Option &O, const char *DefaultMsg) {
891 if (O.ValueStr[0] == 0) return DefaultMsg;
892 return O.ValueStr;
895 //===----------------------------------------------------------------------===//
896 // cl::alias class implementation
899 // Return the width of the option tag for printing...
900 size_t alias::getOptionWidth() const {
901 return std::strlen(ArgStr)+6;
904 // Print out the option for the alias.
905 void alias::printOptionInfo(size_t GlobalWidth) const {
906 size_t L = std::strlen(ArgStr);
907 errs() << " -" << ArgStr;
908 errs().indent(GlobalWidth-L-6) << " - " << HelpStr << "\n";
911 //===----------------------------------------------------------------------===//
912 // Parser Implementation code...
915 // basic_parser implementation
918 // Return the width of the option tag for printing...
919 size_t basic_parser_impl::getOptionWidth(const Option &O) const {
920 size_t Len = std::strlen(O.ArgStr);
921 if (const char *ValName = getValueName())
922 Len += std::strlen(getValueStr(O, ValName))+3;
924 return Len + 6;
927 // printOptionInfo - Print out information about this option. The
928 // to-be-maintained width is specified.
930 void basic_parser_impl::printOptionInfo(const Option &O,
931 size_t GlobalWidth) const {
932 outs() << " -" << O.ArgStr;
934 if (const char *ValName = getValueName())
935 outs() << "=<" << getValueStr(O, ValName) << '>';
937 outs().indent(GlobalWidth-getOptionWidth(O)) << " - " << O.HelpStr << '\n';
940 void basic_parser_impl::printOptionName(const Option &O,
941 size_t GlobalWidth) const {
942 outs() << " -" << O.ArgStr;
943 outs().indent(GlobalWidth-std::strlen(O.ArgStr));
947 // parser<bool> implementation
949 bool parser<bool>::parse(Option &O, StringRef ArgName,
950 StringRef Arg, bool &Value) {
951 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
952 Arg == "1") {
953 Value = true;
954 return false;
957 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
958 Value = false;
959 return false;
961 return O.error("'" + Arg +
962 "' is invalid value for boolean argument! Try 0 or 1");
965 // parser<boolOrDefault> implementation
967 bool parser<boolOrDefault>::parse(Option &O, StringRef ArgName,
968 StringRef Arg, boolOrDefault &Value) {
969 if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
970 Arg == "1") {
971 Value = BOU_TRUE;
972 return false;
974 if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
975 Value = BOU_FALSE;
976 return false;
979 return O.error("'" + Arg +
980 "' is invalid value for boolean argument! Try 0 or 1");
983 // parser<int> implementation
985 bool parser<int>::parse(Option &O, StringRef ArgName,
986 StringRef Arg, int &Value) {
987 if (Arg.getAsInteger(0, Value))
988 return O.error("'" + Arg + "' value invalid for integer argument!");
989 return false;
992 // parser<unsigned> implementation
994 bool parser<unsigned>::parse(Option &O, StringRef ArgName,
995 StringRef Arg, unsigned &Value) {
997 if (Arg.getAsInteger(0, Value))
998 return O.error("'" + Arg + "' value invalid for uint argument!");
999 return false;
1002 // parser<double>/parser<float> implementation
1004 static bool parseDouble(Option &O, StringRef Arg, double &Value) {
1005 SmallString<32> TmpStr(Arg.begin(), Arg.end());
1006 const char *ArgStart = TmpStr.c_str();
1007 char *End;
1008 Value = strtod(ArgStart, &End);
1009 if (*End != 0)
1010 return O.error("'" + Arg + "' value invalid for floating point argument!");
1011 return false;
1014 bool parser<double>::parse(Option &O, StringRef ArgName,
1015 StringRef Arg, double &Val) {
1016 return parseDouble(O, Arg, Val);
1019 bool parser<float>::parse(Option &O, StringRef ArgName,
1020 StringRef Arg, float &Val) {
1021 double dVal;
1022 if (parseDouble(O, Arg, dVal))
1023 return true;
1024 Val = (float)dVal;
1025 return false;
1030 // generic_parser_base implementation
1033 // findOption - Return the option number corresponding to the specified
1034 // argument string. If the option is not found, getNumOptions() is returned.
1036 unsigned generic_parser_base::findOption(const char *Name) {
1037 unsigned e = getNumOptions();
1039 for (unsigned i = 0; i != e; ++i) {
1040 if (strcmp(getOption(i), Name) == 0)
1041 return i;
1043 return e;
1047 // Return the width of the option tag for printing...
1048 size_t generic_parser_base::getOptionWidth(const Option &O) const {
1049 if (O.hasArgStr()) {
1050 size_t Size = std::strlen(O.ArgStr)+6;
1051 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1052 Size = std::max(Size, std::strlen(getOption(i))+8);
1053 return Size;
1054 } else {
1055 size_t BaseSize = 0;
1056 for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1057 BaseSize = std::max(BaseSize, std::strlen(getOption(i))+8);
1058 return BaseSize;
1062 // printOptionInfo - Print out information about this option. The
1063 // to-be-maintained width is specified.
1065 void generic_parser_base::printOptionInfo(const Option &O,
1066 size_t GlobalWidth) const {
1067 if (O.hasArgStr()) {
1068 size_t L = std::strlen(O.ArgStr);
1069 outs() << " -" << O.ArgStr;
1070 outs().indent(GlobalWidth-L-6) << " - " << O.HelpStr << '\n';
1072 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1073 size_t NumSpaces = GlobalWidth-strlen(getOption(i))-8;
1074 outs() << " =" << getOption(i);
1075 outs().indent(NumSpaces) << " - " << getDescription(i) << '\n';
1077 } else {
1078 if (O.HelpStr[0])
1079 outs() << " " << O.HelpStr << '\n';
1080 for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1081 size_t L = std::strlen(getOption(i));
1082 outs() << " -" << getOption(i);
1083 outs().indent(GlobalWidth-L-8) << " - " << getDescription(i) << '\n';
1088 static const size_t MaxOptWidth = 8; // arbitrary spacing for printOptionDiff
1090 // printGenericOptionDiff - Print the value of this option and it's default.
1092 // "Generic" options have each value mapped to a name.
1093 void generic_parser_base::
1094 printGenericOptionDiff(const Option &O, const GenericOptionValue &Value,
1095 const GenericOptionValue &Default,
1096 size_t GlobalWidth) const {
1097 outs() << " -" << O.ArgStr;
1098 outs().indent(GlobalWidth-std::strlen(O.ArgStr));
1100 unsigned NumOpts = getNumOptions();
1101 for (unsigned i = 0; i != NumOpts; ++i) {
1102 if (Value.compare(getOptionValue(i)))
1103 continue;
1105 outs() << "= " << getOption(i);
1106 size_t L = std::strlen(getOption(i));
1107 size_t NumSpaces = MaxOptWidth > L ? MaxOptWidth - L : 0;
1108 outs().indent(NumSpaces) << " (default: ";
1109 for (unsigned j = 0; j != NumOpts; ++j) {
1110 if (Default.compare(getOptionValue(j)))
1111 continue;
1112 outs() << getOption(j);
1113 break;
1115 outs() << ")\n";
1116 return;
1118 outs() << "= *unknown option value*\n";
1121 // printOptionDiff - Specializations for printing basic value types.
1123 #define PRINT_OPT_DIFF(T) \
1124 void parser<T>:: \
1125 printOptionDiff(const Option &O, T V, OptionValue<T> D, \
1126 size_t GlobalWidth) const { \
1127 printOptionName(O, GlobalWidth); \
1128 std::string Str; \
1130 raw_string_ostream SS(Str); \
1131 SS << V; \
1133 outs() << "= " << Str; \
1134 size_t NumSpaces = MaxOptWidth > Str.size() ? MaxOptWidth - Str.size() : 0;\
1135 outs().indent(NumSpaces) << " (default: "; \
1136 if (D.hasValue()) \
1137 outs() << D.getValue(); \
1138 else \
1139 outs() << "*no default*"; \
1140 outs() << ")\n"; \
1143 PRINT_OPT_DIFF(bool)
1144 PRINT_OPT_DIFF(boolOrDefault)
1145 PRINT_OPT_DIFF(int)
1146 PRINT_OPT_DIFF(unsigned)
1147 PRINT_OPT_DIFF(double)
1148 PRINT_OPT_DIFF(float)
1149 PRINT_OPT_DIFF(char)
1151 void parser<std::string>::
1152 printOptionDiff(const Option &O, StringRef V, OptionValue<std::string> D,
1153 size_t GlobalWidth) const {
1154 printOptionName(O, GlobalWidth);
1155 outs() << "= " << V;
1156 size_t NumSpaces = MaxOptWidth > V.size() ? MaxOptWidth - V.size() : 0;
1157 outs().indent(NumSpaces) << " (default: ";
1158 if (D.hasValue())
1159 outs() << D.getValue();
1160 else
1161 outs() << "*no default*";
1162 outs() << ")\n";
1165 // Print a placeholder for options that don't yet support printOptionDiff().
1166 void basic_parser_impl::
1167 printOptionNoValue(const Option &O, size_t GlobalWidth) const {
1168 printOptionName(O, GlobalWidth);
1169 outs() << "= *cannot print option value*\n";
1172 //===----------------------------------------------------------------------===//
1173 // -help and -help-hidden option implementation
1176 static int OptNameCompare(const void *LHS, const void *RHS) {
1177 typedef std::pair<const char *, Option*> pair_ty;
1179 return strcmp(((pair_ty*)LHS)->first, ((pair_ty*)RHS)->first);
1182 // Copy Options into a vector so we can sort them as we like.
1183 static void
1184 sortOpts(StringMap<Option*> &OptMap,
1185 SmallVectorImpl< std::pair<const char *, Option*> > &Opts,
1186 bool ShowHidden) {
1187 SmallPtrSet<Option*, 128> OptionSet; // Duplicate option detection.
1189 for (StringMap<Option*>::iterator I = OptMap.begin(), E = OptMap.end();
1190 I != E; ++I) {
1191 // Ignore really-hidden options.
1192 if (I->second->getOptionHiddenFlag() == ReallyHidden)
1193 continue;
1195 // Unless showhidden is set, ignore hidden flags.
1196 if (I->second->getOptionHiddenFlag() == Hidden && !ShowHidden)
1197 continue;
1199 // If we've already seen this option, don't add it to the list again.
1200 if (!OptionSet.insert(I->second))
1201 continue;
1203 Opts.push_back(std::pair<const char *, Option*>(I->getKey().data(),
1204 I->second));
1207 // Sort the options list alphabetically.
1208 qsort(Opts.data(), Opts.size(), sizeof(Opts[0]), OptNameCompare);
1211 namespace {
1213 class HelpPrinter {
1214 size_t MaxArgLen;
1215 const Option *EmptyArg;
1216 const bool ShowHidden;
1218 public:
1219 explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {
1220 EmptyArg = 0;
1223 void operator=(bool Value) {
1224 if (Value == false) return;
1226 // Get all the options.
1227 SmallVector<Option*, 4> PositionalOpts;
1228 SmallVector<Option*, 4> SinkOpts;
1229 StringMap<Option*> OptMap;
1230 GetOptionInfo(PositionalOpts, SinkOpts, OptMap);
1232 SmallVector<std::pair<const char *, Option*>, 128> Opts;
1233 sortOpts(OptMap, Opts, ShowHidden);
1235 if (ProgramOverview)
1236 outs() << "OVERVIEW: " << ProgramOverview << "\n";
1238 outs() << "USAGE: " << ProgramName << " [options]";
1240 // Print out the positional options.
1241 Option *CAOpt = 0; // The cl::ConsumeAfter option, if it exists...
1242 if (!PositionalOpts.empty() &&
1243 PositionalOpts[0]->getNumOccurrencesFlag() == ConsumeAfter)
1244 CAOpt = PositionalOpts[0];
1246 for (size_t i = CAOpt != 0, e = PositionalOpts.size(); i != e; ++i) {
1247 if (PositionalOpts[i]->ArgStr[0])
1248 outs() << " --" << PositionalOpts[i]->ArgStr;
1249 outs() << " " << PositionalOpts[i]->HelpStr;
1252 // Print the consume after option info if it exists...
1253 if (CAOpt) outs() << " " << CAOpt->HelpStr;
1255 outs() << "\n\n";
1257 // Compute the maximum argument length...
1258 MaxArgLen = 0;
1259 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1260 MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1262 outs() << "OPTIONS:\n";
1263 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1264 Opts[i].second->printOptionInfo(MaxArgLen);
1266 // Print any extra help the user has declared.
1267 for (std::vector<const char *>::iterator I = MoreHelp->begin(),
1268 E = MoreHelp->end(); I != E; ++I)
1269 outs() << *I;
1270 MoreHelp->clear();
1272 // Halt the program since help information was printed
1273 exit(1);
1276 } // End anonymous namespace
1278 // Define the two HelpPrinter instances that are used to print out help, or
1279 // help-hidden...
1281 static HelpPrinter NormalPrinter(false);
1282 static HelpPrinter HiddenPrinter(true);
1284 static cl::opt<HelpPrinter, true, parser<bool> >
1285 HOp("help", cl::desc("Display available options (-help-hidden for more)"),
1286 cl::location(NormalPrinter), cl::ValueDisallowed);
1288 static cl::opt<HelpPrinter, true, parser<bool> >
1289 HHOp("help-hidden", cl::desc("Display all available options"),
1290 cl::location(HiddenPrinter), cl::Hidden, cl::ValueDisallowed);
1292 static cl::opt<bool>
1293 PrintOptions("print-options",
1294 cl::desc("Print non-default options after command line parsing"),
1295 cl::Hidden, cl::init(false));
1297 static cl::opt<bool>
1298 PrintAllOptions("print-all-options",
1299 cl::desc("Print all option values after command line parsing"),
1300 cl::Hidden, cl::init(false));
1302 // Print the value of each option.
1303 void cl::PrintOptionValues() {
1304 if (!PrintOptions && !PrintAllOptions) return;
1306 // Get all the options.
1307 SmallVector<Option*, 4> PositionalOpts;
1308 SmallVector<Option*, 4> SinkOpts;
1309 StringMap<Option*> OptMap;
1310 GetOptionInfo(PositionalOpts, SinkOpts, OptMap);
1312 SmallVector<std::pair<const char *, Option*>, 128> Opts;
1313 sortOpts(OptMap, Opts, /*ShowHidden*/true);
1315 // Compute the maximum argument length...
1316 size_t MaxArgLen = 0;
1317 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1318 MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1320 for (size_t i = 0, e = Opts.size(); i != e; ++i)
1321 Opts[i].second->printOptionValue(MaxArgLen, PrintAllOptions);
1324 static void (*OverrideVersionPrinter)() = 0;
1326 static int TargetArraySortFn(const void *LHS, const void *RHS) {
1327 typedef std::pair<const char *, const Target*> pair_ty;
1328 return strcmp(((const pair_ty*)LHS)->first, ((const pair_ty*)RHS)->first);
1331 namespace {
1332 class VersionPrinter {
1333 public:
1334 void print() {
1335 raw_ostream &OS = outs();
1336 OS << "Low Level Virtual Machine (http://llvm.org/):\n"
1337 << " " << PACKAGE_NAME << " version " << PACKAGE_VERSION;
1338 #ifdef LLVM_VERSION_INFO
1339 OS << LLVM_VERSION_INFO;
1340 #endif
1341 OS << "\n ";
1342 #ifndef __OPTIMIZE__
1343 OS << "DEBUG build";
1344 #else
1345 OS << "Optimized build";
1346 #endif
1347 #ifndef NDEBUG
1348 OS << " with assertions";
1349 #endif
1350 std::string CPU = sys::getHostCPUName();
1351 if (CPU == "generic") CPU = "(unknown)";
1352 OS << ".\n"
1353 #if (ENABLE_TIMESTAMPS == 1)
1354 << " Built " << __DATE__ << " (" << __TIME__ << ").\n"
1355 #endif
1356 << " Host: " << sys::getHostTriple() << '\n'
1357 << " Host CPU: " << CPU << '\n'
1358 << '\n'
1359 << " Registered Targets:\n";
1361 std::vector<std::pair<const char *, const Target*> > Targets;
1362 size_t Width = 0;
1363 for (TargetRegistry::iterator it = TargetRegistry::begin(),
1364 ie = TargetRegistry::end(); it != ie; ++it) {
1365 Targets.push_back(std::make_pair(it->getName(), &*it));
1366 Width = std::max(Width, strlen(Targets.back().first));
1368 if (!Targets.empty())
1369 qsort(&Targets[0], Targets.size(), sizeof(Targets[0]),
1370 TargetArraySortFn);
1372 for (unsigned i = 0, e = Targets.size(); i != e; ++i) {
1373 OS << " " << Targets[i].first;
1374 OS.indent(Width - strlen(Targets[i].first)) << " - "
1375 << Targets[i].second->getShortDescription() << '\n';
1377 if (Targets.empty())
1378 OS << " (none)\n";
1380 void operator=(bool OptionWasSpecified) {
1381 if (!OptionWasSpecified) return;
1383 if (OverrideVersionPrinter == 0) {
1384 print();
1385 exit(1);
1387 (*OverrideVersionPrinter)();
1388 exit(1);
1391 } // End anonymous namespace
1394 // Define the --version option that prints out the LLVM version for the tool
1395 static VersionPrinter VersionPrinterInstance;
1397 static cl::opt<VersionPrinter, true, parser<bool> >
1398 VersOp("version", cl::desc("Display the version of this program"),
1399 cl::location(VersionPrinterInstance), cl::ValueDisallowed);
1401 // Utility function for printing the help message.
1402 void cl::PrintHelpMessage() {
1403 // This looks weird, but it actually prints the help message. The
1404 // NormalPrinter variable is a HelpPrinter and the help gets printed when
1405 // its operator= is invoked. That's because the "normal" usages of the
1406 // help printer is to be assigned true/false depending on whether the
1407 // -help option was given or not. Since we're circumventing that we have
1408 // to make it look like -help was given, so we assign true.
1409 NormalPrinter = true;
1412 /// Utility function for printing version number.
1413 void cl::PrintVersionMessage() {
1414 VersionPrinterInstance.print();
1417 void cl::SetVersionPrinter(void (*func)()) {
1418 OverrideVersionPrinter = func;