Magic-Mirror/llvm-capstone
1
0
Fork 0
mirror of https://github.com/capstone-engine/llvm-capstone.git synced 2024-11-29 00:21:14 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

[lldb] Print the enum values and their description in the help output

Browse Source 
Print the enum values and their description in the help output for
argument values. Until now, there was no way to get these values and
their description.

Example output:

(lldb) help <description-verbosity>
  <description-verbosity> -- How verbose the output of 'po' should be.

     compact : Only show the description string
     full    : Show the full output, including persistent variable's
               name and type

Differential revision: https://reviews.llvm.org/D129707
This commit is contained in:
Jonas Devlieghere 2022-07-14 20:23:07 -07:00
parent 7ced9fff95
commit bcae3cdbd0
No known key found for this signature in database
GPG Key ID: 49CC0BD90FDEED4D
2 changed files with 34 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
lldb/source/Interpreter/CommandObject.cpp
View File

@ -16,6 +16,7 @@
#include <cstdlib>
#include "lldb/Core/Address.h"
#include "lldb/Interpreter/CommandOptionArgumentTable.h"
#include "lldb/Interpreter/Options.h"
#include "lldb/Utility/ArchSpec.h"
#include "llvm/ADT/ScopeExit.h"
@ -398,9 +399,28 @@ void CommandObject::GetArgumentHelp(Stream &str, CommandArgumentType arg_type,
interpreter.OutputHelpText(str, name_str.GetString(), "--", help_text,
name_str.GetSize());
}
} else
} else {
interpreter.OutputFormattedHelpText(str, name_str.GetString(), "--",
entry->help_text, name_str.GetSize());
// Print enum values and their description if any.
OptionEnumValues enum_values = g_argument_table[arg_type].enum_values;
if (!enum_values.empty()) {
str.EOL();
size_t longest = 0;
for (const OptionEnumValueElement &element : enum_values)
longest =
std::max(longest, llvm::StringRef(element.string_value).size());
str.IndentMore(5);
for (const OptionEnumValueElement &element : enum_values) {
str.Indent();
interpreter.OutputHelpText(str, element.string_value, ":",
element.usage, longest);
}
str.IndentLess(5);
str.EOL();
}
}
}
const char *CommandObject::GetArgumentName(CommandArgumentType arg_type) {

13
lldb/test/API/commands/help/TestHelp.py
View File

@ -318,3 +318,16 @@ class HelpCommandTestCase(TestBase):
"\(does not apply to binary output\)."])
self.expect("help memory find", patterns=[
"--show-tags\n\s+Include memory tags in output."])
@no_debug_info_test
def test_help_show_enum_values(self):
""" Check the help output for a argument type contains the enum values
and their descriptions. """
self.expect("help <log-handler>", substrs=[
'The log handle that will be used to write out log messages.',
'default' , 'Use the default (stream) log handler',
'stream' , 'Write log messages to the debugger output stream',
'circular' , 'Write log messages to a fixed size circular buffer',
'os' , 'Write log messages to the operating system log',
])