Add 'W'atch command to debugger and improve help:
Ilya Zakharevich [Wed, 26 Nov 1997 17:05:57 +0000 (12:05 -0500)]
Subject: 5.004_55: Debugger patch again

p4raw-id: //depot/perl@317

lib/perl5db.pl

index d5dbfbd..df56723 100644 (file)
@@ -2,7 +2,7 @@ package DB;
 
 # Debugger for Perl 5.00x; perl5db.pl patch level:
 
-$VERSION = 1.01;
+$VERSION = 1.02;
 $header = "perl5db.pl version $VERSION";
 
 # Enhanced by ilya@math.ohio-state.edu (Ilya Zakharevich)
@@ -381,8 +381,29 @@ sub DB {
        }
     }
     my $was_signal = $signal;
+    if ($trace & 2) {
+      for (my $n = 0; $n <= $#to_watch; $n++) {
+       $evalarg = $to_watch[$n];
+       my ($val) = &eval;      # Fix context (&eval is doing array)?
+       $val = ( (defined $val) ? "'$val'" : 'undef' );
+       if ($val ne $old_watch[$n]) {
+         $signal = 1;
+         print $OUT <<EOP;
+Watchpoint $n: $to_watch[$n] changed:
+old value: $old_watch[$n]
+new value: $val
+EOP
+         $old_watch[$n] = $val;
+       }
+      }
+    }
+    if ($trace & 4) {          # User-installed watch
+      return if watchfunction($package, $filename, $line) 
+       and not $single and not $was_signal and not ($trace & ~4);
+    }
+    $was_signal = $signal;
     $signal = 0;
-    if ($single || $trace || $was_signal) {
+    if ($single || ($trace & 1) || $was_signal) {
        $term || &setterm;
        if ($emacs) {
            $position = "\032\032$filename:$line:0\n";
@@ -449,24 +470,25 @@ sub DB {
                    eval "\$cmd =~ $alias{$i}", print $OUT $@ if $alias{$i};
                    $cmd =~ /^q$/ && ($exiting = 1) && exit 0;
                    $cmd =~ /^h$/ && do {
-                       print $OUT $help;
+                       print_help($help);
                        next CMD; };
                    $cmd =~ /^h\s+h$/ && do {
-                       print $OUT $summary;
+                       print_help($summary);
                        next CMD; };
                    $cmd =~ /^h\s+(\S)$/ && do {
                        my $asked = "\Q$1";
-                       if ($help =~ /^$asked/m) {
-                         while ($help =~ /^($asked([\s\S]*?)\n)(\Z|[^\s$asked])/mg) {
-                           print $OUT $1;
+                       if ($help =~ /^(?:[IB]<)$asked/m) {
+                         while ($help =~ /^((?:[IB]<)$asked([\s\S]*?)\n)(?!\s)/mg) {
+                           print_help($1);
                          }
                        } else {
-                           print $OUT "`$asked' is not a debugger command.\n";
+                           print_help("B<$asked> is not a debugger command.\n");
                        }
                        next CMD; };
                    $cmd =~ /^t$/ && do {
-                       $trace = !$trace;
-                       print $OUT "Trace = ".($trace?"on":"off")."\n";
+                       ($trace & 1) ? ($trace &= ~1) : ($trace |= 1);
+                       print $OUT "Trace = " .
+                           (($trace & 1) ? "on" : "off" ) . "\n";
                        next CMD; };
                    $cmd =~ /^S(\s+(!)?(.+))?$/ && do {
                        $Srev = defined $2; $Spatt = $3; $Snocheck = ! defined $1;
@@ -686,6 +708,14 @@ sub DB {
                          last if $signal;
                        }
                      }
+                     if ($trace & 2) {
+                       print $OUT "Watch-expressions:\n";
+                       my $expr;
+                       for $expr (@to_watch) {
+                         print $OUT " $expr\n";
+                         last if $signal;
+                       }
+                     }
                      next CMD; };
                    $cmd =~ /^b\b\s*load\b\s*(.*)/ && do {
                        my $file = $1; $file =~ s/\s+$//;
@@ -925,6 +955,18 @@ sub DB {
                    $cmd =~ /^T$/ && do {
                        print_trace($OUT, 1); # skip DB
                        next CMD; };
+                   $cmd =~ /^W\s*$/ && do {
+                       $trace &= ~2;
+                       @to_watch = @old_watch = ();
+                       next CMD; };
+                   $cmd =~ /^W\b\s*(.*)/s && do {
+                       push @to_watch, $1;
+                       $evalarg = $1;
+                       my ($val) = &eval;
+                       $val = (defined $val) ? "'$val'" : 'undef' ;
+                       push @old_watch, $val;
+                       $trace |= 2;
+                       next CMD; };
                    $cmd =~ /^\/(.*)$/ && do {
                        $inpat = $1;
                        $inpat =~ s:([^\\])/$:$1:;
@@ -1062,7 +1104,7 @@ sub DB {
                        $cmd =~ s/^\|+\s*//;
                        redo PIPE; };
                    # XXX Local variants do not work!
-                   $cmd =~ s/^t\s/\$DB::trace = 1;\n/;
+                   $cmd =~ s/^t\s/\$DB::trace |= 1;\n/;
                    $cmd =~ s/^s\s/\$DB::single = 1;\n/ && do {$laststep = 's'};
                    $cmd =~ s/^n\s/\$DB::single = 2;\n/ && do {$laststep = 'n'};
                }               # PIPE:
@@ -1176,6 +1218,7 @@ sub eval {
     } elsif ($onetimeDump eq 'methods') {
        methods($res[0]);
     }
+    @res;
 }
 
 sub postponed_sub {
@@ -1678,135 +1721,147 @@ sub list_versions {
 
 sub sethelp {
     $help = "
-T              Stack trace.
-s [expr]       Single step [in expr].
-n [expr]       Next, steps over subroutine calls [in expr].
-<CR>           Repeat last n or s command.
-r              Return from current subroutine.
-c [line|sub]   Continue; optionally inserts a one-time-only breakpoint
+B<T>           Stack trace.
+B<s> [I<expr>] Single step [in I<expr>].
+B<n> [I<expr>] Next, steps over subroutine calls [in I<expr>].
+<B<CR>>                Repeat last B<n> or B<s> command.
+B<r>           Return from current subroutine.
+B<c> [I<line>|I<sub>]  Continue; optionally inserts a one-time-only breakpoint
                at the specified position.
-l min+incr     List incr+1 lines starting at min.
-l min-max      List lines min through max.
-l line         List single line.
-l subname      List first window of lines from subroutine.
-l              List next window of lines.
--              List previous window of lines.
-w [line]       List window around line.
-.              Return to the executed line.
-f filename     Switch to viewing filename. Must be loaded.
-/pattern/      Search forwards for pattern; final / is optional.
-?pattern?      Search backwards for pattern; final ? is optional.
-L              List all breakpoints and actions.
-S [[!]pattern] List subroutine names [not] matching pattern.
-t              Toggle trace mode.
-t expr         Trace through execution of expr.
-b [line] [condition]
-               Set breakpoint; line defaults to the current execution line;
-               condition breaks if it evaluates to true, defaults to '1'.
-b subname [condition]
+B<l> I<min>B<+>I<incr> List I<incr>+1 lines starting at I<min>.
+B<l> I<min>B<->I<max>  List lines I<min> through I<max>.
+B<l> I<line>           List single I<line>.
+B<l> I<subname>        List first window of lines from subroutine.
+B<l>           List next window of lines.
+B<->           List previous window of lines.
+B<w> [I<line>] List window around I<line>.
+B<.>           Return to the executed line.
+B<f> I<filename>       Switch to viewing I<filename>. Must be loaded.
+B</>I<pattern>B</>     Search forwards for I<pattern>; final B</> is optional.
+B<?>I<pattern>B<?>     Search backwards for I<pattern>; final B<?> is optional.
+B<L>           List all breakpoints and actions.
+B<S> [[B<!>]I<pattern>]        List subroutine names [not] matching I<pattern>.
+B<t>           Toggle trace mode.
+B<t> I<expr>           Trace through execution of I<expr>.
+B<b> [I<line>] [I<condition>]
+               Set breakpoint; I<line> defaults to the current execution line;
+               I<condition> breaks if it evaluates to true, defaults to '1'.
+B<b> I<subname> [I<condition>]
                Set breakpoint at first line of subroutine.
-b load filename Set breakpoint on `require'ing the given file.
-b postpone subname [condition]
+B<b> B<load> I<filename> Set breakpoint on `require'ing the given file.
+B<b> B<postpone> I<subname> [I<condition>]
                Set breakpoint at first line of subroutine after 
                it is compiled.
-b compile subname
+B<b> B<compile> I<subname>
                Stop after the subroutine is compiled.
-d [line]       Delete the breakpoint for line.
-D              Delete all breakpoints.
-a [line] command
-               Set an action to be done before the line is executed.
-               Sequence is: check for breakpoint, print line if necessary,
-               do action, prompt user if breakpoint or step, evaluate line.
-A              Delete all actions.
-V [pkg [vars]] List some (default all) variables in package (default current).
-               Use ~pattern and !pattern for positive and negative regexps.
-X [vars]       Same as \"V currentpackage [vars]\".
-x expr         Evals expression in array context, dumps the result.
-m expr         Evals expression in array context, prints methods callable
+B<d> [I<line>] Delete the breakpoint for I<line>.
+B<D>           Delete all breakpoints.
+B<a> [I<line>] I<command>
+               Set an action to be done before the I<line> is executed.
+               Sequence is: check for breakpoint/watchpoint, print line
+               if necessary, do action, prompt user if necessary,
+               execute expression.
+B<A>           Delete all actions.
+B<W> I<expr>           Add a global watch-expression.
+B<W>           Delete all watch-expressions.
+B<V> [I<pkg> [I<vars>]]        List some (default all) variables in package (default current).
+               Use B<~>I<pattern> and B<!>I<pattern> for positive and negative regexps.
+B<X> [I<vars>] Same as \"B<V> I<currentpackage> [I<vars>]\".
+B<x> I<expr>           Evals expression in array context, dumps the result.
+B<m> I<expr>           Evals expression in array context, prints methods callable
                on the first element of the result.
-m class                Prints methods callable via the given class.
-O [opt[=val]] [opt\"val\"] [opt?]...
-               Set or query values of options.  val defaults to 1.  opt can
+B<m> I<class>          Prints methods callable via the given class.
+B<O> [I<opt>[B<=>I<val>]] [I<opt>B<\">I<val>B<\">] [I<opt>B<?>]...
+               Set or query values of options.  I<val> defaults to 1.  I<opt> can
                be abbreviated.  Several options can be listed.
-    recallCommand, ShellBang:  chars used to recall command or spawn shell;
-    pager:                     program for output of \"|cmd\";
-    tkRunning:                 run Tk while prompting (with ReadLine);
-    signalLevel warnLevel dieLevel:    level of verbosity;
-    inhibit_exit               Allows stepping off the end of the script.
-  The following options affect what happens with V, X, and x commands:
-    arrayDepth, hashDepth:     print only first N elements ('' for all);
-    compactDump, veryCompact:  change style of array and hash dump;
-    globPrint:                 whether to print contents of globs;
-    DumpDBFiles:               dump arrays holding debugged files;
-    DumpPackages:              dump symbol tables of packages;
-    quote, HighBit, undefPrint:        change style of string dump;
-  Option PrintRet affects printing of return value after r command,
-         frame    affects printing messages on entry and exit from subroutines.
-         AutoTrace affects printing messages on every possible breaking point.
-        maxTraceLen gives maximal length of evals/args listed in stack trace.
-        ornaments affects screen appearance of the command line.
+    I<recallCommand>, I<ShellBang>:    chars used to recall command or spawn shell;
+    I<pager>:                  program for output of \"|cmd\";
+    I<tkRunning>:                      run Tk while prompting (with ReadLine);
+    I<signalLevel> I<warnLevel> I<dieLevel>:   level of verbosity;
+    I<inhibit_exit>            Allows stepping off the end of the script.
+  The following options affect what happens with B<V>, B<X>, and B<x> commands:
+    I<arrayDepth>, I<hashDepth>:       print only first N elements ('' for all);
+    I<compactDump>, I<veryCompact>:    change style of array and hash dump;
+    I<globPrint>:                      whether to print contents of globs;
+    I<DumpDBFiles>:            dump arrays holding debugged files;
+    I<DumpPackages>:           dump symbol tables of packages;
+    I<quote>, I<HighBit>, I<undefPrint>:       change style of string dump;
+  Option I<PrintRet> affects printing of return value after B<r> command,
+         I<frame>    affects printing messages on entry and exit from subroutines.
+         I<AutoTrace> affects printing messages on every possible breaking point.
+        I<maxTraceLen> gives maximal length of evals/args listed in stack trace.
+        I<ornaments> affects screen appearance of the command line.
                During startup options are initialized from \$ENV{PERLDB_OPTS}.
-               You can put additional initialization options TTY, noTTY,
-               ReadLine, and NonStop there (or use `R' after you set them).
-< command      Define Perl command to run before each prompt.
-<< command     Add to the list of Perl commands to run before each prompt.
-> command      Define Perl command to run after each prompt.
->> command     Add to the list of Perl commands to run after each prompt.
-\{ commandline Define debugger command to run before each prompt.
-\{{ commandline        Add to the list of debugger commands to run before each prompt.
-$prc number    Redo a previous command (default previous command).
-$prc -number   Redo number'th-to-last command.
-$prc pattern   Redo last command that started with pattern.
-               See 'O recallCommand' too.
-$psh$psh cmd   Run cmd in a subprocess (reads from DB::IN, writes to DB::OUT)"
+               You can put additional initialization options I<TTY>, I<noTTY>,
+               I<ReadLine>, and I<NonStop> there (or use `B<R>' after you set them).
+B<<> I<expr>           Define Perl command to run before each prompt.
+B<<<> I<expr>          Add to the list of Perl commands to run before each prompt.
+B<>> I<expr>           Define Perl command to run after each prompt.
+B<>>B<>> I<expr>       Add to the list of Perl commands to run after each prompt.
+B<{> I<db_command>     Define debugger command to run before each prompt.
+B<{{> I<db_command>    Add to the list of debugger commands to run before each prompt.
+B<$prc> I<number>      Redo a previous command (default previous command).
+B<$prc> I<-number>     Redo number'th-to-last command.
+B<$prc> I<pattern>     Redo last command that started with I<pattern>.
+               See 'B<O> I<recallCommand>' too.
+B<$psh$psh> I<cmd>     Run cmd in a subprocess (reads from DB::IN, writes to DB::OUT)"
   . ( $rc eq $sh ? "" : "
-$psh [cmd]     Run cmd in subshell (forces \"\$SHELL -c 'cmd'\")." ) . "
-               See 'O shellBang' too.
-H -number      Display last number commands (default all).
-p expr         Same as \"print {DB::OUT} expr\" in current package.
-|dbcmd         Run debugger command, piping DB::OUT to current pager.
-||dbcmd                Same as |dbcmd but DB::OUT is temporarilly select()ed as well.
-\= [alias value]       Define a command alias, or list current aliases.
-command                Execute as a perl statement in current package.
-v              Show versions of loaded modules.
-R              Pure-man-restart of debugger, some of debugger state
+B<$psh> [I<cmd>]       Run I<cmd> in subshell (forces \"\$SHELL -c 'cmd'\")." ) . "
+               See 'B<O> I<shellBang>' too.
+B<H> I<-number>        Display last number commands (default all).
+B<p> I<expr>           Same as \"I<print {DB::OUT} expr>\" in current package.
+B<|>I<dbcmd>           Run debugger command, piping DB::OUT to current pager.
+B<||>I<dbcmd>          Same as B<|>I<dbcmd> but DB::OUT is temporarilly select()ed as well.
+B<\=> [I<alias> I<value>]      Define a command alias, or list current aliases.
+I<command>             Execute as a perl statement in current package.
+B<v>           Show versions of loaded modules.
+B<R>           Pure-man-restart of debugger, some of debugger state
                and command-line options may be lost.
                Currently the following setting are preserved: 
-               history, breakpoints and actions, debugger Options 
-               and the following command-line options: -w, -I, -e.
-h [db_command] Get help [on a specific debugger command], enter |h to page.
-h h            Summary of debugger commands.
-q or ^D                Quit. Set \$DB::finished to 0 to debug global destruction.
+               history, breakpoints and actions, debugger B<O>ptions 
+               and the following command-line options: I<-w>, I<-I>, I<-e>.
+B<h> [I<db_command>]   Get help [on a specific debugger command], enter B<|h> to page.
+B<h h>         Summary of debugger commands.
+B<q> or B<^D>          Quit. Set \$DB::finished to 0 to debug global destruction.
 
 ";
     $summary = <<"END_SUM";
-List/search source lines:               Control script execution:
-  l [ln|sub]  List source code            T           Stack trace
-  - or .      List previous/current line  s [expr]    Single step [in expr]
-  w [line]    List around line            n [expr]    Next, steps over subs
-  f filename  View source in file         <CR>        Repeat last n or s
-  /pattern/ ?patt?   Search forw/backw    r           Return from subroutine
-  v          Show versions of modules    c [ln|sub]  Continue until position
-Debugger controls:                        L           List break pts & actions
-  O [...]     Set debugger options        t [expr]    Toggle trace [trace expr]
-  <[<] or {[{] [cmd]   Do before prompt   b [ln/event] [c]     Set breakpoint
-  >[>] [cmd]  Do after prompt             b sub [c]   Set breakpoint for sub
-  $prc [N|pat]   Redo a previous command     d [line]    Delete a breakpoint
-  H [-num]    Display last num commands   D           Delete all breakpoints
-  = [a val]   Define/list an alias        a [ln] cmd  Do cmd before line
-  h [db_cmd]  Get help on command         A           Delete all actions
-  |[|]dbcmd   Send output to pager        $psh\[$psh\] syscmd Run cmd in a subprocess
-  q or ^D     Quit                       R           Attempt a restart
-Data Examination:            expr     Execute perl code, also see: s,n,t expr
-  x|m expr     Evals expr in array context, dumps the result or lists methods.
-  p expr       Print expression (uses script's current package).
-  S [[!]pat]   List subroutine names [not] matching pattern
-  V [Pk [Vars]]        List Variables in Package.  Vars can be ~pattern or !pattern.
-  X [Vars]     Same as \"V current_package [Vars]\".
+I<List/search source lines:>               I<Control script execution:>
+  B<l> [I<ln>|I<sub>]  List source code            B<T>           Stack trace
+  B<-> or B<.>      List previous/current line  B<s> [I<expr>]    Single step [in expr]
+  B<w> [I<line>]    List around line            B<n> [I<expr>]    Next, steps over subs
+  B<f> I<filename>  View source in file         <B<CR>>        Repeat last B<n> or B<s>
+  B</>I<pattern>B</> B<?>I<patt>B<?>   Search forw/backw    B<r>           Return from subroutine
+  B<v>       Show versions of modules    B<c> [I<ln>|I<sub>]  Continue until position
+I<Debugger controls:>                        B<L>           List break/watch/actions
+  B<O> [...]     Set debugger options        B<t> [I<expr>]    Toggle trace [trace expr]
+  B<<>[B<<>] or B<{>[B<{>] [I<cmd>]   Do before prompt   B<b> [I<ln>|I<event>] [I<cnd>]  Set breakpoint
+  B<>>[B<>>] [I<cmd>]  Do after prompt             B<b> I<sub> [I<cnd>] Set breakpoint for sub
+  B<$prc> [I<N>|I<pat>]   Redo a previous command     B<d> [I<ln>] or B<D> Delete a/all breakpoints
+  B<H> [I<-num>]    Display last num commands   B<a> [I<ln>] I<cmd>  Do cmd before line
+  B<=> [I<a> I<val>]   Define/list an alias        B<W> I<expr>      Add a watch expression
+  B<h> [I<db_cmd>]  Get help on command         B<A> or B<W>      Delete all actions/watch
+  B<|>[B<|>]I<dbcmd>   Send output to pager        B<$psh>\[B<$psh>\] I<syscmd> Run cmd in a subprocess
+  B<q> or B<^D>     Quit                         B<R>        Attempt a restart
+I<Data Examination:>         B<expr>     Execute perl code, also see: B<s>,B<n>,B<t> I<expr>
+  B<x>|B<m> I<expr>    Evals expr in array context, dumps the result or lists methods.
+  B<p> I<expr> Print expression (uses script's current package).
+  B<S> [[B<!>]I<pat>]  List subroutine names [not] matching pattern
+  B<V> [I<Pk> [I<Vars>]]       List Variables in Package.  Vars can be ~pattern or !pattern.
+  B<X> [I<Vars>]       Same as \"B<V> I<current_package> [I<Vars>]\".
 END_SUM
                                # ')}}; # Fix balance of Emacs parsing
 }
 
+sub print_help {
+  my $message = shift;
+  if (@Term::ReadLine::TermCap::rl_term_set) {
+    $message =~ s/B<([^>]+|>)>/$Term::ReadLine::TermCap::rl_term_set[2]$1$Term::ReadLine::TermCap::rl_term_set[3]/g;
+    $message =~ s/I<([^>]+|>)>/$Term::ReadLine::TermCap::rl_term_set[0]$1$Term::ReadLine::TermCap::rl_term_set[1]/g;
+  }
+  print $OUT $message;
+}
+
 sub diesignal {
     local $frame = 0;
     local $doret = -2;