diff options
author | Jim Ingham <jingham@apple.com> | 2016-08-05 22:47:43 +0000 |
---|---|---|
committer | Jim Ingham <jingham@apple.com> | 2016-08-05 22:47:43 +0000 |
commit | b37c918c6a6efe3da811e31e8a4459536a830c13 (patch) | |
tree | d5e12b465c3f9b096bbd9c5e1f3c58d4050e0b4d /lldb/examples | |
parent | 04b2379661e8ab10bb4d09f35773c0a30bd763c0 (diff) |
Mention is_stale in the scripted step doc.
Diffstat (limited to 'lldb/examples')
-rw-r--r-- | lldb/examples/python/scripted_step.py | 36 |
1 files changed, 29 insertions, 7 deletions
diff --git a/lldb/examples/python/scripted_step.py b/lldb/examples/python/scripted_step.py index 6be39718872..d4958e680c1 100644 --- a/lldb/examples/python/scripted_step.py +++ b/lldb/examples/python/scripted_step.py @@ -64,6 +64,19 @@ # to allow you to do whatever cleanup is required. I haven't gotten to that # yet. For now you should do that at the same time you mark your plan complete. # +# 3) After the round of negotiation over whether to stop or not is done, all the +# plans get asked if they are "stale". If they are say they are stale +# then they will get popped. This question is asked with the "is_stale" method. +# +# This is useful, for instance, in the FinishPrintAndContinue plan. What might +# happen here is that after continuing but before the finish is done, the program +# could hit another breakpoint and stop. Then the user could use the step +# command repeatedly until they leave the frame of interest by stepping. +# In that case, the step plan is the one that will be responsible for stopping, +# and the finish plan won't be asked should_stop, it will just be asked if it +# is stale. In this case, if the step_out plan that the FinishPrintAndContinue +# plan is driving is stale, so is ours, and it is time to do our printing. +# # Both examples show stepping through an address range for 20 bytes from the # current PC. The first one does it by single stepping and checking a condition. # It doesn't, however handle the case where you step into another frame while @@ -195,17 +208,26 @@ class FinishPrintAndContinue: self.step_out_thread_plan = thread_plan.QueueThreadPlanForStepOut(0, True) self.thread = self.thread_plan.GetThread() + def is_stale (self): + if self.step_out_thread_plan.IsPlanStale(): + self.do_print() + return True + else: + return False + def explains_stop (self, event): return False def should_stop (self, event): if self.step_out_thread_plan.IsPlanComplete(): - frame_0 = self.thread.frames[0] - rax_value = frame_0.FindRegister("rax") - if rax_value.GetError().Success(): - print "RAX on exit: ", rax_value.GetValue() - else: - print "Couldn't get rax value:", rax_value.GetError().GetCString() - + self.do_print() self.thread_plan.SetPlanComplete(True) return False + + def do_print (self): + frame_0 = self.thread.frames[0] + rax_value = frame_0.FindRegister("rax") + if rax_value.GetError().Success(): + print "RAX on exit: ", rax_value.GetValue() + else: + print "Couldn't get rax value:", rax_value.GetError().GetCString() |