[lldb] tab completion for 'command delete/unalias'

[MrHate]

Summary

Provided dedicated tab completions for command delete/unalias.

[JDevlieghere]

lldb/source/Commands/CommandObjectCommands.cpp

624

Spurious newline

628

Given that this is tied to the for loop I'd expect the newline before rather than after this line.

629

Can we use a range-based for loop?

[teemperor]

lldb/test/API/functionalities/completion/TestCompletion.py

405

I think this should be a longer command name than just 'f' that you can test searching the prefix. E.g. "long_command" (and complete from "long_". Also maybe add a second command that doesn't match the prefix to make sure we don't hit that ("other_command").

[MrHate]

1. modified newlines;
2. using range-based for-loop now;
3. modified the test case.

[teemperor]

LGTM now, thanks!

lldb/source/Commands/CommandObjectCommands.cpp

719

FWIW, I think you can just inline the variable into the loop. I can do that for you when I merge this.

[JDevlieghere]

lldb/source/Commands/CommandObjectCommands.cpp

628

for (const auto& alias : m_interpreter.GetAliases()) {

719

+1

lldb/include/lldb/Interpreter/CommandInterpreter.h

public:
 
   bool GetEchoCommentCommands() const;
   void SetEchoCommentCommands(bool enable);
 
   const CommandObject::CommandMap &GetUserCommands() const {
     return m_user_dict;
   }
 
+  const CommandObject::CommandMap &GetCommands() const {
+    return m_command_dict;
+  }
+
+  const CommandObject::CommandMap &GetAliases() const { return m_alias_dict; }
+
   /// Specify if the command interpreter should allow that the user can
   /// specify a custom exit code when calling 'quit'.
   void AllowExitCodeOnQuit(bool allow);
 
   /// Sets the exit code for the quit command.
   /// \param[in] exit_code
   ///     The exit code that the driver should return on exit.
   /// \return True if the exit code was successfully set; false if the

lldb/source/Commands/CommandObjectCommands.cpp

CommandObjectCommandsUnalias(CommandInterpreter &interpreter)
     arg.push_back(alias_arg);
 
     // Push the data for the first argument into the m_arguments vector.
     m_arguments.push_back(arg);
   }
 
   ~CommandObjectCommandsUnalias() override = default;
 
+  void
+  HandleArgumentCompletion(CompletionRequest &request,
+                           OptionElementVector &opt_element_vector) override {
+    if (!m_interpreter.HasCommands() || request.GetCursorIndex() != 0)
+      return;
+
+    for (const auto &ent : m_interpreter.GetAliases()) {
+      request.TryCompleteCurrentArg(ent.first, ent.second->GetHelp());
+    }
+  }
+
 protected:
   bool DoExecute(Args &args, CommandReturnObject &result) override {
     CommandObject::CommandMap::iterator pos;
     CommandObject *cmd_obj;
 
     if (args.empty()) {
       result.AppendError("must call 'unalias' with a valid alias");
       result.SetStatus(eReturnStatusFailed);
CommandObjectCommandsDelete(CommandInterpreter &interpreter)
     arg.push_back(alias_arg);
 
     // Push the data for the first argument into the m_arguments vector.
     m_arguments.push_back(arg);
   }
 
   ~CommandObjectCommandsDelete() override = default;
 
+  void
+  HandleArgumentCompletion(CompletionRequest &request,
+                           OptionElementVector &opt_element_vector) override {
+    if (!m_interpreter.HasCommands() || request.GetCursorIndex() != 0)
+      return;
+
+    for (const auto &ent : m_interpreter.GetCommands()) {
+      if (ent.second->IsRemovable())
+        request.TryCompleteCurrentArg(ent.first, ent.second->GetHelp());
+    }
+  }
+
 protected:
   bool DoExecute(Args &args, CommandReturnObject &result) override {
     CommandObject::CommandMap::iterator pos;
 
     if (args.empty()) {
       result.AppendErrorWithFormat("must call '%s' with one or more valid user "
                                    "defined regular expression command names",
                                    GetCommandName().str().c_str());

lldb/test/API/functionalities/completion/TestCompletion.py

def test_command_argument_completion(self):
         self.complete_from_to("watchpoint set variable foo --watch ", ["read", "write", "read_write"])
         self.complete_from_to("watchpoint set variable foo --watch w", "watchpoint set variable foo --watch write")
         self.complete_from_to('watchpoint set variable foo -w read_', 'watchpoint set variable foo -w read_write')
 
     def test_command_script_delete(self):
         self.runCmd("command script add -h test_desc -f none -s current usercmd1")
         self.check_completion_with_desc('command script delete ', [['usercmd1', 'test_desc']])
 
+    def test_command_delete(self):
+        self.runCmd(r"command regex test_command s/^$/finish/ 's/([0-9]+)/frame select %1/'")
+        self.complete_from_to('command delete test_c', 'command delete test_command')
+
+    def test_command_unalias(self):
+        self.complete_from_to('command unalias ima', 'command unalias image')
+
     def test_completion_description_commands(self):
         """Test descriptions of top-level command completions"""
         self.check_completion_with_desc("", [
             ["command", "Commands for managing custom LLDB commands."],
             ["breakpoint", "Commands for operating on breakpoints (see 'help b' for shorthand.)"]
         ])
 
         self.check_completion_with_desc("pl", [