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