blob: c6680f8b140d16b821e9239228c60ef1c9209ecb [file] [log] [blame]
//===-- CommandObjectApropos.cpp ------------------------------------------===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#include "CommandObjectApropos.h"
#include "lldb/Interpreter/CommandInterpreter.h"
#include "lldb/Interpreter/CommandReturnObject.h"
#include "lldb/Interpreter/Property.h"
#include "lldb/Utility/Args.h"
using namespace lldb;
using namespace lldb_private;
// CommandObjectApropos
CommandObjectApropos::CommandObjectApropos(CommandInterpreter &interpreter)
: CommandObjectParsed(
interpreter, "apropos",
"List debugger commands related to a word or subject.", nullptr) {
CommandArgumentEntry arg;
CommandArgumentData search_word_arg;
// Define the first (and only) variant of this arg.
search_word_arg.arg_type = eArgTypeSearchWord;
search_word_arg.arg_repetition = eArgRepeatPlain;
// There is only one variant this argument could be; put it into the argument
// entry.
// Push the data for the first argument into the m_arguments vector.
CommandObjectApropos::~CommandObjectApropos() = default;
bool CommandObjectApropos::DoExecute(Args &args, CommandReturnObject &result) {
const size_t argc = args.GetArgumentCount();
if (argc == 1) {
auto search_word = args[0].ref();
if (!search_word.empty()) {
// The bulk of the work must be done inside the Command Interpreter,
// since the command dictionary is private.
StringList commands_found;
StringList commands_help;
search_word, commands_found, commands_help, true, true, true, true);
if (commands_found.GetSize() == 0) {
result.AppendMessageWithFormat("No commands found pertaining to '%s'. "
"Try 'help' to see a complete list of "
"debugger commands.\n",
} else {
if (commands_found.GetSize() > 0) {
"The following commands may relate to '%s':\n", args[0].c_str());
const size_t max_len = commands_found.GetMaxStringLength();
for (size_t i = 0; i < commands_found.GetSize(); ++i)
result.GetOutputStream(), commands_found.GetStringAtIndex(i),
"--", commands_help.GetStringAtIndex(i), max_len);
std::vector<const Property *> properties;
const size_t num_properties =
GetDebugger().Apropos(search_word, properties);
if (num_properties) {
const bool dump_qualified_name = true;
"\nThe following settings variables may relate to '{0}': \n\n",
for (size_t i = 0; i < num_properties; ++i)
m_interpreter, result.GetOutputStream(), 0, dump_qualified_name);
} else {
result.AppendError("'' is not a valid search word.\n");
} else {
result.AppendError("'apropos' must be called with exactly one argument.\n");
return result.Succeeded();