1 //===-- CommandObjectMultiword.cpp ------------------------------*- C++ -*-===//
2 //
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
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "lldb/Interpreter/CommandObjectMultiword.h"
10 #include "lldb/Core/Debugger.h"
11 #include "lldb/Interpreter/CommandInterpreter.h"
12 #include "lldb/Interpreter/CommandReturnObject.h"
13 #include "lldb/Interpreter/Options.h"
14 
15 using namespace lldb;
16 using namespace lldb_private;
17 
18 // CommandObjectMultiword
19 
20 CommandObjectMultiword::CommandObjectMultiword(CommandInterpreter &interpreter,
21                                                const char *name,
22                                                const char *help,
23                                                const char *syntax,
24                                                uint32_t flags)
25     : CommandObject(interpreter, name, help, syntax, flags),
26       m_can_be_removed(false) {}
27 
28 CommandObjectMultiword::~CommandObjectMultiword() = default;
29 
30 CommandObjectSP CommandObjectMultiword::GetSubcommandSP(llvm::StringRef sub_cmd,
31                                                         StringList *matches) {
32   CommandObjectSP return_cmd_sp;
33   CommandObject::CommandMap::iterator pos;
34 
35   if (!m_subcommand_dict.empty()) {
36     pos = m_subcommand_dict.find(sub_cmd);
37     if (pos != m_subcommand_dict.end()) {
38       // An exact match; append the sub_cmd to the 'matches' string list.
39       if (matches)
40         matches->AppendString(sub_cmd);
41       return_cmd_sp = pos->second;
42     } else {
43       StringList local_matches;
44       if (matches == nullptr)
45         matches = &local_matches;
46       int num_matches =
47           AddNamesMatchingPartialString(m_subcommand_dict, sub_cmd, *matches);
48 
49       if (num_matches == 1) {
50         // Cleaner, but slightly less efficient would be to call back into this
51         // function, since I now know I have an exact match...
52 
53         sub_cmd = matches->GetStringAtIndex(0);
54         pos = m_subcommand_dict.find(sub_cmd);
55         if (pos != m_subcommand_dict.end())
56           return_cmd_sp = pos->second;
57       }
58     }
59   }
60   return return_cmd_sp;
61 }
62 
63 CommandObject *
64 CommandObjectMultiword::GetSubcommandObject(llvm::StringRef sub_cmd,
65                                             StringList *matches) {
66   return GetSubcommandSP(sub_cmd, matches).get();
67 }
68 
69 bool CommandObjectMultiword::LoadSubCommand(llvm::StringRef name,
70                                             const CommandObjectSP &cmd_obj) {
71   if (cmd_obj)
72     assert((&GetCommandInterpreter() == &cmd_obj->GetCommandInterpreter()) &&
73            "tried to add a CommandObject from a different interpreter");
74 
75   CommandMap::iterator pos;
76   bool success = true;
77 
78   pos = m_subcommand_dict.find(name);
79   if (pos == m_subcommand_dict.end()) {
80     m_subcommand_dict[name] = cmd_obj;
81   } else
82     success = false;
83 
84   return success;
85 }
86 
87 bool CommandObjectMultiword::Execute(const char *args_string,
88                                      CommandReturnObject &result) {
89   Args args(args_string);
90   const size_t argc = args.GetArgumentCount();
91   if (argc == 0) {
92     this->CommandObject::GenerateHelpText(result);
93     return result.Succeeded();
94   }
95 
96   auto sub_command = args[0].ref;
97   if (sub_command.empty())
98     return result.Succeeded();
99 
100   if (sub_command.equals_lower("help")) {
101     this->CommandObject::GenerateHelpText(result);
102     return result.Succeeded();
103   }
104 
105   if (m_subcommand_dict.empty()) {
106     result.AppendErrorWithFormat("'%s' does not have any subcommands.\n",
107                                  GetCommandName().str().c_str());
108     result.SetStatus(eReturnStatusFailed);
109     return false;
110   }
111 
112   StringList matches;
113   CommandObject *sub_cmd_obj = GetSubcommandObject(sub_command, &matches);
114   if (sub_cmd_obj != nullptr) {
115     // Now call CommandObject::Execute to process options in `rest_of_line`.
116     // From there the command-specific version of Execute will be called, with
117     // the processed arguments.
118 
119     args.Shift();
120     sub_cmd_obj->Execute(args_string, result);
121     return result.Succeeded();
122   }
123 
124   std::string error_msg;
125   const size_t num_subcmd_matches = matches.GetSize();
126   if (num_subcmd_matches > 0)
127     error_msg.assign("ambiguous command ");
128   else
129     error_msg.assign("invalid command ");
130 
131   error_msg.append("'");
132   error_msg.append(GetCommandName());
133   error_msg.append(" ");
134   error_msg.append(sub_command);
135   error_msg.append("'.");
136 
137   if (num_subcmd_matches > 0) {
138     error_msg.append(" Possible completions:");
139     for (const std::string &match : matches) {
140       error_msg.append("\n\t");
141       error_msg.append(match);
142     }
143   }
144   error_msg.append("\n");
145   result.AppendRawError(error_msg.c_str());
146   result.SetStatus(eReturnStatusFailed);
147   return false;
148 }
149 
150 void CommandObjectMultiword::GenerateHelpText(Stream &output_stream) {
151   // First time through here, generate the help text for the object and push it
152   // to the return result object as well
153 
154   CommandObject::GenerateHelpText(output_stream);
155   output_stream.PutCString("\nThe following subcommands are supported:\n\n");
156 
157   CommandMap::iterator pos;
158   uint32_t max_len = FindLongestCommandWord(m_subcommand_dict);
159 
160   if (max_len)
161     max_len += 4; // Indent the output by 4 spaces.
162 
163   for (pos = m_subcommand_dict.begin(); pos != m_subcommand_dict.end(); ++pos) {
164     std::string indented_command("    ");
165     indented_command.append(pos->first);
166     if (pos->second->WantsRawCommandString()) {
167       std::string help_text(pos->second->GetHelp());
168       help_text.append("  Expects 'raw' input (see 'help raw-input'.)");
169       m_interpreter.OutputFormattedHelpText(output_stream,
170                                             indented_command.c_str(), "--",
171                                             help_text.c_str(), max_len);
172     } else
173       m_interpreter.OutputFormattedHelpText(output_stream,
174                                             indented_command.c_str(), "--",
175                                             pos->second->GetHelp(), max_len);
176   }
177 
178   output_stream.PutCString("\nFor more help on any particular subcommand, type "
179                            "'help <command> <subcommand>'.\n");
180 }
181 
182 void CommandObjectMultiword::HandleCompletion(CompletionRequest &request) {
183   auto arg0 = request.GetParsedLine()[0].ref;
184   if (request.GetCursorIndex() == 0) {
185     StringList new_matches, descriptions;
186     AddNamesMatchingPartialString(m_subcommand_dict, arg0, new_matches,
187                                   &descriptions);
188     request.AddCompletions(new_matches, descriptions);
189 
190     if (new_matches.GetSize() == 1 &&
191         new_matches.GetStringAtIndex(0) != nullptr &&
192         (arg0 == new_matches.GetStringAtIndex(0))) {
193       StringList temp_matches;
194       CommandObject *cmd_obj = GetSubcommandObject(arg0, &temp_matches);
195       if (cmd_obj != nullptr) {
196         if (request.GetParsedLine().GetArgumentCount() != 1) {
197           request.GetParsedLine().Shift();
198           request.SetCursorCharPosition(0);
199           request.GetParsedLine().AppendArgument(llvm::StringRef());
200           cmd_obj->HandleCompletion(request);
201         }
202       }
203     }
204   } else {
205     StringList new_matches;
206     CommandObject *sub_command_object = GetSubcommandObject(arg0, &new_matches);
207     if (sub_command_object == nullptr) {
208       request.AddCompletions(new_matches);
209     } else {
210       // Remove the one match that we got from calling GetSubcommandObject.
211       new_matches.DeleteStringAtIndex(0);
212       request.AddCompletions(new_matches);
213       request.GetParsedLine().Shift();
214       request.SetCursorIndex(request.GetCursorIndex() - 1);
215       return sub_command_object->HandleCompletion(request);
216     }
217   }
218 }
219 
220 const char *CommandObjectMultiword::GetRepeatCommand(Args &current_command_args,
221                                                      uint32_t index) {
222   index++;
223   if (current_command_args.GetArgumentCount() <= index)
224     return nullptr;
225   CommandObject *sub_command_object =
226       GetSubcommandObject(current_command_args[index].ref);
227   if (sub_command_object == nullptr)
228     return nullptr;
229   return sub_command_object->GetRepeatCommand(current_command_args, index);
230 }
231 
232 void CommandObjectMultiword::AproposAllSubCommands(llvm::StringRef prefix,
233                                                    llvm::StringRef search_word,
234                                                    StringList &commands_found,
235                                                    StringList &commands_help) {
236   CommandObject::CommandMap::const_iterator pos;
237 
238   for (pos = m_subcommand_dict.begin(); pos != m_subcommand_dict.end(); ++pos) {
239     const char *command_name = pos->first.c_str();
240     CommandObject *sub_cmd_obj = pos->second.get();
241     StreamString complete_command_name;
242 
243     complete_command_name << prefix << " " << command_name;
244 
245     if (sub_cmd_obj->HelpTextContainsWord(search_word)) {
246       commands_found.AppendString(complete_command_name.GetString());
247       commands_help.AppendString(sub_cmd_obj->GetHelp());
248     }
249 
250     if (sub_cmd_obj->IsMultiwordObject())
251       sub_cmd_obj->AproposAllSubCommands(complete_command_name.GetString(),
252                                          search_word, commands_found,
253                                          commands_help);
254   }
255 }
256 
257 CommandObjectProxy::CommandObjectProxy(CommandInterpreter &interpreter,
258                                        const char *name, const char *help,
259                                        const char *syntax, uint32_t flags)
260     : CommandObject(interpreter, name, help, syntax, flags) {}
261 
262 CommandObjectProxy::~CommandObjectProxy() = default;
263 
264 llvm::StringRef CommandObjectProxy::GetHelpLong() {
265   CommandObject *proxy_command = GetProxyCommandObject();
266   if (proxy_command)
267     return proxy_command->GetHelpLong();
268   return llvm::StringRef();
269 }
270 
271 bool CommandObjectProxy::IsRemovable() const {
272   const CommandObject *proxy_command =
273       const_cast<CommandObjectProxy *>(this)->GetProxyCommandObject();
274   if (proxy_command)
275     return proxy_command->IsRemovable();
276   return false;
277 }
278 
279 bool CommandObjectProxy::IsMultiwordObject() {
280   CommandObject *proxy_command = GetProxyCommandObject();
281   if (proxy_command)
282     return proxy_command->IsMultiwordObject();
283   return false;
284 }
285 
286 CommandObjectMultiword *CommandObjectProxy::GetAsMultiwordCommand() {
287   CommandObject *proxy_command = GetProxyCommandObject();
288   if (proxy_command)
289     return proxy_command->GetAsMultiwordCommand();
290   return nullptr;
291 }
292 
293 void CommandObjectProxy::GenerateHelpText(Stream &result) {
294   CommandObject *proxy_command = GetProxyCommandObject();
295   if (proxy_command)
296     return proxy_command->GenerateHelpText(result);
297 }
298 
299 lldb::CommandObjectSP
300 CommandObjectProxy::GetSubcommandSP(llvm::StringRef sub_cmd,
301                                     StringList *matches) {
302   CommandObject *proxy_command = GetProxyCommandObject();
303   if (proxy_command)
304     return proxy_command->GetSubcommandSP(sub_cmd, matches);
305   return lldb::CommandObjectSP();
306 }
307 
308 CommandObject *CommandObjectProxy::GetSubcommandObject(llvm::StringRef sub_cmd,
309                                                        StringList *matches) {
310   CommandObject *proxy_command = GetProxyCommandObject();
311   if (proxy_command)
312     return proxy_command->GetSubcommandObject(sub_cmd, matches);
313   return nullptr;
314 }
315 
316 void CommandObjectProxy::AproposAllSubCommands(llvm::StringRef prefix,
317                                                llvm::StringRef search_word,
318                                                StringList &commands_found,
319                                                StringList &commands_help) {
320   CommandObject *proxy_command = GetProxyCommandObject();
321   if (proxy_command)
322     return proxy_command->AproposAllSubCommands(prefix, search_word,
323                                                 commands_found, commands_help);
324 }
325 
326 bool CommandObjectProxy::LoadSubCommand(
327     llvm::StringRef cmd_name, const lldb::CommandObjectSP &command_sp) {
328   CommandObject *proxy_command = GetProxyCommandObject();
329   if (proxy_command)
330     return proxy_command->LoadSubCommand(cmd_name, command_sp);
331   return false;
332 }
333 
334 bool CommandObjectProxy::WantsRawCommandString() {
335   CommandObject *proxy_command = GetProxyCommandObject();
336   if (proxy_command)
337     return proxy_command->WantsRawCommandString();
338   return false;
339 }
340 
341 bool CommandObjectProxy::WantsCompletion() {
342   CommandObject *proxy_command = GetProxyCommandObject();
343   if (proxy_command)
344     return proxy_command->WantsCompletion();
345   return false;
346 }
347 
348 Options *CommandObjectProxy::GetOptions() {
349   CommandObject *proxy_command = GetProxyCommandObject();
350   if (proxy_command)
351     return proxy_command->GetOptions();
352   return nullptr;
353 }
354 
355 void CommandObjectProxy::HandleCompletion(CompletionRequest &request) {
356   CommandObject *proxy_command = GetProxyCommandObject();
357   if (proxy_command)
358     proxy_command->HandleCompletion(request);
359 }
360 
361 void CommandObjectProxy::HandleArgumentCompletion(
362     CompletionRequest &request, OptionElementVector &opt_element_vector) {
363   CommandObject *proxy_command = GetProxyCommandObject();
364   if (proxy_command)
365     proxy_command->HandleArgumentCompletion(request, opt_element_vector);
366 }
367 
368 const char *CommandObjectProxy::GetRepeatCommand(Args &current_command_args,
369                                                  uint32_t index) {
370   CommandObject *proxy_command = GetProxyCommandObject();
371   if (proxy_command)
372     return proxy_command->GetRepeatCommand(current_command_args, index);
373   return nullptr;
374 }
375 
376 bool CommandObjectProxy::Execute(const char *args_string,
377                                  CommandReturnObject &result) {
378   CommandObject *proxy_command = GetProxyCommandObject();
379   if (proxy_command)
380     return proxy_command->Execute(args_string, result);
381   result.AppendError("command is not implemented");
382   result.SetStatus(eReturnStatusFailed);
383   return false;
384 }
385