a487aa4cdb
The default help display now shows the alias collection by default, and hides commands whose named begin with an underscore. Help is primarily useful to those unfamiliar with LLDB and should aim to answer typical questions while still being able to provide more esoteric answers when required. To that latter end an argument to include the hidden commands in help has been added, and instead of having a help flag to show aliases there is now one to hide them. This final change might be controversial as it repurposes the -a shorthand as the opposite of its original meaning. The previous implementation of OutputFormattedHelpText was easily confused by embedded newlines. The new algorithm correctly breaks on the FIRST newline or LAST space/tab before the target column count rather than treating all whitespace interchangeably. Command interpreters now have the ability to specify help prologue text and a command prefix string. Neither are used in the current LLDB sources but are required to support REPL-like extensions where LLDB commands must be prefixed and additional help text is required to explain how to access traditional debugging commands. <rdar://problem/17751929> <rdar://problem/16953815> <rdar://problem/16953841> <rdar://problem/16930173> <rdar://problem/16879028> llvm-svn: 226068
256 lines
10 KiB
C++
256 lines
10 KiB
C++
//===-- CommandObjectHelp.cpp -----------------------------------*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "lldb/lldb-python.h"
|
|
|
|
#include "CommandObjectHelp.h"
|
|
|
|
// C Includes
|
|
// C++ Includes
|
|
// Other libraries and framework includes
|
|
// Project includes
|
|
#include "lldb/Interpreter/CommandObjectMultiword.h"
|
|
#include "lldb/Interpreter/CommandInterpreter.h"
|
|
#include "lldb/Interpreter/Options.h"
|
|
#include "lldb/Interpreter/CommandReturnObject.h"
|
|
|
|
using namespace lldb;
|
|
using namespace lldb_private;
|
|
|
|
//-------------------------------------------------------------------------
|
|
// CommandObjectHelp
|
|
//-------------------------------------------------------------------------
|
|
|
|
CommandObjectHelp::CommandObjectHelp (CommandInterpreter &interpreter) :
|
|
CommandObjectParsed (interpreter,
|
|
"help",
|
|
"Show a list of all debugger commands, or give details about specific commands.",
|
|
"help [<cmd-name>]"), m_options (interpreter)
|
|
{
|
|
CommandArgumentEntry arg;
|
|
CommandArgumentData command_arg;
|
|
|
|
// Define the first (and only) variant of this arg.
|
|
command_arg.arg_type = eArgTypeCommandName;
|
|
command_arg.arg_repetition = eArgRepeatStar;
|
|
|
|
// There is only one variant this argument could be; put it into the argument entry.
|
|
arg.push_back (command_arg);
|
|
|
|
// Push the data for the first argument into the m_arguments vector.
|
|
m_arguments.push_back (arg);
|
|
}
|
|
|
|
CommandObjectHelp::~CommandObjectHelp()
|
|
{
|
|
}
|
|
|
|
OptionDefinition
|
|
CommandObjectHelp::CommandOptions::g_option_table[] =
|
|
{
|
|
{ LLDB_OPT_SET_ALL, false, "hide-aliases", 'a', OptionParser::eNoArgument, NULL, NULL, 0, eArgTypeNone, "Hide aliases in the command list."},
|
|
{ LLDB_OPT_SET_ALL, false, "hide-user-commands", 'u', OptionParser::eNoArgument, NULL, NULL, 0, eArgTypeNone, "Hide user-defined commands from the list."},
|
|
{ LLDB_OPT_SET_ALL, false, "show-hidden-commands", 'h', OptionParser::eNoArgument, NULL, NULL, 0, eArgTypeNone, "Include commands prefixed with an underscore."},
|
|
{ 0, false, NULL, NULL, 0, 0, NULL, 0, eArgTypeNone, NULL }
|
|
};
|
|
|
|
bool
|
|
CommandObjectHelp::DoExecute (Args& command, CommandReturnObject &result)
|
|
{
|
|
CommandObject::CommandMap::iterator pos;
|
|
CommandObject *cmd_obj;
|
|
const size_t argc = command.GetArgumentCount ();
|
|
|
|
// 'help' doesn't take any arguments, other than command names. If argc is 0, we show the user
|
|
// all commands (aliases and user commands if asked for). Otherwise every argument must be the name of a command or a sub-command.
|
|
if (argc == 0)
|
|
{
|
|
uint32_t cmd_types = CommandInterpreter::eCommandTypesBuiltin;
|
|
if (m_options.m_show_aliases)
|
|
cmd_types |= CommandInterpreter::eCommandTypesAliases;
|
|
if (m_options.m_show_user_defined)
|
|
cmd_types |= CommandInterpreter::eCommandTypesUserDef;
|
|
if (m_options.m_show_hidden)
|
|
cmd_types |= CommandInterpreter::eCommandTypesHidden;
|
|
|
|
result.SetStatus (eReturnStatusSuccessFinishNoResult);
|
|
m_interpreter.GetHelp (result, cmd_types); // General help
|
|
}
|
|
else
|
|
{
|
|
// Get command object for the first command argument. Only search built-in command dictionary.
|
|
StringList matches;
|
|
cmd_obj = m_interpreter.GetCommandObject (command.GetArgumentAtIndex (0), &matches);
|
|
bool is_alias_command = m_interpreter.AliasExists (command.GetArgumentAtIndex (0));
|
|
std::string alias_name = command.GetArgumentAtIndex(0);
|
|
|
|
if (cmd_obj != NULL)
|
|
{
|
|
StringList matches;
|
|
bool all_okay = true;
|
|
CommandObject *sub_cmd_obj = cmd_obj;
|
|
// Loop down through sub_command dictionaries until we find the command object that corresponds
|
|
// to the help command entered.
|
|
for (size_t i = 1; i < argc && all_okay; ++i)
|
|
{
|
|
std::string sub_command = command.GetArgumentAtIndex(i);
|
|
matches.Clear();
|
|
if (! sub_cmd_obj->IsMultiwordObject ())
|
|
{
|
|
all_okay = false;
|
|
}
|
|
else
|
|
{
|
|
CommandObject *found_cmd;
|
|
found_cmd = sub_cmd_obj->GetSubcommandObject(sub_command.c_str(), &matches);
|
|
if (found_cmd == NULL)
|
|
all_okay = false;
|
|
else if (matches.GetSize() > 1)
|
|
all_okay = false;
|
|
else
|
|
sub_cmd_obj = found_cmd;
|
|
}
|
|
}
|
|
|
|
if (!all_okay || (sub_cmd_obj == NULL))
|
|
{
|
|
std::string cmd_string;
|
|
command.GetCommandString (cmd_string);
|
|
if (matches.GetSize() >= 2)
|
|
{
|
|
StreamString s;
|
|
s.Printf ("ambiguous command %s", cmd_string.c_str());
|
|
size_t num_matches = matches.GetSize();
|
|
for (size_t match_idx = 0; match_idx < num_matches; match_idx++)
|
|
{
|
|
s.Printf ("\n\t%s", matches.GetStringAtIndex(match_idx));
|
|
}
|
|
s.Printf ("\n");
|
|
result.AppendError(s.GetData());
|
|
result.SetStatus (eReturnStatusFailed);
|
|
return false;
|
|
}
|
|
else if (!sub_cmd_obj)
|
|
{
|
|
result.AppendErrorWithFormat("'%s' is not a known command.\n"
|
|
"Try '%shelp' to see a current list of commands.\n",
|
|
cmd_string.c_str(),
|
|
m_interpreter.GetCommandPrefix());
|
|
result.SetStatus (eReturnStatusFailed);
|
|
return false;
|
|
}
|
|
else
|
|
{
|
|
result.GetOutputStream().Printf("'%s' is not a known command.\n"
|
|
"Try '%shelp' to see a current list of commands.\n"
|
|
"The closest match is '%s'. Help on it follows.\n\n",
|
|
cmd_string.c_str(),
|
|
m_interpreter.GetCommandPrefix(),
|
|
sub_cmd_obj->GetCommandName());
|
|
}
|
|
}
|
|
|
|
sub_cmd_obj->GenerateHelpText(result);
|
|
|
|
if (is_alias_command)
|
|
{
|
|
StreamString sstr;
|
|
m_interpreter.GetAliasHelp (alias_name.c_str(), cmd_obj->GetCommandName(), sstr);
|
|
result.GetOutputStream().Printf ("\n'%s' is an abbreviation for %s\n", alias_name.c_str(), sstr.GetData());
|
|
}
|
|
}
|
|
else if (matches.GetSize() > 0)
|
|
{
|
|
Stream &output_strm = result.GetOutputStream();
|
|
output_strm.Printf("Help requested with ambiguous command name, possible completions:\n");
|
|
const size_t match_count = matches.GetSize();
|
|
for (size_t i = 0; i < match_count; i++)
|
|
{
|
|
output_strm.Printf("\t%s\n", matches.GetStringAtIndex(i));
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// Maybe the user is asking for help about a command argument rather than a command.
|
|
const CommandArgumentType arg_type = CommandObject::LookupArgumentName (command.GetArgumentAtIndex (0));
|
|
if (arg_type != eArgTypeLastArg)
|
|
{
|
|
Stream &output_strm = result.GetOutputStream ();
|
|
CommandObject::GetArgumentHelp (output_strm, arg_type, m_interpreter);
|
|
result.SetStatus (eReturnStatusSuccessFinishNoResult);
|
|
}
|
|
else
|
|
{
|
|
result.AppendErrorWithFormat
|
|
("'%s' is not a known command.\nTry '%shelp' to see a current list of commands.\n",
|
|
command.GetArgumentAtIndex(0),
|
|
m_interpreter.GetCommandPrefix());
|
|
result.SetStatus (eReturnStatusFailed);
|
|
}
|
|
}
|
|
}
|
|
|
|
return result.Succeeded();
|
|
}
|
|
|
|
int
|
|
CommandObjectHelp::HandleCompletion
|
|
(
|
|
Args &input,
|
|
int &cursor_index,
|
|
int &cursor_char_position,
|
|
int match_start_point,
|
|
int max_return_elements,
|
|
bool &word_complete,
|
|
StringList &matches
|
|
)
|
|
{
|
|
// Return the completions of the commands in the help system:
|
|
if (cursor_index == 0)
|
|
{
|
|
return m_interpreter.HandleCompletionMatches (input,
|
|
cursor_index,
|
|
cursor_char_position,
|
|
match_start_point,
|
|
max_return_elements,
|
|
word_complete,
|
|
matches);
|
|
}
|
|
else
|
|
{
|
|
CommandObject *cmd_obj = m_interpreter.GetCommandObject (input.GetArgumentAtIndex(0));
|
|
|
|
// The command that they are getting help on might be ambiguous, in which case we should complete that,
|
|
// otherwise complete with the command the user is getting help on...
|
|
|
|
if (cmd_obj)
|
|
{
|
|
input.Shift();
|
|
cursor_index--;
|
|
return cmd_obj->HandleCompletion (input,
|
|
cursor_index,
|
|
cursor_char_position,
|
|
match_start_point,
|
|
max_return_elements,
|
|
word_complete,
|
|
matches);
|
|
}
|
|
else
|
|
{
|
|
return m_interpreter.HandleCompletionMatches (input,
|
|
cursor_index,
|
|
cursor_char_position,
|
|
match_start_point,
|
|
max_return_elements,
|
|
word_complete,
|
|
matches);
|
|
}
|
|
}
|
|
}
|