Debugger: Add dbg.logexec option to log debugger script execution output (fixes #1121) (#1122)

* Fixes issue #1121

* make exec log output more conform Prompt UI

* removed double run(command)

* Use red when not able to write exec output to file

* Added `logExec` as debug command + updated documentation

* allow for toggling logExec in script

* dbg.logexec checked at start of exec run

* Added dbg.script command line parameter

Author: dionoid

docs/debugger.html

@@ -300,6 +300,14 @@ <h2><a name="Startup">Startup</a></h2>
     the current settings. You can also manually edit the file and add more commands.
     </br></br>
   </li>
+  <li>
+    Script specified via "-dbg.script" command line parameter</br>
+    You can specify a custom script file to be executed at debugger startup using
+    the <b>-dbg.script &lt;file&gt;</b> command line parameter. This script will be
+    executed after "autoexec.script" and "&lt;rom_filename&gt;.script" (if present),
+    allowing you to override or extend their settings for specific debugging sessions.
+    </br></br>
+  </li>
   <li>
     "&lt;rom_filename&gt;.cfg"</br>
     This file is described in <a href="#DistellaConfiguration">
@@ -1007,6 +1015,7 @@ <h3><a name="PromptCommands">Prompt Commands</a></h3>
     loadAllStates - Load all emulator states
         loadState - Load emulator state xx (0-9)
         logBreaks - Logs breaks and traps and continues emulation
+          logExec - Logs script execution output to file when enabled
          logTrace - Logs emulation (note: emulation may slow down and the log becomes huge soon)
                 n - Negative Flag: set (0 or 1), or toggle (no arg)
           palette - Show current TIA palette

docs/index.html

@@ -3436,6 +3436,18 @@ <h2><b><a name="CommandLine">Using the Command Line</a></b></h2>
       <td>Debugger considers/ignores 'ghost' reads for trap addresses</td>
     </tr>
 
+    <tr>
+      <td><pre>-dbg.logexec &lt;0|1&gt;</pre></td>
+      <td>Log script execution output to file. When enabled, the 'exec' command
+        writes all command results to [script_path].output.txt</td>
+    </tr>
+
+    <tr>
+      <td><pre>-dbg.script &lt;file&gt;</pre></td>
+      <td>Execute the specified script file on debugger startup. The script will be
+        executed after autoexec.script and [romname].script (if present)</td>
+    </tr>
+
     <tr>
       <td><pre>-dbg.uhex &lt;0|1&gt;</pre></td>
       <td>Lower-/uppercase HEX display</td>

src/debugger/Debugger.cxx

@@ -180,6 +180,14 @@ string Debugger::autoExec(StringList* history)
   const FSNode romname(path);
   buf << myParser->exec(romname, history) << '\n';
 
+  // Also, script specified via -dbg.script command line parameter
+  const string scriptPath = myOSystem.settings().getString("dbg.script");
+  if(!scriptPath.empty())
+  {
+    const FSNode script(scriptPath);
+    buf << myParser->exec(script, history) << '\n';
+  }
+
   // Init builtins
   for(const auto& func: ourBuiltinFunctions)
   {

src/debugger/DebuggerParser.cxx

@@ -132,27 +132,54 @@ string DebuggerParser::run(string_view command)
 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 string DebuggerParser::exec(const FSNode& file, StringList* history)
 {
+  const bool logExec = settings.getBool("dbg.logexec");
+
   if(file.exists())
   {
     stringstream in;
     try        { file.read(in); }
     catch(...) { return red("script file \'" + file.getShortPath() + "\' not found"); }
 
     ostringstream buf;
+    stringstream logBuf; // used to log the results of commands, if enabled
     int count = 0;
     string command;
     while( !in.eof() )
     {
       if(!getline(in, command))
         break;
 
+      // skip empty/comment lines
+      command = BSPF::trim(command);
+      if(command.empty() || command[0] == ';')
+        continue;
+
       ++execDepth;
-      run(command);
+      if(logExec)
+      {
+        logBuf << "> " << command << '\n';
+        const string result = run(command);
+        if(!result.empty() && result != "_EXIT_DEBUGGER" && result != "_NO_PROMPT")
+          logBuf << result << '\n';
+      }
+      else
+      {
+        run(command);
+      }
       --execDepth;
       if (history != nullptr)
         history->push_back(command);
       count++;
     }
+
+    // write execution log if enabled
+    if(logExec && !logBuf.str().empty())
+    {
+      const FSNode logNode(file.getPath() + ".output.txt");
+      try        { logNode.write(logBuf);}
+      catch(...) { buf << red("\nUnable to write exec output to file \'" + logNode.getShortPath() + "\'\n"); }
+    }
+
     buf << "\nExecuted " << count << " command" << (count != 1 ? "s" : "") << " from \""
         << file.getShortPath() << "\"";
 
@@ -1844,6 +1871,15 @@ void DebuggerParser::executeLogBreaks()
   commandResult << "logBreaks " << (enable ? "enabled" : "disabled");
 }
 
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+void DebuggerParser::executeLogExec()
+{
+  const bool enable = !settings.getBool("dbg.logexec");
+
+  settings.setValue("dbg.logexec", enable);
+  commandResult << "logExec " << (enable ? "enabled" : "disabled");
+}
+
 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 void DebuggerParser::executeLogTrace()
 {
@@ -3421,6 +3457,16 @@ DebuggerParser::CommandArray DebuggerParser::commands = { {
     std::mem_fn(&DebuggerParser::executeLogBreaks)
   },
 
+  {
+    "logExec",
+    "Toggle script execution logging to file",
+    "Example: logExec (no parameters)",
+    false,
+    true,
+    { Parameters::ARG_END_ARGS },
+    std::mem_fn(&DebuggerParser::executeLogExec)
+  },
+
   {
     "logTrace",
     "Toggle emulation logging",

src/debugger/DebuggerParser.hxx

@@ -103,7 +103,7 @@ class DebuggerParser
       std::array<Parameters, 10> parms;
       std::function<void (DebuggerParser*)> executor;
     };
-    using CommandArray = std::array<Command, 111>;
+    using CommandArray = std::array<Command, 112>;
     static CommandArray commands;
 
     struct Trap
@@ -214,6 +214,7 @@ class DebuggerParser
     void executeLoadConfig();
     void executeLoadState();
     void executeLogBreaks();
+    void executeLogExec();
     void executeLogTrace();
     void executeN();
     void executePalette();

src/emucore/Settings.cxx

@@ -235,8 +235,10 @@ Settings::Settings()
   setPermanent("dbg.uhex", "false");
   setPermanent("dbg.ghostreadstrap", "true");
   setPermanent("dbg.logbreaks", "false");
+  setPermanent("dbg.logexec", "false");
   setPermanent("dbg.logtrace", "false");
   setPermanent("dbg.autosave", "false");
+  setPermanent("dbg.script", "");
   setPermanent("dis.resolve", "true");
   setPermanent("dis.gfxformat", "2");
   setPermanent("dis.showaddr", "true");
@@ -737,8 +739,10 @@ void Settings::usage()
     << "   -dbg.ghostreadstrap <1|0>     Debugger traps on 'ghost' reads\n"
     << "   -dbg.uhex      <0|1>          Lower-/uppercase HEX display\n"
     << "   -dbg.logbreaks <0|1>          Log breaks and traps and continue emulation\n"
+    << "   -dbg.logexec   <0|1>          Log script execution output to file\n"
     << "   -dbg.logtrace  <0|1>          Log emulation\n"
     << "   -dbg.autosave  <0|1>          Automatically save breaks, traps etc.\n"
+    << "   -dbg.script    <file>         Execute script file on debugger startup\n"
     << "   -break         <address>      Set a breakpoint at 'address'\n"
     << "   -debug                        Start in debugger mode\n\n"
     << "   -bs          <arg>          Sets the 'Cartridge.Type' (bankswitch) property\n"