CommandObjectApropos.cpp [plain text]
#include "CommandObjectApropos.h"
#include "lldb/Interpreter/Args.h"
#include "lldb/Interpreter/Options.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandReturnObject.h"
using namespace lldb;
using namespace lldb_private;
CommandObjectApropos::CommandObjectApropos (CommandInterpreter &interpreter) :
CommandObjectParsed (interpreter,
"apropos",
"Find a list of debugger commands related to a particular word/subject.",
NULL)
{
CommandArgumentEntry arg;
CommandArgumentData search_word_arg;
search_word_arg.arg_type = eArgTypeSearchWord;
search_word_arg.arg_repetition = eArgRepeatPlain;
arg.push_back (search_word_arg);
m_arguments.push_back (arg);
}
CommandObjectApropos::~CommandObjectApropos()
{
}
bool
CommandObjectApropos::DoExecute (Args& args, CommandReturnObject &result)
{
const int argc = args.GetArgumentCount ();
if (argc == 1)
{
const char *search_word = args.GetArgumentAtIndex(0);
if ((search_word != NULL)
&& (strlen (search_word) > 0))
{
StringList commands_found;
StringList commands_help;
m_interpreter.FindCommandsForApropos (search_word, commands_found, commands_help);
if (commands_found.GetSize() == 0)
{
result.AppendMessageWithFormat ("No commands found pertaining to '%s'. Try 'help' to see a complete list of debugger commands.\n", search_word);
}
else
{
result.AppendMessageWithFormat ("The following commands may relate to '%s':\n", search_word);
size_t max_len = 0;
for (size_t i = 0; i < commands_found.GetSize(); ++i)
{
size_t len = strlen (commands_found.GetStringAtIndex (i));
if (len > max_len)
max_len = len;
}
for (size_t i = 0; i < commands_found.GetSize(); ++i)
m_interpreter.OutputFormattedHelpText (result.GetOutputStream(),
commands_found.GetStringAtIndex(i),
"--", commands_help.
GetStringAtIndex(i),
max_len);
}
StreamString settings_search_results;
lldb::UserSettingsControllerSP root = Debugger::GetSettingsController ();
const char *settings_prefix = root->GetLevelName().GetCString();
UserSettingsController::SearchAllSettingsDescriptions (m_interpreter,
root,
settings_prefix,
search_word,
settings_search_results);
if (settings_search_results.GetSize() > 0)
{
result.AppendMessageWithFormat ("\nThe following settings variables may relate to '%s': \n\n", search_word);
result.AppendMessageWithFormat ("%s", settings_search_results.GetData());
}
result.SetStatus (eReturnStatusSuccessFinishNoResult);
}
else
{
result.AppendError ("'' is not a valid search word.\n");
result.SetStatus (eReturnStatusFailed);
}
}
else
{
result.AppendError ("'apropos' must be called with exactly one argument.\n");
result.SetStatus (eReturnStatusFailed);
}
return result.Succeeded();
}