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