Revert "[lldb] Remote disk file/directory completion for platform commands"

This reverts commit 7e4e29e.

The test for that fails on Linux, probably because we need some other
commits backported. Let's just revert it's lldb-server specific and that's
anyway not very useful on macOS.

Author: Teemperor

lldb/docs/lldb-platform-packets.txt

@@ -237,27 +237,6 @@ incompatible with the flags that gdb specifies.
 //  Continues to return the results of the qfProcessInfo.  Once all matches
 //  have been sent, Exx is returned to indicate end of matches.
 
-//----------------------------------------------------------------------
-// qPathComplete
-//
-// BRIEF
-//   Get a list of matched disk files/directories by passing a boolean flag
-//   and a partial path.
-//
-// EXAMPLE
-//
-//   receive: qPathComplete:0,6d61696e
-//   send:    M6d61696e2e637070
-//   receive: qPathComplete:1,746573
-//   send:    M746573742f,74657374732f
-//
-//   If the first argument is zero, the result should contain all
-//   files (including directories) starting with the given path. If the
-//   argument is one, the result should contain only directories.
-//
-//   The result should be a comma-separated list of hex-encoded paths.
-//   Paths denoting a directory should end with a directory separator ('/' or '\').
-
 //----------------------------------------------------------------------
 // vFile:size:
 //

lldb/include/lldb/Interpreter/CommandCompletions.h

@@ -47,13 +47,11 @@ class CommandCompletions {
     eBreakpointNameCompletion = (1u << 19),
     eProcessIDCompletion = (1u << 20),
     eProcessNameCompletion = (1u << 21),
-    eRemoteDiskFileCompletion = (1u << 22),
-    eRemoteDiskDirectoryCompletion = (1u << 23),
     eTypeCategoryNameCompletion = (1u << 24),
     // 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 << 24)
+    eCustomCompletion = (1u << 22)
   };
 
   static bool InvokeCommonCompletionCallbacks(
@@ -75,14 +73,6 @@ class CommandCompletions {
                               StringList &matches,
                               TildeExpressionResolver &Resolver);
 
-  static void RemoteDiskFiles(CommandInterpreter &interpreter,
-                              CompletionRequest &request,
-                              SearchFilter *searcher);
-
-  static void RemoteDiskDirectories(CommandInterpreter &interpreter,
-                                    CompletionRequest &request,
-                                    SearchFilter *searcher);
-
   static void SourceFiles(CommandInterpreter &interpreter,
                           CompletionRequest &request, SearchFilter *searcher);
 

lldb/include/lldb/Target/Platform.h

@@ -523,9 +523,6 @@ class Platform : public PluginInterface {
     return UINT64_MAX;
   }
 
-  virtual void AutoCompleteDiskFileOrDirectory(CompletionRequest &request,
-                                               bool only_dir) {}
-
   virtual uint64_t ReadFile(lldb::user_id_t fd, uint64_t offset, void *dst,
                             uint64_t dst_len, Status &error) {
     error.SetErrorStringWithFormat(

lldb/include/lldb/Utility/StringExtractorGDBRemote.h

@@ -76,7 +76,6 @@ class StringExtractorGDBRemote : public StringExtractor {
     eServerPacketType_QSetSTDERR,
     eServerPacketType_QSetWorkingDir,
     eServerPacketType_QStartNoAckMode,
-    eServerPacketType_qPathComplete,
     eServerPacketType_qPlatform_shell,
     eServerPacketType_qPlatform_mkdir,
     eServerPacketType_qPlatform_chmod,

lldb/source/Commands/CommandCompletions.cpp

@@ -74,9 +74,6 @@ bool CommandCompletions::InvokeCommonCompletionCallbacks(
       {eBreakpointNameCompletion, CommandCompletions::BreakpointNames},
       {eProcessIDCompletion, CommandCompletions::ProcessIDs},
       {eProcessNameCompletion, CommandCompletions::ProcessNames},
-      {eRemoteDiskFileCompletion, CommandCompletions::RemoteDiskFiles},
-      {eRemoteDiskDirectoryCompletion,
-       CommandCompletions::RemoteDiskDirectories},
       {eTypeCategoryNameCompletion, CommandCompletions::TypeCategoryNames},
       {eNoCompletion, nullptr} // This one has to be last in the list.
   };
@@ -491,24 +488,6 @@ void CommandCompletions::DiskDirectories(const llvm::Twine &partial_file_name,
   DiskFilesOrDirectories(partial_file_name, true, matches, Resolver);
 }
 
-void CommandCompletions::RemoteDiskFiles(CommandInterpreter &interpreter,
-                                         CompletionRequest &request,
-                                         SearchFilter *searcher) {
-  lldb::PlatformSP platform_sp =
-      interpreter.GetDebugger().GetPlatformList().GetSelectedPlatform();
-  if (platform_sp)
-    platform_sp->AutoCompleteDiskFileOrDirectory(request, false);
-}
-
-void CommandCompletions::RemoteDiskDirectories(CommandInterpreter &interpreter,
-                                               CompletionRequest &request,
-                                               SearchFilter *searcher) {
-  lldb::PlatformSP platform_sp =
-      interpreter.GetDebugger().GetPlatformList().GetSelectedPlatform();
-  if (platform_sp)
-    platform_sp->AutoCompleteDiskFileOrDirectory(request, true);
-}
-
 void CommandCompletions::Modules(CommandInterpreter &interpreter,
                                  CompletionRequest &request,
                                  SearchFilter *searcher) {

lldb/source/Commands/CommandObjectPlatform.cpp

@@ -392,8 +392,7 @@ class CommandObjectPlatformSettings : public CommandObjectParsed {
                             "or for a platform by name.",
                             "platform settings", 0),
         m_options(),
-        m_option_working_dir(LLDB_OPT_SET_1, false, "working-dir", 'w',
-                             CommandCompletions::eRemoteDiskDirectoryCompletion,
+        m_option_working_dir(LLDB_OPT_SET_1, false, "working-dir", 'w', 0,
                              eArgTypePath,
                              "The working directory for the platform.") {
     m_options.Append(&m_option_working_dir, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
@@ -486,15 +485,6 @@ class CommandObjectPlatformFOpen : public CommandObjectParsed {
 
   ~CommandObjectPlatformFOpen() override = default;
 
-  void
-  HandleArgumentCompletion(CompletionRequest &request,
-                           OptionElementVector &opt_element_vector) override {
-    if (request.GetCursorIndex() == 0)
-      CommandCompletions::InvokeCommonCompletionCallbacks(
-          GetCommandInterpreter(),
-          CommandCompletions::eRemoteDiskFileCompletion, request, nullptr);
-  }
-
   bool DoExecute(Args &args, CommandReturnObject &result) override {
     PlatformSP platform_sp(
         GetDebugger().GetPlatformList().GetSelectedPlatform());
@@ -827,19 +817,6 @@ class CommandObjectPlatformGetFile : public CommandObjectParsed {
 
   ~CommandObjectPlatformGetFile() override = default;
 
-  void
-  HandleArgumentCompletion(CompletionRequest &request,
-                           OptionElementVector &opt_element_vector) override {
-    if (request.GetCursorIndex() == 0)
-      CommandCompletions::InvokeCommonCompletionCallbacks(
-          GetCommandInterpreter(),
-          CommandCompletions::eRemoteDiskFileCompletion, request, nullptr);
-    else if (request.GetCursorIndex() == 1)
-      CommandCompletions::InvokeCommonCompletionCallbacks(
-          GetCommandInterpreter(), CommandCompletions::eDiskFileCompletion,
-          request, nullptr);
-  }
-
   bool DoExecute(Args &args, CommandReturnObject &result) override {
     // If the number of arguments is incorrect, issue an error message.
     if (args.GetArgumentCount() != 2) {
@@ -905,17 +882,6 @@ class CommandObjectPlatformGetSize : public CommandObjectParsed {
 
   ~CommandObjectPlatformGetSize() override = default;
 
-  void
-  HandleArgumentCompletion(CompletionRequest &request,
-                           OptionElementVector &opt_element_vector) override {
-    if (request.GetCursorIndex() != 0)
-      return;
-
-    CommandCompletions::InvokeCommonCompletionCallbacks(
-        GetCommandInterpreter(), CommandCompletions::eRemoteDiskFileCompletion,
-        request, nullptr);
-  }
-
   bool DoExecute(Args &args, CommandReturnObject &result) override {
     // If the number of arguments is incorrect, issue an error message.
     if (args.GetArgumentCount() != 1) {
@@ -961,19 +927,6 @@ class CommandObjectPlatformPutFile : public CommandObjectParsed {
 
   ~CommandObjectPlatformPutFile() override = default;
 
-  void
-  HandleArgumentCompletion(CompletionRequest &request,
-                           OptionElementVector &opt_element_vector) override {
-    if (request.GetCursorIndex() == 0)
-      CommandCompletions::InvokeCommonCompletionCallbacks(
-          GetCommandInterpreter(), CommandCompletions::eDiskFileCompletion,
-          request, nullptr);
-    else if (request.GetCursorIndex() == 1)
-      CommandCompletions::InvokeCommonCompletionCallbacks(
-          GetCommandInterpreter(),
-          CommandCompletions::eRemoteDiskFileCompletion, request, nullptr);
-  }
-
   bool DoExecute(Args &args, CommandReturnObject &result) override {
     const char *src = args.GetArgumentAtIndex(0);
     const char *dst = args.GetArgumentAtIndex(1);

lldb/source/Plugins/Platform/gdb-server/PlatformRemoteGDBServer.cpp

@@ -661,11 +661,6 @@ PlatformRemoteGDBServer::GetFileSize(const FileSpec &file_spec) {
   return m_gdb_client.GetFileSize(file_spec);
 }
 
-void PlatformRemoteGDBServer::AutoCompleteDiskFileOrDirectory(
-    CompletionRequest &request, bool only_dir) {
-  m_gdb_client.AutoCompleteDiskFileOrDirectory(request, only_dir);
-}
-
 uint64_t PlatformRemoteGDBServer::ReadFile(lldb::user_id_t fd, uint64_t offset,
                                            void *dst, uint64_t dst_len,
                                            Status &error) {

lldb/source/Plugins/Platform/gdb-server/PlatformRemoteGDBServer.h

@@ -127,9 +127,6 @@ class PlatformRemoteGDBServer : public Platform, private UserIDResolver {
 
   lldb::user_id_t GetFileSize(const FileSpec &file_spec) override;
 
-  void AutoCompleteDiskFileOrDirectory(CompletionRequest &request,
-                                       bool only_dir) override;
-
   Status PutFile(const FileSpec &source, const FileSpec &destination,
                  uint32_t uid = UINT32_MAX, uint32_t gid = UINT32_MAX) override;
 

lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationClient.cpp

@@ -2981,31 +2981,6 @@ lldb::user_id_t GDBRemoteCommunicationClient::GetFileSize(
   return UINT64_MAX;
 }
 
-void GDBRemoteCommunicationClient::AutoCompleteDiskFileOrDirectory(
-    CompletionRequest &request, bool only_dir) {
-  lldb_private::StreamString stream;
-  stream.PutCString("qPathComplete:");
-  stream.PutHex32(only_dir ? 1 : 0);
-  stream.PutChar(',');
-  stream.PutStringAsRawHex8(request.GetCursorArgumentPrefix());
-  StringExtractorGDBRemote response;
-  if (SendPacketAndWaitForResponse(stream.GetString(), response, false) ==
-      PacketResult::Success) {
-    StreamString strm;
-    char ch = response.GetChar();
-    if (ch != 'M')
-      return;
-    while (response.Peek()) {
-      strm.Clear();
-      while ((ch = response.GetHexU8(0, false)) != '\0')
-        strm.PutChar(ch);
-      request.AddCompletion(strm.GetString());
-      if (response.GetChar() != ',')
-        break;
-    }
-  }
-}
-
 Status
 GDBRemoteCommunicationClient::GetFilePermissions(const FileSpec &file_spec,
                                                  uint32_t &file_permissions) {

lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationClient.h

@@ -375,9 +375,6 @@ class GDBRemoteCommunicationClient : public GDBRemoteClientBase {
 
   lldb::user_id_t GetFileSize(const FileSpec &file_spec);
 
-  void AutoCompleteDiskFileOrDirectory(CompletionRequest &request,
-                                       bool only_dir);
-
   Status GetFilePermissions(const FileSpec &file_spec,
                             uint32_t &file_permissions);
 

lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationServerPlatform.cpp

@@ -26,14 +26,12 @@
 #include "lldb/Host/FileAction.h"
 #include "lldb/Host/Host.h"
 #include "lldb/Host/HostInfo.h"
-#include "lldb/Interpreter/CommandCompletions.h"
 #include "lldb/Target/Platform.h"
 #include "lldb/Target/UnixSignals.h"
 #include "lldb/Utility/GDBRemote.h"
 #include "lldb/Utility/Log.h"
 #include "lldb/Utility/StreamString.h"
 #include "lldb/Utility/StructuredData.h"
-#include "lldb/Utility/TildeExpressionResolver.h"
 #include "lldb/Utility/UriParser.h"
 
 #include "lldb/Utility/StringExtractorGDBRemote.h"
@@ -70,9 +68,6 @@ GDBRemoteCommunicationServerPlatform::GDBRemoteCommunicationServerPlatform(
   RegisterMemberFunctionHandler(
       StringExtractorGDBRemote::eServerPacketType_qProcessInfo,
       &GDBRemoteCommunicationServerPlatform::Handle_qProcessInfo);
-  RegisterMemberFunctionHandler(
-      StringExtractorGDBRemote::eServerPacketType_qPathComplete,
-      &GDBRemoteCommunicationServerPlatform::Handle_qPathComplete);
   RegisterMemberFunctionHandler(
       StringExtractorGDBRemote::eServerPacketType_QSetWorkingDir,
       &GDBRemoteCommunicationServerPlatform::Handle_QSetWorkingDir);
@@ -338,38 +333,6 @@ GDBRemoteCommunicationServerPlatform::Handle_qProcessInfo(
   return SendPacketNoLock(response.GetString());
 }
 
-GDBRemoteCommunication::PacketResult
-GDBRemoteCommunicationServerPlatform::Handle_qPathComplete(
-    StringExtractorGDBRemote &packet) {
-  packet.SetFilePos(::strlen("qPathComplete:"));
-  const bool only_dir = (packet.GetHexMaxU32(false, 0) == 1);
-  if (packet.GetChar() != ',')
-    return SendErrorResponse(85);
-  std::string path;
-  packet.GetHexByteString(path);
-
-  StringList matches;
-  StandardTildeExpressionResolver resolver;
-  if (only_dir)
-    CommandCompletions::DiskDirectories(path, matches, resolver);
-  else
-    CommandCompletions::DiskFiles(path, matches, resolver);
-
-  StreamString response;
-  response.PutChar('M');
-  llvm::StringRef separator;
-  std::sort(matches.begin(), matches.end());
-  for (const auto &match : matches) {
-    response << separator;
-    separator = ",";
-    // encode result strings into hex bytes to avoid unexpected error caused by
-    // special characters like '$'.
-    response.PutStringAsRawHex8(match.c_str());
-  }
-
-  return SendPacketNoLock(response.GetString());
-}
-
 GDBRemoteCommunication::PacketResult
 GDBRemoteCommunicationServerPlatform::Handle_qGetWorkingDir(
     StringExtractorGDBRemote &packet) {

lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationServerPlatform.h

@@ -81,8 +81,6 @@ class GDBRemoteCommunicationServerPlatform
 
   PacketResult Handle_qKillSpawnedProcess(StringExtractorGDBRemote &packet);
 
-  PacketResult Handle_qPathComplete(StringExtractorGDBRemote &packet);
-
   PacketResult Handle_qProcessInfo(StringExtractorGDBRemote &packet);
 
   PacketResult Handle_qGetWorkingDir(StringExtractorGDBRemote &packet);

lldb/source/Utility/StringExtractorGDBRemote.cpp

@@ -233,8 +233,6 @@ StringExtractorGDBRemote::GetServerPacketType() const {
         return eServerPacketType_qPlatform_chmod;
       if (PACKET_MATCHES("qProcessInfo"))
         return eServerPacketType_qProcessInfo;
-      if (PACKET_STARTS_WITH("qPathComplete:"))
-        return eServerPacketType_qPathComplete;
       break;
 
     case 'Q':

lldb/test/API/functionalities/gdb_remote_client/TestGDBRemoteDiskFileCompletion.py

@@ -178,8 +178,6 @@ def respond(self, packet):
             return self.qsProcessInfo()
         if packet.startswith("qfProcessInfo"):
             return self.qfProcessInfo(packet)
-        if packet.startswith("qPathComplete:"):
-            return self.qPathComplete()
 
         return self.other(packet)
 
@@ -284,9 +282,6 @@ def QListThreadsInStopReply(self):
     def qMemoryRegionInfo(self):
         return ""
 
-    def qPathComplete(self):
-        return ""
-
     """
     Raised when we receive a packet for which there is no default action.
     Override the responder class to implement behavior suitable for the test at