Fix tab completion for command arguments containing spaces

[tberghammer]

Summary

Fix tab completion for command arguments containing spaces

If a command argument contains a space then it have to be escaped with backslash signs so the argument parsing logic can parse it properly. This CL fixes the tab completion code for the arguments to create completions with correctly escaped strings.

[labath]

source/Interpreter/Options.cpp

996

If there is any chance quotes will appear here (', ", `), you will need to escape those as well, as they are special to the command interpreter. It might be worth making a utility function out of that (Args::GetCommandInterpreterSafeArgument ?), as a canonical way to escape stuff.

[tberghammer]

Address review comment (the function already exists in Args)

[tberghammer]

Move escaping code to Args

[clayborg]

Looks good.

source/Interpreter/Options.cpp

if (completion_mask & CommandCompletions::eSourceFileCompletion
                     if (target_sp)
                         filter_ap.reset (new SearchFilterByModule (target_sp, module_spec));
                 }
                 break;
             }
         }
     }
 
-    return CommandCompletions::InvokeCommonCompletionCallbacks (m_interpreter,
+    bool ret = CommandCompletions::InvokeCommonCompletionCallbacks (m_interpreter,
                                                                     completion_mask,
                                                                     input.GetArgumentAtIndex (opt_arg_pos),
                                                                     match_start_point,
                                                                     max_return_elements,
                                                                     filter_ap.get(),
                                                                     word_complete,
                                                                     matches);
-    
+    // Escape spaces and backslashes in the matches list as the arguments shouldn't contain any of
+    // these characters without escaping.
+    for (size_t i = 0; i < matches.GetSize(); ++i)
+    {
+        std::string s;
+        Args::GetShellSafeArgument(matches[i].c_str(), s);
+        matches[i] = s;
+    }
+    return ret;
 }
 
 
 void
 OptionGroupOptions::Append (OptionGroup* group)
 {
     const OptionDefinition* group_option_defs = group->GetDefinitions ();
     const uint32_t group_option_count = group->GetNumDefinitions();
     for (uint32_t i=0; i<group_option_count; ++i)

test/functionalities/completion/Makefile

+LEVEL = ../../make
+
+CXX_SOURCES := main.cpp
+
+include $(LEVEL)/Makefile.rules

test/functionalities/completion/TestCompletion.py

def test_target_create_dash_co(self):
         self.complete_from_to('target create --co', 'target create --core ')
 
     @expectedFailureHostWindows("llvm.org/pr22274: need a pexpect replacement for windows")
     @skipIfFreeBSD # timing out on the FreeBSD buildbot
     def test_target_va(self):
         """Test that 'target va' completes to 'target variable '."""
         self.complete_from_to('target va', 'target variable ')
 
+    @skipUnlessDarwin
+    @dsym_test
+    def test_symbol_name_dsym(self):
+        self.buildDsym()
+        self.complete_from_to('''file a.out
+                                 breakpoint set -n Fo''',
+                              'breakpoint set -n Foo::Bar(int,\\ int)',
+                              turn_off_re_match=True)
+
+    @dwarf_test
+    def test_symbol_name_dwarf(self):
+        self.buildDwarf()
+        self.complete_from_to('''file a.out
+                                 breakpoint set -n Fo''',
+                              'breakpoint set -n Foo::Bar(int,\\ int)',
+                              turn_off_re_match=True)
+
     def complete_from_to(self, str_input, patterns, turn_off_re_match=False):
         """Test that the completion mechanism completes str_input to patterns,
         where patterns could be a pattern-string or a list of pattern-strings"""
         import pexpect
         # Patterns should not be None in order to proceed.
         self.assertFalse(patterns is None)
         # And should be either a string or list of strings.  Check for list type
         # below, if not, make a list out of the singleton string.  If patterns

test/functionalities/completion/main.cpp

+class Foo
+{
+public:
+    int Bar(int x, int y)
+    {
+        return x + y;
+    }
+};
+
+int main()
+{
+    Foo f;
+    f.Bar(1, 2);
+}