Switch at_first_stop to at_initial_stop, and address review comments.

Author: jimingham

lldb/include/lldb/Target/Target.h

@@ -1370,11 +1370,11 @@ class Target : public std::enable_shared_from_this<Target>,
 
     bool GetAutoContinue() const { return m_auto_continue; }
 
-    void SetRunAtFirstStop(bool at_first_stop) {
-      m_at_first_stop = at_first_stop;
+    void SetRunAtInitialStop(bool at_initial_stop) {
+      m_at_initial_stop = at_initial_stop;
     }
 
-    bool GetRunAtFirstStop() const { return m_at_first_stop; }
+    bool GetRunAtInitialStop() const { return m_at_initial_stop; }
 
     void GetDescription(Stream &s, lldb::DescriptionLevel level) const;
     virtual void GetSubclassDescription(Stream &s,
@@ -1386,7 +1386,7 @@ class Target : public std::enable_shared_from_this<Target>,
     std::unique_ptr<ThreadSpec> m_thread_spec_up;
     bool m_active = true;
     bool m_auto_continue = false;
-    bool m_at_first_stop = true;
+    bool m_at_initial_stop = true;
 
     StopHook(lldb::TargetSP target_sp, lldb::user_id_t uid);
   };

lldb/source/Commands/CommandObjectTarget.cpp

@@ -4796,12 +4796,12 @@ class CommandObjectTargetStopHookAdd : public CommandObjectParsed,
         m_one_liner.push_back(std::string(option_arg));
         break;
 
-      case 'F': {
+      case 'I': {
         bool value, success;
         value = OptionArgParser::ToBoolean(option_arg, false, &success);
-        if (success) {
-          m_at_first_stop = value;
-        } else
+        if (success)
+          m_at_initial_stop = value;
+        else
           error = Status::FromErrorStringWithFormat(
               "invalid boolean value '%s' passed for -F option",
               option_arg.str().c_str());
@@ -4833,7 +4833,7 @@ class CommandObjectTargetStopHookAdd : public CommandObjectParsed,
       m_use_one_liner = false;
       m_one_liner.clear();
       m_auto_continue = false;
-      m_at_first_stop = true;
+      m_at_initial_stop = true;
     }
 
     std::string m_class_name;
@@ -4854,7 +4854,7 @@ class CommandObjectTargetStopHookAdd : public CommandObjectParsed,
     // Instance variables to hold the values for one_liner options.
     bool m_use_one_liner = false;
     std::vector<std::string> m_one_liner;
-    bool m_at_first_stop;
+    bool m_at_initial_stop;
 
     bool m_auto_continue = false;
   };
@@ -5020,8 +5020,8 @@ Filter Options:
     if (specifier_up)
       new_hook_sp->SetSpecifier(specifier_up.release());
 
-    // Should we run at first stop:
-    new_hook_sp->SetRunAtFirstStop(m_options.m_at_first_stop);
+    // Should we run at the initial stop:
+    new_hook_sp->SetRunAtInitialStop(m_options.m_at_initial_stop);
 
     // Next see if any of the thread options have been entered:
 

lldb/source/Commands/Options.td

@@ -1052,11 +1052,12 @@ let Command = "target stop hook add" in {
   def target_stop_hook_add_auto_continue : Option<"auto-continue", "G">,
     Arg<"Boolean">, Desc<"The stop-hook will auto-continue after running its"
     " commands.">;
-  def target_stop_hook_add_at_first_stop : Option<"at-first-stop", "F">,
-    Arg<"Boolean">, Desc<"Whether the stop-hook will trigger when lldb first "
-    "gains control of the process.  For a process launch, this first stop "
-    "may happen very early on - before the loader has run.  You might not want "
-    "some stop-hooks to run then.  Defaults to true.">;
+  def target_stop_hook_add_at_initial_stop : Option<"at-initial-stop", "I">,
+    Arg<"Boolean">, Desc<"Whether the stop-hook will trigger when lldb  "
+    "initially gains control of the process.  For a process launch, this "
+    "initial stop may happen very early on - before the loader has run.  You "
+    "can use this option if you do not want some stop-hooks to run then.  "
+    "Defaults to true.">;
 }
 
 let Command = "thread backtrace" in {

lldb/source/Target/Process.cpp

@@ -2832,7 +2832,7 @@ Status Process::LoadCore() {
     RestoreProcessEvents();
     // Since we hijacked the event stream, we will have we won't have run the
     // stop hooks.  Make sure we do that here:
-    GetTarget().RunStopHooks(true /* at_initial_stop */);
+    GetTarget().RunStopHooks(/* at_initial_stop= */ true);
   }
   return error;
 }
@@ -3205,7 +3205,7 @@ void Process::CompleteAttach() {
   }
   // Since we hijacked the event stream, we will have we won't have run the
   // stop hooks.  Make sure we do that here:
-  GetTarget().RunStopHooks(true /* at_initial_stop */);
+  GetTarget().RunStopHooks(/* at_initial_stop= */ true);
 }
 
 Status Process::ConnectRemote(llvm::StringRef remote_url) {

lldb/source/Target/Target.cpp

@@ -3056,7 +3056,7 @@ bool Target::RunStopHooks(bool at_initial_stop) {
 
   bool no_active_hooks =
       llvm::none_of(m_stop_hooks, [at_initial_stop](auto &p) {
-        bool should_run_now = !at_initial_stop || p.second->GetRunAtFirstStop();
+        bool should_run_now = !at_initial_stop || p.second->GetRunAtInitialStop();
         return p.second->IsActive() && should_run_now;
       });
   if (no_active_hooks)
@@ -3100,8 +3100,9 @@ bool Target::RunStopHooks(bool at_initial_stop) {
           m_process_sp.get(), thread_to_use_sp.get(),
           thread_to_use_sp->GetStackFrameAtIndex(0).get());
       num_exe_ctx = 1;
-    } else
+    } else {
       return false;
+    }
   }
 
   StreamSP output_sp = m_debugger.GetAsyncOutputStream();
@@ -3116,7 +3117,7 @@ bool Target::RunStopHooks(bool at_initial_stop) {
     StopHookSP cur_hook_sp = stop_entry.second;
     if (!cur_hook_sp->IsActive())
       continue;
-    if (at_initial_stop && !cur_hook_sp->GetRunAtFirstStop())
+    if (at_initial_stop && !cur_hook_sp->GetRunAtInitialStop())
       continue;
 
     bool any_thread_matched = false;
@@ -3606,7 +3607,7 @@ Status Target::Attach(ProcessAttachInfo &attach_info, Stream *stream) {
 
       // Run the stop hooks here.  Since we were hijacking the events, they
       // wouldn't have gotten run as part of event delivery.
-      RunStopHooks(true /* at_initial_stop */);
+      RunStopHooks(/* at_initial_stop= */ true);
 
       if (state != eStateStopped) {
         const char *exit_desc = process_sp->GetExitDescription();

lldb/test/API/commands/target/stop-hooks/TestStopHookScripted.py

@@ -50,7 +50,7 @@ def test_bad_handler(self):
 
     def test_stop_hooks_scripted(self):
         """Test that a scripted stop hook works with no specifiers"""
-        self.stop_hooks_scripted(5, "-F false")
+        self.stop_hooks_scripted(5, "-I false")
 
     def test_stop_hooks_scripted_no_entry(self):
         """Test that a scripted stop hook works with no specifiers"""

lldb/test/API/commands/target/stop-hooks/TestStopHooks.py

@@ -55,7 +55,7 @@ def step_out_test(self):
     def after_expr_test(self):
         interp = self.dbg.GetCommandInterpreter()
         result = lldb.SBCommandReturnObject()
-        interp.HandleCommand("target stop-hook add -o 'expr g_var++' -F false", result)
+        interp.HandleCommand("target stop-hook add -o 'expr g_var++' -I false", result)
         self.assertTrue(result.Succeeded(), "Set the target stop hook")
 
         (target, process, thread, first_bkpt) = lldbutil.run_to_source_breakpoint(