Code review changes -- update help text and usage text, fix format specifier, add thread ID completion

Author: mdko

lldb/include/lldb/Interpreter/CommandCompletions.h

@@ -120,6 +120,9 @@ class CommandCompletions {
                                 CompletionRequest &request,
                                 SearchFilter *searcher);
 
+  static void ThreadIDs(CommandInterpreter &interpreter,
+                        CompletionRequest &request, SearchFilter *searcher);
+
   /// This completer works for commands whose only arguments are a command path.
   /// It isn't tied to an argument type because it completes not on a single
   /// argument but on the sequence of arguments, so you have to invoke it by

lldb/include/lldb/Interpreter/CommandOptionArgumentTable.h

@@ -191,6 +191,7 @@ static constexpr OptionEnumValueElement g_completion_type[] = {
      "Completes to a remote disk directory."},
     {lldb::eTypeCategoryNameCompletion, "type-category-name",
      "Completes to a type category name."},
+    {lldb::eThreadIDCompletion, "thread-id", "Completes to a thread ID."},
     {lldb::eCustomCompletion, "custom", "Custom completion."},
 };
 

lldb/include/lldb/lldb-enumerations.h

@@ -1296,10 +1296,11 @@ enum CompletionType {
   eRemoteDiskFileCompletion = (1u << 22),
   eRemoteDiskDirectoryCompletion = (1u << 23),
   eTypeCategoryNameCompletion = (1u << 24),
+  eThreadIDCompletion = (1u << 25),
   // This item serves two purposes.  It is the last element in the enum, so
   // you can add custom enums starting from here in your Option class. Also
   // if you & in this bit the base code will not process the option.
-  eCustomCompletion = (1u << 25)
+  eCustomCompletion = (1u << 26)
 };
 
 } // namespace lldb

lldb/source/Commands/CommandCompletions.cpp

@@ -83,6 +83,7 @@ bool CommandCompletions::InvokeCommonCompletionCallbacks(
        CommandCompletions::RemoteDiskDirectories},
       {lldb::eTypeCategoryNameCompletion,
        CommandCompletions::TypeCategoryNames},
+      {lldb::eThreadIDCompletion, CommandCompletions::ThreadIDs},
       {lldb::CompletionType::eNoCompletion,
        nullptr} // This one has to be last in the list.
   };
@@ -807,6 +808,23 @@ void CommandCompletions::TypeCategoryNames(CommandInterpreter &interpreter,
       });
 }
 
+void CommandCompletions::ThreadIDs(CommandInterpreter &interpreter,
+                                   CompletionRequest &request,
+                                   SearchFilter *searcher) {
+  const ExecutionContext &exe_ctx = interpreter.GetExecutionContext();
+  if (!exe_ctx.HasProcessScope())
+    return;
+
+  ThreadList &threads = exe_ctx.GetProcessPtr()->GetThreadList();
+  lldb::ThreadSP thread_sp;
+  for (uint32_t idx = 0; (thread_sp = threads.GetThreadAtIndex(idx)); ++idx) {
+    StreamString strm;
+    thread_sp->GetStatus(strm, 0, 1, 1, true);
+    request.TryCompleteCurrentArg(std::to_string(thread_sp->GetID()),
+                                  strm.GetString());
+  }
+}
+
 void CommandCompletions::CompleteModifiableCmdPathArgs(
     CommandInterpreter &interpreter, CompletionRequest &request,
     OptionElementVector &opt_element_vector) {

lldb/source/Commands/CommandObjectThread.cpp

@@ -1172,7 +1172,8 @@ class CommandObjectThreadSelect : public CommandObjectParsed {
 
   CommandObjectThreadSelect(CommandInterpreter &interpreter)
       : CommandObjectParsed(interpreter, "thread select",
-                            "Change the currently selected thread.", nullptr,
+                            "Change the currently selected thread.",
+                            "thread select <thread-index> (or -t <thread-id>)",
                             eCommandRequiresProcess | eCommandTryTargetAPILock |
                                 eCommandProcessMustBeLaunched |
                                 eCommandProcessMustBePaused) {
@@ -1241,15 +1242,15 @@ class CommandObjectThreadSelect : public CommandObjectParsed {
       }
       new_thread = process->GetThreadList().FindThreadByIndexID(index_id).get();
       if (new_thread == nullptr) {
-        result.AppendErrorWithFormat("Invalid thread #%s.\n",
+        result.AppendErrorWithFormat("Invalid thread index #%s.\n",
                                      command.GetArgumentAtIndex(0));
         return;
       }
     } else {
       new_thread =
           process->GetThreadList().FindThreadByID(m_options.m_thread_id).get();
       if (new_thread == nullptr) {
-        result.AppendErrorWithFormat("Invalid thread ID %lu.\n",
+        result.AppendErrorWithFormat("Invalid thread ID %" PRIu64 ".\n",
                                      m_options.m_thread_id);
         return;
       }

lldb/source/Commands/Options.td

@@ -1119,7 +1119,8 @@ let Command = "thread plan list" in {
 
 let Command = "thread select" in {
   def thread_select_thread_id : Option<"thread-id", "t">, Group<2>,
-    Arg<"ThreadID">, Desc<"Provide a thread ID instead of a thread index.">;
+    Arg<"ThreadID">, Completion<"ThreadID">,
+    Desc<"Provide a thread ID instead of a thread index.">;
 }
 
 let Command = "thread trace dump function calls" in {

lldb/test/API/commands/thread/select/TestThreadSelect.py

@@ -36,7 +36,7 @@ def test_invalid_arg(self):
         self.expect(
             "thread select 0xffffffff",
             error=True,
-            startstr="error: Invalid thread #0xffffffff.",
+            startstr="error: Invalid thread index #0xffffffff.",
         )
         self.expect(
             "thread select -t 0xffffffff",