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