1 //===-- CommandObjectHelp.cpp -----------------------------------*- C++ -*-===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 #include "CommandObjectHelp.h"
10 #include "lldb/Interpreter/CommandInterpreter.h"
11 #include "lldb/Interpreter/CommandObjectMultiword.h"
12 #include "lldb/Interpreter/CommandReturnObject.h"
13 #include "lldb/Interpreter/Options.h"
16 using namespace lldb_private;
20 void CommandObjectHelp::GenerateAdditionalHelpAvenuesMessage(
21 Stream *s, llvm::StringRef command, llvm::StringRef prefix,
22 llvm::StringRef subcommand, bool include_upropos,
23 bool include_type_lookup) {
24 if (!s || command.empty())
27 std::string command_str = command.str();
28 std::string prefix_str = prefix.str();
29 std::string subcommand_str = subcommand.str();
30 const std::string &lookup_str = !subcommand_str.empty() ? subcommand_str : command_str;
31 s->Printf("'%s' is not a known command.\n", command_str.c_str());
32 s->Printf("Try '%shelp' to see a current list of commands.\n",
33 prefix.str().c_str());
34 if (include_upropos) {
35 s->Printf("Try '%sapropos %s' for a list of related commands.\n",
36 prefix_str.c_str(), lookup_str.c_str());
38 if (include_type_lookup) {
39 s->Printf("Try '%stype lookup %s' for information on types, methods, "
40 "functions, modules, etc.",
41 prefix_str.c_str(), lookup_str.c_str());
45 CommandObjectHelp::CommandObjectHelp(CommandInterpreter &interpreter)
46 : CommandObjectParsed(interpreter, "help", "Show a list of all debugger "
47 "commands, or give details "
48 "about a specific command.",
51 CommandArgumentEntry arg;
52 CommandArgumentData command_arg;
54 // Define the first (and only) variant of this arg.
55 command_arg.arg_type = eArgTypeCommandName;
56 command_arg.arg_repetition = eArgRepeatStar;
58 // There is only one variant this argument could be; put it into the argument
60 arg.push_back(command_arg);
62 // Push the data for the first argument into the m_arguments vector.
63 m_arguments.push_back(arg);
66 CommandObjectHelp::~CommandObjectHelp() = default;
68 static constexpr OptionDefinition g_help_options[] = {
69 #define LLDB_OPTIONS_help
70 #include "CommandOptions.inc"
73 llvm::ArrayRef<OptionDefinition>
74 CommandObjectHelp::CommandOptions::GetDefinitions() {
75 return llvm::makeArrayRef(g_help_options);
78 bool CommandObjectHelp::DoExecute(Args &command, CommandReturnObject &result) {
79 CommandObject::CommandMap::iterator pos;
80 CommandObject *cmd_obj;
81 const size_t argc = command.GetArgumentCount();
83 // 'help' doesn't take any arguments, other than command names. If argc is
84 // 0, we show the user all commands (aliases and user commands if asked for).
85 // Otherwise every argument must be the name of a command or a sub-command.
87 uint32_t cmd_types = CommandInterpreter::eCommandTypesBuiltin;
88 if (m_options.m_show_aliases)
89 cmd_types |= CommandInterpreter::eCommandTypesAliases;
90 if (m_options.m_show_user_defined)
91 cmd_types |= CommandInterpreter::eCommandTypesUserDef;
92 if (m_options.m_show_hidden)
93 cmd_types |= CommandInterpreter::eCommandTypesHidden;
95 result.SetStatus(eReturnStatusSuccessFinishNoResult);
96 m_interpreter.GetHelp(result, cmd_types); // General help
98 // Get command object for the first command argument. Only search built-in
99 // command dictionary.
101 auto command_name = command[0].ref;
102 cmd_obj = m_interpreter.GetCommandObject(command_name, &matches);
104 if (cmd_obj != nullptr) {
106 bool all_okay = true;
107 CommandObject *sub_cmd_obj = cmd_obj;
108 // Loop down through sub_command dictionaries until we find the command
109 // object that corresponds to the help command entered.
110 std::string sub_command;
111 for (auto &entry : command.entries().drop_front()) {
112 sub_command = entry.ref;
114 if (sub_cmd_obj->IsAlias())
116 ((CommandAlias *)sub_cmd_obj)->GetUnderlyingCommand().get();
117 if (!sub_cmd_obj->IsMultiwordObject()) {
121 CommandObject *found_cmd;
123 sub_cmd_obj->GetSubcommandObject(sub_command.c_str(), &matches);
124 if (found_cmd == nullptr || matches.GetSize() > 1) {
128 sub_cmd_obj = found_cmd;
132 if (!all_okay || (sub_cmd_obj == nullptr)) {
133 std::string cmd_string;
134 command.GetCommandString(cmd_string);
135 if (matches.GetSize() >= 2) {
137 s.Printf("ambiguous command %s", cmd_string.c_str());
138 size_t num_matches = matches.GetSize();
139 for (size_t match_idx = 0; match_idx < num_matches; match_idx++) {
140 s.Printf("\n\t%s", matches.GetStringAtIndex(match_idx));
143 result.AppendError(s.GetString());
144 result.SetStatus(eReturnStatusFailed);
146 } else if (!sub_cmd_obj) {
147 StreamString error_msg_stream;
148 GenerateAdditionalHelpAvenuesMessage(
149 &error_msg_stream, cmd_string.c_str(),
150 m_interpreter.GetCommandPrefix(), sub_command.c_str());
151 result.AppendError(error_msg_stream.GetString());
152 result.SetStatus(eReturnStatusFailed);
155 GenerateAdditionalHelpAvenuesMessage(
156 &result.GetOutputStream(), cmd_string.c_str(),
157 m_interpreter.GetCommandPrefix(), sub_command.c_str());
158 result.GetOutputStream().Printf(
159 "\nThe closest match is '%s'. Help on it follows.\n\n",
160 sub_cmd_obj->GetCommandName().str().c_str());
164 sub_cmd_obj->GenerateHelpText(result);
165 std::string alias_full_name;
166 // Don't use AliasExists here, that only checks exact name matches. If
167 // the user typed a shorter unique alias name, we should still tell them
169 if (m_interpreter.GetAliasFullName(command_name, alias_full_name)) {
171 m_interpreter.GetAlias(alias_full_name)->GetAliasExpansion(sstr);
172 result.GetOutputStream().Printf("\n'%s' is an abbreviation for %s\n",
173 command[0].c_str(), sstr.GetData());
175 } else if (matches.GetSize() > 0) {
176 Stream &output_strm = result.GetOutputStream();
177 output_strm.Printf("Help requested with ambiguous command name, possible "
179 const size_t match_count = matches.GetSize();
180 for (size_t i = 0; i < match_count; i++) {
181 output_strm.Printf("\t%s\n", matches.GetStringAtIndex(i));
184 // Maybe the user is asking for help about a command argument rather than
186 const CommandArgumentType arg_type =
187 CommandObject::LookupArgumentName(command_name);
188 if (arg_type != eArgTypeLastArg) {
189 Stream &output_strm = result.GetOutputStream();
190 CommandObject::GetArgumentHelp(output_strm, arg_type, m_interpreter);
191 result.SetStatus(eReturnStatusSuccessFinishNoResult);
193 StreamString error_msg_stream;
194 GenerateAdditionalHelpAvenuesMessage(&error_msg_stream, command_name,
195 m_interpreter.GetCommandPrefix(),
197 result.AppendError(error_msg_stream.GetString());
198 result.SetStatus(eReturnStatusFailed);
203 return result.Succeeded();
206 int CommandObjectHelp::HandleCompletion(CompletionRequest &request) {
207 // Return the completions of the commands in the help system:
208 if (request.GetCursorIndex() == 0) {
209 return m_interpreter.HandleCompletionMatches(request);
211 CommandObject *cmd_obj =
212 m_interpreter.GetCommandObject(request.GetParsedLine()[0].ref);
214 // The command that they are getting help on might be ambiguous, in which
215 // case we should complete that, otherwise complete with the command the
216 // user is getting help on...
219 request.GetParsedLine().Shift();
220 request.SetCursorIndex(request.GetCursorIndex() - 1);
221 return cmd_obj->HandleCompletion(request);
223 return m_interpreter.HandleCompletionMatches(request);