[lldb] Fix escaping when launching in terminal with AppleScript

[JDevlieghere]

Summary

Fix escaping when launching in terminal with AppleScript. The invocation we're building up is wrapped in single quotes when passed to bash and wrapped in double quotes for AppleScript.

Here's an example invocation with the new escaping:

tell application "Terminal"
   activate
        do script "/bin/bash -c 'arch -arch arm64 '/Users/jonas/llvm/build-ra/bin/darwin-debug' --unix-socket=/tmp/dL2jSh --arch=arm64 --working-dir \"/private/tmp/with spaces\" --disable-aslr --env=\"OS_ACTIVITY_DT_MODE=enable\" --  \"/Users/jonas/llvm/build-ra/bin/lldb-instr\" \"foo bar\" \"baz quux\" ; echo Process exited with status $?';exit"
end tell

Previously we were using unescaped single quotes which resulted in the whole bash invocation being passed in pieces. That works most of the time but breaks when you have a space in your current working directory for example.

rdar://91870763

[aprantl]

lldb/source/Host/macosx/objcxx/Host.mm

222

Should we use raw C++ string literals for this?
https://en.cppreference.com/w/cpp/language/string_literal

267

Is this leftover debugging code?

[aprantl]

I have some trivial suggestions inside, but otherwise, thanks!

[JDevlieghere]

lldb/source/Host/macosx/objcxx/Host.mm

267

Yup, I added that to generate the invocation I put in the summary and forgot to take it out again.

[JDevlieghere]

Address Adrian's code review feedback.

lldb/source/Host/macosx/objcxx/Host.mm

LaunchInNewTerminalWithAppleScript(const char *exe_path,
   darwin_debug_file_spec.GetPath(launcher_path, sizeof(launcher_path));
 
   const ArchSpec &arch_spec = launch_info.GetArchitecture();
   // Only set the architecture if it is valid and if it isn't Haswell (x86_64h).
   if (arch_spec.IsValid() &&
       arch_spec.GetCore() != ArchSpec::eCore_x86_64_x86_64h)
     command.Printf("arch -arch %s ", arch_spec.GetArchitectureName());
 
-  command.Printf("'%s' --unix-socket=%s", launcher_path, unix_socket_name);
+  command.Printf(R"(\"%s\" --unix-socket=%s)", launcher_path, unix_socket_name);
 
   if (arch_spec.IsValid())
     command.Printf(" --arch=%s", arch_spec.GetArchitectureName());
 
   FileSpec working_dir{launch_info.GetWorkingDirectory()};
   if (working_dir)
-    command.Printf(" --working-dir '%s'", working_dir.GetCString());
+    command.Printf(R"( --working-dir \"%s\")", working_dir.GetCString());
   else {
     char cwd[PATH_MAX];
     if (getcwd(cwd, PATH_MAX))
-      command.Printf(" --working-dir '%s'", cwd);
+      command.Printf(R"( --working-dir \"%s\")", cwd);
   }
 
   if (launch_info.GetFlags().Test(eLaunchFlagDisableASLR))
     command.PutCString(" --disable-aslr");
 
   // We are launching on this host in a terminal. So compare the environment on
   // the host to what is supplied in the launch_info. Any items that aren't in
   // the host environment need to be sent to darwin-debug. If we send all
   // environment entries, we might blow the max command line length, so we only
   // send user modified entries.
   Environment host_env = Host::GetEnvironment();
 
   for (const auto &KV : launch_info.GetEnvironment()) {
     auto host_entry = host_env.find(KV.first());
     if (host_entry == host_env.end() || host_entry->second != KV.second)
-      command.Format(" --env='{0}'", Environment::compose(KV));
+      command.Format(R"( --env=\"{0}\")", Environment::compose(KV));
   }
 
   command.PutCString(" -- ");
 
   const char **argv = launch_info.GetArguments().GetConstArgumentVector();
   if (argv) {
     for (size_t i = 0; argv[i] != NULL; ++i) {
       if (i == 0)
-        command.Printf(" '%s'", exe_path);
+        command.Printf(R"( \"%s\")", exe_path);
       else
-        command.Printf(" '%s'", argv[i]);
+        command.Printf(R"( \"%s\")", argv[i]);
     }
   } else {
-    command.Printf(" '%s'", exe_path);
+    command.Printf(R"( \"%s\")", exe_path);
   }
   command.PutCString(" ; echo Process exited with status $?");
   if (launch_info.GetFlags().Test(lldb::eLaunchFlagCloseTTYOnExit))
     command.PutCString(" ; exit");
 
   StreamString applescript_source;
 
   applescript_source.Printf(applscript_in_new_tty,
                             command.GetString().str().c_str());
+
   NSAppleScript *applescript = [[NSAppleScript alloc]
       initWithSource:[NSString stringWithCString:applescript_source.GetString()
                                                      .str()
                                                      .c_str()
                                         encoding:NSUTF8StringEncoding]];
 
   lldb::pid_t pid = LLDB_INVALID_PROCESS_ID;
 
   Status lldb_error;