Switch the "command script add" interactive editor to use the exe_ctx interface

[jingham]

Summary

We're suggesting people use the form of the command that takes an exe_ctx - it
is both more convenient and more correct - since you should not be using
GetSelected{Target, Process, etc.} in commands.

Since we write the function template, and this is purely additive, anything you used to enter in this editor mode will still work, you just won't use the new exe_ctx argument. So this shouldn't affect any workflows.

[mib]

LGTM! Thanks!

[JDevlieghere]

Just to make sure I understand: this works because we already supported both variants, and Python picks up the correct one based on the function signature? If so then this LGTM.

[jingham]

In D139684#3984997, @JDevlieghere wrote:

Just to make sure I understand: this works because we already supported both variants, and Python picks up the correct one based on the function signature? If so then this LGTM.

Exactly.

lldb/source/Commands/CommandObjectCommands.cpp

 // CommandObjectCommandsAlias
 
 #define LLDB_OPTIONS_alias
 #include "CommandOptions.inc"
 
 static const char *g_python_command_instructions =
     "Enter your Python command(s). Type 'DONE' to end.\n"
     "You must define a Python function with this signature:\n"
-    "def my_command_impl(debugger, args, result, internal_dict):\n";
+    "def my_command_impl(debugger, args, exe_ctx, result, internal_dict):\n";
 
 class CommandObjectCommandsAlias : public CommandObjectRaw {
 protected:
   class CommandOptions : public OptionGroup {
   public:
     CommandOptions() = default;
 
     ~CommandOptions() override = default;

lldb/source/Plugins/ScriptInterpreter/Python/ScriptInterpreterPython.cpp

bool ScriptInterpreterPythonImpl::GenerateScriptAliasFunction(
 
   // Check to see if we have any data; if not, just return.
   if (user_input.GetSize() == 0)
     return false;
 
   std::string auto_generated_function_name(GenerateUniqueName(
       "lldb_autogen_python_cmd_alias_func", num_created_functions));
 
-  sstr.Printf("def %s (debugger, args, result, internal_dict):",
+  sstr.Printf("def %s (debugger, args, exe_ctx, result, internal_dict):",
               auto_generated_function_name.c_str());
 
   if (!GenerateFunction(sstr.GetData(), user_input).Success())
     return false;
 
   // Store the name of the auto-generated function to be called.
   output.assign(auto_generated_function_name);
   return true;

lldb/test/Shell/Commands/command-script-add.test

+# Test that command script add with no arguments prompts for
+# and generates the modern (exe_ctx) version of the command.
+
+# RUN: %lldb < %s | FileCheck %s
+command script add doit
+print(exe_ctx.target)
+DONE
+doit
+# CHECK: No value