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