31#include "llvm/Config/config.h"
42#include "llvm/Support/VCSRevision.h"
51#define DEBUG_TYPE "commandline"
80void GenericOptionValue::anchor() {}
83void Option::anchor() {}
107 size_t Len = ArgName.
size();
115 for (
size_t I = 0;
I < Pad; ++
I) {
143 OS <<
argPrefix(Arg.ArgName, Arg.Pad) << Arg.ArgName;
147class CommandLineParser {
151 std::string ProgramName;
155 std::vector<StringRef> MoreHelp;
174 bool LongOptionsUseDoubleDash =
false);
177 if (Opt.
Subs.empty()) {
182 for (
auto *SC : RegisteredSubCommands)
187 for (
auto *SC : Opt.
Subs) {
189 "SubCommand::getAll() should not be used with other subcommands");
197 if (!
SC->OptionsMap.insert(std::make_pair(
Name, &Opt)).second) {
198 errs() << ProgramName <<
": CommandLine Error: Option '" <<
Name
199 <<
"' registered more than once!\n";
210 bool HadErrors =
false;
211 if (
O->hasArgStr()) {
213 if (
O->isDefaultOption() &&
SC->OptionsMap.contains(
O->ArgStr))
217 if (!
SC->OptionsMap.insert(std::make_pair(
O->ArgStr, O)).second) {
218 errs() << ProgramName <<
": CommandLine Error: Option '" <<
O->ArgStr
219 <<
"' registered more than once!\n";
226 SC->PositionalOpts.push_back(O);
228 SC->SinkOpts.push_back(O);
230 if (
SC->ConsumeAfterOpt) {
231 O->error(
"Cannot specify more than one option with cl::ConsumeAfter!");
234 SC->ConsumeAfterOpt =
O;
245 void addOption(
Option *O,
bool ProcessDefaultOption =
false) {
246 if (!ProcessDefaultOption &&
O->isDefaultOption()) {
250 forEachSubCommand(*O, [&](
SubCommand &SC) { addOption(O, &SC); });
255 O->getExtraOptionNames(OptionNames);
261 for (
auto Name : OptionNames) {
263 if (
I !=
End &&
I->getValue() == O)
286 void removeOption(
Option *O) {
287 forEachSubCommand(*O, [&](
SubCommand &SC) { removeOption(O, &SC); });
290 bool hasOptions(
const SubCommand &Sub)
const {
295 bool hasOptions()
const {
296 for (
const auto *S : RegisteredSubCommands) {
303 bool hasNamedSubCommands()
const {
304 for (
const auto *S : RegisteredSubCommands)
305 if (!S->getName().empty())
310 SubCommand *getActiveSubCommand() {
return ActiveSubCommand; }
314 if (!Sub.
OptionsMap.insert(std::make_pair(NewName, O)).second) {
315 errs() << ProgramName <<
": CommandLine Error: Option '" <<
O->ArgStr
316 <<
"' registered more than once!\n";
323 forEachSubCommand(*O,
324 [&](
SubCommand &SC) { updateArgStr(O, NewName, &SC); });
327 void printOptionValues();
334 "Duplicate option categories");
342 return (!
sub->getName().empty()) &&
345 "Duplicate subcommands");
346 RegisteredSubCommands.insert(
sub);
351 "SubCommand::getAll() should not be registered");
354 if ((
O->isPositional() ||
O->isSink() ||
O->isConsumeAfter()) ||
358 addLiteralOption(*O,
sub,
E.first());
363 RegisteredSubCommands.erase(
sub);
368 return make_range(RegisteredSubCommands.begin(),
369 RegisteredSubCommands.end());
373 ActiveSubCommand =
nullptr;
378 RegisteredOptionCategories.
clear();
381 RegisteredSubCommands.clear();
387 DefaultOptions.
clear();
395 bool LongOptionsUseDoubleDash,
bool HaveDoubleDash) {
397 if (Opt && LongOptionsUseDoubleDash && !HaveDoubleDash && !
isGrouping(Opt))
418 FullyInitialized =
true;
424 if (FullyInitialized)
450void OptionCategory::registerCategory() {
484SubCommand::operator
bool()
const {
502 size_t EqualPos = Arg.
find(
'=');
522 Arg = Arg.
substr(0, EqualPos);
527 std::string &NearestString) {
532 for (
auto *S : RegisteredSubCommands) {
534 "SubCommand::getAll() is not expected in RegisteredSubCommands");
535 if (S->getName().empty())
541 if (!NearestMatch && S->getName().edit_distance(
Name) < 2)
546 NearestString = NearestMatch->
getName();
557 std::string &NearestString) {
563 std::pair<StringRef, StringRef> SplitArg = Arg.
split(
'=');
569 unsigned BestDistance = 0;
571 ie = OptionsMap.
end();
579 O->getExtraOptionNames(OptionNames);
585 for (
const auto &
Name : OptionNames) {
587 Flag,
true, BestDistance);
588 if (!Best || Distance < BestDistance) {
590 BestDistance = Distance;
591 if (
RHS.empty() || !PermitValue)
592 NearestString = std::string(
Name);
606 bool MultiArg =
false) {
618 Val = Val.
substr(Pos + 1);
634 const char *
const *argv,
int &i) {
645 return Handler->
error(
"requires a value!");
647 assert(argv &&
"null check");
652 if (NumAdditionalVals > 0)
653 return Handler->
error(
"multi-valued option specified"
654 " with ValueDisallowed modifier!");
665 if (NumAdditionalVals == 0)
669 bool MultiArg =
false;
678 while (NumAdditionalVals > 0) {
680 return Handler->
error(
"not enough values!");
681 assert(argv &&
"null check");
704 bool (*Pred)(
const Option *),
707 if (OMI != OptionsMap.
end() && !Pred(OMI->getValue()))
708 OMI = OptionsMap.
end();
713 while (OMI == OptionsMap.
end() &&
Name.size() > 1) {
716 if (OMI != OptionsMap.
end() && !Pred(OMI->getValue()))
717 OMI = OptionsMap.
end();
720 if (OMI != OptionsMap.
end() && Pred(OMI->second)) {
748 assert(OptionsMap.
count(Arg) && OptionsMap.
find(Arg)->second == PGOpt);
758 if (MaybeValue[0] ==
'=') {
768 ErrorParsing |= PGOpt->
error(
"may not occur within a group!");
797 return C ==
' ' ||
C ==
'\t' ||
C ==
'\r' ||
C ==
'\n';
804static bool isQuote(
char C) {
return C ==
'\"' ||
C ==
'\''; }
810 for (
size_t I = 0,
E = Src.size();
I !=
E; ++
I) {
815 if (MarkEOLs && Src[
I] ==
'\n')
826 if (
I + 1 <
E &&
C ==
'\\') {
835 while (
I !=
E && Src[
I] !=
C) {
837 if (Src[
I] ==
'\\' &&
I + 1 !=
E)
852 if (MarkEOLs &&
C ==
'\n')
885 size_t E = Src.size();
886 int BackslashCount = 0;
891 }
while (
I !=
E && Src[
I] ==
'\\');
893 bool FollowedByDoubleQuote = (
I !=
E && Src[
I] ==
'"');
894 if (FollowedByDoubleQuote) {
895 Token.
append(BackslashCount / 2,
'\\');
896 if (BackslashCount % 2 == 0)
901 Token.
append(BackslashCount,
'\\');
919 bool AlwaysCopy,
function_ref<
void()> MarkEOL,
bool InitialCommandName) {
928 bool CommandName = InitialCommandName;
931 enum {
INIT, UNQUOTED, QUOTED } State =
INIT;
933 for (
size_t I = 0,
E = Src.size();
I <
E; ++
I) {
936 assert(Token.
empty() &&
"token should be empty in initial state");
958 AddToken(AlwaysCopy ? Saver.
save(NormalChars) : NormalChars);
959 if (
I <
E && Src[
I] ==
'\n') {
961 CommandName = InitialCommandName;
965 }
else if (Src[
I] ==
'\"') {
966 Token += NormalChars;
968 }
else if (Src[
I] ==
'\\') {
969 assert(!CommandName &&
"or else we'd have treated it as a normal char");
970 Token += NormalChars;
984 AddToken(Saver.
save(Token.
str()));
986 if (Src[
I] ==
'\n') {
987 CommandName = InitialCommandName;
993 }
else if (Src[
I] ==
'\"') {
995 }
else if (Src[
I] ==
'\\' && !CommandName) {
1003 if (Src[
I] ==
'\"') {
1004 if (
I < (
E - 1) && Src[
I + 1] ==
'"') {
1013 }
else if (Src[
I] ==
'\\' && !CommandName) {
1023 AddToken(Saver.
save(Token.
str()));
1030 auto OnEOL = [&]() {
1035 true, OnEOL,
false);
1041 auto OnEOL = []() {};
1050 auto OnEOL = [&]() {
1061 for (
const char *Cur = Source.begin(); Cur != Source.end();) {
1070 while (Cur != Source.end() && *Cur !=
'\n')
1075 const char *Start = Cur;
1076 for (
const char *
End = Source.end(); Cur !=
End; ++Cur) {
1078 if (Cur + 1 !=
End) {
1081 (*Cur ==
'\r' && (Cur + 1 !=
End) && Cur[1] ==
'\n')) {
1082 Line.append(Start, Cur - 1);
1088 }
else if (*Cur ==
'\n')
1092 Line.append(Start, Cur);
1100 return (S.
size() >= 3 && S[0] ==
'\xef' && S[1] ==
'\xbb' && S[2] ==
'\xbf');
1114 TokenPos = ArgString.
find(Token, StartPos)) {
1118 if (ResponseFile.
empty())
1122 ResponseFile.
append(BasePath);
1123 StartPos = TokenPos + Token.
size();
1126 if (!ResponseFile.
empty()) {
1129 if (!Remaining.
empty())
1136Error ExpansionContext::expandResponseFile(
1144 "': " +
EC.message());
1151 std::string UTF8Buf;
1155 "Could not convert UTF16 to UTF8");
1162 Str =
StringRef(BufRef.data() + 3, BufRef.size() - 3);
1165 Tokenizer(Str, Saver, NewArgv, MarkEOLs);
1170 if (!RelativeNames && !InConfigFile)
1174 for (
const char *&Arg : NewArgv) {
1186 bool ConfigInclusion =
false;
1187 if (ArgStr.consume_front(
"@")) {
1191 }
else if (ArgStr.consume_front(
"--config=")) {
1193 ConfigInclusion =
true;
1205 std::make_error_code(std::errc::no_such_file_or_directory),
1206 "cannot not find configuration file: " + FileName);
1207 ResponseFile.
append(FilePath);
1209 ResponseFile.
append(BasePath);
1221 struct ResponseFileRecord {
1236 for (
unsigned I = 0;
I != Argv.
size();) {
1237 while (
I == FileStack.
back().End) {
1243 const char *Arg = Argv[
I];
1245 if (Arg ==
nullptr) {
1250 if (Arg[0] !=
'@') {
1255 const char *FName = Arg + 1;
1260 if (CurrentDir.
empty()) {
1265 CWD.getError(),
Twine(
"cannot get absolute path for: ") + FName);
1268 CurrDir = CurrentDir;
1271 FName = CurrDir.
c_str();
1275 if (!Res || !Res->exists()) {
1276 std::error_code EC = Res.
getError();
1277 if (!InConfigFile) {
1288 "': " + EC.message());
1293 [FileStatus,
this](
const ResponseFileRecord &RFile) ->
ErrorOr<bool> {
1296 return RHS.getError();
1305 R.getError(),
Twine(
"recursive expansion of: '") +
F.File +
"'");
1308 Twine(
"cannot open file: ") +
F.File);
1315 if (
Error Err = expandResponseFile(FName, ExpandedArgv))
1318 for (ResponseFileRecord &
Record : FileStack) {
1324 FileStack.push_back({FName,
I + ExpandedArgv.
size()});
1349 Tokenize(*EnvValue, Saver, NewArgv,
false);
1352 NewArgv.
append(Argv + 1, Argv + Argc);
1372 : Saver(
A), Tokenizer(
T), FS(vfs::getRealFileSystem().
get()) {}
1386 CfgFilePath = FileName;
1389 if (!FileExists(CfgFilePath))
1396 for (
const StringRef &Dir : SearchDirs) {
1402 if (FileExists(CfgFilePath)) {
1417 return make_error<StringError>(
1418 EC,
Twine(
"cannot get absolute path for " + CfgFile));
1419 CfgFile = AbsPath.
str();
1421 InConfigFile =
true;
1422 RelativeNames =
true;
1423 if (
Error Err = expandResponseFile(CfgFile, Argv))
1432 bool LongOptionsUseDoubleDash) {
1441 if (std::optional<std::string> EnvValue =
1447 for (
int I = 1;
I < argc; ++
I)
1449 int NewArgc =
static_cast<int>(NewArgv.
size());
1452 return GlobalParser->ParseCommandLineOptions(NewArgc, &NewArgv[0], Overview,
1453 Errs, LongOptionsUseDoubleDash);
1457void CommandLineParser::ResetAllOptionOccurrences() {
1461 for (
auto *SC : RegisteredSubCommands) {
1462 for (
auto &O : SC->OptionsMap)
1464 for (
Option *O : SC->PositionalOpts)
1466 for (
Option *O : SC->SinkOpts)
1468 if (SC->ConsumeAfterOpt)
1469 SC->ConsumeAfterOpt->reset();
1473bool CommandLineParser::ParseCommandLineOptions(
int argc,
1474 const char *
const *argv,
1477 bool LongOptionsUseDoubleDash) {
1478 assert(hasOptions() &&
"No options specified!");
1480 ProgramOverview = Overview;
1481 bool IgnoreErrors = Errs;
1484 bool ErrorParsing =
false;
1495 if (
Error Err = ECtx.expandResponseFiles(newArgv)) {
1496 *Errs <<
toString(std::move(Err)) <<
'\n';
1500 argc =
static_cast<int>(newArgv.size());
1506 unsigned NumPositionalRequired = 0;
1509 bool HasUnlimitedPositionals =
false;
1513 std::string NearestSubCommandString;
1514 bool MaybeNamedSubCommand =
1515 argc >= 2 && argv[FirstArg][0] !=
'-' && hasNamedSubCommands();
1516 if (MaybeNamedSubCommand) {
1520 LookupSubCommand(
StringRef(argv[FirstArg]), NearestSubCommandString);
1526 assert(ChosenSubCommand);
1529 auto &SinkOpts = ChosenSubCommand->
SinkOpts;
1530 auto &OptionsMap = ChosenSubCommand->
OptionsMap;
1532 for (
auto *O: DefaultOptions) {
1536 if (ConsumeAfterOpt) {
1537 assert(PositionalOpts.size() > 0 &&
1538 "Cannot specify cl::ConsumeAfter without a positional argument!");
1540 if (!PositionalOpts.empty()) {
1543 bool UnboundedFound =
false;
1544 for (
size_t i = 0, e = PositionalOpts.size(); i != e; ++i) {
1545 Option *Opt = PositionalOpts[i];
1547 ++NumPositionalRequired;
1548 else if (ConsumeAfterOpt) {
1551 if (PositionalOpts.size() > 1) {
1553 Opt->
error(
"error - this positional option will never be matched, "
1554 "because it does not Require a value, and a "
1555 "cl::ConsumeAfter option is active!");
1556 ErrorParsing =
true;
1558 }
else if (UnboundedFound && !Opt->
hasArgStr()) {
1564 Opt->
error(
"error - option can never match, because "
1565 "another positional argument will match an "
1566 "unbounded number of values, and this option"
1567 " does not require a value!");
1568 *Errs << ProgramName <<
": CommandLine Error: Option '" << Opt->
ArgStr
1569 <<
"' is all messed up!\n";
1570 *Errs << PositionalOpts.size();
1571 ErrorParsing =
true;
1575 HasUnlimitedPositionals = UnboundedFound || ConsumeAfterOpt;
1586 Option *ActivePositionalArg =
nullptr;
1589 bool DashDashFound =
false;
1590 for (
int i = FirstArg; i < argc; ++i) {
1591 Option *Handler =
nullptr;
1592 std::string NearestHandlerString;
1595 bool HaveDoubleDash =
false;
1601 if (argv[i][0] !=
'-' || argv[i][1] == 0 || DashDashFound) {
1603 if (ActivePositionalArg) {
1608 if (!PositionalOpts.empty()) {
1614 if (PositionalVals.
size() >= NumPositionalRequired && ConsumeAfterOpt) {
1615 for (++i; i < argc; ++i)
1623 }
else if (argv[i][0] ==
'-' && argv[i][1] ==
'-' && argv[i][2] == 0 &&
1625 DashDashFound =
true;
1627 }
else if (ActivePositionalArg &&
1635 HaveDoubleDash =
true;
1637 Handler = LookupLongOption(*ChosenSubCommand, ArgName,
Value,
1638 LongOptionsUseDoubleDash, HaveDoubleDash);
1647 HaveDoubleDash =
true;
1649 Handler = LookupLongOption(*ChosenSubCommand, ArgName,
Value,
1650 LongOptionsUseDoubleDash, HaveDoubleDash);
1657 LongOptionsUseDoubleDash, HaveDoubleDash);
1660 if (!Handler && !(LongOptionsUseDoubleDash && HaveDoubleDash))
1666 if (!Handler && SinkOpts.empty())
1671 if (!SinkOpts.empty()) {
1672 for (
Option *SinkOpt : SinkOpts)
1673 SinkOpt->addOccurrence(i,
"",
StringRef(argv[i]));
1677 auto ReportUnknownArgument = [&](
bool IsArg,
1679 *Errs << ProgramName <<
": Unknown "
1680 << (IsArg ?
"command line argument" :
"subcommand") <<
" '"
1681 << argv[i] <<
"'. Try: '" << argv[0] <<
" --help'\n";
1683 if (NearestArgumentName.empty())
1686 *Errs << ProgramName <<
": Did you mean '";
1688 *Errs << PrintArg(NearestArgumentName, 0);
1690 *Errs << NearestArgumentName;
1694 if (i > 1 || !MaybeNamedSubCommand)
1695 ReportUnknownArgument(
true, NearestHandlerString);
1697 ReportUnknownArgument(
false, NearestSubCommandString);
1699 ErrorParsing =
true;
1707 Handler->
error(
"This argument does not take a value.\n"
1708 "\tInstead, it consumes any positional arguments until "
1709 "the next recognized option.", *Errs);
1710 ErrorParsing =
true;
1712 ActivePositionalArg = Handler;
1719 if (NumPositionalRequired > PositionalVals.
size()) {
1720 *Errs << ProgramName
1721 <<
": Not enough positional command line arguments specified!\n"
1722 <<
"Must specify at least " << NumPositionalRequired
1723 <<
" positional argument" << (NumPositionalRequired > 1 ?
"s" :
"")
1724 <<
": See: " << argv[0] <<
" --help\n";
1726 ErrorParsing =
true;
1727 }
else if (!HasUnlimitedPositionals &&
1728 PositionalVals.
size() > PositionalOpts.size()) {
1729 *Errs << ProgramName <<
": Too many positional arguments specified!\n"
1730 <<
"Can specify at most " << PositionalOpts.size()
1731 <<
" positional arguments: See: " << argv[0] <<
" --help\n";
1732 ErrorParsing =
true;
1734 }
else if (!ConsumeAfterOpt) {
1736 unsigned ValNo = 0, NumVals =
static_cast<unsigned>(PositionalVals.
size());
1737 for (
size_t i = 0, e = PositionalOpts.size(); i !=
e; ++i) {
1740 PositionalVals[ValNo].second);
1742 --NumPositionalRequired;
1750 while (NumVals - ValNo > NumPositionalRequired && !
Done) {
1751 switch (PositionalOpts[i]->getNumOccurrencesFlag()) {
1758 PositionalVals[ValNo].first,
1759 PositionalVals[ValNo].second);
1764 "positional argument processing!");
1769 assert(ConsumeAfterOpt && NumPositionalRequired <= PositionalVals.
size());
1771 for (
size_t J = 0,
E = PositionalOpts.size(); J !=
E; ++J)
1774 PositionalVals[ValNo].first,
1775 PositionalVals[ValNo].second);
1784 if (PositionalOpts.size() == 1 && ValNo == 0 && !PositionalVals.
empty()) {
1786 PositionalVals[ValNo].first,
1787 PositionalVals[ValNo].second);
1793 for (; ValNo != PositionalVals.
size(); ++ValNo)
1796 PositionalVals[ValNo].second);
1800 for (
const auto &Opt : OptionsMap) {
1805 Opt.second->
error(
"must be specified at least once!");
1806 ErrorParsing =
true;
1818 for (
int i = 0; i < argc; ++i)
dbgs() << argv[i] <<
' ';
1839 if (!ArgName.
data())
1841 if (ArgName.
empty())
1844 Errs <<
GlobalParser->ProgramName <<
": for the " << PrintArg(ArgName, 0);
1846 Errs <<
" option: " << Message <<
"\n";
1855 return handleOccurrence(pos, ArgName,
Value);
1862 if (O.ValueStr.empty())
1872size_t alias::getOptionWidth()
const {
1877 size_t FirstLineIndentedBy) {
1878 assert(Indent >= FirstLineIndentedBy);
1879 std::pair<StringRef, StringRef> Split =
HelpStr.
split(
'\n');
1882 while (!Split.second.empty()) {
1883 Split = Split.second.split(
'\n');
1884 outs().
indent(Indent) << Split.first <<
"\n";
1889 size_t FirstLineIndentedBy) {
1891 assert(BaseIndent >= FirstLineIndentedBy);
1892 std::pair<StringRef, StringRef> Split =
HelpStr.
split(
'\n');
1893 outs().
indent(BaseIndent - FirstLineIndentedBy)
1895 while (!Split.second.empty()) {
1896 Split = Split.second.split(
'\n');
1897 outs().
indent(BaseIndent + ValHelpPrefix.
size()) << Split.first <<
"\n";
1902void alias::printOptionInfo(
size_t GlobalWidth)
const {
1918 if (!ValName.empty()) {
1919 size_t FormattingLen = 3;
1932 size_t GlobalWidth)
const {
1933 outs() << PrintArg(O.ArgStr);
1936 if (!ValName.empty()) {
1942 outs() << (O.ArgStr.size() == 1 ?
" <" :
"=<") <<
getValueStr(O, ValName)
1951 size_t GlobalWidth)
const {
1952 outs() << PrintArg(O.ArgStr);
1953 outs().
indent(GlobalWidth - O.ArgStr.size());
1960 if (Arg ==
"" || Arg ==
"true" || Arg ==
"TRUE" || Arg ==
"True" ||
1966 if (Arg ==
"false" || Arg ==
"FALSE" || Arg ==
"False" || Arg ==
"0") {
1970 return O.error(
"'" + Arg +
1971 "' is invalid value for boolean argument! Try 0 or 1");
1978 if (Arg ==
"" || Arg ==
"true" || Arg ==
"TRUE" || Arg ==
"True" ||
1983 if (Arg ==
"false" || Arg ==
"FALSE" || Arg ==
"False" || Arg ==
"0") {
1988 return O.error(
"'" + Arg +
1989 "' is invalid value for boolean argument! Try 0 or 1");
1997 return O.error(
"'" + Arg +
"' value invalid for integer argument!");
2006 return O.error(
"'" + Arg +
"' value invalid for long argument!");
2015 return O.error(
"'" + Arg +
"' value invalid for llong argument!");
2025 return O.error(
"'" + Arg +
"' value invalid for uint argument!");
2032 unsigned long &
Value) {
2035 return O.error(
"'" + Arg +
"' value invalid for ulong argument!");
2043 unsigned long long &
Value) {
2046 return O.error(
"'" + Arg +
"' value invalid for ullong argument!");
2053 if (to_float(Arg,
Value))
2055 return O.error(
"'" + Arg +
"' value invalid for floating point argument!");
2081 for (
unsigned i = 0; i != e; ++i) {
2098 !Description.
empty();
2103 if (O.hasArgStr()) {
2115 size_t BaseSize = 0;
2126 size_t GlobalWidth)
const {
2127 if (O.hasArgStr()) {
2133 outs() << PrintArg(O.ArgStr);
2152 if (OptionName.
empty()) {
2157 if (!Description.
empty())
2163 if (!O.HelpStr.empty())
2164 outs() <<
" " << O.HelpStr <<
'\n';
2181 outs() <<
" " << PrintArg(O.ArgStr);
2182 outs().
indent(GlobalWidth - O.ArgStr.size());
2185 for (
unsigned i = 0; i != NumOpts; ++i) {
2193 for (
unsigned j = 0; j != NumOpts; ++j) {
2202 outs() <<
"= *unknown option value*\n";
2207#define PRINT_OPT_DIFF(T) \
2208 void parser<T>::printOptionDiff(const Option &O, T V, OptionValue<T> D, \
2209 size_t GlobalWidth) const { \
2210 printOptionName(O, GlobalWidth); \
2213 raw_string_ostream SS(Str); \
2216 outs() << "= " << Str; \
2217 size_t NumSpaces = \
2218 MaxOptWidth > Str.size() ? MaxOptWidth - Str.size() : 0; \
2219 outs().indent(NumSpaces) << " (default: "; \
2221 outs() << D.getValue(); \
2223 outs() << "*no default*"; \
2241 size_t GlobalWidth)
const {
2242 printOptionName(O, GlobalWidth);
2243 outs() <<
"= " << V;
2247 outs() <<
D.getValue();
2249 outs() <<
"*no default*";
2255 size_t GlobalWidth)
const {
2257 outs() <<
"= *cannot print option value*\n";
2265 const std::pair<const char *, Option *> *RHS) {
2266 return strcmp(
LHS->first,
RHS->first);
2270 const std::pair<const char *, SubCommand *> *RHS) {
2271 return strcmp(
LHS->first,
RHS->first);
2287 if (
I->second->getOptionHiddenFlag() ==
Hidden && !ShowHidden)
2291 if (!OptionSet.
insert(
I->second).second)
2295 std::pair<const char *, Option *>(
I->getKey().data(),
I->second));
2305 for (
auto *S : SubMap) {
2306 if (S->getName().empty())
2308 Subs.push_back(std::make_pair(S->getName().data(), S));
2317 const bool ShowHidden;
2319 StrOptionPairVector;
2321 StrSubCommandPairVector;
2323 virtual void printOptions(StrOptionPairVector &Opts,
size_t MaxArgLen) {
2324 for (
size_t i = 0, e = Opts.size(); i != e; ++i)
2325 Opts[i].second->printOptionInfo(MaxArgLen);
2328 void printSubCommands(StrSubCommandPairVector &Subs,
size_t MaxSubLen) {
2329 for (
const auto &S : Subs) {
2330 outs() <<
" " << S.first;
2331 if (!S.second->getDescription().empty()) {
2333 outs() <<
" - " << S.second->getDescription();
2340 explicit HelpPrinter(
bool showHidden) : ShowHidden(showHidden) {}
2341 virtual ~HelpPrinter() =
default;
2344 void operator=(
bool Value) {
2359 StrOptionPairVector Opts;
2360 sortOpts(OptionsMap, Opts, ShowHidden);
2362 StrSubCommandPairVector Subs;
2371 outs() <<
" [subcommand]";
2372 outs() <<
" [options]";
2382 for (
auto *Opt : PositionalOpts) {
2389 if (ConsumeAfterOpt)
2390 outs() <<
" " << ConsumeAfterOpt->HelpStr;
2394 size_t MaxSubLen = 0;
2395 for (
size_t i = 0, e = Subs.size(); i != e; ++i)
2396 MaxSubLen = std::max(MaxSubLen, strlen(Subs[i].first));
2399 outs() <<
"SUBCOMMANDS:\n\n";
2400 printSubCommands(Subs, MaxSubLen);
2403 <<
" <subcommand> --help\" to get more help on a specific "
2410 size_t MaxArgLen = 0;
2411 for (
size_t i = 0, e = Opts.size(); i != e; ++i)
2412 MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
2414 outs() <<
"OPTIONS:\n";
2415 printOptions(Opts, MaxArgLen);
2424class CategorizedHelpPrinter :
public HelpPrinter {
2426 explicit CategorizedHelpPrinter(
bool showHidden) : HelpPrinter(showHidden) {}
2434 return (*A)->getName().compare((*B)->getName());
2438 using HelpPrinter::operator=;
2441 void printOptions(StrOptionPairVector &Opts,
size_t MaxArgLen)
override {
2442 std::vector<OptionCategory *> SortedCategories;
2448 SortedCategories.push_back(Category);
2451 assert(SortedCategories.size() > 0 &&
"No option categories registered!");
2453 OptionCategoryCompare);
2458 for (
size_t I = 0,
E = Opts.size();
I !=
E; ++
I) {
2462 "Option has an unregistered category");
2463 CategorizedOptions[Cat].push_back(Opt);
2470 const auto &CategoryOptions = CategorizedOptions[Category];
2471 if (CategoryOptions.empty())
2485 for (
const Option *Opt : CategoryOptions)
2493class HelpPrinterWrapper {
2495 HelpPrinter &UncategorizedPrinter;
2496 CategorizedHelpPrinter &CategorizedPrinter;
2499 explicit HelpPrinterWrapper(HelpPrinter &UncategorizedPrinter,
2500 CategorizedHelpPrinter &CategorizedPrinter)
2501 : UncategorizedPrinter(UncategorizedPrinter),
2502 CategorizedPrinter(CategorizedPrinter) {}
2505 void operator=(
bool Value);
2510#if defined(__GNUC__)
2513# if defined(__OPTIMIZE__)
2514# define LLVM_IS_DEBUG_BUILD 0
2516# define LLVM_IS_DEBUG_BUILD 1
2518#elif defined(_MSC_VER)
2523# define LLVM_IS_DEBUG_BUILD 1
2525# define LLVM_IS_DEBUG_BUILD 0
2529# define LLVM_IS_DEBUG_BUILD 0
2533class VersionPrinter {
2535 void print(std::vector<VersionPrinterTy> ExtraPrinters = {}) {
2537#ifdef PACKAGE_VENDOR
2538 OS << PACKAGE_VENDOR <<
" ";
2540 OS <<
"LLVM (http://llvm.org/):\n ";
2542 OS << PACKAGE_NAME <<
" version " << PACKAGE_VERSION;
2543#ifdef LLVM_REPOSITORY
2544 OS <<
" (" << LLVM_REPOSITORY;
2546 OS <<
' ' << LLVM_REVISION;
2551#if LLVM_IS_DEBUG_BUILD
2552 OS <<
"DEBUG build";
2554 OS <<
"Optimized build";
2557 OS <<
" with assertions";
2563 if (!ExtraPrinters.empty()) {
2564 for (
const auto &
I : ExtraPrinters)
2568 void operator=(
bool OptionWasSpecified);
2571struct CommandLineCommonOptions {
2574 HelpPrinter UncategorizedNormalPrinter{
false};
2575 HelpPrinter UncategorizedHiddenPrinter{
true};
2576 CategorizedHelpPrinter CategorizedNormalPrinter{
false};
2577 CategorizedHelpPrinter CategorizedHiddenPrinter{
true};
2580 HelpPrinterWrapper WrappedNormalPrinter{UncategorizedNormalPrinter,
2581 CategorizedNormalPrinter};
2582 HelpPrinterWrapper WrappedHiddenPrinter{UncategorizedHiddenPrinter,
2583 CategorizedHiddenPrinter};
2593 "Display list of available options (--help-list-hidden for more)"),
2602 cl::desc(
"Display list of all available options"),
2614 cl::desc(
"Display available options (--help-hidden for more)"),
2625 cl::desc(
"Display all available options"),
2634 cl::desc(
"Print non-default options after command line parsing"),
2641 "print-all-options",
2642 cl::desc(
"Print all option values after command line parsing"),
2650 std::vector<VersionPrinterTy> ExtraVersionPrinters;
2653 VersionPrinter VersionPrinterInstance;
2656 "version",
cl::desc(
"Display the version of this program"),
2682 return GeneralCategory;
2685void VersionPrinter::operator=(
bool OptionWasSpecified) {
2686 if (!OptionWasSpecified)
2698void HelpPrinterWrapper::operator=(
bool Value) {
2705 if (
GlobalParser->RegisteredOptionCategories.size() > 1) {
2710 CategorizedPrinter =
true;
2712 UncategorizedPrinter =
true;
2718void CommandLineParser::printOptionValues() {
2726 size_t MaxArgLen = 0;
2727 for (
size_t i = 0, e = Opts.
size(); i != e; ++i)
2728 MaxArgLen = std::max(MaxArgLen, Opts[i].second->getOptionWidth());
2730 for (
size_t i = 0, e = Opts.
size(); i != e; ++i)
2731 Opts[i].second->printOptionValue(MaxArgLen,
CommonOptions->PrintAllOptions);
2736 if (!
Hidden && !Categorized)
2738 else if (!
Hidden && Categorized)
2740 else if (
Hidden && !Categorized)
2763 assert(Subs.contains(&Sub));
2775 bool Unrelated =
true;
2776 for (
auto &Cat :
I.second->Categories) {
2777 if (Cat == &Category || Cat == &
CommonOptions->GenericCategory)
2789 bool Unrelated =
true;
2790 for (
auto &Cat :
I.second->Categories) {
2806 const char *Overview) {
This file defines the StringMap class.
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
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 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 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 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
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 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...
static void Help(ArrayRef< SubtargetSubTypeKV > CPUTable, 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 ...
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
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.
Allocate memory in an ever growing pool, as if by bump-pointer.
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...
This interface provides simple read-only access to a block of memory, and provides simple methods for...
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)
size_type count(StringRef Key) const
count - Return 1 if the element is in the map, 0 otherwise.
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.
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.
unsigned edit_distance(StringRef Other, bool AllowReplacements=true, unsigned MaxEditDistance=0) const
Determine the edit distance between this string and another string.
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.
static constexpr size_t npos
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.
bool findConfigFile(StringRef FileName, SmallVectorImpl< char > &FilePath)
Looks for the specified configuration file.
ExpansionContext(BumpPtrAllocator &A, TokenizerCallback T)
Error expandResponseFiles(SmallVectorImpl< const char * > &Argv)
Expands constructs "@file" in the provided array of arguments recursively.
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
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)
StringRef getName() const
SmallVector< Option *, 4 > SinkOpts
static SubCommand & getTopLevel()
void unregisterSubCommand()
static SubCommand & getAll()
void registerSubCommand()
SmallVector< Option *, 4 > PositionalOpts
StringMap< Option * > OptionsMap
StringRef getDescription() const
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 std::optional< std::string > GetEnv(StringRef name)
virtual llvm::ErrorOr< std::string > getCurrentWorkingDirectory() const =0
Get the working directory of this file system.
llvm::ErrorOr< std::unique_ptr< llvm::MemoryBuffer > > getBufferForFile(const Twine &Name, int64_t FileSize=-1, bool RequiresNullTerminator=true, bool IsVolatile=false)
This is a convenience method that opens a file, gets its content and then closes the file.
virtual std::error_code makeAbsolute(SmallVectorImpl< char > &Path) const
Make Path an absolute path.
virtual llvm::ErrorOr< Status > status(const Twine &Path)=0
Get the status of the entry at Path, if one exists.
The result of a status operation.
bool equivalent(const Status &Other) const
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.
@ SC
CHAIN = SC CHAIN, Imm128 - System call.
ManagedStatic< cl::opt< FnT >, OptCreatorT > Action
constexpr size_t NameSize
std::function< void(raw_ostream &)> VersionPrinterTy
void(*)(StringRef Source, StringSaver &Saver, SmallVectorImpl< const char * > &NewArgv, bool MarkEOLs) TokenizerCallback
String tokenization function type.
void PrintVersionMessage()
Utility function for printing version number.
bool ExpandResponseFiles(StringSaver &Saver, TokenizerCallback Tokenizer, SmallVectorImpl< const char * > &Argv)
A convenience helper which supports the typical use case of expansion function call.
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 ...
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.
OptionCategory & getGeneralCategory()
void ResetAllOptionOccurrences()
Reset all command line options to a state that looks as if they have never appeared on the command li...
void SetVersionPrinter(VersionPrinterTy func)
===------------------------------------------------------------------—===// Override the default (LLV...
void tokenizeConfigFile(StringRef Source, StringSaver &Saver, SmallVectorImpl< const char * > &NewArgv, bool MarkEOLs=false)
Tokenizes content of configuration file.
StringMap< Option * > & getRegisteredOptions(SubCommand &Sub=SubCommand::getTopLevel())
Use this to get a StringMap to all registered named options (e.g.
void ResetCommandLineParser()
Reset the command line parser back to its initial state.
bool ParseCommandLineOptions(int argc, const char *const *argv, StringRef Overview="", raw_ostream *Errs=nullptr, const char *EnvVar=nullptr, bool LongOptionsUseDoubleDash=false)
ManagedStatic< SubCommand > TopLevelSubCommand
iterator_range< typename SmallPtrSet< SubCommand *, 4 >::iterator > getRegisteredSubcommands()
Use this to get all registered SubCommands from the provided parser.
void AddLiteralOption(Option &O, StringRef Name)
Adds a new option for parsing and provides the option it refers to.
void TokenizeWindowsCommandLineNoCopy(StringRef Source, StringSaver &Saver, SmallVectorImpl< StringRef > &NewArgv)
Tokenizes a Windows command line while attempting to avoid copies.
bool ProvidePositionalOption(Option *Handler, StringRef Arg, int i)
Parses Arg into the option handler Handler.
initializer< Ty > init(const Ty &Val)
ManagedStatic< SubCommand > AllSubCommands
LocationClass< Ty > location(Ty &L)
void HideUnrelatedOptions(cl::OptionCategory &Category, SubCommand &Sub=SubCommand::getTopLevel())
Mark all options not part of this category as cl::ReallyHidden.
void AddExtraVersionPrinter(VersionPrinterTy func)
===------------------------------------------------------------------—===// Add an extra printer to u...
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...
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.
void TokenizeGNUCommandLine(StringRef Source, StringSaver &Saver, SmallVectorImpl< const char * > &NewArgv, bool MarkEOLs=false)
Tokenizes a command line that can contain escapes and quotes.
std::optional< const char * > toString(const std::optional< DWARFFormValue > &V)
Take an optional DWARFFormValue and try to extract a string value from it.
bool has_parent_path(const Twine &path, Style style=Style::native)
Has parent path?
bool is_relative(const Twine &path, Style style=Style::native)
Is path relative?
StringRef filename(StringRef path, Style style=Style::native)
Get filename.
StringRef parent_path(StringRef path, Style style=Style::native)
Get parent path.
bool is_absolute(const Twine &path, Style style=Style::native)
Is path absolute?
void append(SmallVectorImpl< char > &path, const Twine &a, const Twine &b="", const Twine &c="", const Twine &d="")
Append to path.
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.
void initWithColorOptions()
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.
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.
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.
Printable print(const GCNRegPressure &RP, const GCNSubtarget *ST=nullptr)
@ no_such_file_or_directory
decltype(auto) get(const PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info > &Pair)
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
void report_fatal_error(Error Err, bool gen_crash_diag=true)
Report a serious error, calling any installed error handler.
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 initTypeSizeOptions()
void initStatisticOptions()
raw_ostream & nulls()
This returns a reference to a raw_ostream which simply discards output.
raw_fd_ostream & errs()
This returns a reference to a raw_ostream for standard error.
void initRandomSeedOptions()
void initGraphWriterOptions()
raw_ostream & operator<<(raw_ostream &OS, const APFixedPoint &FX)
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.
@ Default
The result values are uniform if and only if all operands are uniform.