This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Increase perl5db.pl’s version to 1.35
[perl5.git] / lib / perl5db.pl
1
2 =head1 NAME 
3
4 perl5db.pl - the perl debugger
5
6 =head1 SYNOPSIS
7
8     perl -d  your_Perl_script
9
10 =head1 DESCRIPTION
11
12 C<perl5db.pl> is the perl debugger. It is loaded automatically by Perl when
13 you invoke a script with C<perl -d>. This documentation tries to outline the
14 structure and services provided by C<perl5db.pl>, and to describe how you
15 can use them.
16
17 =head1 GENERAL NOTES
18
19 The debugger can look pretty forbidding to many Perl programmers. There are
20 a number of reasons for this, many stemming out of the debugger's history.
21
22 When the debugger was first written, Perl didn't have a lot of its nicer
23 features - no references, no lexical variables, no closures, no object-oriented
24 programming. So a lot of the things one would normally have done using such
25 features was done using global variables, globs and the C<local()> operator 
26 in creative ways.
27
28 Some of these have survived into the current debugger; a few of the more
29 interesting and still-useful idioms are noted in this section, along with notes
30 on the comments themselves.
31
32 =head2 Why not use more lexicals?
33
34 Experienced Perl programmers will note that the debugger code tends to use
35 mostly package globals rather than lexically-scoped variables. This is done
36 to allow a significant amount of control of the debugger from outside the
37 debugger itself.       
38
39 Unfortunately, though the variables are accessible, they're not well
40 documented, so it's generally been a decision that hasn't made a lot of
41 difference to most users. Where appropriate, comments have been added to
42 make variables more accessible and usable, with the understanding that these
43 I<are> debugger internals, and are therefore subject to change. Future
44 development should probably attempt to replace the globals with a well-defined
45 API, but for now, the variables are what we've got.
46
47 =head2 Automated variable stacking via C<local()>
48
49 As you may recall from reading C<perlfunc>, the C<local()> operator makes a 
50 temporary copy of a variable in the current scope. When the scope ends, the
51 old copy is restored. This is often used in the debugger to handle the 
52 automatic stacking of variables during recursive calls:
53
54      sub foo {
55         local $some_global++;
56
57         # Do some stuff, then ...
58         return;
59      }
60
61 What happens is that on entry to the subroutine, C<$some_global> is localized,
62 then altered. When the subroutine returns, Perl automatically undoes the 
63 localization, restoring the previous value. Voila, automatic stack management.
64
65 The debugger uses this trick a I<lot>. Of particular note is C<DB::eval>, 
66 which lets the debugger get control inside of C<eval>'ed code. The debugger
67 localizes a saved copy of C<$@> inside the subroutine, which allows it to
68 keep C<$@> safe until it C<DB::eval> returns, at which point the previous
69 value of C<$@> is restored. This makes it simple (well, I<simpler>) to keep 
70 track of C<$@> inside C<eval>s which C<eval> other C<eval's>.
71
72 In any case, watch for this pattern. It occurs fairly often.
73
74 =head2 The C<^> trick
75
76 This is used to cleverly reverse the sense of a logical test depending on 
77 the value of an auxiliary variable. For instance, the debugger's C<S>
78 (search for subroutines by pattern) allows you to negate the pattern 
79 like this:
80
81    # Find all non-'foo' subs:
82    S !/foo/      
83
84 Boolean algebra states that the truth table for XOR looks like this:
85
86 =over 4
87
88 =item * 0 ^ 0 = 0 
89
90 (! not present and no match) --> false, don't print
91
92 =item * 0 ^ 1 = 1 
93
94 (! not present and matches) --> true, print
95
96 =item * 1 ^ 0 = 1 
97
98 (! present and no match) --> true, print
99
100 =item * 1 ^ 1 = 0 
101
102 (! present and matches) --> false, don't print
103
104 =back
105
106 As you can see, the first pair applies when C<!> isn't supplied, and
107 the second pair applies when it is. The XOR simply allows us to
108 compact a more complicated if-then-elseif-else into a more elegant 
109 (but perhaps overly clever) single test. After all, it needed this
110 explanation...
111
112 =head2 FLAGS, FLAGS, FLAGS
113
114 There is a certain C programming legacy in the debugger. Some variables,
115 such as C<$single>, C<$trace>, and C<$frame>, have I<magical> values composed
116 of 1, 2, 4, etc. (powers of 2) OR'ed together. This allows several pieces
117 of state to be stored independently in a single scalar. 
118
119 A test like
120
121     if ($scalar & 4) ...
122
123 is checking to see if the appropriate bit is on. Since each bit can be 
124 "addressed" independently in this way, C<$scalar> is acting sort of like
125 an array of bits. Obviously, since the contents of C<$scalar> are just a 
126 bit-pattern, we can save and restore it easily (it will just look like
127 a number).
128
129 The problem, is of course, that this tends to leave magic numbers scattered
130 all over your program whenever a bit is set, cleared, or checked. So why do 
131 it?
132
133 =over 4
134
135 =item *
136
137 First, doing an arithmetical or bitwise operation on a scalar is
138 just about the fastest thing you can do in Perl: C<use constant> actually
139 creates a subroutine call, and array and hash lookups are much slower. Is
140 this over-optimization at the expense of readability? Possibly, but the 
141 debugger accesses these  variables a I<lot>. Any rewrite of the code will
142 probably have to benchmark alternate implementations and see which is the
143 best balance of readability and speed, and then document how it actually 
144 works.
145
146 =item *
147
148 Second, it's very easy to serialize a scalar number. This is done in 
149 the restart code; the debugger state variables are saved in C<%ENV> and then
150 restored when the debugger is restarted. Having them be just numbers makes
151 this trivial. 
152
153 =item *
154
155 Third, some of these variables are being shared with the Perl core 
156 smack in the middle of the interpreter's execution loop. It's much faster for 
157 a C program (like the interpreter) to check a bit in a scalar than to access 
158 several different variables (or a Perl array).
159
160 =back
161
162 =head2 What are those C<XXX> comments for?
163
164 Any comment containing C<XXX> means that the comment is either somewhat
165 speculative - it's not exactly clear what a given variable or chunk of 
166 code is doing, or that it is incomplete - the basics may be clear, but the
167 subtleties are not completely documented.
168
169 Send in a patch if you can clear up, fill out, or clarify an C<XXX>.
170
171 =head1 DATA STRUCTURES MAINTAINED BY CORE         
172
173 There are a number of special data structures provided to the debugger by
174 the Perl interpreter.
175
176 The array C<@{$main::{'_<'.$filename}}> (aliased locally to C<@dbline>
177 via glob assignment) contains the text from C<$filename>, with each
178 element corresponding to a single line of C<$filename>. Additionally,
179 breakable lines will be dualvars with the numeric component being the
180 memory address of a COP node. Non-breakable lines are dualvar to 0.
181
182 The hash C<%{'_<'.$filename}> (aliased locally to C<%dbline> via glob 
183 assignment) contains breakpoints and actions.  The keys are line numbers; 
184 you can set individual values, but not the whole hash. The Perl interpreter 
185 uses this hash to determine where breakpoints have been set. Any true value is
186 considered to be a breakpoint; C<perl5db.pl> uses C<$break_condition\0$action>.
187 Values are magical in numeric context: 1 if the line is breakable, 0 if not.
188
189 The scalar C<${"_<$filename"}> simply contains the string C<_<$filename>.
190 This is also the case for evaluated strings that contain subroutines, or
191 which are currently being executed.  The $filename for C<eval>ed strings looks
192 like C<(eval 34)> or C<(re_eval 19)>.
193
194 =head1 DEBUGGER STARTUP
195
196 When C<perl5db.pl> starts, it reads an rcfile (C<perl5db.ini> for
197 non-interactive sessions, C<.perldb> for interactive ones) that can set a number
198 of options. In addition, this file may define a subroutine C<&afterinit>
199 that will be executed (in the debugger's context) after the debugger has 
200 initialized itself.
201
202 Next, it checks the C<PERLDB_OPTS> environment variable and treats its 
203 contents as the argument of a C<o> command in the debugger.
204
205 =head2 STARTUP-ONLY OPTIONS
206
207 The following options can only be specified at startup.
208 To set them in your rcfile, add a call to
209 C<&parse_options("optionName=new_value")>.
210
211 =over 4
212
213 =item * TTY 
214
215 the TTY to use for debugging i/o.
216
217 =item * noTTY 
218
219 if set, goes in NonStop mode.  On interrupt, if TTY is not set,
220 uses the value of noTTY or F<$HOME/.perldbtty$$> to find TTY using
221 Term::Rendezvous.  Current variant is to have the name of TTY in this
222 file.
223
224 =item * ReadLine 
225
226 if false, a dummy ReadLine is used, so you can debug
227 ReadLine applications.
228
229 =item * NonStop 
230
231 if true, no i/o is performed until interrupt.
232
233 =item * LineInfo 
234
235 file or pipe to print line number info to.  If it is a
236 pipe, a short "emacs like" message is used.
237
238 =item * RemotePort 
239
240 host:port to connect to on remote host for remote debugging.
241
242 =item * HistFile
243
244 file to store session history to. There is no default and so no
245 history file is written unless this variable is explicitly set.
246
247 =item * HistSize
248
249 number of commands to store to the file specified in C<HistFile>.
250 Default is 100.
251
252 =back
253
254 =head3 SAMPLE RCFILE
255
256  &parse_options("NonStop=1 LineInfo=db.out");
257   sub afterinit { $trace = 1; }
258
259 The script will run without human intervention, putting trace
260 information into C<db.out>.  (If you interrupt it, you had better
261 reset C<LineInfo> to something I<interactive>!)
262
263 =head1 INTERNALS DESCRIPTION
264
265 =head2 DEBUGGER INTERFACE VARIABLES
266
267 Perl supplies the values for C<%sub>.  It effectively inserts
268 a C<&DB::DB();> in front of each place that can have a
269 breakpoint. At each subroutine call, it calls C<&DB::sub> with
270 C<$DB::sub> set to the called subroutine. It also inserts a C<BEGIN
271 {require 'perl5db.pl'}> before the first line.
272
273 After each C<require>d file is compiled, but before it is executed, a
274 call to C<&DB::postponed($main::{'_<'.$filename})> is done. C<$filename>
275 is the expanded name of the C<require>d file (as found via C<%INC>).
276
277 =head3 IMPORTANT INTERNAL VARIABLES
278
279 =head4 C<$CreateTTY>
280
281 Used to control when the debugger will attempt to acquire another TTY to be
282 used for input. 
283
284 =over   
285
286 =item * 1 -  on C<fork()>
287
288 =item * 2 - debugger is started inside debugger
289
290 =item * 4 -  on startup
291
292 =back
293
294 =head4 C<$doret>
295
296 The value -2 indicates that no return value should be printed.
297 Any other positive value causes C<DB::sub> to print return values.
298
299 =head4 C<$evalarg>
300
301 The item to be eval'ed by C<DB::eval>. Used to prevent messing with the current
302 contents of C<@_> when C<DB::eval> is called.
303
304 =head4 C<$frame>
305
306 Determines what messages (if any) will get printed when a subroutine (or eval)
307 is entered or exited. 
308
309 =over 4
310
311 =item * 0 -  No enter/exit messages
312
313 =item * 1 - Print I<entering> messages on subroutine entry
314
315 =item * 2 - Adds exit messages on subroutine exit. If no other flag is on, acts like 1+2.
316
317 =item * 4 - Extended messages: C<< <in|out> I<context>=I<fully-qualified sub name> from I<file>:I<line> >>. If no other flag is on, acts like 1+4.
318
319 =item * 8 - Adds parameter information to messages, and overloaded stringify and tied FETCH is enabled on the printed arguments. Ignored if C<4> is not on.
320
321 =item * 16 - Adds C<I<context> return from I<subname>: I<value>> messages on subroutine/eval exit. Ignored if C<4> is is not on.
322
323 =back
324
325 To get everything, use C<$frame=30> (or C<o f=30> as a debugger command).
326 The debugger internally juggles the value of C<$frame> during execution to
327 protect external modules that the debugger uses from getting traced.
328
329 =head4 C<$level>
330
331 Tracks current debugger nesting level. Used to figure out how many 
332 C<E<lt>E<gt>> pairs to surround the line number with when the debugger 
333 outputs a prompt. Also used to help determine if the program has finished
334 during command parsing.
335
336 =head4 C<$onetimeDump>
337
338 Controls what (if anything) C<DB::eval()> will print after evaluating an
339 expression.
340
341 =over 4
342
343 =item * C<undef> - don't print anything
344
345 =item * C<dump> - use C<dumpvar.pl> to display the value returned
346
347 =item * C<methods> - print the methods callable on the first item returned
348
349 =back
350
351 =head4 C<$onetimeDumpDepth>
352
353 Controls how far down C<dumpvar.pl> will go before printing C<...> while
354 dumping a structure. Numeric. If C<undef>, print all levels.
355
356 =head4 C<$signal>
357
358 Used to track whether or not an C<INT> signal has been detected. C<DB::DB()>,
359 which is called before every statement, checks this and puts the user into
360 command mode if it finds C<$signal> set to a true value.
361
362 =head4 C<$single>
363
364 Controls behavior during single-stepping. Stacked in C<@stack> on entry to
365 each subroutine; popped again at the end of each subroutine.
366
367 =over 4 
368
369 =item * 0 - run continuously.
370
371 =item * 1 - single-step, go into subs. The C<s> command.
372
373 =item * 2 - single-step, don't go into subs. The C<n> command.
374
375 =item * 4 - print current sub depth (turned on to force this when C<too much
376 recursion> occurs.
377
378 =back
379
380 =head4 C<$trace>
381
382 Controls the output of trace information. 
383
384 =over 4
385
386 =item * 1 - The C<t> command was entered to turn on tracing (every line executed is printed)
387
388 =item * 2 - watch expressions are active
389
390 =item * 4 - user defined a C<watchfunction()> in C<afterinit()>
391
392 =back
393
394 =head4 C<$slave_editor>
395
396 1 if C<LINEINFO> was directed to a pipe; 0 otherwise.
397
398 =head4 C<@cmdfhs>
399
400 Stack of filehandles that C<DB::readline()> will read commands from.
401 Manipulated by the debugger's C<source> command and C<DB::readline()> itself.
402
403 =head4 C<@dbline>
404
405 Local alias to the magical line array, C<@{$main::{'_<'.$filename}}> , 
406 supplied by the Perl interpreter to the debugger. Contains the source.
407
408 =head4 C<@old_watch>
409
410 Previous values of watch expressions. First set when the expression is
411 entered; reset whenever the watch expression changes.
412
413 =head4 C<@saved>
414
415 Saves important globals (C<$@>, C<$!>, C<$^E>, C<$,>, C<$/>, C<$\>, C<$^W>)
416 so that the debugger can substitute safe values while it's running, and
417 restore them when it returns control.
418
419 =head4 C<@stack>
420
421 Saves the current value of C<$single> on entry to a subroutine.
422 Manipulated by the C<c> command to turn off tracing in all subs above the
423 current one.
424
425 =head4 C<@to_watch>
426
427 The 'watch' expressions: to be evaluated before each line is executed.
428
429 =head4 C<@typeahead>
430
431 The typeahead buffer, used by C<DB::readline>.
432
433 =head4 C<%alias>
434
435 Command aliases. Stored as character strings to be substituted for a command
436 entered.
437
438 =head4 C<%break_on_load>
439
440 Keys are file names, values are 1 (break when this file is loaded) or undef
441 (don't break when it is loaded).
442
443 =head4 C<%dbline>
444
445 Keys are line numbers, values are C<condition\0action>. If used in numeric
446 context, values are 0 if not breakable, 1 if breakable, no matter what is
447 in the actual hash entry.
448
449 =head4 C<%had_breakpoints>
450
451 Keys are file names; values are bitfields:
452
453 =over 4 
454
455 =item * 1 - file has a breakpoint in it.
456
457 =item * 2 - file has an action in it.
458
459 =back
460
461 A zero or undefined value means this file has neither.
462
463 =head4 C<%option>
464
465 Stores the debugger options. These are character string values.
466
467 =head4 C<%postponed>
468
469 Saves breakpoints for code that hasn't been compiled yet.
470 Keys are subroutine names, values are:
471
472 =over 4
473
474 =item * C<compile> - break when this sub is compiled
475
476 =item * C<< break +0 if <condition> >> - break (conditionally) at the start of this routine. The condition will be '1' if no condition was specified.
477
478 =back
479
480 =head4 C<%postponed_file>
481
482 This hash keeps track of breakpoints that need to be set for files that have
483 not yet been compiled. Keys are filenames; values are references to hashes.
484 Each of these hashes is keyed by line number, and its values are breakpoint
485 definitions (C<condition\0action>).
486
487 =head1 DEBUGGER INITIALIZATION
488
489 The debugger's initialization actually jumps all over the place inside this
490 package. This is because there are several BEGIN blocks (which of course 
491 execute immediately) spread through the code. Why is that? 
492
493 The debugger needs to be able to change some things and set some things up 
494 before the debugger code is compiled; most notably, the C<$deep> variable that
495 C<DB::sub> uses to tell when a program has recursed deeply. In addition, the
496 debugger has to turn off warnings while the debugger code is compiled, but then
497 restore them to their original setting before the program being debugged begins
498 executing.
499
500 The first C<BEGIN> block simply turns off warnings by saving the current
501 setting of C<$^W> and then setting it to zero. The second one initializes
502 the debugger variables that are needed before the debugger begins executing.
503 The third one puts C<$^X> back to its former value. 
504
505 We'll detail the second C<BEGIN> block later; just remember that if you need
506 to initialize something before the debugger starts really executing, that's
507 where it has to go.
508
509 =cut
510
511 package DB;
512
513 BEGIN {eval 'use IO::Handle'};  # Needed for flush only? breaks under miniperl
514
515 BEGIN {
516     require feature;
517     $^V =~ /^v(\d+\.\d+)/;
518     feature->import(":$1");
519 }
520
521 # Debugger for Perl 5.00x; perl5db.pl patch level:
522 $VERSION = '1.35';
523
524 $header = "perl5db.pl version $VERSION";
525
526 =head1 DEBUGGER ROUTINES
527
528 =head2 C<DB::eval()>
529
530 This function replaces straight C<eval()> inside the debugger; it simplifies
531 the process of evaluating code in the user's context.
532
533 The code to be evaluated is passed via the package global variable 
534 C<$DB::evalarg>; this is done to avoid fiddling with the contents of C<@_>.
535
536 Before we do the C<eval()>, we preserve the current settings of C<$trace>,
537 C<$single>, C<$^D> and C<$usercontext>.  The latter contains the
538 preserved values of C<$@>, C<$!>, C<$^E>, C<$,>, C<$/>, C<$\>, C<$^W> and the
539 user's current package, grabbed when C<DB::DB> got control.  This causes the
540 proper context to be used when the eval is actually done.  Afterward, we
541 restore C<$trace>, C<$single>, and C<$^D>.
542
543 Next we need to handle C<$@> without getting confused. We save C<$@> in a
544 local lexical, localize C<$saved[0]> (which is where C<save()> will put 
545 C<$@>), and then call C<save()> to capture C<$@>, C<$!>, C<$^E>, C<$,>, 
546 C<$/>, C<$\>, and C<$^W>) and set C<$,>, C<$/>, C<$\>, and C<$^W> to values
547 considered sane by the debugger. If there was an C<eval()> error, we print 
548 it on the debugger's output. If C<$onetimedump> is defined, we call 
549 C<dumpit> if it's set to 'dump', or C<methods> if it's set to 
550 'methods'. Setting it to something else causes the debugger to do the eval 
551 but not print the result - handy if you want to do something else with it 
552 (the "watch expressions" code does this to get the value of the watch
553 expression but not show it unless it matters).
554
555 In any case, we then return the list of output from C<eval> to the caller, 
556 and unwinding restores the former version of C<$@> in C<@saved> as well 
557 (the localization of C<$saved[0]> goes away at the end of this scope).
558
559 =head3 Parameters and variables influencing execution of DB::eval()
560
561 C<DB::eval> isn't parameterized in the standard way; this is to keep the
562 debugger's calls to C<DB::eval()> from mucking with C<@_>, among other things.
563 The variables listed below influence C<DB::eval()>'s execution directly. 
564
565 =over 4
566
567 =item C<$evalarg> - the thing to actually be eval'ed
568
569 =item C<$trace> - Current state of execution tracing
570
571 =item C<$single> - Current state of single-stepping
572
573 =item C<$onetimeDump> - what is to be displayed after the evaluation 
574
575 =item C<$onetimeDumpDepth> - how deep C<dumpit()> should go when dumping results
576
577 =back
578
579 The following variables are altered by C<DB::eval()> during its execution. They
580 are "stacked" via C<local()>, enabling recursive calls to C<DB::eval()>. 
581
582 =over 4
583
584 =item C<@res> - used to capture output from actual C<eval>.
585
586 =item C<$otrace> - saved value of C<$trace>.
587
588 =item C<$osingle> - saved value of C<$single>.      
589
590 =item C<$od> - saved value of C<$^D>.
591
592 =item C<$saved[0]> - saved value of C<$@>.
593
594 =item $\ - for output of C<$@> if there is an evaluation error.      
595
596 =back
597
598 =head3 The problem of lexicals
599
600 The context of C<DB::eval()> presents us with some problems. Obviously,
601 we want to be 'sandboxed' away from the debugger's internals when we do
602 the eval, but we need some way to control how punctuation variables and
603 debugger globals are used. 
604
605 We can't use local, because the code inside C<DB::eval> can see localized
606 variables; and we can't use C<my> either for the same reason. The code
607 in this routine compromises and uses C<my>.
608
609 After this routine is over, we don't have user code executing in the debugger's
610 context, so we can use C<my> freely.
611
612 =cut
613
614 ############################################## Begin lexical danger zone
615
616 # 'my' variables used here could leak into (that is, be visible in)
617 # the context that the code being evaluated is executing in. This means that
618 # the code could modify the debugger's variables.
619 #
620 # Fiddling with the debugger's context could be Bad. We insulate things as
621 # much as we can.
622
623 sub eval {
624
625     # 'my' would make it visible from user code
626     #    but so does local! --tchrist
627     # Remember: this localizes @DB::res, not @main::res.
628     local @res;
629     {
630
631         # Try to keep the user code from messing  with us. Save these so that
632         # even if the eval'ed code changes them, we can put them back again.
633         # Needed because the user could refer directly to the debugger's
634         # package globals (and any 'my' variables in this containing scope)
635         # inside the eval(), and we want to try to stay safe.
636         local $otrace  = $trace;
637         local $osingle = $single;
638         local $od      = $^D;
639
640         # Untaint the incoming eval() argument.
641         { ($evalarg) = $evalarg =~ /(.*)/s; }
642
643         # $usercontext built in DB::DB near the comment
644         # "set up the context for DB::eval ..."
645         # Evaluate and save any results.
646         @res = eval "$usercontext $evalarg;\n";  # '\n' for nice recursive debug
647
648         # Restore those old values.
649         $trace  = $otrace;
650         $single = $osingle;
651         $^D     = $od;
652     }
653
654     # Save the current value of $@, and preserve it in the debugger's copy
655     # of the saved precious globals.
656     my $at = $@;
657
658     # Since we're only saving $@, we only have to localize the array element
659     # that it will be stored in.
660     local $saved[0];    # Preserve the old value of $@
661     eval { &DB::save };
662
663     # Now see whether we need to report an error back to the user.
664     if ($at) {
665         local $\ = '';
666         print $OUT $at;
667     }
668
669     # Display as required by the caller. $onetimeDump and $onetimedumpDepth
670     # are package globals.
671     elsif ($onetimeDump) {
672         if ( $onetimeDump eq 'dump' ) {
673             local $option{dumpDepth} = $onetimedumpDepth
674               if defined $onetimedumpDepth;
675             dumpit( $OUT, \@res );
676         }
677         elsif ( $onetimeDump eq 'methods' ) {
678             methods( $res[0] );
679         }
680     } ## end elsif ($onetimeDump)
681     @res;
682 } ## end sub eval
683
684 ############################################## End lexical danger zone
685
686 # After this point it is safe to introduce lexicals.
687 # The code being debugged will be executing in its own context, and
688 # can't see the inside of the debugger.
689 #
690 # However, one should not overdo it: leave as much control from outside as
691 # possible. If you make something a lexical, it's not going to be addressable
692 # from outside the debugger even if you know its name.
693
694 # This file is automatically included if you do perl -d.
695 # It's probably not useful to include this yourself.
696 #
697 # Before venturing further into these twisty passages, it is
698 # wise to read the perldebguts man page or risk the ire of dragons.
699 #
700 # (It should be noted that perldebguts will tell you a lot about
701 # the underlying mechanics of how the debugger interfaces into the
702 # Perl interpreter, but not a lot about the debugger itself. The new
703 # comments in this code try to address this problem.)
704
705 # Note that no subroutine call is possible until &DB::sub is defined
706 # (for subroutines defined outside of the package DB). In fact the same is
707 # true if $deep is not defined.
708
709 # Enhanced by ilya@math.ohio-state.edu (Ilya Zakharevich)
710
711 # modified Perl debugger, to be run from Emacs in perldb-mode
712 # Ray Lischner (uunet!mntgfx!lisch) as of 5 Nov 1990
713 # Johan Vromans -- upgrade to 4.0 pl 10
714 # Ilya Zakharevich -- patches after 5.001 (and some before ;-)
715
716 # (We have made efforts to  clarify the comments in the change log
717 # in other places; some of them may seem somewhat obscure as they
718 # were originally written, and explaining them away from the code
719 # in question seems conterproductive.. -JM)
720
721 ########################################################################
722 # Changes: 0.94
723 #   + A lot of things changed after 0.94. First of all, core now informs
724 #     debugger about entry into XSUBs, overloaded operators, tied operations,
725 #     BEGIN and END. Handy with 'O f=2'.
726 #   + This can make debugger a little bit too verbose, please be patient
727 #     and report your problems promptly.
728 #   + Now the option frame has 3 values: 0,1,2. XXX Document!
729 #   + Note that if DESTROY returns a reference to the object (or object),
730 #     the deletion of data may be postponed until the next function call,
731 #     due to the need to examine the return value.
732 #
733 # Changes: 0.95
734 #   + 'v' command shows versions.
735 #
736 # Changes: 0.96
737 #   + 'v' command shows version of readline.
738 #     primitive completion works (dynamic variables, subs for 'b' and 'l',
739 #     options). Can 'p %var'
740 #   + Better help ('h <' now works). New commands <<, >>, {, {{.
741 #     {dump|print}_trace() coded (to be able to do it from <<cmd).
742 #   + 'c sub' documented.
743 #   + At last enough magic combined to stop after the end of debuggee.
744 #   + !! should work now (thanks to Emacs bracket matching an extra
745 #     ']' in a regexp is caught).
746 #   + 'L', 'D' and 'A' span files now (as documented).
747 #   + Breakpoints in 'require'd code are possible (used in 'R').
748 #   +  Some additional words on internal work of debugger.
749 #   + 'b load filename' implemented.
750 #   + 'b postpone subr' implemented.
751 #   + now only 'q' exits debugger (overwritable on $inhibit_exit).
752 #   + When restarting debugger breakpoints/actions persist.
753 #   + Buglet: When restarting debugger only one breakpoint/action per
754 #             autoloaded function persists.
755 #
756 # Changes: 0.97: NonStop will not stop in at_exit().
757 #   + Option AutoTrace implemented.
758 #   + Trace printed differently if frames are printed too.
759 #   + new 'inhibitExit' option.
760 #   + printing of a very long statement interruptible.
761 # Changes: 0.98: New command 'm' for printing possible methods
762 #   + 'l -' is a synonym for '-'.
763 #   + Cosmetic bugs in printing stack trace.
764 #   +  'frame' & 8 to print "expanded args" in stack trace.
765 #   + Can list/break in imported subs.
766 #   + new 'maxTraceLen' option.
767 #   + frame & 4 and frame & 8 granted.
768 #   + new command 'm'
769 #   + nonstoppable lines do not have ':' near the line number.
770 #   + 'b compile subname' implemented.
771 #   + Will not use $` any more.
772 #   + '-' behaves sane now.
773 # Changes: 0.99: Completion for 'f', 'm'.
774 #   +  'm' will remove duplicate names instead of duplicate functions.
775 #   + 'b load' strips trailing whitespace.
776 #     completion ignores leading '|'; takes into account current package
777 #     when completing a subroutine name (same for 'l').
778 # Changes: 1.07: Many fixed by tchrist 13-March-2000
779 #   BUG FIXES:
780 #   + Added bare minimal security checks on perldb rc files, plus
781 #     comments on what else is needed.
782 #   + Fixed the ornaments that made "|h" completely unusable.
783 #     They are not used in print_help if they will hurt.  Strip pod
784 #     if we're paging to less.
785 #   + Fixed mis-formatting of help messages caused by ornaments
786 #     to restore Larry's original formatting.
787 #   + Fixed many other formatting errors.  The code is still suboptimal,
788 #     and needs a lot of work at restructuring.  It's also misindented
789 #     in many places.
790 #   + Fixed bug where trying to look at an option like your pager
791 #     shows "1".
792 #   + Fixed some $? processing.  Note: if you use csh or tcsh, you will
793 #     lose.  You should consider shell escapes not using their shell,
794 #     or else not caring about detailed status.  This should really be
795 #     unified into one place, too.
796 #   + Fixed bug where invisible trailing whitespace on commands hoses you,
797 #     tricking Perl into thinking you weren't calling a debugger command!
798 #   + Fixed bug where leading whitespace on commands hoses you.  (One
799 #     suggests a leading semicolon or any other irrelevant non-whitespace
800 #     to indicate literal Perl code.)
801 #   + Fixed bugs that ate warnings due to wrong selected handle.
802 #   + Fixed a precedence bug on signal stuff.
803 #   + Fixed some unseemly wording.
804 #   + Fixed bug in help command trying to call perl method code.
805 #   + Fixed to call dumpvar from exception handler.  SIGPIPE killed us.
806 #   ENHANCEMENTS:
807 #   + Added some comments.  This code is still nasty spaghetti.
808 #   + Added message if you clear your pre/post command stacks which was
809 #     very easy to do if you just typed a bare >, <, or {.  (A command
810 #     without an argument should *never* be a destructive action; this
811 #     API is fundamentally screwed up; likewise option setting, which
812 #     is equally buggered.)
813 #   + Added command stack dump on argument of "?" for >, <, or {.
814 #   + Added a semi-built-in doc viewer command that calls man with the
815 #     proper %Config::Config path (and thus gets caching, man -k, etc),
816 #     or else perldoc on obstreperous platforms.
817 #   + Added to and rearranged the help information.
818 #   + Detected apparent misuse of { ... } to declare a block; this used
819 #     to work but now is a command, and mysteriously gave no complaint.
820 #
821 # Changes: 1.08: Apr 25, 2001  Jon Eveland <jweveland@yahoo.com>
822 #   BUG FIX:
823 #   + This patch to perl5db.pl cleans up formatting issues on the help
824 #     summary (h h) screen in the debugger.  Mostly columnar alignment
825 #     issues, plus converted the printed text to use all spaces, since
826 #     tabs don't seem to help much here.
827 #
828 # Changes: 1.09: May 19, 2001  Ilya Zakharevich <ilya@math.ohio-state.edu>
829 #   Minor bugs corrected;
830 #   + Support for auto-creation of new TTY window on startup, either
831 #     unconditionally, or if started as a kid of another debugger session;
832 #   + New 'O'ption CreateTTY
833 #       I<CreateTTY>      bits control attempts to create a new TTY on events:
834 #                         1: on fork()
835 #                         2: debugger is started inside debugger
836 #                         4: on startup
837 #   + Code to auto-create a new TTY window on OS/2 (currently one
838 #     extra window per session - need named pipes to have more...);
839 #   + Simplified interface for custom createTTY functions (with a backward
840 #     compatibility hack); now returns the TTY name to use; return of ''
841 #     means that the function reset the I/O handles itself;
842 #   + Better message on the semantic of custom createTTY function;
843 #   + Convert the existing code to create a TTY into a custom createTTY
844 #     function;
845 #   + Consistent support for TTY names of the form "TTYin,TTYout";
846 #   + Switch line-tracing output too to the created TTY window;
847 #   + make 'b fork' DWIM with CORE::GLOBAL::fork;
848 #   + High-level debugger API cmd_*():
849 #      cmd_b_load($filenamepart)            # b load filenamepart
850 #      cmd_b_line($lineno [, $cond])        # b lineno [cond]
851 #      cmd_b_sub($sub [, $cond])            # b sub [cond]
852 #      cmd_stop()                           # Control-C
853 #      cmd_d($lineno)                       # d lineno (B)
854 #      The cmd_*() API returns FALSE on failure; in this case it outputs
855 #      the error message to the debugging output.
856 #   + Low-level debugger API
857 #      break_on_load($filename)             # b load filename
858 #      @files = report_break_on_load()      # List files with load-breakpoints
859 #      breakable_line_in_filename($name, $from [, $to])
860 #                                           # First breakable line in the
861 #                                           # range $from .. $to.  $to defaults
862 #                                           # to $from, and may be less than
863 #                                           # $to
864 #      breakable_line($from [, $to])        # Same for the current file
865 #      break_on_filename_line($name, $lineno [, $cond])
866 #                                           # Set breakpoint,$cond defaults to
867 #                                           # 1
868 #      break_on_filename_line_range($name, $from, $to [, $cond])
869 #                                           # As above, on the first
870 #                                           # breakable line in range
871 #      break_on_line($lineno [, $cond])     # As above, in the current file
872 #      break_subroutine($sub [, $cond])     # break on the first breakable line
873 #      ($name, $from, $to) = subroutine_filename_lines($sub)
874 #                                           # The range of lines of the text
875 #      The low-level API returns TRUE on success, and die()s on failure.
876 #
877 # Changes: 1.10: May 23, 2001  Daniel Lewart <d-lewart@uiuc.edu>
878 #   BUG FIXES:
879 #   + Fixed warnings generated by "perl -dWe 42"
880 #   + Corrected spelling errors
881 #   + Squeezed Help (h) output into 80 columns
882 #
883 # Changes: 1.11: May 24, 2001  David Dyck <dcd@tc.fluke.com>
884 #   + Made "x @INC" work like it used to
885 #
886 # Changes: 1.12: May 24, 2001  Daniel Lewart <d-lewart@uiuc.edu>
887 #   + Fixed warnings generated by "O" (Show debugger options)
888 #   + Fixed warnings generated by "p 42" (Print expression)
889 # Changes: 1.13: Jun 19, 2001 Scott.L.Miller@compaq.com
890 #   + Added windowSize option
891 # Changes: 1.14: Oct  9, 2001 multiple
892 #   + Clean up after itself on VMS (Charles Lane in 12385)
893 #   + Adding "@ file" syntax (Peter Scott in 12014)
894 #   + Debug reloading selfloaded stuff (Ilya Zakharevich in 11457)
895 #   + $^S and other debugger fixes (Ilya Zakharevich in 11120)
896 #   + Forgot a my() declaration (Ilya Zakharevich in 11085)
897 # Changes: 1.15: Nov  6, 2001 Michael G Schwern <schwern@pobox.com>
898 #   + Updated 1.14 change log
899 #   + Added *dbline explanatory comments
900 #   + Mentioning perldebguts man page
901 # Changes: 1.16: Feb 15, 2002 Mark-Jason Dominus <mjd@plover.com>
902 #   + $onetimeDump improvements
903 # Changes: 1.17: Feb 20, 2002 Richard Foley <richard.foley@rfi.net>
904 #   Moved some code to cmd_[.]()'s for clarity and ease of handling,
905 #   rationalised the following commands and added cmd_wrapper() to
906 #   enable switching between old and frighteningly consistent new
907 #   behaviours for diehards: 'o CommandSet=pre580' (sigh...)
908 #     a(add),       A(del)            # action expr   (added del by line)
909 #   + b(add),       B(del)            # break  [line] (was b,D)
910 #   + w(add),       W(del)            # watch  expr   (was W,W)
911 #                                     # added del by expr
912 #   + h(summary), h h(long)           # help (hh)     (was h h,h)
913 #   + m(methods),   M(modules)        # ...           (was m,v)
914 #   + o(option)                       # lc            (was O)
915 #   + v(view code), V(view Variables) # ...           (was w,V)
916 # Changes: 1.18: Mar 17, 2002 Richard Foley <richard.foley@rfi.net>
917 #   + fixed missing cmd_O bug
918 # Changes: 1.19: Mar 29, 2002 Spider Boardman
919 #   + Added missing local()s -- DB::DB is called recursively.
920 # Changes: 1.20: Feb 17, 2003 Richard Foley <richard.foley@rfi.net>
921 #   + pre'n'post commands no longer trashed with no args
922 #   + watch val joined out of eval()
923 # Changes: 1.21: Jun 04, 2003 Joe McMahon <mcmahon@ibiblio.org>
924 #   + Added comments and reformatted source. No bug fixes/enhancements.
925 #   + Includes cleanup by Robin Barker and Jarkko Hietaniemi.
926 # Changes: 1.22  Jun 09, 2003 Alex Vandiver <alexmv@MIT.EDU>
927 #   + Flush stdout/stderr before the debugger prompt is printed.
928 # Changes: 1.23: Dec 21, 2003 Dominique Quatravaux
929 #   + Fix a side-effect of bug #24674 in the perl debugger ("odd taint bug")
930 # Changes: 1.24: Mar 03, 2004 Richard Foley <richard.foley@rfi.net>
931 #   + Added command to save all debugger commands for sourcing later.
932 #   + Added command to display parent inheritance tree of given class.
933 #   + Fixed minor newline in history bug.
934 # Changes: 1.25: Apr 17, 2004 Richard Foley <richard.foley@rfi.net>
935 #   + Fixed option bug (setting invalid options + not recognising valid short forms)
936 # Changes: 1.26: Apr 22, 2004 Richard Foley <richard.foley@rfi.net>
937 #   + unfork the 5.8.x and 5.9.x debuggers.
938 #   + whitespace and assertions call cleanup across versions 
939 #   + H * deletes (resets) history
940 #   + i now handles Class + blessed objects
941 # Changes: 1.27: May 09, 2004 Richard Foley <richard.foley@rfi.net>
942 #   + updated pod page references - clunky.
943 #   + removed windowid restriction for forking into an xterm.
944 #   + more whitespace again.
945 #   + wrapped restart and enabled rerun [-n] (go back n steps) command.
946 # Changes: 1.28: Oct 12, 2004 Richard Foley <richard.foley@rfi.net>
947 #   + Added threads support (inc. e and E commands)
948 # Changes: 1.29: Nov 28, 2006 Bo Lindbergh <blgl@hagernas.com> 
949 #   + Added macosx_get_fork_TTY support 
950 # Changes: 1.30: Mar 06, 2007 Andreas Koenig <andk@cpan.org>
951 #   + Added HistFile, HistSize
952 # Changes: 1.31
953 #   + Remove support for assertions and -A
954 #   + stop NEXT::AUTOLOAD from emitting warnings under the debugger. RT #25053
955 #   + "update for Mac OS X 10.5" [finding the tty device]
956 #   + "What I needed to get the forked debugger to work" [on VMS]
957 #   + [perl #57016] debugger: o warn=0 die=0 ignored
958 #   + Note, but don't use, PERLDBf_SAVESRC
959 #   + Fix #7013: lvalue subs not working inside debugger
960 # Changes: 1.32: Jun 03, 2009 Jonathan Leto <jonathan@leto.net>
961 #   + Fix bug where a key _< with undefined value was put into the symbol table
962 #   +   when the $filename variable is not set
963 # Changes: 1.33:
964 #   + Debugger prints lines to the remote port when it forks and openes a new port (f633fd2)
965 #   + The debugger now continues to use RemotePort when it's been configured to use it. (11653f7)
966 #   + Stop using $ENV{LESS} for parameters not intended for less (d463cf2)
967 #   + Configure has a path to less and perl5db.pl can use it (bf320d6)
968 #   + Die with $@ instead of empty message (86755f4)
969 #   + Remove extra/useless $@ check after eval { require PadWalker } (which is still checked) (dab8d6d)
970 #   + Promote eval( "require ..." ) to eval { require ... } (4a49187)
971 #   + Promote eval { require( ... )} || die to mere require( ... ) (999f23b)
972 #   + Remove indirect object notation from debugger (bee4b46)
973 #   + Document that @{$main::{'_<'.$filename}} lines are dualvar to (COP*). (7e17a74)
974 #   + Remove MacOS classic support from the debugger. (2b894b7)
975 ########################################################################
976
977 =head1 DEBUGGER INITIALIZATION
978
979 The debugger starts up in phases.
980
981 =head2 BASIC SETUP
982
983 First, it initializes the environment it wants to run in: turning off
984 warnings during its own compilation, defining variables which it will need
985 to avoid warnings later, setting itself up to not exit when the program
986 terminates, and defaulting to printing return values for the C<r> command.
987
988 =cut
989
990 # Needed for the statement after exec():
991 #
992 # This BEGIN block is simply used to switch off warnings during debugger
993 # compilation. Probably it would be better practice to fix the warnings,
994 # but this is how it's done at the moment.
995
996 BEGIN {
997     $ini_warn = $^W;
998     $^W       = 0;
999 }    # Switch compilation warnings off until another BEGIN.
1000
1001 local ($^W) = 0;    # Switch run-time warnings off during init.
1002
1003 =head2 THREADS SUPPORT
1004
1005 If we are running under a threaded Perl, we require threads and threads::shared
1006 if the environment variable C<PERL5DB_THREADED> is set, to enable proper
1007 threaded debugger control.  C<-dt> can also be used to set this.
1008
1009 Each new thread will be announced and the debugger prompt will always inform
1010 you of each new thread created.  It will also indicate the thread id in which
1011 we are currently running within the prompt like this:
1012
1013         [tid] DB<$i>
1014
1015 Where C<[tid]> is an integer thread id and C<$i> is the familiar debugger
1016 command prompt.  The prompt will show: C<[0]> when running under threads, but
1017 not actually in a thread.  C<[tid]> is consistent with C<gdb> usage.
1018
1019 While running under threads, when you set or delete a breakpoint (etc.), this
1020 will apply to all threads, not just the currently running one.  When you are 
1021 in a currently executing thread, you will stay there until it completes.  With
1022 the current implementation it is not currently possible to hop from one thread
1023 to another.
1024
1025 The C<e> and C<E> commands are currently fairly minimal - see C<h e> and C<h E>.
1026
1027 Note that threading support was built into the debugger as of Perl version
1028 C<5.8.6> and debugger version C<1.2.8>.
1029
1030 =cut
1031
1032 BEGIN {
1033   # ensure we can share our non-threaded variables or no-op
1034   if ($ENV{PERL5DB_THREADED}) {
1035         require threads;
1036         require threads::shared;
1037         import threads::shared qw(share);
1038         $DBGR;
1039         share(\$DBGR);
1040         lock($DBGR);
1041         print "Threads support enabled\n";
1042   } else {
1043         *lock  = sub(*) {};
1044         *share = sub(*) {};
1045   }
1046 }
1047
1048 # This would probably be better done with "use vars", but that wasn't around
1049 # when this code was originally written. (Neither was "use strict".) And on
1050 # the principle of not fiddling with something that was working, this was
1051 # left alone.
1052 warn(               # Do not ;-)
1053     # These variables control the execution of 'dumpvar.pl'.
1054     $dumpvar::hashDepth,
1055     $dumpvar::arrayDepth,
1056     $dumpvar::dumpDBFiles,
1057     $dumpvar::dumpPackages,
1058     $dumpvar::quoteHighBit,
1059     $dumpvar::printUndef,
1060     $dumpvar::globPrint,
1061     $dumpvar::usageOnly,
1062
1063     # used to save @ARGV and extract any debugger-related flags.
1064     @ARGS,
1065
1066     # used to control die() reporting in diesignal()
1067     $Carp::CarpLevel,
1068
1069     # used to prevent multiple entries to diesignal()
1070     # (if for instance diesignal() itself dies)
1071     $panic,
1072
1073     # used to prevent the debugger from running nonstop
1074     # after a restart
1075     $second_time,
1076   )
1077   if 0;
1078
1079 # without threads, $filename is not defined until DB::DB is called
1080 foreach my $k (keys (%INC)) {
1081         &share(\$main::{'_<'.$filename}) if defined $filename;
1082 };
1083
1084 # Command-line + PERLLIB:
1085 # Save the contents of @INC before they are modified elsewhere.
1086 @ini_INC = @INC;
1087
1088 # This was an attempt to clear out the previous values of various
1089 # trapped errors. Apparently it didn't help. XXX More info needed!
1090 # $prevwarn = $prevdie = $prevbus = $prevsegv = ''; # Does not help?!
1091
1092 # We set these variables to safe values. We don't want to blindly turn
1093 # off warnings, because other packages may still want them.
1094 $trace = $signal = $single = 0;    # Uninitialized warning suppression
1095                                    # (local $^W cannot help - other packages!).
1096
1097 # Default to not exiting when program finishes; print the return
1098 # value when the 'r' command is used to return from a subroutine.
1099 $inhibit_exit = $option{PrintRet} = 1;
1100
1101 # Default to 1 so the prompt will display the first line.
1102 $trace_to_depth = 1;
1103
1104 =head1 OPTION PROCESSING
1105
1106 The debugger's options are actually spread out over the debugger itself and 
1107 C<dumpvar.pl>; some of these are variables to be set, while others are 
1108 subs to be called with a value. To try to make this a little easier to
1109 manage, the debugger uses a few data structures to define what options
1110 are legal and how they are to be processed.
1111
1112 First, the C<@options> array defines the I<names> of all the options that
1113 are to be accepted.
1114
1115 =cut
1116
1117 @options = qw(
1118   CommandSet   HistFile      HistSize
1119   hashDepth    arrayDepth    dumpDepth
1120   DumpDBFiles  DumpPackages  DumpReused
1121   compactDump  veryCompact   quote
1122   HighBit      undefPrint    globPrint
1123   PrintRet     UsageOnly     frame
1124   AutoTrace    TTY           noTTY
1125   ReadLine     NonStop       LineInfo
1126   maxTraceLen  recallCommand ShellBang
1127   pager        tkRunning     ornaments
1128   signalLevel  warnLevel     dieLevel
1129   inhibit_exit ImmediateStop bareStringify
1130   CreateTTY    RemotePort    windowSize
1131   DollarCaretP
1132 );
1133
1134 @RememberOnROptions = qw(DollarCaretP);
1135
1136 =pod
1137
1138 Second, C<optionVars> lists the variables that each option uses to save its
1139 state.
1140
1141 =cut
1142
1143 %optionVars = (
1144     hashDepth     => \$dumpvar::hashDepth,
1145     arrayDepth    => \$dumpvar::arrayDepth,
1146     CommandSet    => \$CommandSet,
1147     DumpDBFiles   => \$dumpvar::dumpDBFiles,
1148     DumpPackages  => \$dumpvar::dumpPackages,
1149     DumpReused    => \$dumpvar::dumpReused,
1150     HighBit       => \$dumpvar::quoteHighBit,
1151     undefPrint    => \$dumpvar::printUndef,
1152     globPrint     => \$dumpvar::globPrint,
1153     UsageOnly     => \$dumpvar::usageOnly,
1154     CreateTTY     => \$CreateTTY,
1155     bareStringify => \$dumpvar::bareStringify,
1156     frame         => \$frame,
1157     AutoTrace     => \$trace,
1158     inhibit_exit  => \$inhibit_exit,
1159     maxTraceLen   => \$maxtrace,
1160     ImmediateStop => \$ImmediateStop,
1161     RemotePort    => \$remoteport,
1162     windowSize    => \$window,
1163     HistFile      => \$histfile,
1164     HistSize      => \$histsize,
1165 );
1166
1167 =pod
1168
1169 Third, C<%optionAction> defines the subroutine to be called to process each
1170 option.
1171
1172 =cut 
1173
1174 %optionAction = (
1175     compactDump   => \&dumpvar::compactDump,
1176     veryCompact   => \&dumpvar::veryCompact,
1177     quote         => \&dumpvar::quote,
1178     TTY           => \&TTY,
1179     noTTY         => \&noTTY,
1180     ReadLine      => \&ReadLine,
1181     NonStop       => \&NonStop,
1182     LineInfo      => \&LineInfo,
1183     recallCommand => \&recallCommand,
1184     ShellBang     => \&shellBang,
1185     pager         => \&pager,
1186     signalLevel   => \&signalLevel,
1187     warnLevel     => \&warnLevel,
1188     dieLevel      => \&dieLevel,
1189     tkRunning     => \&tkRunning,
1190     ornaments     => \&ornaments,
1191     RemotePort    => \&RemotePort,
1192     DollarCaretP  => \&DollarCaretP,
1193 );
1194
1195 =pod
1196
1197 Last, the C<%optionRequire> notes modules that must be C<require>d if an
1198 option is used.
1199
1200 =cut
1201
1202 # Note that this list is not complete: several options not listed here
1203 # actually require that dumpvar.pl be loaded for them to work, but are
1204 # not in the table. A subsequent patch will correct this problem; for
1205 # the moment, we're just recommenting, and we are NOT going to change
1206 # function.
1207 %optionRequire = (
1208     compactDump => 'dumpvar.pl',
1209     veryCompact => 'dumpvar.pl',
1210     quote       => 'dumpvar.pl',
1211 );
1212
1213 =pod
1214
1215 There are a number of initialization-related variables which can be set
1216 by putting code to set them in a BEGIN block in the C<PERL5DB> environment
1217 variable. These are:
1218
1219 =over 4
1220
1221 =item C<$rl> - readline control XXX needs more explanation
1222
1223 =item C<$warnLevel> - whether or not debugger takes over warning handling
1224
1225 =item C<$dieLevel> - whether or not debugger takes over die handling
1226
1227 =item C<$signalLevel> - whether or not debugger takes over signal handling
1228
1229 =item C<$pre> - preprompt actions (array reference)
1230
1231 =item C<$post> - postprompt actions (array reference)
1232
1233 =item C<$pretype>
1234
1235 =item C<$CreateTTY> - whether or not to create a new TTY for this debugger
1236
1237 =item C<$CommandSet> - which command set to use (defaults to new, documented set)
1238
1239 =back
1240
1241 =cut
1242
1243 # These guys may be defined in $ENV{PERL5DB} :
1244 $rl          = 1     unless defined $rl;
1245 $warnLevel   = 1     unless defined $warnLevel;
1246 $dieLevel    = 1     unless defined $dieLevel;
1247 $signalLevel = 1     unless defined $signalLevel;
1248 $pre         = []    unless defined $pre;
1249 $post        = []    unless defined $post;
1250 $pretype     = []    unless defined $pretype;
1251 $CreateTTY   = 3     unless defined $CreateTTY;
1252 $CommandSet  = '580' unless defined $CommandSet;
1253
1254 share($rl);
1255 share($warnLevel);
1256 share($dieLevel);
1257 share($signalLevel);
1258 share($pre);
1259 share($post);
1260 share($pretype);
1261 share($rl);
1262 share($CreateTTY);
1263 share($CommandSet);
1264
1265 =pod
1266
1267 The default C<die>, C<warn>, and C<signal> handlers are set up.
1268
1269 =cut
1270
1271 warnLevel($warnLevel);
1272 dieLevel($dieLevel);
1273 signalLevel($signalLevel);
1274
1275 =pod
1276
1277 The pager to be used is needed next. We try to get it from the
1278 environment first.  If it's not defined there, we try to find it in
1279 the Perl C<Config.pm>.  If it's not there, we default to C<more>. We
1280 then call the C<pager()> function to save the pager name.
1281
1282 =cut
1283
1284 # This routine makes sure $pager is set up so that '|' can use it.
1285 pager(
1286
1287     # If PAGER is defined in the environment, use it.
1288     defined $ENV{PAGER}
1289     ? $ENV{PAGER}
1290
1291       # If not, see if Config.pm defines it.
1292     : eval { require Config }
1293       && defined $Config::Config{pager}
1294     ? $Config::Config{pager}
1295
1296       # If not, fall back to 'more'.
1297     : 'more'
1298   )
1299   unless defined $pager;
1300
1301 =pod
1302
1303 We set up the command to be used to access the man pages, the command
1304 recall character (C<!> unless otherwise defined) and the shell escape
1305 character (C<!> unless otherwise defined). Yes, these do conflict, and
1306 neither works in the debugger at the moment.
1307
1308 =cut
1309
1310 setman();
1311
1312 # Set up defaults for command recall and shell escape (note:
1313 # these currently don't work in linemode debugging).
1314 &recallCommand("!") unless defined $prc;
1315 &shellBang("!")     unless defined $psh;
1316
1317 =pod
1318
1319 We then set up the gigantic string containing the debugger help.
1320 We also set the limit on the number of arguments we'll display during a
1321 trace.
1322
1323 =cut
1324
1325 sethelp();
1326
1327 # If we didn't get a default for the length of eval/stack trace args,
1328 # set it here.
1329 $maxtrace = 400 unless defined $maxtrace;
1330
1331 =head2 SETTING UP THE DEBUGGER GREETING
1332
1333 The debugger I<greeting> helps to inform the user how many debuggers are
1334 running, and whether the current debugger is the primary or a child.
1335
1336 If we are the primary, we just hang onto our pid so we'll have it when
1337 or if we start a child debugger. If we are a child, we'll set things up
1338 so we'll have a unique greeting and so the parent will give us our own
1339 TTY later.
1340
1341 We save the current contents of the C<PERLDB_PIDS> environment variable
1342 because we mess around with it. We'll also need to hang onto it because
1343 we'll need it if we restart.
1344
1345 Child debuggers make a label out of the current PID structure recorded in
1346 PERLDB_PIDS plus the new PID. They also mark themselves as not having a TTY
1347 yet so the parent will give them one later via C<resetterm()>.
1348
1349 =cut
1350
1351 # Save the current contents of the environment; we're about to
1352 # much with it. We'll need this if we have to restart.
1353 $ini_pids = $ENV{PERLDB_PIDS};
1354
1355 if ( defined $ENV{PERLDB_PIDS} ) {
1356
1357     # We're a child. Make us a label out of the current PID structure
1358     # recorded in PERLDB_PIDS plus our (new) PID. Mark us as not having
1359     # a term yet so the parent will give us one later via resetterm().
1360
1361     my $env_pids = $ENV{PERLDB_PIDS};
1362     $pids = "[$env_pids]";
1363
1364     # Unless we are on OpenVMS, all programs under the DCL shell run under
1365     # the same PID.
1366
1367     if (($^O eq 'VMS') && ($env_pids =~ /\b$$\b/)) {
1368         $term_pid         = $$;
1369     }
1370     else {
1371         $ENV{PERLDB_PIDS} .= "->$$";
1372         $term_pid = -1;
1373     }
1374
1375 } ## end if (defined $ENV{PERLDB_PIDS...
1376 else {
1377
1378     # We're the parent PID. Initialize PERLDB_PID in case we end up with a
1379     # child debugger, and mark us as the parent, so we'll know to set up
1380     # more TTY's is we have to.
1381     $ENV{PERLDB_PIDS} = "$$";
1382     $pids             = "[pid=$$]";
1383     $term_pid         = $$;
1384 }
1385
1386 $pidprompt = '';
1387
1388 # Sets up $emacs as a synonym for $slave_editor.
1389 *emacs = $slave_editor if $slave_editor;    # May be used in afterinit()...
1390
1391 =head2 READING THE RC FILE
1392
1393 The debugger will read a file of initialization options if supplied. If    
1394 running interactively, this is C<.perldb>; if not, it's C<perldb.ini>.
1395
1396 =cut      
1397
1398 # As noted, this test really doesn't check accurately that the debugger
1399 # is running at a terminal or not.
1400
1401 my $dev_tty = '/dev/tty';
1402    $dev_tty = 'TT:' if ($^O eq 'VMS');
1403 if ( -e $dev_tty ) {                      # this is the wrong metric!
1404     $rcfile = ".perldb";
1405 }
1406 else {
1407     $rcfile = "perldb.ini";
1408 }
1409
1410 =pod
1411
1412 The debugger does a safety test of the file to be read. It must be owned
1413 either by the current user or root, and must only be writable by the owner.
1414
1415 =cut
1416
1417 # This wraps a safety test around "do" to read and evaluate the init file.
1418 #
1419 # This isn't really safe, because there's a race
1420 # between checking and opening.  The solution is to
1421 # open and fstat the handle, but then you have to read and
1422 # eval the contents.  But then the silly thing gets
1423 # your lexical scope, which is unfortunate at best.
1424 sub safe_do {
1425     my $file = shift;
1426
1427     # Just exactly what part of the word "CORE::" don't you understand?
1428     local $SIG{__WARN__};
1429     local $SIG{__DIE__};
1430
1431     unless ( is_safe_file($file) ) {
1432         CORE::warn <<EO_GRIPE;
1433 perldb: Must not source insecure rcfile $file.
1434         You or the superuser must be the owner, and it must not 
1435         be writable by anyone but its owner.
1436 EO_GRIPE
1437         return;
1438     } ## end unless (is_safe_file($file...
1439
1440     do $file;
1441     CORE::warn("perldb: couldn't parse $file: $@") if $@;
1442 } ## end sub safe_do
1443
1444 # This is the safety test itself.
1445 #
1446 # Verifies that owner is either real user or superuser and that no
1447 # one but owner may write to it.  This function is of limited use
1448 # when called on a path instead of upon a handle, because there are
1449 # no guarantees that filename (by dirent) whose file (by ino) is
1450 # eventually accessed is the same as the one tested.
1451 # Assumes that the file's existence is not in doubt.
1452 sub is_safe_file {
1453     my $path = shift;
1454     stat($path) || return;    # mysteriously vaporized
1455     my ( $dev, $ino, $mode, $nlink, $uid, $gid ) = stat(_);
1456
1457     return 0 if $uid != 0 && $uid != $<;
1458     return 0 if $mode & 022;
1459     return 1;
1460 } ## end sub is_safe_file
1461
1462 # If the rcfile (whichever one we decided was the right one to read)
1463 # exists, we safely do it.
1464 if ( -f $rcfile ) {
1465     safe_do("./$rcfile");
1466 }
1467
1468 # If there isn't one here, try the user's home directory.
1469 elsif ( defined $ENV{HOME} && -f "$ENV{HOME}/$rcfile" ) {
1470     safe_do("$ENV{HOME}/$rcfile");
1471 }
1472
1473 # Else try the login directory.
1474 elsif ( defined $ENV{LOGDIR} && -f "$ENV{LOGDIR}/$rcfile" ) {
1475     safe_do("$ENV{LOGDIR}/$rcfile");
1476 }
1477
1478 # If the PERLDB_OPTS variable has options in it, parse those out next.
1479 if ( defined $ENV{PERLDB_OPTS} ) {
1480     parse_options( $ENV{PERLDB_OPTS} );
1481 }
1482
1483 =pod
1484
1485 The last thing we do during initialization is determine which subroutine is
1486 to be used to obtain a new terminal when a new debugger is started. Right now,
1487 the debugger only handles TCP sockets, X11, OS/2, amd Mac OS X
1488 (darwin).
1489
1490 =cut
1491
1492 # Set up the get_fork_TTY subroutine to be aliased to the proper routine.
1493 # Works if you're running an xterm or xterm-like window, or you're on
1494 # OS/2, or on Mac OS X. This may need some expansion.
1495
1496 if (not defined &get_fork_TTY)       # only if no routine exists
1497 {
1498     if ( defined $remoteport ) {                 
1499                                                  # Expect an inetd-like server
1500         *get_fork_TTY = \&socket_get_fork_TTY;   # to listen to us
1501     }
1502     elsif (defined $ENV{TERM}                    # If we know what kind
1503                                                  # of terminal this is,
1504         and $ENV{TERM} eq 'xterm'                # and it's an xterm,
1505         and defined $ENV{DISPLAY}                # and what display it's on,
1506       )
1507     {
1508         *get_fork_TTY = \&xterm_get_fork_TTY;    # use the xterm version
1509     }
1510     elsif ( $^O eq 'os2' ) {                     # If this is OS/2,
1511         *get_fork_TTY = \&os2_get_fork_TTY;      # use the OS/2 version
1512     }
1513     elsif ( $^O eq 'darwin'                      # If this is Mac OS X
1514             and defined $ENV{TERM_PROGRAM}       # and we're running inside
1515             and $ENV{TERM_PROGRAM}
1516                 eq 'Apple_Terminal'              # Terminal.app
1517             )
1518     {
1519         *get_fork_TTY = \&macosx_get_fork_TTY;   # use the Mac OS X version
1520     }
1521 } ## end if (not defined &get_fork_TTY...
1522
1523 # untaint $^O, which may have been tainted by the last statement.
1524 # see bug [perl #24674]
1525 $^O =~ m/^(.*)\z/;
1526 $^O = $1;
1527
1528 # Here begin the unreadable code.  It needs fixing.
1529
1530 =head2 RESTART PROCESSING
1531
1532 This section handles the restart command. When the C<R> command is invoked, it
1533 tries to capture all of the state it can into environment variables, and
1534 then sets C<PERLDB_RESTART>. When we start executing again, we check to see
1535 if C<PERLDB_RESTART> is there; if so, we reload all the information that
1536 the R command stuffed into the environment variables.
1537
1538   PERLDB_RESTART   - flag only, contains no restart data itself.       
1539   PERLDB_HIST      - command history, if it's available
1540   PERLDB_ON_LOAD   - breakpoints set by the rc file
1541   PERLDB_POSTPONE  - subs that have been loaded/not executed, and have actions
1542   PERLDB_VISITED   - files that had breakpoints
1543   PERLDB_FILE_...  - breakpoints for a file
1544   PERLDB_OPT       - active options
1545   PERLDB_INC       - the original @INC
1546   PERLDB_PRETYPE   - preprompt debugger actions
1547   PERLDB_PRE       - preprompt Perl code
1548   PERLDB_POST      - post-prompt Perl code
1549   PERLDB_TYPEAHEAD - typeahead captured by readline()
1550
1551 We chug through all these variables and plug the values saved in them
1552 back into the appropriate spots in the debugger.
1553
1554 =cut
1555
1556 if ( exists $ENV{PERLDB_RESTART} ) {
1557
1558     # We're restarting, so we don't need the flag that says to restart anymore.
1559     delete $ENV{PERLDB_RESTART};
1560
1561     # $restart = 1;
1562     @hist          = get_list('PERLDB_HIST');
1563     %break_on_load = get_list("PERLDB_ON_LOAD");
1564     %postponed     = get_list("PERLDB_POSTPONE");
1565
1566         share(@hist);
1567         share(@truehist);
1568         share(%break_on_load);
1569         share(%postponed);
1570
1571     # restore breakpoints/actions
1572     my @had_breakpoints = get_list("PERLDB_VISITED");
1573     for my $file_idx ( 0 .. $#had_breakpoints ) {
1574         my $filename = $had_breakpoints[$file_idx];
1575         my %pf = get_list("PERLDB_FILE_$file_idx");
1576         $postponed_file{ $filename } = \%pf if %pf;
1577         my @lines = sort {$a <=> $b} keys(%pf);
1578         my @enabled_statuses = get_list("PERLDB_FILE_ENABLED_$file_idx");
1579         for my $line_idx (0 .. $#lines) {
1580             _set_breakpoint_enabled_status(
1581                 $filename,
1582                 $lines[$line_idx],
1583                 ($enabled_statuses[$line_idx] ? 1 : ''),
1584             );
1585         }
1586     }
1587
1588     # restore options
1589     my %opt = get_list("PERLDB_OPT");
1590     my ( $opt, $val );
1591     while ( ( $opt, $val ) = each %opt ) {
1592         $val =~ s/[\\\']/\\$1/g;
1593         parse_options("$opt'$val'");
1594     }
1595
1596     # restore original @INC
1597     @INC     = get_list("PERLDB_INC");
1598     @ini_INC = @INC;
1599
1600     # return pre/postprompt actions and typeahead buffer
1601     $pretype   = [ get_list("PERLDB_PRETYPE") ];
1602     $pre       = [ get_list("PERLDB_PRE") ];
1603     $post      = [ get_list("PERLDB_POST") ];
1604     @typeahead = get_list( "PERLDB_TYPEAHEAD", @typeahead );
1605 } ## end if (exists $ENV{PERLDB_RESTART...
1606
1607 =head2 SETTING UP THE TERMINAL
1608
1609 Now, we'll decide how the debugger is going to interact with the user.
1610 If there's no TTY, we set the debugger to run non-stop; there's not going
1611 to be anyone there to enter commands.
1612
1613 =cut
1614
1615 if ($notty) {
1616     $runnonstop = 1;
1617         share($runnonstop);
1618 }
1619
1620 =pod
1621
1622 If there is a TTY, we have to determine who it belongs to before we can
1623 proceed. If this is a slave editor or graphical debugger (denoted by
1624 the first command-line switch being '-emacs'), we shift this off and
1625 set C<$rl> to 0 (XXX ostensibly to do straight reads).
1626
1627 =cut
1628
1629 else {
1630
1631     # Is Perl being run from a slave editor or graphical debugger?
1632     # If so, don't use readline, and set $slave_editor = 1.
1633     $slave_editor =
1634       ( ( defined $main::ARGV[0] ) and ( $main::ARGV[0] eq '-emacs' ) );
1635     $rl = 0, shift(@main::ARGV) if $slave_editor;
1636
1637     #require Term::ReadLine;
1638
1639 =pod
1640
1641 We then determine what the console should be on various systems:
1642
1643 =over 4
1644
1645 =item * Cygwin - We use C<stdin> instead of a separate device.
1646
1647 =cut
1648
1649     if ( $^O eq 'cygwin' ) {
1650
1651         # /dev/tty is binary. use stdin for textmode
1652         undef $console;
1653     }
1654
1655 =item * Unix - use C</dev/tty>.
1656
1657 =cut
1658
1659     elsif ( -e "/dev/tty" ) {
1660         $console = "/dev/tty";
1661     }
1662
1663 =item * Windows or MSDOS - use C<con>.
1664
1665 =cut
1666
1667     elsif ( $^O eq 'dos' or -e "con" or $^O eq 'MSWin32' ) {
1668         $console = "con";
1669     }
1670
1671 =item * VMS - use C<sys$command>.
1672
1673 =cut
1674
1675     else {
1676
1677         # everything else is ...
1678         $console = "sys\$command";
1679     }
1680
1681 =pod
1682
1683 =back
1684
1685 Several other systems don't use a specific console. We C<undef $console>
1686 for those (Windows using a slave editor/graphical debugger, NetWare, OS/2
1687 with a slave editor, Epoc).
1688
1689 =cut
1690
1691     if ( ( $^O eq 'MSWin32' ) and ( $slave_editor or defined $ENV{EMACS} ) ) {
1692
1693         # /dev/tty is binary. use stdin for textmode
1694         $console = undef;
1695     }
1696
1697     if ( $^O eq 'NetWare' ) {
1698
1699         # /dev/tty is binary. use stdin for textmode
1700         $console = undef;
1701     }
1702
1703     # In OS/2, we need to use STDIN to get textmode too, even though
1704     # it pretty much looks like Unix otherwise.
1705     if ( defined $ENV{OS2_SHELL} and ( $slave_editor or $ENV{WINDOWID} ) )
1706     {    # In OS/2
1707         $console = undef;
1708     }
1709
1710     # EPOC also falls into the 'got to use STDIN' camp.
1711     if ( $^O eq 'epoc' ) {
1712         $console = undef;
1713     }
1714
1715 =pod
1716
1717 If there is a TTY hanging around from a parent, we use that as the console.
1718
1719 =cut
1720
1721     $console = $tty if defined $tty;
1722
1723 =head2 SOCKET HANDLING   
1724
1725 The debugger is capable of opening a socket and carrying out a debugging
1726 session over the socket.
1727
1728 If C<RemotePort> was defined in the options, the debugger assumes that it
1729 should try to start a debugging session on that port. It builds the socket
1730 and then tries to connect the input and output filehandles to it.
1731
1732 =cut
1733
1734     # Handle socket stuff.
1735
1736     if ( defined $remoteport ) {
1737
1738         # If RemotePort was defined in the options, connect input and output
1739         # to the socket.
1740         $IN = $OUT = connect_remoteport();
1741     } ## end if (defined $remoteport)
1742
1743 =pod
1744
1745 If no C<RemotePort> was defined, and we want to create a TTY on startup,
1746 this is probably a situation where multiple debuggers are running (for example,
1747 a backticked command that starts up another debugger). We create a new IN and
1748 OUT filehandle, and do the necessary mojo to create a new TTY if we know how
1749 and if we can.
1750
1751 =cut
1752
1753     # Non-socket.
1754     else {
1755
1756         # Two debuggers running (probably a system or a backtick that invokes
1757         # the debugger itself under the running one). create a new IN and OUT
1758         # filehandle, and do the necessary mojo to create a new tty if we
1759         # know how, and we can.
1760         create_IN_OUT(4) if $CreateTTY & 4;
1761         if ($console) {
1762
1763             # If we have a console, check to see if there are separate ins and
1764             # outs to open. (They are assumed identical if not.)
1765
1766             my ( $i, $o ) = split /,/, $console;
1767             $o = $i unless defined $o;
1768
1769             # read/write on in, or just read, or read on STDIN.
1770             open( IN,      "+<$i" )
1771               || open( IN, "<$i" )
1772               || open( IN, "<&STDIN" );
1773
1774             # read/write/create/clobber out, or write/create/clobber out,
1775             # or merge with STDERR, or merge with STDOUT.
1776                  open( OUT, "+>$o" )
1777               || open( OUT, ">$o" )
1778               || open( OUT, ">&STDERR" )
1779               || open( OUT, ">&STDOUT" );    # so we don't dongle stdout
1780
1781         } ## end if ($console)
1782         elsif ( not defined $console ) {
1783
1784             # No console. Open STDIN.
1785             open( IN, "<&STDIN" );
1786
1787             # merge with STDERR, or with STDOUT.
1788             open( OUT,      ">&STDERR" )
1789               || open( OUT, ">&STDOUT" );    # so we don't dongle stdout
1790             $console = 'STDIN/OUT';
1791         } ## end elsif (not defined $console)
1792
1793         # Keep copies of the filehandles so that when the pager runs, it
1794         # can close standard input without clobbering ours.
1795         $IN = \*IN, $OUT = \*OUT if $console or not defined $console;
1796     } ## end elsif (from if(defined $remoteport))
1797
1798     # Unbuffer DB::OUT. We need to see responses right away.
1799     my $previous = select($OUT);
1800     $| = 1;                                  # for DB::OUT
1801     select($previous);
1802
1803     # Line info goes to debugger output unless pointed elsewhere.
1804     # Pointing elsewhere makes it possible for slave editors to
1805     # keep track of file and position. We have both a filehandle
1806     # and a I/O description to keep track of.
1807     $LINEINFO = $OUT     unless defined $LINEINFO;
1808     $lineinfo = $console unless defined $lineinfo;
1809         # share($LINEINFO); # <- unable to share globs
1810         share($lineinfo);   # 
1811
1812 =pod
1813
1814 To finish initialization, we show the debugger greeting,
1815 and then call the C<afterinit()> subroutine if there is one.
1816
1817 =cut
1818
1819     # Show the debugger greeting.
1820     $header =~ s/.Header: ([^,]+),v(\s+\S+\s+\S+).*$/$1$2/;
1821     unless ($runnonstop) {
1822         local $\ = '';
1823         local $, = '';
1824         if ( $term_pid eq '-1' ) {
1825             print $OUT "\nDaughter DB session started...\n";
1826         }
1827         else {
1828             print $OUT "\nLoading DB routines from $header\n";
1829             print $OUT (
1830                 "Editor support ",
1831                 $slave_editor ? "enabled" : "available", ".\n"
1832             );
1833             print $OUT
1834 "\nEnter h or 'h h' for help, or '$doccmd perldebug' for more help.\n\n";
1835         } ## end else [ if ($term_pid eq '-1')
1836     } ## end unless ($runnonstop)
1837 } ## end else [ if ($notty)
1838
1839 # XXX This looks like a bug to me.
1840 # Why copy to @ARGS and then futz with @args?
1841 @ARGS = @ARGV;
1842 for (@args) {
1843     # Make sure backslashes before single quotes are stripped out, and
1844     # keep args unless they are numeric (XXX why?)
1845     # s/\'/\\\'/g;                      # removed while not justified understandably
1846     # s/(.*)/'$1'/ unless /^-?[\d.]+$/; # ditto
1847 }
1848
1849 # If there was an afterinit() sub defined, call it. It will get
1850 # executed in our scope, so it can fiddle with debugger globals.
1851 if ( defined &afterinit ) {    # May be defined in $rcfile
1852     &afterinit();
1853 }
1854
1855 # Inform us about "Stack dump during die enabled ..." in dieLevel().
1856 $I_m_init = 1;
1857
1858 ############################################################ Subroutines
1859
1860 =head1 SUBROUTINES
1861
1862 =head2 DB
1863
1864 This gigantic subroutine is the heart of the debugger. Called before every
1865 statement, its job is to determine if a breakpoint has been reached, and
1866 stop if so; read commands from the user, parse them, and execute
1867 them, and then send execution off to the next statement.
1868
1869 Note that the order in which the commands are processed is very important;
1870 some commands earlier in the loop will actually alter the C<$cmd> variable
1871 to create other commands to be executed later. This is all highly I<optimized>
1872 but can be confusing. Check the comments for each C<$cmd ... && do {}> to
1873 see what's happening in any given command.
1874
1875 =cut
1876
1877 sub DB {
1878
1879     # lock the debugger and get the thread id for the prompt
1880         lock($DBGR);
1881         my $tid;
1882         if ($ENV{PERL5DB_THREADED}) {
1883                 $tid = eval { "[".threads->tid."]" };
1884         }
1885
1886     # Check for whether we should be running continuously or not.
1887     # _After_ the perl program is compiled, $single is set to 1:
1888     if ( $single and not $second_time++ ) {
1889
1890         # Options say run non-stop. Run until we get an interrupt.
1891         if ($runnonstop) {    # Disable until signal
1892                 # If there's any call stack in place, turn off single
1893                 # stepping into subs throughout the stack.
1894             for ( $i = 0 ; $i <= $stack_depth ; ) {
1895                 $stack[ $i++ ] &= ~1;
1896             }
1897
1898             # And we are now no longer in single-step mode.
1899             $single = 0;
1900
1901             # If we simply returned at this point, we wouldn't get
1902             # the trace info. Fall on through.
1903             # return;
1904         } ## end if ($runnonstop)
1905
1906         elsif ($ImmediateStop) {
1907
1908             # We are supposed to stop here; XXX probably a break.
1909             $ImmediateStop = 0;    # We've processed it; turn it off
1910             $signal        = 1;    # Simulate an interrupt to force
1911                                    # us into the command loop
1912         }
1913     } ## end if ($single and not $second_time...
1914
1915     # If we're in single-step mode, or an interrupt (real or fake)
1916     # has occurred, turn off non-stop mode.
1917     $runnonstop = 0 if $single or $signal;
1918
1919     # Preserve current values of $@, $!, $^E, $,, $/, $\, $^W.
1920     # The code being debugged may have altered them.
1921     &save;
1922
1923     # Since DB::DB gets called after every line, we can use caller() to
1924     # figure out where we last were executing. Sneaky, eh? This works because
1925     # caller is returning all the extra information when called from the
1926     # debugger.
1927     local ( $package, $filename, $line ) = caller;
1928     local $filename_ini = $filename;
1929
1930     # set up the context for DB::eval, so it can properly execute
1931     # code on behalf of the user. We add the package in so that the
1932     # code is eval'ed in the proper package (not in the debugger!).
1933     local $usercontext =
1934       '($@, $!, $^E, $,, $/, $\, $^W) = @saved;' . "package $package;";
1935
1936     # Create an alias to the active file magical array to simplify
1937     # the code here.
1938     local (*dbline) = $main::{ '_<' . $filename };
1939
1940     # Last line in the program.
1941     local $max = $#dbline;
1942
1943     # if we have something here, see if we should break.
1944     if ( $dbline{$line}
1945         && _is_breakpoint_enabled($filename, $line)
1946         && ( ( $stop, $action ) = split( /\0/, $dbline{$line} ) ) )
1947     {
1948
1949         # Stop if the stop criterion says to just stop.
1950         if ( $stop eq '1' ) {
1951             $signal |= 1;
1952         }
1953
1954         # It's a conditional stop; eval it in the user's context and
1955         # see if we should stop. If so, remove the one-time sigil.
1956         elsif ($stop) {
1957             $evalarg = "\$DB::signal |= 1 if do {$stop}";
1958             &eval;
1959             $dbline{$line} =~ s/;9($|\0)/$1/;
1960         }
1961     } ## end if ($dbline{$line} && ...
1962
1963     # Preserve the current stop-or-not, and see if any of the W
1964     # (watch expressions) has changed.
1965     my $was_signal = $signal;
1966
1967     # If we have any watch expressions ...
1968     if ( $trace & 2 ) {
1969         for ( my $n = 0 ; $n <= $#to_watch ; $n++ ) {
1970             $evalarg = $to_watch[$n];
1971             local $onetimeDump;    # Tell DB::eval() to not output results
1972
1973             # Fix context DB::eval() wants to return an array, but
1974             # we need a scalar here.
1975             my ($val) = join( "', '", &eval );
1976             $val = ( ( defined $val ) ? "'$val'" : 'undef' );
1977
1978             # Did it change?
1979             if ( $val ne $old_watch[$n] ) {
1980
1981                 # Yep! Show the difference, and fake an interrupt.
1982                 $signal = 1;
1983                 print $OUT <<EOP;
1984 Watchpoint $n:\t$to_watch[$n] changed:
1985     old value:\t$old_watch[$n]
1986     new value:\t$val
1987 EOP
1988                 $old_watch[$n] = $val;
1989             } ## end if ($val ne $old_watch...
1990         } ## end for (my $n = 0 ; $n <= ...
1991     } ## end if ($trace & 2)
1992
1993 =head2 C<watchfunction()>
1994
1995 C<watchfunction()> is a function that can be defined by the user; it is a
1996 function which will be run on each entry to C<DB::DB>; it gets the 
1997 current package, filename, and line as its parameters.
1998
1999 The watchfunction can do anything it likes; it is executing in the 
2000 debugger's context, so it has access to all of the debugger's internal
2001 data structures and functions.
2002
2003 C<watchfunction()> can control the debugger's actions. Any of the following
2004 will cause the debugger to return control to the user's program after
2005 C<watchfunction()> executes:
2006
2007 =over 4 
2008
2009 =item *
2010
2011 Returning a false value from the C<watchfunction()> itself.
2012
2013 =item *
2014
2015 Altering C<$single> to a false value.
2016
2017 =item *
2018
2019 Altering C<$signal> to a false value.
2020
2021 =item *
2022
2023 Turning off the C<4> bit in C<$trace> (this also disables the
2024 check for C<watchfunction()>. This can be done with
2025
2026     $trace &= ~4;
2027
2028 =back
2029
2030 =cut
2031
2032     # If there's a user-defined DB::watchfunction, call it with the
2033     # current package, filename, and line. The function executes in
2034     # the DB:: package.
2035     if ( $trace & 4 ) {    # User-installed watch
2036         return
2037           if watchfunction( $package, $filename, $line )
2038           and not $single
2039           and not $was_signal
2040           and not( $trace & ~4 );
2041     } ## end if ($trace & 4)
2042
2043     # Pick up any alteration to $signal in the watchfunction, and
2044     # turn off the signal now.
2045     $was_signal = $signal;
2046     $signal     = 0;
2047
2048 =head2 GETTING READY TO EXECUTE COMMANDS
2049
2050 The debugger decides to take control if single-step mode is on, the
2051 C<t> command was entered, or the user generated a signal. If the program
2052 has fallen off the end, we set things up so that entering further commands
2053 won't cause trouble, and we say that the program is over.
2054
2055 =cut
2056
2057     # Check to see if we should grab control ($single true,
2058     # trace set appropriately, or we got a signal).
2059     if ( $single || ( $trace & 1 ) || $was_signal ) {
2060
2061         # Yes, grab control.
2062         if ($slave_editor) {
2063
2064             # Tell the editor to update its position.
2065             $position = "\032\032$filename:$line:0\n";
2066             print_lineinfo($position);
2067         }
2068
2069 =pod
2070
2071 Special check: if we're in package C<DB::fake>, we've gone through the 
2072 C<END> block at least once. We set up everything so that we can continue
2073 to enter commands and have a valid context to be in.
2074
2075 =cut
2076
2077         elsif ( $package eq 'DB::fake' ) {
2078
2079             # Fallen off the end already.
2080             $term || &setterm;
2081             print_help(<<EOP);
2082 Debugged program terminated.  Use B<q> to quit or B<R> to restart,
2083   use B<o> I<inhibit_exit> to avoid stopping after program termination,
2084   B<h q>, B<h R> or B<h o> to get additional info.  
2085 EOP
2086
2087             # Set the DB::eval context appropriately.
2088             $package     = 'main';
2089             $usercontext =
2090                 '($@, $!, $^E, $,, $/, $\, $^W) = @saved;'
2091               . "package $package;";    # this won't let them modify, alas
2092         } ## end elsif ($package eq 'DB::fake')
2093
2094 =pod
2095
2096 If the program hasn't finished executing, we scan forward to the
2097 next executable line, print that out, build the prompt from the file and line
2098 number information, and print that.   
2099
2100 =cut
2101
2102         else {
2103
2104             # Still somewhere in the midst of execution. Set up the
2105             #  debugger prompt.
2106             $sub =~ s/\'/::/;    # Swap Perl 4 package separators (') to
2107                                  # Perl 5 ones (sorry, we don't print Klingon
2108                                  #module names)
2109
2110             $prefix = $sub =~ /::/ ? "" : "${'package'}::";
2111             $prefix .= "$sub($filename:";
2112             $after = ( $dbline[$line] =~ /\n$/ ? '' : "\n" );
2113
2114             # Break up the prompt if it's really long.
2115             if ( length($prefix) > 30 ) {
2116                 $position = "$prefix$line):\n$line:\t$dbline[$line]$after";
2117                 $prefix   = "";
2118                 $infix    = ":\t";
2119             }
2120             else {
2121                 $infix    = "):\t";
2122                 $position = "$prefix$line$infix$dbline[$line]$after";
2123             }
2124
2125             # Print current line info, indenting if necessary.
2126             if ($frame) {
2127                 print_lineinfo( ' ' x $stack_depth,
2128                     "$line:\t$dbline[$line]$after" );
2129             }
2130             else {
2131                 depth_print_lineinfo($position);
2132             }
2133
2134             # Scan forward, stopping at either the end or the next
2135             # unbreakable line.
2136             for ( $i = $line + 1 ; $i <= $max && $dbline[$i] == 0 ; ++$i )
2137             {    #{ vi
2138
2139                 # Drop out on null statements, block closers, and comments.
2140                 last if $dbline[$i] =~ /^\s*[\;\}\#\n]/;
2141
2142                 # Drop out if the user interrupted us.
2143                 last if $signal;
2144
2145                 # Append a newline if the line doesn't have one. Can happen
2146                 # in eval'ed text, for instance.
2147                 $after = ( $dbline[$i] =~ /\n$/ ? '' : "\n" );
2148
2149                 # Next executable line.
2150                 $incr_pos = "$prefix$i$infix$dbline[$i]$after";
2151                 $position .= $incr_pos;
2152                 if ($frame) {
2153
2154                     # Print it indented if tracing is on.
2155                     print_lineinfo( ' ' x $stack_depth,
2156                         "$i:\t$dbline[$i]$after" );
2157                 }
2158                 else {
2159                     depth_print_lineinfo($incr_pos);
2160                 }
2161             } ## end for ($i = $line + 1 ; $i...
2162         } ## end else [ if ($slave_editor)
2163     } ## end if ($single || ($trace...
2164
2165 =pod
2166
2167 If there's an action to be executed for the line we stopped at, execute it.
2168 If there are any preprompt actions, execute those as well.      
2169
2170 =cut
2171
2172     # If there's an action, do it now.
2173     $evalarg = $action, &eval if $action;
2174
2175     # Are we nested another level (e.g., did we evaluate a function
2176     # that had a breakpoint in it at the debugger prompt)?
2177     if ( $single || $was_signal ) {
2178
2179         # Yes, go down a level.
2180         local $level = $level + 1;
2181
2182         # Do any pre-prompt actions.
2183         foreach $evalarg (@$pre) {
2184             &eval;
2185         }
2186
2187         # Complain about too much recursion if we passed the limit.
2188         print $OUT $stack_depth . " levels deep in subroutine calls!\n"
2189           if $single & 4;
2190
2191         # The line we're currently on. Set $incr to -1 to stay here
2192         # until we get a command that tells us to advance.
2193         $start = $line;
2194         $incr  = -1;      # for backward motion.
2195
2196         # Tack preprompt debugger actions ahead of any actual input.
2197         @typeahead = ( @$pretype, @typeahead );
2198
2199 =head2 WHERE ARE WE?
2200
2201 XXX Relocate this section?
2202
2203 The debugger normally shows the line corresponding to the current line of
2204 execution. Sometimes, though, we want to see the next line, or to move elsewhere
2205 in the file. This is done via the C<$incr>, C<$start>, and C<$max> variables.
2206
2207 C<$incr> controls by how many lines the I<current> line should move forward
2208 after a command is executed. If set to -1, this indicates that the I<current>
2209 line shouldn't change.
2210
2211 C<$start> is the I<current> line. It is used for things like knowing where to
2212 move forwards or backwards from when doing an C<L> or C<-> command.
2213
2214 C<$max> tells the debugger where the last line of the current file is. It's
2215 used to terminate loops most often.
2216
2217 =head2 THE COMMAND LOOP
2218
2219 Most of C<DB::DB> is actually a command parsing and dispatch loop. It comes
2220 in two parts:
2221
2222 =over 4
2223
2224 =item *
2225
2226 The outer part of the loop, starting at the C<CMD> label. This loop
2227 reads a command and then executes it.
2228
2229 =item *
2230
2231 The inner part of the loop, starting at the C<PIPE> label. This part
2232 is wholly contained inside the C<CMD> block and only executes a command.
2233 Used to handle commands running inside a pager.
2234
2235 =back
2236
2237 So why have two labels to restart the loop? Because sometimes, it's easier to
2238 have a command I<generate> another command and then re-execute the loop to do
2239 the new command. This is faster, but perhaps a bit more convoluted.
2240
2241 =cut
2242
2243         # The big command dispatch loop. It keeps running until the
2244         # user yields up control again.
2245         #
2246         # If we have a terminal for input, and we get something back
2247         # from readline(), keep on processing.
2248       CMD:
2249         while (
2250
2251             # We have a terminal, or can get one ...
2252             ( $term || &setterm ),
2253
2254             # ... and it belogs to this PID or we get one for this PID ...
2255             ( $term_pid == $$ or resetterm(1) ),
2256
2257             # ... and we got a line of command input ...
2258             defined(
2259                 $cmd = &readline(
2260                         "$pidprompt $tid DB"
2261                       . ( '<' x $level )
2262                       . ( $#hist + 1 )
2263                       . ( '>' x $level ) . " "
2264                 )
2265             )
2266           )
2267         {
2268
2269                         share($cmd);
2270             # ... try to execute the input as debugger commands.
2271
2272             # Don't stop running.
2273             $single = 0;
2274
2275             # No signal is active.
2276             $signal = 0;
2277
2278             # Handle continued commands (ending with \):
2279             $cmd =~ s/\\$/\n/ && do {
2280                 $cmd .= &readline("  cont: ");
2281                 redo CMD;
2282             };
2283
2284 =head4 The null command
2285
2286 A newline entered by itself means I<re-execute the last command>. We grab the
2287 command out of C<$laststep> (where it was recorded previously), and copy it
2288 back into C<$cmd> to be executed below. If there wasn't any previous command,
2289 we'll do nothing below (no command will match). If there was, we also save it
2290 in the command history and fall through to allow the command parsing to pick
2291 it up.
2292
2293 =cut
2294
2295             # Empty input means repeat the last command.
2296             $cmd =~ /^$/ && ( $cmd = $laststep );
2297             chomp($cmd);    # get rid of the annoying extra newline
2298             push( @hist, $cmd ) if length($cmd) > 1;
2299             push( @truehist, $cmd );
2300                         share(@hist);
2301                         share(@truehist);
2302
2303             # This is a restart point for commands that didn't arrive
2304             # via direct user input. It allows us to 'redo PIPE' to
2305             # re-execute command processing without reading a new command.
2306           PIPE: {
2307                 $cmd =~ s/^\s+//s;    # trim annoying leading whitespace
2308                 $cmd =~ s/\s+$//s;    # trim annoying trailing whitespace
2309                 ($i) = split( /\s+/, $cmd );
2310
2311 =head3 COMMAND ALIASES
2312
2313 The debugger can create aliases for commands (these are stored in the
2314 C<%alias> hash). Before a command is executed, the command loop looks it up
2315 in the alias hash and substitutes the contents of the alias for the command,
2316 completely replacing it.
2317
2318 =cut
2319
2320                 # See if there's an alias for the command, and set it up if so.
2321                 if ( $alias{$i} ) {
2322
2323                     # Squelch signal handling; we want to keep control here
2324                     # if something goes loco during the alias eval.
2325                     local $SIG{__DIE__};
2326                     local $SIG{__WARN__};
2327
2328                     # This is a command, so we eval it in the DEBUGGER's
2329                     # scope! Otherwise, we can't see the special debugger
2330                     # variables, or get to the debugger's subs. (Well, we
2331                     # _could_, but why make it even more complicated?)
2332                     eval "\$cmd =~ $alias{$i}";
2333                     if ($@) {
2334                         local $\ = '';
2335                         print $OUT "Couldn't evaluate '$i' alias: $@";
2336                         next CMD;
2337                     }
2338                 } ## end if ($alias{$i})
2339
2340 =head3 MAIN-LINE COMMANDS
2341
2342 All of these commands work up to and after the program being debugged has
2343 terminated. 
2344
2345 =head4 C<q> - quit
2346
2347 Quit the debugger. This entails setting the C<$fall_off_end> flag, so we don't 
2348 try to execute further, cleaning any restart-related stuff out of the
2349 environment, and executing with the last value of C<$?>.
2350
2351 =cut
2352
2353                 $cmd =~ /^q$/ && do {
2354                     $fall_off_end = 1;
2355                     clean_ENV();
2356                     exit $?;
2357                 };
2358
2359 =head4 C<t> - trace [n]
2360
2361 Turn tracing on or off. Inverts the appropriate bit in C<$trace> (q.v.).
2362 If level is specified, set C<$trace_to_depth>.
2363
2364 =cut
2365
2366                 $cmd =~ /^t(?:\s+(\d+))?$/ && do {
2367                     my $levels = $1;
2368                     $trace ^= 1;
2369                     local $\ = '';
2370                     $trace_to_depth = $levels ? $stack_depth + $levels : 1E9;
2371                     print $OUT "Trace = "
2372                       . ( ( $trace & 1 )
2373                       ? ( $levels ? "on (to level $trace_to_depth)" : "on" )
2374                       : "off" ) . "\n";
2375                     next CMD;
2376                 };
2377
2378 =head4 C<S> - list subroutines matching/not matching a pattern
2379
2380 Walks through C<%sub>, checking to see whether or not to print the name.
2381
2382 =cut
2383
2384                 $cmd =~ /^S(\s+(!)?(.+))?$/ && do {
2385
2386                     $Srev     = defined $2;     # Reverse scan?
2387                     $Spatt    = $3;             # The pattern (if any) to use.
2388                     $Snocheck = !defined $1;    # No args - print all subs.
2389
2390                     # Need to make these sane here.
2391                     local $\ = '';
2392                     local $, = '';
2393
2394                     # Search through the debugger's magical hash of subs.
2395                     # If $nocheck is true, just print the sub name.
2396                     # Otherwise, check it against the pattern. We then use
2397                     # the XOR trick to reverse the condition as required.
2398                     foreach $subname ( sort( keys %sub ) ) {
2399                         if ( $Snocheck or $Srev ^ ( $subname =~ /$Spatt/ ) ) {
2400                             print $OUT $subname, "\n";
2401                         }
2402                     }
2403                     next CMD;
2404                 };
2405
2406 =head4 C<X> - list variables in current package
2407
2408 Since the C<V> command actually processes this, just change this to the 
2409 appropriate C<V> command and fall through.
2410
2411 =cut
2412
2413                 $cmd =~ s/^X\b/V $package/;
2414
2415 =head4 C<V> - list variables
2416
2417 Uses C<dumpvar.pl> to dump out the current values for selected variables. 
2418
2419 =cut
2420
2421                 # Bare V commands get the currently-being-debugged package
2422                 # added.
2423                 $cmd =~ /^V$/ && do {
2424                     $cmd = "V $package";
2425                 };
2426
2427                 # V - show variables in package.
2428                 $cmd =~ /^V\b\s*(\S+)\s*(.*)/ && do {
2429
2430                     # Save the currently selected filehandle and
2431                     # force output to debugger's filehandle (dumpvar
2432                     # just does "print" for output).
2433                     local ($savout) = select($OUT);
2434
2435                     # Grab package name and variables to dump.
2436                     $packname = $1;
2437                     @vars     = split( ' ', $2 );
2438
2439                     # If main::dumpvar isn't here, get it.
2440                     do 'dumpvar.pl' || die $@ unless defined &main::dumpvar;
2441                     if ( defined &main::dumpvar ) {
2442
2443                         # We got it. Turn off subroutine entry/exit messages
2444                         # for the moment, along with return values.
2445                         local $frame = 0;
2446                         local $doret = -2;
2447
2448                         # must detect sigpipe failures  - not catching
2449                         # then will cause the debugger to die.
2450                         eval {
2451                             &main::dumpvar(
2452                                 $packname,
2453                                 defined $option{dumpDepth}
2454                                 ? $option{dumpDepth}
2455                                 : -1,    # assume -1 unless specified
2456                                 @vars
2457                             );
2458                         };
2459
2460                         # The die doesn't need to include the $@, because
2461                         # it will automatically get propagated for us.
2462                         if ($@) {
2463                             die unless $@ =~ /dumpvar print failed/;
2464                         }
2465                     } ## end if (defined &main::dumpvar)
2466                     else {
2467
2468                         # Couldn't load dumpvar.
2469                         print $OUT "dumpvar.pl not available.\n";
2470                     }
2471
2472                     # Restore the output filehandle, and go round again.
2473                     select($savout);
2474                     next CMD;
2475                 };
2476
2477 =head4 C<x> - evaluate and print an expression
2478
2479 Hands the expression off to C<DB::eval>, setting it up to print the value
2480 via C<dumpvar.pl> instead of just printing it directly.
2481
2482 =cut
2483
2484                 $cmd =~ s/^x\b/ / && do {    # Remainder gets done by DB::eval()
2485                     $onetimeDump = 'dump';    # main::dumpvar shows the output
2486
2487                     # handle special  "x 3 blah" syntax XXX propagate
2488                     # doc back to special variables.
2489                     if ( $cmd =~ s/^\s*(\d+)(?=\s)/ / ) {
2490                         $onetimedumpDepth = $1;
2491                     }
2492                 };
2493
2494 =head4 C<m> - print methods
2495
2496 Just uses C<DB::methods> to determine what methods are available.
2497
2498 =cut
2499
2500                 $cmd =~ s/^m\s+([\w:]+)\s*$/ / && do {
2501                     methods($1);
2502                     next CMD;
2503                 };
2504
2505                 # m expr - set up DB::eval to do the work
2506                 $cmd =~ s/^m\b/ / && do {    # Rest gets done by DB::eval()
2507                     $onetimeDump = 'methods';   #  method output gets used there
2508                 };
2509
2510 =head4 C<f> - switch files
2511
2512 =cut
2513
2514                 $cmd =~ /^f\b\s*(.*)/ && do {
2515                     $file = $1;
2516                     $file =~ s/\s+$//;
2517
2518                     # help for no arguments (old-style was return from sub).
2519                     if ( !$file ) {
2520                         print $OUT
2521                           "The old f command is now the r command.\n";    # hint
2522                         print $OUT "The new f command switches filenames.\n";
2523                         next CMD;
2524                     } ## end if (!$file)
2525
2526                     # if not in magic file list, try a close match.
2527                     if ( !defined $main::{ '_<' . $file } ) {
2528                         if ( ($try) = grep( m#^_<.*$file#, keys %main:: ) ) {
2529                             {
2530                                 $try = substr( $try, 2 );
2531                                 print $OUT "Choosing $try matching '$file':\n";
2532                                 $file = $try;
2533                             }
2534                         } ## end if (($try) = grep(m#^_<.*$file#...
2535                     } ## end if (!defined $main::{ ...
2536
2537                     # If not successfully switched now, we failed.
2538                     if ( !defined $main::{ '_<' . $file } ) {
2539                         print $OUT "No file matching '$file' is loaded.\n";
2540                         next CMD;
2541                     }
2542
2543                     # We switched, so switch the debugger internals around.
2544                     elsif ( $file ne $filename ) {
2545                         *dbline   = $main::{ '_<' . $file };
2546                         $max      = $#dbline;
2547                         $filename = $file;
2548                         $start    = 1;
2549                         $cmd      = "l";
2550                     } ## end elsif ($file ne $filename)
2551
2552                     # We didn't switch; say we didn't.
2553                     else {
2554                         print $OUT "Already in $file.\n";
2555                         next CMD;
2556                     }
2557                 };
2558
2559 =head4 C<.> - return to last-executed line.
2560
2561 We set C<$incr> to -1 to indicate that the debugger shouldn't move ahead,
2562 and then we look up the line in the magical C<%dbline> hash.
2563
2564 =cut
2565
2566                 # . command.
2567                 $cmd =~ /^\.$/ && do {
2568                     $incr = -1;    # stay at current line
2569
2570                     # Reset everything to the old location.
2571                     $start    = $line;
2572                     $filename = $filename_ini;
2573                     *dbline   = $main::{ '_<' . $filename };
2574                     $max      = $#dbline;
2575
2576                     # Now where are we?
2577                     print_lineinfo($position);
2578                     next CMD;
2579                 };
2580
2581 =head4 C<-> - back one window
2582
2583 We change C<$start> to be one window back; if we go back past the first line,
2584 we set it to be the first line. We ser C<$incr> to put us back at the
2585 currently-executing line, and then put a C<l $start +> (list one window from
2586 C<$start>) in C<$cmd> to be executed later.
2587
2588 =cut
2589
2590                 # - - back a window.
2591                 $cmd =~ /^-$/ && do {
2592
2593                     # back up by a window; go to 1 if back too far.
2594                     $start -= $incr + $window + 1;
2595                     $start = 1 if $start <= 0;
2596                     $incr  = $window - 1;
2597
2598                     # Generate and execute a "l +" command (handled below).
2599                     $cmd = 'l ' . ($start) . '+';
2600                 };
2601
2602 =head3 PRE-580 COMMANDS VS. NEW COMMANDS: C<a, A, b, B, h, l, L, M, o, O, P, v, w, W, E<lt>, E<lt>E<lt>, {, {{>
2603
2604 In Perl 5.8.0, a realignment of the commands was done to fix up a number of
2605 problems, most notably that the default case of several commands destroying
2606 the user's work in setting watchpoints, actions, etc. We wanted, however, to
2607 retain the old commands for those who were used to using them or who preferred
2608 them. At this point, we check for the new commands and call C<cmd_wrapper> to
2609 deal with them instead of processing them in-line.
2610
2611 =cut
2612
2613                 # All of these commands were remapped in perl 5.8.0;
2614                 # we send them off to the secondary dispatcher (see below).
2615                 $cmd =~ /^([aAbBeEhilLMoOPvwW]\b|[<>\{]{1,2})\s*(.*)/so && do {
2616                     &cmd_wrapper( $1, $2, $line );
2617                     next CMD;
2618                 };
2619
2620 =head4 C<y> - List lexicals in higher scope
2621
2622 Uses C<PadWalker> to find the lexicals supplied as arguments in a scope    
2623 above the current one and then displays then using C<dumpvar.pl>.
2624
2625 =cut
2626
2627                 $cmd =~ /^y(?:\s+(\d*)\s*(.*))?$/ && do {
2628
2629                     # See if we've got the necessary support.
2630                     eval { require PadWalker; PadWalker->VERSION(0.08) }
2631                       or &warn(
2632                         $@ =~ /locate/
2633                         ? "PadWalker module not found - please install\n"
2634                         : $@
2635                       )
2636                       and next CMD;
2637
2638                     # Load up dumpvar if we don't have it. If we can, that is.
2639                     do 'dumpvar.pl' || die $@ unless defined &main::dumpvar;
2640                     defined &main::dumpvar
2641                       or print $OUT "dumpvar.pl not available.\n"
2642                       and next CMD;
2643
2644                     # Got all the modules we need. Find them and print them.
2645                     my @vars = split( ' ', $2 || '' );
2646
2647                     # Find the pad.
2648                     my $h = eval { PadWalker::peek_my( ( $1 || 0 ) + 1 ) };
2649
2650                     # Oops. Can't find it.
2651                     $@ and $@ =~ s/ at .*//, &warn($@), next CMD;
2652
2653                     # Show the desired vars with dumplex().
2654                     my $savout = select($OUT);
2655
2656                     # Have dumplex dump the lexicals.
2657                     dumpvar::dumplex( $_, $h->{$_},
2658                         defined $option{dumpDepth} ? $option{dumpDepth} : -1,
2659                         @vars )
2660                       for sort keys %$h;
2661                     select($savout);
2662                     next CMD;
2663                 };
2664
2665 =head3 COMMANDS NOT WORKING AFTER PROGRAM ENDS
2666
2667 All of the commands below this point don't work after the program being
2668 debugged has ended. All of them check to see if the program has ended; this
2669 allows the commands to be relocated without worrying about a 'line of
2670 demarcation' above which commands can be entered anytime, and below which
2671 they can't.
2672
2673 =head4 C<n> - single step, but don't trace down into subs
2674
2675 Done by setting C<$single> to 2, which forces subs to execute straight through
2676 when entered (see C<DB::sub>). We also save the C<n> command in C<$laststep>,
2677 so a null command knows what to re-execute. 
2678
2679 =cut
2680
2681                 # n - next
2682                 $cmd =~ /^n$/ && do {
2683                     end_report(), next CMD if $finished and $level <= 1;
2684
2685                     # Single step, but don't enter subs.
2686                     $single = 2;
2687
2688                     # Save for empty command (repeat last).
2689                     $laststep = $cmd;
2690                     last CMD;
2691                 };
2692
2693 =head4 C<s> - single-step, entering subs
2694
2695 Sets C<$single> to 1, which causes C<DB::sub> to continue tracing inside     
2696 subs. Also saves C<s> as C<$lastcmd>.
2697
2698 =cut
2699
2700                 # s - single step.
2701                 $cmd =~ /^s$/ && do {
2702
2703                     # Get out and restart the command loop if program
2704                     # has finished.
2705                     end_report(), next CMD if $finished and $level <= 1;
2706
2707                     # Single step should enter subs.
2708                     $single = 1;
2709
2710                     # Save for empty command (repeat last).
2711                     $laststep = $cmd;
2712                     last CMD;
2713                 };
2714
2715 =head4 C<c> - run continuously, setting an optional breakpoint
2716
2717 Most of the code for this command is taken up with locating the optional
2718 breakpoint, which is either a subroutine name or a line number. We set
2719 the appropriate one-time-break in C<@dbline> and then turn off single-stepping
2720 in this and all call levels above this one.
2721
2722 =cut
2723
2724                 # c - start continuous execution.
2725                 $cmd =~ /^c\b\s*([\w:]*)\s*$/ && do {
2726
2727                     # Hey, show's over. The debugged program finished
2728                     # executing already.
2729                     end_report(), next CMD if $finished and $level <= 1;
2730
2731                     # Capture the place to put a one-time break.
2732                     $subname = $i = $1;
2733
2734                     #  Probably not needed, since we finish an interactive
2735                     #  sub-session anyway...
2736                     # local $filename = $filename;
2737                     # local *dbline = *dbline; # XXX Would this work?!
2738                     #
2739                     # The above question wonders if localizing the alias
2740                     # to the magic array works or not. Since it's commented
2741                     # out, we'll just leave that to speculation for now.
2742
2743                     # If the "subname" isn't all digits, we'll assume it
2744                     # is a subroutine name, and try to find it.
2745                     if ( $subname =~ /\D/ ) {    # subroutine name
2746                             # Qualify it to the current package unless it's
2747                             # already qualified.
2748                         $subname = $package . "::" . $subname
2749                           unless $subname =~ /::/;
2750
2751                         # find_sub will return "file:line_number" corresponding
2752                         # to where the subroutine is defined; we call find_sub,
2753                         # break up the return value, and assign it in one
2754                         # operation.
2755                         ( $file, $i ) = ( find_sub($subname) =~ /^(.*):(.*)$/ );
2756
2757                         # Force the line number to be numeric.
2758                         $i += 0;
2759
2760                         # If we got a line number, we found the sub.
2761                         if ($i) {
2762
2763                             # Switch all the debugger's internals around so
2764                             # we're actually working with that file.
2765                             $filename = $file;
2766                             *dbline   = $main::{ '_<' . $filename };
2767
2768                             # Mark that there's a breakpoint in this file.
2769                             $had_breakpoints{$filename} |= 1;
2770
2771                             # Scan forward to the first executable line
2772                             # after the 'sub whatever' line.
2773                             $max = $#dbline;
2774                             ++$i while $dbline[$i] == 0 && $i < $max;
2775                         } ## end if ($i)
2776
2777                         # We didn't find a sub by that name.
2778                         else {
2779                             print $OUT "Subroutine $subname not found.\n";
2780                             next CMD;
2781                         }
2782                     } ## end if ($subname =~ /\D/)
2783
2784                     # At this point, either the subname was all digits (an
2785                     # absolute line-break request) or we've scanned through
2786                     # the code following the definition of the sub, looking
2787                     # for an executable, which we may or may not have found.
2788                     #
2789                     # If $i (which we set $subname from) is non-zero, we
2790                     # got a request to break at some line somewhere. On
2791                     # one hand, if there wasn't any real subroutine name
2792                     # involved, this will be a request to break in the current
2793                     # file at the specified line, so we have to check to make
2794                     # sure that the line specified really is breakable.
2795                     #
2796                     # On the other hand, if there was a subname supplied, the
2797                     # preceding block has moved us to the proper file and
2798                     # location within that file, and then scanned forward
2799                     # looking for the next executable line. We have to make
2800                     # sure that one was found.
2801                     #
2802                     # On the gripping hand, we can't do anything unless the
2803                     # current value of $i points to a valid breakable line.
2804                     # Check that.
2805                     if ($i) {
2806
2807                         # Breakable?
2808                         if ( $dbline[$i] == 0 ) {
2809                             print $OUT "Line $i not breakable.\n";
2810                             next CMD;
2811                         }
2812
2813                         # Yes. Set up the one-time-break sigil.
2814                         $dbline{$i} =~ s/($|\0)/;9$1/;  # add one-time-only b.p.
2815                     } ## end if ($i)
2816
2817                     # Turn off stack tracing from here up.
2818                     for ( $i = 0 ; $i <= $stack_depth ; ) {
2819                         $stack[ $i++ ] &= ~1;
2820                     }
2821                     last CMD;
2822                 };
2823
2824 =head4 C<r> - return from a subroutine
2825
2826 For C<r> to work properly, the debugger has to stop execution again
2827 immediately after the return is executed. This is done by forcing
2828 single-stepping to be on in the call level above the current one. If
2829 we are printing return values when a C<r> is executed, set C<$doret>
2830 appropriately, and force us out of the command loop.
2831
2832 =cut
2833
2834                 # r - return from the current subroutine.
2835                 $cmd =~ /^r$/ && do {
2836
2837                     # Can't do anything if the program's over.
2838                     end_report(), next CMD if $finished and $level <= 1;
2839
2840                     # Turn on stack trace.
2841                     $stack[$stack_depth] |= 1;
2842
2843                     # Print return value unless the stack is empty.
2844                     $doret = $option{PrintRet} ? $stack_depth - 1 : -2;
2845                     last CMD;
2846                 };
2847
2848 =head4 C<T> - stack trace
2849
2850 Just calls C<DB::print_trace>.
2851
2852 =cut
2853
2854                 $cmd =~ /^T$/ && do {
2855                     print_trace( $OUT, 1 );    # skip DB
2856                     next CMD;
2857                 };
2858
2859 =head4 C<w> - List window around current line.
2860
2861 Just calls C<DB::cmd_w>.
2862
2863 =cut
2864
2865                 $cmd =~ /^w\b\s*(.*)/s && do { &cmd_w( 'w', $1 ); next CMD; };
2866
2867 =head4 C<W> - watch-expression processing.
2868
2869 Just calls C<DB::cmd_W>. 
2870
2871 =cut
2872
2873                 $cmd =~ /^W\b\s*(.*)/s && do { &cmd_W( 'W', $1 ); next CMD; };
2874
2875 =head4 C</> - search forward for a string in the source
2876
2877 We take the argument and treat it as a pattern. If it turns out to be a 
2878 bad one, we return the error we got from trying to C<eval> it and exit.
2879 If not, we create some code to do the search and C<eval> it so it can't 
2880 mess us up.
2881
2882 =cut
2883
2884                 $cmd =~ /^\/(.*)$/ && do {
2885
2886                     # The pattern as a string.
2887                     $inpat = $1;
2888
2889                     # Remove the final slash.
2890                     $inpat =~ s:([^\\])/$:$1:;
2891
2892                     # If the pattern isn't null ...
2893                     if ( $inpat ne "" ) {
2894
2895                         # Turn of warn and die procesing for a bit.
2896                         local $SIG{__DIE__};
2897                         local $SIG{__WARN__};
2898
2899                         # Create the pattern.
2900                         eval '$inpat =~ m' . "\a$inpat\a";
2901                         if ( $@ ne "" ) {
2902
2903                             # Oops. Bad pattern. No biscuit.
2904                             # Print the eval error and go back for more
2905                             # commands.
2906                             print $OUT "$@";
2907                             next CMD;
2908                         }
2909                         $pat = $inpat;
2910                     } ## end if ($inpat ne "")
2911
2912                     # Set up to stop on wrap-around.
2913                     $end = $start;
2914
2915                     # Don't move off the current line.
2916                     $incr = -1;
2917
2918                     # Done in eval so nothing breaks if the pattern
2919                     # does something weird.
2920                     eval '
2921                         for (;;) {
2922                             # Move ahead one line.
2923                             ++$start;
2924
2925                             # Wrap if we pass the last line.
2926                             $start = 1 if ($start > $max);
2927
2928                             # Stop if we have gotten back to this line again,
2929                             last if ($start == $end);
2930
2931                             # A hit! (Note, though, that we are doing
2932                             # case-insensitive matching. Maybe a qr//
2933                             # expression would be better, so the user could
2934                             # do case-sensitive matching if desired.
2935                             if ($dbline[$start] =~ m' . "\a$pat\a" . 'i) {
2936                                 if ($slave_editor) {
2937                                     # Handle proper escaping in the slave.
2938                                     print $OUT "\032\032$filename:$start:0\n";
2939                                 } 
2940                                 else {
2941                                     # Just print the line normally.
2942                                     print $OUT "$start:\t",$dbline[$start],"\n";
2943                                 }
2944                                 # And quit since we found something.
2945                                 last;
2946                             }
2947                          } ';
2948
2949                     # If we wrapped, there never was a match.
2950                     print $OUT "/$pat/: not found\n" if ( $start == $end );
2951                     next CMD;
2952                 };
2953
2954 =head4 C<?> - search backward for a string in the source
2955
2956 Same as for C</>, except the loop runs backwards.
2957
2958 =cut
2959
2960                 # ? - backward pattern search.
2961                 $cmd =~ /^\?(.*)$/ && do {
2962
2963                     # Get the pattern, remove trailing question mark.
2964                     $inpat = $1;
2965                     $inpat =~ s:([^\\])\?$:$1:;
2966
2967                     # If we've got one ...
2968                     if ( $inpat ne "" ) {
2969
2970                         # Turn off die & warn handlers.
2971                         local $SIG{__DIE__};
2972                         local $SIG{__WARN__};
2973                         eval '$inpat =~ m' . "\a$inpat\a";
2974
2975                         if ( $@ ne "" ) {
2976
2977                             # Ouch. Not good. Print the error.
2978                             print $OUT $@;
2979                             next CMD;
2980                         }
2981                         $pat = $inpat;
2982                     } ## end if ($inpat ne "")
2983
2984                     # Where we are now is where to stop after wraparound.
2985                     $end = $start;
2986
2987                     # Don't move away from this line.
2988                     $incr = -1;
2989
2990                     # Search inside the eval to prevent pattern badness
2991                     # from killing us.
2992                     eval '
2993                         for (;;) {
2994                             # Back up a line.
2995                             --$start;
2996
2997                             # Wrap if we pass the first line.
2998
2999                             $start = $max if ($start <= 0);
3000
3001                             # Quit if we get back where we started,
3002                             last if ($start == $end);
3003
3004                             # Match?
3005                             if ($dbline[$start] =~ m' . "\a$pat\a" . 'i) {
3006                                 if ($slave_editor) {
3007                                     # Yep, follow slave editor requirements.
3008                                     print $OUT "\032\032$filename:$start:0\n";
3009                                 } 
3010                                 else {
3011                                     # Yep, just print normally.
3012                                     print $OUT "$start:\t",$dbline[$start],"\n";
3013                                 }
3014
3015                                 # Found, so done.
3016                                 last;
3017                             }
3018                         } ';
3019
3020                     # Say we failed if the loop never found anything,
3021                     print $OUT "?$pat?: not found\n" if ( $start == $end );
3022                     next CMD;
3023                 };
3024
3025 =head4 C<$rc> - Recall command
3026
3027 Manages the commands in C<@hist> (which is created if C<Term::ReadLine> reports
3028 that the terminal supports history). It find the the command required, puts it
3029 into C<$cmd>, and redoes the loop to execute it.
3030
3031 =cut
3032
3033                 # $rc - recall command.
3034                 $cmd =~ /^$rc+\s*(-)?(\d+)?$/ && do {
3035
3036                     # No arguments, take one thing off history.
3037                     pop(@hist) if length($cmd) > 1;
3038
3039                     # Relative (- found)?
3040                     #  Y - index back from most recent (by 1 if bare minus)
3041                     #  N - go to that particular command slot or the last
3042                     #      thing if nothing following.
3043                     $i = $1 ? ( $#hist - ( $2 || 1 ) ) : ( $2 || $#hist );
3044
3045                     # Pick out the command desired.
3046                     $cmd = $hist[$i];
3047
3048                     # Print the command to be executed and restart the loop
3049                     # with that command in the buffer.
3050                     print $OUT $cmd, "\n";
3051                     redo CMD;
3052                 };
3053
3054 =head4 C<$sh$sh> - C<system()> command
3055
3056 Calls the C<DB::system()> to handle the command. This keeps the C<STDIN> and
3057 C<STDOUT> from getting messed up.
3058
3059 =cut
3060
3061                 # $sh$sh - run a shell command (if it's all ASCII).
3062                 # Can't run shell commands with Unicode in the debugger, hmm.
3063                 $cmd =~ /^$sh$sh\s*([\x00-\xff]*)/ && do {
3064
3065                     # System it.
3066                     &system($1);
3067                     next CMD;
3068                 };
3069
3070 =head4 C<$rc I<pattern> $rc> - Search command history
3071
3072 Another command to manipulate C<@hist>: this one searches it with a pattern.
3073 If a command is found, it is placed in C<$cmd> and executed via C<redo>.
3074
3075 =cut
3076
3077                 # $rc pattern $rc - find a command in the history.
3078                 $cmd =~ /^$rc([^$rc].*)$/ && do {
3079
3080                     # Create the pattern to use.
3081                     $pat = "^$1";
3082
3083                     # Toss off last entry if length is >1 (and it always is).
3084                     pop(@hist) if length($cmd) > 1;
3085
3086                     # Look backward through the history.
3087                     for ( $i = $#hist ; $i ; --$i ) {
3088
3089                         # Stop if we find it.
3090                         last if $hist[$i] =~ /$pat/;
3091                     }
3092
3093                     if ( !$i ) {
3094
3095                         # Never found it.
3096                         print $OUT "No such command!\n\n";
3097                         next CMD;
3098                     }
3099
3100                     # Found it. Put it in the buffer, print it, and process it.
3101                     $cmd = $hist[$i];
3102                     print $OUT $cmd, "\n";
3103                     redo CMD;
3104                 };
3105
3106 =head4 C<$sh> - Invoke a shell     
3107
3108 Uses C<DB::system> to invoke a shell.
3109
3110 =cut
3111
3112                 # $sh - start a shell.
3113                 $cmd =~ /^$sh$/ && do {
3114
3115                     # Run the user's shell. If none defined, run Bourne.
3116                     # We resume execution when the shell terminates.
3117                     &system( $ENV{SHELL} || "/bin/sh" );
3118                     next CMD;
3119                 };
3120
3121 =head4 C<$sh I<command>> - Force execution of a command in a shell
3122
3123 Like the above, but the command is passed to the shell. Again, we use
3124 C<DB::system> to avoid problems with C<STDIN> and C<STDOUT>.
3125
3126 =cut
3127
3128                 # $sh command - start a shell and run a command in it.
3129                 $cmd =~ /^$sh\s*([\x00-\xff]*)/ && do {
3130
3131                     # XXX: using csh or tcsh destroys sigint retvals!
3132                     #&system($1);  # use this instead
3133
3134                     # use the user's shell, or Bourne if none defined.
3135                     &system( $ENV{SHELL} || "/bin/sh", "-c", $1 );
3136                     next CMD;
3137                 };
3138
3139 =head4 C<H> - display commands in history
3140
3141 Prints the contents of C<@hist> (if any).
3142
3143 =cut
3144
3145                 $cmd =~ /^H\b\s*\*/ && do {
3146                     @hist = @truehist = ();
3147                     print $OUT "History cleansed\n";
3148                     next CMD;
3149                 };
3150
3151                 $cmd =~ /^H\b\s*(-(\d+))?/ && do {
3152
3153                     # Anything other than negative numbers is ignored by
3154                     # the (incorrect) pattern, so this test does nothing.
3155                     $end = $2 ? ( $#hist - $2 ) : 0;
3156
3157                     # Set to the minimum if less than zero.
3158                     $hist = 0 if $hist < 0;
3159
3160                     # Start at the end of the array.
3161                     # Stay in while we're still above the ending value.
3162                     # Tick back by one each time around the loop.
3163                     for ( $i = $#hist ; $i > $end ; $i-- ) {
3164
3165                         # Print the command  unless it has no arguments.
3166                         print $OUT "$i: ", $hist[$i], "\n"
3167                           unless $hist[$i] =~ /^.?$/;
3168                     }
3169                     next CMD;
3170                 };
3171
3172 =head4 C<man, doc, perldoc> - look up documentation
3173
3174 Just calls C<runman()> to print the appropriate document.
3175
3176 =cut
3177
3178                 # man, perldoc, doc - show manual pages.
3179                 $cmd =~ /^(?:man|(?:perl)?doc)\b(?:\s+([^(]*))?$/ && do {
3180                     runman($1);
3181                     next CMD;
3182                 };
3183
3184 =head4 C<p> - print
3185
3186 Builds a C<print EXPR> expression in the C<$cmd>; this will get executed at
3187 the bottom of the loop.
3188
3189 =cut
3190
3191                 # p - print (no args): print $_.
3192                 $cmd =~ s/^p$/print {\$DB::OUT} \$_/;
3193
3194                 # p - print the given expression.
3195                 $cmd =~ s/^p\b/print {\$DB::OUT} /;
3196
3197 =head4 C<=> - define command alias
3198
3199 Manipulates C<%alias> to add or list command aliases.
3200
3201 =cut
3202
3203                 # = - set up a command alias.
3204                 $cmd =~ s/^=\s*// && do {
3205                     my @keys;
3206                     if ( length $cmd == 0 ) {
3207
3208                         # No args, get current aliases.
3209                         @keys = sort keys %alias;
3210                     }
3211                     elsif ( my ( $k, $v ) = ( $cmd =~ /^(\S+)\s+(\S.*)/ ) ) {
3212
3213                         # Creating a new alias. $k is alias name, $v is
3214                         # alias value.
3215
3216                         # can't use $_ or kill //g state
3217                         for my $x ( $k, $v ) {
3218
3219                             # Escape "alarm" characters.
3220                             $x =~ s/\a/\\a/g;
3221                         }
3222
3223                         # Substitute key for value, using alarm chars
3224                         # as separators (which is why we escaped them in
3225                         # the command).
3226                         $alias{$k} = "s\a$k\a$v\a";
3227
3228                         # Turn off standard warn and die behavior.
3229                         local $SIG{__DIE__};
3230                         local $SIG{__WARN__};
3231
3232                         # Is it valid Perl?
3233                         unless ( eval "sub { s\a$k\a$v\a }; 1" ) {
3234
3235                             # Nope. Bad alias. Say so and get out.
3236                             print $OUT "Can't alias $k to $v: $@\n";
3237                             delete $alias{$k};
3238                             next CMD;
3239                         }
3240
3241                         # We'll only list the new one.
3242                         @keys = ($k);
3243                     } ## end elsif (my ($k, $v) = ($cmd...
3244
3245                     # The argument is the alias to list.
3246                     else {
3247                         @keys = ($cmd);
3248                     }
3249
3250                     # List aliases.
3251                     for my $k (@keys) {
3252
3253                         # Messy metaquoting: Trim the substitution code off.
3254                         # We use control-G as the delimiter because it's not
3255                         # likely to appear in the alias.
3256                         if ( ( my $v = $alias{$k} ) =~ s\as\a$k\a(.*)\a$\a1\a ) {
3257
3258                             # Print the alias.
3259                             print $OUT "$k\t= $1\n";
3260                         }
3261                         elsif ( defined $alias{$k} ) {
3262
3263                             # Couldn't trim it off; just print the alias code.
3264                             print $OUT "$k\t$alias{$k}\n";
3265                         }
3266                         else {
3267
3268                             # No such, dude.
3269                             print "No alias for $k\n";
3270                         }
3271                     } ## end for my $k (@keys)
3272                     next CMD;
3273                 };
3274
3275 =head4 C<source> - read commands from a file.
3276
3277 Opens a lexical filehandle and stacks it on C<@cmdfhs>; C<DB::readline> will
3278 pick it up.
3279
3280 =cut
3281
3282                 # source - read commands from a file (or pipe!) and execute.
3283                 $cmd =~ /^source\s+(.*\S)/ && do {
3284                     if ( open my $fh, $1 ) {
3285
3286                         # Opened OK; stick it in the list of file handles.
3287                         push @cmdfhs, $fh;
3288                     }
3289                     else {
3290
3291                         # Couldn't open it.
3292                         &warn("Can't execute '$1': $!\n");
3293                     }
3294                     next CMD;
3295                 };
3296
3297                 $cmd =~ /^(enable|disable)\s+(\S+)\s*$/ && do {
3298                     my ($cmd, $position) = ($1, $2);
3299
3300                     my ($fn, $line_num);
3301                     if ($position =~ m{\A\d+\z})
3302                     {
3303                         $fn = $filename;
3304                         $line_num = $position;
3305                     }
3306                     elsif ($position =~ m{\A(.*):(\d+)\z})
3307                     {
3308                         ($fn, $line_num) = ($1, $2);
3309                     }
3310                     else
3311                     {
3312                         &warn("Wrong spec for enable/disable argument.\n");
3313                     }
3314
3315                     if (defined($fn)) {
3316                         if (_has_breakpoint_data_ref($fn, $line_num)) {
3317                             _set_breakpoint_enabled_status($fn, $line_num,
3318                                 ($cmd eq 'enable' ? 1 : '')
3319                             );
3320                         }
3321                         else {
3322                             &warn("No breakpoint set at ${fn}:${line_num}\n");
3323                         }
3324                     }
3325
3326                     next CMD;
3327                 };
3328
3329 =head4 C<save> - send current history to a file
3330
3331 Takes the complete history, (not the shrunken version you see with C<H>),
3332 and saves it to the given filename, so it can be replayed using C<source>.
3333
3334 Note that all C<^(save|source)>'s are commented out with a view to minimise recursion.
3335
3336 =cut
3337
3338                 # save source - write commands to a file for later use
3339                 $cmd =~ /^save\s*(.*)$/ && do {
3340                     my $file = $1 || '.perl5dbrc';    # default?
3341                     if ( open my $fh, "> $file" ) {
3342
3343                        # chomp to remove extraneous newlines from source'd files
3344                         chomp( my @truelist =
3345                               map { m/^\s*(save|source)/ ? "#$_" : $_ }
3346                               @truehist );
3347                         print $fh join( "\n", @truelist );
3348                         print "commands saved in $file\n";
3349                     }
3350                     else {
3351                         &warn("Can't save debugger commands in '$1': $!\n");
3352                     }
3353                     next CMD;
3354                 };
3355
3356 =head4 C<R> - restart
3357
3358 Restart the debugger session. 
3359
3360 =head4 C<rerun> - rerun the current session
3361
3362 Return to any given position in the B<true>-history list
3363
3364 =cut
3365
3366                 # R - restart execution.
3367                 # rerun - controlled restart execution.
3368                 $cmd =~ /^(R|rerun\s*(.*))$/ && do {
3369                     my @args = ($1 eq 'R' ? restart() : rerun($2));
3370
3371                     # Close all non-system fds for a clean restart.  A more
3372                     # correct method would be to close all fds that were not
3373                     # open when the process started, but this seems to be
3374                     # hard.  See "debugger 'R'estart and open database
3375                     # connections" on p5p.
3376
3377                     my $max_fd = 1024; # default if POSIX can't be loaded
3378                     if (eval { require POSIX }) {
3379                         eval { $max_fd = POSIX::sysconf(POSIX::_SC_OPEN_MAX()) };
3380                     }
3381
3382                     if (defined $max_fd) {
3383                         foreach ($^F+1 .. $max_fd-1) {
3384                             next unless open FD_TO_CLOSE, "<&=$_";
3385                             close(FD_TO_CLOSE);
3386                         }
3387                     }
3388
3389                     # And run Perl again.  We use exec() to keep the
3390                     # PID stable (and that way $ini_pids is still valid).
3391                     exec(@args) || print $OUT "exec failed: $!\n";
3392
3393                     last CMD;
3394                 };
3395
3396 =head4 C<|, ||> - pipe output through the pager.
3397
3398 For C<|>, we save C<OUT> (the debugger's output filehandle) and C<STDOUT>
3399 (the program's standard output). For C<||>, we only save C<OUT>. We open a
3400 pipe to the pager (restoring the output filehandles if this fails). If this
3401 is the C<|> command, we also set up a C<SIGPIPE> handler which will simply 
3402 set C<$signal>, sending us back into the debugger.
3403
3404 We then trim off the pipe symbols and C<redo> the command loop at the
3405 C<PIPE> label, causing us to evaluate the command in C<$cmd> without
3406 reading another.
3407
3408 =cut
3409
3410                 # || - run command in the pager, with output to DB::OUT.
3411                 $cmd =~ /^\|\|?\s*[^|]/ && do {
3412                     if ( $pager =~ /^\|/ ) {
3413
3414                         # Default pager is into a pipe. Redirect I/O.
3415                         open( SAVEOUT, ">&STDOUT" )
3416                           || &warn("Can't save STDOUT");
3417                         open( STDOUT, ">&OUT" )
3418                           || &warn("Can't redirect STDOUT");
3419                     } ## end if ($pager =~ /^\|/)
3420                     else {
3421
3422                         # Not into a pipe. STDOUT is safe.
3423                         open( SAVEOUT, ">&OUT" ) || &warn("Can't save DB::OUT");
3424                     }
3425
3426                     # Fix up environment to record we have less if so.
3427                     fix_less();
3428
3429                     unless ( $piped = open( OUT, $pager ) ) {
3430
3431                         # Couldn't open pipe to pager.
3432                         &warn("Can't pipe output to '$pager'");
3433                         if ( $pager =~ /^\|/ ) {
3434
3435                             # Redirect I/O back again.
3436                             open( OUT, ">&STDOUT" )    # XXX: lost message
3437                               || &warn("Can't restore DB::OUT");
3438                             open( STDOUT, ">&SAVEOUT" )
3439                               || &warn("Can't restore STDOUT");
3440                             close(SAVEOUT);
3441                         } ## end if ($pager =~ /^\|/)
3442                         else {
3443
3444                             # Redirect I/O. STDOUT already safe.
3445                             open( OUT, ">&STDOUT" )    # XXX: lost message
3446                               || &warn("Can't restore DB::OUT");
3447                         }
3448                         next CMD;
3449                     } ## end unless ($piped = open(OUT,...
3450
3451                     # Set up broken-pipe handler if necessary.
3452                     $SIG{PIPE} = \&DB::catch
3453                       if $pager =~ /^\|/
3454                       && ( "" eq $SIG{PIPE} || "DEFAULT" eq $SIG{PIPE} );
3455
3456                     # Save current filehandle, unbuffer out, and put it back.
3457                     $selected = select(OUT);
3458                     $|        = 1;
3459
3460                     # Don't put it back if pager was a pipe.
3461                     select($selected), $selected = "" unless $cmd =~ /^\|\|/;
3462
3463                     # Trim off the pipe symbols and run the command now.
3464                     $cmd =~ s/^\|+\s*//;
3465                     redo PIPE;
3466                 };
3467
3468 =head3 END OF COMMAND PARSING
3469
3470 Anything left in C<$cmd> at this point is a Perl expression that we want to 
3471 evaluate. We'll always evaluate in the user's context, and fully qualify 
3472 any variables we might want to address in the C<DB> package.
3473
3474 =cut
3475
3476                 # t - turn trace on.
3477                 $cmd =~ s/^t\s+(\d+)?/\$DB::trace |= 1;\n/ && do {
3478                     $trace_to_depth = $1 ? $stack_depth||0 + $1 : 1E9;
3479                 };
3480
3481                 # s - single-step. Remember the last command was 's'.
3482                 $cmd =~ s/^s\s/\$DB::single = 1;\n/ && do { $laststep = 's' };
3483
3484                 # n - single-step, but not into subs. Remember last command
3485                 # was 'n'.
3486                 $cmd =~ s/^n\s/\$DB::single = 2;\n/ && do { $laststep = 'n' };
3487
3488             }    # PIPE:
3489
3490             # Make sure the flag that says "the debugger's running" is
3491             # still on, to make sure we get control again.
3492             $evalarg = "\$^D = \$^D | \$DB::db_stop;\n$cmd";
3493
3494             # Run *our* eval that executes in the caller's context.
3495             &eval;
3496
3497             # Turn off the one-time-dump stuff now.
3498             if ($onetimeDump) {
3499                 $onetimeDump      = undef;
3500                 $onetimedumpDepth = undef;
3501             }
3502             elsif ( $term_pid == $$ ) {
3503                 eval {          # May run under miniperl, when not available...
3504                     STDOUT->flush();
3505                     STDERR->flush();
3506                 };
3507
3508                 # XXX If this is the master pid, print a newline.
3509                 print $OUT "\n";
3510             }
3511         } ## end while (($term || &setterm...
3512
3513 =head3 POST-COMMAND PROCESSING
3514
3515 After each command, we check to see if the command output was piped anywhere.
3516 If so, we go through the necessary code to unhook the pipe and go back to
3517 our standard filehandles for input and output.
3518
3519 =cut
3520
3521         continue {    # CMD:
3522
3523             # At the end of every command:
3524             if ($piped) {
3525
3526                 # Unhook the pipe mechanism now.
3527                 if ( $pager =~ /^\|/ ) {
3528
3529                     # No error from the child.
3530                     $? = 0;
3531
3532                     # we cannot warn here: the handle is missing --tchrist
3533                     close(OUT) || print SAVEOUT "\nCan't close DB::OUT\n";
3534
3535                     # most of the $? crud was coping with broken cshisms
3536                     # $? is explicitly set to 0, so this never runs.
3537                     if ($?) {
3538                         print SAVEOUT "Pager '$pager' failed: ";
3539                         if ( $? == -1 ) {
3540                             print SAVEOUT "shell returned -1\n";
3541                         }
3542                         elsif ( $? >> 8 ) {
3543                             print SAVEOUT ( $? & 127 )
3544                               ? " (SIG#" . ( $? & 127 ) . ")"
3545                               : "", ( $? & 128 ) ? " -- core dumped" : "", "\n";
3546                         }
3547                         else {
3548                             print SAVEOUT "status ", ( $? >> 8 ), "\n";
3549                         }
3550                     } ## end if ($?)
3551
3552                     # Reopen filehandle for our output (if we can) and
3553                     # restore STDOUT (if we can).
3554                     open( OUT, ">&STDOUT" ) || &warn("Can't restore DB::OUT");
3555                     open( STDOUT, ">&SAVEOUT" )
3556                       || &warn("Can't restore STDOUT");
3557
3558                     # Turn off pipe exception handler if necessary.
3559                     $SIG{PIPE} = "DEFAULT" if $SIG{PIPE} eq \&DB::catch;
3560
3561                     # Will stop ignoring SIGPIPE if done like nohup(1)
3562                     # does SIGINT but Perl doesn't give us a choice.
3563                 } ## end if ($pager =~ /^\|/)
3564                 else {
3565
3566                     # Non-piped "pager". Just restore STDOUT.
3567                     open( OUT, ">&SAVEOUT" ) || &warn("Can't restore DB::OUT");
3568                 }
3569
3570                 # Close filehandle pager was using, restore the normal one
3571                 # if necessary,
3572                 close(SAVEOUT);
3573                 select($selected), $selected = "" unless $selected eq "";
3574
3575                 # No pipes now.
3576                 $piped = "";
3577             } ## end if ($piped)
3578         }    # CMD:
3579
3580 =head3 COMMAND LOOP TERMINATION
3581
3582 When commands have finished executing, we come here. If the user closed the
3583 input filehandle, we turn on C<$fall_off_end> to emulate a C<q> command. We
3584 evaluate any post-prompt items. We restore C<$@>, C<$!>, C<$^E>, C<$,>, C<$/>,
3585 C<$\>, and C<$^W>, and return a null list as expected by the Perl interpreter.
3586 The interpreter will then execute the next line and then return control to us
3587 again.
3588
3589 =cut
3590
3591         # No more commands? Quit.
3592         $fall_off_end = 1 unless defined $cmd;    # Emulate 'q' on EOF
3593
3594         # Evaluate post-prompt commands.
3595         foreach $evalarg (@$post) {
3596             &eval;
3597         }
3598     }    # if ($single || $signal)
3599
3600     # Put the user's globals back where you found them.
3601     ( $@, $!, $^E, $,, $/, $\, $^W ) = @saved;
3602     ();
3603 } ## end sub DB
3604
3605 # The following code may be executed now:
3606 # BEGIN {warn 4}
3607
3608 =head2 sub
3609
3610 C<sub> is called whenever a subroutine call happens in the program being 
3611 debugged. The variable C<$DB::sub> contains the name of the subroutine
3612 being called.
3613
3614 The core function of this subroutine is to actually call the sub in the proper
3615 context, capturing its output. This of course causes C<DB::DB> to get called
3616 again, repeating until the subroutine ends and returns control to C<DB::sub>
3617 again. Once control returns, C<DB::sub> figures out whether or not to dump the
3618 return value, and returns its captured copy of the return value as its own
3619 return value. The value then feeds back into the program being debugged as if
3620 C<DB::sub> hadn't been there at all.
3621
3622 C<sub> does all the work of printing the subroutine entry and exit messages
3623 enabled by setting C<$frame>. It notes what sub the autoloader got called for,
3624 and also prints the return value if needed (for the C<r> command and if 
3625 the 16 bit is set in C<$frame>).
3626
3627 It also tracks the subroutine call depth by saving the current setting of
3628 C<$single> in the C<@stack> package global; if this exceeds the value in
3629 C<$deep>, C<sub> automatically turns on printing of the current depth by
3630 setting the C<4> bit in C<$single>. In any case, it keeps the current setting
3631 of stop/don't stop on entry to subs set as it currently is set.
3632
3633 =head3 C<caller()> support
3634
3635 If C<caller()> is called from the package C<DB>, it provides some
3636 additional data, in the following order:
3637
3638 =over 4
3639
3640 =item * C<$package>
3641
3642 The package name the sub was in
3643
3644 =item * C<$filename>
3645
3646 The filename it was defined in
3647
3648 =item * C<$line>
3649
3650 The line number it was defined on
3651
3652 =item * C<$subroutine>
3653
3654 The subroutine name; C<(eval)> if an C<eval>().
3655
3656 =item * C<$hasargs>
3657
3658 1 if it has arguments, 0 if not
3659
3660 =item * C<$wantarray>
3661
3662 1 if array context, 0 if scalar context
3663
3664 =item * C<$evaltext>
3665
3666 The C<eval>() text, if any (undefined for C<eval BLOCK>)
3667
3668 =item * C<$is_require>
3669
3670 frame was created by a C<use> or C<require> statement
3671
3672 =item * C<$hints>
3673
3674 pragma information; subject to change between versions
3675
3676 =item * C<$bitmask>
3677
3678 pragma information; subject to change between versions
3679
3680 =item * C<@DB::args>
3681
3682 arguments with which the subroutine was invoked
3683
3684 =back
3685
3686 =cut
3687
3688 sub sub {
3689         # Do not use a regex in this subroutine -> results in corrupted memory
3690         # See: [perl #66110]
3691
3692         # lock ourselves under threads
3693         lock($DBGR);
3694
3695     # Whether or not the autoloader was running, a scalar to put the
3696     # sub's return value in (if needed), and an array to put the sub's
3697     # return value in (if needed).
3698     my ( $al, $ret, @ret ) = "";
3699         if ($sub eq 'threads::new' && $ENV{PERL5DB_THREADED}) {
3700                 print "creating new thread\n"; 
3701         }
3702
3703     # If the last ten characters are '::AUTOLOAD', note we've traced
3704     # into AUTOLOAD for $sub.
3705     if ( length($sub) > 10 && substr( $sub, -10, 10 ) eq '::AUTOLOAD' ) {
3706         $al = " for $$sub" if defined $$sub;
3707     }
3708
3709     # We stack the stack pointer and then increment it to protect us
3710     # from a situation that might unwind a whole bunch of call frames
3711     # at once. Localizing the stack pointer means that it will automatically
3712     # unwind the same amount when multiple stack frames are unwound.
3713     local $stack_depth = $stack_depth + 1;    # Protect from non-local exits
3714
3715     # Expand @stack.
3716     $#stack = $stack_depth;
3717
3718     # Save current single-step setting.
3719     $stack[-1] = $single;
3720
3721     # Turn off all flags except single-stepping.
3722     $single &= 1;
3723
3724     # If we've gotten really deeply recursed, turn on the flag that will
3725     # make us stop with the 'deep recursion' message.
3726     $single |= 4 if $stack_depth == $deep;
3727
3728     # If frame messages are on ...
3729     (
3730         $frame & 4    # Extended frame entry message
3731         ? (
3732             print_lineinfo( ' ' x ( $stack_depth - 1 ), "in  " ),
3733
3734             # Why -1? But it works! :-(
3735             # Because print_trace will call add 1 to it and then call
3736             # dump_trace; this results in our skipping -1+1 = 0 stack frames
3737             # in dump_trace.
3738             print_trace( $LINEINFO, -1, 1, 1, "$sub$al" )
3739           )
3740         : print_lineinfo( ' ' x ( $stack_depth - 1 ), "entering $sub$al\n" )
3741
3742           # standard frame entry message
3743       )
3744       if $frame;
3745
3746     # Determine the sub's return type, and capture appropriately.
3747     if (wantarray) {
3748
3749         # Called in array context. call sub and capture output.
3750         # DB::DB will recursively get control again if appropriate; we'll come
3751         # back here when the sub is finished.
3752         @ret = &$sub;
3753
3754         # Pop the single-step value back off the stack.
3755         $single |= $stack[ $stack_depth-- ];
3756
3757         # Check for exit trace messages...
3758         (
3759             $frame & 4    # Extended exit message
3760             ? (
3761                 print_lineinfo( ' ' x $stack_depth, "out " ),
3762                 print_trace( $LINEINFO, -1, 1, 1, "$sub$al" )
3763               )
3764             : print_lineinfo( ' ' x $stack_depth, "exited $sub$al\n" )
3765
3766               # Standard exit message
3767           )
3768           if $frame & 2;
3769
3770         # Print the return info if we need to.
3771         if ( $doret eq $stack_depth or $frame & 16 ) {
3772
3773             # Turn off output record separator.
3774             local $\ = '';
3775             my $fh = ( $doret eq $stack_depth ? $OUT : $LINEINFO );
3776
3777             # Indent if we're printing because of $frame tracing.
3778             print $fh ' ' x $stack_depth if $frame & 16;
3779
3780             # Print the return value.
3781             print $fh "list context return from $sub:\n";
3782             dumpit( $fh, \@ret );
3783
3784             # And don't print it again.
3785             $doret = -2;
3786         } ## end if ($doret eq $stack_depth...
3787             # And we have to return the return value now.
3788         @ret;
3789     } ## end if (wantarray)
3790
3791     # Scalar context.
3792     else {
3793         if ( defined wantarray ) {
3794
3795             # Save the value if it's wanted at all.
3796             $ret = &$sub;
3797         }
3798         else {
3799
3800             # Void return, explicitly.
3801             &$sub;
3802             undef $ret;
3803         }
3804
3805         # Pop the single-step value off the stack.
3806         $single |= $stack[ $stack_depth-- ];
3807
3808         # If we're doing exit messages...
3809         (
3810             $frame & 4    # Extended messages
3811             ? (
3812                 print_lineinfo( ' ' x $stack_depth, "out " ),
3813                 print_trace( $LINEINFO, -1, 1, 1, "$sub$al" )
3814               )
3815             : print_lineinfo( ' ' x $stack_depth, "exited $sub$al\n" )
3816
3817               # Standard messages
3818           )
3819           if $frame & 2;
3820
3821         # If we are supposed to show the return value... same as before.
3822         if ( $doret eq $stack_depth or $frame & 16 and defined wantarray ) {
3823             local $\ = '';
3824             my $fh = ( $doret eq $stack_depth ? $OUT : $LINEINFO );
3825             print $fh ( ' ' x $stack_depth ) if $frame & 16;
3826             print $fh (
3827                 defined wantarray
3828                 ? "scalar context return from $sub: "
3829                 : "void context return from $sub\n"
3830             );
3831             dumpit( $fh, $ret ) if defined wantarray;
3832             $doret = -2;
3833         } ## end if ($doret eq $stack_depth...
3834
3835         # Return the appropriate scalar value.
3836         $ret;
3837     } ## end else [ if (wantarray)
3838 } ## end sub sub
3839
3840 sub lsub : lvalue {
3841
3842         # lock ourselves under threads
3843         lock($DBGR);
3844
3845     # Whether or not the autoloader was running, a scalar to put the
3846     # sub's return value in (if needed), and an array to put the sub's
3847     # return value in (if needed).
3848     my ( $al, $ret, @ret ) = "";
3849         if ($sub =~ /^threads::new$/ && $ENV{PERL5DB_THREADED}) {
3850                 print "creating new thread\n";
3851         }
3852
3853     # If the last ten characters are C'::AUTOLOAD', note we've traced
3854     # into AUTOLOAD for $sub.
3855     if ( length($sub) > 10 && substr( $sub, -10, 10 ) eq '::AUTOLOAD' ) {
3856         $al = " for $$sub";
3857     }
3858
3859     # We stack the stack pointer and then increment it to protect us
3860     # from a situation that might unwind a whole bunch of call frames
3861     # at once. Localizing the stack pointer means that it will automatically
3862     # unwind the same amount when multiple stack frames are unwound.
3863     local $stack_depth = $stack_depth + 1;    # Protect from non-local exits
3864
3865     # Expand @stack.
3866     $#stack = $stack_depth;
3867
3868     # Save current single-step setting.
3869     $stack[-1] = $single;
3870
3871     # Turn off all flags except single-stepping.
3872     $single &= 1;
3873
3874     # If we've gotten really deeply recursed, turn on the flag that will
3875     # make us stop with the 'deep recursion' message.
3876     $single |= 4 if $stack_depth == $deep;
3877
3878     # If frame messages are on ...
3879     (
3880         $frame & 4    # Extended frame entry message
3881         ? (
3882             print_lineinfo( ' ' x ( $stack_depth - 1 ), "in  " ),
3883
3884             # Why -1? But it works! :-(
3885             # Because print_trace will call add 1 to it and then call
3886             # dump_trace; this results in our skipping -1+1 = 0 stack frames
3887             # in dump_trace.
3888             print_trace( $LINEINFO, -1, 1, 1, "$sub$al" )
3889           )
3890         : print_lineinfo( ' ' x ( $stack_depth - 1 ), "entering $sub$al\n" )
3891
3892           # standard frame entry message
3893       )
3894       if $frame;
3895
3896     # Pop the single-step value back off the stack.
3897     $single |= $stack[ $stack_depth-- ];
3898
3899     # call the original lvalue sub.
3900     &$sub;
3901 }
3902
3903 # Abstracting common code from multiple places elsewhere:
3904 sub depth_print_lineinfo {
3905     print_lineinfo( @_ ) if $stack_depth < $trace_to_depth;
3906 }
3907
3908 =head1 EXTENDED COMMAND HANDLING AND THE COMMAND API
3909
3910 In Perl 5.8.0, there was a major realignment of the commands and what they did,
3911 Most of the changes were to systematize the command structure and to eliminate
3912 commands that threw away user input without checking.
3913
3914 The following sections describe the code added to make it easy to support 
3915 multiple command sets with conflicting command names. This section is a start 
3916 at unifying all command processing to make it simpler to develop commands.
3917
3918 Note that all the cmd_[a-zA-Z] subroutines require the command name, a line 
3919 number, and C<$dbline> (the current line) as arguments.
3920
3921 Support functions in this section which have multiple modes of failure C<die> 
3922 on error; the rest simply return a false value.
3923
3924 The user-interface functions (all of the C<cmd_*> functions) just output
3925 error messages.
3926
3927 =head2 C<%set>
3928
3929 The C<%set> hash defines the mapping from command letter to subroutine
3930 name suffix. 
3931
3932 C<%set> is a two-level hash, indexed by set name and then by command name.
3933 Note that trying to set the CommandSet to C<foobar> simply results in the
3934 5.8.0 command set being used, since there's no top-level entry for C<foobar>.
3935
3936 =cut 
3937
3938 ### The API section
3939
3940 my %set = (    #
3941     'pre580' => {
3942         'a' => 'pre580_a',
3943         'A' => 'pre580_null',
3944         'b' => 'pre580_b',
3945         'B' => 'pre580_null',
3946         'd' => 'pre580_null',
3947         'D' => 'pre580_D',
3948         'h' => 'pre580_h',
3949         'M' => 'pre580_null',
3950         'O' => 'o',
3951         'o' => 'pre580_null',
3952         'v' => 'M',
3953         'w' => 'v',
3954         'W' => 'pre580_W',
3955     },
3956     'pre590' => {
3957         '<'  => 'pre590_prepost',
3958         '<<' => 'pre590_prepost',
3959         '>'  => 'pre590_prepost',
3960         '>>' => 'pre590_prepost',
3961         '{'  => 'pre590_prepost',
3962         '{{' => 'pre590_prepost',
3963     },
3964 );
3965
3966 my %breakpoints_data;
3967
3968 sub _has_breakpoint_data_ref {
3969     my ($filename, $line) = @_;
3970
3971     return (
3972         exists( $breakpoints_data{$filename} )
3973             and
3974         exists( $breakpoints_data{$filename}{$line} )
3975     );
3976 }
3977
3978 sub _get_breakpoint_data_ref {
3979     my ($filename, $line) = @_;
3980
3981     return ($breakpoints_data{$filename}{$line} ||= +{});
3982 }
3983
3984 sub _delete_breakpoint_data_ref {
3985     my ($filename, $line) = @_;
3986
3987     delete($breakpoints_data{$filename}{$line});
3988     if (! scalar(keys( %{$breakpoints_data{$filename}} )) ) {
3989         delete($breakpoints_data{$filename});
3990     }
3991
3992     return;
3993 }
3994
3995 sub _set_breakpoint_enabled_status {
3996     my ($filename, $line, $status) = @_;
3997
3998     _get_breakpoint_data_ref($filename, $line)->{'enabled'} =
3999         ($status ? 1 : '')
4000         ;
4001
4002     return;
4003 }
4004
4005 sub _is_breakpoint_enabled {
4006     my ($filename, $line) = @_;
4007
4008     return _get_breakpoint_data_ref($filename, $line)->{'enabled'};
4009 }
4010
4011 =head2 C<cmd_wrapper()> (API)
4012
4013 C<cmd_wrapper()> allows the debugger to switch command sets 
4014 depending on the value of the C<CommandSet> option. 
4015
4016 It tries to look up the command in the C<%set> package-level I<lexical>
4017 (which means external entities can't fiddle with it) and create the name of 
4018 the sub to call based on the value found in the hash (if it's there). I<All> 
4019 of the commands to be handled in a set have to be added to C<%set>; if they 
4020 aren't found, the 5.8.0 equivalent is called (if there is one).
4021
4022 This code uses symbolic references. 
4023
4024 =cut
4025
4026 sub cmd_wrapper {
4027     my $cmd      = shift;
4028     my $line     = shift;
4029     my $dblineno = shift;
4030
4031     # Assemble the command subroutine's name by looking up the
4032     # command set and command name in %set. If we can't find it,
4033     # default to the older version of the command.
4034     my $call = 'cmd_'
4035       . ( $set{$CommandSet}{$cmd}
4036           || ( $cmd =~ /^[<>{]+/o ? 'prepost' : $cmd ) );
4037
4038     # Call the command subroutine, call it by name.
4039     return &$call( $cmd, $line, $dblineno );
4040 } ## end sub cmd_wrapper
4041
4042 =head3 C<cmd_a> (command)
4043
4044 The C<a> command handles pre-execution actions. These are associated with a
4045 particular line, so they're stored in C<%dbline>. We default to the current 
4046 line if none is specified. 
4047
4048 =cut
4049
4050 sub cmd_a {
4051     my $cmd    = shift;
4052     my $line   = shift || '';    # [.|line] expr
4053     my $dbline = shift;
4054
4055     # If it's dot (here), or not all digits,  use the current line.
4056     $line =~ s/^(\.|(?:[^\d]))/$dbline/;
4057
4058     # Should be a line number followed by an expression.
4059     if ( $line =~ /^\s*(\d*)\s*(\S.+)/ ) {
4060         my ( $lineno, $expr ) = ( $1, $2 );
4061
4062         # If we have an expression ...
4063         if ( length $expr ) {
4064
4065             # ... but the line isn't breakable, complain.
4066             if ( $dbline[$lineno] == 0 ) {
4067                 print $OUT
4068                   "Line $lineno($dbline[$lineno]) does not have an action?\n";
4069             }
4070             else {
4071
4072                 # It's executable. Record that the line has an action.
4073                 $had_breakpoints{$filename} |= 2;
4074
4075                 # Remove any action, temp breakpoint, etc.
4076                 $dbline{$lineno} =~ s/\0[^\0]*//;
4077
4078                 # Add the action to the line.
4079                 $dbline{$lineno} .= "\0" . action($expr);
4080             }
4081         } ## end if (length $expr)
4082     } ## end if ($line =~ /^\s*(\d*)\s*(\S.+)/)
4083     else {
4084
4085         # Syntax wrong.
4086         print $OUT
4087           "Adding an action requires an optional lineno and an expression\n"
4088           ;    # hint
4089     }
4090 } ## end sub cmd_a
4091
4092 =head3 C<cmd_A> (command)
4093
4094 Delete actions. Similar to above, except the delete code is in a separate
4095 subroutine, C<delete_action>.
4096
4097 =cut
4098
4099 sub cmd_A {
4100     my $cmd    = shift;
4101     my $line   = shift || '';
4102     my $dbline = shift;
4103
4104     # Dot is this line.
4105     $line =~ s/^\./$dbline/;
4106
4107     # Call delete_action with a null param to delete them all.
4108     # The '1' forces the eval to be true. It'll be false only
4109     # if delete_action blows up for some reason, in which case
4110     # we print $@ and get out.
4111     if ( $line eq '*' ) {
4112         eval { &delete_action(); 1 } or print $OUT $@ and return;
4113     }
4114
4115     # There's a real line  number. Pass it to delete_action.
4116     # Error trapping is as above.
4117     elsif ( $line =~ /^(\S.*)/ ) {
4118         eval { &delete_action($1); 1 } or print $OUT $@ and return;
4119     }
4120
4121     # Swing and a miss. Bad syntax.
4122     else {
4123         print $OUT
4124           "Deleting an action requires a line number, or '*' for all\n" ; # hint
4125     }
4126 } ## end sub cmd_A
4127
4128 =head3 C<delete_action> (API)
4129
4130 C<delete_action> accepts either a line number or C<undef>. If a line number
4131 is specified, we check for the line being executable (if it's not, it 
4132 couldn't have had an  action). If it is, we just take the action off (this
4133 will get any kind of an action, including breakpoints).
4134
4135 =cut
4136
4137 sub delete_action {
4138     my $i = shift;
4139     if ( defined($i) ) {
4140
4141         # Can there be one?
4142         die "Line $i has no action .\n" if $dbline[$i] == 0;
4143
4144         # Nuke whatever's there.
4145         $dbline{$i} =~ s/\0[^\0]*//;    # \^a
4146         delete $dbline{$i} if $dbline{$i} eq '';
4147     }
4148     else {
4149         print $OUT "Deleting all actions...\n";
4150         for my $file ( keys %had_breakpoints ) {
4151             local *dbline = $main::{ '_<' . $file };
4152             my $max = $#dbline;
4153             my $was;
4154             for ( $i = 1 ; $i <= $max ; $i++ ) {
4155                 if ( defined $dbline{$i} ) {
4156                     $dbline{$i} =~ s/\0[^\0]*//;
4157                     delete $dbline{$i} if $dbline{$i} eq '';
4158                 }
4159                 unless ( $had_breakpoints{$file} &= ~2 ) {
4160                     delete $had_breakpoints{$file};
4161                 }
4162             } ## end for ($i = 1 ; $i <= $max...
4163         } ## end for my $file (keys %had_breakpoints)
4164     } ## end else [ if (defined($i))
4165 } ## end sub delete_action
4166
4167 =head3 C<cmd_b> (command)
4168
4169 Set breakpoints. Since breakpoints can be set in so many places, in so many
4170 ways, conditionally or not, the breakpoint code is kind of complex. Mostly,
4171 we try to parse the command type, and then shuttle it off to an appropriate
4172 subroutine to actually do the work of setting the breakpoint in the right
4173 place.
4174
4175 =cut
4176
4177 sub cmd_b {
4178     my $cmd    = shift;
4179     my $line   = shift;    # [.|line] [cond]
4180     my $dbline = shift;
4181
4182     # Make . the current line number if it's there..
4183     $line =~ s/^\.\b/$dbline/;
4184
4185     # No line number, no condition. Simple break on current line.
4186     if ( $line =~ /^\s*$/ ) {
4187         &cmd_b_line( $dbline, 1 );
4188     }
4189
4190     # Break on load for a file.
4191     elsif ( $line =~ /^load\b\s*(.*)/ ) {
4192         my $file = $1;
4193         $file =~ s/\s+$//;
4194         &cmd_b_load($file);
4195     }
4196
4197     # b compile|postpone <some sub> [<condition>]
4198     # The interpreter actually traps this one for us; we just put the
4199     # necessary condition in the %postponed hash.
4200     elsif ( $line =~ /^(postpone|compile)\b\s*([':A-Za-z_][':\w]*)\s*(.*)/ ) {
4201
4202         # Capture the condition if there is one. Make it true if none.
4203         my $cond = length $3 ? $3 : '1';
4204
4205         # Save the sub name and set $break to 1 if $1 was 'postpone', 0
4206         # if it was 'compile'.
4207         my ( $subname, $break ) = ( $2, $1 eq 'postpone' );
4208
4209         # De-Perl4-ify the name - ' separators to ::.
4210         $subname =~ s/\'/::/g;
4211
4212         # Qualify it into the current package unless it's already qualified.
4213         $subname = "${'package'}::" . $subname unless $subname =~ /::/;
4214
4215         # Add main if it starts with ::.
4216         $subname = "main" . $subname if substr( $subname, 0, 2 ) eq "::";
4217
4218         # Save the break type for this sub.
4219         $postponed{$subname} = $break ? "break +0 if $cond" : "compile";
4220     } ## end elsif ($line =~ ...
4221     # b <filename>:<line> [<condition>]
4222     elsif ($line =~ /\A(\S+[^:]):(\d+)\s*(.*)/ms) {
4223         my ($filename, $line_num, $cond) = ($1, $2, $3);
4224         cmd_b_filename_line(
4225             $filename,
4226             $line_num, 
4227             (length($cond) ? $cond : '1'),
4228         );
4229     }
4230     # b <sub name> [<condition>]
4231     elsif ( $line =~ /^([':A-Za-z_][':\w]*(?:\[.*\])?)\s*(.*)/ ) {
4232
4233         #
4234         $subname = $1;
4235         $cond = length $2 ? $2 : '1';
4236         &cmd_b_sub( $subname, $cond );
4237     }
4238
4239     # b <line> [<condition>].
4240     elsif ( $line =~ /^(\d*)\s*(.*)/ ) {
4241
4242         # Capture the line. If none, it's the current line.
4243         $line = $1 || $dbline;
4244
4245         # If there's no condition, make it '1'.
4246         $cond = length $2 ? $2 : '1';
4247
4248         # Break on line.
4249         &cmd_b_line( $line, $cond );
4250     }
4251
4252     # Line didn't make sense.
4253     else {
4254         print "confused by line($line)?\n";
4255     }
4256 } ## end sub cmd_b
4257
4258 =head3 C<break_on_load> (API)
4259
4260 We want to break when this file is loaded. Mark this file in the
4261 C<%break_on_load> hash, and note that it has a breakpoint in 
4262 C<%had_breakpoints>.
4263
4264 =cut
4265
4266 sub break_on_load {
4267     my $file = shift;
4268     $break_on_load{$file} = 1;
4269     $had_breakpoints{$file} |= 1;
4270 }
4271
4272 =head3 C<report_break_on_load> (API)
4273
4274 Gives us an array of filenames that are set to break on load. Note that 
4275 only files with break-on-load are in here, so simply showing the keys
4276 suffices.
4277
4278 =cut
4279
4280 sub report_break_on_load {
4281     sort keys %break_on_load;
4282 }
4283
4284 =head3 C<cmd_b_load> (command)
4285
4286 We take the file passed in and try to find it in C<%INC> (which maps modules
4287 to files they came from). We mark those files for break-on-load via 
4288 C<break_on_load> and then report that it was done.
4289
4290 =cut
4291
4292 sub cmd_b_load {
4293     my $file = shift;
4294     my @files;
4295
4296     # This is a block because that way we can use a redo inside it
4297     # even without there being any looping structure at all outside it.
4298     {
4299
4300         # Save short name and full path if found.
4301         push @files, $file;
4302         push @files, $::INC{$file} if $::INC{$file};
4303
4304         # Tack on .pm and do it again unless there was a '.' in the name
4305         # already.
4306         $file .= '.pm', redo unless $file =~ /\./;
4307     }
4308
4309     # Do the real work here.
4310     break_on_load($_) for @files;
4311
4312     # All the files that have break-on-load breakpoints.
4313     @files = report_break_on_load;
4314
4315     # Normalize for the purposes of our printing this.
4316     local $\ = '';
4317     local $" = ' ';
4318     print $OUT "Will stop on load of '@files'.\n";
4319 } ## end sub cmd_b_load
4320
4321 =head3 C<$filename_error> (API package global)
4322
4323 Several of the functions we need to implement in the API need to work both
4324 on the current file and on other files. We don't want to duplicate code, so
4325 C<$filename_error> is used to contain the name of the file that's being 
4326 worked on (if it's not the current one).
4327
4328 We can now build functions in pairs: the basic function works on the current
4329 file, and uses C<$filename_error> as part of its error message. Since this is
4330 initialized to C<"">, no filename will appear when we are working on the
4331 current file.
4332
4333 The second function is a wrapper which does the following:
4334
4335 =over 4 
4336
4337 =item *
4338
4339 Localizes C<$filename_error> and sets it to the name of the file to be processed.
4340
4341 =item *
4342
4343 Localizes the C<*dbline> glob and reassigns it to point to the file we want to process. 
4344
4345 =item *
4346
4347 Calls the first function. 
4348
4349 The first function works on the I<current> file (i.e., the one we changed to),
4350 and prints C<$filename_error> in the error message (the name of the other file)
4351 if it needs to. When the functions return, C<*dbline> is restored to point
4352 to the actual current file (the one we're executing in) and
4353 C<$filename_error> is restored to C<"">. This restores everything to
4354 the way it was before the second function was called at all.
4355
4356 See the comments in C<breakable_line> and C<breakable_line_in_file> for more
4357 details.
4358
4359 =back
4360
4361 =cut
4362
4363 $filename_error = '';
4364
4365 =head3 breakable_line(from, to) (API)
4366
4367 The subroutine decides whether or not a line in the current file is breakable.
4368 It walks through C<@dbline> within the range of lines specified, looking for
4369 the first line that is breakable.
4370
4371 If C<$to> is greater than C<$from>, the search moves forwards, finding the 
4372 first line I<after> C<$to> that's breakable, if there is one.
4373
4374 If C<$from> is greater than C<$to>, the search goes I<backwards>, finding the
4375 first line I<before> C<$to> that's breakable, if there is one.
4376
4377 =cut
4378
4379 sub breakable_line {
4380
4381     my ( $from, $to ) = @_;
4382
4383     # $i is the start point. (Where are the FORTRAN programs of yesteryear?)
4384     my $i = $from;
4385
4386     # If there are at least 2 arguments, we're trying to search a range.
4387     if ( @_ >= 2 ) {
4388
4389         # $delta is positive for a forward search, negative for a backward one.
4390         my $delta = $from < $to ? +1 : -1;
4391
4392         # Keep us from running off the ends of the file.
4393         my $limit = $delta > 0 ? $#dbline : 1;
4394
4395         # Clever test. If you're a mathematician, it's obvious why this
4396         # test works. If not:
4397         # If $delta is positive (going forward), $limit will be $#dbline.
4398         #    If $to is less than $limit, ($limit - $to) will be positive, times
4399         #    $delta of 1 (positive), so the result is > 0 and we should use $to
4400         #    as the stopping point.
4401         #
4402         #    If $to is greater than $limit, ($limit - $to) is negative,
4403         #    times $delta of 1 (positive), so the result is < 0 and we should
4404         #    use $limit ($#dbline) as the stopping point.
4405         #
4406         # If $delta is negative (going backward), $limit will be 1.
4407         #    If $to is zero, ($limit - $to) will be 1, times $delta of -1
4408         #    (negative) so the result is > 0, and we use $to as the stopping
4409         #    point.
4410         #
4411         #    If $to is less than zero, ($limit - $to) will be positive,
4412         #    times $delta of -1 (negative), so the result is not > 0, and
4413         #    we use $limit (1) as the stopping point.
4414         #
4415         #    If $to is 1, ($limit - $to) will zero, times $delta of -1
4416         #    (negative), still giving zero; the result is not > 0, and
4417         #    we use $limit (1) as the stopping point.
4418         #
4419         #    if $to is >1, ($limit - $to) will be negative, times $delta of -1
4420         #    (negative), giving a positive (>0) value, so we'll set $limit to
4421         #    $to.
4422
4423         $limit = $to if ( $limit - $to ) * $delta > 0;
4424
4425         # The real search loop.
4426         # $i starts at $from (the point we want to start searching from).
4427         # We move through @dbline in the appropriate direction (determined
4428         # by $delta: either -1 (back) or +1 (ahead).
4429         # We stay in as long as we haven't hit an executable line
4430         # ($dbline[$i] == 0 means not executable) and we haven't reached
4431         # the limit yet (test similar to the above).
4432         $i += $delta while $dbline[$i] == 0 and ( $limit - $i ) * $delta > 0;
4433
4434     } ## end if (@_&n