This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
a17ebde971a9b11ecd659c6c8d819c1354206102
[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_04';
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) = @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_on_init__initialize_globals
1763 {
1764     # Check for whether we should be running continuously or not.
1765     # _After_ the perl program is compiled, $single is set to 1:
1766     if ( $single and not $second_time++ ) {
1767
1768         # Options say run non-stop. Run until we get an interrupt.
1769         if ($runnonstop) {    # Disable until signal
1770                 # If there's any call stack in place, turn off single
1771                 # stepping into subs throughout the stack.
1772             for my $i (0 .. $stack_depth) {
1773                 $stack[ $i ] &= ~1;
1774             }
1775
1776             # And we are now no longer in single-step mode.
1777             $single = 0;
1778
1779             # If we simply returned at this point, we wouldn't get
1780             # the trace info. Fall on through.
1781             # return;
1782         } ## end if ($runnonstop)
1783
1784         elsif ($ImmediateStop) {
1785
1786             # We are supposed to stop here; XXX probably a break.
1787             $ImmediateStop = 0;    # We've processed it; turn it off
1788             $signal        = 1;    # Simulate an interrupt to force
1789                                    # us into the command loop
1790         }
1791     } ## end if ($single and not $second_time...
1792
1793     # If we're in single-step mode, or an interrupt (real or fake)
1794     # has occurred, turn off non-stop mode.
1795     $runnonstop = 0 if $single or $signal;
1796
1797     return;
1798 }
1799
1800 sub _DB__determine_if_we_should_break
1801 {
1802     # if we have something here, see if we should break.
1803     # $stop is lexical and local to this block - $action on the other hand
1804     # is global.
1805     my $stop;
1806
1807     if ( $dbline{$line}
1808         && _is_breakpoint_enabled($filename, $line)
1809         && (( $stop, $action ) = split( /\0/, $dbline{$line} ) ) )
1810     {
1811
1812         # Stop if the stop criterion says to just stop.
1813         if ( $stop eq '1' ) {
1814             $signal |= 1;
1815         }
1816
1817         # It's a conditional stop; eval it in the user's context and
1818         # see if we should stop. If so, remove the one-time sigil.
1819         elsif ($stop) {
1820             $evalarg = "\$DB::signal |= 1 if do {$stop}";
1821             &eval;
1822             # If the breakpoint is temporary, then delete its enabled status.
1823             if ($dbline{$line} =~ s/;9($|\0)/$1/) {
1824                 _cancel_breakpoint_temp_enabled_status($filename, $line);
1825             }
1826         }
1827     } ## end if ($dbline{$line} && ...
1828 }
1829
1830 sub DB {
1831
1832     # lock the debugger and get the thread id for the prompt
1833     lock($DBGR);
1834     my $tid;
1835     my $position;
1836     my ($prefix, $after, $infix);
1837     my $pat;
1838
1839     if ($ENV{PERL5DB_THREADED}) {
1840         $tid = eval { "[".threads->tid."]" };
1841     }
1842
1843     _DB_on_init__initialize_globals();
1844
1845     # Preserve current values of $@, $!, $^E, $,, $/, $\, $^W.
1846     # The code being debugged may have altered them.
1847     &save;
1848
1849     # Since DB::DB gets called after every line, we can use caller() to
1850     # figure out where we last were executing. Sneaky, eh? This works because
1851     # caller is returning all the extra information when called from the
1852     # debugger.
1853     local ( $package, $filename, $line ) = caller;
1854     $filename_ini = $filename;
1855
1856     # set up the context for DB::eval, so it can properly execute
1857     # code on behalf of the user. We add the package in so that the
1858     # code is eval'ed in the proper package (not in the debugger!).
1859     local $usercontext = _calc_usercontext($package);
1860
1861     # Create an alias to the active file magical array to simplify
1862     # the code here.
1863     local (*dbline) = $main::{ '_<' . $filename };
1864
1865     # Last line in the program.
1866     $max = $#dbline;
1867
1868     _DB__determine_if_we_should_break();
1869
1870     # Preserve the current stop-or-not, and see if any of the W
1871     # (watch expressions) has changed.
1872     my $was_signal = $signal;
1873
1874     # If we have any watch expressions ...
1875     if ( $trace & 2 ) {
1876         for my $n (0 .. $#to_watch) {
1877             $evalarg = $to_watch[$n];
1878             local $onetimeDump;    # Tell DB::eval() to not output results
1879
1880             # Fix context DB::eval() wants to return an array, but
1881             # we need a scalar here.
1882             my ($val) = join( "', '", &eval );
1883             $val = ( ( defined $val ) ? "'$val'" : 'undef' );
1884
1885             # Did it change?
1886             if ( $val ne $old_watch[$n] ) {
1887
1888                 # Yep! Show the difference, and fake an interrupt.
1889                 $signal = 1;
1890                 print $OUT <<EOP;
1891 Watchpoint $n:\t$to_watch[$n] changed:
1892     old value:\t$old_watch[$n]
1893     new value:\t$val
1894 EOP
1895                 $old_watch[$n] = $val;
1896             } ## end if ($val ne $old_watch...
1897         } ## end for my $n (0 ..
1898     } ## end if ($trace & 2)
1899
1900 =head2 C<watchfunction()>
1901
1902 C<watchfunction()> is a function that can be defined by the user; it is a
1903 function which will be run on each entry to C<DB::DB>; it gets the
1904 current package, filename, and line as its parameters.
1905
1906 The watchfunction can do anything it likes; it is executing in the
1907 debugger's context, so it has access to all of the debugger's internal
1908 data structures and functions.
1909
1910 C<watchfunction()> can control the debugger's actions. Any of the following
1911 will cause the debugger to return control to the user's program after
1912 C<watchfunction()> executes:
1913
1914 =over 4
1915
1916 =item *
1917
1918 Returning a false value from the C<watchfunction()> itself.
1919
1920 =item *
1921
1922 Altering C<$single> to a false value.
1923
1924 =item *
1925
1926 Altering C<$signal> to a false value.
1927
1928 =item *
1929
1930 Turning off the C<4> bit in C<$trace> (this also disables the
1931 check for C<watchfunction()>. This can be done with
1932
1933     $trace &= ~4;
1934
1935 =back
1936
1937 =cut
1938
1939     # If there's a user-defined DB::watchfunction, call it with the
1940     # current package, filename, and line. The function executes in
1941     # the DB:: package.
1942     if ( $trace & 4 ) {    # User-installed watch
1943         return
1944           if watchfunction( $package, $filename, $line )
1945           and not $single
1946           and not $was_signal
1947           and not( $trace & ~4 );
1948     } ## end if ($trace & 4)
1949
1950     # Pick up any alteration to $signal in the watchfunction, and
1951     # turn off the signal now.
1952     $was_signal = $signal;
1953     $signal     = 0;
1954
1955 =head2 GETTING READY TO EXECUTE COMMANDS
1956
1957 The debugger decides to take control if single-step mode is on, the
1958 C<t> command was entered, or the user generated a signal. If the program
1959 has fallen off the end, we set things up so that entering further commands
1960 won't cause trouble, and we say that the program is over.
1961
1962 =cut
1963
1964     # Make sure that we always print if asked for explicitly regardless
1965     # of $trace_to_depth .
1966     my $explicit_stop = ($single || $was_signal);
1967
1968     # Check to see if we should grab control ($single true,
1969     # trace set appropriately, or we got a signal).
1970     if ( $explicit_stop || ( $trace & 1 ) ) {
1971
1972         # Yes, grab control.
1973         if ($slave_editor) {
1974
1975             # Tell the editor to update its position.
1976             $position = "\032\032$filename:$line:0\n";
1977             print_lineinfo($position);
1978         }
1979
1980 =pod
1981
1982 Special check: if we're in package C<DB::fake>, we've gone through the
1983 C<END> block at least once. We set up everything so that we can continue
1984 to enter commands and have a valid context to be in.
1985
1986 =cut
1987
1988         elsif ( $package eq 'DB::fake' ) {
1989
1990             # Fallen off the end already.
1991             $term || &setterm;
1992             print_help(<<EOP);
1993 Debugged program terminated.  Use B<q> to quit or B<R> to restart,
1994   use B<o> I<inhibit_exit> to avoid stopping after program termination,
1995   B<h q>, B<h R> or B<h o> to get additional info.
1996 EOP
1997
1998             # Set the DB::eval context appropriately.
1999             $package     = 'main';
2000             $usercontext = _calc_usercontext($package);
2001         } ## end elsif ($package eq 'DB::fake')
2002
2003 =pod
2004
2005 If the program hasn't finished executing, we scan forward to the
2006 next executable line, print that out, build the prompt from the file and line
2007 number information, and print that.
2008
2009 =cut
2010
2011         else {
2012
2013
2014             # Still somewhere in the midst of execution. Set up the
2015             #  debugger prompt.
2016             $sub =~ s/\'/::/;    # Swap Perl 4 package separators (') to
2017                                  # Perl 5 ones (sorry, we don't print Klingon
2018                                  #module names)
2019
2020             $prefix = $sub =~ /::/ ? "" : ($package . '::');
2021             $prefix .= "$sub($filename:";
2022             $after = ( $dbline[$line] =~ /\n$/ ? '' : "\n" );
2023
2024             # Break up the prompt if it's really long.
2025             if ( length($prefix) > 30 ) {
2026                 $position = "$prefix$line):\n$line:\t$dbline[$line]$after";
2027                 $prefix   = "";
2028                 $infix    = ":\t";
2029             }
2030             else {
2031                 $infix    = "):\t";
2032                 $position = "$prefix$line$infix$dbline[$line]$after";
2033             }
2034
2035             # Print current line info, indenting if necessary.
2036             if ($frame) {
2037                 print_lineinfo( ' ' x $stack_depth,
2038                     "$line:\t$dbline[$line]$after" );
2039             }
2040             else {
2041                 depth_print_lineinfo($explicit_stop, $position);
2042             }
2043
2044             # Scan forward, stopping at either the end or the next
2045             # unbreakable line.
2046             for ( my $i = $line + 1 ; $i <= $max && $dbline[$i] == 0 ; ++$i )
2047             {    #{ vi
2048
2049                 # Drop out on null statements, block closers, and comments.
2050                 last if $dbline[$i] =~ /^\s*[\;\}\#\n]/;
2051
2052                 # Drop out if the user interrupted us.
2053                 last if $signal;
2054
2055                 # Append a newline if the line doesn't have one. Can happen
2056                 # in eval'ed text, for instance.
2057                 $after = ( $dbline[$i] =~ /\n$/ ? '' : "\n" );
2058
2059                 # Next executable line.
2060                 my $incr_pos = "$prefix$i$infix$dbline[$i]$after";
2061                 $position .= $incr_pos;
2062                 if ($frame) {
2063
2064                     # Print it indented if tracing is on.
2065                     print_lineinfo( ' ' x $stack_depth,
2066                         "$i:\t$dbline[$i]$after" );
2067                 }
2068                 else {
2069                     depth_print_lineinfo($explicit_stop, $incr_pos);
2070                 }
2071             } ## end for ($i = $line + 1 ; $i...
2072         } ## end else [ if ($slave_editor)
2073     } ## end if ($single || ($trace...
2074
2075 =pod
2076
2077 If there's an action to be executed for the line we stopped at, execute it.
2078 If there are any preprompt actions, execute those as well.
2079
2080 =cut
2081
2082     # If there's an action, do it now.
2083     $evalarg = $action, &eval if $action;
2084
2085     # Are we nested another level (e.g., did we evaluate a function
2086     # that had a breakpoint in it at the debugger prompt)?
2087     if ( $single || $was_signal ) {
2088
2089         # Yes, go down a level.
2090         local $level = $level + 1;
2091
2092         # Do any pre-prompt actions.
2093         foreach $evalarg (@$pre) {
2094             &eval;
2095         }
2096
2097         # Complain about too much recursion if we passed the limit.
2098         print $OUT $stack_depth . " levels deep in subroutine calls!\n"
2099           if $single & 4;
2100
2101         # The line we're currently on. Set $incr to -1 to stay here
2102         # until we get a command that tells us to advance.
2103         $start = $line;
2104         $incr  = -1;      # for backward motion.
2105
2106         # Tack preprompt debugger actions ahead of any actual input.
2107         @typeahead = ( @$pretype, @typeahead );
2108
2109 =head2 WHERE ARE WE?
2110
2111 XXX Relocate this section?
2112
2113 The debugger normally shows the line corresponding to the current line of
2114 execution. Sometimes, though, we want to see the next line, or to move elsewhere
2115 in the file. This is done via the C<$incr>, C<$start>, and C<$max> variables.
2116
2117 C<$incr> controls by how many lines the I<current> line should move forward
2118 after a command is executed. If set to -1, this indicates that the I<current>
2119 line shouldn't change.
2120
2121 C<$start> is the I<current> line. It is used for things like knowing where to
2122 move forwards or backwards from when doing an C<L> or C<-> command.
2123
2124 C<$max> tells the debugger where the last line of the current file is. It's
2125 used to terminate loops most often.
2126
2127 =head2 THE COMMAND LOOP
2128
2129 Most of C<DB::DB> is actually a command parsing and dispatch loop. It comes
2130 in two parts:
2131
2132 =over 4
2133
2134 =item *
2135
2136 The outer part of the loop, starting at the C<CMD> label. This loop
2137 reads a command and then executes it.
2138
2139 =item *
2140
2141 The inner part of the loop, starting at the C<PIPE> label. This part
2142 is wholly contained inside the C<CMD> block and only executes a command.
2143 Used to handle commands running inside a pager.
2144
2145 =back
2146
2147 So why have two labels to restart the loop? Because sometimes, it's easier to
2148 have a command I<generate> another command and then re-execute the loop to do
2149 the new command. This is faster, but perhaps a bit more convoluted.
2150
2151 =cut
2152
2153         # The big command dispatch loop. It keeps running until the
2154         # user yields up control again.
2155         #
2156         # If we have a terminal for input, and we get something back
2157         # from readline(), keep on processing.
2158         my $piped;
2159         my $selected;
2160
2161       CMD:
2162         while (
2163
2164             # We have a terminal, or can get one ...
2165             ( $term || &setterm ),
2166
2167             # ... and it belogs to this PID or we get one for this PID ...
2168             ( $term_pid == $$ or resetterm(1) ),
2169
2170             # ... and we got a line of command input ...
2171             defined(
2172                 $cmd = &readline(
2173                         "$pidprompt $tid DB"
2174                       . ( '<' x $level )
2175                       . ( $#hist + 1 )
2176                       . ( '>' x $level ) . " "
2177                 )
2178             )
2179           )
2180         {
2181
2182                         share($cmd);
2183             # ... try to execute the input as debugger commands.
2184
2185             # Don't stop running.
2186             $single = 0;
2187
2188             # No signal is active.
2189             $signal = 0;
2190
2191             # Handle continued commands (ending with \):
2192             if ($cmd =~ s/\\\z/\n/) {
2193                 $cmd .= &readline("  cont: ");
2194                 redo CMD;
2195             }
2196
2197 =head4 The null command
2198
2199 A newline entered by itself means I<re-execute the last command>. We grab the
2200 command out of C<$laststep> (where it was recorded previously), and copy it
2201 back into C<$cmd> to be executed below. If there wasn't any previous command,
2202 we'll do nothing below (no command will match). If there was, we also save it
2203 in the command history and fall through to allow the command parsing to pick
2204 it up.
2205
2206 =cut
2207
2208             # Empty input means repeat the last command.
2209             $cmd =~ /^$/ && ( $cmd = $laststep );
2210             chomp($cmd);    # get rid of the annoying extra newline
2211             push( @hist, $cmd ) if length($cmd) > 1;
2212             push( @truehist, $cmd );
2213                         share(@hist);
2214                         share(@truehist);
2215
2216             # This is a restart point for commands that didn't arrive
2217             # via direct user input. It allows us to 'redo PIPE' to
2218             # re-execute command processing without reading a new command.
2219           PIPE: {
2220                 $cmd =~ s/^\s+//s;    # trim annoying leading whitespace
2221                 $cmd =~ s/\s+$//s;    # trim annoying trailing whitespace
2222                 my ($i) = split( /\s+/, $cmd );
2223
2224 =head3 COMMAND ALIASES
2225
2226 The debugger can create aliases for commands (these are stored in the
2227 C<%alias> hash). Before a command is executed, the command loop looks it up
2228 in the alias hash and substitutes the contents of the alias for the command,
2229 completely replacing it.
2230
2231 =cut
2232
2233                 # See if there's an alias for the command, and set it up if so.
2234                 if ( $alias{$i} ) {
2235
2236                     # Squelch signal handling; we want to keep control here
2237                     # if something goes loco during the alias eval.
2238                     local $SIG{__DIE__};
2239                     local $SIG{__WARN__};
2240
2241                     # This is a command, so we eval it in the DEBUGGER's
2242                     # scope! Otherwise, we can't see the special debugger
2243                     # variables, or get to the debugger's subs. (Well, we
2244                     # _could_, but why make it even more complicated?)
2245                     eval "\$cmd =~ $alias{$i}";
2246                     if ($@) {
2247                         local $\ = '';
2248                         print $OUT "Couldn't evaluate '$i' alias: $@";
2249                         next CMD;
2250                     }
2251                 } ## end if ($alias{$i})
2252
2253 =head3 MAIN-LINE COMMANDS
2254
2255 All of these commands work up to and after the program being debugged has
2256 terminated.
2257
2258 =head4 C<q> - quit
2259
2260 Quit the debugger. This entails setting the C<$fall_off_end> flag, so we don't
2261 try to execute further, cleaning any restart-related stuff out of the
2262 environment, and executing with the last value of C<$?>.
2263
2264 =cut
2265
2266                 if ($cmd eq 'q') {
2267                     $fall_off_end = 1;
2268                     clean_ENV();
2269                     exit $?;
2270                 }
2271
2272 =head4 C<t> - trace [n]
2273
2274 Turn tracing on or off. Inverts the appropriate bit in C<$trace> (q.v.).
2275 If level is specified, set C<$trace_to_depth>.
2276
2277 =cut
2278
2279                 if (my ($levels) = $cmd =~ /\At(?:\s+(\d+))?\z/) {
2280                     $trace ^= 1;
2281                     local $\ = '';
2282                     $trace_to_depth = $levels ? $stack_depth + $levels : 1E9;
2283                     print $OUT "Trace = "
2284                       . ( ( $trace & 1 )
2285                       ? ( $levels ? "on (to level $trace_to_depth)" : "on" )
2286                       : "off" ) . "\n";
2287                     next CMD;
2288                 }
2289
2290 =head4 C<S> - list subroutines matching/not matching a pattern
2291
2292 Walks through C<%sub>, checking to see whether or not to print the name.
2293
2294 =cut
2295
2296                 if (my ($print_all_subs, $should_reverse, $Spatt)
2297                     = $cmd =~ /\AS(\s+(!)?(.+))?\z/) {
2298                     # $Spatt is the pattern (if any) to use.
2299                     # Reverse scan?
2300                     my $Srev     = defined $should_reverse;
2301                     # No args - print all subs.
2302                     my $Snocheck = !defined $print_all_subs;
2303
2304                     # Need to make these sane here.
2305                     local $\ = '';
2306                     local $, = '';
2307
2308                     # Search through the debugger's magical hash of subs.
2309                     # If $nocheck is true, just print the sub name.
2310                     # Otherwise, check it against the pattern. We then use
2311                     # the XOR trick to reverse the condition as required.
2312                     foreach $subname ( sort( keys %sub ) ) {
2313                         if ( $Snocheck or $Srev ^ ( $subname =~ /$Spatt/ ) ) {
2314                             print $OUT $subname, "\n";
2315                         }
2316                     }
2317                     next CMD;
2318                 }
2319
2320 =head4 C<X> - list variables in current package
2321
2322 Since the C<V> command actually processes this, just change this to the
2323 appropriate C<V> command and fall through.
2324
2325 =cut
2326
2327                 $cmd =~ s/^X\b/V $package/;
2328
2329 =head4 C<V> - list variables
2330
2331 Uses C<dumpvar.pl> to dump out the current values for selected variables.
2332
2333 =cut
2334
2335                 # Bare V commands get the currently-being-debugged package
2336                 # added.
2337                 if ($cmd eq "V") {
2338                     $cmd = "V $package";
2339                 }
2340
2341                 # V - show variables in package.
2342                 if (my ($new_packname, $new_vars_str) =
2343                     $cmd =~ /\AV\b\s*(\S+)\s*(.*)/) {
2344
2345                     # Save the currently selected filehandle and
2346                     # force output to debugger's filehandle (dumpvar
2347                     # just does "print" for output).
2348                     my $savout = select($OUT);
2349
2350                     # Grab package name and variables to dump.
2351                     $packname = $new_packname;
2352                     my @vars     = split( ' ', $new_vars_str );
2353
2354                     # If main::dumpvar isn't here, get it.
2355                     do 'dumpvar.pl' || die $@ unless defined &main::dumpvar;
2356                     if ( defined &main::dumpvar ) {
2357
2358                         # We got it. Turn off subroutine entry/exit messages
2359                         # for the moment, along with return values.
2360                         local $frame = 0;
2361                         local $doret = -2;
2362
2363                         # must detect sigpipe failures  - not catching
2364                         # then will cause the debugger to die.
2365                         eval {
2366                             &main::dumpvar(
2367                                 $packname,
2368                                 defined $option{dumpDepth}
2369                                 ? $option{dumpDepth}
2370                                 : -1,    # assume -1 unless specified
2371                                 @vars
2372                             );
2373                         };
2374
2375                         # The die doesn't need to include the $@, because
2376                         # it will automatically get propagated for us.
2377                         if ($@) {
2378                             die unless $@ =~ /dumpvar print failed/;
2379                         }
2380                     } ## end if (defined &main::dumpvar)
2381                     else {
2382
2383                         # Couldn't load dumpvar.
2384                         print $OUT "dumpvar.pl not available.\n";
2385                     }
2386
2387                     # Restore the output filehandle, and go round again.
2388                     select($savout);
2389                     next CMD;
2390                 }
2391
2392 =head4 C<x> - evaluate and print an expression
2393
2394 Hands the expression off to C<DB::eval>, setting it up to print the value
2395 via C<dumpvar.pl> instead of just printing it directly.
2396
2397 =cut
2398
2399                 if ($cmd =~ s#\Ax\b# #) {    # Remainder gets done by DB::eval()
2400                     $onetimeDump = 'dump';    # main::dumpvar shows the output
2401
2402                     # handle special  "x 3 blah" syntax XXX propagate
2403                     # doc back to special variables.
2404                     if ( $cmd =~ s#\A\s*(\d+)(?=\s)# #) {
2405                         $onetimedumpDepth = $1;
2406                     }
2407                 }
2408
2409 =head4 C<m> - print methods
2410
2411 Just uses C<DB::methods> to determine what methods are available.
2412
2413 =cut
2414
2415                 if ($cmd =~ s#\Am\s+([\w:]+)\s*\z# #) {
2416                     methods($1);
2417                     next CMD;
2418                 }
2419
2420                 # m expr - set up DB::eval to do the work
2421                 if ($cmd =~ s#\Am\b# #) {    # Rest gets done by DB::eval()
2422                     $onetimeDump = 'methods';   #  method output gets used there
2423                 }
2424
2425 =head4 C<f> - switch files
2426
2427 =cut
2428
2429                 if (($file) = $cmd =~ /\Af\b\s*(.*)/) {
2430                     $file =~ s/\s+$//;
2431
2432                     # help for no arguments (old-style was return from sub).
2433                     if ( !$file ) {
2434                         print $OUT
2435                           "The old f command is now the r command.\n";    # hint
2436                         print $OUT "The new f command switches filenames.\n";
2437                         next CMD;
2438                     } ## end if (!$file)
2439
2440                     # if not in magic file list, try a close match.
2441                     if ( !defined $main::{ '_<' . $file } ) {
2442                         if ( ($try) = grep( m#^_<.*$file#, keys %main:: ) ) {
2443                             {
2444                                 $try = substr( $try, 2 );
2445                                 print $OUT "Choosing $try matching '$file':\n";
2446                                 $file = $try;
2447                             }
2448                         } ## end if (($try) = grep(m#^_<.*$file#...
2449                     } ## end if (!defined $main::{ ...
2450
2451                     # If not successfully switched now, we failed.
2452                     if ( !defined $main::{ '_<' . $file } ) {
2453                         print $OUT "No file matching '$file' is loaded.\n";
2454                         next CMD;
2455                     }
2456
2457                     # We switched, so switch the debugger internals around.
2458                     elsif ( $file ne $filename ) {
2459                         *dbline   = $main::{ '_<' . $file };
2460                         $max      = $#dbline;
2461                         $filename = $file;
2462                         $start    = 1;
2463                         $cmd      = "l";
2464                     } ## end elsif ($file ne $filename)
2465
2466                     # We didn't switch; say we didn't.
2467                     else {
2468                         print $OUT "Already in $file.\n";
2469                         next CMD;
2470                     }
2471                 }
2472
2473 =head4 C<.> - return to last-executed line.
2474
2475 We set C<$incr> to -1 to indicate that the debugger shouldn't move ahead,
2476 and then we look up the line in the magical C<%dbline> hash.
2477
2478 =cut
2479
2480                 # . command.
2481                 if ($cmd eq '.') {
2482                     $incr = -1;    # stay at current line
2483
2484                     # Reset everything to the old location.
2485                     $start    = $line;
2486                     $filename = $filename_ini;
2487                     *dbline   = $main::{ '_<' . $filename };
2488                     $max      = $#dbline;
2489
2490                     # Now where are we?
2491                     print_lineinfo($position);
2492                     next CMD;
2493                 }
2494
2495 =head4 C<-> - back one window
2496
2497 We change C<$start> to be one window back; if we go back past the first line,
2498 we set it to be the first line. We ser C<$incr> to put us back at the
2499 currently-executing line, and then put a C<l $start +> (list one window from
2500 C<$start>) in C<$cmd> to be executed later.
2501
2502 =cut
2503
2504                 # - - back a window.
2505                 if ($cmd eq '-') {
2506
2507                     # back up by a window; go to 1 if back too far.
2508                     $start -= $incr + $window + 1;
2509                     $start = 1 if $start <= 0;
2510                     $incr  = $window - 1;
2511
2512                     # Generate and execute a "l +" command (handled below).
2513                     $cmd = 'l ' . ($start) . '+';
2514                 }
2515
2516 =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>, {, {{>
2517
2518 In Perl 5.8.0, a realignment of the commands was done to fix up a number of
2519 problems, most notably that the default case of several commands destroying
2520 the user's work in setting watchpoints, actions, etc. We wanted, however, to
2521 retain the old commands for those who were used to using them or who preferred
2522 them. At this point, we check for the new commands and call C<cmd_wrapper> to
2523 deal with them instead of processing them in-line.
2524
2525 =cut
2526
2527                 # All of these commands were remapped in perl 5.8.0;
2528                 # we send them off to the secondary dispatcher (see below).
2529                 if (my ($cmd_letter, $my_arg) = $cmd =~ /\A([aAbBeEhilLMoOPvwW]\b|[<>\{]{1,2})\s*(.*)/so) {
2530                     &cmd_wrapper( $cmd_letter, $my_arg, $line );
2531                     next CMD;
2532                 }
2533
2534 =head4 C<y> - List lexicals in higher scope
2535
2536 Uses C<PadWalker> to find the lexicals supplied as arguments in a scope
2537 above the current one and then displays then using C<dumpvar.pl>.
2538
2539 =cut
2540
2541                 if (my ($match_level, $match_vars)
2542                     = $cmd =~ /^y(?:\s+(\d*)\s*(.*))?$/) {
2543
2544                     # See if we've got the necessary support.
2545                     eval { require PadWalker; PadWalker->VERSION(0.08) }
2546                       or &warn(
2547                         $@ =~ /locate/
2548                         ? "PadWalker module not found - please install\n"
2549                         : $@
2550                       )
2551                       and next CMD;
2552
2553                     # Load up dumpvar if we don't have it. If we can, that is.
2554                     do 'dumpvar.pl' || die $@ unless defined &main::dumpvar;
2555                     defined &main::dumpvar
2556                       or print $OUT "dumpvar.pl not available.\n"
2557                       and next CMD;
2558
2559                     # Got all the modules we need. Find them and print them.
2560                     my @vars = split( ' ', $match_vars || '' );
2561
2562                     # Find the pad.
2563                     my $h = eval { PadWalker::peek_my( ( $match_level || 0 ) + 1 ) };
2564
2565                     # Oops. Can't find it.
2566                     $@ and $@ =~ s/ at .*//, &warn($@), next CMD;
2567
2568                     # Show the desired vars with dumplex().
2569                     my $savout = select($OUT);
2570
2571                     # Have dumplex dump the lexicals.
2572                     dumpvar::dumplex( $_, $h->{$_},
2573                         defined $option{dumpDepth} ? $option{dumpDepth} : -1,
2574                         @vars )
2575                       for sort keys %$h;
2576                     select($savout);
2577                     next CMD;
2578                 }
2579
2580 =head3 COMMANDS NOT WORKING AFTER PROGRAM ENDS
2581
2582 All of the commands below this point don't work after the program being
2583 debugged has ended. All of them check to see if the program has ended; this
2584 allows the commands to be relocated without worrying about a 'line of
2585 demarcation' above which commands can be entered anytime, and below which
2586 they can't.
2587
2588 =head4 C<n> - single step, but don't trace down into subs
2589
2590 Done by setting C<$single> to 2, which forces subs to execute straight through
2591 when entered (see C<DB::sub>). We also save the C<n> command in C<$laststep>,
2592 so a null command knows what to re-execute.
2593
2594 =cut
2595
2596                 # n - next
2597                 if ($cmd eq 'n') {
2598                     end_report(), next CMD if $finished and $level <= 1;
2599
2600                     # Single step, but don't enter subs.
2601                     $single = 2;
2602
2603                     # Save for empty command (repeat last).
2604                     $laststep = $cmd;
2605                     last CMD;
2606                 }
2607
2608 =head4 C<s> - single-step, entering subs
2609
2610 Sets C<$single> to 1, which causes C<DB::sub> to continue tracing inside
2611 subs. Also saves C<s> as C<$lastcmd>.
2612
2613 =cut
2614
2615                 # s - single step.
2616                 if ($cmd eq 's') {
2617
2618                     # Get out and restart the command loop if program
2619                     # has finished.
2620                     end_report(), next CMD if $finished and $level <= 1;
2621
2622                     # Single step should enter subs.
2623                     $single = 1;
2624
2625                     # Save for empty command (repeat last).
2626                     $laststep = $cmd;
2627                     last CMD;
2628                 }
2629
2630 =head4 C<c> - run continuously, setting an optional breakpoint
2631
2632 Most of the code for this command is taken up with locating the optional
2633 breakpoint, which is either a subroutine name or a line number. We set
2634 the appropriate one-time-break in C<@dbline> and then turn off single-stepping
2635 in this and all call levels above this one.
2636
2637 =cut
2638
2639                 # c - start continuous execution.
2640                 if (($i) = $cmd =~ m#\Ac\b\s*([\w:]*)\s*\z#) {
2641
2642                     # Hey, show's over. The debugged program finished
2643                     # executing already.
2644                     end_report(), next CMD if $finished and $level <= 1;
2645
2646                     # Capture the place to put a one-time break.
2647                     $subname = $i;
2648
2649                     #  Probably not needed, since we finish an interactive
2650                     #  sub-session anyway...
2651                     # local $filename = $filename;
2652                     # local *dbline = *dbline; # XXX Would this work?!
2653                     #
2654                     # The above question wonders if localizing the alias
2655                     # to the magic array works or not. Since it's commented
2656                     # out, we'll just leave that to speculation for now.
2657
2658                     # If the "subname" isn't all digits, we'll assume it
2659                     # is a subroutine name, and try to find it.
2660                     if ( $subname =~ /\D/ ) {    # subroutine name
2661                             # Qualify it to the current package unless it's
2662                             # already qualified.
2663                         $subname = $package . "::" . $subname
2664                           unless $subname =~ /::/;
2665
2666                         # find_sub will return "file:line_number" corresponding
2667                         # to where the subroutine is defined; we call find_sub,
2668                         # break up the return value, and assign it in one
2669                         # operation.
2670                         ( $file, $i ) = ( find_sub($subname) =~ /^(.*):(.*)$/ );
2671
2672                         # Force the line number to be numeric.
2673                         $i += 0;
2674
2675                         # If we got a line number, we found the sub.
2676                         if ($i) {
2677
2678                             # Switch all the debugger's internals around so
2679                             # we're actually working with that file.
2680                             $filename = $file;
2681                             *dbline   = $main::{ '_<' . $filename };
2682
2683                             # Mark that there's a breakpoint in this file.
2684                             $had_breakpoints{$filename} |= 1;
2685
2686                             # Scan forward to the first executable line
2687                             # after the 'sub whatever' line.
2688                             $max = $#dbline;
2689                             ++$i while $dbline[$i] == 0 && $i < $max;
2690                         } ## end if ($i)
2691
2692                         # We didn't find a sub by that name.
2693                         else {
2694                             print $OUT "Subroutine $subname not found.\n";
2695                             next CMD;
2696                         }
2697                     } ## end if ($subname =~ /\D/)
2698
2699                     # At this point, either the subname was all digits (an
2700                     # absolute line-break request) or we've scanned through
2701                     # the code following the definition of the sub, looking
2702                     # for an executable, which we may or may not have found.
2703                     #
2704                     # If $i (which we set $subname from) is non-zero, we
2705                     # got a request to break at some line somewhere. On
2706                     # one hand, if there wasn't any real subroutine name
2707                     # involved, this will be a request to break in the current
2708                     # file at the specified line, so we have to check to make
2709                     # sure that the line specified really is breakable.
2710                     #
2711                     # On the other hand, if there was a subname supplied, the
2712                     # preceding block has moved us to the proper file and
2713                     # location within that file, and then scanned forward
2714                     # looking for the next executable line. We have to make
2715                     # sure that one was found.
2716                     #
2717                     # On the gripping hand, we can't do anything unless the
2718                     # current value of $i points to a valid breakable line.
2719                     # Check that.
2720                     if ($i) {
2721
2722                         # Breakable?
2723                         if ( $dbline[$i] == 0 ) {
2724                             print $OUT "Line $i not breakable.\n";
2725                             next CMD;
2726                         }
2727
2728                         # Yes. Set up the one-time-break sigil.
2729                         $dbline{$i} =~ s/($|\0)/;9$1/;  # add one-time-only b.p.
2730                         _enable_breakpoint_temp_enabled_status($filename, $i);
2731                     } ## end if ($i)
2732
2733                     # Turn off stack tracing from here up.
2734                     for my $i (0 .. $stack_depth) {
2735                         $stack[ $i ] &= ~1;
2736                     }
2737                     last CMD;
2738                 }
2739
2740 =head4 C<r> - return from a subroutine
2741
2742 For C<r> to work properly, the debugger has to stop execution again
2743 immediately after the return is executed. This is done by forcing
2744 single-stepping to be on in the call level above the current one. If
2745 we are printing return values when a C<r> is executed, set C<$doret>
2746 appropriately, and force us out of the command loop.
2747
2748 =cut
2749
2750                 # r - return from the current subroutine.
2751                 if ($cmd eq 'r') {
2752
2753                     # Can't do anything if the program's over.
2754                     end_report(), next CMD if $finished and $level <= 1;
2755
2756                     # Turn on stack trace.
2757                     $stack[$stack_depth] |= 1;
2758
2759                     # Print return value unless the stack is empty.
2760                     $doret = $option{PrintRet} ? $stack_depth - 1 : -2;
2761                     last CMD;
2762                 }
2763
2764 =head4 C<T> - stack trace
2765
2766 Just calls C<DB::print_trace>.
2767
2768 =cut
2769
2770                 if ($cmd eq 'T') {
2771                     print_trace( $OUT, 1 );    # skip DB
2772                     next CMD;
2773                 }
2774
2775 =head4 C<w> - List window around current line.
2776
2777 Just calls C<DB::cmd_w>.
2778
2779 =cut
2780
2781                 if (my ($arg) = $cmd =~ /\Aw\b\s*(.*)/s) {
2782                     &cmd_w( 'w', $arg );
2783                     next CMD;
2784                 }
2785
2786 =head4 C<W> - watch-expression processing.
2787
2788 Just calls C<DB::cmd_W>.
2789
2790 =cut
2791
2792                 if (my ($arg) = $cmd =~ /\AW\b\s*(.*)/s) {
2793                     &cmd_W( 'W', $arg );
2794                     next CMD;
2795                 }
2796
2797 =head4 C</> - search forward for a string in the source
2798
2799 We take the argument and treat it as a pattern. If it turns out to be a
2800 bad one, we return the error we got from trying to C<eval> it and exit.
2801 If not, we create some code to do the search and C<eval> it so it can't
2802 mess us up.
2803
2804 =cut
2805
2806                 # The pattern as a string.
2807                 use vars qw($inpat);
2808
2809                 if (($inpat) = $cmd =~ m#\A/(.*)\z#) {
2810
2811                     # Remove the final slash.
2812                     $inpat =~ s:([^\\])/$:$1:;
2813
2814                     # If the pattern isn't null ...
2815                     if ( $inpat ne "" ) {
2816
2817                         # Turn of warn and die procesing for a bit.
2818                         local $SIG{__DIE__};
2819                         local $SIG{__WARN__};
2820
2821                         # Create the pattern.
2822                         eval '$inpat =~ m' . "\a$inpat\a";
2823                         if ( $@ ne "" ) {
2824
2825                             # Oops. Bad pattern. No biscuit.
2826                             # Print the eval error and go back for more
2827                             # commands.
2828                             print $OUT "$@";
2829                             next CMD;
2830                         }
2831                         $pat = $inpat;
2832                     } ## end if ($inpat ne "")
2833
2834                     # Set up to stop on wrap-around.
2835                     $end = $start;
2836
2837                     # Don't move off the current line.
2838                     $incr = -1;
2839
2840                     # Done in eval so nothing breaks if the pattern
2841                     # does something weird.
2842                     eval '
2843                         for (;;) {
2844                             # Move ahead one line.
2845                             ++$start;
2846
2847                             # Wrap if we pass the last line.
2848                             $start = 1 if ($start > $max);
2849
2850                             # Stop if we have gotten back to this line again,
2851                             last if ($start == $end);
2852
2853                             # A hit! (Note, though, that we are doing
2854                             # case-insensitive matching. Maybe a qr//
2855                             # expression would be better, so the user could
2856                             # do case-sensitive matching if desired.
2857                             if ($dbline[$start] =~ m' . "\a$pat\a" . 'i) {
2858                                 if ($slave_editor) {
2859                                     # Handle proper escaping in the slave.
2860                                     print $OUT "\032\032$filename:$start:0\n";
2861                                 }
2862                                 else {
2863                                     # Just print the line normally.
2864                                     print $OUT "$start:\t",$dbline[$start],"\n";
2865                                 }
2866                                 # And quit since we found something.
2867                                 last;
2868                             }
2869                          } ';
2870
2871                     # If we wrapped, there never was a match.
2872                     print $OUT "/$pat/: not found\n" if ( $start == $end );
2873                     next CMD;
2874                 }
2875
2876 =head4 C<?> - search backward for a string in the source
2877
2878 Same as for C</>, except the loop runs backwards.
2879
2880 =cut
2881
2882                 # ? - backward pattern search.
2883                 if (my ($inpat) = $cmd =~ m#\A\?(.*)\z#) {
2884
2885                     # Get the pattern, remove trailing question mark.
2886                     $inpat =~ s:([^\\])\?$:$1:;
2887
2888                     # If we've got one ...
2889                     if ( $inpat ne "" ) {
2890
2891                         # Turn off die & warn handlers.
2892                         local $SIG{__DIE__};
2893                         local $SIG{__WARN__};
2894                         eval '$inpat =~ m' . "\a$inpat\a";
2895
2896                         if ( $@ ne "" ) {
2897
2898                             # Ouch. Not good. Print the error.
2899                             print $OUT $@;
2900                             next CMD;
2901                         }
2902                         $pat = $inpat;
2903                     } ## end if ($inpat ne "")
2904
2905                     # Where we are now is where to stop after wraparound.
2906                     $end = $start;
2907
2908                     # Don't move away from this line.
2909                     $incr = -1;
2910
2911                     # Search inside the eval to prevent pattern badness
2912                     # from killing us.
2913                     eval '
2914                         for (;;) {
2915                             # Back up a line.
2916                             --$start;
2917
2918                             # Wrap if we pass the first line.
2919
2920                             $start = $max if ($start <= 0);
2921
2922                             # Quit if we get back where we started,
2923                             last if ($start == $end);
2924
2925                             # Match?
2926                             if ($dbline[$start] =~ m' . "\a$pat\a" . 'i) {
2927                                 if ($slave_editor) {
2928                                     # Yep, follow slave editor requirements.
2929                                     print $OUT "\032\032$filename:$start:0\n";
2930                                 }
2931                                 else {
2932                                     # Yep, just print normally.
2933                                     print $OUT "$start:\t",$dbline[$start],"\n";
2934                                 }
2935
2936                                 # Found, so done.
2937                                 last;
2938                             }
2939                         } ';
2940
2941                     # Say we failed if the loop never found anything,
2942                     print $OUT "?$pat?: not found\n" if ( $start == $end );
2943                     next CMD;
2944                 }
2945
2946 =head4 C<$rc> - Recall command
2947
2948 Manages the commands in C<@hist> (which is created if C<Term::ReadLine> reports
2949 that the terminal supports history). It find the the command required, puts it
2950 into C<$cmd>, and redoes the loop to execute it.
2951
2952 =cut
2953
2954                 # $rc - recall command.
2955                 if (my ($minus, $arg) = $cmd =~ m#\A$rc+\s*(-)?(\d+)?\z#) {
2956
2957                     # No arguments, take one thing off history.
2958                     pop(@hist) if length($cmd) > 1;
2959
2960                     # Relative (- found)?
2961                     #  Y - index back from most recent (by 1 if bare minus)
2962                     #  N - go to that particular command slot or the last
2963                     #      thing if nothing following.
2964                     $i = $minus ? ( $#hist - ( $arg || 1 ) ) : ( $arg || $#hist );
2965
2966                     # Pick out the command desired.
2967                     $cmd = $hist[$i];
2968
2969                     # Print the command to be executed and restart the loop
2970                     # with that command in the buffer.
2971                     print $OUT $cmd, "\n";
2972                     redo CMD;
2973                 }
2974
2975 =head4 C<$sh$sh> - C<system()> command
2976
2977 Calls the C<DB::system()> to handle the command. This keeps the C<STDIN> and
2978 C<STDOUT> from getting messed up.
2979
2980 =cut
2981
2982                 # $sh$sh - run a shell command (if it's all ASCII).
2983                 # Can't run shell commands with Unicode in the debugger, hmm.
2984                 if (my ($arg) = $cmd =~ m#\A$sh$sh\s*(.*)#ms) {
2985
2986                     # System it.
2987                     &system($arg);
2988                     next CMD;
2989                 }
2990
2991 =head4 C<$rc I<pattern> $rc> - Search command history
2992
2993 Another command to manipulate C<@hist>: this one searches it with a pattern.
2994 If a command is found, it is placed in C<$cmd> and executed via C<redo>.
2995
2996 =cut
2997
2998                 # $rc pattern $rc - find a command in the history.
2999                 if (my ($arg) = $cmd =~ /\A$rc([^$rc].*)\z/) {
3000
3001                     # Create the pattern to use.
3002                     $pat = "^$arg";
3003
3004                     # Toss off last entry if length is >1 (and it always is).
3005                     pop(@hist) if length($cmd) > 1;
3006
3007                     # Look backward through the history.
3008                     for ( $i = $#hist ; $i ; --$i ) {
3009                         # Stop if we find it.
3010                         last if $hist[$i] =~ /$pat/;
3011                     }
3012
3013                     if ( !$i ) {
3014
3015                         # Never found it.
3016                         print $OUT "No such command!\n\n";
3017                         next CMD;
3018                     }
3019
3020                     # Found it. Put it in the buffer, print it, and process it.
3021                     $cmd = $hist[$i];
3022                     print $OUT $cmd, "\n";
3023                     redo CMD;
3024                 }
3025
3026 =head4 C<$sh> - Invoke a shell
3027
3028 Uses C<DB::system> to invoke a shell.
3029
3030 =cut
3031
3032                 # $sh - start a shell.
3033                 if ($cmd =~ /\A$sh\z/) {
3034
3035                     # Run the user's shell. If none defined, run Bourne.
3036                     # We resume execution when the shell terminates.
3037                     &system( $ENV{SHELL} || "/bin/sh" );
3038                     next CMD;
3039                 }
3040
3041 =head4 C<$sh I<command>> - Force execution of a command in a shell
3042
3043 Like the above, but the command is passed to the shell. Again, we use
3044 C<DB::system> to avoid problems with C<STDIN> and C<STDOUT>.
3045
3046 =cut
3047
3048                 # $sh command - start a shell and run a command in it.
3049                 if (my ($arg) = $cmd =~ m#\A$sh\s*(.*)#ms) {
3050
3051                     # XXX: using csh or tcsh destroys sigint retvals!
3052                     #&system($1);  # use this instead
3053
3054                     # use the user's shell, or Bourne if none defined.
3055                     &system( $ENV{SHELL} || "/bin/sh", "-c", $arg );
3056                     next CMD;
3057                 }
3058
3059 =head4 C<H> - display commands in history
3060
3061 Prints the contents of C<@hist> (if any).
3062
3063 =cut
3064
3065                 if ($cmd =~ /\AH\b\s*\*/) {
3066                     @hist = @truehist = ();
3067                     print $OUT "History cleansed\n";
3068                     next CMD;
3069                 }
3070
3071                 if (my ($num)
3072                     = $cmd =~ /\AH\b\s*(?:-(\d+))?/) {
3073
3074                     # Anything other than negative numbers is ignored by
3075                     # the (incorrect) pattern, so this test does nothing.
3076                     $end = $num ? ( $#hist - $num ) : 0;
3077
3078                     # Set to the minimum if less than zero.
3079                     $hist = 0 if $hist < 0;
3080
3081                     # Start at the end of the array.
3082                     # Stay in while we're still above the ending value.
3083                     # Tick back by one each time around the loop.
3084                     for ( $i = $#hist ; $i > $end ; $i-- ) {
3085
3086                         # Print the command  unless it has no arguments.
3087                         print $OUT "$i: ", $hist[$i], "\n"
3088                           unless $hist[$i] =~ /^.?$/;
3089                     }
3090                     next CMD;
3091                 }
3092
3093 =head4 C<man, doc, perldoc> - look up documentation
3094
3095 Just calls C<runman()> to print the appropriate document.
3096
3097 =cut
3098
3099                 # man, perldoc, doc - show manual pages.
3100                 if (my ($man_page)
3101                     = $cmd =~ /\A(?:man|(?:perl)?doc)\b(?:\s+([^(]*))?\z/) {
3102                     runman($man_page);
3103                     next CMD;
3104                 }
3105
3106 =head4 C<p> - print
3107
3108 Builds a C<print EXPR> expression in the C<$cmd>; this will get executed at
3109 the bottom of the loop.
3110
3111 =cut
3112
3113                 my $print_cmd = 'print {$DB::OUT} ';
3114                 # p - print (no args): print $_.
3115                 if ($cmd eq 'p') {
3116                     $cmd = $print_cmd . '$_';
3117                 }
3118
3119                 # p - print the given expression.
3120                 $cmd =~ s/\Ap\b/$print_cmd /;
3121
3122 =head4 C<=> - define command alias
3123
3124 Manipulates C<%alias> to add or list command aliases.
3125
3126 =cut
3127
3128                 # = - set up a command alias.
3129                 if ($cmd =~ s/\A=\s*//) {
3130                     my @keys;
3131                     if ( length $cmd == 0 ) {
3132
3133                         # No args, get current aliases.
3134                         @keys = sort keys %alias;
3135                     }
3136                     elsif ( my ( $k, $v ) = ( $cmd =~ /^(\S+)\s+(\S.*)/ ) ) {
3137
3138                         # Creating a new alias. $k is alias name, $v is
3139                         # alias value.
3140
3141                         # can't use $_ or kill //g state
3142                         for my $x ( $k, $v ) {
3143
3144                             # Escape "alarm" characters.
3145                             $x =~ s/\a/\\a/g;
3146                         }
3147
3148                         # Substitute key for value, using alarm chars
3149                         # as separators (which is why we escaped them in
3150                         # the command).
3151                         $alias{$k} = "s\a$k\a$v\a";
3152
3153                         # Turn off standard warn and die behavior.
3154                         local $SIG{__DIE__};
3155                         local $SIG{__WARN__};
3156
3157                         # Is it valid Perl?
3158                         unless ( eval "sub { s\a$k\a$v\a }; 1" ) {
3159
3160                             # Nope. Bad alias. Say so and get out.
3161                             print $OUT "Can't alias $k to $v: $@\n";
3162                             delete $alias{$k};
3163                             next CMD;
3164                         }
3165
3166                         # We'll only list the new one.
3167                         @keys = ($k);
3168                     } ## end elsif (my ($k, $v) = ($cmd...
3169
3170                     # The argument is the alias to list.
3171                     else {
3172                         @keys = ($cmd);
3173                     }
3174
3175                     # List aliases.
3176                     for my $k (@keys) {
3177
3178                         # Messy metaquoting: Trim the substitution code off.
3179                         # We use control-G as the delimiter because it's not
3180                         # likely to appear in the alias.
3181                         if ( ( my $v = $alias{$k} ) =~ s\as\a$k\a(.*)\a$\a1\a ) {
3182
3183                             # Print the alias.
3184                             print $OUT "$k\t= $1\n";
3185                         }
3186                         elsif ( defined $alias{$k} ) {
3187
3188                             # Couldn't trim it off; just print the alias code.
3189                             print $OUT "$k\t$alias{$k}\n";
3190                         }
3191                         else {
3192
3193                             # No such, dude.
3194                             print "No alias for $k\n";
3195                         }
3196                     } ## end for my $k (@keys)
3197                     next CMD;
3198                 }
3199
3200 =head4 C<source> - read commands from a file.
3201
3202 Opens a lexical filehandle and stacks it on C<@cmdfhs>; C<DB::readline> will
3203 pick it up.
3204
3205 =cut
3206
3207                 # source - read commands from a file (or pipe!) and execute.
3208                 if (my ($sourced_fn) = $cmd =~ /\Asource\s+(.*\S)/) {
3209                     if ( open my $fh, $sourced_fn ) {
3210
3211                         # Opened OK; stick it in the list of file handles.
3212                         push @cmdfhs, $fh;
3213                     }
3214                     else {
3215
3216                         # Couldn't open it.
3217                         &warn("Can't execute '$sourced_fn': $!\n");
3218                     }
3219                     next CMD;
3220                 }
3221
3222                 if (my ($which_cmd, $position)
3223                     = $cmd =~ /^(enable|disable)\s+(\S+)\s*$/) {
3224
3225                     my ($fn, $line_num);
3226                     if ($position =~ m{\A\d+\z})
3227                     {
3228                         $fn = $filename;
3229                         $line_num = $position;
3230                     }
3231                     elsif (my ($new_fn, $new_line_num)
3232                         = $position =~ m{\A(.*):(\d+)\z}) {
3233                         ($fn, $line_num) = ($new_fn, $new_line_num);
3234                     }
3235                     else
3236                     {
3237                         &warn("Wrong spec for enable/disable argument.\n");
3238                     }
3239
3240                     if (defined($fn)) {
3241                         if (_has_breakpoint_data_ref($fn, $line_num)) {
3242                             _set_breakpoint_enabled_status($fn, $line_num,
3243                                 ($which_cmd eq 'enable' ? 1 : '')
3244                             );
3245                         }
3246                         else {
3247                             &warn("No breakpoint set at ${fn}:${line_num}\n");
3248                         }
3249                     }
3250
3251                     next CMD;
3252                 }
3253
3254 =head4 C<save> - send current history to a file
3255
3256 Takes the complete history, (not the shrunken version you see with C<H>),
3257 and saves it to the given filename, so it can be replayed using C<source>.
3258
3259 Note that all C<^(save|source)>'s are commented out with a view to minimise recursion.
3260
3261 =cut
3262
3263                 # save source - write commands to a file for later use
3264                 if (my ($new_fn) = $cmd =~ /\Asave\s*(.*)\z/) {
3265                     my $filename = $new_fn || '.perl5dbrc';    # default?
3266                     if ( open my $fh, '>', $filename ) {
3267
3268                        # chomp to remove extraneous newlines from source'd files
3269                         chomp( my @truelist =
3270                               map { m/^\s*(save|source)/ ? "#$_" : $_ }
3271                               @truehist );
3272                         print $fh join( "\n", @truelist );
3273                         print "commands saved in $file\n";
3274                     }
3275                     else {
3276                         &warn("Can't save debugger commands in '$new_fn': $!\n");
3277                     }
3278                     next CMD;
3279                 }
3280
3281 =head4 C<R> - restart
3282
3283 Restart the debugger session.
3284
3285 =head4 C<rerun> - rerun the current session
3286
3287 Return to any given position in the B<true>-history list
3288
3289 =cut
3290
3291                 # R - restart execution.
3292                 # rerun - controlled restart execution.
3293                 if (my ($cmd_cmd, $cmd_params) =
3294                     $cmd =~ /\A((?:R)|(?:rerun\s*(.*)))\z/) {
3295                     my @args = ($cmd_cmd eq 'R' ? restart() : rerun($cmd_params));
3296
3297                     # Close all non-system fds for a clean restart.  A more
3298                     # correct method would be to close all fds that were not
3299                     # open when the process started, but this seems to be
3300                     # hard.  See "debugger 'R'estart and open database
3301                     # connections" on p5p.
3302
3303                     my $max_fd = 1024; # default if POSIX can't be loaded
3304                     if (eval { require POSIX }) {
3305                         eval { $max_fd = POSIX::sysconf(POSIX::_SC_OPEN_MAX()) };
3306                     }
3307
3308                     if (defined $max_fd) {
3309                         foreach ($^F+1 .. $max_fd-1) {
3310                             next unless open FD_TO_CLOSE, "<&=$_";
3311                             close(FD_TO_CLOSE);
3312                         }
3313                     }
3314
3315                     # And run Perl again.  We use exec() to keep the
3316                     # PID stable (and that way $ini_pids is still valid).
3317                     exec(@args) || print $OUT "exec failed: $!\n";
3318
3319                     last CMD;
3320                 }
3321
3322 =head4 C<|, ||> - pipe output through the pager.
3323
3324 For C<|>, we save C<OUT> (the debugger's output filehandle) and C<STDOUT>
3325 (the program's standard output). For C<||>, we only save C<OUT>. We open a
3326 pipe to the pager (restoring the output filehandles if this fails). If this
3327 is the C<|> command, we also set up a C<SIGPIPE> handler which will simply
3328 set C<$signal>, sending us back into the debugger.
3329
3330 We then trim off the pipe symbols and C<redo> the command loop at the
3331 C<PIPE> label, causing us to evaluate the command in C<$cmd> without
3332 reading another.
3333
3334 =cut
3335
3336                 # || - run command in the pager, with output to DB::OUT.
3337                 if ($cmd =~ m#\A\|\|?\s*[^|]#) {
3338                     if ( $pager =~ /^\|/ ) {
3339
3340                         # Default pager is into a pipe. Redirect I/O.
3341                         open( SAVEOUT, ">&STDOUT" )
3342                           || &warn("Can't save STDOUT");
3343                         open( STDOUT, ">&OUT" )
3344                           || &warn("Can't redirect STDOUT");
3345                     } ## end if ($pager =~ /^\|/)
3346                     else {
3347
3348                         # Not into a pipe. STDOUT is safe.
3349                         open( SAVEOUT, ">&OUT" ) || &warn("Can't save DB::OUT");
3350                     }
3351
3352                     # Fix up environment to record we have less if so.
3353                     fix_less();
3354
3355                     unless ( $piped = open( OUT, $pager ) ) {
3356
3357                         # Couldn't open pipe to pager.
3358                         &warn("Can't pipe output to '$pager'");
3359                         if ( $pager =~ /^\|/ ) {
3360
3361                             # Redirect I/O back again.
3362                             open( OUT, ">&STDOUT" )    # XXX: lost message
3363                               || &warn("Can't restore DB::OUT");
3364                             open( STDOUT, ">&SAVEOUT" )
3365                               || &warn("Can't restore STDOUT");
3366                             close(SAVEOUT);
3367                         } ## end if ($pager =~ /^\|/)
3368                         else {
3369
3370                             # Redirect I/O. STDOUT already safe.
3371                             open( OUT, ">&STDOUT" )    # XXX: lost message
3372                               || &warn("Can't restore DB::OUT");
3373                         }
3374                         next CMD;
3375                     } ## end unless ($piped = open(OUT,...
3376
3377                     # Set up broken-pipe handler if necessary.
3378                     $SIG{PIPE} = \&DB::catch
3379                       if $pager =~ /^\|/
3380                       && ( "" eq $SIG{PIPE} || "DEFAULT" eq $SIG{PIPE} );
3381
3382                     OUT->autoflush(1);
3383                     # Save current filehandle, and put it back.
3384                     $selected = select(OUT);
3385                     # Don't put it back if pager was a pipe.
3386                     select($selected), $selected = "" unless $cmd =~ /^\|\|/;
3387
3388                     # Trim off the pipe symbols and run the command now.
3389                     $cmd =~ s#\A\|+\s*##;
3390                     redo PIPE;
3391                 }
3392
3393 =head3 END OF COMMAND PARSING
3394
3395 Anything left in C<$cmd> at this point is a Perl expression that we want to
3396 evaluate. We'll always evaluate in the user's context, and fully qualify
3397 any variables we might want to address in the C<DB> package.
3398
3399 =cut
3400
3401                 # t - turn trace on.
3402                 if ($cmd =~ s#\At\s+(\d+)?#\$DB::trace |= 1;\n#) {
3403                     my $trace_arg = $1;
3404                     $trace_to_depth = $trace_arg ? $stack_depth||0 + $1 : 1E9;
3405                 }
3406
3407                 # s - single-step. Remember the last command was 's'.
3408                 if ($cmd =~ s/\As\s/\$DB::single = 1;\n/) {
3409                     $laststep = 's';
3410                 }
3411
3412                 # n - single-step, but not into subs. Remember last command
3413                 # was 'n'.
3414                 if ($cmd =~ s#\An\s#\$DB::single = 2;\n#) {
3415                     $laststep = 'n';
3416                 }
3417
3418             }    # PIPE:
3419
3420             # Make sure the flag that says "the debugger's running" is
3421             # still on, to make sure we get control again.
3422             $evalarg = "\$^D = \$^D | \$DB::db_stop;\n$cmd";
3423
3424             # Run *our* eval that executes in the caller's context.
3425             &eval;
3426
3427             # Turn off the one-time-dump stuff now.
3428             if ($onetimeDump) {
3429                 $onetimeDump      = undef;
3430                 $onetimedumpDepth = undef;
3431             }
3432             elsif ( $term_pid == $$ ) {
3433                 eval {          # May run under miniperl, when not available...
3434                     STDOUT->flush();
3435                     STDERR->flush();
3436                 };
3437
3438                 # XXX If this is the master pid, print a newline.
3439                 print $OUT "\n";
3440             }
3441         } ## end while (($term || &setterm...
3442
3443 =head3 POST-COMMAND PROCESSING
3444
3445 After each command, we check to see if the command output was piped anywhere.
3446 If so, we go through the necessary code to unhook the pipe and go back to
3447 our standard filehandles for input and output.
3448
3449 =cut
3450
3451         continue {    # CMD:
3452
3453             # At the end of every command:
3454             if ($piped) {
3455
3456                 # Unhook the pipe mechanism now.
3457                 if ( $pager =~ /^\|/ ) {
3458
3459                     # No error from the child.
3460                     $? = 0;
3461
3462                     # we cannot warn here: the handle is missing --tchrist
3463                     close(OUT) || print SAVEOUT "\nCan't close DB::OUT\n";
3464
3465                     # most of the $? crud was coping with broken cshisms
3466                     # $? is explicitly set to 0, so this never runs.
3467                     if ($?) {
3468                         print SAVEOUT "Pager '$pager' failed: ";
3469                         if ( $? == -1 ) {
3470                             print SAVEOUT "shell returned -1\n";
3471                         }
3472                         elsif ( $? >> 8 ) {
3473                             print SAVEOUT ( $? & 127 )
3474                               ? " (SIG#" . ( $? & 127 ) . ")"
3475                               : "", ( $? & 128 ) ? " -- core dumped" : "", "\n";
3476                         }
3477                         else {
3478                             print SAVEOUT "status ", ( $? >> 8 ), "\n";
3479                         }
3480                     } ## end if ($?)
3481
3482                     # Reopen filehandle for our output (if we can) and
3483                     # restore STDOUT (if we can).
3484                     open( OUT, ">&STDOUT" ) || &warn("Can't restore DB::OUT");
3485                     open( STDOUT, ">&SAVEOUT" )
3486                       || &warn("Can't restore STDOUT");
3487
3488                     # Turn off pipe exception handler if necessary.
3489                     $SIG{PIPE} = "DEFAULT" if $SIG{PIPE} eq \&DB::catch;
3490
3491                     # Will stop ignoring SIGPIPE if done like nohup(1)
3492                     # does SIGINT but Perl doesn't give us a choice.
3493                 } ## end if ($pager =~ /^\|/)
3494                 else {
3495
3496                     # Non-piped "pager". Just restore STDOUT.
3497                     open( OUT, ">&SAVEOUT" ) || &warn("Can't restore DB::OUT");
3498                 }
3499
3500                 # Close filehandle pager was using, restore the normal one
3501                 # if necessary,
3502                 close(SAVEOUT);
3503                 select($selected), $selected = "" unless $selected eq "";
3504
3505                 # No pipes now.
3506                 $piped = "";
3507             } ## end if ($piped)
3508         }    # CMD:
3509
3510 =head3 COMMAND LOOP TERMINATION
3511
3512 When commands have finished executing, we come here. If the user closed the
3513 input filehandle, we turn on C<$fall_off_end> to emulate a C<q> command. We
3514 evaluate any post-prompt items. We restore C<$@>, C<$!>, C<$^E>, C<$,>, C<$/>,
3515 C<$\>, and C<$^W>, and return a null list as expected by the Perl interpreter.
3516 The interpreter will then execute the next line and then return control to us
3517 again.
3518
3519 =cut
3520
3521         # No more commands? Quit.
3522         $fall_off_end = 1 unless defined $cmd;    # Emulate 'q' on EOF
3523
3524         # Evaluate post-prompt commands.
3525         foreach $evalarg (@$post) {
3526             &eval;
3527         }
3528     }    # if ($single || $signal)
3529
3530     # Put the user's globals back where you found them.
3531     ( $@, $!, $^E, $,, $/, $\, $^W ) = @saved;
3532     ();
3533 } ## end sub DB
3534
3535 # The following code may be executed now:
3536 # BEGIN {warn 4}
3537
3538 =head2 sub
3539
3540 C<sub> is called whenever a subroutine call happens in the program being
3541 debugged. The variable C<$DB::sub> contains the name of the subroutine
3542 being called.
3543
3544 The core function of this subroutine is to actually call the sub in the proper
3545 context, capturing its output. This of course causes C<DB::DB> to get called
3546 again, repeating until the subroutine ends and returns control to C<DB::sub>
3547 again. Once control returns, C<DB::sub> figures out whether or not to dump the
3548 return value, and returns its captured copy of the return value as its own
3549 return value. The value then feeds back into the program being debugged as if
3550 C<DB::sub> hadn't been there at all.
3551
3552 C<sub> does all the work of printing the subroutine entry and exit messages
3553 enabled by setting C<$frame>. It notes what sub the autoloader got called for,
3554 and also prints the return value if needed (for the C<r> command and if
3555 the 16 bit is set in C<$frame>).
3556
3557 It also tracks the subroutine call depth by saving the current setting of
3558 C<$single> in the C<@stack> package global; if this exceeds the value in
3559 C<$deep>, C<sub> automatically turns on printing of the current depth by
3560 setting the C<4> bit in C<$single>. In any case, it keeps the current setting
3561 of stop/don't stop on entry to subs set as it currently is set.
3562
3563 =head3 C<caller()> support
3564
3565 If C<caller()> is called from the package C<DB>, it provides some
3566 additional data, in the following order:
3567
3568 =over 4
3569
3570 =item * C<$package>
3571
3572 The package name the sub was in
3573
3574 =item * C<$filename>
3575
3576 The filename it was defined in
3577
3578 =item * C<$line>
3579
3580 The line number it was defined on
3581
3582 =item * C<$subroutine>
3583
3584 The subroutine name; C<(eval)> if an C<eval>().
3585
3586 =item * C<$hasargs>
3587
3588 1 if it has arguments, 0 if not
3589
3590 =item * C<$wantarray>
3591
3592 1 if array context, 0 if scalar context
3593
3594 =item * C<$evaltext>
3595
3596 The C<eval>() text, if any (undefined for C<eval BLOCK>)
3597
3598 =item * C<$is_require>
3599
3600 frame was created by a C<use> or C<require> statement
3601
3602 =item * C<$hints>
3603
3604 pragma information; subject to change between versions
3605
3606 =item * C<$bitmask>
3607
3608 pragma information; subject to change between versions
3609
3610 =item * C<@DB::args>
3611
3612 arguments with which the subroutine was invoked
3613
3614 =back
3615
3616 =cut
3617
3618 use vars qw($deep);
3619
3620 # We need to fully qualify the name ("DB::sub") to make "use strict;"
3621 # happy. -- Shlomi Fish
3622 sub DB::sub {
3623         # Do not use a regex in this subroutine -> results in corrupted memory
3624         # See: [perl #66110]
3625
3626         # lock ourselves under threads
3627         lock($DBGR);
3628
3629     # Whether or not the autoloader was running, a scalar to put the
3630     # sub's return value in (if needed), and an array to put the sub's
3631     # return value in (if needed).
3632     my ( $al, $ret, @ret ) = "";
3633         if ($sub eq 'threads::new' && $ENV{PERL5DB_THREADED}) {
3634                 print "creating new thread\n";
3635         }
3636
3637     # If the last ten characters are '::AUTOLOAD', note we've traced
3638     # into AUTOLOAD for $sub.
3639     if ( length($sub) > 10 && substr( $sub, -10, 10 ) eq '::AUTOLOAD' ) {
3640         no strict 'refs';
3641         $al = " for $$sub" if defined $$sub;
3642     }
3643
3644     # We stack the stack pointer and then increment it to protect us
3645     # from a situation that might unwind a whole bunch of call frames
3646     # at once. Localizing the stack pointer means that it will automatically
3647     # unwind the same amount when multiple stack frames are unwound.
3648     local $stack_depth = $stack_depth + 1;    # Protect from non-local exits
3649
3650     # Expand @stack.
3651     $#stack = $stack_depth;
3652
3653     # Save current single-step setting.
3654     $stack[-1] = $single;
3655
3656     # Turn off all flags except single-stepping.
3657     $single &= 1;
3658
3659     # If we've gotten really deeply recursed, turn on the flag that will
3660     # make us stop with the 'deep recursion' message.
3661     $single |= 4 if $stack_depth == $deep;
3662
3663     # If frame messages are on ...
3664     (
3665         $frame & 4    # Extended frame entry message
3666         ? (
3667             print_lineinfo( ' ' x ( $stack_depth - 1 ), "in  " ),
3668
3669             # Why -1? But it works! :-(
3670             # Because print_trace will call add 1 to it and then call
3671             # dump_trace; this results in our skipping -1+1 = 0 stack frames
3672             # in dump_trace.
3673             print_trace( $LINEINFO, -1, 1, 1, "$sub$al" )
3674           )
3675         : print_lineinfo( ' ' x ( $stack_depth - 1 ), "entering $sub$al\n" )
3676
3677           # standard frame entry message
3678       )
3679       if $frame;
3680
3681     # Determine the sub's return type, and capture appropriately.
3682     if (wantarray) {
3683
3684         # Called in array context. call sub and capture output.
3685         # DB::DB will recursively get control again if appropriate; we'll come
3686         # back here when the sub is finished.
3687         {
3688             no strict 'refs';
3689             @ret = &$sub;
3690         }
3691
3692         # Pop the single-step value back off the stack.
3693         $single |= $stack[ $stack_depth-- ];
3694
3695         # Check for exit trace messages...
3696         (
3697             $frame & 4    # Extended exit message
3698             ? (
3699                 print_lineinfo( ' ' x $stack_depth, "out " ),
3700                 print_trace( $LINEINFO, -1, 1, 1, "$sub$al" )
3701               )
3702             : print_lineinfo( ' ' x $stack_depth, "exited $sub$al\n" )
3703
3704               # Standard exit message
3705           )
3706           if $frame & 2;
3707
3708         # Print the return info if we need to.
3709         if ( $doret eq $stack_depth or $frame & 16 ) {
3710
3711             # Turn off output record separator.
3712             local $\ = '';
3713             my $fh = ( $doret eq $stack_depth ? $OUT : $LINEINFO );
3714
3715             # Indent if we're printing because of $frame tracing.
3716             print $fh ' ' x $stack_depth if $frame & 16;
3717
3718             # Print the return value.
3719             print $fh "list context return from $sub:\n";
3720             dumpit( $fh, \@ret );
3721
3722             # And don't print it again.
3723             $doret = -2;
3724         } ## end if ($doret eq $stack_depth...
3725             # And we have to return the return value now.
3726         @ret;
3727     } ## end if (wantarray)
3728
3729     # Scalar context.
3730     else {
3731         if ( defined wantarray ) {
3732         no strict 'refs';
3733             # Save the value if it's wanted at all.
3734             $ret = &$sub;
3735         }
3736         else {
3737         no strict 'refs';
3738             # Void return, explicitly.
3739             &$sub;
3740             undef $ret;
3741         }
3742
3743         # Pop the single-step value off the stack.
3744         $single |= $stack[ $stack_depth-- ];
3745
3746         # If we're doing exit messages...
3747         (
3748             $frame & 4    # Extended messages
3749             ? (
3750                 print_lineinfo( ' ' x $stack_depth, "out " ),
3751                 print_trace( $LINEINFO, -1, 1, 1, "$sub$al" )
3752               )
3753             : print_lineinfo( ' ' x $stack_depth, "exited $sub$al\n" )
3754
3755               # Standard messages
3756           )
3757           if $frame & 2;
3758
3759         # If we are supposed to show the return value... same as before.
3760         if ( $doret eq $stack_depth or $frame & 16 and defined wantarray ) {
3761             local $\ = '';
3762             my $fh = ( $doret eq $stack_depth ? $OUT : $LINEINFO );
3763             print $fh ( ' ' x $stack_depth ) if $frame & 16;
3764             print $fh (
3765                 defined wantarray
3766                 ? "scalar context return from $sub: "
3767                 : "void context return from $sub\n"
3768             );
3769             dumpit( $fh, $ret ) if defined wantarray;
3770             $doret = -2;
3771         } ## end if ($doret eq $stack_depth...
3772
3773         # Return the appropriate scalar value.
3774         $ret;
3775     } ## end else [ if (wantarray)
3776 } ## end sub _sub
3777
3778 sub lsub : lvalue {
3779
3780     no strict 'refs';
3781
3782         # lock ourselves under threads
3783         lock($DBGR);
3784
3785     # Whether or not the autoloader was running, a scalar to put the
3786     # sub's return value in (if needed), and an array to put the sub's
3787     # return value in (if needed).
3788     my ( $al, $ret, @ret ) = "";
3789         if ($sub =~ /^threads::new$/ && $ENV{PERL5DB_THREADED}) {
3790                 print "creating new thread\n";
3791         }
3792
3793     # If the last ten characters are C'::AUTOLOAD', note we've traced
3794     # into AUTOLOAD for $sub.
3795     if ( length($sub) > 10 && substr( $sub, -10, 10 ) eq '::AUTOLOAD' ) {
3796         $al = " for $$sub";
3797     }
3798
3799     # We stack the stack pointer and then increment it to protect us
3800     # from a situation that might unwind a whole bunch of call frames
3801     # at once. Localizing the stack pointer means that it will automatically
3802     # unwind the same amount when multiple stack frames are unwound.
3803     local $stack_depth = $stack_depth + 1;    # Protect from non-local exits
3804
3805     # Expand @stack.
3806     $#stack = $stack_depth;
3807
3808     # Save current single-step setting.
3809     $stack[-1] = $single;
3810
3811     # Turn off all flags except single-stepping.
3812     $single &= 1;
3813
3814     # If we've gotten really deeply recursed, turn on the flag that will
3815     # make us stop with the 'deep recursion' message.
3816     $single |= 4 if $stack_depth == $deep;
3817
3818     # If frame messages are on ...
3819     (
3820         $frame & 4    # Extended frame entry message
3821         ? (
3822             print_lineinfo( ' ' x ( $stack_depth - 1 ), "in  " ),
3823
3824             # Why -1? But it works! :-(
3825             # Because print_trace will call add 1 to it and then call
3826             # dump_trace; this results in our skipping -1+1 = 0 stack frames
3827             # in dump_trace.
3828             print_trace( $LINEINFO, -1, 1, 1, "$sub$al" )
3829           )
3830         : print_lineinfo( ' ' x ( $stack_depth - 1 ), "entering $sub$al\n" )
3831
3832           # standard frame entry message
3833       )
3834       if $frame;
3835
3836     # Pop the single-step value back off the stack.
3837     $single |= $stack[ $stack_depth-- ];
3838
3839     # call the original lvalue sub.
3840     &$sub;
3841 }
3842
3843 # Abstracting common code from multiple places elsewhere:
3844 sub depth_print_lineinfo {
3845     my $always_print = shift;
3846
3847     print_lineinfo( @_ ) if ($always_print or $stack_depth < $trace_to_depth);
3848 }
3849
3850 =head1 EXTENDED COMMAND HANDLING AND THE COMMAND API
3851
3852 In Perl 5.8.0, there was a major realignment of the commands and what they did,
3853 Most of the changes were to systematize the command structure and to eliminate
3854 commands that threw away user input without checking.
3855
3856 The following sections describe the code added to make it easy to support
3857 multiple command sets with conflicting command names. This section is a start
3858 at unifying all command processing to make it simpler to develop commands.
3859
3860 Note that all the cmd_[a-zA-Z] subroutines require the command name, a line
3861 number, and C<$dbline> (the current line) as arguments.
3862
3863 Support functions in this section which have multiple modes of failure C<die>
3864 on error; the rest simply return a false value.
3865
3866 The user-interface functions (all of the C<cmd_*> functions) just output
3867 error messages.
3868
3869 =head2 C<%set>
3870
3871 The C<%set> hash defines the mapping from command letter to subroutine
3872 name suffix.
3873
3874 C<%set> is a two-level hash, indexed by set name and then by command name.
3875 Note that trying to set the CommandSet to C<foobar> simply results in the
3876 5.8.0 command set being used, since there's no top-level entry for C<foobar>.
3877
3878 =cut
3879
3880 ### The API section
3881
3882 my %set = (    #
3883     'pre580' => {
3884         'a' => 'pre580_a',
3885         'A' => 'pre580_null',
3886         'b' => 'pre580_b',
3887         'B' => 'pre580_null',
3888         'd' => 'pre580_null',
3889         'D' => 'pre580_D',
3890         'h' => 'pre580_h',
3891         'M' => 'pre580_null',
3892         'O' => 'o',
3893         'o' => 'pre580_null',
3894         'v' => 'M',
3895         'w' => 'v',
3896         'W' => 'pre580_W',
3897     },
3898     'pre590' => {
3899         '<'  => 'pre590_prepost',
3900         '<<' => 'pre590_prepost',
3901         '>'  => 'pre590_prepost',
3902         '>>' => 'pre590_prepost',
3903         '{'  => 'pre590_prepost',
3904         '{{' => 'pre590_prepost',
3905     },
3906 );
3907
3908 my %breakpoints_data;
3909
3910 sub _has_breakpoint_data_ref {
3911     my ($filename, $line) = @_;
3912
3913     return (
3914         exists( $breakpoints_data{$filename} )
3915             and
3916         exists( $breakpoints_data{$filename}{$line} )
3917     );
3918 }
3919
3920 sub _get_breakpoint_data_ref {
3921     my ($filename, $line) = @_;
3922
3923     return ($breakpoints_data{$filename}{$line} ||= +{});
3924 }
3925
3926 sub _delete_breakpoint_data_ref {
3927     my ($filename, $line) = @_;
3928
3929     delete($breakpoints_data{$filename}{$line});
3930     if (! scalar(keys( %{$breakpoints_data{$filename}} )) ) {
3931         delete($breakpoints_data{$filename});
3932     }
3933
3934     return;
3935 }
3936
3937 sub _set_breakpoint_enabled_status {
3938     my ($filename, $line, $status) = @_;
3939
3940     _get_breakpoint_data_ref($filename, $line)->{'enabled'} =
3941         ($status ? 1 : '')
3942         ;
3943
3944     return;
3945 }
3946
3947 sub _enable_breakpoint_temp_enabled_status {
3948     my ($filename, $line) = @_;
3949
3950     _get_breakpoint_data_ref($filename, $line)->{'temp_enabled'} = 1;
3951
3952     return;
3953 }
3954
3955 sub _cancel_breakpoint_temp_enabled_status {
3956     my ($filename, $line) = @_;
3957
3958     my $ref = _get_breakpoint_data_ref($filename, $line);
3959
3960     delete ($ref->{'temp_enabled'});
3961
3962     if (! %$ref) {
3963         _delete_breakpoint_data_ref($filename, $line);
3964     }
3965
3966     return;
3967 }
3968
3969 sub _is_breakpoint_enabled {
3970     my ($filename, $line) = @_;
3971
3972     my $data_ref = _get_breakpoint_data_ref($filename, $line);
3973     return ($data_ref->{'enabled'} || $data_ref->{'temp_enabled'});
3974 }
3975
3976 =head2 C<cmd_wrapper()> (API)
3977
3978 C<cmd_wrapper()> allows the debugger to switch command sets
3979 depending on the value of the C<CommandSet> option.
3980
3981 It tries to look up the command in the C<%set> package-level I<lexical>
3982 (which means external entities can't fiddle with it) and create the name of
3983 the sub to call based on the value found in the hash (if it's there). I<All>
3984 of the commands to be handled in a set have to be added to C<%set>; if they
3985 aren't found, the 5.8.0 equivalent is called (if there is one).
3986
3987 This code uses symbolic references.
3988
3989 =cut
3990
3991 sub cmd_wrapper {
3992     my $cmd      = shift;
3993     my $line     = shift;
3994     my $dblineno = shift;
3995
3996     # Assemble the command subroutine's name by looking up the
3997     # command set and command name in %set. If we can't find it,
3998     # default to the older version of the command.
3999     my $call = 'cmd_'
4000       . ( $set{$CommandSet}{$cmd}
4001           || ( $cmd =~ /^[<>{]+/o ? 'prepost' : $cmd ) );
4002
4003     # Call the command subroutine, call it by name.
4004     return __PACKAGE__->can($call)->( $cmd, $line, $dblineno );
4005 } ## end sub cmd_wrapper
4006
4007 =head3 C<cmd_a> (command)
4008
4009 The C<a> command handles pre-execution actions. These are associated with a
4010 particular line, so they're stored in C<%dbline>. We default to the current
4011 line if none is specified.
4012
4013 =cut
4014
4015 sub cmd_a {
4016     my $cmd    = shift;
4017     my $line   = shift || '';    # [.|line] expr
4018     my $dbline = shift;
4019
4020     # If it's dot (here), or not all digits,  use the current line.
4021     $line =~ s/^(\.|(?:[^\d]))/$dbline/;
4022
4023     # Should be a line number followed by an expression.
4024     if ( $line =~ /^\s*(\d*)\s*(\S.+)/ ) {
4025         my ( $lineno, $expr ) = ( $1, $2 );
4026
4027         # If we have an expression ...
4028         if ( length $expr ) {
4029
4030             # ... but the line isn't breakable, complain.
4031             if ( $dbline[$lineno] == 0 ) {
4032                 print $OUT
4033                   "Line $lineno($dbline[$lineno]) does not have an action?\n";
4034             }
4035             else {
4036
4037                 # It's executable. Record that the line has an action.
4038                 $had_breakpoints{$filename} |= 2;
4039
4040                 # Remove any action, temp breakpoint, etc.
4041                 $dbline{$lineno} =~ s/\0[^\0]*//;
4042
4043                 # Add the action to the line.
4044                 $dbline{$lineno} .= "\0" . action($expr);
4045
4046                 _set_breakpoint_enabled_status($filename, $lineno, 1);
4047             }
4048         } ## end if (length $expr)
4049     } ## end if ($line =~ /^\s*(\d*)\s*(\S.+)/)
4050     else {
4051
4052         # Syntax wrong.
4053         print $OUT
4054           "Adding an action requires an optional lineno and an expression\n"
4055           ;    # hint
4056     }
4057 } ## end sub cmd_a
4058
4059 =head3 C<cmd_A> (command)
4060
4061 Delete actions. Similar to above, except the delete code is in a separate
4062 subroutine, C<delete_action>.
4063
4064 =cut
4065
4066 sub cmd_A {
4067     my $cmd    = shift;
4068     my $line   = shift || '';
4069     my $dbline = shift;
4070
4071     # Dot is this line.
4072     $line =~ s/^\./$dbline/;
4073
4074     # Call delete_action with a null param to delete them all.
4075     # The '1' forces the eval to be true. It'll be false only
4076     # if delete_action blows up for some reason, in which case
4077     # we print $@ and get out.
4078     if ( $line eq '*' ) {
4079         eval { &delete_action(); 1 } or print $OUT $@ and return;
4080     }
4081
4082     # There's a real line  number. Pass it to delete_action.
4083     # Error trapping is as above.
4084     elsif ( $line =~ /^(\S.*)/ ) {
4085         eval { &delete_action($1); 1 } or print $OUT $@ and return;
4086     }
4087
4088     # Swing and a miss. Bad syntax.
4089     else {
4090         print $OUT
4091           "Deleting an action requires a line number, or '*' for all\n" ; # hint
4092     }
4093 } ## end sub cmd_A
4094
4095 =head3 C<delete_action> (API)
4096
4097 C<delete_action> accepts either a line number or C<undef>. If a line number
4098 is specified, we check for the line being executable (if it's not, it
4099 couldn't have had an  action). If it is, we just take the action off (this
4100 will get any kind of an action, including breakpoints).
4101
4102 =cut
4103
4104 sub delete_action {
4105     my $i = shift;
4106     if ( defined($i) ) {
4107
4108         # Can there be one?
4109         die "Line $i has no action .\n" if $dbline[$i] == 0;
4110
4111         # Nuke whatever's there.
4112         $dbline{$i} =~ s/\0[^\0]*//;    # \^a
4113         delete $dbline{$i} if $dbline{$i} eq '';
4114     }
4115     else {
4116         print $OUT "Deleting all actions...\n";
4117         for my $file ( keys %had_breakpoints ) {
4118             local *dbline = $main::{ '_<' . $file };
4119             $max = $#dbline;
4120             my $was;
4121             for $i (1 .. $max) {
4122                 if ( defined $dbline{$i} ) {
4123                     $dbline{$i} =~ s/\0[^\0]*//;
4124                     delete $dbline{$i} if $dbline{$i} eq '';
4125                 }
4126                 unless ( $had_breakpoints{$file} &= ~2 ) {
4127                     delete $had_breakpoints{$file};
4128                 }
4129             } ## end for ($i = 1 .. $max)
4130         } ## end for my $file (keys %had_breakpoints)
4131     } ## end else [ if (defined($i))
4132 } ## end sub delete_action
4133
4134 =head3 C<cmd_b> (command)
4135
4136 Set breakpoints. Since breakpoints can be set in so many places, in so many
4137 ways, conditionally or not, the breakpoint code is kind of complex. Mostly,
4138 we try to parse the command type, and then shuttle it off to an appropriate
4139 subroutine to actually do the work of setting the breakpoint in the right
4140 place.
4141
4142 =cut
4143
4144 sub cmd_b {
4145     my $cmd    = shift;
4146     my $line   = shift;    # [.|line] [cond]
4147     my $dbline = shift;
4148
4149     # Make . the current line number if it's there..
4150     $line =~ s/^\.(\s|\z)/$dbline$1/;
4151
4152     # No line number, no condition. Simple break on current line.
4153     if ( $line =~ /^\s*$/ ) {
4154         &cmd_b_line( $dbline, 1 );
4155     }
4156
4157     # Break on load for a file.
4158     elsif ( $line =~ /^load\b\s*(.*)/ ) {
4159         my $file = $1;
4160         $file =~ s/\s+$//;
4161         &cmd_b_load($file);
4162     }
4163
4164     # b compile|postpone <some sub> [<condition>]
4165     # The interpreter actually traps this one for us; we just put the
4166     # necessary condition in the %postponed hash.
4167     elsif ( $line =~ /^(postpone|compile)\b\s*([':A-Za-z_][':\w]*)\s*(.*)/ ) {
4168
4169         # Capture the condition if there is one. Make it true if none.
4170         my $cond = length $3 ? $3 : '1';
4171
4172         # Save the sub name and set $break to 1 if $1 was 'postpone', 0
4173         # if it was 'compile'.
4174         my ( $subname, $break ) = ( $2, $1 eq 'postpone' );
4175
4176         # De-Perl4-ify the name - ' separators to ::.
4177         $subname =~ s/\'/::/g;
4178
4179         # Qualify it into the current package unless it's already qualified.
4180         $subname = "${package}::" . $subname unless $subname =~ /::/;
4181
4182         # Add main if it starts with ::.
4183         $subname = "main" . $subname if substr( $subname, 0, 2 ) eq "::";
4184
4185         # Save the break type for this sub.
4186         $postponed{$subname} = $break ? "break +0 if $cond" : "compile";
4187     } ## end elsif ($line =~ ...
4188     # b <filename>:<line> [<condition>]
4189     elsif ($line =~ /\A(\S+[^:]):(\d+)\s*(.*)/ms) {
4190         my ($filename, $line_num, $cond) = ($1, $2, $3);
4191         cmd_b_filename_line(
4192             $filename,
4193             $line_num,
4194             (length($cond) ? $cond : '1'),
4195         );
4196     }
4197     # b <sub name> [<condition>]
4198     elsif ( $line =~ /^([':A-Za-z_][':\w]*(?:\[.*\])?)\s*(.*)/ ) {
4199
4200         #
4201         $subname = $1;
4202         my $cond = length $2 ? $2 : '1';
4203         &cmd_b_sub( $subname, $cond );
4204     }
4205
4206     # b <line> [<condition>].
4207     elsif ( $line =~ /^(\d*)\s*(.*)/ ) {
4208
4209         # Capture the line. If none, it's the current line.
4210         $line = $1 || $dbline;
4211
4212         # If there's no condition, make it '1'.
4213         my $cond = length $2 ? $2 : '1';
4214
4215         # Break on line.
4216         &cmd_b_line( $line, $cond );
4217     }
4218
4219     # Line didn't make sense.
4220     else {
4221         print "confused by line($line)?\n";
4222     }
4223 } ## end sub cmd_b
4224
4225 =head3 C<break_on_load> (API)
4226
4227 We want to break when this file is loaded. Mark this file in the
4228 C<%break_on_load> hash, and note that it has a breakpoint in
4229 C<%had_breakpoints>.
4230
4231 =cut
4232
4233 sub break_on_load {
4234     my $file = shift;
4235     $break_on_load{$file} = 1;
4236     $had_breakpoints{$file} |= 1;
4237 }
4238
4239 =head3 C<report_break_on_load> (API)
4240
4241 Gives us an array of filenames that are set to break on load. Note that
4242 only files with break-on-load are in here, so simply showing the keys
4243 suffices.
4244
4245 =cut
4246
4247 sub report_break_on_load {
4248     sort keys %break_on_load;
4249 }
4250
4251 =head3 C<cmd_b_load> (command)
4252
4253 We take the file passed in and try to find it in C<%INC> (which maps modules
4254 to files they came from). We mark those files for break-on-load via
4255 C<break_on_load> and then report that it was done.
4256
4257 =cut
4258
4259 sub cmd_b_load {
4260     my $file = shift;
4261     my @files;
4262
4263     # This is a block because that way we can use a redo inside it
4264     # even without there being any looping structure at all outside it.
4265     {
4266
4267         # Save short name and full path if found.
4268         push @files, $file;
4269         push @files, $::INC{$file} if $::INC{$file};
4270
4271         # Tack on .pm and do it again unless there was a '.' in the name
4272         # already.
4273         $file .= '.pm', redo unless $file =~ /\./;
4274     }
4275
4276     # Do the real work here.
4277     break_on_load($_) for @files;
4278
4279     # All the files that have break-on-load breakpoints.
4280     @files = report_break_on_load;
4281
4282     # Normalize for the purposes of our printing this.
4283     local $\ = '';
4284     local $" = ' ';
4285     print $OUT "Will stop on load of '@files'.\n";
4286 } ## end sub cmd_b_load
4287
4288 =head3 C<$filename_error> (API package global)
4289
4290 Several of the functions we need to implement in the API need to work both
4291 on the current file and on other files. We don't want to duplicate code, so
4292 C<$filename_error> is used to contain the name of the file that's being
4293 worked on (if it's not the current one).
4294
4295 We can now build functions in pairs: the basic function works on the current
4296 file, and uses C<$filename_error> as part of its error message. Since this is
4297 initialized to C<"">, no filename will appear when we are working on the
4298 current file.
4299
4300 The second function is a wrapper which does the following:
4301
4302 =over 4
4303
4304 =item *
4305
4306 Localizes C<$filename_error> and sets it to the name of the file to be processed.
4307
4308 =item *
4309
4310 Localizes the C<*dbline> glob and reassigns it to point to the file we want to process.
4311
4312 =item *
4313
4314 Calls the first function.
4315
4316 The first function works on the I<current> file (i.e., the one we changed to),
4317 and prints C<$filename_error> in the error message (the name of the other file)
4318 if it needs to. When the functions return, C<*dbline> is restored to point
4319 to the actual current file (the one we're executing in) and
4320 C<$filename_error> is restored to C<"">. This restores everything to
4321 the way it was before the second function was called at all.
4322
4323 See the comments in C<breakable_line> and C<breakable_line_in_file> for more
4324 details.
4325
4326 =back
4327
4328 =cut
4329
4330 use vars qw($filename_error);
4331 $filename_error = '';
4332
4333 =head3 breakable_line(from, to) (API)
4334
4335 The subroutine decides whether or not a line in the current file is breakable.
4336 It walks through C<@dbline> within the range of lines specified, looking for
4337 the first line that is breakable.
4338
4339 If C<$to> is greater than C<$from>, the search moves forwards, finding the
4340 first line I<after> C<$to> that's breakable, if there is one.
4341
4342 If C<$from> is greater than C<$to>, the search goes I<backwards>, finding the
4343 first line I<before> C<$to> that's breakable, if there is one.
4344
4345 =cut
4346
4347 sub breakable_line {
4348
4349     my ( $from, $to ) = @_;
4350
4351     # $i is the start point. (Where are the FORTRAN programs of yesteryear?)
4352     my $i = $from;
4353
4354     # If there are at least 2 arguments, we're trying to search a range.
4355     if ( @_ >= 2 ) {
4356
4357         # $delta is positive for a forward search, negative for a backward one.
4358         my $delta = $from < $to ? +1 : -1;
4359
4360         # Keep us from running off the ends of the file.
4361         my $limit = $delta > 0 ? $#dbline : 1;
4362
4363         # Clever test. If you're a mathematician, it's obvious why this
4364         # test works. If not:
4365         # If $delta is positive (going forward), $limit will be $#dbline.
4366         #    If $to is less than $limit, ($limit - $to) will be positive, times
4367         #    $delta of 1 (positive), so the result is > 0 and we should use $to
4368         #    as the stopping point.
4369         #
4370         #    If $to is greater than $limit, ($limit - $to) is negative,
4371         #    times $delta of 1 (positive), so the result is < 0 and we should
4372         #    use $limit ($#dbline) as the stopping point.
4373         #
4374         # If $delta is negative (going backward), $limit will be 1.
4375         #    If $to is zero, ($limit - $to) will be 1, times $delta of -1
4376         #    (negative) so the result is > 0, and we use $to as the stopping
4377         #    point.
4378         #
4379         #    If $to is less than zero, ($limit - $to) will be positive,
4380         #    times $delta of -1 (negative), so the result is not > 0, and
4381         #    we use $limit (1) as the stopping point.
4382         #
4383         #    If $to is 1, ($limit - $to) will zero, times $delta of -1
4384         #    (negative), still giving zero; the result is not > 0, and
4385         #    we use $limit (1) as the stopping point.
4386         #
4387         #    if $to is >1, ($limit - $to) will be negative, times $delta of -1
4388         #    (negative), giving a positive (>0) value, so we'll set $limit to
4389         #    $to.
4390
4391         $limit = $to if ( $limit - $to ) * $delta > 0;
4392
4393         # The real search loop.
4394         # $i starts at $from (the point we want to start searching from).
4395         # We move through @dbline in the appropriate direction (determined
4396         # by $delta: either -1 (back) or +1 (ahead).
4397         # We stay in as long as we haven't hit an executable line
4398         # ($dbline[$i] == 0 means not executable) and we haven't reached
4399         # the limit yet (test similar to the above).
4400         $i += $delta while $dbline[$i] == 0 and ( $limit - $i ) * $delta > 0;
4401
4402     } ## end if (@_ >= 2)
4403
4404     # If $i points to a line that is executable, return that.
4405     return $i unless $dbline[$i] == 0;
4406
4407     # Format the message and print it: no breakable lines in range.
4408     my ( $pl, $upto ) = ( '', '' );
4409     ( $pl, $upto ) = ( 's', "..$to" ) if @_ >= 2 and $from != $to;
4410
4411     # If there's a filename in filename_error, we'll see it.
4412     # If not, not.
4413     die "Line$pl $from$upto$filename_error not breakable\n";
4414 } ## end sub breakable_line
4415
4416 =head3 breakable_line_in_filename(file, from, to) (API)
4417
4418 Like C<breakable_line>, but look in another file.
4419
4420 =cut
4421
4422 sub breakable_line_in_filename {
4423
4424     # Capture the file name.
4425     my ($f) = shift;
4426
4427     # Swap the magic line array over there temporarily.
4428     local *dbline = $main::{ '_<' . $f };
4429
4430     # If there's an error, it's in this other file.
4431     local $filename_error = " of '$f'";
4432
4433     # Find the breakable line.
4434     breakable_line(@_);
4435
4436     # *dbline and $filename_error get restored when this block ends.
4437
4438 } ## end sub breakable_line_in_filename
4439
4440 =head3 break_on_line(lineno, [condition]) (API)
4441
4442 Adds a breakpoint with the specified condition (or 1 if no condition was
4443 specified) to the specified line. Dies if it can't.
4444
4445 =cut
4446
4447 sub break_on_line {
4448     my ( $i, $cond ) = @_;
4449
4450     # Always true if no condition supplied.
4451     $cond = 1 unless @_ >= 2;
4452
4453     my $inii  = $i;
4454     my $after = '';
4455     my $pl    = '';
4456
4457     # Woops, not a breakable line. $filename_error allows us to say
4458     # if it was in a different file.
4459     die "Line $i$filename_error not breakable.\n" if $dbline[$i] == 0;
4460
4461     # Mark this file as having breakpoints in it.
4462     $had_breakpoints{$filename} |= 1;
4463
4464     # If there is an action or condition here already ...
4465     if ( $dbline{$i} ) {
4466
4467         # ... swap this condition for the existing one.
4468         $dbline{$i} =~ s/^[^\0]*/$cond/;
4469     }
4470     else {
4471
4472         # Nothing here - just add the condition.
4473         $dbline{$i} = $cond;
4474
4475         _set_breakpoint_enabled_status($filename, $i, 1);
4476     }
4477 } ## end sub break_on_line
4478
4479 =head3 cmd_b_line(line, [condition]) (command)
4480
4481 Wrapper for C<break_on_line>. Prints the failure message if it
4482 doesn't work.
4483
4484 =cut
4485
4486 sub cmd_b_line {
4487     if (not eval { break_on_line(@_); 1 }) {
4488         local $\ = '';
4489         print $OUT $@ and return;
4490     }
4491
4492     return;
4493 } ## end sub cmd_b_line
4494
4495 =head3 cmd_b_filename_line(line, [condition]) (command)
4496
4497 Wrapper for C<break_on_filename_line>. Prints the failure message if it
4498 doesn't work.
4499
4500 =cut
4501
4502 sub cmd_b_filename_line {
4503     if (not eval { break_on_filename_line(@_); 1 }) {
4504         local $\ = '';
4505         print $OUT $@ and return;
4506     }
4507
4508     return;
4509 }
4510
4511 =head3 break_on_filename_line(file, line, [condition]) (API)
4512
4513 Switches to the file specified and then calls C<break_on_line> to set
4514 the breakpoint.
4515
4516 =cut
4517
4518 sub break_on_filename_line {
4519     my ( $f, $i, $cond ) = @_;
4520
4521     # Always true if condition left off.
4522     $cond = 1 unless @_ >= 3;
4523
4524     # Switch the magical hash temporarily.
4525     local *dbline = $main::{ '_<' . $f };
4526
4527     # Localize the variables that break_on_line uses to make its message.
4528     local $filename_error = " of '$f'";
4529   &nb