Avoid deprecation message.
[perl.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 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 use Cwd ();
516
517 my $_initial_cwd;
518
519 BEGIN {eval 'use IO::Handle'}; # Needed for flush only? breaks under miniperl
520
521 BEGIN {
522     require feature;
523     $^V =~ /^v(\d+\.\d+)/;
524     feature->import(":$1");
525     $_initial_cwd = Cwd::getcwd();
526 }
527
528 # Debugger for Perl 5.00x; perl5db.pl patch level:
529 use vars qw($VERSION $header);
530
531 # bump to X.XX in blead, only use X.XX_XX in maint
532 $VERSION = '1.51';
533
534 $header = "perl5db.pl version $VERSION";
535
536 =head1 DEBUGGER ROUTINES
537
538 =head2 C<DB::eval()>
539
540 This function replaces straight C<eval()> inside the debugger; it simplifies
541 the process of evaluating code in the user's context.
542
543 The code to be evaluated is passed via the package global variable
544 C<$DB::evalarg>; this is done to avoid fiddling with the contents of C<@_>.
545
546 Before we do the C<eval()>, we preserve the current settings of C<$trace>,
547 C<$single>, C<$^D> and C<$usercontext>.  The latter contains the
548 preserved values of C<$@>, C<$!>, C<$^E>, C<$,>, C<$/>, C<$\>, C<$^W> and the
549 user's current package, grabbed when C<DB::DB> got control.  This causes the
550 proper context to be used when the eval is actually done.  Afterward, we
551 restore C<$trace>, C<$single>, and C<$^D>.
552
553 Next we need to handle C<$@> without getting confused. We save C<$@> in a
554 local lexical, localize C<$saved[0]> (which is where C<save()> will put
555 C<$@>), and then call C<save()> to capture C<$@>, C<$!>, C<$^E>, C<$,>,
556 C<$/>, C<$\>, and C<$^W>) and set C<$,>, C<$/>, C<$\>, and C<$^W> to values
557 considered sane by the debugger. If there was an C<eval()> error, we print
558 it on the debugger's output. If C<$onetimedump> is defined, we call
559 C<dumpit> if it's set to 'dump', or C<methods> if it's set to
560 'methods'. Setting it to something else causes the debugger to do the eval
561 but not print the result - handy if you want to do something else with it
562 (the "watch expressions" code does this to get the value of the watch
563 expression but not show it unless it matters).
564
565 In any case, we then return the list of output from C<eval> to the caller,
566 and unwinding restores the former version of C<$@> in C<@saved> as well
567 (the localization of C<$saved[0]> goes away at the end of this scope).
568
569 =head3 Parameters and variables influencing execution of DB::eval()
570
571 C<DB::eval> isn't parameterized in the standard way; this is to keep the
572 debugger's calls to C<DB::eval()> from mucking with C<@_>, among other things.
573 The variables listed below influence C<DB::eval()>'s execution directly.
574
575 =over 4
576
577 =item C<$evalarg> - the thing to actually be eval'ed
578
579 =item C<$trace> - Current state of execution tracing
580
581 =item C<$single> - Current state of single-stepping
582
583 =item C<$onetimeDump> - what is to be displayed after the evaluation
584
585 =item C<$onetimeDumpDepth> - how deep C<dumpit()> should go when dumping results
586
587 =back
588
589 The following variables are altered by C<DB::eval()> during its execution. They
590 are "stacked" via C<local()>, enabling recursive calls to C<DB::eval()>.
591
592 =over 4
593
594 =item C<@res> - used to capture output from actual C<eval>.
595
596 =item C<$otrace> - saved value of C<$trace>.
597
598 =item C<$osingle> - saved value of C<$single>.
599
600 =item C<$od> - saved value of C<$^D>.
601
602 =item C<$saved[0]> - saved value of C<$@>.
603
604 =item $\ - for output of C<$@> if there is an evaluation error.
605
606 =back
607
608 =head3 The problem of lexicals
609
610 The context of C<DB::eval()> presents us with some problems. Obviously,
611 we want to be 'sandboxed' away from the debugger's internals when we do
612 the eval, but we need some way to control how punctuation variables and
613 debugger globals are used.
614
615 We can't use local, because the code inside C<DB::eval> can see localized
616 variables; and we can't use C<my> either for the same reason. The code
617 in this routine compromises and uses C<my>.
618
619 After this routine is over, we don't have user code executing in the debugger's
620 context, so we can use C<my> freely.
621
622 =cut
623
624 ############################################## Begin lexical danger zone
625
626 # 'my' variables used here could leak into (that is, be visible in)
627 # the context that the code being evaluated is executing in. This means that
628 # the code could modify the debugger's variables.
629 #
630 # Fiddling with the debugger's context could be Bad. We insulate things as
631 # much as we can.
632
633 use vars qw(
634     @args
635     %break_on_load
636     $CommandSet
637     $CreateTTY
638     $DBGR
639     @dbline
640     $dbline
641     %dbline
642     $dieLevel
643     $filename
644     $histfile
645     $histsize
646     $IN
647     $inhibit_exit
648     @ini_INC
649     $ini_warn
650     $maxtrace
651     $od
652     @options
653     $osingle
654     $otrace
655     $pager
656     $post
657     %postponed
658     $prc
659     $pre
660     $pretype
661     $psh
662     @RememberOnROptions
663     $remoteport
664     @res
665     $rl
666     @saved
667     $signalLevel
668     $sub
669     $term
670     $usercontext
671     $warnLevel
672 );
673
674 our (
675     @cmdfhs,
676     $evalarg,
677     $frame,
678     $hist,
679     $ImmediateStop,
680     $line,
681     $onetimeDump,
682     $onetimedumpDepth,
683     %option,
684     $OUT,
685     $packname,
686     $signal,
687     $single,
688     $start,
689     %sub,
690     $subname,
691     $trace,
692     $window,
693 );
694
695 # Used to save @ARGV and extract any debugger-related flags.
696 use vars qw(@ARGS);
697
698 # Used to prevent multiple entries to diesignal()
699 # (if for instance diesignal() itself dies)
700 use vars qw($panic);
701
702 # Used to prevent the debugger from running nonstop
703 # after a restart
704 our ($second_time);
705
706 sub _calc_usercontext {
707     my ($package) = @_;
708
709     # Cancel strict completely for the evaluated code, so the code
710     # the user evaluates won't be affected by it. (Shlomi Fish)
711     return 'no strict; ($@, $!, $^E, $,, $/, $\, $^W) = @DB::saved;'
712     . "package $package;";    # this won't let them modify, alas
713 }
714
715 sub eval {
716
717     # 'my' would make it visible from user code
718     #    but so does local! --tchrist
719     # Remember: this localizes @DB::res, not @main::res.
720     local @res;
721     {
722
723         # Try to keep the user code from messing  with us. Save these so that
724         # even if the eval'ed code changes them, we can put them back again.
725         # Needed because the user could refer directly to the debugger's
726         # package globals (and any 'my' variables in this containing scope)
727         # inside the eval(), and we want to try to stay safe.
728         local $otrace  = $trace;
729         local $osingle = $single;
730         local $od      = $^D;
731
732         # Untaint the incoming eval() argument.
733         { ($evalarg) = $evalarg =~ /(.*)/s; }
734
735         # $usercontext built in DB::DB near the comment
736         # "set up the context for DB::eval ..."
737         # Evaluate and save any results.
738         @res = eval "$usercontext $evalarg;\n";  # '\n' for nice recursive debug
739
740         # Restore those old values.
741         $trace  = $otrace;
742         $single = $osingle;
743         $^D     = $od;
744     }
745
746     # Save the current value of $@, and preserve it in the debugger's copy
747     # of the saved precious globals.
748     my $at = $@;
749
750     # Since we're only saving $@, we only have to localize the array element
751     # that it will be stored in.
752     local $saved[0];    # Preserve the old value of $@
753     eval { &DB::save };
754
755     # Now see whether we need to report an error back to the user.
756     if ($at) {
757         local $\ = '';
758         print $OUT $at;
759     }
760
761     # Display as required by the caller. $onetimeDump and $onetimedumpDepth
762     # are package globals.
763     elsif ($onetimeDump) {
764         if ( $onetimeDump eq 'dump' ) {
765             local $option{dumpDepth} = $onetimedumpDepth
766               if defined $onetimedumpDepth;
767             dumpit( $OUT, \@res );
768         }
769         elsif ( $onetimeDump eq 'methods' ) {
770             methods( $res[0] );
771         }
772     } ## end elsif ($onetimeDump)
773     @res;
774 } ## end sub eval
775
776 ############################################## End lexical danger zone
777
778 # After this point it is safe to introduce lexicals.
779 # The code being debugged will be executing in its own context, and
780 # can't see the inside of the debugger.
781 #
782 # However, one should not overdo it: leave as much control from outside as
783 # possible. If you make something a lexical, it's not going to be addressable
784 # from outside the debugger even if you know its name.
785
786 # This file is automatically included if you do perl -d.
787 # It's probably not useful to include this yourself.
788 #
789 # Before venturing further into these twisty passages, it is
790 # wise to read the perldebguts man page or risk the ire of dragons.
791 #
792 # (It should be noted that perldebguts will tell you a lot about
793 # the underlying mechanics of how the debugger interfaces into the
794 # Perl interpreter, but not a lot about the debugger itself. The new
795 # comments in this code try to address this problem.)
796
797 # Note that no subroutine call is possible until &DB::sub is defined
798 # (for subroutines defined outside of the package DB). In fact the same is
799 # true if $deep is not defined.
800
801 # Enhanced by ilya@math.ohio-state.edu (Ilya Zakharevich)
802
803 # modified Perl debugger, to be run from Emacs in perldb-mode
804 # Ray Lischner (uunet!mntgfx!lisch) as of 5 Nov 1990
805 # Johan Vromans -- upgrade to 4.0 pl 10
806 # Ilya Zakharevich -- patches after 5.001 (and some before ;-)
807 ########################################################################
808
809 =head1 DEBUGGER INITIALIZATION
810
811 The debugger starts up in phases.
812
813 =head2 BASIC SETUP
814
815 First, it initializes the environment it wants to run in: turning off
816 warnings during its own compilation, defining variables which it will need
817 to avoid warnings later, setting itself up to not exit when the program
818 terminates, and defaulting to printing return values for the C<r> command.
819
820 =cut
821
822 # Needed for the statement after exec():
823 #
824 # This BEGIN block is simply used to switch off warnings during debugger
825 # compilation. Probably it would be better practice to fix the warnings,
826 # but this is how it's done at the moment.
827
828 BEGIN {
829     $ini_warn = $^W;
830     $^W       = 0;
831 }    # Switch compilation warnings off until another BEGIN.
832
833 local ($^W) = 0;    # Switch run-time warnings off during init.
834
835 =head2 THREADS SUPPORT
836
837 If we are running under a threaded Perl, we require threads and threads::shared
838 if the environment variable C<PERL5DB_THREADED> is set, to enable proper
839 threaded debugger control.  C<-dt> can also be used to set this.
840
841 Each new thread will be announced and the debugger prompt will always inform
842 you of each new thread created.  It will also indicate the thread id in which
843 we are currently running within the prompt like this:
844
845     [tid] DB<$i>
846
847 Where C<[tid]> is an integer thread id and C<$i> is the familiar debugger
848 command prompt.  The prompt will show: C<[0]> when running under threads, but
849 not actually in a thread.  C<[tid]> is consistent with C<gdb> usage.
850
851 While running under threads, when you set or delete a breakpoint (etc.), this
852 will apply to all threads, not just the currently running one.  When you are
853 in a currently executing thread, you will stay there until it completes.  With
854 the current implementation it is not currently possible to hop from one thread
855 to another.
856
857 The C<e> and C<E> commands are currently fairly minimal - see C<h e> and C<h E>.
858
859 Note that threading support was built into the debugger as of Perl version
860 C<5.8.6> and debugger version C<1.2.8>.
861
862 =cut
863
864 BEGIN {
865     # ensure we can share our non-threaded variables or no-op
866     if ($ENV{PERL5DB_THREADED}) {
867         require threads;
868         require threads::shared;
869         import threads::shared qw(share);
870         $DBGR;
871         share(\$DBGR);
872         lock($DBGR);
873         print "Threads support enabled\n";
874     } else {
875         *lock = sub(*) {};
876         *share = sub(\[$@%]) {};
877     }
878 }
879
880 # These variables control the execution of 'dumpvar.pl'.
881 {
882     package dumpvar;
883     use vars qw(
884     $hashDepth
885     $arrayDepth
886     $dumpDBFiles
887     $dumpPackages
888     $quoteHighBit
889     $printUndef
890     $globPrint
891     $usageOnly
892     );
893 }
894
895 # used to control die() reporting in diesignal()
896 {
897     package Carp;
898     use vars qw($CarpLevel);
899 }
900
901 # without threads, $filename is not defined until DB::DB is called
902 share($main::{'_<'.$filename}) if defined $filename;
903
904 # Command-line + PERLLIB:
905 # Save the contents of @INC before they are modified elsewhere.
906 @ini_INC = @INC;
907
908 # This was an attempt to clear out the previous values of various
909 # trapped errors. Apparently it didn't help. XXX More info needed!
910 # $prevwarn = $prevdie = $prevbus = $prevsegv = ''; # Does not help?!
911
912 # We set these variables to safe values. We don't want to blindly turn
913 # off warnings, because other packages may still want them.
914 $trace = $signal = $single = 0;    # Uninitialized warning suppression
915                                    # (local $^W cannot help - other packages!).
916
917 # Default to not exiting when program finishes; print the return
918 # value when the 'r' command is used to return from a subroutine.
919 $inhibit_exit = $option{PrintRet} = 1;
920
921 use vars qw($trace_to_depth);
922
923 # Default to 1E9 so it won't be limited to a certain recursion depth.
924 $trace_to_depth = 1E9;
925
926 =head1 OPTION PROCESSING
927
928 The debugger's options are actually spread out over the debugger itself and
929 C<dumpvar.pl>; some of these are variables to be set, while others are
930 subs to be called with a value. To try to make this a little easier to
931 manage, the debugger uses a few data structures to define what options
932 are legal and how they are to be processed.
933
934 First, the C<@options> array defines the I<names> of all the options that
935 are to be accepted.
936
937 =cut
938
939 @options = qw(
940   CommandSet   HistFile      HistSize
941   hashDepth    arrayDepth    dumpDepth
942   DumpDBFiles  DumpPackages  DumpReused
943   compactDump  veryCompact   quote
944   HighBit      undefPrint    globPrint
945   PrintRet     UsageOnly     frame
946   AutoTrace    TTY           noTTY
947   ReadLine     NonStop       LineInfo
948   maxTraceLen  recallCommand ShellBang
949   pager        tkRunning     ornaments
950   signalLevel  warnLevel     dieLevel
951   inhibit_exit ImmediateStop bareStringify
952   CreateTTY    RemotePort    windowSize
953   DollarCaretP
954 );
955
956 @RememberOnROptions = qw(DollarCaretP);
957
958 =pod
959
960 Second, C<optionVars> lists the variables that each option uses to save its
961 state.
962
963 =cut
964
965 use vars qw(%optionVars);
966
967 %optionVars = (
968     hashDepth     => \$dumpvar::hashDepth,
969     arrayDepth    => \$dumpvar::arrayDepth,
970     CommandSet    => \$CommandSet,
971     DumpDBFiles   => \$dumpvar::dumpDBFiles,
972     DumpPackages  => \$dumpvar::dumpPackages,
973     DumpReused    => \$dumpvar::dumpReused,
974     HighBit       => \$dumpvar::quoteHighBit,
975     undefPrint    => \$dumpvar::printUndef,
976     globPrint     => \$dumpvar::globPrint,
977     UsageOnly     => \$dumpvar::usageOnly,
978     CreateTTY     => \$CreateTTY,
979     bareStringify => \$dumpvar::bareStringify,
980     frame         => \$frame,
981     AutoTrace     => \$trace,
982     inhibit_exit  => \$inhibit_exit,
983     maxTraceLen   => \$maxtrace,
984     ImmediateStop => \$ImmediateStop,
985     RemotePort    => \$remoteport,
986     windowSize    => \$window,
987     HistFile      => \$histfile,
988     HistSize      => \$histsize,
989 );
990
991 =pod
992
993 Third, C<%optionAction> defines the subroutine to be called to process each
994 option.
995
996 =cut
997
998 use vars qw(%optionAction);
999
1000 %optionAction = (
1001     compactDump   => \&dumpvar::compactDump,
1002     veryCompact   => \&dumpvar::veryCompact,
1003     quote         => \&dumpvar::quote,
1004     TTY           => \&TTY,
1005     noTTY         => \&noTTY,
1006     ReadLine      => \&ReadLine,
1007     NonStop       => \&NonStop,
1008     LineInfo      => \&LineInfo,
1009     recallCommand => \&recallCommand,
1010     ShellBang     => \&shellBang,
1011     pager         => \&pager,
1012     signalLevel   => \&signalLevel,
1013     warnLevel     => \&warnLevel,
1014     dieLevel      => \&dieLevel,
1015     tkRunning     => \&tkRunning,
1016     ornaments     => \&ornaments,
1017     RemotePort    => \&RemotePort,
1018     DollarCaretP  => \&DollarCaretP,
1019 );
1020
1021 =pod
1022
1023 Last, the C<%optionRequire> notes modules that must be C<require>d if an
1024 option is used.
1025
1026 =cut
1027
1028 # Note that this list is not complete: several options not listed here
1029 # actually require that dumpvar.pl be loaded for them to work, but are
1030 # not in the table. A subsequent patch will correct this problem; for
1031 # the moment, we're just recommenting, and we are NOT going to change
1032 # function.
1033 use vars qw(%optionRequire);
1034
1035 %optionRequire = (
1036     compactDump => 'dumpvar.pl',
1037     veryCompact => 'dumpvar.pl',
1038     quote       => 'dumpvar.pl',
1039 );
1040
1041 =pod
1042
1043 There are a number of initialization-related variables which can be set
1044 by putting code to set them in a BEGIN block in the C<PERL5DB> environment
1045 variable. These are:
1046
1047 =over 4
1048
1049 =item C<$rl> - readline control XXX needs more explanation
1050
1051 =item C<$warnLevel> - whether or not debugger takes over warning handling
1052
1053 =item C<$dieLevel> - whether or not debugger takes over die handling
1054
1055 =item C<$signalLevel> - whether or not debugger takes over signal handling
1056
1057 =item C<$pre> - preprompt actions (array reference)
1058
1059 =item C<$post> - postprompt actions (array reference)
1060
1061 =item C<$pretype>
1062
1063 =item C<$CreateTTY> - whether or not to create a new TTY for this debugger
1064
1065 =item C<$CommandSet> - which command set to use (defaults to new, documented set)
1066
1067 =back
1068
1069 =cut
1070
1071 # These guys may be defined in $ENV{PERL5DB} :
1072 $rl          = 1     unless defined $rl;
1073 $warnLevel   = 1     unless defined $warnLevel;
1074 $dieLevel    = 1     unless defined $dieLevel;
1075 $signalLevel = 1     unless defined $signalLevel;
1076 $pre         = []    unless defined $pre;
1077 $post        = []    unless defined $post;
1078 $pretype     = []    unless defined $pretype;
1079 $CreateTTY   = 3     unless defined $CreateTTY;
1080 $CommandSet  = '580' unless defined $CommandSet;
1081
1082 share($rl);
1083 share($warnLevel);
1084 share($dieLevel);
1085 share($signalLevel);
1086 share($pre);
1087 share($post);
1088 share($pretype);
1089 share($rl);
1090 share($CreateTTY);
1091 share($CommandSet);
1092
1093 =pod
1094
1095 The default C<die>, C<warn>, and C<signal> handlers are set up.
1096
1097 =cut
1098
1099 warnLevel($warnLevel);
1100 dieLevel($dieLevel);
1101 signalLevel($signalLevel);
1102
1103 =pod
1104
1105 The pager to be used is needed next. We try to get it from the
1106 environment first.  If it's not defined there, we try to find it in
1107 the Perl C<Config.pm>.  If it's not there, we default to C<more>. We
1108 then call the C<pager()> function to save the pager name.
1109
1110 =cut
1111
1112 # This routine makes sure $pager is set up so that '|' can use it.
1113 pager(
1114
1115     # If PAGER is defined in the environment, use it.
1116     defined $ENV{PAGER}
1117     ? $ENV{PAGER}
1118
1119       # If not, see if Config.pm defines it.
1120     : eval { require Config }
1121       && defined $Config::Config{pager}
1122     ? $Config::Config{pager}
1123
1124       # If not, fall back to 'more'.
1125     : 'more'
1126   )
1127   unless defined $pager;
1128
1129 =pod
1130
1131 We set up the command to be used to access the man pages, the command
1132 recall character (C<!> unless otherwise defined) and the shell escape
1133 character (C<!> unless otherwise defined). Yes, these do conflict, and
1134 neither works in the debugger at the moment.
1135
1136 =cut
1137
1138 setman();
1139
1140 # Set up defaults for command recall and shell escape (note:
1141 # these currently don't work in linemode debugging).
1142 recallCommand("!") unless defined $prc;
1143 shellBang("!")     unless defined $psh;
1144
1145 =pod
1146
1147 We then set up the gigantic string containing the debugger help.
1148 We also set the limit on the number of arguments we'll display during a
1149 trace.
1150
1151 =cut
1152
1153 sethelp();
1154
1155 # If we didn't get a default for the length of eval/stack trace args,
1156 # set it here.
1157 $maxtrace = 400 unless defined $maxtrace;
1158
1159 =head2 SETTING UP THE DEBUGGER GREETING
1160
1161 The debugger I<greeting> helps to inform the user how many debuggers are
1162 running, and whether the current debugger is the primary or a child.
1163
1164 If we are the primary, we just hang onto our pid so we'll have it when
1165 or if we start a child debugger. If we are a child, we'll set things up
1166 so we'll have a unique greeting and so the parent will give us our own
1167 TTY later.
1168
1169 We save the current contents of the C<PERLDB_PIDS> environment variable
1170 because we mess around with it. We'll also need to hang onto it because
1171 we'll need it if we restart.
1172
1173 Child debuggers make a label out of the current PID structure recorded in
1174 PERLDB_PIDS plus the new PID. They also mark themselves as not having a TTY
1175 yet so the parent will give them one later via C<resetterm()>.
1176
1177 =cut
1178
1179 # Save the current contents of the environment; we're about to
1180 # much with it. We'll need this if we have to restart.
1181 use vars qw($ini_pids);
1182 $ini_pids = $ENV{PERLDB_PIDS};
1183
1184 use vars qw ($pids $term_pid);
1185
1186 if ( defined $ENV{PERLDB_PIDS} ) {
1187
1188     # We're a child. Make us a label out of the current PID structure
1189     # recorded in PERLDB_PIDS plus our (new) PID. Mark us as not having
1190     # a term yet so the parent will give us one later via resetterm().
1191
1192     my $env_pids = $ENV{PERLDB_PIDS};
1193     $pids = "[$env_pids]";
1194
1195     # Unless we are on OpenVMS, all programs under the DCL shell run under
1196     # the same PID.
1197
1198     if (($^O eq 'VMS') && ($env_pids =~ /\b$$\b/)) {
1199         $term_pid         = $$;
1200     }
1201     else {
1202         $ENV{PERLDB_PIDS} .= "->$$";
1203         $term_pid = -1;
1204     }
1205
1206 } ## end if (defined $ENV{PERLDB_PIDS...
1207 else {
1208
1209     # We're the parent PID. Initialize PERLDB_PID in case we end up with a
1210     # child debugger, and mark us as the parent, so we'll know to set up
1211     # more TTY's is we have to.
1212     $ENV{PERLDB_PIDS} = "$$";
1213     $pids             = "[pid=$$]";
1214     $term_pid         = $$;
1215 }
1216
1217 use vars qw($pidprompt);
1218 $pidprompt = '';
1219
1220 # Sets up $emacs as a synonym for $slave_editor.
1221 our ($slave_editor);
1222 *emacs = $slave_editor if $slave_editor;    # May be used in afterinit()...
1223
1224 =head2 READING THE RC FILE
1225
1226 The debugger will read a file of initialization options if supplied. If
1227 running interactively, this is C<.perldb>; if not, it's C<perldb.ini>.
1228
1229 =cut
1230
1231 # As noted, this test really doesn't check accurately that the debugger
1232 # is running at a terminal or not.
1233
1234 use vars qw($rcfile);
1235 {
1236     my $dev_tty = (($^O eq 'VMS') ? 'TT:' : '/dev/tty');
1237     # this is the wrong metric!
1238     $rcfile = ((-e $dev_tty) ? ".perldb" : "perldb.ini");
1239 }
1240
1241 =pod
1242
1243 The debugger does a safety test of the file to be read. It must be owned
1244 either by the current user or root, and must only be writable by the owner.
1245
1246 =cut
1247
1248 # This wraps a safety test around "do" to read and evaluate the init file.
1249 #
1250 # This isn't really safe, because there's a race
1251 # between checking and opening.  The solution is to
1252 # open and fstat the handle, but then you have to read and
1253 # eval the contents.  But then the silly thing gets
1254 # your lexical scope, which is unfortunate at best.
1255 sub safe_do {
1256     my $file = shift;
1257
1258     # Just exactly what part of the word "CORE::" don't you understand?
1259     local $SIG{__WARN__};
1260     local $SIG{__DIE__};
1261
1262     unless ( is_safe_file($file) ) {
1263         CORE::warn <<EO_GRIPE;
1264 perldb: Must not source insecure rcfile $file.
1265         You or the superuser must be the owner, and it must not
1266         be writable by anyone but its owner.
1267 EO_GRIPE
1268         return;
1269     } ## end unless (is_safe_file($file...
1270
1271     do $file;
1272     CORE::warn("perldb: couldn't parse $file: $@") if $@;
1273 } ## end sub safe_do
1274
1275 # This is the safety test itself.
1276 #
1277 # Verifies that owner is either real user or superuser and that no
1278 # one but owner may write to it.  This function is of limited use
1279 # when called on a path instead of upon a handle, because there are
1280 # no guarantees that filename (by dirent) whose file (by ino) is
1281 # eventually accessed is the same as the one tested.
1282 # Assumes that the file's existence is not in doubt.
1283 sub is_safe_file {
1284     my $path = shift;
1285     stat($path) || return;    # mysteriously vaporized
1286     my ( $dev, $ino, $mode, $nlink, $uid, $gid ) = stat(_);
1287
1288     return 0 if $uid != 0 && $uid != $<;
1289     return 0 if $mode & 022;
1290     return 1;
1291 } ## end sub is_safe_file
1292
1293 # If the rcfile (whichever one we decided was the right one to read)
1294 # exists, we safely do it.
1295 if ( -f $rcfile ) {
1296     safe_do("./$rcfile");
1297 }
1298
1299 # If there isn't one here, try the user's home directory.
1300 elsif ( defined $ENV{HOME} && -f "$ENV{HOME}/$rcfile" ) {
1301     safe_do("$ENV{HOME}/$rcfile");
1302 }
1303
1304 # Else try the login directory.
1305 elsif ( defined $ENV{LOGDIR} && -f "$ENV{LOGDIR}/$rcfile" ) {
1306     safe_do("$ENV{LOGDIR}/$rcfile");
1307 }
1308
1309 # If the PERLDB_OPTS variable has options in it, parse those out next.
1310 if ( defined $ENV{PERLDB_OPTS} ) {
1311     parse_options( $ENV{PERLDB_OPTS} );
1312 }
1313
1314 =pod
1315
1316 The last thing we do during initialization is determine which subroutine is
1317 to be used to obtain a new terminal when a new debugger is started. Right now,
1318 the debugger only handles TCP sockets, X11, OS/2, amd Mac OS X
1319 (darwin).
1320
1321 =cut
1322
1323 # Set up the get_fork_TTY subroutine to be aliased to the proper routine.
1324 # Works if you're running an xterm or xterm-like window, or you're on
1325 # OS/2, or on Mac OS X. This may need some expansion.
1326
1327 if (not defined &get_fork_TTY)       # only if no routine exists
1328 {
1329     if ( defined $remoteport ) {
1330                                                  # Expect an inetd-like server
1331         *get_fork_TTY = \&socket_get_fork_TTY;   # to listen to us
1332     }
1333     elsif (defined $ENV{TERM}                    # If we know what kind
1334                                                  # of terminal this is,
1335         and $ENV{TERM} eq 'xterm'                # and it's an xterm,
1336         and defined $ENV{DISPLAY}                # and what display it's on,
1337       )
1338     {
1339         *get_fork_TTY = \&xterm_get_fork_TTY;    # use the xterm version
1340     }
1341     elsif ( $ENV{TMUX} ) {
1342         *get_fork_TTY = \&tmux_get_fork_TTY;
1343     }
1344     elsif ( $^O eq 'os2' ) {                     # If this is OS/2,
1345         *get_fork_TTY = \&os2_get_fork_TTY;      # use the OS/2 version
1346     }
1347     elsif ( $^O eq 'darwin'                      # If this is Mac OS X
1348             and defined $ENV{TERM_PROGRAM}       # and we're running inside
1349             and $ENV{TERM_PROGRAM}
1350                 eq 'Apple_Terminal'              # Terminal.app
1351             )
1352     {
1353         *get_fork_TTY = \&macosx_get_fork_TTY;   # use the Mac OS X version
1354     }
1355 } ## end if (not defined &get_fork_TTY...
1356
1357 # untaint $^O, which may have been tainted by the last statement.
1358 # see bug [perl #24674]
1359 $^O =~ m/^(.*)\z/;
1360 $^O = $1;
1361
1362 # Here begin the unreadable code.  It needs fixing.
1363
1364 =head2 RESTART PROCESSING
1365
1366 This section handles the restart command. When the C<R> command is invoked, it
1367 tries to capture all of the state it can into environment variables, and
1368 then sets C<PERLDB_RESTART>. When we start executing again, we check to see
1369 if C<PERLDB_RESTART> is there; if so, we reload all the information that
1370 the R command stuffed into the environment variables.
1371
1372   PERLDB_RESTART   - flag only, contains no restart data itself.
1373   PERLDB_HIST      - command history, if it's available
1374   PERLDB_ON_LOAD   - breakpoints set by the rc file
1375   PERLDB_POSTPONE  - subs that have been loaded/not executed,
1376                      and have actions
1377   PERLDB_VISITED   - files that had breakpoints
1378   PERLDB_FILE_...  - breakpoints for a file
1379   PERLDB_OPT       - active options
1380   PERLDB_INC       - the original @INC
1381   PERLDB_PRETYPE   - preprompt debugger actions
1382   PERLDB_PRE       - preprompt Perl code
1383   PERLDB_POST      - post-prompt Perl code
1384   PERLDB_TYPEAHEAD - typeahead captured by readline()
1385
1386 We chug through all these variables and plug the values saved in them
1387 back into the appropriate spots in the debugger.
1388
1389 =cut
1390
1391 use vars qw(%postponed_file @typeahead);
1392
1393 our (@hist, @truehist);
1394
1395 sub _restore_shared_globals_after_restart
1396 {
1397     @hist          = get_list('PERLDB_HIST');
1398     %break_on_load = get_list("PERLDB_ON_LOAD");
1399     %postponed     = get_list("PERLDB_POSTPONE");
1400
1401     share(@hist);
1402     share(@truehist);
1403     share(%break_on_load);
1404     share(%postponed);
1405 }
1406
1407 sub _restore_breakpoints_and_actions {
1408
1409     my @had_breakpoints = get_list("PERLDB_VISITED");
1410
1411     for my $file_idx ( 0 .. $#had_breakpoints ) {
1412         my $filename = $had_breakpoints[$file_idx];
1413         my %pf = get_list("PERLDB_FILE_$file_idx");
1414         $postponed_file{ $filename } = \%pf if %pf;
1415         my @lines = sort {$a <=> $b} keys(%pf);
1416         my @enabled_statuses = get_list("PERLDB_FILE_ENABLED_$file_idx");
1417         for my $line_idx (0 .. $#lines) {
1418             _set_breakpoint_enabled_status(
1419                 $filename,
1420                 $lines[$line_idx],
1421                 ($enabled_statuses[$line_idx] ? 1 : ''),
1422             );
1423         }
1424     }
1425
1426     return;
1427 }
1428
1429 sub _restore_options_after_restart
1430 {
1431     my %options_map = get_list("PERLDB_OPT");
1432
1433     while ( my ( $opt, $val ) = each %options_map ) {
1434         $val =~ s/[\\\']/\\$1/g;
1435         parse_options("$opt'$val'");
1436     }
1437
1438     return;
1439 }
1440
1441 sub _restore_globals_after_restart
1442 {
1443     # restore original @INC
1444     @INC     = get_list("PERLDB_INC");
1445     @ini_INC = @INC;
1446
1447     # return pre/postprompt actions and typeahead buffer
1448     $pretype   = [ get_list("PERLDB_PRETYPE") ];
1449     $pre       = [ get_list("PERLDB_PRE") ];
1450     $post      = [ get_list("PERLDB_POST") ];
1451     @typeahead = get_list( "PERLDB_TYPEAHEAD", @typeahead );
1452
1453     return;
1454 }
1455
1456
1457 if ( exists $ENV{PERLDB_RESTART} ) {
1458
1459     # We're restarting, so we don't need the flag that says to restart anymore.
1460     delete $ENV{PERLDB_RESTART};
1461
1462     # $restart = 1;
1463     _restore_shared_globals_after_restart();
1464
1465     _restore_breakpoints_and_actions();
1466
1467     # restore options
1468     _restore_options_after_restart();
1469
1470     _restore_globals_after_restart();
1471 } ## end if (exists $ENV{PERLDB_RESTART...
1472
1473 =head2 SETTING UP THE TERMINAL
1474
1475 Now, we'll decide how the debugger is going to interact with the user.
1476 If there's no TTY, we set the debugger to run non-stop; there's not going
1477 to be anyone there to enter commands.
1478
1479 =cut
1480
1481 use vars qw($notty $console $tty $LINEINFO);
1482 use vars qw($lineinfo $doccmd);
1483
1484 our ($runnonstop);
1485
1486 # Local autoflush to avoid rt#116769,
1487 # as calling IO::File methods causes an unresolvable loop
1488 # that results in debugger failure.
1489 sub _autoflush {
1490     my $o = select($_[0]);
1491     $|++;
1492     select($o);
1493 }
1494
1495 if ($notty) {
1496     $runnonstop = 1;
1497     share($runnonstop);
1498 }
1499
1500 =pod
1501
1502 If there is a TTY, we have to determine who it belongs to before we can
1503 proceed. If this is a slave editor or graphical debugger (denoted by
1504 the first command-line switch being '-emacs'), we shift this off and
1505 set C<$rl> to 0 (XXX ostensibly to do straight reads).
1506
1507 =cut
1508
1509 else {
1510
1511     # Is Perl being run from a slave editor or graphical debugger?
1512     # If so, don't use readline, and set $slave_editor = 1.
1513     if ($slave_editor = ( @main::ARGV && ( $main::ARGV[0] eq '-emacs' ) )) {
1514         $rl = 0;
1515         shift(@main::ARGV);
1516     }
1517
1518     #require Term::ReadLine;
1519
1520 =pod
1521
1522 We then determine what the console should be on various systems:
1523
1524 =over 4
1525
1526 =item * Cygwin - We use C<stdin> instead of a separate device.
1527
1528 =cut
1529
1530     if ( $^O eq 'cygwin' ) {
1531
1532         # /dev/tty is binary. use stdin for textmode
1533         undef $console;
1534     }
1535
1536 =item * Windows or MSDOS - use C<con>.
1537
1538 =cut
1539
1540     elsif ( $^O eq 'dos' or -e "con" or $^O eq 'MSWin32' ) {
1541         $console = "con";
1542     }
1543
1544 =item * AmigaOS - use C<CONSOLE:>.
1545
1546 =cut
1547
1548     elsif ( $^O eq 'amigaos' ) {
1549         $console = "CONSOLE:";
1550     }
1551
1552 =item * VMS - use C<sys$command>.
1553
1554 =cut
1555
1556     elsif ($^O eq 'VMS') {
1557         $console = 'sys$command';
1558     }
1559
1560 # Keep this penultimate, on the grounds that it satisfies a wide variety of
1561 # Unix-like systems that would otherwise need to be identified individually.
1562
1563 =item * Unix - use F</dev/tty>.
1564
1565 =cut
1566
1567     elsif ( -e "/dev/tty" ) {
1568         $console = "/dev/tty";
1569     }
1570
1571 # Keep this last.
1572
1573     else {
1574         _db_warn("Can't figure out your console, using stdin");
1575         undef $console;
1576     }
1577
1578 =pod
1579
1580 =back
1581
1582 Several other systems don't use a specific console. We C<undef $console>
1583 for those (Windows using a slave editor/graphical debugger, NetWare, OS/2
1584 with a slave editor).
1585
1586 =cut
1587
1588     if ( ( $^O eq 'MSWin32' ) and ( $slave_editor or defined $ENV{EMACS} ) ) {
1589
1590         # /dev/tty is binary. use stdin for textmode
1591         $console = undef;
1592     }
1593
1594     if ( $^O eq 'NetWare' ) {
1595
1596         # /dev/tty is binary. use stdin for textmode
1597         $console = undef;
1598     }
1599
1600     # In OS/2, we need to use STDIN to get textmode too, even though
1601     # it pretty much looks like Unix otherwise.
1602     if ( defined $ENV{OS2_SHELL} and ( $slave_editor or $ENV{WINDOWID} ) )
1603     {    # In OS/2
1604         $console = undef;
1605     }
1606
1607 =pod
1608
1609 If there is a TTY hanging around from a parent, we use that as the console.
1610
1611 =cut
1612
1613     $console = $tty if defined $tty;
1614
1615 =head2 SOCKET HANDLING
1616
1617 The debugger is capable of opening a socket and carrying out a debugging
1618 session over the socket.
1619
1620 If C<RemotePort> was defined in the options, the debugger assumes that it
1621 should try to start a debugging session on that port. It builds the socket
1622 and then tries to connect the input and output filehandles to it.
1623
1624 =cut
1625
1626     # Handle socket stuff.
1627
1628     if ( defined $remoteport ) {
1629
1630         # If RemotePort was defined in the options, connect input and output
1631         # to the socket.
1632         $IN = $OUT = connect_remoteport();
1633     } ## end if (defined $remoteport)
1634
1635 =pod
1636
1637 If no C<RemotePort> was defined, and we want to create a TTY on startup,
1638 this is probably a situation where multiple debuggers are running (for example,
1639 a backticked command that starts up another debugger). We create a new IN and
1640 OUT filehandle, and do the necessary mojo to create a new TTY if we know how
1641 and if we can.
1642
1643 =cut
1644
1645     # Non-socket.
1646     else {
1647
1648         # Two debuggers running (probably a system or a backtick that invokes
1649         # the debugger itself under the running one). create a new IN and OUT
1650         # filehandle, and do the necessary mojo to create a new tty if we
1651         # know how, and we can.
1652         create_IN_OUT(4) if $CreateTTY & 4;
1653         if ($console) {
1654
1655             # If we have a console, check to see if there are separate ins and
1656             # outs to open. (They are assumed identical if not.)
1657
1658             my ( $i, $o ) = split /,/, $console;
1659             $o = $i unless defined $o;
1660
1661             # read/write on in, or just read, or read on STDIN.
1662                  open( IN, '+<', $i )
1663               || open( IN, '<',  $i )
1664               || open( IN, "<&STDIN" );
1665
1666             # read/write/create/clobber out, or write/create/clobber out,
1667             # or merge with STDERR, or merge with STDOUT.
1668                  open( OUT, '+>', $o )
1669               || open( OUT, '>',  $o )
1670               || open( OUT, ">&STDERR" )
1671               || open( OUT, ">&STDOUT" );    # so we don't dongle stdout
1672
1673         } ## end if ($console)
1674         elsif ( not defined $console ) {
1675
1676             # No console. Open STDIN.
1677             open( IN, "<&STDIN" );
1678
1679             # merge with STDERR, or with STDOUT.
1680             open( OUT,      ">&STDERR" )
1681               || open( OUT, ">&STDOUT" );    # so we don't dongle stdout
1682             $console = 'STDIN/OUT';
1683         } ## end elsif (not defined $console)
1684
1685         # Keep copies of the filehandles so that when the pager runs, it
1686         # can close standard input without clobbering ours.
1687         if ($console or (not defined($console))) {
1688             $IN = \*IN;
1689             $OUT = \*OUT;
1690         }
1691     } ## end elsif (from if(defined $remoteport))
1692
1693     # Unbuffer DB::OUT. We need to see responses right away.
1694     _autoflush($OUT);
1695
1696     # Line info goes to debugger output unless pointed elsewhere.
1697     # Pointing elsewhere makes it possible for slave editors to
1698     # keep track of file and position. We have both a filehandle
1699     # and a I/O description to keep track of.
1700     $LINEINFO = $OUT     unless defined $LINEINFO;
1701     $lineinfo = $console unless defined $lineinfo;
1702     # share($LINEINFO); # <- unable to share globs
1703     share($lineinfo);   #
1704
1705 =pod
1706
1707 To finish initialization, we show the debugger greeting,
1708 and then call the C<afterinit()> subroutine if there is one.
1709
1710 =cut
1711
1712     # Show the debugger greeting.
1713     $header =~ s/.Header: ([^,]+),v(\s+\S+\s+\S+).*$/$1$2/;
1714     unless ($runnonstop) {
1715         local $\ = '';
1716         local $, = '';
1717         if ( $term_pid eq '-1' ) {
1718             print $OUT "\nDaughter DB session started...\n";
1719         }
1720         else {
1721             print $OUT "\nLoading DB routines from $header\n";
1722             print $OUT (
1723                 "Editor support ",
1724                 $slave_editor ? "enabled" : "available", ".\n"
1725             );
1726             print $OUT
1727 "\nEnter h or 'h h' for help, or '$doccmd perldebug' for more help.\n\n";
1728         } ## end else [ if ($term_pid eq '-1')
1729     } ## end unless ($runnonstop)
1730 } ## end else [ if ($notty)
1731
1732 # XXX This looks like a bug to me.
1733 # Why copy to @ARGS and then futz with @args?
1734 @ARGS = @ARGV;
1735 # for (@args) {
1736     # Make sure backslashes before single quotes are stripped out, and
1737     # keep args unless they are numeric (XXX why?)
1738     # s/\'/\\\'/g;                      # removed while not justified understandably
1739     # s/(.*)/'$1'/ unless /^-?[\d.]+$/; # ditto
1740 # }
1741
1742 # If there was an afterinit() sub defined, call it. It will get
1743 # executed in our scope, so it can fiddle with debugger globals.
1744 if ( defined &afterinit ) {    # May be defined in $rcfile
1745     afterinit();
1746 }
1747
1748 # Inform us about "Stack dump during die enabled ..." in dieLevel().
1749 use vars qw($I_m_init);
1750
1751 $I_m_init = 1;
1752
1753 ############################################################ Subroutines
1754
1755 =head1 SUBROUTINES
1756
1757 =head2 DB
1758
1759 This gigantic subroutine is the heart of the debugger. Called before every
1760 statement, its job is to determine if a breakpoint has been reached, and
1761 stop if so; read commands from the user, parse them, and execute
1762 them, and then send execution off to the next statement.
1763
1764 Note that the order in which the commands are processed is very important;
1765 some commands earlier in the loop will actually alter the C<$cmd> variable
1766 to create other commands to be executed later. This is all highly I<optimized>
1767 but can be confusing. Check the comments for each C<$cmd ... && do {}> to
1768 see what's happening in any given command.
1769
1770 =cut
1771
1772 # $cmd cannot be an our() variable unfortunately (possible perl bug?).
1773
1774 use vars qw(
1775     $action
1776     $cmd
1777     $file
1778     $filename_ini
1779     $finished
1780     %had_breakpoints
1781     $level
1782     $max
1783     $package
1784     $try
1785 );
1786
1787 our (
1788     %alias,
1789     $doret,
1790     $end,
1791     $fall_off_end,
1792     $incr,
1793     $laststep,
1794     $rc,
1795     $sh,
1796     $stack_depth,
1797     @stack,
1798     @to_watch,
1799     @old_watch,
1800 );
1801
1802 sub _DB__determine_if_we_should_break
1803 {
1804     # if we have something here, see if we should break.
1805     # $stop is lexical and local to this block - $action on the other hand
1806     # is global.
1807     my $stop;
1808
1809     if ( $dbline{$line}
1810         && _is_breakpoint_enabled($filename, $line)
1811         && (( $stop, $action ) = split( /\0/, $dbline{$line} ) ) )
1812     {
1813
1814         # Stop if the stop criterion says to just stop.
1815         if ( $stop eq '1' ) {
1816             $signal |= 1;
1817         }
1818
1819         # It's a conditional stop; eval it in the user's context and
1820         # see if we should stop. If so, remove the one-time sigil.
1821         elsif ($stop) {
1822             $evalarg = "\$DB::signal |= 1 if do {$stop}";
1823             # The &-call is here to ascertain the mutability of @_.
1824             &DB::eval;
1825             # If the breakpoint is temporary, then delete its enabled status.
1826             if ($dbline{$line} =~ s/;9($|\0)/$1/) {
1827                 _cancel_breakpoint_temp_enabled_status($filename, $line);
1828             }
1829         }
1830     } ## end if ($dbline{$line} && ...
1831 }
1832
1833 sub _DB__is_finished {
1834     if ($finished and $level <= 1) {
1835         end_report();
1836         return 1;
1837     }
1838     else {
1839         return;
1840     }
1841 }
1842
1843 sub _DB__read_next_cmd
1844 {
1845     my ($tid) = @_;
1846
1847     # We have a terminal, or can get one ...
1848     if (!$term) {
1849         setterm();
1850     }
1851
1852     # ... and it belongs to this PID or we get one for this PID ...
1853     if ($term_pid != $$) {
1854         resetterm(1);
1855     }
1856
1857     # ... and we got a line of command input ...
1858     $cmd = DB::readline(
1859         "$pidprompt $tid DB"
1860         . ( '<' x $level )
1861         . ( $#hist + 1 )
1862         . ( '>' x $level ) . " "
1863     );
1864
1865     return defined($cmd);
1866 }
1867
1868 sub _DB__trim_command_and_return_first_component {
1869     my ($obj) = @_;
1870
1871     $cmd =~ s/\A\s+//s;    # trim annoying leading whitespace
1872     $cmd =~ s/\s+\z//s;    # trim annoying trailing whitespace
1873
1874     my ($verb, $args) = $cmd =~ m{\A(\S*)\s*(.*)}s;
1875
1876     $obj->cmd_verb($verb);
1877     $obj->cmd_args($args);
1878
1879     return;
1880 }
1881
1882 sub _DB__handle_f_command {
1883     my ($obj) = @_;
1884
1885     if ($file = $obj->cmd_args) {
1886         # help for no arguments (old-style was return from sub).
1887         if ( !$file ) {
1888             print $OUT
1889             "The old f command is now the r command.\n";    # hint
1890             print $OUT "The new f command switches filenames.\n";
1891             next CMD;
1892         } ## end if (!$file)
1893
1894         # if not in magic file list, try a close match.
1895         if ( !defined $main::{ '_<' . $file } ) {
1896             if ( ($try) = grep( m#^_<.*$file#, keys %main:: ) ) {
1897                 {
1898                     $try = substr( $try, 2 );
1899                     print $OUT "Choosing $try matching '$file':\n";
1900                     $file = $try;
1901                 }
1902             } ## end if (($try) = grep(m#^_<.*$file#...
1903         } ## end if (!defined $main::{ ...
1904
1905         # If not successfully switched now, we failed.
1906         if ( !defined $main::{ '_<' . $file } ) {
1907             print $OUT "No file matching '$file' is loaded.\n";
1908             next CMD;
1909         }
1910
1911         # We switched, so switch the debugger internals around.
1912         elsif ( $file ne $filename ) {
1913             *dbline   = $main::{ '_<' . $file };
1914             $max      = $#dbline;
1915             $filename = $file;
1916             $start    = 1;
1917             $cmd      = "l";
1918         } ## end elsif ($file ne $filename)
1919
1920         # We didn't switch; say we didn't.
1921         else {
1922             print $OUT "Already in $file.\n";
1923             next CMD;
1924         }
1925     }
1926
1927     return;
1928 }
1929
1930 sub _DB__handle_dot_command {
1931     my ($obj) = @_;
1932
1933     # . command.
1934     if ($obj->_is_full('.')) {
1935         $incr = -1;    # stay at current line
1936
1937         # Reset everything to the old location.
1938         $start    = $line;
1939         $filename = $filename_ini;
1940         *dbline   = $main::{ '_<' . $filename };
1941         $max      = $#dbline;
1942
1943         # Now where are we?
1944         print_lineinfo($obj->position());
1945         next CMD;
1946     }
1947
1948     return;
1949 }
1950
1951 sub _DB__handle_y_command {
1952     my ($obj) = @_;
1953
1954     if (my ($match_level, $match_vars)
1955         = $obj->cmd_args =~ /\A(?:(\d*)\s*(.*))?\z/) {
1956
1957         # See if we've got the necessary support.
1958         if (!eval {
1959             local @INC = @INC;
1960             pop @INC if $INC[-1] eq '.';
1961             require PadWalker; PadWalker->VERSION(0.08) }) {
1962             my $Err = $@;
1963             _db_warn(
1964                 $Err =~ /locate/
1965                 ? "PadWalker module not found - please install\n"
1966                 : $Err
1967             );
1968             next CMD;
1969         }
1970
1971         # Load up dumpvar if we don't have it. If we can, that is.
1972         do 'dumpvar.pl' || die $@ unless defined &main::dumpvar;
1973         defined &main::dumpvar
1974             or print $OUT "dumpvar.pl not available.\n"
1975             and next CMD;
1976
1977         # Got all the modules we need. Find them and print them.
1978         my @vars = split( ' ', $match_vars || '' );
1979
1980         # Find the pad.
1981         my $h = eval { PadWalker::peek_my( ( $match_level || 0 ) + 2 ) };
1982
1983         # Oops. Can't find it.
1984         if (my $Err = $@) {
1985             $Err =~ s/ at .*//;
1986             _db_warn($Err);
1987             next CMD;
1988         }
1989
1990         # Show the desired vars with dumplex().
1991         my $savout = select($OUT);
1992
1993         # Have dumplex dump the lexicals.
1994         foreach my $key (sort keys %$h) {
1995             dumpvar::dumplex( $key, $h->{$key},
1996                 defined $option{dumpDepth} ? $option{dumpDepth} : -1,
1997                 @vars );
1998         }
1999         select($savout);
2000         next CMD;
2001     }
2002 }
2003
2004 sub _DB__handle_c_command {
2005     my ($obj) = @_;
2006
2007     my $i = $obj->cmd_args;
2008
2009     if ($i =~ m#\A[\w:]*\z#) {
2010
2011         # Hey, show's over. The debugged program finished
2012         # executing already.
2013         next CMD if _DB__is_finished();
2014
2015         # Capture the place to put a one-time break.
2016         $subname = $i;
2017
2018         #  Probably not needed, since we finish an interactive
2019         #  sub-session anyway...
2020         # local $filename = $filename;
2021         # local *dbline = *dbline; # XXX Would this work?!
2022         #
2023         # The above question wonders if localizing the alias
2024         # to the magic array works or not. Since it's commented
2025         # out, we'll just leave that to speculation for now.
2026
2027         # If the "subname" isn't all digits, we'll assume it
2028         # is a subroutine name, and try to find it.
2029         if ( $subname =~ /\D/ ) {    # subroutine name
2030             # Qualify it to the current package unless it's
2031             # already qualified.
2032             $subname = $package . "::" . $subname
2033             unless $subname =~ /::/;
2034
2035             # find_sub will return "file:line_number" corresponding
2036             # to where the subroutine is defined; we call find_sub,
2037             # break up the return value, and assign it in one
2038             # operation.
2039             ( $file, $i ) = ( find_sub($subname) =~ /^(.*):(.*)$/ );
2040
2041             # Force the line number to be numeric.
2042             $i = $i + 0;
2043
2044             # If we got a line number, we found the sub.
2045             if ($i) {
2046
2047                 # Switch all the debugger's internals around so
2048                 # we're actually working with that file.
2049                 $filename = $file;
2050                 *dbline   = $main::{ '_<' . $filename };
2051
2052                 # Mark that there's a breakpoint in this file.
2053                 $had_breakpoints{$filename} |= 1;
2054
2055                 # Scan forward to the first executable line
2056                 # after the 'sub whatever' line.
2057                 $max = $#dbline;
2058                 my $_line_num = $i;
2059                 while ($dbline[$_line_num] == 0 && $_line_num< $max)
2060                 {
2061                     $_line_num++;
2062                 }
2063                 $i = $_line_num;
2064             } ## end if ($i)
2065
2066             # We didn't find a sub by that name.
2067             else {
2068                 print $OUT "Subroutine $subname not found.\n";
2069                 next CMD;
2070             }
2071         } ## end if ($subname =~ /\D/)
2072
2073         # At this point, either the subname was all digits (an
2074         # absolute line-break request) or we've scanned through
2075         # the code following the definition of the sub, looking
2076         # for an executable, which we may or may not have found.
2077         #
2078         # If $i (which we set $subname from) is non-zero, we
2079         # got a request to break at some line somewhere. On
2080         # one hand, if there wasn't any real subroutine name
2081         # involved, this will be a request to break in the current
2082         # file at the specified line, so we have to check to make
2083         # sure that the line specified really is breakable.
2084         #
2085         # On the other hand, if there was a subname supplied, the
2086         # preceding block has moved us to the proper file and
2087         # location within that file, and then scanned forward
2088         # looking for the next executable line. We have to make
2089         # sure that one was found.
2090         #
2091         # On the gripping hand, we can't do anything unless the
2092         # current value of $i points to a valid breakable line.
2093         # Check that.
2094         if ($i) {
2095
2096             # Breakable?
2097             if ( $dbline[$i] == 0 ) {
2098                 print $OUT "Line $i not breakable.\n";
2099                 next CMD;
2100             }
2101
2102             # Yes. Set up the one-time-break sigil.
2103             $dbline{$i} =~ s/($|\0)/;9$1/;  # add one-time-only b.p.
2104             _enable_breakpoint_temp_enabled_status($filename, $i);
2105         } ## end if ($i)
2106
2107         # Turn off stack tracing from here up.
2108         for my $j (0 .. $stack_depth) {
2109             $stack[ $j ] &= ~1;
2110         }
2111         last CMD;
2112     }
2113
2114     return;
2115 }
2116
2117 sub _DB__handle_forward_slash_command {
2118     my ($obj) = @_;
2119
2120     # The pattern as a string.
2121     use vars qw($inpat);
2122
2123     if (($inpat) = $cmd =~ m#\A/(.*)\z#) {
2124
2125         # Remove the final slash.
2126         $inpat =~ s:([^\\])/$:$1:;
2127
2128         # If the pattern isn't null ...
2129         if ( $inpat ne "" ) {
2130
2131             # Turn off warn and die processing for a bit.
2132             local $SIG{__DIE__};
2133             local $SIG{__WARN__};
2134
2135             # Create the pattern.
2136             eval 'no strict q/vars/; $inpat =~ m' . "\a$inpat\a";
2137             if ( $@ ne "" ) {
2138
2139                 # Oops. Bad pattern. No biscuit.
2140                 # Print the eval error and go back for more
2141                 # commands.
2142                 print {$OUT} "$@";
2143                 next CMD;
2144             }
2145             $obj->pat($inpat);
2146         } ## end if ($inpat ne "")
2147
2148         # Set up to stop on wrap-around.
2149         $end = $start;
2150
2151         # Don't move off the current line.
2152         $incr = -1;
2153
2154         my $pat = $obj->pat;
2155
2156         # Done in eval so nothing breaks if the pattern
2157         # does something weird.
2158         eval
2159         {
2160             no strict q/vars/;
2161             for (;;) {
2162                 # Move ahead one line.
2163                 ++$start;
2164
2165                 # Wrap if we pass the last line.
2166                 if ($start > $max) {
2167                     $start = 1;
2168                 }
2169
2170                 # Stop if we have gotten back to this line again,
2171                 last if ($start == $end);
2172
2173                 # A hit! (Note, though, that we are doing
2174                 # case-insensitive matching. Maybe a qr//
2175                 # expression would be better, so the user could
2176                 # do case-sensitive matching if desired.
2177                 if ($dbline[$start] =~ m/$pat/i) {
2178                     if ($slave_editor) {
2179                         # Handle proper escaping in the slave.
2180                         print {$OUT} "\032\032$filename:$start:0\n";
2181                     }
2182                     else {
2183                         # Just print the line normally.
2184                         print {$OUT} "$start:\t",$dbline[$start],"\n";
2185                     }
2186                     # And quit since we found something.
2187                     last;
2188                 }
2189             }
2190         };
2191
2192         if ($@) {
2193             warn $@;
2194         }
2195
2196         # If we wrapped, there never was a match.
2197         if ( $start == $end ) {
2198             print {$OUT} "/$pat/: not found\n";
2199         }
2200         next CMD;
2201     }
2202
2203     return;
2204 }
2205
2206 sub _DB__handle_question_mark_command {
2207     my ($obj) = @_;
2208
2209     # ? - backward pattern search.
2210     if (my ($inpat) = $cmd =~ m#\A\?(.*)\z#) {
2211
2212         # Get the pattern, remove trailing question mark.
2213         $inpat =~ s:([^\\])\?$:$1:;
2214
2215         # If we've got one ...
2216         if ( $inpat ne "" ) {
2217
2218             # Turn off die & warn handlers.
2219             local $SIG{__DIE__};
2220             local $SIG{__WARN__};
2221             eval '$inpat =~ m' . "\a$inpat\a";
2222
2223             if ( $@ ne "" ) {
2224
2225                 # Ouch. Not good. Print the error.
2226                 print $OUT $@;
2227                 next CMD;
2228             }
2229             $obj->pat($inpat);
2230         } ## end if ($inpat ne "")
2231
2232         # Where we are now is where to stop after wraparound.
2233         $end = $start;
2234
2235         # Don't move away from this line.
2236         $incr = -1;
2237
2238         my $pat = $obj->pat;
2239         # Search inside the eval to prevent pattern badness
2240         # from killing us.
2241         eval {
2242             no strict q/vars/;
2243             for (;;) {
2244                 # Back up a line.
2245                 --$start;
2246
2247                 # Wrap if we pass the first line.
2248
2249                 $start = $max if ($start <= 0);
2250
2251                 # Quit if we get back where we started,
2252                 last if ($start == $end);
2253
2254                 # Match?
2255                 if ($dbline[$start] =~ m/$pat/i) {
2256                     if ($slave_editor) {
2257                         # Yep, follow slave editor requirements.
2258                         print $OUT "\032\032$filename:$start:0\n";
2259                     }
2260                     else {
2261                         # Yep, just print normally.
2262                         print $OUT "$start:\t",$dbline[$start],"\n";
2263                     }
2264
2265                     # Found, so done.
2266                     last;
2267                 }
2268             }
2269         };
2270
2271         # Say we failed if the loop never found anything,
2272         if ( $start == $end ) {
2273             print {$OUT} "?$pat?: not found\n";
2274         }
2275         next CMD;
2276     }
2277
2278     return;
2279 }
2280
2281 sub _DB__handle_restart_and_rerun_commands {
2282     my ($obj) = @_;
2283
2284     my $cmd_cmd = $obj->cmd_verb;
2285     my $cmd_params = $obj->cmd_args;
2286     # R - restart execution.
2287     # rerun - controlled restart execution.
2288     if ($cmd_cmd eq 'rerun' or $cmd_params eq '') {
2289
2290         # Change directory to the initial current working directory on
2291         # the script startup, so if the debugged program changed the
2292         # directory, then we will still be able to find the path to the
2293         # the program. (perl 5 RT #121509 ).
2294         chdir ($_initial_cwd);
2295
2296         my @args = ($cmd_cmd eq 'R' ? restart() : rerun($cmd_params));
2297
2298         # Close all non-system fds for a clean restart.  A more
2299         # correct method would be to close all fds that were not
2300         # open when the process started, but this seems to be
2301         # hard.  See "debugger 'R'estart and open database
2302         # connections" on p5p.
2303
2304         my $max_fd = 1024; # default if POSIX can't be loaded
2305         if (eval { require POSIX }) {
2306             eval { $max_fd = POSIX::sysconf(POSIX::_SC_OPEN_MAX()) };
2307         }
2308
2309         if (defined $max_fd) {
2310             foreach ($^F+1 .. $max_fd-1) {
2311                 next unless open FD_TO_CLOSE, "<&=$_";
2312                 close(FD_TO_CLOSE);
2313             }
2314         }
2315
2316         # And run Perl again.  We use exec() to keep the
2317         # PID stable (and that way $ini_pids is still valid).
2318         exec(@args) or print {$OUT} "exec failed: $!\n";
2319
2320         last CMD;
2321     }
2322
2323     return;
2324 }
2325
2326 sub _DB__handle_run_command_in_pager_command {
2327     my ($obj) = @_;
2328
2329     if ($cmd =~ m#\A\|\|?\s*[^|]#) {
2330         if ( $pager =~ /^\|/ ) {
2331
2332             # Default pager is into a pipe. Redirect I/O.
2333             open( SAVEOUT, ">&STDOUT" )
2334             || _db_warn("Can't save STDOUT");
2335             open( STDOUT, ">&OUT" )
2336             || _db_warn("Can't redirect STDOUT");
2337         } ## end if ($pager =~ /^\|/)
2338         else {
2339
2340             # Not into a pipe. STDOUT is safe.
2341             open( SAVEOUT, ">&OUT" ) || _db_warn("Can't save DB::OUT");
2342         }
2343
2344         # Fix up environment to record we have less if so.
2345         fix_less();
2346
2347         unless ( $obj->piped(scalar ( open( OUT, $pager ) ) ) ) {
2348
2349             # Couldn't open pipe to pager.
2350             _db_warn("Can't pipe output to '$pager'");
2351             if ( $pager =~ /^\|/ ) {
2352
2353                 # Redirect I/O back again.
2354                 open( OUT, ">&STDOUT" )    # XXX: lost message
2355                 || _db_warn("Can't restore DB::OUT");
2356                 open( STDOUT, ">&SAVEOUT" )
2357                 || _db_warn("Can't restore STDOUT");
2358                 close(SAVEOUT);
2359             } ## end if ($pager =~ /^\|/)
2360             else {
2361
2362                 # Redirect I/O. STDOUT already safe.
2363                 open( OUT, ">&STDOUT" )    # XXX: lost message
2364                 || _db_warn("Can't restore DB::OUT");
2365             }
2366             next CMD;
2367         } ## end unless ($piped = open(OUT,...
2368
2369         # Set up broken-pipe handler if necessary.
2370         $SIG{PIPE} = \&DB::catch
2371         if $pager =~ /^\|/
2372         && ( "" eq $SIG{PIPE} || "DEFAULT" eq $SIG{PIPE} );
2373
2374         _autoflush(\*OUT);
2375         # Save current filehandle, and put it back.
2376         $obj->selected(scalar( select(OUT) ));
2377         # Don't put it back if pager was a pipe.
2378         if ($cmd !~ /\A\|\|/)
2379         {
2380             select($obj->selected());
2381             $obj->selected("");
2382         }
2383
2384         # Trim off the pipe symbols and run the command now.
2385         $cmd =~ s#\A\|+\s*##;
2386         redo PIPE;
2387     }
2388
2389     return;
2390 }
2391
2392 sub _DB__handle_m_command {
2393     my ($obj) = @_;
2394
2395     if ($cmd =~ s#\Am\s+([\w:]+)\s*\z# #) {
2396         methods($1);
2397         next CMD;
2398     }
2399
2400     # m expr - set up DB::eval to do the work
2401     if ($cmd =~ s#\Am\b# #) {    # Rest gets done by DB::eval()
2402         $onetimeDump = 'methods';   #  method output gets used there
2403     }
2404
2405     return;
2406 }
2407
2408 sub _DB__at_end_of_every_command {
2409     my ($obj) = @_;
2410
2411     # At the end of every command:
2412     if ($obj->piped) {
2413
2414         # Unhook the pipe mechanism now.
2415         if ( $pager =~ /^\|/ ) {
2416
2417             # No error from the child.
2418             $? = 0;
2419
2420             # we cannot warn here: the handle is missing --tchrist
2421             close(OUT) || print SAVEOUT "\nCan't close DB::OUT\n";
2422
2423             # most of the $? crud was coping with broken cshisms
2424             # $? is explicitly set to 0, so this never runs.
2425             if ($?) {
2426                 print SAVEOUT "Pager '$pager' failed: ";
2427                 if ( $? == -1 ) {
2428                     print SAVEOUT "shell returned -1\n";
2429                 }
2430                 elsif ( $? >> 8 ) {
2431                     print SAVEOUT ( $? & 127 )
2432                     ? " (SIG#" . ( $? & 127 ) . ")"
2433                     : "", ( $? & 128 ) ? " -- core dumped" : "", "\n";
2434                 }
2435                 else {
2436                     print SAVEOUT "status ", ( $? >> 8 ), "\n";
2437                 }
2438             } ## end if ($?)
2439
2440             # Reopen filehandle for our output (if we can) and
2441             # restore STDOUT (if we can).
2442             open( OUT, ">&STDOUT" ) || _db_warn("Can't restore DB::OUT");
2443             open( STDOUT, ">&SAVEOUT" )
2444             || _db_warn("Can't restore STDOUT");
2445
2446             # Turn off pipe exception handler if necessary.
2447             $SIG{PIPE} = "DEFAULT" if $SIG{PIPE} eq \&DB::catch;
2448
2449             # Will stop ignoring SIGPIPE if done like nohup(1)
2450             # does SIGINT but Perl doesn't give us a choice.
2451         } ## end if ($pager =~ /^\|/)
2452         else {
2453
2454             # Non-piped "pager". Just restore STDOUT.
2455             open( OUT, ">&SAVEOUT" ) || _db_warn("Can't restore DB::OUT");
2456         }
2457
2458         # Let Readline know about the new filehandles.
2459         reset_IN_OUT( \*IN, \*OUT );
2460
2461         # Close filehandle pager was using, restore the normal one
2462         # if necessary,
2463         close(SAVEOUT);
2464
2465         if ($obj->selected() ne "") {
2466             select($obj->selected);
2467             $obj->selected("");
2468         }
2469
2470         # No pipes now.
2471         $obj->piped("");
2472     } ## end if ($piped)
2473
2474     return;
2475 }
2476
2477 sub _DB__handle_watch_expressions
2478 {
2479     my $self = shift;
2480
2481     if ( $DB::trace & 2 ) {
2482         for my $n (0 .. $#DB::to_watch) {
2483             $DB::evalarg = $DB::to_watch[$n];
2484             local $DB::onetimeDump;    # Tell DB::eval() to not output results
2485
2486             # Fix context DB::eval() wants to return an array, but
2487             # we need a scalar here.
2488             my ($val) = join( "', '", DB::eval(@_) );
2489             $val = ( ( defined $val ) ? "'$val'" : 'undef' );
2490
2491             # Did it change?
2492             if ( $val ne $DB::old_watch[$n] ) {
2493
2494                 # Yep! Show the difference, and fake an interrupt.
2495                 $DB::signal = 1;
2496                 print {$DB::OUT} <<EOP;
2497 Watchpoint $n:\t$DB::to_watch[$n] changed:
2498     old value:\t$DB::old_watch[$n]
2499     new value:\t$val
2500 EOP
2501                 $DB::old_watch[$n] = $val;
2502             } ## end if ($val ne $old_watch...
2503         } ## end for my $n (0 ..
2504     } ## end if ($trace & 2)
2505
2506     return;
2507 }
2508
2509 # 't' is type.
2510 # 'm' is method.
2511 # 'v' is the value (i.e: method name or subroutine ref).
2512 # 's' is subroutine.
2513 my %cmd_lookup;
2514
2515 BEGIN
2516 {
2517     %cmd_lookup =
2518 (
2519     '-' => { t => 'm', v => '_handle_dash_command', },
2520     '.' => { t => 's', v => \&_DB__handle_dot_command, },
2521     '=' => { t => 'm', v => '_handle_equal_sign_command', },
2522     'H' => { t => 'm', v => '_handle_H_command', },
2523     'S' => { t => 'm', v => '_handle_S_command', },
2524     'T' => { t => 'm', v => '_handle_T_command', },
2525     'W' => { t => 'm', v => '_handle_W_command', },
2526     'c' => { t => 's', v => \&_DB__handle_c_command, },
2527     'f' => { t => 's', v => \&_DB__handle_f_command, },
2528     'm' => { t => 's', v => \&_DB__handle_m_command, },
2529     'n' => { t => 'm', v => '_handle_n_command', },
2530     'p' => { t => 'm', v => '_handle_p_command', },
2531     'q' => { t => 'm', v => '_handle_q_command', },
2532     'r' => { t => 'm', v => '_handle_r_command', },
2533     's' => { t => 'm', v => '_handle_s_command', },
2534     'save' => { t => 'm', v => '_handle_save_command', },
2535     'source' => { t => 'm', v => '_handle_source_command', },
2536     't' => { t => 'm', v => '_handle_t_command', },
2537     'w' => { t => 'm', v => '_handle_w_command', },
2538     'x' => { t => 'm', v => '_handle_x_command', },
2539     'y' => { t => 's', v => \&_DB__handle_y_command, },
2540     (map { $_ => { t => 'm', v => '_handle_V_command_and_X_command', }, }
2541         ('X', 'V')),
2542     (map { $_ => { t => 'm', v => '_handle_enable_disable_commands', }, }
2543         qw(enable disable)),
2544     (map { $_ =>
2545         { t => 's', v => \&_DB__handle_restart_and_rerun_commands, },
2546         } qw(R rerun)),
2547     (map { $_ => {t => 'm', v => '_handle_cmd_wrapper_commands' }, }
2548         qw(a A b B e E h i l L M o O v w W)),
2549 );
2550 };
2551
2552 sub DB {
2553
2554     # lock the debugger and get the thread id for the prompt
2555     lock($DBGR);
2556     my $tid;
2557     my $position;
2558     my ($prefix, $after, $infix);
2559     my $pat;
2560     my $explicit_stop;
2561     my $piped;
2562     my $selected;
2563
2564     if ($ENV{PERL5DB_THREADED}) {
2565         $tid = eval { "[".threads->tid."]" };
2566     }
2567
2568     my $cmd_verb;
2569     my $cmd_args;
2570
2571     my $obj = DB::Obj->new(
2572         {
2573             position => \$position,
2574             prefix => \$prefix,
2575             after => \$after,
2576             explicit_stop => \$explicit_stop,
2577             infix => \$infix,
2578             cmd_args => \$cmd_args,
2579             cmd_verb => \$cmd_verb,
2580             pat => \$pat,
2581             piped => \$piped,
2582             selected => \$selected,
2583         },
2584     );
2585
2586     $obj->_DB_on_init__initialize_globals(@_);
2587
2588     # Preserve current values of $@, $!, $^E, $,, $/, $\, $^W.
2589     # The code being debugged may have altered them.
2590     DB::save();
2591
2592     # Since DB::DB gets called after every line, we can use caller() to
2593     # figure out where we last were executing. Sneaky, eh? This works because
2594     # caller is returning all the extra information when called from the
2595     # debugger.
2596     local ( $package, $filename, $line ) = caller;
2597     $filename_ini = $filename;
2598
2599     # set up the context for DB::eval, so it can properly execute
2600     # code on behalf of the user. We add the package in so that the
2601     # code is eval'ed in the proper package (not in the debugger!).
2602     local $usercontext = _calc_usercontext($package);
2603
2604     # Create an alias to the active file magical array to simplify
2605     # the code here.
2606     local (*dbline) = $main::{ '_<' . $filename };
2607
2608     # Last line in the program.
2609     $max = $#dbline;
2610
2611     # The &-call is here to ascertain the mutability of @_.
2612     &_DB__determine_if_we_should_break;
2613
2614     # Preserve the current stop-or-not, and see if any of the W
2615     # (watch expressions) has changed.
2616     my $was_signal = $signal;
2617
2618     # If we have any watch expressions ...
2619     _DB__handle_watch_expressions($obj);
2620
2621 =head2 C<watchfunction()>
2622
2623 C<watchfunction()> is a function that can be defined by the user; it is a
2624 function which will be run on each entry to C<DB::DB>; it gets the
2625 current package, filename, and line as its parameters.
2626
2627 The watchfunction can do anything it likes; it is executing in the
2628 debugger's context, so it has access to all of the debugger's internal
2629 data structures and functions.
2630
2631 C<watchfunction()> can control the debugger's actions. Any of the following
2632 will cause the debugger to return control to the user's program after
2633 C<watchfunction()> executes:
2634
2635 =over 4
2636
2637 =item *
2638
2639 Returning a false value from the C<watchfunction()> itself.
2640
2641 =item *
2642
2643 Altering C<$single> to a false value.
2644
2645 =item *
2646
2647 Altering C<$signal> to a false value.
2648
2649 =item *
2650
2651 Turning off the C<4> bit in C<$trace> (this also disables the
2652 check for C<watchfunction()>. This can be done with
2653
2654     $trace &= ~4;
2655
2656 =back
2657
2658 =cut
2659
2660     # If there's a user-defined DB::watchfunction, call it with the
2661     # current package, filename, and line. The function executes in
2662     # the DB:: package.
2663     if ( $trace & 4 ) {    # User-installed watch
2664         return
2665           if watchfunction( $package, $filename, $line )
2666           and not $single
2667           and not $was_signal
2668           and not( $trace & ~4 );
2669     } ## end if ($trace & 4)
2670
2671     # Pick up any alteration to $signal in the watchfunction, and
2672     # turn off the signal now.
2673     $was_signal = $signal;
2674     $signal     = 0;
2675
2676 =head2 GETTING READY TO EXECUTE COMMANDS
2677
2678 The debugger decides to take control if single-step mode is on, the
2679 C<t> command was entered, or the user generated a signal. If the program
2680 has fallen off the end, we set things up so that entering further commands
2681 won't cause trouble, and we say that the program is over.
2682
2683 =cut
2684
2685     # Make sure that we always print if asked for explicitly regardless
2686     # of $trace_to_depth .
2687     $explicit_stop = ($single || $was_signal);
2688
2689     # Check to see if we should grab control ($single true,
2690     # trace set appropriately, or we got a signal).
2691     if ( $explicit_stop || ( $trace & 1 ) ) {
2692         $obj->_DB__grab_control(@_);
2693     } ## end if ($single || ($trace...
2694
2695 =pod
2696
2697 If there's an action to be executed for the line we stopped at, execute it.
2698 If there are any preprompt actions, execute those as well.
2699
2700 =cut
2701
2702     # If there's an action, do it now.
2703     if ($action) {
2704         $evalarg = $action;
2705         # The &-call is here to ascertain the mutability of @_.
2706         &DB::eval;
2707     }
2708
2709     # Are we nested another level (e.g., did we evaluate a function
2710     # that had a breakpoint in it at the debugger prompt)?
2711     if ( $single || $was_signal ) {
2712
2713         # Yes, go down a level.
2714         local $level = $level + 1;
2715
2716         # Do any pre-prompt actions.
2717         foreach $evalarg (@$pre) {
2718             # The &-call is here to ascertain the mutability of @_.
2719             &DB::eval;
2720         }
2721
2722         # Complain about too much recursion if we passed the limit.
2723         if ($single & 4) {
2724             print $OUT $stack_depth . " levels deep in subroutine calls!\n";
2725         }
2726
2727         # The line we're currently on. Set $incr to -1 to stay here
2728         # until we get a command that tells us to advance.
2729         $start = $line;
2730         $incr  = -1;      # for backward motion.
2731
2732         # Tack preprompt debugger actions ahead of any actual input.
2733         @typeahead = ( @$pretype, @typeahead );
2734
2735 =head2 WHERE ARE WE?
2736
2737 XXX Relocate this section?
2738
2739 The debugger normally shows the line corresponding to the current line of
2740 execution. Sometimes, though, we want to see the next line, or to move elsewhere
2741 in the file. This is done via the C<$incr>, C<$start>, and C<$max> variables.
2742
2743 C<$incr> controls by how many lines the I<current> line should move forward
2744 after a command is executed. If set to -1, this indicates that the I<current>
2745 line shouldn't change.
2746
2747 C<$start> is the I<current> line. It is used for things like knowing where to
2748 move forwards or backwards from when doing an C<L> or C<-> command.
2749
2750 C<$max> tells the debugger where the last line of the current file is. It's
2751 used to terminate loops most often.
2752
2753 =head2 THE COMMAND LOOP
2754
2755 Most of C<DB::DB> is actually a command parsing and dispatch loop. It comes
2756 in two parts:
2757
2758 =over 4
2759
2760 =item *
2761
2762 The outer part of the loop, starting at the C<CMD> label. This loop
2763 reads a command and then executes it.
2764
2765 =item *
2766
2767 The inner part of the loop, starting at the C<PIPE> label. This part
2768 is wholly contained inside the C<CMD> block and only executes a command.
2769 Used to handle commands running inside a pager.
2770
2771 =back
2772
2773 So why have two labels to restart the loop? Because sometimes, it's easier to
2774 have a command I<generate> another command and then re-execute the loop to do
2775 the new command. This is faster, but perhaps a bit more convoluted.
2776
2777 =cut
2778
2779         # The big command dispatch loop. It keeps running until the
2780         # user yields up control again.
2781         #
2782         # If we have a terminal for input, and we get something back
2783         # from readline(), keep on processing.
2784
2785       CMD:
2786         while (_DB__read_next_cmd($tid))
2787         {
2788
2789             share($cmd);
2790             # ... try to execute the input as debugger commands.
2791
2792             # Don't stop running.
2793             $single = 0;
2794
2795             # No signal is active.
2796             $signal = 0;
2797
2798             # Handle continued commands (ending with \):
2799             if ($cmd =~ s/\\\z/\n/) {
2800                 $cmd .= DB::readline("  cont: ");
2801                 redo CMD;
2802             }
2803
2804 =head4 The null command
2805
2806 A newline entered by itself means I<re-execute the last command>. We grab the
2807 command out of C<$laststep> (where it was recorded previously), and copy it
2808 back into C<$cmd> to be executed below. If there wasn't any previous command,
2809 we'll do nothing below (no command will match). If there was, we also save it
2810 in the command history and fall through to allow the command parsing to pick
2811 it up.
2812
2813 =cut
2814
2815             # Empty input means repeat the last command.
2816             if ($cmd eq '') {
2817                 $cmd = $laststep;
2818             }
2819             chomp($cmd);    # get rid of the annoying extra newline
2820             if (length($cmd) >= 2) {
2821                 push( @hist, $cmd );
2822             }
2823             push( @truehist, $cmd );
2824             share(@hist);
2825             share(@truehist);
2826
2827             # This is a restart point for commands that didn't arrive
2828             # via direct user input. It allows us to 'redo PIPE' to
2829             # re-execute command processing without reading a new command.
2830           PIPE: {
2831                 _DB__trim_command_and_return_first_component($obj);
2832
2833 =head3 COMMAND ALIASES
2834
2835 The debugger can create aliases for commands (these are stored in the
2836 C<%alias> hash). Before a command is executed, the command loop looks it up
2837 in the alias hash and substitutes the contents of the alias for the command,
2838 completely replacing it.
2839
2840 =cut
2841
2842                 # See if there's an alias for the command, and set it up if so.
2843                 if ( $alias{$cmd_verb} ) {
2844
2845                     # Squelch signal handling; we want to keep control here
2846                     # if something goes loco during the alias eval.
2847                     local $SIG{__DIE__};
2848                     local $SIG{__WARN__};
2849
2850                     # This is a command, so we eval it in the DEBUGGER's
2851                     # scope! Otherwise, we can't see the special debugger
2852                     # variables, or get to the debugger's subs. (Well, we
2853                     # _could_, but why make it even more complicated?)
2854                     eval "\$cmd =~ $alias{$cmd_verb}";
2855                     if ($@) {
2856                         local $\ = '';
2857                         print $OUT "Couldn't evaluate '$cmd_verb' alias: $@";
2858                         next CMD;
2859                     }
2860                     _DB__trim_command_and_return_first_component($obj);
2861                 } ## end if ($alias{$cmd_verb})
2862
2863 =head3 MAIN-LINE COMMANDS
2864
2865 All of these commands work up to and after the program being debugged has
2866 terminated.
2867
2868 =head4 C<q> - quit
2869
2870 Quit the debugger. This entails setting the C<$fall_off_end> flag, so we don't
2871 try to execute further, cleaning any restart-related stuff out of the
2872 environment, and executing with the last value of C<$?>.
2873
2874 =cut
2875
2876                 # All of these commands were remapped in perl 5.8.0;
2877                 # we send them off to the secondary dispatcher (see below).
2878                 $obj->_handle_special_char_cmd_wrapper_commands;
2879                 _DB__trim_command_and_return_first_component($obj);
2880
2881                 if (my $cmd_rec = $cmd_lookup{$cmd_verb}) {
2882                     my $type = $cmd_rec->{t};
2883                     my $val = $cmd_rec->{v};
2884                     if ($type eq 'm') {
2885                         $obj->$val();
2886                     }
2887                     elsif ($type eq 's') {
2888                         $val->($obj);
2889                     }
2890                 }
2891
2892 =head4 C<t> - trace [n]
2893
2894 Turn tracing on or off. Inverts the appropriate bit in C<$trace> (q.v.).
2895 If level is specified, set C<$trace_to_depth>.
2896
2897 =head4 C<S> - list subroutines matching/not matching a pattern
2898
2899 Walks through C<%sub>, checking to see whether or not to print the name.
2900
2901 =head4 C<X> - list variables in current package
2902
2903 Since the C<V> command actually processes this, just change this to the
2904 appropriate C<V> command and fall through.
2905
2906 =head4 C<V> - list variables
2907
2908 Uses C<dumpvar.pl> to dump out the current values for selected variables.
2909
2910 =head4 C<x> - evaluate and print an expression
2911
2912 Hands the expression off to C<DB::eval>, setting it up to print the value
2913 via C<dumpvar.pl> instead of just printing it directly.
2914
2915 =head4 C<m> - print methods
2916
2917 Just uses C<DB::methods> to determine what methods are available.
2918
2919 =head4 C<f> - switch files
2920
2921 Switch to a different filename.
2922
2923 =head4 C<.> - return to last-executed line.
2924
2925 We set C<$incr> to -1 to indicate that the debugger shouldn't move ahead,
2926 and then we look up the line in the magical C<%dbline> hash.
2927
2928 =head4 C<-> - back one window
2929
2930 We change C<$start> to be one window back; if we go back past the first line,
2931 we set it to be the first line. We ser C<$incr> to put us back at the
2932 currently-executing line, and then put a C<l $start +> (list one window from
2933 C<$start>) in C<$cmd> to be executed later.
2934
2935 =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>>
2936
2937 In Perl 5.8.0, a realignment of the commands was done to fix up a number of
2938 problems, most notably that the default case of several commands destroying
2939 the user's work in setting watchpoints, actions, etc. We wanted, however, to
2940 retain the old commands for those who were used to using them or who preferred
2941 them. At this point, we check for the new commands and call C<cmd_wrapper> to
2942 deal with them instead of processing them in-line.
2943
2944 =head4 C<y> - List lexicals in higher scope
2945
2946 Uses C<PadWalker> to find the lexicals supplied as arguments in a scope
2947 above the current one and then displays then using C<dumpvar.pl>.
2948
2949 =head3 COMMANDS NOT WORKING AFTER PROGRAM ENDS
2950
2951 All of the commands below this point don't work after the program being
2952 debugged has ended. All of them check to see if the program has ended; this
2953 allows the commands to be relocated without worrying about a 'line of
2954 demarcation' above which commands can be entered anytime, and below which
2955 they can't.
2956
2957 =head4 C<n> - single step, but don't trace down into subs
2958
2959 Done by setting C<$single> to 2, which forces subs to execute straight through
2960 when entered (see C<DB::sub>). We also save the C<n> command in C<$laststep>,
2961 so a null command knows what to re-execute.
2962
2963 =head4 C<s> - single-step, entering subs
2964
2965 Sets C<$single> to 1, which causes C<DB::sub> to continue tracing inside
2966 subs. Also saves C<s> as C<$lastcmd>.
2967
2968 =head4 C<c> - run continuously, setting an optional breakpoint
2969
2970 Most of the code for this command is taken up with locating the optional
2971 breakpoint, which is either a subroutine name or a line number. We set
2972 the appropriate one-time-break in C<@dbline> and then turn off single-stepping
2973 in this and all call levels above this one.
2974
2975 =head4 C<r> - return from a subroutine
2976
2977 For C<r> to work properly, the debugger has to stop execution again
2978 immediately after the return is executed. This is done by forcing
2979 single-stepping to be on in the call level above the current one. If
2980 we are printing return values when a C<r> is executed, set C<$doret>
2981 appropriately, and force us out of the command loop.
2982
2983 =head4 C<T> - stack trace
2984
2985 Just calls C<DB::print_trace>.
2986
2987 =head4 C<w> - List window around current line.
2988
2989 Just calls C<DB::cmd_w>.
2990
2991 =head4 C<W> - watch-expression processing.
2992
2993 Just calls C<DB::cmd_W>.
2994
2995 =head4 C</> - search forward for a string in the source
2996
2997 We take the argument and treat it as a pattern. If it turns out to be a
2998 bad one, we return the error we got from trying to C<eval> it and exit.
2999 If not, we create some code to do the search and C<eval> it so it can't
3000 mess us up.
3001
3002 =cut
3003
3004                 _DB__handle_forward_slash_command($obj);
3005
3006 =head4 C<?> - search backward for a string in the source
3007
3008 Same as for C</>, except the loop runs backwards.
3009
3010 =cut
3011
3012                 _DB__handle_question_mark_command($obj);
3013
3014 =head4 C<$rc> - Recall command
3015
3016 Manages the commands in C<@hist> (which is created if C<Term::ReadLine> reports
3017 that the terminal supports history). It finds the command required, puts it
3018 into C<$cmd>, and redoes the loop to execute it.
3019
3020 =cut
3021
3022                 # $rc - recall command.
3023                 $obj->_handle_rc_recall_command;
3024
3025 =head4 C<$sh$sh> - C<system()> command
3026
3027 Calls the C<_db_system()> to handle the command. This keeps the C<STDIN> and
3028 C<STDOUT> from getting messed up.
3029
3030 =cut
3031
3032                 $obj->_handle_sh_command;
3033
3034 =head4 C<$rc I<pattern> $rc> - Search command history
3035
3036 Another command to manipulate C<@hist>: this one searches it with a pattern.
3037 If a command is found, it is placed in C<$cmd> and executed via C<redo>.
3038
3039 =cut
3040
3041                 $obj->_handle_rc_search_history_command;
3042
3043 =head4 C<$sh> - Invoke a shell
3044
3045 Uses C<_db_system()> to invoke a shell.
3046
3047 =cut
3048
3049 =head4 C<$sh I<command>> - Force execution of a command in a shell
3050
3051 Like the above, but the command is passed to the shell. Again, we use
3052 C<_db_system()> to avoid problems with C<STDIN> and C<STDOUT>.
3053
3054 =head4 C<H> - display commands in history
3055
3056 Prints the contents of C<@hist> (if any).
3057
3058 =head4 C<man, doc, perldoc> - look up documentation
3059
3060 Just calls C<runman()> to print the appropriate document.
3061
3062 =cut
3063
3064                 $obj->_handle_doc_command;
3065
3066 =head4 C<p> - print
3067
3068 Builds a C<print EXPR> expression in the C<$cmd>; this will get executed at
3069 the bottom of the loop.
3070
3071 =head4 C<=> - define command alias
3072
3073 Manipulates C<%alias> to add or list command aliases.
3074
3075 =head4 C<source> - read commands from a file.
3076
3077 Opens a lexical filehandle and stacks it on C<@cmdfhs>; C<DB::readline> will
3078 pick it up.
3079
3080 =head4 C<enable> C<disable> - enable or disable breakpoints
3081
3082 This enables or disables breakpoints.
3083
3084 =head4 C<save> - send current history to a file
3085
3086 Takes the complete history, (not the shrunken version you see with C<H>),
3087 and saves it to the given filename, so it can be replayed using C<source>.
3088
3089 Note that all C<^(save|source)>'s are commented out with a view to minimise recursion.
3090
3091 =head4 C<R> - restart
3092
3093 Restart the debugger session.
3094
3095 =head4 C<rerun> - rerun the current session
3096
3097 Return to any given position in the B<true>-history list
3098
3099 =head4 C<|, ||> - pipe output through the pager.
3100
3101 For C<|>, we save C<OUT> (the debugger's output filehandle) and C<STDOUT>
3102 (the program's standard output). For C<||>, we only save C<OUT>. We open a
3103 pipe to the pager (restoring the output filehandles if this fails). If this
3104 is the C<|> command, we also set up a C<SIGPIPE> handler which will simply
3105 set C<$signal>, sending us back into the debugger.
3106
3107 We then trim off the pipe symbols and C<redo> the command loop at the
3108 C<PIPE> label, causing us to evaluate the command in C<$cmd> without
3109 reading another.
3110
3111 =cut
3112
3113                 # || - run command in the pager, with output to DB::OUT.
3114                 _DB__handle_run_command_in_pager_command($obj);
3115
3116 =head3 END OF COMMAND PARSING
3117
3118 Anything left in C<$cmd> at this point is a Perl expression that we want to
3119 evaluate. We'll always evaluate in the user's context, and fully qualify
3120 any variables we might want to address in the C<DB> package.
3121
3122 =cut
3123
3124             }    # PIPE:
3125
3126             # trace an expression
3127             $cmd =~ s/^t\s/\$DB::trace |= 1;\n/;
3128
3129             # Make sure the flag that says "the debugger's running" is
3130             # still on, to make sure we get control again.
3131             $evalarg = "\$^D = \$^D | \$DB::db_stop;\n$cmd";
3132
3133             # Run *our* eval that executes in the caller's context.
3134             # The &-call is here to ascertain the mutability of @_.
3135             &DB::eval;
3136
3137             # Turn off the one-time-dump stuff now.
3138             if ($onetimeDump) {
3139                 $onetimeDump      = undef;
3140                 $onetimedumpDepth = undef;
3141             }
3142             elsif ( $term_pid == $$ ) {
3143                 eval { # May run under miniperl, when not available...
3144                     STDOUT->flush();
3145                     STDERR->flush();
3146                 };
3147
3148                 # XXX If this is the master pid, print a newline.
3149                 print {$OUT} "\n";
3150             }
3151         } ## end while (($term || &setterm...
3152
3153 =head3 POST-COMMAND PROCESSING
3154
3155 After each command, we check to see if the command output was piped anywhere.
3156 If so, we go through the necessary code to unhook the pipe and go back to
3157 our standard filehandles for input and output.
3158
3159 =cut
3160
3161         continue {    # CMD:
3162             _DB__at_end_of_every_command($obj);
3163         }    # CMD:
3164
3165 =head3 COMMAND LOOP TERMINATION
3166
3167 When commands have finished executing, we come here. If the user closed the
3168 input filehandle, we turn on C<$fall_off_end> to emulate a C<q> command. We
3169 evaluate any post-prompt items. We restore C<$@>, C<$!>, C<$^E>, C<$,>, C<$/>,
3170 C<$\>, and C<$^W>, and return a null list as expected by the Perl interpreter.
3171 The interpreter will then execute the next line and then return control to us
3172 again.
3173
3174 =cut
3175
3176         # No more commands? Quit.
3177         $fall_off_end = 1 unless defined $cmd;    # Emulate 'q' on EOF
3178
3179         # Evaluate post-prompt commands.
3180         foreach $evalarg (@$post) {
3181             # The &-call is here to ascertain the mutability of @_.
3182             &DB::eval;
3183         }
3184     }    # if ($single || $signal)
3185
3186     # Put the user's globals back where you found them.
3187     ( $@, $!, $^E, $,, $/, $\, $^W ) = @saved;
3188     ();
3189 } ## end sub DB
3190
3191 # Because DB::Obj is used above,
3192 #
3193 #   my $obj = DB::Obj->new(
3194 #
3195 # The following package declaration must come before that,
3196 # or else runtime errors will occur with
3197 #
3198 #   PERLDB_OPTS="autotrace nonstop"
3199 #
3200 # ( rt#116771 )
3201 BEGIN {
3202
3203 package DB::Obj;
3204
3205 sub new {
3206     my $class = shift;
3207
3208     my $self = bless {}, $class;
3209
3210     $self->_init(@_);
3211
3212     return $self;
3213 }
3214
3215 sub _init {
3216     my ($self, $args) = @_;
3217
3218     %{$self} = (%$self, %$args);
3219
3220     return;
3221 }
3222
3223 {
3224     no strict 'refs';
3225     foreach my $slot_name (qw(
3226         after explicit_stop infix pat piped position prefix selected cmd_verb
3227         cmd_args
3228         )) {
3229         my $slot = $slot_name;
3230         *{$slot} = sub {
3231             my $self = shift;
3232
3233             if (@_) {
3234                 ${ $self->{$slot} } = shift;
3235             }
3236
3237             return ${ $self->{$slot} };
3238         };
3239
3240         *{"append_to_$slot"} = sub {
3241             my $self = shift;
3242             my $s = shift;
3243
3244             return $self->$slot($self->$slot . $s);
3245         };
3246     }
3247 }
3248
3249 sub _DB_on_init__initialize_globals
3250 {
3251     my $self = shift;
3252
3253     # Check for whether we should be running continuously or not.
3254     # _After_ the perl program is compiled, $single is set to 1:
3255     if ( $single and not $second_time++ ) {
3256
3257         # Options say run non-stop. Run until we get an interrupt.
3258         if ($runnonstop) {    # Disable until signal
3259                 # If there's any call stack in place, turn off single
3260                 # stepping into subs throughout the stack.
3261             for my $i (0 .. $stack_depth) {
3262                 $stack[ $i ] &= ~1;
3263             }
3264
3265             # And we are now no longer in single-step mode.
3266             $single = 0;
3267
3268             # If we simply returned at this point, we wouldn't get
3269             # the trace info. Fall on through.
3270             # return;
3271         } ## end if ($runnonstop)
3272
3273         elsif ($ImmediateStop) {
3274
3275             # We are supposed to stop here; XXX probably a break.
3276             $ImmediateStop = 0;    # We've processed it; turn it off
3277             $signal        = 1;    # Simulate an interrupt to force
3278                                    # us into the command loop
3279         }
3280     } ## end if ($single and not $second_time...
3281
3282     # If we're in single-step mode, or an interrupt (real or fake)
3283     # has occurred, turn off non-stop mode.
3284     $runnonstop = 0 if $single or $signal;
3285
3286     return;
3287 }
3288
3289 sub _my_print_lineinfo
3290 {
3291     my ($self, $i, $incr_pos) = @_;
3292
3293     if ($frame) {
3294         # Print it indented if tracing is on.
3295         DB::print_lineinfo( ' ' x $stack_depth,
3296             "$i:\t$DB::dbline[$i]" . $self->after );
3297     }
3298     else {
3299         DB::depth_print_lineinfo($self->explicit_stop, $incr_pos);
3300     }
3301 }
3302
3303 sub _curr_line {
3304     return $DB::dbline[$line];
3305 }
3306
3307 sub _is_full {
3308     my ($self, $letter) = @_;
3309
3310     return ($DB::cmd eq $letter);
3311 }
3312
3313 sub _DB__grab_control
3314 {
3315     my $self = shift;
3316
3317     # Yes, grab control.
3318     if ($slave_editor) {
3319
3320         # Tell the editor to update its position.
3321         $self->position("\032\032${DB::filename}:$line:0\n");
3322         DB::print_lineinfo($self->position());
3323     }
3324
3325 =pod
3326
3327 Special check: if we're in package C<DB::fake>, we've gone through the
3328 C<END> block at least once. We set up everything so that we can continue
3329 to enter commands and have a valid context to be in.
3330
3331 =cut
3332
3333     elsif ( $DB::package eq 'DB::fake' ) {
3334
3335         # Fallen off the end already.
3336         if (!$DB::term) {
3337             DB::setterm();
3338         }
3339
3340         DB::print_help(<<EOP);
3341 Debugged program terminated.  Use B<q> to quit or B<R> to restart,
3342 use B<o> I<inhibit_exit> to avoid stopping after program termination,
3343 B<h q>, B<h R> or B<h o> to get additional info.
3344 EOP
3345
3346         # Set the DB::eval context appropriately.
3347         # At program termination disable any user actions.
3348         $DB::action = undef;
3349
3350         $DB::package     = 'main';
3351         $DB::usercontext = DB::_calc_usercontext($DB::package);
3352     } ## end elsif ($package eq 'DB::fake')
3353
3354 =pod
3355
3356 If the program hasn't finished executing, we scan forward to the
3357 next executable line, print that out, build the prompt from the file and line
3358 number information, and print that.
3359
3360 =cut
3361
3362     else {
3363
3364
3365         # Still somewhere in the midst of execution. Set up the
3366         #  debugger prompt.
3367         $DB::sub =~ s/\'/::/;    # Swap Perl 4 package separators (') to
3368                              # Perl 5 ones (sorry, we don't print Klingon
3369                              #module names)
3370
3371         $self->prefix($DB::sub =~ /::/ ? "" : ($DB::package . '::'));
3372         $self->append_to_prefix( "$DB::sub(${DB::filename}:" );
3373         $self->after( $self->_curr_line =~ /\n$/ ? '' : "\n" );
3374
3375         # Break up the prompt if it's really long.
3376         if ( length($self->prefix()) > 30 ) {
3377             $self->position($self->prefix . "$line):\n$line:\t" . $self->_curr_line . $self->after);
3378             $self->prefix("");
3379             $self->infix(":\t");
3380         }
3381         else {
3382             $self->infix("):\t");
3383             $self->position(
3384                 $self->prefix . $line. $self->infix
3385                 . $self->_curr_line . $self->after
3386             );
3387         }
3388
3389         # Print current line info, indenting if necessary.
3390         $self->_my_print_lineinfo($line, $self->position);
3391
3392         my $i;
3393         my $line_i = sub { return $DB::dbline[$i]; };
3394
3395         # Scan forward, stopping at either the end or the next
3396         # unbreakable line.
3397         for ( $i = $line + 1 ; $i <= $DB::max && $line_i->() == 0 ; ++$i )
3398         {    #{ vi
3399
3400             # Drop out on null statements, block closers, and comments.
3401             last if $line_i->() =~ /^\s*[\;\}\#\n]/;
3402
3403             # Drop out if the user interrupted us.
3404             last if $signal;
3405
3406             # Append a newline if the line doesn't have one. Can happen
3407             # in eval'ed text, for instance.
3408             $self->after( $line_i->() =~ /\n$/ ? '' : "\n" );
3409
3410             # Next executable line.
3411             my $incr_pos = $self->prefix . $i . $self->infix . $line_i->()
3412                 . $self->after;
3413             $self->append_to_position($incr_pos);
3414             $self->_my_print_lineinfo($i, $incr_pos);
3415         } ## end for ($i = $line + 1 ; $i...
3416     } ## end else [ if ($slave_editor)
3417
3418     return;
3419 }
3420
3421 sub _handle_t_command {
3422     my $self = shift;
3423
3424     my $levels = $self->cmd_args();
3425
3426     if ((!length($levels)) or ($levels !~ /\D/)) {
3427         $trace ^= 1;
3428         local $\ = '';
3429         $DB::trace_to_depth = $levels ? $stack_depth + $levels : 1E9;
3430         print {$OUT} "Trace = "
3431         . ( ( $trace & 1 )
3432             ? ( $levels ? "on (to level $DB::trace_to_depth)" : "on" )
3433             : "off" ) . "\n";
3434         next CMD;
3435     }
3436
3437     return;
3438 }
3439
3440
3441 sub _handle_S_command {
3442     my $self = shift;
3443
3444     if (my ($print_all_subs, $should_reverse, $Spatt)
3445         = $self->cmd_args =~ /\A((!)?(.+))?\z/) {
3446         # $Spatt is the pattern (if any) to use.
3447         # Reverse scan?
3448         my $Srev     = defined $should_reverse;
3449         # No args - print all subs.
3450         my $Snocheck = !defined $print_all_subs;
3451
3452         # Need to make these sane here.
3453         local $\ = '';
3454         local $, = '';
3455
3456         # Search through the debugger's magical hash of subs.
3457         # If $nocheck is true, just print the sub name.
3458         # Otherwise, check it against the pattern. We then use
3459         # the XOR trick to reverse the condition as required.
3460         foreach $subname ( sort( keys %sub ) ) {
3461             if ( $Snocheck or $Srev ^ ( $subname =~ /$Spatt/ ) ) {
3462                 print $OUT $subname, "\n";
3463             }
3464         }
3465         next CMD;
3466     }
3467
3468     return;
3469 }
3470
3471 sub _handle_V_command_and_X_command {
3472     my $self = shift;
3473
3474     $DB::cmd =~ s/^X\b/V $DB::package/;
3475
3476     # Bare V commands get the currently-being-debugged package
3477     # added.
3478     if ($self->_is_full('V')) {
3479         $DB::cmd = "V $DB::package";
3480     }
3481
3482     # V - show variables in package.
3483     if (my ($new_packname, $new_vars_str) =
3484         $DB::cmd =~ /\AV\b\s*(\S+)\s*(.*)/) {
3485
3486         # Save the currently selected filehandle and
3487         # force output to debugger's filehandle (dumpvar
3488         # just does "print" for output).
3489         my $savout = select($OUT);
3490
3491         # Grab package name and variables to dump.
3492         $packname = $new_packname;
3493         my @vars     = split( ' ', $new_vars_str );
3494
3495         # If main::dumpvar isn't here, get it.
3496         do 'dumpvar.pl' || die $@ unless defined &main::dumpvar;
3497         if ( defined &main::dumpvar ) {
3498
3499             # We got it. Turn off subroutine entry/exit messages
3500             # for the moment, along with return values.
3501             local $frame = 0;
3502             local $doret = -2;
3503
3504             # must detect sigpipe failures  - not catching
3505             # then will cause the debugger to die.
3506             eval {
3507                 main::dumpvar(
3508                     $packname,
3509                     defined $option{dumpDepth}
3510                     ? $option{dumpDepth}
3511                     : -1,    # assume -1 unless specified
3512                     @vars
3513                 );
3514             };
3515
3516             # The die doesn't need to include the $@, because
3517             # it will automatically get propagated for us.
3518             if ($@) {
3519                 die unless $@ =~ /dumpvar print failed/;
3520             }
3521         } ## end if (defined &main::dumpvar)
3522         else {
3523
3524             # Couldn't load dumpvar.
3525             print $OUT "dumpvar.pl not available.\n";
3526         }
3527
3528         # Restore the output filehandle, and go round again.
3529         select($savout);
3530         next CMD;
3531     }
3532
3533     return;
3534 }
3535
3536 sub _handle_dash_command {
3537     my $self = shift;
3538
3539     if ($self->_is_full('-')) {
3540
3541         # back up by a window; go to 1 if back too far.
3542         $start -= $incr + $window + 1;
3543         $start = 1 if $start <= 0;
3544         $incr  = $window - 1;
3545
3546         # Generate and execute a "l +" command (handled below).
3547         $DB::cmd = 'l ' . ($start) . '+';
3548         redo CMD;
3549     }
3550     return;
3551 }
3552
3553 sub _n_or_s_commands_generic {
3554     my ($self, $new_val) = @_;
3555     # n - next
3556     next CMD if DB::_DB__is_finished();
3557
3558     # Single step, but don't enter subs.
3559     $single = $new_val;
3560
3561     # Save for empty command (repeat last).
3562     $laststep = $DB::cmd;
3563     last CMD;
3564 }
3565
3566 sub _n_or_s {
3567     my ($self, $letter, $new_val) = @_;
3568
3569     if ($self->_is_full($letter)) {
3570         $self->_n_or_s_commands_generic($new_val);
3571     }
3572     else {
3573         $self->_n_or_s_and_arg_commands_generic($letter, $new_val);
3574     }
3575
3576     return;
3577 }
3578
3579 sub _handle_n_command {
3580     my $self = shift;
3581
3582     return $self->_n_or_s('n', 2);
3583 }
3584
3585 sub _handle_s_command {
3586     my $self = shift;
3587
3588     return $self->_n_or_s('s', 1);
3589 }
3590
3591 sub _handle_r_command {
3592     my $self = shift;
3593
3594     # r - return from the current subroutine.
3595     if ($self->_is_full('r')) {
3596
3597         # Can't do anything if the program's over.
3598         next CMD if DB::_DB__is_finished();
3599
3600         # Turn on stack trace.
3601         $stack[$stack_depth] |= 1;
3602
3603         # Print return value unless the stack is empty.
3604         $doret = $option{PrintRet} ? $stack_depth - 1 : -2;
3605         last CMD;
3606     }
3607
3608     return;
3609 }
3610
3611 sub _handle_T_command {
3612     my $self = shift;
3613
3614     if ($self->_is_full('T')) {
3615         DB::print_trace( $OUT, 1 );    # skip DB
3616         next CMD;
3617     }
3618
3619     return;
3620 }
3621
3622 sub _handle_w_command {
3623     my $self = shift;
3624
3625     DB::cmd_w( 'w', $self->cmd_args() );
3626     next CMD;
3627
3628     return;
3629 }
3630
3631 sub _handle_W_command {
3632     my $self = shift;
3633
3634     if (my $arg = $self->cmd_args) {
3635         DB::cmd_W( 'W', $arg );
3636         next CMD;
3637     }
3638
3639     return;
3640 }
3641
3642 sub _handle_rc_recall_command {
3643     my $self = shift;
3644
3645     # $rc - recall command.
3646     if (my ($minus, $arg) = $DB::cmd =~ m#\A$rc+\s*(-)?(\d+)?\z#) {
3647
3648         # No arguments, take one thing off history.
3649         pop(@hist) if length($DB::cmd) > 1;
3650
3651         # Relative (- found)?
3652         #  Y - index back from most recent (by 1 if bare minus)
3653         #  N - go to that particular command slot or the last
3654         #      thing if nothing following.
3655
3656         $self->cmd_verb(
3657             scalar($minus ? ( $#hist - ( $arg || 1 ) ) : ( $arg || $#hist ))
3658         );
3659
3660         # Pick out the command desired.
3661         $DB::cmd = $hist[$self->cmd_verb];
3662
3663         # Print the command to be executed and restart the loop
3664         # with that command in the buffer.
3665         print {$OUT} $DB::cmd, "\n";
3666         redo CMD;
3667     }
3668
3669     return;
3670 }
3671
3672 sub _handle_rc_search_history_command {
3673     my $self = shift;
3674
3675     # $rc pattern $rc - find a command in the history.
3676     if (my ($arg) = $DB::cmd =~ /\A$rc([^$rc].*)\z/) {
3677
3678         # Create the pattern to use.
3679         my $pat = "^$arg";
3680         $self->pat($pat);
3681
3682         # Toss off last entry if length is >1 (and it always is).
3683         pop(@hist) if length($DB::cmd) > 1;
3684
3685         my $i;
3686
3687         # Look backward through the history.
3688         SEARCH_HIST:
3689         for ( $i = $#hist ; $i ; --$i ) {
3690             # Stop if we find it.
3691             last SEARCH_HIST if $hist[$i] =~ /$pat/;
3692         }
3693
3694         if ( !$i ) {
3695
3696             # Never found it.
3697             print $OUT "No such command!\n\n";
3698             next CMD;
3699         }
3700
3701         # Found it. Put it in the buffer, print it, and process it.
3702         $DB::cmd = $hist[$i];
3703         print $OUT $DB::cmd, "\n";
3704         redo CMD;
3705     }
3706
3707     return;
3708 }
3709
3710 sub _handle_H_command {
3711     my $self = shift;
3712
3713     if ($self->cmd_args =~ m#\A\*#) {
3714         @hist = @truehist = ();
3715         print $OUT "History cleansed\n";
3716         next CMD;
3717     }
3718
3719     if (my ($num) = $self->cmd_args =~ /\A(?:-(\d+))?/) {
3720
3721         # Anything other than negative numbers is ignored by
3722         # the (incorrect) pattern, so this test does nothing.
3723         $end = $num ? ( $#hist - $num ) : 0;
3724
3725         # Set to the minimum if less than zero.
3726         $hist = 0 if $hist < 0;
3727
3728         # Start at the end of the array.
3729         # Stay in while we're still above the ending value.
3730         # Tick back by one each time around the loop.
3731         my $i;
3732
3733         for ( $i = $#hist ; $i > $end ; $i-- ) {
3734
3735             # Print the command  unless it has no arguments.
3736             print $OUT "$i: ", $hist[$i], "\n"
3737             unless $hist[$i] =~ /^.?$/;
3738         }
3739
3740         next CMD;
3741     }
3742
3743     return;
3744 }
3745
3746 sub _handle_doc_command {
3747     my $self = shift;
3748
3749     # man, perldoc, doc - show manual pages.
3750     if (my ($man_page)
3751         = $DB::cmd =~ /\A(?:man|(?:perl)?doc)\b(?:\s+([^(]*))?\z/) {
3752         DB::runman($man_page);
3753         next CMD;
3754     }
3755
3756     return;
3757 }
3758
3759 sub _handle_p_command {
3760     my $self = shift;
3761
3762     my $print_cmd = 'print {$DB::OUT} ';
3763     # p - print (no args): print $_.
3764     if ($self->_is_full('p')) {
3765         $DB::cmd = $print_cmd . '$_';
3766     }
3767     else {
3768         # p - print the given expression.
3769         $DB::cmd =~ s/\Ap\b/$print_cmd /;
3770     }
3771
3772     return;
3773 }
3774
3775 sub _handle_equal_sign_command {
3776     my $self = shift;
3777
3778     if ($DB::cmd =~ s/\A=\s*//) {
3779         my @keys;
3780         if ( length $DB::cmd == 0 ) {
3781
3782             # No args, get current aliases.
3783             @keys = sort keys %alias;
3784         }
3785         elsif ( my ( $k, $v ) = ( $DB::cmd =~ /^(\S+)\s+(\S.*)/ ) ) {
3786
3787             # Creating a new alias. $k is alias name, $v is
3788             # alias value.
3789
3790             # can't use $_ or kill //g state
3791             for my $x ( $k, $v ) {
3792
3793                 # Escape "alarm" characters.
3794                 $x =~ s/\a/\\a/g;
3795             }
3796
3797             # Substitute key for value, using alarm chars
3798             # as separators (which is why we escaped them in
3799             # the command).
3800             $alias{$k} = "s\a$k\a$v\a";
3801
3802             # Turn off standard warn and die behavior.
3803             local $SIG{__DIE__};
3804             local $SIG{__WARN__};
3805
3806             # Is it valid Perl?
3807             unless ( eval "sub { s\a$k\a$v\a }; 1" ) {
3808
3809                 # Nope. Bad alias. Say so and get out.
3810                 print $OUT "Can't alias $k to $v: $@\n";
3811                 delete $alias{$k};
3812                 next CMD;
3813             }
3814
3815             # We'll only list the new one.
3816             @keys = ($k);
3817         } ## end elsif (my ($k, $v) = ($DB::cmd...
3818
3819         # The argument is the alias to list.
3820         else {
3821             @keys = ($DB::cmd);
3822         }
3823
3824         # List aliases.
3825         for my $k (@keys) {
3826
3827             # Messy metaquoting: Trim the substitution code off.
3828             # We use control-G as the delimiter because it's not
3829             # likely to appear in the alias.
3830             if ( ( my $v = $alias{$k} ) =~ s\as\a$k\a(.*)\a$\a1\a ) {
3831
3832                 # Print the alias.
3833                 print $OUT "$k\t= $1\n";
3834             }
3835             elsif ( defined $alias{$k} ) {
3836
3837                 # Couldn't trim it off; just print the alias code.
3838                 print $OUT "$k\t$alias{$k}\n";
3839             }
3840             else {
3841
3842                 # No such, dude.
3843                 print "No alias for $k\n";
3844             }
3845         } ## end for my $k (@keys)
3846         next CMD;
3847     }
3848
3849     return;
3850 }
3851
3852 sub _handle_source_command {
3853     my $self = shift;
3854
3855     # source - read commands from a file (or pipe!) and execute.
3856     if (my $sourced_fn = $self->cmd_args) {
3857         if ( open my $fh, $sourced_fn ) {
3858
3859             # Opened OK; stick it in the list of file handles.
3860             push @cmdfhs, $fh;
3861         }
3862         else {
3863
3864             # Couldn't open it.
3865             DB::_db_warn("Can't execute '$sourced_fn': $!\n");
3866         }
3867         next CMD;
3868     }
3869
3870     return;
3871 }
3872
3873 sub _handle_enable_disable_commands {
3874     my $self = shift;
3875
3876     my $which_cmd = $self->cmd_verb;
3877     my $position = $self->cmd_args;
3878
3879     if ($position !~ /\s/) {
3880         my ($fn, $line_num);
3881         if ($position =~ m{\A\d+\z})
3882         {
3883             $fn = $DB::filename;
3884             $line_num = $position;
3885         }
3886         elsif (my ($new_fn, $new_line_num)
3887             = $position =~ m{\A(.*):(\d+)\z}) {
3888             ($fn, $line_num) = ($new_fn, $new_line_num);
3889         }
3890         else
3891         {
3892             DB::_db_warn("Wrong spec for enable/disable argument.\n");
3893         }
3894
3895         if (defined($fn)) {
3896             if (DB::_has_breakpoint_data_ref($fn, $line_num)) {
3897                 DB::_set_breakpoint_enabled_status($fn, $line_num,
3898                     ($which_cmd eq 'enable' ? 1 : '')
3899                 );
3900             }
3901             else {
3902                 DB::_db_warn("No breakpoint set at ${fn}:${line_num}\n");
3903             }
3904         }
3905
3906         next CMD;
3907     }
3908
3909     return;
3910 }
3911
3912 sub _handle_save_command {
3913     my $self = shift;
3914
3915     if (my $new_fn = $self->cmd_args) {
3916         my $filename = $new_fn || '.perl5dbrc';    # default?
3917         if ( open my $fh, '>', $filename ) {
3918
3919             # chomp to remove extraneous newlines from source'd files
3920             chomp( my @truelist =
3921                 map { m/\A\s*(save|source)/ ? "#$_" : $_ }
3922                 @truehist );
3923             print {$fh} join( "\n", @truelist );
3924             print "commands saved in $filename\n";
3925         }
3926         else {
3927             DB::_db_warn("Can't save debugger commands in '$new_fn': $!\n");
3928         }
3929         next CMD;
3930     }
3931
3932     return;
3933 }
3934
3935 sub _n_or_s_and_arg_commands_generic {
3936     my ($self, $letter, $new_val) = @_;
3937
3938     # s - single-step. Remember the last command was 's'.
3939     if ($DB::cmd =~ s#\A\Q$letter\E\s#\$DB::single = $new_val;\n#) {
3940         $laststep = $letter;
3941     }
3942
3943     return;
3944 }
3945
3946 sub _handle_sh_command {
3947     my $self = shift;
3948
3949     # $sh$sh - run a shell command (if it's all ASCII).
3950     # Can't run shell commands with Unicode in the debugger, hmm.
3951     my $my_cmd = $DB::cmd;
3952     if ($my_cmd =~ m#\A$sh#gms) {
3953
3954         if ($my_cmd =~ m#\G\z#cgms) {
3955             # Run the user's shell. If none defined, run Bourne.
3956             # We resume execution when the shell terminates.
3957             DB::_db_system( $ENV{SHELL} || "/bin/sh" );
3958             next CMD;
3959         }
3960         elsif ($my_cmd =~ m#\G$sh\s*(.*)#cgms) {
3961             # System it.
3962             DB::_db_system($1);
3963             next CMD;
3964         }
3965         elsif ($my_cmd =~ m#\G\s*(.*)#cgms) {
3966             DB::_db_system( $ENV{SHELL} || "/bin/sh", "-c", $1 );
3967             next CMD;
3968         }
3969     }
3970 }
3971
3972 sub _handle_x_command {
3973     my $self = shift;
3974
3975     if ($DB::cmd =~ s#\Ax\b# #) {    # Remainder gets done by DB::eval()
3976         $onetimeDump = 'dump';    # main::dumpvar shows the output
3977
3978         # handle special  "x 3 blah" syntax XXX propagate
3979         # doc back to special variables.
3980         if ( $DB::cmd =~ s#\A\s*(\d+)(?=\s)# #) {
3981             $onetimedumpDepth = $1;
3982         }
3983     }
3984
3985     return;
3986 }
3987
3988 sub _handle_q_command {
3989     my $self = shift;
3990
3991     if ($self->_is_full('q')) {
3992         $fall_off_end = 1;
3993         DB::clean_ENV();
3994         exit $?;
3995     }
3996
3997     return;
3998 }
3999
4000 sub _handle_cmd_wrapper_commands {
4001     my $self = shift;
4002
4003     DB::cmd_wrapper( $self->cmd_verb, $self->cmd_args, $line );
4004     next CMD;
4005 }
4006
4007 sub _handle_special_char_cmd_wrapper_commands {
4008     my $self = shift;
4009
4010     # All of these commands were remapped in perl 5.8.0;
4011     # we send them off to the secondary dispatcher (see below).
4012     if (my ($cmd_letter, $my_arg) = $DB::cmd =~ /\A([<>\{]{1,2})\s*(.*)/so) {
4013         DB::cmd_wrapper( $cmd_letter, $my_arg, $line );
4014         next CMD;
4015     }
4016
4017     return;
4018 }
4019
4020 } ## end DB::Obj
4021
4022 package DB;
4023
4024 # The following code may be executed now:
4025 # BEGIN {warn 4}
4026
4027 =head2 sub
4028
4029 C<sub> is called whenever a subroutine call happens in the program being
4030 debugged. The variable C<$DB::sub> contains the name of the subroutine
4031 being called.
4032
4033 The core function of this subroutine is to actually call the sub in the proper
4034 context, capturing its output. This of course causes C<DB::DB> to get called
4035 again, repeating until the subroutine ends and returns control to C<DB::sub>
4036 again. Once control returns, C<DB::sub> figures out whether or not to dump the
4037 return value, and returns its captured copy of the return value as its own
4038 return value. The value then feeds back into the program being debugged as if
4039 C<DB::sub> hadn't been there at all.
4040
4041 C<sub> does all the work of printing the subroutine entry and exit messages
4042 enabled by setting C<$frame>. It notes what sub the autoloader got called for,
4043 and also prints the return value if needed (for the C<r> command and if
4044 the 16 bit is set in C<$frame>).
4045
4046 It also tracks the subroutine call depth by saving the current setting of
4047 C<$single> in the C<@stack> package global; if this exceeds the value in
4048 C<$deep>, C<sub> automatically turns on printing of the current depth by
4049 setting the C<4> bit in C<$single>. In any case, it keeps the current setting
4050 of stop/don't stop on entry to subs set as it currently is set.
4051
4052 =head3 C<caller()> support
4053
4054 If C<caller()> is called from the package C<DB>, it provides some
4055 additional data, in the following order:
4056
4057 =over 4
4058
4059 =item * C<$package>
4060
4061 The package name the sub was in
4062
4063 =item * C<$filename>
4064
4065 The filename it was defined in
4066
4067 =item * C<$line>
4068
4069 The line number it was defined on
4070
4071 =item * C<$subroutine>
4072
4073 The subroutine name; C<(eval)> if an C<eval>().
4074
4075 =item * C<$hasargs>
4076
4077 1 if it has arguments, 0 if not
4078
4079 =item * C<$wantarray>
4080
4081 1 if array context, 0 if scalar context
4082
4083 =item * C<$evaltext>
4084
4085 The C<eval>() text, if any (undefined for C<eval BLOCK>)
4086
4087 =item * C<$is_require>
4088
4089 frame was created by a C<use> or C<require> statement
4090
4091 =item * C<$hints>
4092
4093 pragma information; subject to change between versions
4094
4095 =item * C<$bitmask>
4096
4097 pragma information; subject to change between versions
4098
4099 =item * C<@DB::args>
4100
4101 arguments with which the subroutine was invoked
4102
4103 =back
4104
4105 =cut
4106
4107 use vars qw($deep);
4108
4109 # We need to fully qualify the name ("DB::sub") to make "use strict;"
4110 # happy. -- Shlomi Fish
4111
4112 sub _indent_print_line_info {
4113     my ($offset, $str) = @_;
4114
4115     print_lineinfo( ' ' x ($stack_depth - $offset), $str);
4116
4117     return;
4118 }
4119
4120 sub _print_frame_message {
4121     my ($al) = @_;
4122
4123     if ($frame) {
4124         if ($frame & 4) {   # Extended frame entry message
4125             _indent_print_line_info(-1, "in  ");
4126
4127             # Why -1? But it works! :-(
4128             # Because print_trace will call add 1 to it and then call
4129             # dump_trace; this results in our skipping -1+1 = 0 stack frames
4130             # in dump_trace.
4131             #
4132             # Now it's 0 because we extracted a function.
4133             print_trace( $LINEINFO, 0, 1, 1, "$sub$al" );
4134         }
4135         else {
4136             _indent_print_line_info(-1, "entering $sub$al\n" );
4137         }
4138     }
4139
4140     return;
4141 }
4142
4143 sub DB::sub {
4144     # lock ourselves under threads
4145     lock($DBGR);
4146
4147     # Whether or not the autoloader was running, a scalar to put the
4148     # sub's return value in (if needed), and an array to put the sub's
4149     # return value in (if needed).
4150     my ( $al, $ret, @ret ) = "";
4151     if ($sub eq 'threads::new' && $ENV{PERL5DB_THREADED}) {
4152         print "creating new thread\n";
4153     }
4154
4155     # If the last ten characters are '::AUTOLOAD', note we've traced
4156     # into AUTOLOAD for $sub.
4157     if ( length($sub) > 10 && substr( $sub, -10, 10 ) eq '::AUTOLOAD' ) {
4158         no strict 'refs';
4159         $al = " for $$sub" if defined $$sub;
4160     }
4161
4162     # We stack the stack pointer and then increment it to protect us
4163     # from a situation that might unwind a whole bunch of call frames
4164     # at once. Localizing the stack pointer means that it will automatically
4165     # unwind the same amount when multiple stack frames are unwound.
4166     local $stack_depth = $stack_depth + 1;    # Protect from non-local exits
4167
4168     # Expand @stack.
4169     $#stack = $stack_depth;
4170
4171     # Save current single-step setting.
4172     $stack[-1] = $single;
4173
4174     # Turn off all flags except single-stepping.
4175     $single &= 1;
4176
4177     # If we've gotten really deeply recursed, turn on the flag that will
4178     # make us stop with the 'deep recursion' message.
4179     $single |= 4 if $stack_depth == $deep;
4180
4181     # If frame messages are on ...
4182
4183     _print_frame_message($al);
4184     # standard frame entry message
4185
4186     my $print_exit_msg = sub {
4187         # Check for exit trace messages...
4188         if ($frame & 2)
4189         {
4190             if ($frame & 4)    # Extended exit message
4191             {
4192                 _indent_print_line_info(0, "out ");
4193                 print_trace( $LINEINFO, 0, 1, 1, "$sub$al" );
4194             }
4195             else
4196             {
4197                 _indent_print_line_info(0, "exited $sub$al\n" );
4198             }
4199         }
4200         return;
4201     };
4202
4203     # Determine the sub's return type, and capture appropriately.
4204     if (wantarray) {
4205
4206         # Called in array context. call sub and capture output.
4207         # DB::DB will recursively get control again if appropriate; we'll come
4208         # back here when the sub is finished.
4209         {
4210             no strict 'refs';
4211             @ret = &$sub;
4212         }
4213
4214         # Pop the single-step value back off the stack.
4215         $single |= $stack[ $stack_depth-- ];
4216
4217         $print_exit_msg->();
4218
4219         # Print the return info if we need to.
4220         if ( $doret eq $stack_depth or $frame & 16 ) {
4221
4222             # Turn off output record separator.
4223             local $\ = '';
4224             my $fh = ( $doret eq $stack_depth ? $OUT : $LINEINFO );
4225
4226             # Indent if we're printing because of $frame tracing.
4227             if ($frame & 16)
4228             {
4229                 print {$fh} ' ' x $stack_depth;
4230             }
4231
4232             # Print the return value.
4233             print {$fh} "list context return from $sub:\n";
4234             dumpit( $fh, \@ret );
4235
4236             # And don't print it again.
4237             $doret = -2;
4238         } ## end if ($doret eq $stack_depth...
4239             # And we have to return the return value now.
4240         @ret;
4241     } ## end if (wantarray)
4242
4243     # Scalar context.
4244     else {
4245         if ( defined wantarray ) {
4246             no strict 'refs';
4247             # Save the value if it's wanted at all.
4248             $ret = &$sub;
4249         }
4250         else {
4251             no strict 'refs';
4252             # Void return, explicitly.
4253             &$sub;
4254             undef $ret;
4255         }
4256
4257         # Pop the single-step value off the stack.
4258         $single |= $stack[ $stack_depth-- ];
4259
4260         # If we're doing exit messages...
4261         $print_exit_msg->();
4262
4263         # If we are supposed to show the return value... same as before.
4264         if ( $doret eq $stack_depth or $frame & 16 and defined wantarray ) {
4265             local $\ = '';
4266             my $fh = ( $doret eq $stack_depth ? $OUT : $LINEINFO );
4267             print $fh ( ' ' x $stack_depth ) if $frame & 16;
4268             print $fh (
4269                 defined wantarray
4270                 ? "scalar context return from $sub: "
4271                 : "void context return from $sub\n"
4272             );
4273             dumpit( $fh, $ret ) if defined wantarray;
4274             $doret = -2;
4275         } ## end if ($doret eq $stack_depth...
4276
4277         # Return the appropriate scalar value.
4278         $ret;
4279     } ## end else [ if (wantarray)
4280 } ## end sub _sub
4281
4282 sub lsub : lvalue {
4283
4284     no strict 'refs';
4285
4286     # lock ourselves under threads
4287     lock($DBGR);
4288
4289     # Whether or not the autoloader was running, a scalar to put the
4290     # sub's return value in (if needed), and an array to put the sub's
4291     # return value in (if needed).
4292     my ( $al, $ret, @ret ) = "";
4293     if ($sub =~ /^threads::new$/ && $ENV{PERL5DB_THREADED}) {
4294         print "creating new thread\n";
4295     }
4296
4297     # If the last ten characters are C'::AUTOLOAD', note we've traced
4298     # into AUTOLOAD for $sub.
4299     if ( length($sub) > 10 && substr( $sub, -10, 10 ) eq '::AUTOLOAD' ) {
4300         $al = " for $$sub";
4301     }
4302
4303     # We stack the stack pointer and then increment it to protect us
4304     # from a situation that might unwind a whole bunch of call frames
4305     # at once. Localizing the stack pointer means that it will automatically
4306     # unwind the same amount when multiple stack frames are unwound.
4307     local $stack_depth = $stack_depth + 1;    # Protect from non-local exits
4308
4309     # Expand @stack.
4310     $#stack = $stack_depth;
4311
4312     # Save current single-step setting.
4313     $stack[-1] = $single;
4314
4315     # Turn off all flags except single-stepping.
4316     # Use local so the single-step value is popped back off the
4317     # stack for us.
4318     local $single = $single & 1;
4319
4320     # If we've gotten really deeply recursed, turn on the flag that will
4321     # make us stop with the 'deep recursion' message.
4322     $single |= 4 if $stack_depth == $deep;
4323
4324     # If frame messages are on ...
4325     _print_frame_message($al);
4326
4327     # call the original lvalue sub.
4328     &$sub;
4329 }
4330
4331 # Abstracting common code from multiple places elsewhere:
4332 sub depth_print_lineinfo {
4333     my $always_print = shift;
4334
4335     print_lineinfo( @_ ) if ($always_print or $stack_depth < $trace_to_depth);
4336 }
4337
4338 =head1 EXTENDED COMMAND HANDLING AND THE COMMAND API
4339
4340 In Perl 5.8.0, there was a major realignment of the commands and what they did,
4341 Most of the changes were to systematize the command structure and to eliminate
4342 commands that threw away user input without checking.
4343
4344 The following sections describe the code added to make it easy to support
4345 multiple command sets with conflicting command names. This section is a start
4346 at unifying all command processing to make it simpler to develop commands.
4347
4348 Note that all the cmd_[a-zA-Z] subroutines require the command name, a line
4349 number, and C<$dbline> (the current line) as arguments.
4350
4351 Support functions in this section which have multiple modes of failure C<die>
4352 on error; the rest simply return a false value.
4353
4354 The user-interface functions (all of the C<cmd_*> functions) just output
4355 error messages.
4356
4357 =head2 C<%set>
4358
4359 The C<%set> hash defines the mapping from command letter to subroutine
4360 name suffix.
4361
4362 C<%set> is a two-level hash, indexed by set name and then by command name.
4363 Note that trying to set the CommandSet to C<foobar> simply results in the
4364 5.8.0 command set being used, since there's no top-level entry for C<foobar>.
4365
4366 =cut
4367
4368 ### The API section
4369
4370 my %set = (    #
4371     'pre580' => {
4372         'a' => 'pre580_a',
4373         'A' => 'pre580_null',
4374         'b' => 'pre580_b',
4375         'B' => 'pre580_null',
4376         'd' => 'pre580_null',
4377         'D' => 'pre580_D',
4378         'h' => 'pre580_h',
4379         'M' => 'pre580_null',
4380         'O' => 'o',
4381         'o' => 'pre580_null',
4382         'v' => 'M',
4383         'w' => 'v',
4384         'W' => 'pre580_W',
4385     },
4386     'pre590' => {
4387         '<'  => 'pre590_prepost',
4388         '<<' => 'pre590_prepost',
4389         '>'  => 'pre590_prepost',
4390         '>>' => 'pre590_prepost',
4391         '{'  => 'pre590_prepost',
4392         '{{' => 'pre590_prepost',
4393     },
4394 );
4395
4396 my %breakpoints_data;
4397
4398 sub _has_breakpoint_data_ref {
4399     my ($filename, $line) = @_;
4400
4401     return (
4402         exists( $breakpoints_data{$filename} )
4403             and
4404         exists( $breakpoints_data{$filename}{$line} )
4405     );
4406 }
4407
4408 sub _get_breakpoint_data_ref {
4409     my ($filename, $line) = @_;
4410
4411     return ($breakpoints_data{$filename}{$line} ||= +{});
4412 }
4413
4414 sub _delete_breakpoint_data_ref {
4415     my ($filename, $line) = @_;
4416
4417     delete($breakpoints_data{$filename}{$line});
4418     if (! scalar(keys( %{$breakpoints_data{$filename}} )) ) {
4419         delete($breakpoints_data{$filename});
4420     }
4421
4422     return;
4423 }
4424
4425 sub _set_breakpoint_enabled_status {
4426     my ($filename, $line, $status) = @_;
4427
4428     _get_breakpoint_data_ref($filename, $line)->{'enabled'} =
4429         ($status ? 1 : '')
4430         ;
4431
4432     return;
4433 }
4434
4435 sub _enable_breakpoint_temp_enabled_status {
4436     my ($filename, $line) = @_;
4437
4438     _get_breakpoint_data_ref($filename, $line)->{'temp_enabled'} = 1;
4439
4440     return;
4441 }
4442
4443 sub _cancel_breakpoint_temp_enabled_status {
4444     my ($filename, $line) = @_;
4445
4446     my $ref = _get_breakpoint_data_ref($filename, $line);
4447
4448     delete ($ref->{'temp_enabled'});
4449
4450     if (! %$ref) {
4451         _delete_breakpoint_data_ref($filename, $line);
4452     }
4453
4454     return;
4455 }
4456
4457 sub _is_breakpoint_enabled {
4458     my ($filename, $line) = @_;
4459
4460     my $data_ref = _get_breakpoint_data_ref($filename, $line);
4461     return ($data_ref->{'enabled'} || $data_ref->{'temp_enabled'});
4462 }
4463
4464 =head2 C<cmd_wrapper()> (API)
4465
4466 C<cmd_wrapper()> allows the debugger to switch command sets
4467 depending on the value of the C<CommandSet> option.
4468
4469 It tries to look up the command in the C<%set> package-level I<lexical>
4470 (which means external entities can't fiddle with it) and create the name of
4471 the sub to call based on the value found in the hash (if it's there). I<All>
4472 of the commands to be handled in a set have to be added to C<%set>; if they
4473 aren't found, the 5.8.0 equivalent is called (if there is one).
4474
4475 This code uses symbolic references.
4476
4477 =cut
4478
4479 sub cmd_wrapper {
4480     my $cmd      = shift;
4481     my $line     = shift;
4482     my $dblineno = shift;
4483
4484     # Assemble the command subroutine's name by looking up the
4485     # command set and command name in %set. If we can't find it,
4486     # default to the older version of the command.
4487     my $call = 'cmd_'
4488       . ( $set{$CommandSet}{$cmd}
4489           || ( $cmd =~ /\A[<>{]+/o ? 'prepost' : $cmd ) );
4490
4491     # Call the command subroutine, call it by name.
4492     return __PACKAGE__->can($call)->( $cmd, $line, $dblineno );
4493 } ## end sub cmd_wrapper
4494
4495 =head3 C<cmd_a> (command)
4496
4497 The C<a> command handles pre-execution actions. These are associated with a
4498 particular line, so they're stored in C<%dbline>. We default to the current
4499 line if none is specified.
4500
4501 =cut
4502
4503 sub cmd_a {
4504     my $cmd    = shift;
4505     my $line   = shift || '';    # [.|line] expr
4506     my $dbline = shift;
4507
4508     # If it's dot (here), or not all digits,  use the current line.
4509     $line =~ s/\A\./$dbline/;
4510
4511     # Should be a line number followed by an expression.
4512     if ( my ($lineno, $expr) = $line =~ /^\s*(\d*)\s*(\S.+)/ ) {
4513
4514         if (! length($lineno)) {
4515             $lineno = $dbline;
4516         }
4517
4518         # If we have an expression ...
4519         if ( length $expr ) {
4520
4521             # ... but the line isn't breakable, complain.
4522             if ( $dbline[$lineno] == 0 ) {
4523                 print $OUT
4524                   "Line $lineno($dbline[$lineno]) does not have an action?\n";
4525             }
4526             else {
4527
4528                 # It's executable. Record that the line has an action.
4529                 $had_breakpoints{$filename} |= 2;
4530
4531                 # Remove any action, temp breakpoint, etc.
4532                 $dbline{$lineno} =~ s/\0[^\0]*//;
4533
4534                 # Add the action to the line.
4535                 $dbline{$lineno} .= "\0" . action($expr);
4536
4537                 _set_breakpoint_enabled_status($filename, $lineno, 1);
4538             }
4539         } ## end if (length $expr)
4540     } ## end if ($line =~ /^\s*(\d*)\s*(\S.+)/)
4541     else {
4542
4543         # Syntax wrong.
4544         print $OUT
4545           "Adding an action requires an optional lineno and an expression\n"
4546           ;    # hint
4547     }
4548 } ## end sub cmd_a
4549
4550 =head3 C<cmd_A> (command)
4551
4552 Delete actions. Similar to above, except the delete code is in a separate
4553 subroutine, C<delete_action>.
4554
4555 =cut
4556
4557 sub cmd_A {
4558     my $cmd    = shift;
4559     my $line   = shift || '';
4560     my $dbline = shift;
4561
4562     # Dot is this line.
4563     $line =~ s/^\./$dbline/;
4564
4565     # Call delete_action with a null param to delete them all.
4566     # The '1' forces the eval to be true. It'll be false only
4567     # if delete_action blows up for some reason, in which case
4568     # we print $@ and get out.
4569     if ( $line eq '*' ) {
4570         if (! eval { _delete_all_actions(); 1 }) {
4571             print {$OUT} $@;
4572             return;
4573         }
4574     }
4575
4576     # There's a real line  number. Pass it to delete_action.
4577     # Error trapping is as above.
4578     elsif ( $line =~ /^(\S.*)/ ) {
4579         if (! eval { delete_action($1); 1 }) {
4580             print {$OUT} $@;
4581             return;
4582         }
4583     }
4584
4585     # Swing and a miss. Bad syntax.
4586     else {
4587         print $OUT
4588           "Deleting an action requires a line number, or '*' for all\n" ; # hint
4589     }
4590 } ## end sub cmd_A
4591
4592 =head3 C<delete_action> (API)
4593
4594 C<delete_action> accepts either a line number or C<undef>. If a line number
4595 is specified, we check for the line being executable (if it's not, it
4596 couldn't have had an  action). If it is, we just take the action off (this
4597 will get any kind of an action, including breakpoints).
4598
4599 =cut
4600
4601 sub _remove_action_from_dbline {
4602     my $i = shift;
4603
4604     $dbline{$i} =~ s/\0[^\0]*//;    # \^a
4605     delete $dbline{$i} if $dbline{$i} eq '';
4606
4607     return;
4608 }
4609
4610 sub _delete_all_actions {
4611     print {$OUT} "Deleting all actions...\n";
4612
4613     for my $file ( keys %had_breakpoints ) {
4614         local *dbline = $main::{ '_<' . $file };
4615         $max = $#dbline;
4616         my $was;
4617         for my $i (1 .. $max) {
4618             if ( defined $dbline{$i} ) {
4619                 _remove_action_from_dbline($i);
4620             }
4621         }
4622
4623         unless ( $had_breakpoints{$file} &= ~2 ) {
4624             delete $had_breakpoints{$file};
4625         }
4626     }
4627
4628     return;
4629 }
4630
4631 sub delete_action {
4632     my $i = shift;
4633
4634     if ( defined($i) ) {
4635         # Can there be one?
4636         die "Line $i has no action .\n" if $dbline[$i] == 0;
4637
4638         # Nuke whatever's there.
4639         _remove_action_from_dbline($i);
4640     }
4641     else {
4642         _delete_all_actions();
4643     }
4644 }
4645
4646 =head3 C<cmd_b> (command)
4647
4648 Set breakpoints. Since breakpoints can be set in so many places, in so many
4649 ways, conditionally or not, the breakpoint code is kind of complex. Mostly,
4650 we try to parse the command type, and then shuttle it off to an appropriate
4651 subroutine to actually do the work of setting the breakpoint in the right
4652 place.
4653
4654 =cut
4655
4656 sub cmd_b {
4657     my $cmd    = shift;
4658     my $line   = shift;    # [.|line] [cond]
4659     my $dbline = shift;
4660
4661     my $default_cond = sub {
4662         my $cond = shift;
4663         return length($cond) ? $cond : '1';
4664     };
4665
4666     # Make . the current line number if it's there..
4667     $line =~ s/^\.(\s|\z)/$dbline$1/;
4668
4669     # No line number, no condition. Simple break on current line.
4670     if ( $line =~ /^\s*$/ ) {
4671         cmd_b_line( $dbline, 1 );
4672     }
4673
4674     # Break on load for a file.
4675     elsif ( my ($file) = $line =~ /^load\b\s*(.*)/ ) {
4676         $file =~ s/\s+\z//;
4677         cmd_b_load($file);
4678     }
4679
4680     # b compile|postpone <some sub> [<condition>]
4681     # The interpreter actually traps this one for us; we just put the
4682     # necessary condition in the %postponed hash.
4683     elsif ( my ($action, $subname, $cond)
4684         = $line =~ /^(postpone|compile)\b\s*([':A-Za-z_][':\w]*)\s*(.*)/ ) {
4685
4686         # De-Perl4-ify the name - ' separators to ::.
4687         $subname =~ s/'/::/g;
4688
4689         # Qualify it into the current package unless it's already qualified.
4690         $subname = "${package}::" . $subname unless $subname =~ /::/;
4691
4692         # Add main if it starts with ::.
4693         $subname = "main" . $subname if substr( $subname, 0, 2 ) eq "::";
4694
4695         # Save the break type for this sub.
4696         $postponed{$subname} = (($action eq 'postpone')
4697             ? ( "break +0 if " . $default_cond->($cond) )
4698             : "compile");
4699     } ## end elsif ($line =~ ...
4700     # b <filename>:<line> [<condition>]
4701     elsif (my ($filename, $line_num, $cond)
4702         = $line =~ /\A(\S+[^:]):(\d+)\s*(.*)/ms) {
4703         cmd_b_filename_line(
4704             $filename,
4705             $line_num,
4706             (length($cond) ? $cond : '1'),
4707         );
4708     }
4709     # b <sub name> [<condition>]
4710     elsif ( my ($new_subname, $new_cond) =
4711         $line =~ /^([':A-Za-z_][':\w]*(?:\[.*\])?)\s*(.*)/ ) {
4712
4713         #
4714         $subname = $new_subname;
4715         cmd_b_sub( $subname, $default_cond->($new_cond) );
4716     }
4717
4718     # b <line> [<condition>].
4719     elsif ( my ($line_n, $cond) = $line =~ /^(\d*)\s*(.*)/ ) {
4720
4721         # Capture the line. If none, it's the current line.
4722         $line = $line_n || $dbline;
4723
4724         # Break on line.
4725         cmd_b_line( $line, $default_cond->($cond) );
4726     }
4727
4728     # Line didn't make sense.
4729     else {
4730         print "confused by line($line)?\n";
4731     }
4732
4733     return;
4734 } ## end sub cmd_b
4735
4736 =head3 C<break_on_load> (API)
4737
4738 We want to break when this file is loaded. Mark this file in the
4739 C<%break_on_load> hash, and note that it has a breakpoint in
4740 C<%had_breakpoints>.
4741
4742 =cut
4743
4744 sub break_on_load {
4745     my $file = shift;
4746     $break_on_load{$file} = 1;
4747     $had_breakpoints{$file} |= 1;
4748 }
4749
4750 =head3 C<report_break_on_load> (API)
4751
4752 Gives us an array of filenames that are set to break on load. Note that
4753 only files with break-on-load are in here, so simply showing the keys
4754 suffices.
4755
4756 =cut
4757
4758 sub report_break_on_load {
4759     sort keys %break_on_load;
4760 }
4761
4762 =head3 C<cmd_b_load> (command)
4763
4764 We take the file passed in and try to find it in C<%INC> (which maps modules
4765 to files they came from). We mark those files for break-on-load via
4766 C<break_on_load> and then report that it was done.
4767
4768 =cut
4769
4770 sub cmd_b_load {
4771     my $file = shift;
4772     my @files;
4773
4774     # This is a block because that way we can use a redo inside it
4775     # even without there being any looping structure at all outside it.
4776     {
4777
4778         # Save short name and full path if found.
4779         push @files, $file;
4780         push @files, $::INC{$file} if $::INC{$file};
4781
4782         # Tack on .pm and do it again unless there was a '.' in the name
4783         # already.
4784         $file .= '.pm', redo unless $file =~ /\./;
4785     }
4786
4787     # Do the real work here.
4788     break_on_load($_) for @files;
4789
4790     # All the files that have break-on-load breakpoints.
4791     @files = report_break_on_load;
4792
4793     # Normalize for the purposes of our printing this.
4794     local $\ = '';
4795     local $" = ' ';
4796     print $OUT "Will stop on load of '@files'.\n";
4797 } ## end sub cmd_b_load
4798
4799 =head3 C<$filename_error> (API package global)
4800
4801 Several of the functions we need to implement in the API need to work both
4802 on the current file and on other files. We don't want to duplicate code, so
4803 C<$filename_error> is used to contain the name of the file that's being
4804 worked on (if it's not the current one).
4805
4806 We can now build functions in pairs: the basic function works on the current
4807 file, and uses C<$filename_error> as part of its error message. Since this is
4808 initialized to C<"">, no filename will appear when we are working on the
4809 current file.
4810
4811 The second function is a wrapper which does the following:
4812
4813 =over 4
4814
4815 =item *
4816
4817 Localizes C<$filename_error> and sets it to the name of the file to be processed.
4818
4819 =item *
4820
4821 Localizes the C<*dbline> glob and reassigns it to point to the file we want to process.
4822
4823 =item *
4824
4825 Calls the first function.
4826
4827 The first function works on the I<current> file (i.e., the one we changed to),
4828 and prints C<$filename_error> in the error message (the name of the other file)
4829 if it needs to. When the functions return, C<*dbline> is restored to point
4830 to the actual current file (the one we're executing in) and
4831 C<$filename_error> is restored to C<"">. This restores everything to
4832 the way it was before the second function was called at all.
4833
4834 See the comments in C<breakable_line> and C<breakable_line_in_file> for more
4835 details.
4836
4837 =back
4838
4839 =cut
4840
4841 use vars qw($filename_error);
4842 $filename_error = '';
4843
4844 =head3 breakable_line(from, to) (API)
4845
4846 The subroutine decides whether or not a line in the current file is breakable.
4847 It walks through C<@dbline> within the range of lines specified, looking for
4848 the first line that is breakable.
4849
4850 If C<$to> is greater than C<$from>, the search moves forwards, finding the
4851 first line I<after> C<$to> that's breakable, if there is one.
4852
4853 If C<$from> is greater than C<$to>, the search goes I<backwards>, finding the
4854 first line I<before> C<$to> that's breakable, if there is one.
4855
4856 =cut
4857
4858 sub breakable_line {
4859
4860     my ( $from, $to ) = @_;
4861
4862     # $i is the start point. (Where are the FORTRAN programs of yesteryear?)
4863     my $i = $from;
4864
4865     # If there are at least 2 arguments, we're trying to search a range.
4866     if ( @_ >= 2 ) {
4867
4868         # $delta is positive for a forward search, negative for a backward one.
4869         my $delta = $from < $to ? +1 : -1;
4870
4871         # Keep us from running off the ends of the file.
4872         my $limit = $delta > 0 ? $#dbline : 1;
4873
4874         # Clever test. If you're a mathematician, it's obvious why this
4875         # test works. If not:
4876         # If $delta is positive (going forward), $limit will be $#dbline.
4877         #    If $to is less than $limit, ($limit - $to) will be positive, times
4878         #    $delta of 1 (positive), so the result is > 0 and we should use $to
4879         #    as the stopping point.
4880         #
4881         #    If $to is greater than $limit, ($limit - $to) is negative,
4882         #    times $delta of 1 (positive), so the result is < 0 and we should
4883         #    use $limit ($#dbline) as the stopping point.
4884         #
4885         # If $delta is negative (going backward), $limit will be 1.
4886         #    If $to is zero, ($limit - $to) will be 1, times $delta of -1
4887         #    (negative) so the result is > 0, and we use $to as the stopping
4888         #    point.
4889         #
4890         #    If $to is less than zero, ($limit - $to) will be positive,
4891         #    times $delta of -1 (negative), so the result is not > 0, and
4892         #    we use $limit (1) as the stopping point.
4893         #
4894         #    If $to is 1, ($limit - $to) will zero, times $delta of -1
4895         #    (negative), still giving zero; the result is not > 0, and
4896         #    we use $limit (1) as the stopping point.
4897         #
4898         #    if $to is >1, ($limit - $to) will be negative, times $delta of -1
4899         #    (negative), giving a positive (>0) value, so we'll set $limit to
4900         #    $to.
4901
4902         $limit = $to if ( $limit - $to ) * $delta > 0;
4903
4904         # The real search loop.
4905         # $i starts at $from (the point we want to start searching from).
4906         # We move through @dbline in the appropriate direction (determined
4907         # by $delta: either -1 (back) or +1 (ahead).
4908         # We stay in as long as we haven't hit an executable line
4909         # ($dbline[$i] == 0 means not executable) and we haven't reached
4910         # the limit yet (test similar to the above).
4911         $i += $delta while $dbline[$i] == 0 and ( $limit - $i ) * $delta > 0;
4912
4913     } ## end if (@_ >= 2)
4914
4915     # If $i points to a line that is executable, return that.
4916     return $i unless $dbline[$i] == 0;
4917
4918     # Format the message and print it: no breakable lines in range.
4919     my ( $pl, $upto ) = ( '', '' );
4920     ( $pl, $upto ) = ( 's', "..$to" ) if @_ >= 2 and $from != $to;
4921
4922     # If there's a filename in filename_error, we'll see it.
4923     # If not, not.
4924     die "Line$pl $from$upto$filename_error not breakable\n";
4925 } ## end sub breakable_line
4926
4927 =head3 breakable_line_in_filename(file, from, to) (API)
4928
4929 Like C<breakable_line>, but look in another file.
4930
4931 =cut
4932
4933 sub breakable_line_in_filename {
4934
4935     # Capture the file name.
4936     my ($f) = shift;
4937
4938     # Swap the magic line array over there temporarily.
4939     local *dbline = $main::{ '_<' . $f };
4940
4941     # If there's an error, it's in this other file.
4942     local $filename_error = " of '$f'";
4943
4944     # Find the breakable line.
4945     breakable_line(@_);
4946
4947     # *dbline and $filename_error get restored when this block ends.
4948
4949 } ## end sub breakable_line_in_filename
4950
4951 =head3 break_on_line(lineno, [condition]) (API)
4952
4953 Adds a breakpoint with the specified condition (or 1 if no condition was
4954 specified) to the specified line. Dies if it can't.
4955
4956 =cut
4957
4958 sub break_on_line {
4959     my $i = shift;
4960     my $cond = @_ ? shift(@_) : 1;
4961
4962     my $inii  = $i;
4963     my $after = '';
4964     my $pl    = '';
4965
4966     # Woops, not a breakable line. $filename_error allows us to say
4967     # if it was in a different file.
4968     die "Line $i$filename_error not breakable.\n" if $dbline[$i] == 0;
4969
4970     # Mark this file as having breakpoints in it.
4971     $had_breakpoints{$filename} |= 1;
4972
4973     # If there is an action or condition here already ...
4974     if ( $dbline{$i} ) {
4975
4976         # ... swap this condition for the existing one.
4977         $dbline{$i} =~ s/^[^\0]*/$cond/;
4978     }
4979     else {
4980
4981         # Nothing here - just add the condition.
4982         $dbline{$i} = $cond;
4983
4984         _set_breakpoint_enabled_status($filename, $i, 1);
4985     }
4986
4987     return;
4988 } ## end sub break_on_line
4989
4990 =head3 cmd_b_line(line, [condition]) (command)
4991
4992 Wrapper for C<break_on_line>. Prints the failure message if it
4993 doesn't work.
4994
4995 =cut
4996
4997 sub cmd_b_line {
4998     if (not eval { break_on_line(@_); 1 }) {
4999         local $\ = '';
5000         print $OUT $@ and return;
5001     }
5002
5003     return;
5004 } ## end sub cmd_b_line
5005
5006 =head3 cmd_b_filename_line(line, [condition]) (command)
5007
5008 Wrapper for C<break_on_filename_line>. Prints the failure message if it
5009 doesn't work.
5010
5011 =cut
5012
5013 sub cmd_b_filename_line {
5014     if (not eval { break_on_filename_line(@_); 1 }) {
5015         local $\ = '';
5016         print $OUT $@ and return;
5017     }
5018
5019     return;
5020 }
5021
5022 =head3 break_on_filename_line(file, line, [condition]) (API)
5023
5024 Switches to the file specified and then calls C<break_on_line> to set
5025 the breakpoint.
5026
5027 =cut
5028
5029 sub break_on_filename_line {
5030     my $f = shift;
5031     my $i = shift;
5032     my $cond = @_ ? shift(@_) : 1;
5033
5034     # Switch the magical hash temporarily.
5035     local *dbline = $main::{ '_<' . $f };
5036
5037     # Localize the variables that break_on_line uses to make its message.
5038     local $filename_error = " of '$f'";
5039     local $filename       = $f;
5040
5041     # Add the breakpoint.
5042     break_on_line( $i, $cond );
5043
5044     return;
5045 } ## end sub break_on_filename_line
5046
5047 =head3 break_on_filename_line_range(file, from, to, [condition]) (API)
5048
5049 Switch to another file, search the range of lines specified for an
5050 executable one, and put a breakpoint on the first one you find.
5051
5052 =cut
5053
5054 sub break_on_filename_line_range {
5055     my $f = shift;
5056     my $from = shift;
5057     my $to = shift;
5058     my $cond = @_ ? shift(@_) : 1;
5059
5060     # Find a breakable line if there is one.
5061     my $i = breakable_line_in_filename( $f, $from, $to );
5062
5063     # Add the breakpoint.
5064     break_on_filename_line( $f, $i, $cond );
5065
5066     return;
5067 } ## end sub break_on_filename_line_range
5068
5069 =head3 subroutine_filename_lines(subname, [condition]) (API)
5070
5071 Search for a subroutine within a given file. The condition is ignored.
5072 Uses C<find_sub> to locate the desired subroutine.
5073
5074 =cut
5075
5076 sub subroutine_filename_lines {
5077     my ( $subname ) = @_;
5078
5079     # Returned value from find_sub() is fullpathname:startline-endline.
5080     # The match creates the list (fullpathname, start, end).
5081     return (find_sub($subname) =~ /^(.*):(\d+)-(\d+)$/);
5082 } ## end sub subroutine_filename_lines
5083
5084 =head3 break_subroutine(subname) (API)
5085
5086 Places a break on the first line possible in the specified subroutine. Uses
5087 C<subroutine_filename_lines> to find the subroutine, and
5088 C<break_on_filename_line_range> to place the break.
5089
5090 =cut
5091
5092 sub break_subroutine {
5093     my $subname = shift;
5094
5095     # Get filename, start, and end.
5096     my ( $file, $s, $e ) = subroutine_filename_lines($subname)
5097       or die "Subroutine $subname not found.\n";
5098
5099
5100     # Null condition changes to '1' (always true).
5101     my $cond = @_ ? shift(@_) : 1;
5102
5103     # Put a break the first place possible in the range of lines
5104     # that make up this subroutine.
5105     break_on_filename_line_range( $file, $s, $e, $cond );
5106
5107     return;
5108 } ## end sub break_subroutine
5109
5110 =head3 cmd_b_sub(subname, [condition]) (command)
5111
5112 We take the incoming subroutine name and fully-qualify it as best we can.
5113
5114 =over 4
5115
5116 =item 1. If it's already fully-qualified, leave it alone.
5117
5118 =item 2. Try putting it in the current package.
5119
5120 =item 3. If it's not there, try putting it in CORE::GLOBAL if it exists there.
5121
5122 =item 4. If it starts with '::', put it in 'main::'.
5123
5124 =back
5125
5126 After all this cleanup, we call C<break_subroutine> to try to set the
5127 breakpoint.
5128
5129 =cut
5130
5131 sub cmd_b_sub {
5132     my $subname = shift;
5133     my $cond = @_ ? shift : 1;
5134
5135     # If the subname isn't a code reference, qualify it so that
5136     # break_subroutine() will work right.
5137     if ( ref($subname) ne 'CODE' ) {
5138
5139         # Not Perl 4.
5140         $subname =~ s/'/::/g;
5141         my $s = $subname;
5142
5143         # Put it in this package unless it's already qualified.
5144         if ($subname !~ /::/)
5145         {
5146             $subname = $package . '::' . $subname;
5147         };
5148
5149         # Requalify it into CORE::GLOBAL if qualifying it into this
5150         # package resulted in its not being defined, but only do so
5151         # if it really is in CORE::GLOBAL.
5152         my $core_name = "CORE::GLOBAL::$s";
5153         if ((!defined(&$subname))
5154                 and ($s !~ /::/)
5155                 and (defined &{$core_name}))
5156         {
5157             $subname = $core_name;
5158         }
5159
5160         # Put it in package 'main' if it has a leading ::.
5161         if ($subname =~ /\A::/)
5162         {
5163             $subname = "main" . $subname;
5164         }
5165     } ## end if ( ref($subname) ne 'CODE' ) {
5166
5167     # Try to set the breakpoint.
5168     if (not eval { break_subroutine( $subname, $cond ); 1 }) {
5169         local $\ = '';
5170         print {$OUT} $@;
5171         return;
5172     }
5173
5174     return;
5175 } ## end sub cmd_b_sub
5176
5177 =head3 C<cmd_B> - delete breakpoint(s) (command)
5178
5179 The command mostly parses the command line and tries to turn the argument
5180 into a line spec. If it can't, it uses the current line. It then calls
5181 C<delete_breakpoint> to actually do the work.
5182
5183 If C<*> is  specified, C<cmd_B> calls C<delete_breakpoint> with no arguments,
5184 thereby deleting all the breakpoints.
5185
5186 =cut
5187
5188 sub cmd_B {
5189     my $cmd = shift;
5190
5191     # No line spec? Use dbline.
5192     # If there is one, use it if it's non-zero, or wipe it out if it is.
5193     my $line   = ( $_[0] =~ /\A\./ ) ? $dbline : (shift || '');
5194     my $dbline = shift;
5195
5196     # If the line was dot, make the line the current one.
5197     $line =~ s/^\./$dbline/;
5198
5199     # If it's * we're deleting all the breakpoints.
5200     if ( $line eq '*' ) {
5201         if (not eval { delete_breakpoint(); 1 }) {
5202             print {$OUT} $@;
5203         }
5204     }
5205
5206     # If there is a line spec, delete the breakpoint on that line.
5207     elsif ( $line =~ /\A(\S.*)/ ) {
5208         if (not eval { delete_breakpoint( $line || $dbline ); 1 }) {
5209             local $\ = '';
5210             print {$OUT} $@;
5211         }
5212     } ## end elsif ($line =~ /^(\S.*)/)
5213
5214     # No line spec.
5215     else {
5216         print {$OUT}
5217           "Deleting a breakpoint requires a line number, or '*' for all\n"
5218           ;    # hint
5219     }
5220
5221     return;
5222 } ## end sub cmd_B
5223
5224 =head3 delete_breakpoint([line]) (API)
5225
5226 This actually does the work of deleting either a single breakpoint, or all
5227 of them.
5228
5229 For a single line, we look for it in C<@dbline>. If it's nonbreakable, we
5230 just drop out with a message saying so. If it is, we remove the condition
5231 part of the 'condition\0action' that says there's a breakpoint here. If,
5232 after we've done that, there's nothing left, we delete the corresponding
5233 line in C<%dbline> to signal that no action needs to be taken for this line.
5234
5235 For all breakpoints, we iterate through the keys of C<%had_breakpoints>,
5236 which lists all currently-loaded files which have breakpoints. We then look
5237 at each line in each of these files, temporarily switching the C<%dbline>
5238 and C<@dbline> structures to point to the files in question, and do what
5239 we did in the single line case: delete the condition in C<@dbline>, and
5240 delete the key in C<%dbline> if nothing's left.
5241
5242 We then wholesale delete C<%postponed>, C<%postponed_file>, and
5243 C<%break_on_load>, because these structures contain breakpoints for files
5244 and code that haven't been loaded yet. We can just kill these off because there
5245 are no magical debugger structures associated with them.
5246
5247 =cut
5248
5249 sub _remove_breakpoint_entry {
5250     my ($fn, $i) = @_;
5251
5252     delete $dbline{$i};
5253     _delete_breakpoint_data_ref($fn, $i);
5254
5255     return;
5256 }
5257
5258 sub _delete_all_breakpoints {
5259     print {$OUT} "Deleting all breakpoints...\n";
5260
5261     # %had_breakpoints lists every file that had at least one
5262     # breakpoint in it.
5263     for my $fn ( keys %had_breakpoints ) {
5264
5265         # Switch to the desired file temporarily.
5266         local *dbline = $main::{ '_<' . $fn };
5267
5268         $max = $#dbline;
5269
5270         # For all lines in this file ...
5271         for my $i (1 .. $max) {
5272
5273             # If there's a breakpoint or action on this line ...
5274             if ( defined $dbline{$i} ) {
5275
5276                 # ... remove the breakpoint.
5277                 $dbline{$i} =~ s/\A[^\0]+//;
5278                 if ( $dbline{$i} =~ s/\A\0?\z// ) {
5279                     # Remove the entry altogether if no action is there.
5280                     _remove_breakpoint_entry($fn, $i);
5281                 }
5282             } ## end if (defined $dbline{$i...
5283         } ## end for $i (1 .. $max)
5284
5285         # If, after we turn off the "there were breakpoints in this file"
5286         # bit, the entry in %had_breakpoints for this file is zero,
5287         # we should remove this file from the hash.
5288         if ( not $had_breakpoints{$fn} &= (~1) ) {
5289             delete $had_breakpoints{$fn};
5290         }
5291     } ## end for my $fn (keys %had_breakpoints)
5292
5293     # Kill off all the other breakpoints that are waiting for files that
5294     # haven't been loaded yet.
5295     undef %postponed;
5296     undef %postponed_file;
5297     undef %break_on_load;
5298
5299     return;
5300 }
5301
5302 sub _delete_breakpoint_from_line {
5303     my ($i) = @_;
5304
5305     # Woops. This line wasn't breakable at all.
5306     die "Line $i not breakable.\n" if $dbline[$i] == 0;
5307
5308     # Kill the condition, but leave any action.
5309     $dbline{$i} =~ s/\A[^\0]*//;
5310
5311     # Remove the entry entirely if there's no action left.
5312     if ($dbline{$i} eq '') {
5313         _remove_breakpoint_entry($filename, $i);
5314     }
5315
5316     return;
5317 }
5318
5319 sub delete_breakpoint {
5320     my $i = shift;
5321
5322     # If we got a line, delete just that one.
5323     if ( defined($i) ) {
5324         _delete_breakpoint_from_line($i);
5325     }
5326     # No line; delete them all.
5327     else {
5328         _delete_all_breakpoints();
5329     }
5330
5331     return;
5332 }
5333
5334 =head3 cmd_stop (command)
5335
5336 This is meant to be part of the new command API, but it isn't called or used
5337 anywhere else in the debugger. XXX It is probably meant for use in development
5338 of new commands.
5339
5340 =cut
5341
5342 sub cmd_stop {    # As on ^C, but not signal-safy.
5343     $signal = 1;
5344 }
5345
5346 =head3 C<cmd_e> - threads
5347
5348 Display the current thread id:
5349
5350     e
5351
5352 This could be how (when implemented) to send commands to this thread id (e cmd)
5353 or that thread id (e tid cmd).
5354
5355 =cut
5356
5357 sub cmd_e {
5358     my $cmd  = shift;
5359     my $line = shift;
5360     unless (exists($INC{'threads.pm'})) {
5361         print "threads not loaded($ENV{PERL5DB_THREADED})
5362         please run the debugger with PERL5DB_THREADED=1 set in the environment\n";
5363     } else {
5364         my $tid = threads->tid;
5365         print "thread id: $tid\n";
5366     }
5367 } ## end sub cmd_e
5368
5369 =head3 C<cmd_E> - list of thread ids
5370
5371 Display the list of available thread ids:
5372
5373     E
5374
5375 This could be used (when implemented) to send commands to all threads (E cmd).
5376
5377 =cut
5378
5379 sub cmd_E {
5380     my $cmd  = shift;
5381     my $line = shift;
5382     unless (exists($INC{'threads.pm'})) {
5383         print "threads not loaded($ENV{PERL5DB_THREADED})
5384         please run the debugger with PERL5DB_THREADED=1 set in the environment\n";
5385     } else {
5386         my $tid = threads->tid;
5387         print "thread ids: ".join(', ',
5388             map { ($tid == $_->tid ? '<'.$_->tid.'>' : $_->tid) } threads->list
5389         )."\n";
5390     }
5391 } ## end sub cmd_E
5392
5393 =head3 C<cmd_h> - help command (command)
5394
5395 Does the work of either
5396
5397 =over 4
5398
5399 =item *
5400
5401 Showing all the debugger help
5402
5403 =item *
5404
5405 Showing help for a specific command
5406
5407 =back
5408
5409 =cut
5410
5411 use vars qw($help);
5412 use vars qw($summary);
5413
5414 sub cmd_h {
5415     my $cmd = shift;
5416
5417     # If we have no operand, assume null.
5418     my $line = shift || '';
5419
5420     # 'h h'. Print the long-format help.
5421     if ( $line =~ /\Ah\s*\z/ ) {
5422         print_help($help);
5423     }
5424
5425     # 'h <something>'. Search for the command and print only its help.
5426     elsif ( my ($asked) = $line =~ /\A(\S.*)\z/ ) {
5427
5428         # support long commands; otherwise bogus errors
5429         # happen when you ask for h on <CR> for example
5430         my $qasked = quotemeta($asked);    # for searching; we don't
5431                                            # want to use it as a pattern.
5432                                            # XXX: finds CR but not <CR>
5433
5434         # Search the help string for the command.
5435         if (
5436             $help =~ /^                    # Start of a line
5437                       <?                   # Optional '<'
5438                       (?:[IB]<)            # Optional markup
5439                       $qasked              # The requested command
5440                      /mx
5441           )
5442         {
5443
5444             # It's there; pull it out and print it.
5445             while (
5446                 $help =~ /^
5447                               (<?            # Optional '<'
5448                                  (?:[IB]<)   # Optional markup
5449                                  $qasked     # The command
5450                                  ([\s\S]*?)  # Description line(s)
5451                               \n)            # End of last description line
5452                               (?!\s)         # Next line not starting with
5453                                              # whitespace
5454                              /mgx
5455               )
5456             {
5457                 print_help($1);
5458             }
5459         }
5460
5461         # Not found; not a debugger command.
5462         else {
5463             print_help("B<$asked> is not a debugger command.\n");
5464         }
5465     } ## end elsif ($line =~ /^(\S.*)$/)
5466
5467     # 'h' - print the summary help.
5468     else {
5469         print_help($summary);
5470     }
5471 } ## end sub cmd_h
5472
5473 =head3 C<cmd_i> - inheritance display
5474
5475 Display the (nested) parentage of the module or object given.
5476
5477 =cut
5478
5479 sub cmd_i {
5480     my $cmd  = shift;
5481     my $line = shift;
5482     foreach my $isa ( split( /\s+/, $line ) ) {
5483         $evalarg = $isa;
5484         # The &-call is here to ascertain the mutability of @_.
5485         ($isa) = &DB::eval;
5486         no strict 'refs';
5487         print join(
5488             ', ',
5489             map {
5490                 "$_"
5491                   . (
5492                     defined( ${"$_\::VERSION"} )
5493                     ? ' ' . ${"$_\::VERSION"}
5494                     : undef )
5495               } @{mro::get_linear_isa(ref($isa) || $isa)}
5496         );
5497         print "\n";
5498     }
5499 } ## end sub cmd_i
5500
5501 =head3 C<cmd_l> - list lines (command)
5502
5503 Most of the command is taken up with transforming all the different line
5504 specification syntaxes into 'start-stop'. After that is done, the command
5505 runs a loop over C<@dbline> for the specified range of lines. It handles
5506 the printing of each line and any markers (C<==E<gt>> for current line,
5507 C<b> for break on this line, C<a> for action on this line, C<:> for this
5508 line breakable).
5509
5510 We save the last line listed in the C<$start> global for further listing
5511 later.
5512
5513 =cut
5514
5515 sub _min {
5516     my $min = shift;
5517     foreach my $v (@_) {
5518         if ($min > $v) {
5519             $min = $v;
5520         }
5521     }
5522     return $min;
5523 }
5524
5525 sub _max {
5526     my $max = shift;
5527     foreach my $v (@_) {
5528         if ($max < $v) {
5529             $max = $v;
5530         }
5531     }
5532     return $max;
5533 }
5534
5535 sub _minify_to_max {
5536     my $ref = shift;
5537
5538     $$ref = _min($$ref, $max);
5539
5540     return;
5541 }
5542
5543 sub _cmd_l_handle_var_name {
5544     my $var_name = shift;
5545
5546     $evalarg = $var_name;
5547
5548     my ($s) = DB::eval();
5549
5550     # Ooops. Bad scalar.
5551     if ($@) {
5552         print {$OUT} "Error: $@\n";
5553         next CMD;
5554     }
5555
5556     # Good scalar. If it's a reference, find what it points to.
5557     $s = CvGV_name($s);
5558     print {$OUT} "Interpreted as: $1 $s\n";
5559     $line = "$1 $s";
5560
5561     # Call self recursively to really do the command.
5562     return _cmd_l_main( $s );
5563 }
5564
5565 sub _cmd_l_handle_subname {
5566
5567     my $s = $subname;
5568
5569     # De-Perl4.
5570     $subname =~ s/\'/::/;
5571
5572     # Put it in this package unless it starts with ::.
5573     $subname = $package . "::" . $subname unless $subname =~ /::/;
5574
5575     # Put it in CORE::GLOBAL if t doesn't start with :: and
5576     # it doesn't live in this package and it lives in CORE::GLOBAL.
5577     $subname = "CORE::GLOBAL::$s"
5578     if not defined &$subname
5579         and $s !~ /::/
5580         and defined &{"CORE::GLOBAL::$s"};
5581
5582     # Put leading '::' names into 'main::'.
5583     $subname = "main" . $subname if substr( $subname, 0, 2 ) eq "::";
5584
5585     # Get name:start-stop from find_sub, and break this up at
5586     # colons.
5587     my @pieces = split( /:/, find_sub($subname) || $sub{$subname} );
5588
5589     # Pull off start-stop.
5590     my $subrange = pop @pieces;
5591
5592     # If the name contained colons, the split broke it up.
5593     # Put it back together.
5594     $file = join( ':', @pieces );
5595
5596     # If we're not in that file, switch over to it.
5597     if ( $file ne $filename ) {
5598         if (! $slave_editor) {
5599             print {$OUT} "Switching to file '$file'.\n";
5600         }
5601
5602         # Switch debugger's magic structures.
5603         *dbline   = $main::{ '_<' . $file };
5604         $max      = $#dbline;
5605         $filename = $file;
5606     } ## end if ($file ne $filename)
5607
5608     # Subrange is 'start-stop'. If this is less than a window full,
5609     # swap it to 'start+', which will list a window from the start point.
5610     if ($subrange) {
5611         if ( eval($subrange) < -$window ) {
5612             $subrange =~ s/-.*/+/;
5613         }
5614
5615         # Call self recursively to list the range.
5616         return _cmd_l_main( $subrange );
5617     } ## end if ($subrange)
5618
5619     # Couldn't find it.
5620     else {
5621         print {$OUT} "Subroutine $subname not found.\n";
5622         return;
5623     }
5624 }
5625
5626 sub _cmd_l_empty {
5627     # Compute new range to list.
5628     $incr = $window - 1;
5629
5630     # Recurse to do it.
5631     return _cmd_l_main( $start . '-' . ( $start + $incr ) );
5632 }
5633
5634 sub _cmd_l_plus {
5635     my ($new_start, $new_incr) = @_;
5636
5637     # Don't reset start for 'l +nnn'.
5638     $start = $new_start if $new_start;
5639
5640     # Increment for list. Use window size if not specified.
5641     # (Allows 'l +' to work.)
5642     $incr = $new_incr || ($window - 1);
5643
5644     # Create a line range we'll understand, and recurse to do it.
5645     return _cmd_l_main( $start . '-' . ( $start + $incr ) );
5646 }
5647
5648 sub _cmd_l_calc_initial_end_and_i {
5649     my ($spec, $start_match, $end_match) = @_;
5650
5651     # Determine end point; use end of file if not specified.
5652     my $end = ( !defined $start_match ) ? $max :
5653     ( $end_match ? $end_match : $start_match );
5654
5655     # Go on to the end, and then stop.
5656     _minify_to_max(\$end);
5657
5658     # Determine start line.
5659     my $i = $start_match;
5660
5661     if ($i eq '.') {
5662         $i = $spec;
5663     }
5664
5665     $i = _max($i, 1);
5666
5667     $incr = $end - $i;
5668
5669     return ($end, $i);
5670 }
5671
5672 sub _cmd_l_range {
5673     my ($spec, $current_line, $start_match, $end_match) = @_;
5674
5675     my ($end, $i) =
5676         _cmd_l_calc_initial_end_and_i($spec, $start_match, $end_match);
5677
5678     # If we're running under a slave editor, force it to show the lines.
5679     if ($slave_editor) {
5680         print {$OUT} "\032\032$filename:$i:0\n";
5681         $i = $end;
5682     }
5683     # We're doing it ourselves. We want to show the line and special
5684     # markers for:
5685     # - the current line in execution
5686     # - whether a line is breakable or not
5687     # - whether a line has a break or not
5688     # - whether a line has an action or not
5689     else {
5690         I_TO_END:
5691         for ( ; $i <= $end ; $i++ ) {
5692
5693             # Check for breakpoints and actions.
5694             my ( $stop, $action );
5695             if ($dbline{$i}) {
5696                 ( $stop, $action ) = split( /\0/, $dbline{$i} );
5697             }
5698
5699             # ==> if this is the current line in execution,
5700             # : if it's breakable.
5701             my $arrow =
5702             ( $i == $current_line and $filename eq $filename_ini )
5703             ? '==>'
5704             : ( $dbline[$i] + 0 ? ':' : ' ' );
5705
5706             # Add break and action indicators.
5707             $arrow .= 'b' if $stop;
5708             $arrow .= 'a' if $action;
5709
5710             # Print the line.
5711             print {$OUT} "$i$arrow\t", $dbline[$i];
5712
5713             # Move on to the next line. Drop out on an interrupt.
5714             if ($signal) {
5715                 $i++;
5716                 last I_TO_END;
5717             }
5718         } ## end for (; $i <= $end ; $i++)
5719
5720         # Line the prompt up; print a newline if the last line listed
5721         # didn't have a newline.
5722         if ($dbline[ $i - 1 ] !~ /\n\z/) {
5723             print {$OUT} "\n";
5724         }
5725     } ## end else [ if ($slave_editor)
5726
5727     # Save the point we last listed to in case another relative 'l'
5728     # command is desired. Don't let it run off the end.
5729     $start = $i;
5730     _minify_to_max(\$start);
5731
5732     return;
5733 }
5734
5735 sub _cmd_l_main {
5736     my $spec = shift;
5737
5738     # If this is '-something', delete any spaces after the dash.
5739     $spec =~ s/\A-\s*\z/-/;
5740
5741     # If the line is '$something', assume this is a scalar containing a
5742     # line number.
5743     # Set up for DB::eval() - evaluate in *user* context.
5744     if ( my ($var_name) = $spec =~ /\A(\$.*)/s ) {
5745         return _cmd_l_handle_var_name($var_name);
5746     }
5747     # l name. Try to find a sub by that name.
5748     elsif ( ($subname) = $spec =~ /\A([\':A-Za-z_][\':\w]*(?:\[.*\])?)/s ) {
5749         return _cmd_l_handle_subname();
5750     }
5751     # Bare 'l' command.
5752     elsif ( $spec !~ /\S/ ) {
5753         return _cmd_l_empty();
5754     }
5755     # l [start]+number_of_lines
5756     elsif ( my ($new_start, $new_incr) = $spec =~ /\A(\d*)\+(\d*)\z/ ) {
5757         return _cmd_l_plus($new_start, $new_incr);
5758     }
5759     # l start-stop or l start,stop
5760     elsif (my ($s, $e) = $spec =~ /^(?:(-?[\d\$\.]+)(?:[-,]([\d\$\.]+))?)?/ ) {
5761         return _cmd_l_range($spec, $line, $s, $e);
5762     }
5763
5764     return;
5765 } ## end sub cmd_l
5766
5767 sub cmd_l {
5768     my (undef, $line) = @_;
5769
5770     return _cmd_l_main($line);
5771 }
5772
5773 =head3 C<cmd_L> - list breakpoints, actions, and watch expressions (command)
5774
5775 To list breakpoints, the command has to look determine where all of them are
5776 first. It starts a C<%had_breakpoints>, which tells us what all files have
5777 breakpoints and/or actions. For each file, we switch the C<*dbline> glob (the
5778 magic source and breakpoint data structures) to the file, and then look
5779 through C<%dbline> for lines with breakpoints and/or actions, listing them
5780 out. We look through C<%postponed> not-yet-compiled subroutines that have
5781 breakpoints, and through C<%postponed_file> for not-yet-C<require>'d files
5782 that have breakpoints.
5783
5784 Watchpoints are simpler: we just list the entries in C<@to_watch>.
5785
5786 =cut
5787
5788 sub _cmd_L_calc_arg {
5789     # If no argument, list everything. Pre-5.8.0 version always lists
5790     # everything
5791     my $arg = shift || 'abw';
5792     if ($CommandSet ne '580')
5793     {
5794         $arg = 'abw';
5795     }
5796
5797     return $arg;
5798 }
5799
5800 sub _cmd_L_calc_wanted_flags {
5801     my $arg = _cmd_L_calc_arg(shift);
5802
5803     return (map { index($arg, $_) >= 0 ? 1 : 0 } qw(a b w));
5804 }
5805
5806
5807 sub _cmd_L_handle_breakpoints {
5808     my ($handle_db_line) = @_;
5809
5810     BREAKPOINTS_SCAN:
5811     # Look in all the files with breakpoints...
5812     for my $file ( keys %had_breakpoints ) {
5813
5814         # Temporary switch to this file.
5815         local *dbline = $main::{ '_<' . $file };
5816
5817         # Set up to look through the whole file.
5818         $max = $#dbline;
5819         my $was;    # Flag: did we print something
5820         # in this file?
5821
5822         # For each line in the file ...
5823         for my $i (1 .. $max) {
5824
5825             # We've got something on this line.
5826             if ( defined $dbline{$i} ) {
5827
5828                 # Print the header if we haven't.
5829                 if (not $was++) {
5830                     print {$OUT} "$file:\n";
5831                 }
5832
5833                 # Print the line.
5834                 print {$OUT} " $i:\t", $dbline[$i];
5835
5836                 $handle_db_line->($dbline{$i});
5837
5838                 # Quit if the user hit interrupt.
5839                 if ($signal) {
5840                     last BREAKPOINTS_SCAN;
5841                 }
5842             } ## end if (defined $dbline{$i...
5843         } ## end for my $i (1 .. $max)
5844     } ## end for my $file (keys %had_breakpoints)
5845
5846     return;
5847 }
5848
5849 sub _cmd_L_handle_postponed_breakpoints {
5850     my ($handle_db_line) = @_;
5851
5852     print {$OUT} "Postponed breakpoints in files:\n";
5853
5854     POSTPONED_SCANS:
5855     for my $file ( keys %postponed_file ) {
5856         my $db = $postponed_file{$file};
5857         print {$OUT} " $file:\n";
5858         for my $line ( sort { $a <=> $b } keys %$db ) {
5859             print {$OUT} "  $line:\n";
5860
5861             $handle_db_line->($db->{$line});
5862
5863             if ($signal) {
5864                 last POSTPONED_SCANS;
5865             }
5866         }
5867         if ($signal) {
5868             last POSTPONED_SCANS;
5869         }
5870     }
5871
5872     return;
5873 }
5874
5875
5876 sub cmd_L {
5877     my $cmd = shift;
5878