MemoryBuffer now return an error_code and returns a OwningPtr<MemoryBuffer> via an...
[oota-llvm.git] / lib / Support / CommandLine.cpp
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.
13 //
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 //
17 //===----------------------------------------------------------------------===//
18
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;
39
40 //===----------------------------------------------------------------------===//
41 // Template instantiations and anchors.
42 //
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>);
52
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
59
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() {}
70
71 //===----------------------------------------------------------------------===//
72
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;
77
78 // This collects additional help to be printed.
79 static ManagedStatic<std::vector<const char*> > MoreHelp;
80
81 extrahelp::extrahelp(const char *Help)
82   : morehelp(Help) {
83   MoreHelp->push_back(Help);
84 }
85
86 static bool OptionListChanged = false;
87
88 // MarkOptionsChanged - Internal helper function.
89 void cl::MarkOptionsChanged() {
90   OptionListChanged = true;
91 }
92
93 /// RegisteredOptionList - This is the list of the command line options that
94 /// have statically constructed themselves.
95 static Option *RegisteredOptionList = 0;
96
97 void Option::addArgument() {
98   assert(NextRegistered == 0 && "argument multiply registered!");
99
100   NextRegistered = RegisteredOptionList;
101   RegisteredOptionList = this;
102   MarkOptionsChanged();
103 }
104
105
106 //===----------------------------------------------------------------------===//
107 // Basic, shared command line option processing machinery.
108 //
109
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);
123
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";
130       }
131     }
132
133     OptionNames.clear();
134
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;
144     }
145   }
146
147   if (CAOpt)
148     PositionalOpts.push_back(CAOpt);
149
150   // Make sure that they are in order of registration not backwards.
151   std::reverse(PositionalOpts.begin(), PositionalOpts.end());
152 }
153
154
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;
162
163   size_t EqualPos = Arg.find('=');
164
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;
170   }
171
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;
177
178   Value = Arg.substr(EqualPos+1);
179   Arg = Arg.substr(0, EqualPos);
180   return I->second;
181 }
182
183 /// CommaSeparateAndAddOccurence - A wrapper around Handler->addOccurence() that
184 /// does special handling of cl::CommaSeparated options.
185 static bool CommaSeparateAndAddOccurence(Option *Handler, unsigned pos,
186                                          StringRef ArgName,
187                                          StringRef Value, bool MultiArg = false)
188 {
189   // Check to see if this option accepts a comma separated list of values.  If
190   // it does, we have to split up the value into multiple values.
191   if (Handler->getMiscFlags() & CommaSeparated) {
192     StringRef Val(Value);
193     StringRef::size_type Pos = Val.find(',');
194
195     while (Pos != StringRef::npos) {
196       // Process the portion before the comma.
197       if (Handler->addOccurrence(pos, ArgName, Val.substr(0, Pos), MultiArg))
198         return true;
199       // Erase the portion before the comma, AND the comma.
200       Val = Val.substr(Pos+1);
201       Value.substr(Pos+1);  // Increment the original value pointer as well.
202       // Check for another comma.
203       Pos = Val.find(',');
204     }
205
206     Value = Val;
207   }
208
209   if (Handler->addOccurrence(pos, ArgName, Value, MultiArg))
210     return true;
211
212   return false;
213 }
214
215 /// ProvideOption - For Value, this differentiates between an empty value ("")
216 /// and a null value (StringRef()).  The later is accepted for arguments that
217 /// don't allow a value (-foo) the former is rejected (-foo=).
218 static inline bool ProvideOption(Option *Handler, StringRef ArgName,
219                                  StringRef Value, int argc, char **argv,
220                                  int &i) {
221   // Is this a multi-argument option?
222   unsigned NumAdditionalVals = Handler->getNumAdditionalVals();
223
224   // Enforce value requirements
225   switch (Handler->getValueExpectedFlag()) {
226   case ValueRequired:
227     if (Value.data() == 0) {       // No value specified?
228       if (i+1 >= argc)
229         return Handler->error("requires a value!");
230       // Steal the next argument, like for '-o filename'
231       Value = argv[++i];
232     }
233     break;
234   case ValueDisallowed:
235     if (NumAdditionalVals > 0)
236       return Handler->error("multi-valued option specified"
237                             " with ValueDisallowed modifier!");
238
239     if (Value.data())
240       return Handler->error("does not allow a value! '" +
241                             Twine(Value) + "' specified.");
242     break;
243   case ValueOptional:
244     break;
245
246   default:
247     errs() << ProgramName
248          << ": Bad ValueMask flag! CommandLine usage error:"
249          << Handler->getValueExpectedFlag() << "\n";
250     llvm_unreachable(0);
251   }
252
253   // If this isn't a multi-arg option, just run the handler.
254   if (NumAdditionalVals == 0)
255     return CommaSeparateAndAddOccurence(Handler, i, ArgName, Value);
256
257   // If it is, run the handle several times.
258   bool MultiArg = false;
259
260   if (Value.data()) {
261     if (CommaSeparateAndAddOccurence(Handler, i, ArgName, Value, MultiArg))
262       return true;
263     --NumAdditionalVals;
264     MultiArg = true;
265   }
266
267   while (NumAdditionalVals > 0) {
268     if (i+1 >= argc)
269       return Handler->error("not enough values!");
270     Value = argv[++i];
271
272     if (CommaSeparateAndAddOccurence(Handler, i, ArgName, Value, MultiArg))
273       return true;
274     MultiArg = true;
275     --NumAdditionalVals;
276   }
277   return false;
278 }
279
280 static bool ProvidePositionalOption(Option *Handler, StringRef Arg, int i) {
281   int Dummy = i;
282   return ProvideOption(Handler, Handler->ArgStr, Arg, 0, 0, Dummy);
283 }
284
285
286 // Option predicates...
287 static inline bool isGrouping(const Option *O) {
288   return O->getFormattingFlag() == cl::Grouping;
289 }
290 static inline bool isPrefixedOrGrouping(const Option *O) {
291   return isGrouping(O) || O->getFormattingFlag() == cl::Prefix;
292 }
293
294 // getOptionPred - Check to see if there are any options that satisfy the
295 // specified predicate with names that are the prefixes in Name.  This is
296 // checked by progressively stripping characters off of the name, checking to
297 // see if there options that satisfy the predicate.  If we find one, return it,
298 // otherwise return null.
299 //
300 static Option *getOptionPred(StringRef Name, size_t &Length,
301                              bool (*Pred)(const Option*),
302                              const StringMap<Option*> &OptionsMap) {
303
304   StringMap<Option*>::const_iterator OMI = OptionsMap.find(Name);
305
306   // Loop while we haven't found an option and Name still has at least two
307   // characters in it (so that the next iteration will not be the empty
308   // string.
309   while (OMI == OptionsMap.end() && Name.size() > 1) {
310     Name = Name.substr(0, Name.size()-1);   // Chop off the last character.
311     OMI = OptionsMap.find(Name);
312   }
313
314   if (OMI != OptionsMap.end() && Pred(OMI->second)) {
315     Length = Name.size();
316     return OMI->second;    // Found one!
317   }
318   return 0;                // No option found!
319 }
320
321 /// HandlePrefixedOrGroupedOption - The specified argument string (which started
322 /// with at least one '-') does not fully match an available option.  Check to
323 /// see if this is a prefix or grouped option.  If so, split arg into output an
324 /// Arg/Value pair and return the Option to parse it with.
325 static Option *HandlePrefixedOrGroupedOption(StringRef &Arg, StringRef &Value,
326                                              bool &ErrorParsing,
327                                          const StringMap<Option*> &OptionsMap) {
328   if (Arg.size() == 1) return 0;
329
330   // Do the lookup!
331   size_t Length = 0;
332   Option *PGOpt = getOptionPred(Arg, Length, isPrefixedOrGrouping, OptionsMap);
333   if (PGOpt == 0) return 0;
334
335   // If the option is a prefixed option, then the value is simply the
336   // rest of the name...  so fall through to later processing, by
337   // setting up the argument name flags and value fields.
338   if (PGOpt->getFormattingFlag() == cl::Prefix) {
339     Value = Arg.substr(Length);
340     Arg = Arg.substr(0, Length);
341     assert(OptionsMap.count(Arg) && OptionsMap.find(Arg)->second == PGOpt);
342     return PGOpt;
343   }
344
345   // This must be a grouped option... handle them now.  Grouping options can't
346   // have values.
347   assert(isGrouping(PGOpt) && "Broken getOptionPred!");
348
349   do {
350     // Move current arg name out of Arg into OneArgName.
351     StringRef OneArgName = Arg.substr(0, Length);
352     Arg = Arg.substr(Length);
353
354     // Because ValueRequired is an invalid flag for grouped arguments,
355     // we don't need to pass argc/argv in.
356     assert(PGOpt->getValueExpectedFlag() != cl::ValueRequired &&
357            "Option can not be cl::Grouping AND cl::ValueRequired!");
358     int Dummy = 0;
359     ErrorParsing |= ProvideOption(PGOpt, OneArgName,
360                                   StringRef(), 0, 0, Dummy);
361
362     // Get the next grouping option.
363     PGOpt = getOptionPred(Arg, Length, isGrouping, OptionsMap);
364   } while (PGOpt && Length != Arg.size());
365
366   // Return the last option with Arg cut down to just the last one.
367   return PGOpt;
368 }
369
370
371
372 static bool RequiresValue(const Option *O) {
373   return O->getNumOccurrencesFlag() == cl::Required ||
374          O->getNumOccurrencesFlag() == cl::OneOrMore;
375 }
376
377 static bool EatsUnboundedNumberOfValues(const Option *O) {
378   return O->getNumOccurrencesFlag() == cl::ZeroOrMore ||
379          O->getNumOccurrencesFlag() == cl::OneOrMore;
380 }
381
382 /// ParseCStringVector - Break INPUT up wherever one or more
383 /// whitespace characters are found, and store the resulting tokens in
384 /// OUTPUT. The tokens stored in OUTPUT are dynamically allocated
385 /// using strdup(), so it is the caller's responsibility to free()
386 /// them later.
387 ///
388 static void ParseCStringVector(std::vector<char *> &OutputVector,
389                                const char *Input) {
390   // Characters which will be treated as token separators:
391   StringRef Delims = " \v\f\t\r\n";
392
393   StringRef WorkStr(Input);
394   while (!WorkStr.empty()) {
395     // If the first character is a delimiter, strip them off.
396     if (Delims.find(WorkStr[0]) != StringRef::npos) {
397       size_t Pos = WorkStr.find_first_not_of(Delims);
398       if (Pos == StringRef::npos) Pos = WorkStr.size();
399       WorkStr = WorkStr.substr(Pos);
400       continue;
401     }
402
403     // Find position of first delimiter.
404     size_t Pos = WorkStr.find_first_of(Delims);
405     if (Pos == StringRef::npos) Pos = WorkStr.size();
406
407     // Everything from 0 to Pos is the next word to copy.
408     char *NewStr = (char*)malloc(Pos+1);
409     memcpy(NewStr, WorkStr.data(), Pos);
410     NewStr[Pos] = 0;
411     OutputVector.push_back(NewStr);
412
413     WorkStr = WorkStr.substr(Pos);
414   }
415 }
416
417 /// ParseEnvironmentOptions - An alternative entry point to the
418 /// CommandLine library, which allows you to read the program's name
419 /// from the caller (as PROGNAME) and its command-line arguments from
420 /// an environment variable (whose name is given in ENVVAR).
421 ///
422 void cl::ParseEnvironmentOptions(const char *progName, const char *envVar,
423                                  const char *Overview, bool ReadResponseFiles) {
424   // Check args.
425   assert(progName && "Program name not specified");
426   assert(envVar && "Environment variable name missing");
427
428   // Get the environment variable they want us to parse options out of.
429   const char *envValue = getenv(envVar);
430   if (!envValue)
431     return;
432
433   // Get program's "name", which we wouldn't know without the caller
434   // telling us.
435   std::vector<char*> newArgv;
436   newArgv.push_back(strdup(progName));
437
438   // Parse the value of the environment variable into a "command line"
439   // and hand it off to ParseCommandLineOptions().
440   ParseCStringVector(newArgv, envValue);
441   int newArgc = static_cast<int>(newArgv.size());
442   ParseCommandLineOptions(newArgc, &newArgv[0], Overview, ReadResponseFiles);
443
444   // Free all the strdup()ed strings.
445   for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
446        i != e; ++i)
447     free(*i);
448 }
449
450
451 /// ExpandResponseFiles - Copy the contents of argv into newArgv,
452 /// substituting the contents of the response files for the arguments
453 /// of type @file.
454 static void ExpandResponseFiles(unsigned argc, char** argv,
455                                 std::vector<char*>& newArgv) {
456   for (unsigned i = 1; i != argc; ++i) {
457     char *arg = argv[i];
458
459     if (arg[0] == '@') {
460       sys::PathWithStatus respFile(++arg);
461
462       // Check that the response file is not empty (mmap'ing empty
463       // files can be problematic).
464       const sys::FileStatus *FileStat = respFile.getFileStatus();
465       if (FileStat && FileStat->getSize() != 0) {
466
467         // If we could open the file, parse its contents, otherwise
468         // pass the @file option verbatim.
469
470         // TODO: we should also support recursive loading of response files,
471         // since this is how gcc behaves. (From their man page: "The file may
472         // itself contain additional @file options; any such options will be
473         // processed recursively.")
474
475         // Mmap the response file into memory.
476         OwningPtr<MemoryBuffer> respFilePtr;
477         if (!MemoryBuffer::getFile(respFile.c_str(), respFilePtr)) {
478           ParseCStringVector(newArgv, respFilePtr->getBufferStart());
479           continue;
480         }
481       }
482     }
483     newArgv.push_back(strdup(arg));
484   }
485 }
486
487 void cl::ParseCommandLineOptions(int argc, char **argv,
488                                  const char *Overview, bool ReadResponseFiles) {
489   // Process all registered options.
490   SmallVector<Option*, 4> PositionalOpts;
491   SmallVector<Option*, 4> SinkOpts;
492   StringMap<Option*> Opts;
493   GetOptionInfo(PositionalOpts, SinkOpts, Opts);
494
495   assert((!Opts.empty() || !PositionalOpts.empty()) &&
496          "No options specified!");
497
498   // Expand response files.
499   std::vector<char*> newArgv;
500   if (ReadResponseFiles) {
501     newArgv.push_back(strdup(argv[0]));
502     ExpandResponseFiles(argc, argv, newArgv);
503     argv = &newArgv[0];
504     argc = static_cast<int>(newArgv.size());
505   }
506
507   // Copy the program name into ProgName, making sure not to overflow it.
508   std::string ProgName = sys::Path(argv[0]).getLast();
509   size_t Len = std::min(ProgName.size(), size_t(79));
510   memcpy(ProgramName, ProgName.data(), Len);
511   ProgramName[Len] = '\0';
512
513   ProgramOverview = Overview;
514   bool ErrorParsing = false;
515
516   // Check out the positional arguments to collect information about them.
517   unsigned NumPositionalRequired = 0;
518
519   // Determine whether or not there are an unlimited number of positionals
520   bool HasUnlimitedPositionals = false;
521
522   Option *ConsumeAfterOpt = 0;
523   if (!PositionalOpts.empty()) {
524     if (PositionalOpts[0]->getNumOccurrencesFlag() == cl::ConsumeAfter) {
525       assert(PositionalOpts.size() > 1 &&
526              "Cannot specify cl::ConsumeAfter without a positional argument!");
527       ConsumeAfterOpt = PositionalOpts[0];
528     }
529
530     // Calculate how many positional values are _required_.
531     bool UnboundedFound = false;
532     for (size_t i = ConsumeAfterOpt != 0, e = PositionalOpts.size();
533          i != e; ++i) {
534       Option *Opt = PositionalOpts[i];
535       if (RequiresValue(Opt))
536         ++NumPositionalRequired;
537       else if (ConsumeAfterOpt) {
538         // ConsumeAfter cannot be combined with "optional" positional options
539         // unless there is only one positional argument...
540         if (PositionalOpts.size() > 2)
541           ErrorParsing |=
542             Opt->error("error - this positional option will never be matched, "
543                        "because it does not Require a value, and a "
544                        "cl::ConsumeAfter option is active!");
545       } else if (UnboundedFound && !Opt->ArgStr[0]) {
546         // This option does not "require" a value...  Make sure this option is
547         // not specified after an option that eats all extra arguments, or this
548         // one will never get any!
549         //
550         ErrorParsing |= Opt->error("error - option can never match, because "
551                                    "another positional argument will match an "
552                                    "unbounded number of values, and this option"
553                                    " does not require a value!");
554       }
555       UnboundedFound |= EatsUnboundedNumberOfValues(Opt);
556     }
557     HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
558   }
559
560   // PositionalVals - A vector of "positional" arguments we accumulate into
561   // the process at the end.
562   //
563   SmallVector<std::pair<StringRef,unsigned>, 4> PositionalVals;
564
565   // If the program has named positional arguments, and the name has been run
566   // across, keep track of which positional argument was named.  Otherwise put
567   // the positional args into the PositionalVals list...
568   Option *ActivePositionalArg = 0;
569
570   // Loop over all of the arguments... processing them.
571   bool DashDashFound = false;  // Have we read '--'?
572   for (int i = 1; i < argc; ++i) {
573     Option *Handler = 0;
574     StringRef Value;
575     StringRef ArgName = "";
576
577     // If the option list changed, this means that some command line
578     // option has just been registered or deregistered.  This can occur in
579     // response to things like -load, etc.  If this happens, rescan the options.
580     if (OptionListChanged) {
581       PositionalOpts.clear();
582       SinkOpts.clear();
583       Opts.clear();
584       GetOptionInfo(PositionalOpts, SinkOpts, Opts);
585       OptionListChanged = false;
586     }
587
588     // Check to see if this is a positional argument.  This argument is
589     // considered to be positional if it doesn't start with '-', if it is "-"
590     // itself, or if we have seen "--" already.
591     //
592     if (argv[i][0] != '-' || argv[i][1] == 0 || DashDashFound) {
593       // Positional argument!
594       if (ActivePositionalArg) {
595         ProvidePositionalOption(ActivePositionalArg, argv[i], i);
596         continue;  // We are done!
597       }
598
599       if (!PositionalOpts.empty()) {
600         PositionalVals.push_back(std::make_pair(argv[i],i));
601
602         // All of the positional arguments have been fulfulled, give the rest to
603         // the consume after option... if it's specified...
604         //
605         if (PositionalVals.size() >= NumPositionalRequired &&
606             ConsumeAfterOpt != 0) {
607           for (++i; i < argc; ++i)
608             PositionalVals.push_back(std::make_pair(argv[i],i));
609           break;   // Handle outside of the argument processing loop...
610         }
611
612         // Delay processing positional arguments until the end...
613         continue;
614       }
615     } else if (argv[i][0] == '-' && argv[i][1] == '-' && argv[i][2] == 0 &&
616                !DashDashFound) {
617       DashDashFound = true;  // This is the mythical "--"?
618       continue;              // Don't try to process it as an argument itself.
619     } else if (ActivePositionalArg &&
620                (ActivePositionalArg->getMiscFlags() & PositionalEatsArgs)) {
621       // If there is a positional argument eating options, check to see if this
622       // option is another positional argument.  If so, treat it as an argument,
623       // otherwise feed it to the eating positional.
624       ArgName = argv[i]+1;
625       // Eat leading dashes.
626       while (!ArgName.empty() && ArgName[0] == '-')
627         ArgName = ArgName.substr(1);
628
629       Handler = LookupOption(ArgName, Value, Opts);
630       if (!Handler || Handler->getFormattingFlag() != cl::Positional) {
631         ProvidePositionalOption(ActivePositionalArg, argv[i], i);
632         continue;  // We are done!
633       }
634
635     } else {     // We start with a '-', must be an argument.
636       ArgName = argv[i]+1;
637       // Eat leading dashes.
638       while (!ArgName.empty() && ArgName[0] == '-')
639         ArgName = ArgName.substr(1);
640
641       Handler = LookupOption(ArgName, Value, Opts);
642
643       // Check to see if this "option" is really a prefixed or grouped argument.
644       if (Handler == 0)
645         Handler = HandlePrefixedOrGroupedOption(ArgName, Value,
646                                                 ErrorParsing, Opts);
647     }
648
649     if (Handler == 0) {
650       if (SinkOpts.empty()) {
651         errs() << ProgramName << ": Unknown command line argument '"
652              << argv[i] << "'.  Try: '" << argv[0] << " -help'\n";
653         ErrorParsing = true;
654       } else {
655         for (SmallVectorImpl<Option*>::iterator I = SinkOpts.begin(),
656                E = SinkOpts.end(); I != E ; ++I)
657           (*I)->addOccurrence(i, "", argv[i]);
658       }
659       continue;
660     }
661
662     // If this is a named positional argument, just remember that it is the
663     // active one...
664     if (Handler->getFormattingFlag() == cl::Positional)
665       ActivePositionalArg = Handler;
666     else
667       ErrorParsing |= ProvideOption(Handler, ArgName, Value, argc, argv, i);
668   }
669
670   // Check and handle positional arguments now...
671   if (NumPositionalRequired > PositionalVals.size()) {
672     errs() << ProgramName
673          << ": Not enough positional command line arguments specified!\n"
674          << "Must specify at least " << NumPositionalRequired
675          << " positional arguments: See: " << argv[0] << " -help\n";
676
677     ErrorParsing = true;
678   } else if (!HasUnlimitedPositionals &&
679              PositionalVals.size() > PositionalOpts.size()) {
680     errs() << ProgramName
681          << ": Too many positional arguments specified!\n"
682          << "Can specify at most " << PositionalOpts.size()
683          << " positional arguments: See: " << argv[0] << " -help\n";
684     ErrorParsing = true;
685
686   } else if (ConsumeAfterOpt == 0) {
687     // Positional args have already been handled if ConsumeAfter is specified.
688     unsigned ValNo = 0, NumVals = static_cast<unsigned>(PositionalVals.size());
689     for (size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
690       if (RequiresValue(PositionalOpts[i])) {
691         ProvidePositionalOption(PositionalOpts[i], PositionalVals[ValNo].first,
692                                 PositionalVals[ValNo].second);
693         ValNo++;
694         --NumPositionalRequired;  // We fulfilled our duty...
695       }
696
697       // If we _can_ give this option more arguments, do so now, as long as we
698       // do not give it values that others need.  'Done' controls whether the
699       // option even _WANTS_ any more.
700       //
701       bool Done = PositionalOpts[i]->getNumOccurrencesFlag() == cl::Required;
702       while (NumVals-ValNo > NumPositionalRequired && !Done) {
703         switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
704         case cl::Optional:
705           Done = true;          // Optional arguments want _at most_ one value
706           // FALL THROUGH
707         case cl::ZeroOrMore:    // Zero or more will take all they can get...
708         case cl::OneOrMore:     // One or more will take all they can get...
709           ProvidePositionalOption(PositionalOpts[i],
710                                   PositionalVals[ValNo].first,
711                                   PositionalVals[ValNo].second);
712           ValNo++;
713           break;
714         default:
715           llvm_unreachable("Internal error, unexpected NumOccurrences flag in "
716                  "positional argument processing!");
717         }
718       }
719     }
720   } else {
721     assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.size());
722     unsigned ValNo = 0;
723     for (size_t j = 1, e = PositionalOpts.size(); j != e; ++j)
724       if (RequiresValue(PositionalOpts[j])) {
725         ErrorParsing |= ProvidePositionalOption(PositionalOpts[j],
726                                                 PositionalVals[ValNo].first,
727                                                 PositionalVals[ValNo].second);
728         ValNo++;
729       }
730
731     // Handle the case where there is just one positional option, and it's
732     // optional.  In this case, we want to give JUST THE FIRST option to the
733     // positional option and keep the rest for the consume after.  The above
734     // loop would have assigned no values to positional options in this case.
735     //
736     if (PositionalOpts.size() == 2 && ValNo == 0 && !PositionalVals.empty()) {
737       ErrorParsing |= ProvidePositionalOption(PositionalOpts[1],
738                                               PositionalVals[ValNo].first,
739                                               PositionalVals[ValNo].second);
740       ValNo++;
741     }
742
743     // Handle over all of the rest of the arguments to the
744     // cl::ConsumeAfter command line option...
745     for (; ValNo != PositionalVals.size(); ++ValNo)
746       ErrorParsing |= ProvidePositionalOption(ConsumeAfterOpt,
747                                               PositionalVals[ValNo].first,
748                                               PositionalVals[ValNo].second);
749   }
750
751   // Loop over args and make sure all required args are specified!
752   for (StringMap<Option*>::iterator I = Opts.begin(),
753          E = Opts.end(); I != E; ++I) {
754     switch (I->second->getNumOccurrencesFlag()) {
755     case Required:
756     case OneOrMore:
757       if (I->second->getNumOccurrences() == 0) {
758         I->second->error("must be specified at least once!");
759         ErrorParsing = true;
760       }
761       // Fall through
762     default:
763       break;
764     }
765   }
766
767   // Now that we know if -debug is specified, we can use it.
768   // Note that if ReadResponseFiles == true, this must be done before the
769   // memory allocated for the expanded command line is free()d below.
770   DEBUG(dbgs() << "Args: ";
771         for (int i = 0; i < argc; ++i)
772           dbgs() << argv[i] << ' ';
773         dbgs() << '\n';
774        );
775
776   // Free all of the memory allocated to the map.  Command line options may only
777   // be processed once!
778   Opts.clear();
779   PositionalOpts.clear();
780   MoreHelp->clear();
781
782   // Free the memory allocated by ExpandResponseFiles.
783   if (ReadResponseFiles) {
784     // Free all the strdup()ed strings.
785     for (std::vector<char*>::iterator i = newArgv.begin(), e = newArgv.end();
786          i != e; ++i)
787       free(*i);
788   }
789
790   // If we had an error processing our arguments, don't let the program execute
791   if (ErrorParsing) exit(1);
792 }
793
794 //===----------------------------------------------------------------------===//
795 // Option Base class implementation
796 //
797
798 bool Option::error(const Twine &Message, StringRef ArgName) {
799   if (ArgName.data() == 0) ArgName = ArgStr;
800   if (ArgName.empty())
801     errs() << HelpStr;  // Be nice for positional arguments
802   else
803     errs() << ProgramName << ": for the -" << ArgName;
804
805   errs() << " option: " << Message << "\n";
806   return true;
807 }
808
809 bool Option::addOccurrence(unsigned pos, StringRef ArgName,
810                            StringRef Value, bool MultiArg) {
811   if (!MultiArg)
812     NumOccurrences++;   // Increment the number of times we have been seen
813
814   switch (getNumOccurrencesFlag()) {
815   case Optional:
816     if (NumOccurrences > 1)
817       return error("may only occur zero or one times!", ArgName);
818     break;
819   case Required:
820     if (NumOccurrences > 1)
821       return error("must occur exactly one time!", ArgName);
822     // Fall through
823   case OneOrMore:
824   case ZeroOrMore:
825   case ConsumeAfter: break;
826   default: return error("bad num occurrences flag value!");
827   }
828
829   return handleOccurrence(pos, ArgName, Value);
830 }
831
832
833 // getValueStr - Get the value description string, using "DefaultMsg" if nothing
834 // has been specified yet.
835 //
836 static const char *getValueStr(const Option &O, const char *DefaultMsg) {
837   if (O.ValueStr[0] == 0) return DefaultMsg;
838   return O.ValueStr;
839 }
840
841 //===----------------------------------------------------------------------===//
842 // cl::alias class implementation
843 //
844
845 // Return the width of the option tag for printing...
846 size_t alias::getOptionWidth() const {
847   return std::strlen(ArgStr)+6;
848 }
849
850 // Print out the option for the alias.
851 void alias::printOptionInfo(size_t GlobalWidth) const {
852   size_t L = std::strlen(ArgStr);
853   errs() << "  -" << ArgStr;
854   errs().indent(GlobalWidth-L-6) << " - " << HelpStr << "\n";
855 }
856
857
858
859 //===----------------------------------------------------------------------===//
860 // Parser Implementation code...
861 //
862
863 // basic_parser implementation
864 //
865
866 // Return the width of the option tag for printing...
867 size_t basic_parser_impl::getOptionWidth(const Option &O) const {
868   size_t Len = std::strlen(O.ArgStr);
869   if (const char *ValName = getValueName())
870     Len += std::strlen(getValueStr(O, ValName))+3;
871
872   return Len + 6;
873 }
874
875 // printOptionInfo - Print out information about this option.  The
876 // to-be-maintained width is specified.
877 //
878 void basic_parser_impl::printOptionInfo(const Option &O,
879                                         size_t GlobalWidth) const {
880   outs() << "  -" << O.ArgStr;
881
882   if (const char *ValName = getValueName())
883     outs() << "=<" << getValueStr(O, ValName) << '>';
884
885   outs().indent(GlobalWidth-getOptionWidth(O)) << " - " << O.HelpStr << '\n';
886 }
887
888
889
890
891 // parser<bool> implementation
892 //
893 bool parser<bool>::parse(Option &O, StringRef ArgName,
894                          StringRef Arg, bool &Value) {
895   if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
896       Arg == "1") {
897     Value = true;
898     return false;
899   }
900
901   if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
902     Value = false;
903     return false;
904   }
905   return O.error("'" + Arg +
906                  "' is invalid value for boolean argument! Try 0 or 1");
907 }
908
909 // parser<boolOrDefault> implementation
910 //
911 bool parser<boolOrDefault>::parse(Option &O, StringRef ArgName,
912                                   StringRef Arg, boolOrDefault &Value) {
913   if (Arg == "" || Arg == "true" || Arg == "TRUE" || Arg == "True" ||
914       Arg == "1") {
915     Value = BOU_TRUE;
916     return false;
917   }
918   if (Arg == "false" || Arg == "FALSE" || Arg == "False" || Arg == "0") {
919     Value = BOU_FALSE;
920     return false;
921   }
922
923   return O.error("'" + Arg +
924                  "' is invalid value for boolean argument! Try 0 or 1");
925 }
926
927 // parser<int> implementation
928 //
929 bool parser<int>::parse(Option &O, StringRef ArgName,
930                         StringRef Arg, int &Value) {
931   if (Arg.getAsInteger(0, Value))
932     return O.error("'" + Arg + "' value invalid for integer argument!");
933   return false;
934 }
935
936 // parser<unsigned> implementation
937 //
938 bool parser<unsigned>::parse(Option &O, StringRef ArgName,
939                              StringRef Arg, unsigned &Value) {
940
941   if (Arg.getAsInteger(0, Value))
942     return O.error("'" + Arg + "' value invalid for uint argument!");
943   return false;
944 }
945
946 // parser<double>/parser<float> implementation
947 //
948 static bool parseDouble(Option &O, StringRef Arg, double &Value) {
949   SmallString<32> TmpStr(Arg.begin(), Arg.end());
950   const char *ArgStart = TmpStr.c_str();
951   char *End;
952   Value = strtod(ArgStart, &End);
953   if (*End != 0)
954     return O.error("'" + Arg + "' value invalid for floating point argument!");
955   return false;
956 }
957
958 bool parser<double>::parse(Option &O, StringRef ArgName,
959                            StringRef Arg, double &Val) {
960   return parseDouble(O, Arg, Val);
961 }
962
963 bool parser<float>::parse(Option &O, StringRef ArgName,
964                           StringRef Arg, float &Val) {
965   double dVal;
966   if (parseDouble(O, Arg, dVal))
967     return true;
968   Val = (float)dVal;
969   return false;
970 }
971
972
973
974 // generic_parser_base implementation
975 //
976
977 // findOption - Return the option number corresponding to the specified
978 // argument string.  If the option is not found, getNumOptions() is returned.
979 //
980 unsigned generic_parser_base::findOption(const char *Name) {
981   unsigned e = getNumOptions();
982
983   for (unsigned i = 0; i != e; ++i) {
984     if (strcmp(getOption(i), Name) == 0)
985       return i;
986   }
987   return e;
988 }
989
990
991 // Return the width of the option tag for printing...
992 size_t generic_parser_base::getOptionWidth(const Option &O) const {
993   if (O.hasArgStr()) {
994     size_t Size = std::strlen(O.ArgStr)+6;
995     for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
996       Size = std::max(Size, std::strlen(getOption(i))+8);
997     return Size;
998   } else {
999     size_t BaseSize = 0;
1000     for (unsigned i = 0, e = getNumOptions(); i != e; ++i)
1001       BaseSize = std::max(BaseSize, std::strlen(getOption(i))+8);
1002     return BaseSize;
1003   }
1004 }
1005
1006 // printOptionInfo - Print out information about this option.  The
1007 // to-be-maintained width is specified.
1008 //
1009 void generic_parser_base::printOptionInfo(const Option &O,
1010                                           size_t GlobalWidth) const {
1011   if (O.hasArgStr()) {
1012     size_t L = std::strlen(O.ArgStr);
1013     outs() << "  -" << O.ArgStr;
1014     outs().indent(GlobalWidth-L-6) << " - " << O.HelpStr << '\n';
1015
1016     for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1017       size_t NumSpaces = GlobalWidth-strlen(getOption(i))-8;
1018       outs() << "    =" << getOption(i);
1019       outs().indent(NumSpaces) << " -   " << getDescription(i) << '\n';
1020     }
1021   } else {
1022     if (O.HelpStr[0])
1023       outs() << "  " << O.HelpStr << '\n';
1024     for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
1025       size_t L = std::strlen(getOption(i));
1026       outs() << "    -" << getOption(i);
1027       outs().indent(GlobalWidth-L-8) << " - " << getDescription(i) << '\n';
1028     }
1029   }
1030 }
1031
1032
1033 //===----------------------------------------------------------------------===//
1034 // -help and -help-hidden option implementation
1035 //
1036
1037 static int OptNameCompare(const void *LHS, const void *RHS) {
1038   typedef std::pair<const char *, Option*> pair_ty;
1039
1040   return strcmp(((pair_ty*)LHS)->first, ((pair_ty*)RHS)->first);
1041 }
1042
1043 namespace {
1044
1045 class HelpPrinter {
1046   size_t MaxArgLen;
1047   const Option *EmptyArg;
1048   const bool ShowHidden;
1049
1050 public:
1051   explicit HelpPrinter(bool showHidden) : ShowHidden(showHidden) {
1052     EmptyArg = 0;
1053   }
1054
1055   void operator=(bool Value) {
1056     if (Value == false) return;
1057
1058     // Get all the options.
1059     SmallVector<Option*, 4> PositionalOpts;
1060     SmallVector<Option*, 4> SinkOpts;
1061     StringMap<Option*> OptMap;
1062     GetOptionInfo(PositionalOpts, SinkOpts, OptMap);
1063
1064     // Copy Options into a vector so we can sort them as we like.
1065     SmallVector<std::pair<const char *, Option*>, 128> Opts;
1066     SmallPtrSet<Option*, 128> OptionSet;  // Duplicate option detection.
1067
1068     for (StringMap<Option*>::iterator I = OptMap.begin(), E = OptMap.end();
1069          I != E; ++I) {
1070       // Ignore really-hidden options.
1071       if (I->second->getOptionHiddenFlag() == ReallyHidden)
1072         continue;
1073
1074       // Unless showhidden is set, ignore hidden flags.
1075       if (I->second->getOptionHiddenFlag() == Hidden && !ShowHidden)
1076         continue;
1077
1078       // If we've already seen this option, don't add it to the list again.
1079       if (!OptionSet.insert(I->second))
1080         continue;
1081
1082       Opts.push_back(std::pair<const char *, Option*>(I->getKey().data(),
1083                                                       I->second));
1084     }
1085
1086     // Sort the options list alphabetically.
1087     qsort(Opts.data(), Opts.size(), sizeof(Opts[0]), OptNameCompare);
1088
1089     if (ProgramOverview)
1090       outs() << "OVERVIEW: " << ProgramOverview << "\n";
1091
1092     outs() << "USAGE: " << ProgramName << " [options]";
1093
1094     // Print out the positional options.
1095     Option *CAOpt = 0;   // The cl::ConsumeAfter option, if it exists...
1096     if (!PositionalOpts.empty() &&
1097         PositionalOpts[0]->getNumOccurrencesFlag() == ConsumeAfter)
1098       CAOpt = PositionalOpts[0];
1099
1100     for (size_t i = CAOpt != 0, e = PositionalOpts.size(); i != e; ++i) {
1101       if (PositionalOpts[i]->ArgStr[0])
1102         outs() << " --" << PositionalOpts[i]->ArgStr;
1103       outs() << " " << PositionalOpts[i]->HelpStr;
1104     }
1105
1106     // Print the consume after option info if it exists...
1107     if (CAOpt) outs() << " " << CAOpt->HelpStr;
1108
1109     outs() << "\n\n";
1110
1111     // Compute the maximum argument length...
1112     MaxArgLen = 0;
1113     for (size_t i = 0, e = Opts.size(); i != e; ++i)
1114       MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
1115
1116     outs() << "OPTIONS:\n";
1117     for (size_t i = 0, e = Opts.size(); i != e; ++i)
1118       Opts[i].second->printOptionInfo(MaxArgLen);
1119
1120     // Print any extra help the user has declared.
1121     for (std::vector<const char *>::iterator I = MoreHelp->begin(),
1122           E = MoreHelp->end(); I != E; ++I)
1123       outs() << *I;
1124     MoreHelp->clear();
1125
1126     // Halt the program since help information was printed
1127     exit(1);
1128   }
1129 };
1130 } // End anonymous namespace
1131
1132 // Define the two HelpPrinter instances that are used to print out help, or
1133 // help-hidden...
1134 //
1135 static HelpPrinter NormalPrinter(false);
1136 static HelpPrinter HiddenPrinter(true);
1137
1138 static cl::opt<HelpPrinter, true, parser<bool> >
1139 HOp("help", cl::desc("Display available options (-help-hidden for more)"),
1140     cl::location(NormalPrinter), cl::ValueDisallowed);
1141
1142 static cl::opt<HelpPrinter, true, parser<bool> >
1143 HHOp("help-hidden", cl::desc("Display all available options"),
1144      cl::location(HiddenPrinter), cl::Hidden, cl::ValueDisallowed);
1145
1146 static void (*OverrideVersionPrinter)() = 0;
1147
1148 static int TargetArraySortFn(const void *LHS, const void *RHS) {
1149   typedef std::pair<const char *, const Target*> pair_ty;
1150   return strcmp(((const pair_ty*)LHS)->first, ((const pair_ty*)RHS)->first);
1151 }
1152
1153 namespace {
1154 class VersionPrinter {
1155 public:
1156   void print() {
1157     raw_ostream &OS = outs();
1158     OS << "Low Level Virtual Machine (http://llvm.org/):\n"
1159        << "  " << PACKAGE_NAME << " version " << PACKAGE_VERSION;
1160 #ifdef LLVM_VERSION_INFO
1161     OS << LLVM_VERSION_INFO;
1162 #endif
1163     OS << "\n  ";
1164 #ifndef __OPTIMIZE__
1165     OS << "DEBUG build";
1166 #else
1167     OS << "Optimized build";
1168 #endif
1169 #ifndef NDEBUG
1170     OS << " with assertions";
1171 #endif
1172     std::string CPU = sys::getHostCPUName();
1173     if (CPU == "generic") CPU = "(unknown)";
1174     OS << ".\n"
1175 #if (ENABLE_TIMESTAMPS == 1)
1176        << "  Built " << __DATE__ << " (" << __TIME__ << ").\n"
1177 #endif
1178        << "  Host: " << sys::getHostTriple() << '\n'
1179        << "  Host CPU: " << CPU << '\n'
1180        << '\n'
1181        << "  Registered Targets:\n";
1182
1183     std::vector<std::pair<const char *, const Target*> > Targets;
1184     size_t Width = 0;
1185     for (TargetRegistry::iterator it = TargetRegistry::begin(),
1186            ie = TargetRegistry::end(); it != ie; ++it) {
1187       Targets.push_back(std::make_pair(it->getName(), &*it));
1188       Width = std::max(Width, strlen(Targets.back().first));
1189     }
1190     if (!Targets.empty())
1191       qsort(&Targets[0], Targets.size(), sizeof(Targets[0]),
1192             TargetArraySortFn);
1193
1194     for (unsigned i = 0, e = Targets.size(); i != e; ++i) {
1195       OS << "    " << Targets[i].first;
1196       OS.indent(Width - strlen(Targets[i].first)) << " - "
1197              << Targets[i].second->getShortDescription() << '\n';
1198     }
1199     if (Targets.empty())
1200       OS << "    (none)\n";
1201   }
1202   void operator=(bool OptionWasSpecified) {
1203     if (!OptionWasSpecified) return;
1204
1205     if (OverrideVersionPrinter == 0) {
1206       print();
1207       exit(1);
1208     }
1209     (*OverrideVersionPrinter)();
1210     exit(1);
1211   }
1212 };
1213 } // End anonymous namespace
1214
1215
1216 // Define the --version option that prints out the LLVM version for the tool
1217 static VersionPrinter VersionPrinterInstance;
1218
1219 static cl::opt<VersionPrinter, true, parser<bool> >
1220 VersOp("version", cl::desc("Display the version of this program"),
1221     cl::location(VersionPrinterInstance), cl::ValueDisallowed);
1222
1223 // Utility function for printing the help message.
1224 void cl::PrintHelpMessage() {
1225   // This looks weird, but it actually prints the help message. The
1226   // NormalPrinter variable is a HelpPrinter and the help gets printed when
1227   // its operator= is invoked. That's because the "normal" usages of the
1228   // help printer is to be assigned true/false depending on whether the
1229   // -help option was given or not. Since we're circumventing that we have
1230   // to make it look like -help was given, so we assign true.
1231   NormalPrinter = true;
1232 }
1233
1234 /// Utility function for printing version number.
1235 void cl::PrintVersionMessage() {
1236   VersionPrinterInstance.print();
1237 }
1238
1239 void cl::SetVersionPrinter(void (*func)()) {
1240   OverrideVersionPrinter = func;
1241 }