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