31#include "llvm/Config/config.h"
51#define DEBUG_TYPE "commandline"
71#if !(defined(LLVM_ENABLE_LLVM_EXPORT_ANNOTATIONS) && defined(_MSC_VER))
88void GenericOptionValue::anchor() {}
89void OptionValue<boolOrDefault>::anchor() {}
90void OptionValue<std::string>::anchor() {}
91void Option::anchor() {}
125 size_t Len = ArgName.
size();
133 for (
size_t I = 0;
I < Pad; ++
I) {
156 PrintArg(StringRef ArgName,
size_t Pad =
DefaultPad) : ArgName(ArgName), Pad(Pad) {}
157 friend raw_ostream &
operator<<(raw_ostream &OS,
const PrintArg &);
160raw_ostream &
operator<<(raw_ostream &OS,
const PrintArg& Arg) {
161 OS <<
argPrefix(Arg.ArgName, Arg.Pad) << Arg.ArgName;
165class CommandLineParser {
169 std::string ProgramName;
170 StringRef ProgramOverview;
173 std::vector<StringRef> MoreHelp;
181 SmallPtrSet<OptionCategory *, 16> RegisteredOptionCategories;
184 SmallPtrSet<SubCommand *, 4> RegisteredSubCommands;
191 StringRef Overview, raw_ostream *Errs =
nullptr,
192 vfs::FileSystem *VFS =
nullptr,
193 bool LongOptionsUseDoubleDash =
false);
195 void forEachSubCommand(Option &Opt, function_ref<
void(SubCommand &)> Action) {
196 if (Opt.
Subs.empty()) {
201 for (
auto *SC : RegisteredSubCommands)
206 for (
auto *SC : Opt.
Subs) {
208 "SubCommand::getAll() should not be used with other subcommands");
213 void addLiteralOption(Option &Opt, SubCommand *SC, StringRef Name) {
216 if (!SC->
OptionsMap.insert(std::make_pair(Name, &Opt)).second) {
217 errs() << ProgramName <<
": CommandLine Error: Option '" <<
Name
218 <<
"' registered more than once!\n";
223 void addLiteralOption(Option &Opt, StringRef Name) {
225 Opt, [&](SubCommand &SC) { addLiteralOption(Opt, &SC, Name); });
228 void addOption(Option *O, SubCommand *SC) {
229 bool HadErrors =
false;
230 if (
O->hasArgStr()) {
232 if (
O->isDefaultOption() && SC->
OptionsMap.contains(
O->ArgStr))
236 if (!SC->
OptionsMap.insert(std::make_pair(
O->ArgStr, O)).second) {
237 errs() << ProgramName <<
": CommandLine Error: Option '" <<
O->ArgStr
238 <<
"' registered more than once!\n";
250 O->error(
"Cannot specify more than one option with cl::ConsumeAfter!");
264 void addOption(Option *O,
bool ProcessDefaultOption =
false) {
265 if (!ProcessDefaultOption &&
O->isDefaultOption()) {
269 forEachSubCommand(*O, [&](SubCommand &SC) { addOption(O, &SC); });
272 void removeOption(Option *O, SubCommand *SC) {
273 SmallVector<StringRef, 16> OptionNames;
274 O->getExtraOptionNames(OptionNames);
278 SubCommand &
Sub = *SC;
280 for (
auto Name : OptionNames) {
281 auto I =
Sub.OptionsMap.find(Name);
282 if (
I != End &&
I->getValue() == O)
283 Sub.OptionsMap.erase(
I);
287 for (
auto *Opt =
Sub.PositionalOpts.begin();
288 Opt !=
Sub.PositionalOpts.end(); ++Opt) {
290 Sub.PositionalOpts.erase(Opt);
295 for (
auto *Opt =
Sub.SinkOpts.begin(); Opt !=
Sub.SinkOpts.end(); ++Opt) {
297 Sub.SinkOpts.erase(Opt);
301 else if (O ==
Sub.ConsumeAfterOpt)
302 Sub.ConsumeAfterOpt =
nullptr;
305 void removeOption(Option *O) {
306 forEachSubCommand(*O, [&](SubCommand &SC) { removeOption(O, &SC); });
309 bool hasOptions(
const SubCommand &
Sub)
const {
310 return (!
Sub.OptionsMap.empty() || !
Sub.PositionalOpts.empty() ||
311 nullptr !=
Sub.ConsumeAfterOpt);
314 bool hasOptions()
const {
315 for (
const auto *S : RegisteredSubCommands) {
322 bool hasNamedSubCommands()
const {
323 for (
const auto *S : RegisteredSubCommands)
324 if (!S->getName().empty())
329 SubCommand *getActiveSubCommand() {
return ActiveSubCommand; }
331 void updateArgStr(Option *O, StringRef NewName, SubCommand *SC) {
332 SubCommand &
Sub = *SC;
333 if (!
Sub.OptionsMap.insert(std::make_pair(NewName, O)).second) {
334 errs() << ProgramName <<
": CommandLine Error: Option '" <<
O->ArgStr
335 <<
"' registered more than once!\n";
341 void updateArgStr(Option *O, StringRef NewName) {
342 forEachSubCommand(*O,
343 [&](SubCommand &SC) { updateArgStr(O, NewName, &SC); });
346 void printOptionValues();
348 void registerCategory(OptionCategory *cat) {
350 [cat](
const OptionCategory *Category) {
353 "Duplicate option categories");
355 RegisteredOptionCategories.
insert(cat);
358 void registerSubCommand(SubCommand *sub) {
360 [sub](
const SubCommand *
Sub) {
361 return (!
sub->getName().empty()) &&
362 (
Sub->getName() ==
sub->getName());
364 "Duplicate subcommands");
365 RegisteredSubCommands.insert(sub);
370 "SubCommand::getAll() should not be registered");
373 if ((
O->isPositional() ||
O->isSink() ||
O->isConsumeAfter()) ||
377 addLiteralOption(*O, sub,
E.first());
381 void unregisterSubCommand(SubCommand *sub) {
382 RegisteredSubCommands.erase(sub);
385 iterator_range<SmallPtrSet<SubCommand *, 4>::iterator>
387 return make_range(RegisteredSubCommands.begin(),
388 RegisteredSubCommands.end());
392 ActiveSubCommand =
nullptr;
394 ProgramOverview = StringRef();
397 RegisteredOptionCategories.
clear();
400 RegisteredSubCommands.clear();
406 DefaultOptions.
clear();
410 SubCommand *ActiveSubCommand =
nullptr;
412 Option *LookupOption(SubCommand &
Sub, StringRef &Arg, StringRef &
Value);
413 Option *LookupLongOption(SubCommand &
Sub, StringRef &Arg, StringRef &
Value,
414 bool LongOptionsUseDoubleDash,
bool HaveDoubleDash) {
416 if (Opt && LongOptionsUseDoubleDash && !HaveDoubleDash && !
isGrouping(Opt))
420 SubCommand *LookupSubCommand(StringRef Name, std::string &NearestString);
427template <
typename T, T TrueVal, T FalseVal>
429 if (Arg ==
"" || Arg ==
"true" || Arg ==
"TRUE" || Arg ==
"True" ||
435 if (Arg ==
"false" || Arg ==
"FALSE" || Arg ==
"False" || Arg ==
"0") {
439 return O.error(
"'" + Arg +
440 "' is invalid value for boolean argument! Try 0 or 1");
453 FullyInitialized =
true;
459 if (FullyInitialized)
485void OptionCategory::registerCategory() {
519SubCommand::operator
bool()
const {
537 size_t EqualPos = Arg.
find(
'=');
542 return Sub.OptionsMap.lookup(Arg);
548 auto I =
Sub.OptionsMap.find(Arg.
substr(0, EqualPos));
549 if (
I ==
Sub.OptionsMap.end())
557 Arg = Arg.
substr(0, EqualPos);
562 std::string &NearestString) {
567 for (
auto *S : RegisteredSubCommands) {
569 "SubCommand::getAll() is not expected in RegisteredSubCommands");
570 if (S->getName().empty())
573 if (S->getName() == Name)
576 if (!NearestMatch && S->getName().edit_distance(Name) < 2)
581 NearestString = NearestMatch->
getName();
592 std::string &NearestString) {
598 std::pair<StringRef, StringRef> SplitArg = Arg.
split(
'=');
604 unsigned BestDistance = 0;
605 for (
const auto &[
_, O] : OptionsMap) {
611 O->getExtraOptionNames(OptionNames);
617 for (
const auto &Name : OptionNames) {
619 Flag,
true, BestDistance);
620 if (!Best || Distance < BestDistance) {
622 BestDistance = Distance;
623 if (
RHS.empty() || !PermitValue)
624 NearestString = std::string(Name);
626 NearestString = (
Twine(Name) +
"=" +
RHS).str();
638 bool MultiArg =
false) {
650 Val = Val.
substr(Pos + 1);
666 const char *
const *argv,
int &i) {
677 return Handler->
error(
"requires a value!");
679 assert(argv &&
"null check");
684 if (NumAdditionalVals > 0)
685 return Handler->
error(
"multi-valued option specified"
686 " with ValueDisallowed modifier!");
697 if (NumAdditionalVals == 0)
701 bool MultiArg =
false;
710 while (NumAdditionalVals > 0) {
712 return Handler->
error(
"not enough values!");
713 assert(argv &&
"null check");
736 bool (*Pred)(
const Option *),
739 if (OMI != OptionsMap.
end() && !Pred(OMI->getValue()))
740 OMI = OptionsMap.
end();
745 while (OMI == OptionsMap.
end() && Name.size() > 1) {
746 Name = Name.drop_back();
747 OMI = OptionsMap.
find(Name);
748 if (OMI != OptionsMap.
end() && !Pred(OMI->getValue()))
749 OMI = OptionsMap.
end();
752 if (OMI != OptionsMap.
end() && Pred(OMI->second)) {
780 assert(OptionsMap.
count(Arg) && OptionsMap.
find(Arg)->second == PGOpt);
790 if (MaybeValue[0] ==
'=') {
800 ErrorParsing |= PGOpt->
error(
"may not occur within a group!");
829 return C ==
' ' ||
C ==
'\t' ||
C ==
'\r' ||
C ==
'\n';
836static bool isQuote(
char C) {
return C ==
'\"' ||
C ==
'\''; }
842 for (
size_t I = 0, E = Src.size();
I != E; ++
I) {
847 if (MarkEOLs && Src[
I] ==
'\n')
858 if (
I + 1 < E &&
C ==
'\\') {
867 while (
I != E && Src[
I] !=
C) {
869 if (Src[
I] ==
'\\' &&
I + 1 != E)
884 if (MarkEOLs &&
C ==
'\n')
917 size_t E = Src.size();
918 int BackslashCount = 0;
923 }
while (
I !=
E && Src[
I] ==
'\\');
925 bool FollowedByDoubleQuote = (
I !=
E && Src[
I] ==
'"');
926 if (FollowedByDoubleQuote) {
927 Token.
append(BackslashCount / 2,
'\\');
928 if (BackslashCount % 2 == 0)
933 Token.
append(BackslashCount,
'\\');
951 bool AlwaysCopy,
function_ref<
void()> MarkEOL,
bool InitialCommandName) {
960 bool CommandName = InitialCommandName;
963 enum {
INIT, UNQUOTED, QUOTED } State =
INIT;
965 for (
size_t I = 0,
E = Src.size();
I <
E; ++
I) {
968 assert(Token.
empty() &&
"token should be empty in initial state");
990 AddToken(AlwaysCopy ? Saver.
save(NormalChars) : NormalChars);
991 if (
I <
E && Src[
I] ==
'\n') {
993 CommandName = InitialCommandName;
997 }
else if (Src[
I] ==
'\"') {
998 Token += NormalChars;
1000 }
else if (Src[
I] ==
'\\') {
1001 assert(!CommandName &&
"or else we'd have treated it as a normal char");
1002 Token += NormalChars;
1016 AddToken(Saver.
save(Token.
str()));
1018 if (Src[
I] ==
'\n') {
1019 CommandName = InitialCommandName;
1022 CommandName =
false;
1025 }
else if (Src[
I] ==
'\"') {
1027 }
else if (Src[
I] ==
'\\' && !CommandName) {
1035 if (Src[
I] ==
'\"') {
1036 if (
I < (
E - 1) && Src[
I + 1] ==
'"') {
1045 }
else if (Src[
I] ==
'\\' && !CommandName) {
1055 AddToken(Saver.
save(Token.
str()));
1062 auto OnEOL = [&]() {
1067 true, OnEOL,
false);
1073 auto OnEOL = []() {};
1082 auto OnEOL = [&]() {
1093 for (
const char *Cur = Source.begin(); Cur != Source.end();) {
1102 while (Cur != Source.end() && *Cur !=
'\n')
1107 const char *Start = Cur;
1108 for (
const char *End = Source.end(); Cur != End; ++Cur) {
1110 if (Cur + 1 != End) {
1113 (*Cur ==
'\r' && (Cur + 1 != End) && Cur[1] ==
'\n')) {
1114 Line.append(Start, Cur - 1);
1120 }
else if (*Cur ==
'\n')
1124 Line.append(Start, Cur);
1132 return (S.
size() >= 3 && S[0] ==
'\xef' && S[1] ==
'\xbb' && S[2] ==
'\xbf');
1146 TokenPos = ArgString.
find(Token, StartPos)) {
1150 if (ResponseFile.
empty())
1154 ResponseFile.
append(BasePath);
1155 StartPos = TokenPos + Token.
size();
1158 if (!ResponseFile.
empty()) {
1161 if (!Remaining.
empty())
1168Error ExpansionContext::expandResponseFile(
1169 StringRef FName, SmallVectorImpl<const char *> &NewArgv) {
1171 llvm::ErrorOr<std::unique_ptr<MemoryBuffer>> MemBufOrErr =
1172 FS->getBufferForFile(FName);
1176 "': " +
EC.message());
1178 MemoryBuffer &MemBuf = *MemBufOrErr.
get();
1183 std::string UTF8Buf;
1187 "Could not convert UTF16 to UTF8");
1188 Str = StringRef(UTF8Buf);
1194 Str = StringRef(BufRef.data() + 3, BufRef.size() - 3);
1197 Tokenizer(Str, Saver, NewArgv, MarkEOLs);
1202 if (!RelativeNames && !InConfigFile)
1206 for (
const char *&Arg : NewArgv) {
1216 StringRef ArgStr(Arg);
1218 bool ConfigInclusion =
false;
1219 if (ArgStr.consume_front(
"@")) {
1223 }
else if (ArgStr.consume_front(
"--config=")) {
1225 ConfigInclusion =
true;
1231 SmallString<128> ResponseFile;
1234 SmallString<128> FilePath;
1237 std::make_error_code(std::errc::no_such_file_or_directory),
1238 "cannot not find configuration file: " + FileName);
1239 ResponseFile.
append(FilePath);
1241 ResponseFile.
append(BasePath);
1244 Arg = Saver.save(ResponseFile.
str()).
data();
1253 struct ResponseFileRecord {
1268 for (
unsigned I = 0;
I != Argv.
size();) {
1269 while (
I == FileStack.
back().End) {
1275 const char *Arg = Argv[
I];
1277 if (Arg ==
nullptr) {
1282 if (Arg[0] !=
'@') {
1287 const char *FName = Arg + 1;
1292 if (CurrentDir.empty()) {
1293 if (
auto CWD = FS->getCurrentWorkingDirectory()) {
1297 CWD.getError(),
Twine(
"cannot get absolute path for: ") + FName);
1300 CurrDir = CurrentDir;
1303 FName = CurrDir.
c_str();
1307 if (!Res || !Res->exists()) {
1308 std::error_code EC = Res.
getError();
1309 if (!InConfigFile) {
1320 "': " + EC.message());
1325 [FileStatus,
this](
const ResponseFileRecord &RFile) ->
ErrorOr<bool> {
1337 R.getError(),
Twine(
"recursive expansion of: '") +
F.File +
"'");
1340 Twine(
"cannot open file: ") +
F.File);
1347 if (
Error Err = expandResponseFile(FName, ExpandedArgv))
1350 for (ResponseFileRecord &
Record : FileStack) {
1381 Tokenize(*EnvValue, Saver, NewArgv,
false);
1384 NewArgv.
append(Argv + 1, Argv + Argc);
1405 : Saver(
A), Tokenizer(
T), FS(FS ? FS :
vfs::getRealFileSystem().
get()) {}
1411 auto Status = FS->status(Path);
1419 CfgFilePath = FileName;
1422 if (!FileExists(CfgFilePath))
1429 for (
const StringRef &Dir : SearchDirs) {
1435 if (FileExists(CfgFilePath)) {
1449 if (std::error_code EC = FS->makeAbsolute(AbsPath))
1451 EC,
Twine(
"cannot get absolute path for " + CfgFile));
1452 CfgFile = AbsPath.
str();
1454 InConfigFile =
true;
1455 RelativeNames =
true;
1456 if (
Error Err = expandResponseFile(CfgFile, Argv))
1465 bool LongOptionsUseDoubleDash) {
1474 if (std::optional<std::string> EnvValue =
1480 for (
int I = 1;
I < argc; ++
I)
1482 int NewArgc =
static_cast<int>(NewArgv.
size());
1486 NewArgc, &NewArgv[0], Overview, Errs, VFS, LongOptionsUseDoubleDash);
1490void CommandLineParser::ResetAllOptionOccurrences() {
1494 for (
auto *SC : RegisteredSubCommands) {
1506bool CommandLineParser::ParseCommandLineOptions(
1509 assert(hasOptions() &&
"No options specified!");
1511 ProgramOverview = Overview;
1512 bool IgnoreErrors = Errs;
1517 bool ErrorParsing =
false;
1528 if (
Error Err = ECtx.expandResponseFiles(newArgv)) {
1529 *Errs <<
toString(std::move(Err)) <<
'\n';
1533 argc =
static_cast<int>(newArgv.size());
1539 unsigned NumPositionalRequired = 0;
1542 bool HasUnlimitedPositionals =
false;
1546 std::string NearestSubCommandString;
1547 bool MaybeNamedSubCommand =
1548 argc >= 2 && argv[FirstArg][0] !=
'-' && hasNamedSubCommands();
1549 if (MaybeNamedSubCommand) {
1553 LookupSubCommand(
StringRef(argv[FirstArg]), NearestSubCommandString);
1559 assert(ChosenSubCommand);
1562 auto &SinkOpts = ChosenSubCommand->
SinkOpts;
1563 auto &OptionsMap = ChosenSubCommand->
OptionsMap;
1565 for (
auto *O: DefaultOptions) {
1569 if (ConsumeAfterOpt) {
1570 assert(PositionalOpts.size() > 0 &&
1571 "Cannot specify cl::ConsumeAfter without a positional argument!");
1573 if (!PositionalOpts.empty()) {
1576 bool UnboundedFound =
false;
1577 for (
size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
1578 Option *Opt = PositionalOpts[i];
1580 ++NumPositionalRequired;
1581 else if (ConsumeAfterOpt) {
1584 if (PositionalOpts.size() > 1) {
1586 Opt->
error(
"error - this positional option will never be matched, "
1587 "because it does not Require a value, and a "
1588 "cl::ConsumeAfter option is active!");
1589 ErrorParsing =
true;
1591 }
else if (UnboundedFound && !Opt->
hasArgStr()) {
1597 Opt->
error(
"error - option can never match, because "
1598 "another positional argument will match an "
1599 "unbounded number of values, and this option"
1600 " does not require a value!");
1601 *Errs << ProgramName <<
": CommandLine Error: Option '" << Opt->
ArgStr
1602 <<
"' is all messed up!\n";
1603 *Errs << PositionalOpts.size();
1604 ErrorParsing =
true;
1608 HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
1619 Option *ActivePositionalArg =
nullptr;
1622 bool DashDashFound =
false;
1623 for (
int i = FirstArg; i < argc; ++i) {
1624 Option *Handler =
nullptr;
1625 std::string NearestHandlerString;
1627 StringRef ArgName =
"";
1628 bool HaveDoubleDash =
false;
1634 if (argv[i][0] !=
'-' || argv[i][1] == 0 || DashDashFound) {
1636 if (ActivePositionalArg) {
1641 if (!PositionalOpts.empty()) {
1642 PositionalVals.
push_back(std::make_pair(StringRef(argv[i]), i));
1647 if (PositionalVals.
size() >= NumPositionalRequired && ConsumeAfterOpt) {
1648 for (++i; i < argc; ++i)
1649 PositionalVals.
push_back(std::make_pair(StringRef(argv[i]), i));
1656 }
else if (argv[i][0] ==
'-' && argv[i][1] ==
'-' && argv[i][2] == 0 &&
1658 DashDashFound =
true;
1660 }
else if (ActivePositionalArg &&
1665 ArgName = StringRef(argv[i] + 1);
1668 HaveDoubleDash =
true;
1670 Handler = LookupLongOption(*ChosenSubCommand, ArgName,
Value,
1671 LongOptionsUseDoubleDash, HaveDoubleDash);
1677 ArgName = StringRef(argv[i] + 1);
1680 HaveDoubleDash =
true;
1682 Handler = LookupLongOption(*ChosenSubCommand, ArgName,
Value,
1683 LongOptionsUseDoubleDash, HaveDoubleDash);
1690 LongOptionsUseDoubleDash, HaveDoubleDash);
1693 if (!Handler && !(LongOptionsUseDoubleDash && HaveDoubleDash))
1699 if (!Handler && SinkOpts.empty())
1704 if (!SinkOpts.empty()) {
1705 for (
Option *SinkOpt : SinkOpts)
1706 SinkOpt->addOccurrence(i,
"", StringRef(argv[i]));
1710 auto ReportUnknownArgument = [&](
bool IsArg,
1711 StringRef NearestArgumentName) {
1712 *Errs << ProgramName <<
": Unknown "
1713 << (IsArg ?
"command line argument" :
"subcommand") <<
" '"
1714 << argv[i] <<
"'. Try: '" << argv[0] <<
" --help'\n";
1716 if (NearestArgumentName.empty())
1719 *Errs << ProgramName <<
": Did you mean '";
1721 *Errs << PrintArg(NearestArgumentName, 0);
1723 *Errs << NearestArgumentName;
1727 if (i > 1 || !MaybeNamedSubCommand)
1728 ReportUnknownArgument(
true, NearestHandlerString);
1730 ReportUnknownArgument(
false, NearestSubCommandString);
1732 ErrorParsing =
true;
1740 Handler->
error(
"This argument does not take a value.\n"
1741 "\tInstead, it consumes any positional arguments until "
1742 "the next recognized option.", *Errs);
1743 ErrorParsing =
true;
1745 ActivePositionalArg = Handler;
1752 if (NumPositionalRequired > PositionalVals.
size()) {
1753 *Errs << ProgramName
1754 <<
": Not enough positional command line arguments specified!\n"
1755 <<
"Must specify at least " << NumPositionalRequired
1756 <<
" positional argument" << (NumPositionalRequired > 1 ?
"s" :
"")
1757 <<
": See: " << argv[0] <<
" --help\n";
1759 ErrorParsing =
true;
1760 }
else if (!HasUnlimitedPositionals &&
1761 PositionalVals.
size() > PositionalOpts.size()) {
1762 *Errs << ProgramName <<
": Too many positional arguments specified!\n"
1763 <<
"Can specify at most " << PositionalOpts.size()
1764 <<
" positional arguments: See: " << argv[0] <<
" --help\n";
1765 ErrorParsing =
true;
1767 }
else if (!ConsumeAfterOpt) {
1769 unsigned ValNo = 0, NumVals =
static_cast<unsigned>(PositionalVals.
size());
1770 for (
Option *Opt : PositionalOpts) {
1773 PositionalVals[ValNo].second);
1775 --NumPositionalRequired;
1783 while (NumVals - ValNo > NumPositionalRequired && !
Done) {
1791 PositionalVals[ValNo].second);
1796 "positional argument processing!");
1801 assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.
size());
1803 for (
Option *Opt : PositionalOpts)
1806 Opt, PositionalVals[ValNo].first, PositionalVals[ValNo].second);
1815 if (PositionalOpts.size() == 1 && ValNo == 0 && !PositionalVals.
empty()) {
1817 PositionalVals[ValNo].first,
1818 PositionalVals[ValNo].second);
1824 for (; ValNo != PositionalVals.
size(); ++ValNo)
1827 PositionalVals[ValNo].second);
1831 for (
const auto &Opt : OptionsMap) {
1836 Opt.second->
error(
"must be specified at least once!");
1837 ErrorParsing =
true;
1849 for (
int i = 0; i < argc; ++i)
dbgs() << argv[i] <<
' ';
1870 if (!ArgName.
data())
1872 if (ArgName.
empty())
1875 Errs <<
GlobalParser->ProgramName <<
": for the " << PrintArg(ArgName, 0);
1877 Errs <<
" option: " << Message <<
"\n";
1886 return handleOccurrence(pos, ArgName, Value);
1893 if (O.ValueStr.empty())
1908 size_t FirstLineIndentedBy) {
1909 assert(Indent >= FirstLineIndentedBy);
1910 std::pair<StringRef, StringRef> Split =
HelpStr.split(
'\n');
1913 while (!Split.second.empty()) {
1914 Split = Split.second.split(
'\n');
1915 outs().
indent(Indent) << Split.first <<
"\n";
1920 size_t FirstLineIndentedBy) {
1922 assert(BaseIndent >= FirstLineIndentedBy);
1923 std::pair<StringRef, StringRef> Split =
HelpStr.split(
'\n');
1924 outs().
indent(BaseIndent - FirstLineIndentedBy)
1926 while (!Split.second.empty()) {
1927 Split = Split.second.split(
'\n');
1928 outs().
indent(BaseIndent + ValHelpPrefix.
size()) << Split.first <<
"\n";
1933void alias::printOptionInfo(
size_t GlobalWidth)
const {
1949 if (!ValName.empty()) {
1950 size_t FormattingLen = 3;
1963 size_t GlobalWidth)
const {
1964 outs() << PrintArg(O.ArgStr);
1967 if (!ValName.empty()) {
1973 outs() << (O.ArgStr.size() == 1 ?
" <" :
"=<") <<
getValueStr(O, ValName)
1982 size_t GlobalWidth)
const {
1983 outs() << PrintArg(O.ArgStr);
1984 outs().
indent(GlobalWidth - O.ArgStr.size());
2006 return O.error(
"'" + Arg +
"' value invalid for integer argument!");
2015 return O.error(
"'" + Arg +
"' value invalid for long argument!");
2024 return O.error(
"'" + Arg +
"' value invalid for llong argument!");
2034 return O.error(
"'" + Arg +
"' value invalid for uint argument!");
2041 unsigned long &
Value) {
2044 return O.error(
"'" + Arg +
"' value invalid for ulong argument!");
2052 unsigned long long &
Value) {
2055 return O.error(
"'" + Arg +
"' value invalid for ullong argument!");
2064 return O.error(
"'" + Arg +
"' value invalid for floating point argument!");
2090 for (
unsigned i = 0; i != e; ++i) {
2106 return O.getValueExpectedFlag() !=
ValueOptional || !Name.empty() ||
2107 !Description.
empty();
2112 if (O.hasArgStr()) {
2124 size_t BaseSize = 0;
2135 size_t GlobalWidth)
const {
2136 if (O.hasArgStr()) {
2142 outs() << PrintArg(O.ArgStr);
2161 if (OptionName.
empty()) {
2166 if (!Description.
empty())
2172 if (!O.HelpStr.empty())
2173 outs() <<
" " << O.HelpStr <<
'\n';
2190 outs() <<
" " << PrintArg(O.ArgStr);
2191 outs().
indent(GlobalWidth - O.ArgStr.size());
2194 for (
unsigned i = 0; i != NumOpts; ++i) {
2202 for (
unsigned j = 0; j != NumOpts; ++j) {
2211 outs() <<
"= *unknown option value*\n";
2216#define PRINT_OPT_DIFF(T) \
2217 void parser<T>::printOptionDiff(const Option &O, T V, OptionValue<T> D, \
2218 size_t GlobalWidth) const { \
2219 printOptionName(O, GlobalWidth); \
2222 raw_string_ostream SS(Str); \
2225 outs() << "= " << Str; \
2226 size_t NumSpaces = \
2227 MaxOptWidth > Str.size() ? MaxOptWidth - Str.size() : 0; \
2228 outs().indent(NumSpaces) << " (default: "; \
2230 outs() << D.getValue(); \
2232 outs() << "*no default*"; \
2250 size_t GlobalWidth)
const {
2251 printOptionName(O, GlobalWidth);
2252 outs() <<
"= " << V;
2256 outs() <<
D.getValue();
2258 outs() <<
"*no default*";
2263 const Option &O, std::optional<StringRef> V,
2265 size_t GlobalWidth)
const {
2266 printOptionName(O, GlobalWidth);
2267 outs() <<
"= " <<
V;
2268 size_t VSize =
V.has_value() ?
V.value().size() : 0;
2271 if (
D.hasValue() &&
D.getValue().has_value())
2272 outs() <<
D.getValue();
2274 outs() <<
"*no value*";
2280 size_t GlobalWidth)
const {
2282 outs() <<
"= *cannot print option value*\n";
2290 const std::pair<const char *, Option *> *
RHS) {
2291 return strcmp(
LHS->first,
RHS->first);
2295 const std::pair<const char *, SubCommand *> *
RHS) {
2296 return strcmp(
LHS->first,
RHS->first);
2312 if (
I->second->getOptionHiddenFlag() ==
Hidden && !ShowHidden)
2316 if (!OptionSet.
insert(
I->second).second)
2320 std::pair<const char *, Option *>(
I->getKey().data(),
I->second));
2330 for (
auto *S : SubMap) {
2331 if (S->getName().empty())
2333 Subs.push_back(std::make_pair(S->getName().data(), S));
2342 const bool ShowHidden;
2343 using StrOptionPairVector =
2345 using StrSubCommandPairVector =
2348 virtual void printOptions(StrOptionPairVector &Opts,
size_t MaxArgLen) {
2349 for (
const auto &Opt : Opts)
2353 void printSubCommands(StrSubCommandPairVector &Subs,
size_t MaxSubLen) {
2354 for (
const auto &S : Subs) {
2355 outs() <<
" " << S.first;
2356 if (!S.second->getDescription().empty()) {
2358 outs() <<
" - " << S.second->getDescription();
2365 explicit HelpPrinter(
bool showHidden) : ShowHidden(showHidden) {}
2366 virtual ~HelpPrinter() =
default;
2369 void operator=(
bool Value) {
2380 auto &OptionsMap =
Sub->OptionsMap;
2381 auto &PositionalOpts =
Sub->PositionalOpts;
2382 auto &ConsumeAfterOpt =
Sub->ConsumeAfterOpt;
2384 StrOptionPairVector Opts;
2385 sortOpts(OptionsMap, Opts, ShowHidden);
2387 StrSubCommandPairVector Subs;
2396 outs() <<
" [subcommand]";
2397 outs() <<
" [options]";
2399 if (!
Sub->getDescription().empty()) {
2400 outs() <<
"SUBCOMMAND '" <<
Sub->getName()
2401 <<
"': " <<
Sub->getDescription() <<
"\n\n";
2407 for (
auto *Opt : PositionalOpts) {
2414 if (ConsumeAfterOpt)
2415 outs() <<
" " << ConsumeAfterOpt->HelpStr;
2419 size_t MaxSubLen = 0;
2420 for (
const auto &
Sub : Subs)
2421 MaxSubLen = std::max(MaxSubLen, strlen(
Sub.first));
2424 outs() <<
"SUBCOMMANDS:\n\n";
2425 printSubCommands(Subs, MaxSubLen);
2428 <<
" <subcommand> --help\" to get more help on a specific "
2435 size_t MaxArgLen = 0;
2436 for (
const auto &Opt : Opts)
2439 outs() <<
"OPTIONS:\n";
2440 printOptions(Opts, MaxArgLen);
2449class CategorizedHelpPrinter :
public HelpPrinter {
2451 explicit CategorizedHelpPrinter(
bool showHidden) : HelpPrinter(showHidden) {}
2457 static int OptionCategoryCompare(OptionCategory *
const *
A,
2458 OptionCategory *
const *
B) {
2459 return (*A)->getName().compare((*B)->getName());
2463 using HelpPrinter::operator=;
2466 void printOptions(StrOptionPairVector &Opts,
size_t MaxArgLen)
override {
2467 std::vector<OptionCategory *> SortedCategories;
2468 DenseMap<OptionCategory *, std::vector<Option *>> CategorizedOptions;
2476 assert(SortedCategories.size() > 0 &&
"No option categories registered!");
2478 OptionCategoryCompare);
2483 for (
const auto &
I : Opts) {
2485 for (OptionCategory *Cat : Opt->
Categories) {
2487 "Option has an unregistered category");
2488 CategorizedOptions[Cat].push_back(Opt);
2493 for (OptionCategory *Category : SortedCategories) {
2495 const auto &CategoryOptions = CategorizedOptions[Category];
2496 if (CategoryOptions.empty())
2510 for (
const Option *Opt : CategoryOptions)
2518class HelpPrinterWrapper {
2520 HelpPrinter &UncategorizedPrinter;
2521 CategorizedHelpPrinter &CategorizedPrinter;
2524 explicit HelpPrinterWrapper(HelpPrinter &UncategorizedPrinter,
2525 CategorizedHelpPrinter &CategorizedPrinter)
2526 : UncategorizedPrinter(UncategorizedPrinter),
2527 CategorizedPrinter(CategorizedPrinter) {}
2530 void operator=(
bool Value);
2535#if defined(__GNUC__)
2538# if defined(__OPTIMIZE__)
2539# define LLVM_IS_DEBUG_BUILD 0
2541# define LLVM_IS_DEBUG_BUILD 1
2543#elif defined(_MSC_VER)
2548# define LLVM_IS_DEBUG_BUILD 1
2550# define LLVM_IS_DEBUG_BUILD 0
2554# define LLVM_IS_DEBUG_BUILD 0
2558class VersionPrinter {
2560 void print(std::vector<VersionPrinterTy> ExtraPrinters = {}) {
2562#ifdef PACKAGE_VENDOR
2563 OS << PACKAGE_VENDOR <<
" ";
2565 OS <<
"LLVM (http://llvm.org/):\n ";
2567 OS << PACKAGE_NAME <<
" version " << PACKAGE_VERSION <<
"\n ";
2568#if LLVM_IS_DEBUG_BUILD
2569 OS <<
"DEBUG build";
2571 OS <<
"Optimized build";
2574 OS <<
" with assertions";
2580 if (!ExtraPrinters.empty()) {
2581 for (
const auto &
I : ExtraPrinters)
2585 void operator=(
bool OptionWasSpecified);
2588struct CommandLineCommonOptions {
2591 HelpPrinter UncategorizedNormalPrinter{
false};
2592 HelpPrinter UncategorizedHiddenPrinter{
true};
2593 CategorizedHelpPrinter CategorizedNormalPrinter{
false};
2594 CategorizedHelpPrinter CategorizedHiddenPrinter{
true};
2597 HelpPrinterWrapper WrappedNormalPrinter{UncategorizedNormalPrinter,
2598 CategorizedNormalPrinter};
2599 HelpPrinterWrapper WrappedHiddenPrinter{UncategorizedHiddenPrinter,
2600 CategorizedHiddenPrinter};
2610 "Display list of available options (--help-list-hidden for more)"),
2619 cl::desc(
"Display list of all available options"),
2631 cl::desc(
"Display available options (--help-hidden for more)"),
2642 cl::desc(
"Display all available options"),
2651 cl::desc(
"Print non-default options after command line parsing"),
2658 "print-all-options",
2659 cl::desc(
"Print all option values after command line parsing"),
2667 std::vector<VersionPrinterTy> ExtraVersionPrinters;
2670 VersionPrinter VersionPrinterInstance;
2673 "version",
cl::desc(
"Display the version of this program"),
2698 return GeneralCategory;
2701void VersionPrinter::operator=(
bool OptionWasSpecified) {
2702 if (!OptionWasSpecified)
2714void HelpPrinterWrapper::operator=(
bool Value) {
2721 if (
GlobalParser->RegisteredOptionCategories.size() > 1) {
2726 CategorizedPrinter =
true;
2728 UncategorizedPrinter =
true;
2735void CommandLineParser::printOptionValues() {
2743 size_t MaxArgLen = 0;
2744 for (
const auto &Opt : Opts)
2747 for (
const auto &Opt : Opts)
2753 if (!
Hidden && !Categorized)
2755 else if (!
Hidden && Categorized)
2757 else if (
Hidden && !Categorized)
2769#if LLVM_IS_DEBUG_BUILD
2775#ifdef EXPENSIVE_CHECKS
2776 "+expensive-checks",
2778#if __has_feature(address_sanitizer)
2781#if __has_feature(dataflow_sanitizer)
2784#if __has_feature(hwaddress_sanitizer)
2787#if __has_feature(memory_sanitizer)
2790#if __has_feature(thread_sanitizer)
2793#if __has_feature(undefined_behavior_sanitizer)
2802#if LLVM_VERSION_PRINTER_SHOW_BUILD_CONFIG
2803 OS <<
"Build config: ";
2827 return Sub.OptionsMap;
2837 for (
auto &
I :
Sub.OptionsMap) {
2838 bool Unrelated =
true;
2839 for (
auto &Cat :
I.second->Categories) {
2840 if (Cat == &Category || Cat == &
CommonOptions->GenericCategory)
2851 for (
auto &
I :
Sub.OptionsMap) {
2852 bool Unrelated =
true;
2853 for (
auto &Cat :
I.second->Categories) {
2869 const char *Overview) {
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
This file defines the StringMap class.
static void print(raw_ostream &Out, object::Archive::Kind Kind, T Val)
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
static bool CommaSeparateAndAddOccurrence(Option *Handler, unsigned pos, StringRef ArgName, StringRef Value, bool MultiArg=false)
CommaSeparateAndAddOccurrence - A wrapper around Handler->addOccurrence() that does special handling ...
static StringRef OptionPrefix
static bool RequiresValue(const Option *O)
static int SubNameCompare(const std::pair< const char *, SubCommand * > *LHS, const std::pair< const char *, SubCommand * > *RHS)
static size_t argPlusPrefixesSize(StringRef ArgName, size_t Pad=DefaultPad)
static bool isPrefixedOrGrouping(const Option *O)
static bool shouldPrintOption(StringRef Name, StringRef Description, const Option &O)
static ManagedStatic< SubCommand > AllSubCommands
static Option * HandlePrefixedOrGroupedOption(StringRef &Arg, StringRef &Value, bool &ErrorParsing, const StringMap< Option * > &OptionsMap)
HandlePrefixedOrGroupedOption - The specified argument string (which started with at least one '-') d...
static bool parseDouble(Option &O, StringRef Arg, double &Value)
static bool parseBool(Option &O, StringRef ArgName, StringRef Arg, T &Value)
static const size_t DefaultPad
static StringRef EmptyOption
static bool hasUTF8ByteOrderMark(ArrayRef< char > S)
static ManagedStatic< CommandLineParser > GlobalParser
static void ExpandBasePaths(StringRef BasePath, StringSaver &Saver, const char *&Arg)
static SmallString< 8 > argPrefix(StringRef ArgName, size_t Pad=DefaultPad)
static StringRef ArgHelpPrefix
void opt_unsigned_anchor()
static bool isWindowsSpecialCharInCommandName(char C)
static Option * getOptionPred(StringRef Name, size_t &Length, bool(*Pred)(const Option *), const StringMap< Option * > &OptionsMap)
static StringRef getValueStr(const Option &O, StringRef DefaultMsg)
static size_t getOptionPrefixesSize()
static bool ProvideOption(Option *Handler, StringRef ArgName, StringRef Value, int argc, const char *const *argv, int &i)
ProvideOption - For Value, this differentiates between an empty value ("") and a null value (StringRe...
static bool isQuote(char C)
static ManagedStatic< CommandLineCommonOptions > CommonOptions
static void initCommonOptions()
static void tokenizeWindowsCommandLineImpl(StringRef Src, StringSaver &Saver, function_ref< void(StringRef)> AddToken, bool AlwaysCopy, function_ref< void()> MarkEOL, bool InitialCommandName)
static bool isWhitespace(char C)
static LLVM_REQUIRE_CONSTANT_INITIALIZATION ManagedStatic< SubCommand > TopLevelSubCommand
static size_t parseBackslash(StringRef Src, size_t I, SmallString< 128 > &Token)
Backslashes are interpreted in a rather complicated way in the Windows-style command line,...
static StringRef ArgPrefixLong
static void sortSubCommands(const SmallPtrSetImpl< SubCommand * > &SubMap, SmallVectorImpl< std::pair< const char *, SubCommand * > > &Subs)
#define PRINT_OPT_DIFF(T)
static bool isWhitespaceOrNull(char C)
static const size_t MaxOptWidth
static Option * LookupNearestOption(StringRef Arg, const StringMap< Option * > &OptionsMap, std::string &NearestString)
LookupNearestOption - Lookup the closest match to the option specified by the specified option on the...
static bool EatsUnboundedNumberOfValues(const Option *O)
static int OptNameCompare(const std::pair< const char *, Option * > *LHS, const std::pair< const char *, Option * > *RHS)
static void sortOpts(StringMap< Option * > &OptMap, SmallVectorImpl< std::pair< const char *, Option * > > &Opts, bool ShowHidden)
static StringRef ArgPrefix
static bool isWindowsSpecialChar(char C)
static bool isGrouping(const Option *O)
#define LLVM_REQUIRE_CONSTANT_INITIALIZATION
LLVM_REQUIRE_CONSTANT_INITIALIZATION - Apply this to globals to ensure that they are constant initial...
#define LLVM_EXPORT_TEMPLATE
static void Help(ArrayRef< StringRef > CPUNames, ArrayRef< SubtargetFeatureKV > FeatTable)
Display help for feature and mcpu choices.
Provides a library for accessing information about this process and other processes on the operating ...
This file defines the SmallPtrSet class.
This file defines the SmallString class.
Defines the virtual file system interface vfs::FileSystem.
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
size_t size() const
size - Get the array size.
Represents either an error or a value T.
std::error_code getError() const
Lightweight error class with error context and mandatory checking.
static ErrorSuccess success()
Create a success value.
ManagedStatic - This transparently changes the behavior of global statics to be lazily constructed on...
size_t getBufferSize() const
const char * getBufferEnd() const
const char * getBufferStart() const
A templated base class for SmallPtrSet which provides the typesafe interface that is common across al...
std::pair< iterator, bool > insert(PtrType Ptr)
Inserts Ptr if and only if there is no element in the container equal to Ptr.
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements.
SmallString - A SmallString is just a SmallVector with methods and accessors that make it work better...
void assign(StringRef RHS)
Assign from a StringRef.
void append(StringRef RHS)
Append from a StringRef.
StringRef str() const
Explicit conversion to StringRef.
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
void assign(size_type NumElts, ValueParamT Elt)
iterator erase(const_iterator CI)
void append(ItTy in_start, ItTy in_end)
Add the specified range to the end of the SmallVector.
iterator insert(iterator I, T &&Elt)
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
A wrapper around a string literal that serves as a proxy for constructing global tables of StringRefs...
StringMap - This is an unconventional map that is specialized for handling keys that are "strings",...
iterator find(StringRef Key)
StringMapIterBase< ValueTy, false > iterator
size_type count(StringRef Key) const
count - Return 1 if the element is in the map, 0 otherwise.
StringMapIterBase< ValueTy, true > const_iterator
StringRef - Represent a constant reference to a string, i.e.
std::pair< StringRef, StringRef > split(char Separator) const
Split into two substrings around the first occurrence of a separator character.
static constexpr size_t npos
bool getAsInteger(unsigned Radix, T &Result) const
Parse the current string as an integer of the specified radix.
constexpr StringRef substr(size_t Start, size_t N=npos) const
Return a reference to the substring from [Start, Start + N).
bool starts_with(StringRef Prefix) const
Check if this string starts with the given Prefix.
constexpr bool empty() const
empty - Check if the string is empty.
StringRef drop_front(size_t N=1) const
Return a StringRef equal to 'this' but with the first N elements dropped.
LLVM_ABI unsigned edit_distance(StringRef Other, bool AllowReplacements=true, unsigned MaxEditDistance=0) const
Determine the edit distance between this string and another string.
StringRef slice(size_t Start, size_t End) const
Return a reference to the substring from [Start, End).
constexpr size_t size() const
size - Get the string size.
constexpr const char * data() const
data - Get a pointer to the start of the string (which may not be null terminated).
bool consume_front(StringRef Prefix)
Returns true if this StringRef has the given prefix and removes that prefix.
size_t find(char C, size_t From=0) const
Search for the first character C in the string.
Saves strings in the provided stable storage and returns a StringRef with a stable character pointer.
BumpPtrAllocator & getAllocator() const
StringRef save(const char *S)
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
LLVM Value Representation.
Contains options that control response file expansion.
LLVM_ABI ExpansionContext(BumpPtrAllocator &A, TokenizerCallback T, vfs::FileSystem *FS=nullptr)
LLVM_ABI bool findConfigFile(StringRef FileName, SmallVectorImpl< char > &FilePath)
Looks for the specified configuration file.
LLVM_ABI Error expandResponseFiles(SmallVectorImpl< const char * > &Argv)
Expands constructs "@file" in the provided array of arguments recursively.
LLVM_ABI Error readConfigFile(StringRef CfgFile, SmallVectorImpl< const char * > &Argv)
Reads command line options from the given configuration file.
StringRef getDescription() const
StringRef getName() const
SmallPtrSet< SubCommand *, 1 > Subs
int getNumOccurrences() const
enum ValueExpected getValueExpectedFlag() const
void addCategory(OptionCategory &C)
virtual bool addOccurrence(unsigned pos, StringRef ArgName, StringRef Value, bool MultiArg=false)
void setMiscFlag(enum MiscFlags M)
enum FormattingFlags getFormattingFlag() const
virtual void printOptionInfo(size_t GlobalWidth) const =0
enum NumOccurrencesFlag getNumOccurrencesFlag() const
SmallVector< OptionCategory *, 1 > Categories
bool error(const Twine &Message, StringRef ArgName=StringRef(), raw_ostream &Errs=llvm::errs())
void setArgStr(StringRef S)
bool isDefaultOption() const
unsigned getMiscFlags() const
virtual void setDefault()=0
virtual void printOptionValue(size_t GlobalWidth, bool Force) const =0
static void printEnumValHelpStr(StringRef HelpStr, size_t Indent, size_t FirstLineIndentedBy)
unsigned getNumAdditionalVals() const
void removeArgument()
Unregisters this option from the CommandLine system.
static void printHelpStr(StringRef HelpStr, size_t Indent, size_t FirstLineIndentedBy)
virtual size_t getOptionWidth() const =0
StringRef getName() const
SubCommand(StringRef Name, StringRef Description="")
SmallVector< Option *, 4 > SinkOpts
static LLVM_ABI SubCommand & getTopLevel()
LLVM_ABI void unregisterSubCommand()
static LLVM_ABI SubCommand & getAll()
LLVM_ABI void registerSubCommand()
SmallVector< Option *, 4 > PositionalOpts
StringMap< Option * > OptionsMap
void printOptionInfo(const Option &O, size_t GlobalWidth) const
virtual StringRef getValueName() const
void printOptionNoValue(const Option &O, size_t GlobalWidth) const
size_t getOptionWidth(const Option &O) const
void printOptionName(const Option &O, size_t GlobalWidth) const
virtual size_t getOptionWidth(const Option &O) const
virtual StringRef getDescription(unsigned N) const =0
virtual const GenericOptionValue & getOptionValue(unsigned N) const =0
virtual unsigned getNumOptions() const =0
virtual StringRef getOption(unsigned N) const =0
void printOptionDiff(const Option &O, const AnyOptionValue &V, const AnyOptionValue &Default, size_t GlobalWidth) const
void printGenericOptionDiff(const Option &O, const GenericOptionValue &V, const GenericOptionValue &Default, size_t GlobalWidth) const
virtual void printOptionInfo(const Option &O, size_t GlobalWidth) const
unsigned findOption(StringRef Name)
bool parse(Option &O, StringRef ArgName, StringRef Arg, DataType &V)
An efficient, type-erasing, non-owning reference to a callable.
A range adaptor for a pair of iterators.
This class implements an extremely fast bulk output stream that can only output to a stream.
raw_ostream & indent(unsigned NumSpaces)
indent - Insert 'NumSpaces' spaces.
static LLVM_ABI std::optional< std::string > GetEnv(StringRef name)
The virtual file system interface.
The result of a status operation.
LLVM_ABI bool equivalent(const Status &Other) const
LLVM_C_ABI void LLVMParseCommandLineOptions(int argc, const char *const *argv, const char *Overview)
This function parses the given arguments using the LLVM command line parser.
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
@ C
The default llvm calling convention, compatible with C.
constexpr size_t NameSize
This namespace contains all of the command line option processing machinery.
LLVM_ABI iterator_range< SmallPtrSet< SubCommand *, 4 >::iterator > getRegisteredSubcommands()
Use this to get all registered SubCommands from the provided parser.
LLVM_ABI void PrintVersionMessage()
Utility function for printing version number.
LLVM_ABI bool ExpandResponseFiles(StringSaver &Saver, TokenizerCallback Tokenizer, SmallVectorImpl< const char * > &Argv)
A convenience helper which supports the typical use case of expansion function call.
LLVM_ABI void TokenizeWindowsCommandLine(StringRef Source, StringSaver &Saver, SmallVectorImpl< const char * > &NewArgv, bool MarkEOLs=false)
Tokenizes a string of Windows command line arguments, which may contain quotes and escaped quotes.
LLVM_ABI OptionCategory & getGeneralCategory()
LLVM_ABI void ResetAllOptionOccurrences()
Reset all command line options to a state that looks as if they have never appeared on the command li...
LLVM_ABI void SetVersionPrinter(VersionPrinterTy func)
===------------------------------------------------------------------—===// Override the default (LLV...
LLVM_ABI void tokenizeConfigFile(StringRef Source, StringSaver &Saver, SmallVectorImpl< const char * > &NewArgv, bool MarkEOLs=false)
Tokenizes content of configuration file.
LLVM_ABI StringMap< Option * > & getRegisteredOptions(SubCommand &Sub=SubCommand::getTopLevel())
Use this to get a StringMap to all registered named options (e.g.
LLVM_ABI void ResetCommandLineParser()
Reset the command line parser back to its initial state.
LLVM_ABI void PrintOptionValues()
LLVM_ABI void AddLiteralOption(Option &O, StringRef Name)
Adds a new option for parsing and provides the option it refers to.
void printOptionDiff(const Option &O, const generic_parser_base &P, const DT &V, const OptionValue< DT > &Default, size_t GlobalWidth)
LLVM_ABI void TokenizeWindowsCommandLineNoCopy(StringRef Source, StringSaver &Saver, SmallVectorImpl< StringRef > &NewArgv)
Tokenizes a Windows command line while attempting to avoid copies.
LLVM_ABI void printBuildConfig(raw_ostream &OS)
Prints the compiler build configuration.
void(*)(StringRef Source, StringSaver &Saver, SmallVectorImpl< const char * > &NewArgv, bool MarkEOLs) TokenizerCallback
String tokenization function type.
LLVM_ABI bool ProvidePositionalOption(Option *Handler, StringRef Arg, int i)
Parses Arg into the option handler Handler.
LLVM_ABI bool expandResponseFiles(int Argc, const char *const *Argv, const char *EnvVar, SmallVectorImpl< const char * > &NewArgv)
A convenience helper which concatenates the options specified by the environment variable EnvVar and ...
initializer< Ty > init(const Ty &Val)
std::function< void(raw_ostream &)> VersionPrinterTy
LLVM_ABI ArrayRef< StringRef > getCompilerBuildConfig()
An array of optional enabled settings in the LLVM build configuration, which may be of interest to co...
LocationClass< Ty > location(Ty &L)
LLVM_ABI void HideUnrelatedOptions(cl::OptionCategory &Category, SubCommand &Sub=SubCommand::getTopLevel())
Mark all options not part of this category as cl::ReallyHidden.
LLVM_ABI void AddExtraVersionPrinter(VersionPrinterTy func)
===------------------------------------------------------------------—===// Add an extra printer to u...
LLVM_ABI void PrintHelpMessage(bool Hidden=false, bool Categorized=false)
This function just prints the help message, exactly the same way as if the -help or -help-hidden opti...
LLVM_ABI void TokenizeWindowsCommandLineFull(StringRef Source, StringSaver &Saver, SmallVectorImpl< const char * > &NewArgv, bool MarkEOLs=false)
Tokenizes a Windows full command line, including command name at the start.
LLVM_ABI bool ParseCommandLineOptions(int argc, const char *const *argv, StringRef Overview="", raw_ostream *Errs=nullptr, vfs::FileSystem *VFS=nullptr, const char *EnvVar=nullptr, bool LongOptionsUseDoubleDash=false)
LLVM_ABI void TokenizeGNUCommandLine(StringRef Source, StringSaver &Saver, SmallVectorImpl< const char * > &NewArgv, bool MarkEOLs=false)
Tokenizes a command line that can contain escapes and quotes.
LLVM_ABI StringRef parent_path(StringRef path LLVM_LIFETIME_BOUND, Style style=Style::native)
Get parent path.
LLVM_ABI bool has_parent_path(const Twine &path, Style style=Style::native)
Has parent path?
LLVM_ABI bool is_relative(const Twine &path, Style style=Style::native)
Is path relative?
LLVM_ABI StringRef filename(StringRef path LLVM_LIFETIME_BOUND, Style style=Style::native)
Get filename.
LLVM_ABI bool is_absolute(const Twine &path, Style style=Style::native)
Is path absolute?
LLVM_ABI void append(SmallVectorImpl< char > &path, const Twine &a, const Twine &b="", const Twine &c="", const Twine &d="")
Append to path.
LLVM_ABI IntrusiveRefCntPtr< FileSystem > getRealFileSystem()
Gets an vfs::FileSystem for the 'real' file system, as seen by the operating system.
This is an optimization pass for GlobalISel generic memory operations.
auto drop_begin(T &&RangeOrContainer, size_t N=1)
Return a range covering RangeOrContainer with the first N elements excluded.
FunctionAddr VTableAddr Value
void initWithColorOptions()
Printable print(const GCNRegPressure &RP, const GCNSubtarget *ST=nullptr, unsigned DynamicVGPRBlockSize=0)
auto size(R &&Range, std::enable_if_t< std::is_base_of< std::random_access_iterator_tag, typename std::iterator_traits< decltype(Range.begin())>::iterator_category >::value, void > *=nullptr)
Get the size of a range.
LLVM_ABI raw_fd_ostream & outs()
This returns a reference to a raw_fd_ostream for standard output.
iterator_range< T > make_range(T x, T y)
Convenience function for iterating over sub-ranges.
void append_range(Container &C, Range &&R)
Wrapper function to append range R to container C.
void interleaveComma(const Container &c, StreamT &os, UnaryFunctor each_fn)
LLVM_ABI bool hasUTF16ByteOrderMark(ArrayRef< char > SrcBytes)
Returns true if a blob of text starts with a UTF-16 big or little endian byte order mark.
void initDebugCounterOptions()
Error createStringError(std::error_code EC, char const *Fmt, const Ts &... Vals)
Create formatted StringError object.
bool to_float(const Twine &T, float &Num)
@ no_such_file_or_directory
decltype(auto) get(const PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info > &Pair)
LLVM_ABI raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
LLVM_ABI void report_fatal_error(Error Err, bool gen_crash_diag=true)
LLVM_ABI bool convertUTF16ToUTF8String(ArrayRef< char > SrcBytes, std::string &Out)
Converts a stream of raw bytes assumed to be UTF16 into a UTF8 std::string.
void initSignalsOptions()
void initStatisticOptions()
LLVM_ABI raw_ostream & nulls()
This returns a reference to a raw_ostream which simply discards output.
class LLVM_GSL_OWNER SmallVector
Forward declaration of SmallVector so that calculateSmallVectorDefaultInlinedElements can reference s...
Error make_error(ArgTs &&... Args)
Make a Error instance representing failure using the given error info type.
LLVM_ABI raw_fd_ostream & errs()
This returns a reference to a raw_ostream for standard error.
void initRandomSeedOptions()
@ Sub
Subtraction of integers.
void initGraphWriterOptions()
raw_ostream & operator<<(raw_ostream &OS, const APFixedPoint &FX)
ArrayRef(const T &OneElt) -> ArrayRef< T >
std::string toString(const APInt &I, unsigned Radix, bool Signed, bool formatAsCLiteral=false, bool UpperCase=true, bool InsertSeparators=false)
auto count_if(R &&Range, UnaryPredicate P)
Wrapper function around std::count_if to count the number of times an element satisfying a given pred...
bool is_contained(R &&Range, const E &Element)
Returns true if Element is found in Range.
void array_pod_sort(IteratorTy Start, IteratorTy End)
array_pod_sort - This sorts an array with the specified start and end extent.
BumpPtrAllocatorImpl<> BumpPtrAllocator
The standard BumpPtrAllocator which just uses the default template parameters.
@ Default
The result values are uniform if and only if all operands are uniform.