maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

Better output for long help strings for command-line options. 

Summary:
This patch allows using \n inside long help strings for command-line
options, so that all lines are equally indented. This is not a perfect solution,
as we don't (and probably don't want to) know about terminal width, but it
allows to format long help strings somehow readable without manually padding
them with spaces. A motivating example is -help output from clang-format (source
code in tools/clang-format/ClangFormat.cpp, see cl options offset, length,
style, and dump-config).

Reviewers: atrick, alexfh

Reviewed By: alexfh

CC: llvm-commits, rafael

Differential Revision: http://llvm-reviews.chandlerc.com/D779

llvm-svn: 181608
This commit is contained in:
Alexander Kornienko 2013-05-10 17:15:51 +00:00
parent 757fbb0b14
commit 72a196a159
2 changed files with 18 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
llvm/docs/CommandLine.rst
View File

@ -930,7 +930,8 @@ This section describes the basic attributes that you can specify on options.
.. _cl::desc(...): .. _cl::desc(...):
* The **cl::desc** attribute specifies a description for the option to be * The **cl::desc** attribute specifies a description for the option to be
shown in the ``-help`` output for the program. shown in the ``-help`` output for the program. This attribute supports
multi-line descriptions with lines separated by '\n'.
.. _cl::value_desc: .. _cl::value_desc:

24
llvm/lib/Support/CommandLine.cpp
View File

@ -913,11 +913,20 @@ size_t alias::getOptionWidth() const {
return std::strlen(ArgStr)+6; return std::strlen(ArgStr)+6;
} }
static void printHelpStr(StringRef HelpStr, size_t Indent,
size_t FirstLineIndentedBy) {
std::pair<StringRef, StringRef> Split = HelpStr.split('\n');
outs().indent(Indent - FirstLineIndentedBy) << " - " << Split.first << "\n";
while (!Split.second.empty()) {
Split = Split.second.split('\n');
outs().indent(Indent) << Split.first << "\n";
}
}
// Print out the option for the alias. // Print out the option for the alias.
void alias::printOptionInfo(size_t GlobalWidth) const { void alias::printOptionInfo(size_t GlobalWidth) const {
size_t L = std::strlen(ArgStr);
outs() << " -" << ArgStr; outs() << " -" << ArgStr;
outs().indent(GlobalWidth-L-6) << " - " << HelpStr << "\n"; printHelpStr(HelpStr, GlobalWidth, std::strlen(ArgStr) + 6);
} }
//===----------------------------------------------------------------------===// //===----------------------------------------------------------------------===//
@ -946,7 +955,7 @@ void basic_parser_impl::printOptionInfo(const Option &O,
if (const char *ValName = getValueName()) if (const char *ValName = getValueName())
outs() << "=<" << getValueStr(O, ValName) << '>'; outs() << "=<" << getValueStr(O, ValName) << '>';
outs().indent(GlobalWidth-getOptionWidth(O)) << " - " << O.HelpStr << '\n'; printHelpStr(O.HelpStr, GlobalWidth, getOptionWidth(O));
} }
void basic_parser_impl::printOptionName(const Option &O, void basic_parser_impl::printOptionName(const Option &O,
@ -1087,9 +1096,8 @@ size_t generic_parser_base::getOptionWidth(const Option &O) const {
void generic_parser_base::printOptionInfo(const Option &O, void generic_parser_base::printOptionInfo(const Option &O,
size_t GlobalWidth) const { size_t GlobalWidth) const {
if (O.hasArgStr()) { if (O.hasArgStr()) {
size_t L = std::strlen(O.ArgStr);
outs() << " -" << O.ArgStr; outs() << " -" << O.ArgStr;
outs().indent(GlobalWidth-L-6) << " - " << O.HelpStr << '\n'; printHelpStr(O.HelpStr, GlobalWidth, std::strlen(O.ArgStr) + 6);
for (unsigned i = 0, e = getNumOptions(); i != e; ++i) { for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
size_t NumSpaces = GlobalWidth-strlen(getOption(i))-8; size_t NumSpaces = GlobalWidth-strlen(getOption(i))-8;
@ -1100,9 +1108,9 @@ void generic_parser_base::printOptionInfo(const Option &O,
if (O.HelpStr[0]) if (O.HelpStr[0])
outs() << " " << O.HelpStr << '\n'; outs() << " " << O.HelpStr << '\n';
for (unsigned i = 0, e = getNumOptions(); i != e; ++i) { for (unsigned i = 0, e = getNumOptions(); i != e; ++i) {
size_t L = std::strlen(getOption(i)); const char *Option = getOption(i);
outs() << " -" << getOption(i); outs() << " -" << Option;
outs().indent(GlobalWidth-L-8) << " - " << getDescription(i) << '\n'; printHelpStr(getDescription(i), GlobalWidth, std::strlen(Option) + 8);
} }
} }
} }