perldelta - Mention a bug number
[perl.git] / lib / perl5db.pl
1
2 =head1 NAME
3
4 perl5db.pl - the perl debugger
5
6 =head1 SYNOPSIS
7
8     perl -d  your_Perl_script
9
10 =head1 DESCRIPTION
11
12 C<perl5db.pl> is the perl debugger. It is loaded automatically by Perl when
13 you invoke a script with C<perl -d>. This documentation tries to outline the
14 structure and services provided by C<perl5db.pl>, and to describe how you
15 can use them.
16
17 =head1 GENERAL NOTES
18
19 The debugger can look pretty forbidding to many Perl programmers. There are
20 a number of reasons for this, many stemming out of the debugger's history.
21
22 When the debugger was first written, Perl didn't have a lot of its nicer
23 features - no references, no lexical variables, no closures, no object-oriented
24 programming. So a lot of the things one would normally have done using such
25 features was done using global variables, globs and the C<local()> operator
26 in creative ways.
27
28 Some of these have survived into the current debugger; a few of the more
29 interesting and still-useful idioms are noted in this section, along with notes
30 on the comments themselves.
31
32 =head2 Why not use more lexicals?
33
34 Experienced Perl programmers will note that the debugger code tends to use
35 mostly package globals rather than lexically-scoped variables. This is done
36 to allow a significant amount of control of the debugger from outside the
37 debugger itself.
38
39 Unfortunately, though the variables are accessible, they're not well
40 documented, so it's generally been a decision that hasn't made a lot of
41 difference to most users. Where appropriate, comments have been added to
42 make variables more accessible and usable, with the understanding that these
43 I<are> debugger internals, and are therefore subject to change. Future
44 development should probably attempt to replace the globals with a well-defined
45 API, but for now, the variables are what we've got.
46
47 =head2 Automated variable stacking via C<local()>
48
49 As you may recall from reading C<perlfunc>, the C<local()> operator makes a
50 temporary copy of a variable in the current scope. When the scope ends, the
51 old copy is restored. This is often used in the debugger to handle the
52 automatic stacking of variables during recursive calls:
53
54      sub foo {
55         local $some_global++;
56
57         # Do some stuff, then ...
58         return;
59      }
60
61 What happens is that on entry to the subroutine, C<$some_global> is localized,
62 then altered. When the subroutine returns, Perl automatically undoes the
63 localization, restoring the previous value. Voila, automatic stack management.
64
65 The debugger uses this trick a I<lot>. Of particular note is C<DB::eval>,
66 which lets the debugger get control inside of C<eval>'ed code. The debugger
67 localizes a saved copy of C<$@> inside the subroutine, which allows it to
68 keep C<$@> safe until it C<DB::eval> returns, at which point the previous
69 value of C<$@> is restored. This makes it simple (well, I<simpler>) to keep
70 track of C<$@> inside C<eval>s which C<eval> other C<eval's>.
71
72 In any case, watch for this pattern. It occurs fairly often.
73
74 =head2 The C<^> trick
75
76 This is used to cleverly reverse the sense of a logical test depending on
77 the value of an auxiliary variable. For instance, the debugger's C<S>
78 (search for subroutines by pattern) allows you to negate the pattern
79 like this:
80
81    # Find all non-'foo' subs:
82    S !/foo/
83
84 Boolean algebra states that the truth table for XOR looks like this:
85
86 =over 4
87
88 =item * 0 ^ 0 = 0
89
90 (! not present and no match) --> false, don't print
91
92 =item * 0 ^ 1 = 1
93
94 (! not present and matches) --> true, print
95
96 =item * 1 ^ 0 = 1
97
98 (! present and no match) --> true, print
99
100 =item * 1 ^ 1 = 0
101
102 (! present and matches) --> false, don't print
103
104 =back
105
106 As you can see, the first pair applies when C<!> isn't supplied, and
107 the second pair applies when it is. The XOR simply allows us to
108 compact a more complicated if-then-elseif-else into a more elegant
109 (but perhaps overly clever) single test. After all, it needed this
110 explanation...
111
112 =head2 FLAGS, FLAGS, FLAGS
113
114 There is a certain C programming legacy in the debugger. Some variables,
115 such as C<$single>, C<$trace>, and C<$frame>, have I<magical> values composed
116 of 1, 2, 4, etc. (powers of 2) OR'ed together. This allows several pieces
117 of state to be stored independently in a single scalar.
118
119 A test like
120
121     if ($scalar & 4) ...
122
123 is checking to see if the appropriate bit is on. Since each bit can be
124 "addressed" independently in this way, C<$scalar> is acting sort of like
125 an array of bits. Obviously, since the contents of C<$scalar> are just a
126 bit-pattern, we can save and restore it easily (it will just look like
127 a number).
128
129 The problem, is of course, that this tends to leave magic numbers scattered
130 all over your program whenever a bit is set, cleared, or checked. So why do
131 it?
132
133 =over 4
134
135 =item *
136
137 First, doing an arithmetical or bitwise operation on a scalar is
138 just about the fastest thing you can do in Perl: C<use constant> actually
139 creates a subroutine call, and array and hash lookups are much slower. Is
140 this over-optimization at the expense of readability? Possibly, but the
141 debugger accesses these  variables a I<lot>. Any rewrite of the code will
142 probably have to benchmark alternate implementations and see which is the
143 best balance of readability and speed, and then document how it actually
144 works.
145
146 =item *
147
148 Second, it's very easy to serialize a scalar number. This is done in
149 the restart code; the debugger state variables are saved in C<%ENV> and then
150 restored when the debugger is restarted. Having them be just numbers makes
151 this trivial.
152
153 =item *
154
155 Third, some of these variables are being shared with the Perl core
156 smack in the middle of the interpreter's execution loop. It's much faster for
157 a C program (like the interpreter) to check a bit in a scalar than to access
158 several different variables (or a Perl array).
159
160 =back
161
162 =head2 What are those C<XXX> comments for?
163
164 Any comment containing C<XXX> means that the comment is either somewhat
165 speculative - it's not exactly clear what a given variable or chunk of
166 code is doing, or that it is incomplete - the basics may be clear, but the
167 subtleties are not completely documented.
168
169 Send in a patch if you can clear up, fill out, or clarify an C<XXX>.
170
171 =head1 DATA STRUCTURES MAINTAINED BY CORE
172
173 There are a number of special data structures provided to the debugger by
174 the Perl interpreter.
175
176 The array C<@{$main::{'_<'.$filename}}> (aliased locally to C<@dbline>
177 via glob assignment) contains the text from C<$filename>, with each
178 element corresponding to a single line of C<$filename>. Additionally,
179 breakable lines will be dualvars with the numeric component being the
180 memory address of a COP node. Non-breakable lines are dualvar to 0.
181
182 The hash C<%{'_<'.$filename}> (aliased locally to C<%dbline> via glob
183 assignment) contains breakpoints and actions.  The keys are line numbers;
184 you can set individual values, but not the whole hash. The Perl interpreter
185 uses this hash to determine where breakpoints have been set. Any true value is
186 considered to be a breakpoint; C<perl5db.pl> uses C<$break_condition\0$action>.
187 Values are magical in numeric context: 1 if the line is breakable, 0 if not.
188
189 The scalar C<${"_<$filename"}> simply contains the string C<$filename>.
190 This is also the case for evaluated strings that contain subroutines, or
191 which are currently being executed.  The $filename for C<eval>ed strings looks
192 like C<(eval 34).
193
194 =head1 DEBUGGER STARTUP
195
196 When C<perl5db.pl> starts, it reads an rcfile (C<perl5db.ini> for
197 non-interactive sessions, C<.perldb> for interactive ones) that can set a number
198 of options. In addition, this file may define a subroutine C<&afterinit>
199 that will be executed (in the debugger's context) after the debugger has
200 initialized itself.
201
202 Next, it checks the C<PERLDB_OPTS> environment variable and treats its
203 contents as the argument of a C<o> command in the debugger.
204
205 =head2 STARTUP-ONLY OPTIONS
206
207 The following options can only be specified at startup.
208 To set them in your rcfile, add a call to
209 C<&parse_options("optionName=new_value")>.
210
211 =over 4
212
213 =item * TTY
214
215 the TTY to use for debugging i/o.
216
217 =item * noTTY
218
219 if set, goes in NonStop mode.  On interrupt, if TTY is not set,
220 uses the value of noTTY or F<$HOME/.perldbtty$$> to find TTY using
221 Term::Rendezvous.  Current variant is to have the name of TTY in this
222 file.
223
224 =item * ReadLine
225
226 if false, a dummy ReadLine is used, so you can debug
227 ReadLine applications.
228
229 =item * NonStop
230
231 if true, no i/o is performed until interrupt.
232
233 =item * LineInfo
234
235 file or pipe to print line number info to.  If it is a
236 pipe, a short "emacs like" message is used.
237
238 =item * RemotePort
239
240 host:port to connect to on remote host for remote debugging.
241
242 =item * HistFile
243
244 file to store session history to. There is no default and so no
245 history file is written unless this variable is explicitly set.
246
247 =item * HistSize
248
249 number of commands to store to the file specified in C<HistFile>.
250 Default is 100.
251
252 =back
253
254 =head3 SAMPLE RCFILE
255
256  &parse_options("NonStop=1 LineInfo=db.out");
257   sub afterinit { $trace = 1; }
258
259 The script will run without human intervention, putting trace
260 information into C<db.out>.  (If you interrupt it, you had better
261 reset C<LineInfo> to something I<interactive>!)
262
263 =head1 INTERNALS DESCRIPTION
264
265 =head2 DEBUGGER INTERFACE VARIABLES
266
267 Perl supplies the values for C<%sub>.  It effectively inserts
268 a C<&DB::DB();> in front of each place that can have a
269 breakpoint. At each subroutine call, it calls C<&DB::sub> with
270 C<$DB::sub> set to the called subroutine. It also inserts a C<BEGIN
271 {require 'perl5db.pl'}> before the first line.
272
273 After each C<require>d file is compiled, but before it is executed, a
274 call to C<&DB::postponed($main::{'_<'.$filename})> is done. C<$filename>
275 is the expanded name of the C<require>d file (as found via C<%INC>).
276
277 =head3 IMPORTANT INTERNAL VARIABLES
278
279 =head4 C<$CreateTTY>
280
281 Used to control when the debugger will attempt to acquire another TTY to be
282 used for input.
283
284 =over
285
286 =item * 1 -  on C<fork()>
287
288 =item * 2 - debugger is started inside debugger
289
290 =item * 4 -  on startup
291
292 =back
293
294 =head4 C<$doret>
295
296 The value -2 indicates that no return value should be printed.
297 Any other positive value causes C<DB::sub> to print return values.
298
299 =head4 C<$evalarg>
300
301 The item to be eval'ed by C<DB::eval>. Used to prevent messing with the current
302 contents of C<@_> when C<DB::eval> is called.
303
304 =head4 C<$frame>
305
306 Determines what messages (if any) will get printed when a subroutine (or eval)
307 is entered or exited.
308
309 =over 4
310
311 =item * 0 -  No enter/exit messages
312
313 =item * 1 - Print I<entering> messages on subroutine entry
314
315 =item * 2 - Adds exit messages on subroutine exit. If no other flag is on, acts like 1+2.
316
317 =item * 4 - Extended messages: C<< <in|out> I<context>=I<fully-qualified sub name> from I<file>:I<line> >>. If no other flag is on, acts like 1+4.
318
319 =item * 8 - Adds parameter information to messages, and overloaded stringify and tied FETCH is enabled on the printed arguments. Ignored if C<4> is not on.
320
321 =item * 16 - Adds C<I<context> return from I<subname>: I<value>> messages on subroutine/eval exit. Ignored if C<4> is not on.
322
323 =back
324
325 To get everything, use C<$frame=30> (or C<o f=30> as a debugger command).
326 The debugger internally juggles the value of C<$frame> during execution to
327 protect external modules that the debugger uses from getting traced.
328
329 =head4 C<$level>
330
331 Tracks current debugger nesting level. Used to figure out how many
332 C<E<lt>E<gt>> pairs to surround the line number with when the debugger
333 outputs a prompt. Also used to help determine if the program has finished
334 during command parsing.
335
336 =head4 C<$onetimeDump>
337
338 Controls what (if anything) C<DB::eval()> will print after evaluating an
339 expression.
340
341 =over 4
342
343 =item * C<undef> - don't print anything
344
345 =item * C<dump> - use C<dumpvar.pl> to display the value returned
346
347 =item * C<methods> - print the methods callable on the first item returned
348
349 =back
350
351 =head4 C<$onetimeDumpDepth>
352
353 Controls how far down C<dumpvar.pl> will go before printing C<...> while
354 dumping a structure. Numeric. If C<undef>, print all levels.
355
356 =head4 C<$signal>
357
358 Used to track whether or not an C<INT> signal has been detected. C<DB::DB()>,
359 which is called before every statement, checks this and puts the user into
360 command mode if it finds C<$signal> set to a true value.
361
362 =head4 C<$single>
363
364 Controls behavior during single-stepping. Stacked in C<@stack> on entry to
365 each subroutine; popped again at the end of each subroutine.
366
367 =over 4
368
369 =item * 0 - run continuously.
370
371 =item * 1 - single-step, go into subs. The C<s> command.
372
373 =item * 2 - single-step, don't go into subs. The C<n> command.
374
375 =item * 4 - print current sub depth (turned on to force this when C<too much
376 recursion> occurs.
377
378 =back
379
380 =head4 C<$trace>
381
382 Controls the output of trace information.
383
384 =over 4
385
386 =item * 1 - The C<t> command was entered to turn on tracing (every line executed is printed)
387
388 =item * 2 - watch expressions are active
389
390 =item * 4 - user defined a C<watchfunction()> in C<afterinit()>
391
392 =back
393
394 =head4 C<$slave_editor>
395
396 1 if C<LINEINFO> was directed to a pipe; 0 otherwise.
397
398 =head4 C<@cmdfhs>
399
400 Stack of filehandles that C<DB::readline()> will read commands from.
401 Manipulated by the debugger's C<source> command and C<DB::readline()> itself.
402
403 =head4 C<@dbline>
404
405 Local alias to the magical line array, C<@{$main::{'_<'.$filename}}> ,
406 supplied by the Perl interpreter to the debugger. Contains the source.
407
408 =head4 C<@old_watch>
409
410 Previous values of watch expressions. First set when the expression is
411 entered; reset whenever the watch expression changes.
412
413 =head4 C<@saved>
414
415 Saves important globals (C<$@>, C<$!>, C<$^E>, C<$,>, C<$/>, C<$\>, C<$^W>)
416 so that the debugger can substitute safe values while it's running, and
417 restore them when it returns control.
418
419 =head4 C<@stack>
420
421 Saves the current value of C<$single> on entry to a subroutine.
422 Manipulated by the C<c> command to turn off tracing in all subs above the
423 current one.
424
425 =head4 C<@to_watch>
426
427 The 'watch' expressions: to be evaluated before each line is executed.
428
429 =head4 C<@typeahead>
430
431 The typeahead buffer, used by C<DB::readline>.
432
433 =head4 C<%alias>
434
435 Command aliases. Stored as character strings to be substituted for a command
436 entered.
437
438 =head4 C<%break_on_load>
439
440 Keys are file names, values are 1 (break when this file is loaded) or undef
441 (don't break when it is loaded).
442
443 =head4 C<%dbline>
444
445 Keys are line numbers, values are C<condition\0action>. If used in numeric
446 context, values are 0 if not breakable, 1 if breakable, no matter what is
447 in the actual hash entry.
448
449 =head4 C<%had_breakpoints>
450
451 Keys are file names; values are bitfields:
452
453 =over 4
454
455 =item * 1 - file has a breakpoint in it.
456
457 =item * 2 - file has an action in it.
458
459 =back
460
461 A zero or undefined value means this file has neither.
462
463 =head4 C<%option>
464
465 Stores the debugger options. These are character string values.
466
467 =head4 C<%postponed>
468
469 Saves breakpoints for code that hasn't been compiled yet.
470 Keys are subroutine names, values are:
471
472 =over 4
473
474 =item * C<compile> - break when this sub is compiled
475
476 =item * C<< break +0 if <condition> >> - break (conditionally) at the start of this routine. The condition will be '1' if no condition was specified.
477
478 =back
479
480 =head4 C<%postponed_file>
481
482 This hash keeps track of breakpoints that need to be set for files that have
483 not yet been compiled. Keys are filenames; values are references to hashes.
484 Each of these hashes is keyed by line number, and its values are breakpoint
485 definitions (C<condition\0action>).
486
487 =head1 DEBUGGER INITIALIZATION
488
489 The debugger's initialization actually jumps all over the place inside this
490 package. This is because there are several BEGIN blocks (which of course
491 execute immediately) spread through the code. Why is that?
492
493 The debugger needs to be able to change some things and set some things up
494 before the debugger code is compiled; most notably, the C<$deep> variable that
495 C<DB::sub> uses to tell when a program has recursed deeply. In addition, the
496 debugger has to turn off warnings while the debugger code is compiled, but then
497 restore them to their original setting before the program being debugged begins
498 executing.
499
500 The first C<BEGIN> block simply turns off warnings by saving the current
501 setting of C<$^W> and then setting it to zero. The second one initializes
502 the debugger variables that are needed before the debugger begins executing.
503 The third one puts C<$^X> back to its former value.
504
505 We'll detail the second C<BEGIN> block later; just remember that if you need
506 to initialize something before the debugger starts really executing, that's
507 where it has to go.
508
509 =cut
510
511 package DB;
512
513 use strict;
514
515 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.44';
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     $CommandSet
631     $CreateTTY
632     $DBGR
633     @dbline
634     $dbline
635     %dbline
636     $dieLevel
637     $filename
638     $histfile
639     $histsize
640     $IN
641     $inhibit_exit
642     @ini_INC
643     $ini_warn
644     $maxtrace
645     $od
646     @options
647     $osingle
648     $otrace
649     $pager
650     $post
651     %postponed
652     $prc
653     $pre
654     $pretype
655     $psh
656     @RememberOnROptions
657     $remoteport
658     @res
659     $rl
660     @saved
661     $signalLevel
662     $sub
663     $term
664     $usercontext
665     $warnLevel
666 );
667
668 our (
669     @cmdfhs,
670     $evalarg,
671     $frame,
672     $hist,
673     $ImmediateStop,
674     $line,
675     $onetimeDump,
676     $onetimedumpDepth,
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         *share = sub(\[$@%]) {};
870     }
871 }
872
873 # These variables control the execution of 'dumpvar.pl'.
874 {
875     package dumpvar;
876     use vars qw(
877     $hashDepth
878     $arrayDepth
879     $dumpDBFiles
880     $dumpPackages
881     $quoteHighBit
882     $printUndef
883     $globPrint
884     $usageOnly
885     );
886 }
887
888 # used to control die() reporting in diesignal()
889 {
890     package Carp;
891     use vars qw($CarpLevel);
892 }
893
894 # without threads, $filename is not defined until DB::DB is called
895 share($main::{'_<'.$filename}) if defined $filename;
896
897 # Command-line + PERLLIB:
898 # Save the contents of @INC before they are modified elsewhere.
899 @ini_INC = @INC;
900
901 # This was an attempt to clear out the previous values of various
902 # trapped errors. Apparently it didn't help. XXX More info needed!
903 # $prevwarn = $prevdie = $prevbus = $prevsegv = ''; # Does not help?!
904
905 # We set these variables to safe values. We don't want to blindly turn
906 # off warnings, because other packages may still want them.
907 $trace = $signal = $single = 0;    # Uninitialized warning suppression
908                                    # (local $^W cannot help - other packages!).
909
910 # Default to not exiting when program finishes; print the return
911 # value when the 'r' command is used to return from a subroutine.
912 $inhibit_exit = $option{PrintRet} = 1;
913
914 use vars qw($trace_to_depth);
915
916 # Default to 1E9 so it won't be limited to a certain recursion depth.
917 $trace_to_depth = 1E9;
918
919 =head1 OPTION PROCESSING
920
921 The debugger's options are actually spread out over the debugger itself and
922 C<dumpvar.pl>; some of these are variables to be set, while others are
923 subs to be called with a value. To try to make this a little easier to
924 manage, the debugger uses a few data structures to define what options
925 are legal and how they are to be processed.
926
927 First, the C<@options> array defines the I<names> of all the options that
928 are to be accepted.
929
930 =cut
931
932 @options = qw(
933   CommandSet   HistFile      HistSize
934   hashDepth    arrayDepth    dumpDepth
935   DumpDBFiles  DumpPackages  DumpReused
936   compactDump  veryCompact   quote
937   HighBit      undefPrint    globPrint
938   PrintRet     UsageOnly     frame
939   AutoTrace    TTY           noTTY
940   ReadLine     NonStop       LineInfo
941   maxTraceLen  recallCommand ShellBang
942   pager        tkRunning     ornaments
943   signalLevel  warnLevel     dieLevel
944   inhibit_exit ImmediateStop bareStringify
945   CreateTTY    RemotePort    windowSize
946   DollarCaretP
947 );
948
949 @RememberOnROptions = qw(DollarCaretP);
950
951 =pod
952
953 Second, C<optionVars> lists the variables that each option uses to save its
954 state.
955
956 =cut
957
958 use vars qw(%optionVars);
959
960 %optionVars = (
961     hashDepth     => \$dumpvar::hashDepth,
962     arrayDepth    => \$dumpvar::arrayDepth,
963     CommandSet    => \$CommandSet,
964     DumpDBFiles   => \$dumpvar::dumpDBFiles,
965     DumpPackages  => \$dumpvar::dumpPackages,
966     DumpReused    => \$dumpvar::dumpReused,
967     HighBit       => \$dumpvar::quoteHighBit,
968     undefPrint    => \$dumpvar::printUndef,
969     globPrint     => \$dumpvar::globPrint,
970     UsageOnly     => \$dumpvar::usageOnly,
971     CreateTTY     => \$CreateTTY,
972     bareStringify => \$dumpvar::bareStringify,
973     frame         => \$frame,
974     AutoTrace     => \$trace,
975     inhibit_exit  => \$inhibit_exit,
976     maxTraceLen   => \$maxtrace,
977     ImmediateStop => \$ImmediateStop,
978     RemotePort    => \$remoteport,
979     windowSize    => \$window,
980     HistFile      => \$histfile,
981     HistSize      => \$histsize,
982 );
983
984 =pod
985
986 Third, C<%optionAction> defines the subroutine to be called to process each
987 option.
988
989 =cut
990
991 use vars qw(%optionAction);
992
993 %optionAction = (
994     compactDump   => \&dumpvar::compactDump,
995     veryCompact   => \&dumpvar::veryCompact,
996     quote         => \&dumpvar::quote,
997     TTY           => \&TTY,
998     noTTY         => \&noTTY,
999     ReadLine      => \&ReadLine,
1000     NonStop       => \&NonStop,
1001     LineInfo      => \&LineInfo,
1002     recallCommand => \&recallCommand,
1003     ShellBang     => \&shellBang,
1004     pager         => \&pager,
1005     signalLevel   => \&signalLevel,
1006     warnLevel     => \&warnLevel,
1007     dieLevel      => \&dieLevel,
1008     tkRunning     => \&tkRunning,
1009     ornaments     => \&ornaments,
1010     RemotePort    => \&RemotePort,
1011     DollarCaretP  => \&DollarCaretP,
1012 );
1013
1014 =pod
1015
1016 Last, the C<%optionRequire> notes modules that must be C<require>d if an
1017 option is used.
1018
1019 =cut
1020
1021 # Note that this list is not complete: several options not listed here
1022 # actually require that dumpvar.pl be loaded for them to work, but are
1023 # not in the table. A subsequent patch will correct this problem; for
1024 # the moment, we're just recommenting, and we are NOT going to change
1025 # function.
1026 use vars qw(%optionRequire);
1027
1028 %optionRequire = (
1029     compactDump => 'dumpvar.pl',
1030     veryCompact => 'dumpvar.pl',
1031     quote       => 'dumpvar.pl',
1032 );
1033
1034 =pod
1035
1036 There are a number of initialization-related variables which can be set
1037 by putting code to set them in a BEGIN block in the C<PERL5DB> environment
1038 variable. These are:
1039
1040 =over 4
1041
1042 =item C<$rl> - readline control XXX needs more explanation
1043
1044 =item C<$warnLevel> - whether or not debugger takes over warning handling
1045
1046 =item C<$dieLevel> - whether or not debugger takes over die handling
1047
1048 =item C<$signalLevel> - whether or not debugger takes over signal handling
1049
1050 =item C<$pre> - preprompt actions (array reference)
1051
1052 =item C<$post> - postprompt actions (array reference)
1053
1054 =item C<$pretype>
1055
1056 =item C<$CreateTTY> - whether or not to create a new TTY for this debugger
1057
1058 =item C<$CommandSet> - which command set to use (defaults to new, documented set)
1059
1060 =back
1061
1062 =cut
1063
1064 # These guys may be defined in $ENV{PERL5DB} :
1065 $rl          = 1     unless defined $rl;
1066 $warnLevel   = 1     unless defined $warnLevel;
1067 $dieLevel    = 1     unless defined $dieLevel;
1068 $signalLevel = 1     unless defined $signalLevel;
1069 $pre         = []    unless defined $pre;
1070 $post        = []    unless defined $post;
1071 $pretype     = []    unless defined $pretype;
1072 $CreateTTY   = 3     unless defined $CreateTTY;
1073 $CommandSet  = '580' unless defined $CommandSet;
1074
1075 share($rl);
1076 share($warnLevel);
1077 share($dieLevel);
1078 share($signalLevel);
1079 share($pre);
1080 share($post);
1081 share($pretype);
1082 share($rl);
1083 share($CreateTTY);
1084 share($CommandSet);
1085
1086 =pod
1087
1088 The default C<die>, C<warn>, and C<signal> handlers are set up.
1089
1090 =cut
1091
1092 warnLevel($warnLevel);
1093 dieLevel($dieLevel);
1094 signalLevel($signalLevel);
1095
1096 =pod
1097
1098 The pager to be used is needed next. We try to get it from the
1099 environment first.  If it's not defined there, we try to find it in
1100 the Perl C<Config.pm>.  If it's not there, we default to C<more>. We
1101 then call the C<pager()> function to save the pager name.
1102
1103 =cut
1104
1105 # This routine makes sure $pager is set up so that '|' can use it.
1106 pager(
1107
1108     # If PAGER is defined in the environment, use it.
1109     defined $ENV{PAGER}
1110     ? $ENV{PAGER}
1111
1112       # If not, see if Config.pm defines it.
1113     : eval { require Config }
1114       && defined $Config::Config{pager}
1115     ? $Config::Config{pager}
1116
1117       # If not, fall back to 'more'.
1118     : 'more'
1119   )
1120   unless defined $pager;
1121
1122 =pod
1123
1124 We set up the command to be used to access the man pages, the command
1125 recall character (C<!> unless otherwise defined) and the shell escape
1126 character (C<!> unless otherwise defined). Yes, these do conflict, and
1127 neither works in the debugger at the moment.
1128
1129 =cut
1130
1131 setman();
1132
1133 # Set up defaults for command recall and shell escape (note:
1134 # these currently don't work in linemode debugging).
1135 recallCommand("!") unless defined $prc;
1136 shellBang("!")     unless defined $psh;
1137
1138 =pod
1139
1140 We then set up the gigantic string containing the debugger help.
1141 We also set the limit on the number of arguments we'll display during a
1142 trace.
1143
1144 =cut
1145
1146 sethelp();
1147
1148 # If we didn't get a default for the length of eval/stack trace args,
1149 # set it here.
1150 $maxtrace = 400 unless defined $maxtrace;
1151
1152 =head2 SETTING UP THE DEBUGGER GREETING
1153
1154 The debugger I<greeting> helps to inform the user how many debuggers are
1155 running, and whether the current debugger is the primary or a child.
1156
1157 If we are the primary, we just hang onto our pid so we'll have it when
1158 or if we start a child debugger. If we are a child, we'll set things up
1159 so we'll have a unique greeting and so the parent will give us our own
1160 TTY later.
1161
1162 We save the current contents of the C<PERLDB_PIDS> environment variable
1163 because we mess around with it. We'll also need to hang onto it because
1164 we'll need it if we restart.
1165
1166 Child debuggers make a label out of the current PID structure recorded in
1167 PERLDB_PIDS plus the new PID. They also mark themselves as not having a TTY
1168 yet so the parent will give them one later via C<resetterm()>.
1169
1170 =cut
1171
1172 # Save the current contents of the environment; we're about to
1173 # much with it. We'll need this if we have to restart.
1174 use vars qw($ini_pids);
1175 $ini_pids = $ENV{PERLDB_PIDS};
1176
1177 use vars qw ($pids $term_pid);
1178
1179 if ( defined $ENV{PERLDB_PIDS} ) {
1180
1181     # We're a child. Make us a label out of the current PID structure
1182     # recorded in PERLDB_PIDS plus our (new) PID. Mark us as not having
1183     # a term yet so the parent will give us one later via resetterm().
1184
1185     my $env_pids = $ENV{PERLDB_PIDS};
1186     $pids = "[$env_pids]";
1187
1188     # Unless we are on OpenVMS, all programs under the DCL shell run under
1189     # the same PID.
1190
1191     if (($^O eq 'VMS') && ($env_pids =~ /\b$$\b/)) {
1192         $term_pid         = $$;
1193     }
1194     else {
1195         $ENV{PERLDB_PIDS} .= "->$$";
1196         $term_pid = -1;
1197     }
1198
1199 } ## end if (defined $ENV{PERLDB_PIDS...
1200 else {
1201
1202     # We're the parent PID. Initialize PERLDB_PID in case we end up with a
1203     # child debugger, and mark us as the parent, so we'll know to set up
1204     # more TTY's is we have to.
1205     $ENV{PERLDB_PIDS} = "$$";
1206     $pids             = "[pid=$$]";
1207     $term_pid         = $$;
1208 }
1209
1210 use vars qw($pidprompt);
1211 $pidprompt = '';
1212
1213 # Sets up $emacs as a synonym for $slave_editor.
1214 our ($slave_editor);
1215 *emacs = $slave_editor if $slave_editor;    # May be used in afterinit()...
1216
1217 =head2 READING THE RC FILE
1218
1219 The debugger will read a file of initialization options if supplied. If
1220 running interactively, this is C<.perldb>; if not, it's C<perldb.ini>.
1221
1222 =cut
1223
1224 # As noted, this test really doesn't check accurately that the debugger
1225 # is running at a terminal or not.
1226
1227 use vars qw($rcfile);
1228 {
1229     my $dev_tty = (($^O eq 'VMS') ? 'TT:' : '/dev/tty');
1230     # this is the wrong metric!
1231     $rcfile = ((-e $dev_tty) ? ".perldb" : "perldb.ini");
1232 }
1233
1234 =pod
1235
1236 The debugger does a safety test of the file to be read. It must be owned
1237 either by the current user or root, and must only be writable by the owner.
1238
1239 =cut
1240
1241 # This wraps a safety test around "do" to read and evaluate the init file.
1242 #
1243 # This isn't really safe, because there's a race
1244 # between checking and opening.  The solution is to
1245 # open and fstat the handle, but then you have to read and
1246 # eval the contents.  But then the silly thing gets
1247 # your lexical scope, which is unfortunate at best.
1248 sub safe_do {
1249     my $file = shift;
1250
1251     # Just exactly what part of the word "CORE::" don't you understand?
1252     local $SIG{__WARN__};
1253     local $SIG{__DIE__};
1254
1255     unless ( is_safe_file($file) ) {
1256         CORE::warn <<EO_GRIPE;
1257 perldb: Must not source insecure rcfile $file.
1258         You or the superuser must be the owner, and it must not
1259         be writable by anyone but its owner.
1260 EO_GRIPE
1261         return;
1262     } ## end unless (is_safe_file($file...
1263
1264     do $file;
1265     CORE::warn("perldb: couldn't parse $file: $@") if $@;
1266 } ## end sub safe_do
1267
1268 # This is the safety test itself.
1269 #
1270 # Verifies that owner is either real user or superuser and that no
1271 # one but owner may write to it.  This function is of limited use
1272 # when called on a path instead of upon a handle, because there are
1273 # no guarantees that filename (by dirent) whose file (by ino) is
1274 # eventually accessed is the same as the one tested.
1275 # Assumes that the file's existence is not in doubt.
1276 sub is_safe_file {
1277     my $path = shift;
1278     stat($path) || return;    # mysteriously vaporized
1279     my ( $dev, $ino, $mode, $nlink, $uid, $gid ) = stat(_);
1280
1281     return 0 if $uid != 0 && $uid != $<;
1282     return 0 if $mode & 022;
1283     return 1;
1284 } ## end sub is_safe_file
1285
1286 # If the rcfile (whichever one we decided was the right one to read)
1287 # exists, we safely do it.
1288 if ( -f $rcfile ) {
1289     safe_do("./$rcfile");
1290 }
1291
1292 # If there isn't one here, try the user's home directory.
1293 elsif ( defined $ENV{HOME} && -f "$ENV{HOME}/$rcfile" ) {
1294     safe_do("$ENV{HOME}/$rcfile");
1295 }
1296
1297 # Else try the login directory.
1298 elsif ( defined $ENV{LOGDIR} && -f "$ENV{LOGDIR}/$rcfile" ) {
1299     safe_do("$ENV{LOGDIR}/$rcfile");
1300 }
1301
1302 # If the PERLDB_OPTS variable has options in it, parse those out next.
1303 if ( defined $ENV{PERLDB_OPTS} ) {
1304     parse_options( $ENV{PERLDB_OPTS} );
1305 }
1306
1307 =pod
1308
1309 The last thing we do during initialization is determine which subroutine is
1310 to be used to obtain a new terminal when a new debugger is started. Right now,
1311 the debugger only handles TCP sockets, X11, OS/2, amd Mac OS X
1312 (darwin).
1313
1314 =cut
1315
1316 # Set up the get_fork_TTY subroutine to be aliased to the proper routine.
1317 # Works if you're running an xterm or xterm-like window, or you're on
1318 # OS/2, or on Mac OS X. This may need some expansion.
1319
1320 if (not defined &get_fork_TTY)       # only if no routine exists
1321 {
1322     if ( defined $remoteport ) {
1323                                                  # Expect an inetd-like server
1324         *get_fork_TTY = \&socket_get_fork_TTY;   # to listen to us
1325     }
1326     elsif (defined $ENV{TERM}                    # If we know what kind
1327                                                  # of terminal this is,
1328         and $ENV{TERM} eq 'xterm'                # and it's an xterm,
1329         and defined $ENV{DISPLAY}                # and what display it's on,
1330       )
1331     {
1332         *get_fork_TTY = \&xterm_get_fork_TTY;    # use the xterm version
1333     }
1334     elsif ( $^O eq 'os2' ) {                     # If this is OS/2,
1335         *get_fork_TTY = \&os2_get_fork_TTY;      # use the OS/2 version
1336     }
1337     elsif ( $^O eq 'darwin'                      # If this is Mac OS X
1338             and defined $ENV{TERM_PROGRAM}       # and we're running inside
1339             and $ENV{TERM_PROGRAM}
1340                 eq 'Apple_Terminal'              # Terminal.app
1341             )
1342     {
1343         *get_fork_TTY = \&macosx_get_fork_TTY;   # use the Mac OS X version
1344     }
1345 } ## end if (not defined &get_fork_TTY...
1346
1347 # untaint $^O, which may have been tainted by the last statement.
1348 # see bug [perl #24674]
1349 $^O =~ m/^(.*)\z/;
1350 $^O = $1;
1351
1352 # Here begin the unreadable code.  It needs fixing.
1353
1354 =head2 RESTART PROCESSING
1355
1356 This section handles the restart command. When the C<R> command is invoked, it
1357 tries to capture all of the state it can into environment variables, and
1358 then sets C<PERLDB_RESTART>. When we start executing again, we check to see
1359 if C<PERLDB_RESTART> is there; if so, we reload all the information that
1360 the R command stuffed into the environment variables.
1361
1362   PERLDB_RESTART   - flag only, contains no restart data itself.
1363   PERLDB_HIST      - command history, if it's available
1364   PERLDB_ON_LOAD   - breakpoints set by the rc file
1365   PERLDB_POSTPONE  - subs that have been loaded/not executed,
1366                      and have actions
1367   PERLDB_VISITED   - files that had breakpoints
1368   PERLDB_FILE_...  - breakpoints for a file
1369   PERLDB_OPT       - active options
1370   PERLDB_INC       - the original @INC
1371   PERLDB_PRETYPE   - preprompt debugger actions
1372   PERLDB_PRE       - preprompt Perl code
1373   PERLDB_POST      - post-prompt Perl code
1374   PERLDB_TYPEAHEAD - typeahead captured by readline()
1375
1376 We chug through all these variables and plug the values saved in them
1377 back into the appropriate spots in the debugger.
1378
1379 =cut
1380
1381 use vars qw(%postponed_file @typeahead);
1382
1383 our (@hist, @truehist);
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 # Local autoflush to avoid rt#116769,
1477 # as calling IO::File methods causes an unresolvable loop
1478 # that results in debugger failure.
1479 sub _autoflush {
1480     my $o = select($_[0]);
1481     $|++;
1482     select($o);
1483 }
1484
1485 if ($notty) {
1486     $runnonstop = 1;
1487     share($runnonstop);
1488 }
1489
1490 =pod
1491
1492 If there is a TTY, we have to determine who it belongs to before we can
1493 proceed. If this is a slave editor or graphical debugger (denoted by
1494 the first command-line switch being '-emacs'), we shift this off and
1495 set C<$rl> to 0 (XXX ostensibly to do straight reads).
1496
1497 =cut
1498
1499 else {
1500
1501     # Is Perl being run from a slave editor or graphical debugger?
1502     # If so, don't use readline, and set $slave_editor = 1.
1503     if ($slave_editor = ( @main::ARGV && ( $main::ARGV[0] eq '-emacs' ) )) {
1504         $rl = 0;
1505         shift(@main::ARGV);
1506     }
1507
1508     #require Term::ReadLine;
1509
1510 =pod
1511
1512 We then determine what the console should be on various systems:
1513
1514 =over 4
1515
1516 =item * Cygwin - We use C<stdin> instead of a separate device.
1517
1518 =cut
1519
1520     if ( $^O eq 'cygwin' ) {
1521
1522         # /dev/tty is binary. use stdin for textmode
1523         undef $console;
1524     }
1525
1526 =item * Unix - use F</dev/tty>.
1527
1528 =cut
1529
1530     elsif ( -e "/dev/tty" ) {
1531         $console = "/dev/tty";
1532     }
1533
1534 =item * Windows or MSDOS - use C<con>.
1535
1536 =cut
1537
1538     elsif ( $^O eq 'dos' or -e "con" or $^O eq 'MSWin32' ) {
1539         $console = "con";
1540     }
1541
1542 =item * VMS - use C<sys$command>.
1543
1544 =cut
1545
1546     else {
1547
1548         # everything else is ...
1549         $console = "sys\$command";
1550     }
1551
1552 =pod
1553
1554 =back
1555
1556 Several other systems don't use a specific console. We C<undef $console>
1557 for those (Windows using a slave editor/graphical debugger, NetWare, OS/2
1558 with a slave editor).
1559
1560 =cut
1561
1562     if ( ( $^O eq 'MSWin32' ) and ( $slave_editor or defined $ENV{EMACS} ) ) {
1563
1564         # /dev/tty is binary. use stdin for textmode
1565         $console = undef;
1566     }
1567
1568     if ( $^O eq 'NetWare' ) {
1569
1570         # /dev/tty is binary. use stdin for textmode
1571         $console = undef;
1572     }
1573
1574     # In OS/2, we need to use STDIN to get textmode too, even though
1575     # it pretty much looks like Unix otherwise.
1576     if ( defined $ENV{OS2_SHELL} and ( $slave_editor or $ENV{WINDOWID} ) )
1577     {    # In OS/2
1578         $console = undef;
1579     }
1580
1581 =pod
1582
1583 If there is a TTY hanging around from a parent, we use that as the console.
1584
1585 =cut
1586
1587     $console = $tty if defined $tty;
1588
1589 =head2 SOCKET HANDLING
1590
1591 The debugger is capable of opening a socket and carrying out a debugging
1592 session over the socket.
1593
1594 If C<RemotePort> was defined in the options, the debugger assumes that it
1595 should try to start a debugging session on that port. It builds the socket
1596 and then tries to connect the input and output filehandles to it.
1597
1598 =cut
1599
1600     # Handle socket stuff.
1601
1602     if ( defined $remoteport ) {
1603
1604         # If RemotePort was defined in the options, connect input and output
1605         # to the socket.
1606         $IN = $OUT = connect_remoteport();
1607     } ## end if (defined $remoteport)
1608
1609 =pod
1610
1611 If no C<RemotePort> was defined, and we want to create a TTY on startup,
1612 this is probably a situation where multiple debuggers are running (for example,
1613 a backticked command that starts up another debugger). We create a new IN and
1614 OUT filehandle, and do the necessary mojo to create a new TTY if we know how
1615 and if we can.
1616
1617 =cut
1618
1619     # Non-socket.
1620     else {
1621
1622         # Two debuggers running (probably a system or a backtick that invokes
1623         # the debugger itself under the running one). create a new IN and OUT
1624         # filehandle, and do the necessary mojo to create a new tty if we
1625         # know how, and we can.
1626         create_IN_OUT(4) if $CreateTTY & 4;
1627         if ($console) {
1628
1629             # If we have a console, check to see if there are separate ins and
1630             # outs to open. (They are assumed identical if not.)
1631
1632             my ( $i, $o ) = split /,/, $console;
1633             $o = $i unless defined $o;
1634
1635             # read/write on in, or just read, or read on STDIN.
1636             open( IN,      "+<$i" )
1637               || open( IN, "<$i" )
1638               || open( IN, "<&STDIN" );
1639
1640             # read/write/create/clobber out, or write/create/clobber out,
1641             # or merge with STDERR, or merge with STDOUT.
1642                  open( OUT, "+>$o" )
1643               || open( OUT, ">$o" )
1644               || open( OUT, ">&STDERR" )
1645               || open( OUT, ">&STDOUT" );    # so we don't dongle stdout
1646
1647         } ## end if ($console)
1648         elsif ( not defined $console ) {
1649
1650             # No console. Open STDIN.
1651             open( IN, "<&STDIN" );
1652
1653             # merge with STDERR, or with STDOUT.
1654             open( OUT,      ">&STDERR" )
1655               || open( OUT, ">&STDOUT" );    # so we don't dongle stdout
1656             $console = 'STDIN/OUT';
1657         } ## end elsif (not defined $console)
1658
1659         # Keep copies of the filehandles so that when the pager runs, it
1660         # can close standard input without clobbering ours.
1661         if ($console or (not defined($console))) {
1662             $IN = \*IN;
1663             $OUT = \*OUT;
1664         }
1665     } ## end elsif (from if(defined $remoteport))
1666
1667     # Unbuffer DB::OUT. We need to see responses right away.
1668     _autoflush($OUT);
1669
1670     # Line info goes to debugger output unless pointed elsewhere.
1671     # Pointing elsewhere makes it possible for slave editors to
1672     # keep track of file and position. We have both a filehandle
1673     # and a I/O description to keep track of.
1674     $LINEINFO = $OUT     unless defined $LINEINFO;
1675     $lineinfo = $console unless defined $lineinfo;
1676     # share($LINEINFO); # <- unable to share globs
1677     share($lineinfo);   #
1678
1679 =pod
1680
1681 To finish initialization, we show the debugger greeting,
1682 and then call the C<afterinit()> subroutine if there is one.
1683
1684 =cut
1685
1686     # Show the debugger greeting.
1687     $header =~ s/.Header: ([^,]+),v(\s+\S+\s+\S+).*$/$1$2/;
1688     unless ($runnonstop) {
1689         local $\ = '';
1690         local $, = '';
1691         if ( $term_pid eq '-1' ) {
1692             print $OUT "\nDaughter DB session started...\n";
1693         }
1694         else {
1695             print $OUT "\nLoading DB routines from $header\n";
1696             print $OUT (
1697                 "Editor support ",
1698                 $slave_editor ? "enabled" : "available", ".\n"
1699             );
1700             print $OUT
1701 "\nEnter h or 'h h' for help, or '$doccmd perldebug' for more help.\n\n";
1702         } ## end else [ if ($term_pid eq '-1')
1703     } ## end unless ($runnonstop)
1704 } ## end else [ if ($notty)
1705
1706 # XXX This looks like a bug to me.
1707 # Why copy to @ARGS and then futz with @args?
1708 @ARGS = @ARGV;
1709 # for (@args) {
1710     # Make sure backslashes before single quotes are stripped out, and
1711     # keep args unless they are numeric (XXX why?)
1712     # s/\'/\\\'/g;                      # removed while not justified understandably
1713     # s/(.*)/'$1'/ unless /^-?[\d.]+$/; # ditto
1714 # }
1715
1716 # If there was an afterinit() sub defined, call it. It will get
1717 # executed in our scope, so it can fiddle with debugger globals.
1718 if ( defined &afterinit ) {    # May be defined in $rcfile
1719     afterinit();
1720 }
1721
1722 # Inform us about "Stack dump during die enabled ..." in dieLevel().
1723 use vars qw($I_m_init);
1724
1725 $I_m_init = 1;
1726
1727 ############################################################ Subroutines
1728
1729 =head1 SUBROUTINES
1730
1731 =head2 DB
1732
1733 This gigantic subroutine is the heart of the debugger. Called before every
1734 statement, its job is to determine if a breakpoint has been reached, and
1735 stop if so; read commands from the user, parse them, and execute
1736 them, and then send execution off to the next statement.
1737
1738 Note that the order in which the commands are processed is very important;
1739 some commands earlier in the loop will actually alter the C<$cmd> variable
1740 to create other commands to be executed later. This is all highly I<optimized>
1741 but can be confusing. Check the comments for each C<$cmd ... && do {}> to
1742 see what's happening in any given command.
1743
1744 =cut
1745
1746 # $cmd cannot be an our() variable unfortunately (possible perl bug?).
1747
1748 use vars qw(
1749     $action
1750     $cmd
1751     $file
1752     $filename_ini
1753     $finished
1754     %had_breakpoints
1755     $level
1756     $max
1757     $package
1758     $try
1759 );
1760
1761 our (
1762     %alias,
1763     $doret,
1764     $end,
1765     $fall_off_end,
1766     $incr,
1767     $laststep,
1768     $rc,
1769     $sh,
1770     $stack_depth,
1771     @stack,
1772     @to_watch,
1773     @old_watch,
1774 );
1775
1776 sub _DB__determine_if_we_should_break
1777 {
1778     # if we have something here, see if we should break.
1779     # $stop is lexical and local to this block - $action on the other hand
1780     # is global.
1781     my $stop;
1782
1783     if ( $dbline{$line}
1784         && _is_breakpoint_enabled($filename, $line)
1785         && (( $stop, $action ) = split( /\0/, $dbline{$line} ) ) )
1786     {
1787
1788         # Stop if the stop criterion says to just stop.
1789         if ( $stop eq '1' ) {
1790             $signal |= 1;
1791         }
1792
1793         # It's a conditional stop; eval it in the user's context and
1794         # see if we should stop. If so, remove the one-time sigil.
1795         elsif ($stop) {
1796             $evalarg = "\$DB::signal |= 1 if do {$stop}";
1797             # The &-call is here to ascertain the mutability of @_.
1798             &DB::eval;
1799             # If the breakpoint is temporary, then delete its enabled status.
1800             if ($dbline{$line} =~ s/;9($|\0)/$1/) {
1801                 _cancel_breakpoint_temp_enabled_status($filename, $line);
1802             }
1803         }
1804     } ## end if ($dbline{$line} && ...
1805 }
1806
1807 sub _DB__is_finished {
1808     if ($finished and $level <= 1) {
1809         end_report();
1810         return 1;
1811     }
1812     else {
1813         return;
1814     }
1815 }
1816
1817 sub _DB__read_next_cmd
1818 {
1819     my ($tid) = @_;
1820
1821     # We have a terminal, or can get one ...
1822     if (!$term) {
1823         setterm();
1824     }
1825
1826     # ... and it belongs to this PID or we get one for this PID ...
1827     if ($term_pid != $$) {
1828         resetterm(1);
1829     }
1830
1831     # ... and we got a line of command input ...
1832     $cmd = DB::readline(
1833         "$pidprompt $tid DB"
1834         . ( '<' x $level )
1835         . ( $#hist + 1 )
1836         . ( '>' x $level ) . " "
1837     );
1838
1839     return defined($cmd);
1840 }
1841
1842 sub _DB__trim_command_and_return_first_component {
1843     my ($obj) = @_;
1844
1845     $cmd =~ s/\A\s+//s;    # trim annoying leading whitespace
1846     $cmd =~ s/\s+\z//s;    # trim annoying trailing whitespace
1847
1848     my ($verb, $args) = $cmd =~ m{\A(\S*)\s*(.*)}s;
1849
1850     $obj->cmd_verb($verb);
1851     $obj->cmd_args($args);
1852
1853     return;
1854 }
1855
1856 sub _DB__handle_f_command {
1857     my ($obj) = @_;
1858
1859     if ($file = $obj->cmd_args) {
1860         # help for no arguments (old-style was return from sub).
1861         if ( !$file ) {
1862             print $OUT
1863             "The old f command is now the r command.\n";    # hint
1864             print $OUT "The new f command switches filenames.\n";
1865             next CMD;
1866         } ## end if (!$file)
1867
1868         # if not in magic file list, try a close match.
1869         if ( !defined $main::{ '_<' . $file } ) {
1870             if ( ($try) = grep( m#^_<.*$file#, keys %main:: ) ) {
1871                 {
1872                     $try = substr( $try, 2 );
1873                     print $OUT "Choosing $try matching '$file':\n";
1874                     $file = $try;
1875                 }
1876             } ## end if (($try) = grep(m#^_<.*$file#...
1877         } ## end if (!defined $main::{ ...
1878
1879         # If not successfully switched now, we failed.
1880         if ( !defined $main::{ '_<' . $file } ) {
1881             print $OUT "No file matching '$file' is loaded.\n";
1882             next CMD;
1883         }
1884
1885         # We switched, so switch the debugger internals around.
1886         elsif ( $file ne $filename ) {
1887             *dbline   = $main::{ '_<' . $file };
1888             $max      = $#dbline;
1889             $filename = $file;
1890             $start    = 1;
1891             $cmd      = "l";
1892         } ## end elsif ($file ne $filename)
1893
1894         # We didn't switch; say we didn't.
1895         else {
1896             print $OUT "Already in $file.\n";
1897             next CMD;
1898         }
1899     }
1900
1901     return;
1902 }
1903
1904 sub _DB__handle_dot_command {
1905     my ($obj) = @_;
1906
1907     # . command.
1908     if ($obj->_is_full('.')) {
1909         $incr = -1;    # stay at current line
1910
1911         # Reset everything to the old location.
1912         $start    = $line;
1913         $filename = $filename_ini;
1914         *dbline   = $main::{ '_<' . $filename };
1915         $max      = $#dbline;
1916
1917         # Now where are we?
1918         print_lineinfo($obj->position());
1919         next CMD;
1920     }
1921
1922     return;
1923 }
1924
1925 sub _DB__handle_y_command {
1926     my ($obj) = @_;
1927
1928     if (my ($match_level, $match_vars)
1929         = $obj->cmd_args =~ /\A(?:(\d*)\s*(.*))?\z/) {
1930
1931         # See if we've got the necessary support.
1932         if (!eval { require PadWalker; PadWalker->VERSION(0.08) }) {
1933             my $Err = $@;
1934             _db_warn(
1935                 $Err =~ /locate/
1936                 ? "PadWalker module not found - please install\n"
1937                 : $Err
1938             );
1939             next CMD;
1940         }
1941
1942         # Load up dumpvar if we don't have it. If we can, that is.
1943         do 'dumpvar.pl' || die $@ unless defined &main::dumpvar;
1944         defined &main::dumpvar
1945             or print $OUT "dumpvar.pl not available.\n"
1946             and next CMD;
1947
1948         # Got all the modules we need. Find them and print them.
1949         my @vars = split( ' ', $match_vars || '' );
1950
1951         # Find the pad.
1952         my $h = eval { PadWalker::peek_my( ( $match_level || 0 ) + 1 ) };
1953
1954         # Oops. Can't find it.
1955         if (my $Err = $@) {
1956             $Err =~ s/ at .*//;
1957             _db_warn($Err);
1958             next CMD;
1959         }
1960
1961         # Show the desired vars with dumplex().
1962         my $savout = select($OUT);
1963
1964         # Have dumplex dump the lexicals.
1965         foreach my $key (sort keys %$h) {
1966             dumpvar::dumplex( $key, $h->{$key},
1967                 defined $option{dumpDepth} ? $option{dumpDepth} : -1,
1968                 @vars );
1969         }
1970         select($savout);
1971         next CMD;
1972     }
1973 }
1974
1975 sub _DB__handle_c_command {
1976     my ($obj) = @_;
1977
1978     my $i = $obj->cmd_args;
1979
1980     if ($i =~ m#\A[\w:]*\z#) {
1981
1982         # Hey, show's over. The debugged program finished
1983         # executing already.
1984         next CMD if _DB__is_finished();
1985
1986         # Capture the place to put a one-time break.
1987         $subname = $i;
1988
1989         #  Probably not needed, since we finish an interactive
1990         #  sub-session anyway...
1991         # local $filename = $filename;
1992         # local *dbline = *dbline; # XXX Would this work?!
1993         #
1994         # The above question wonders if localizing the alias
1995         # to the magic array works or not. Since it's commented
1996         # out, we'll just leave that to speculation for now.
1997
1998         # If the "subname" isn't all digits, we'll assume it
1999         # is a subroutine name, and try to find it.
2000         if ( $subname =~ /\D/ ) {    # subroutine name
2001             # Qualify it to the current package unless it's
2002             # already qualified.
2003             $subname = $package . "::" . $subname
2004             unless $subname =~ /::/;
2005
2006             # find_sub will return "file:line_number" corresponding
2007             # to where the subroutine is defined; we call find_sub,
2008             # break up the return value, and assign it in one
2009             # operation.
2010             ( $file, $i ) = ( find_sub($subname) =~ /^(.*):(.*)$/ );
2011
2012             # Force the line number to be numeric.
2013             $i = $i + 0;
2014
2015             # If we got a line number, we found the sub.
2016             if ($i) {
2017
2018                 # Switch all the debugger's internals around so
2019                 # we're actually working with that file.
2020                 $filename = $file;
2021                 *dbline   = $main::{ '_<' . $filename };
2022
2023                 # Mark that there's a breakpoint in this file.
2024                 $had_breakpoints{$filename} |= 1;
2025
2026                 # Scan forward to the first executable line
2027                 # after the 'sub whatever' line.
2028                 $max = $#dbline;
2029                 my $_line_num = $i;
2030                 while ($dbline[$_line_num] == 0 && $_line_num< $max)
2031                 {
2032                     $_line_num++;
2033                 }
2034                 $i = $_line_num;
2035             } ## end if ($i)
2036
2037             # We didn't find a sub by that name.
2038             else {
2039                 print $OUT "Subroutine $subname not found.\n";
2040                 next CMD;
2041             }
2042         } ## end if ($subname =~ /\D/)
2043
2044         # At this point, either the subname was all digits (an
2045         # absolute line-break request) or we've scanned through
2046         # the code following the definition of the sub, looking
2047         # for an executable, which we may or may not have found.
2048         #
2049         # If $i (which we set $subname from) is non-zero, we
2050         # got a request to break at some line somewhere. On
2051         # one hand, if there wasn't any real subroutine name
2052         # involved, this will be a request to break in the current
2053         # file at the specified line, so we have to check to make
2054         # sure that the line specified really is breakable.
2055         #
2056         # On the other hand, if there was a subname supplied, the
2057         # preceding block has moved us to the proper file and
2058         # location within that file, and then scanned forward
2059         # looking for the next executable line. We have to make
2060         # sure that one was found.
2061         #
2062         # On the gripping hand, we can't do anything unless the
2063         # current value of $i points to a valid breakable line.
2064         # Check that.
2065         if ($i) {
2066
2067             # Breakable?
2068             if ( $dbline[$i] == 0 ) {
2069                 print $OUT "Line $i not breakable.\n";
2070                 next CMD;
2071             }
2072
2073             # Yes. Set up the one-time-break sigil.
2074             $dbline{$i} =~ s/($|\0)/;9$1/;  # add one-time-only b.p.
2075             _enable_breakpoint_temp_enabled_status($filename, $i);
2076         } ## end if ($i)
2077
2078         # Turn off stack tracing from here up.
2079         for my $j (0 .. $stack_depth) {
2080             $stack[ $j ] &= ~1;
2081         }
2082         last CMD;
2083     }
2084
2085     return;
2086 }
2087
2088 sub _DB__handle_forward_slash_command {
2089     my ($obj) = @_;
2090
2091     # The pattern as a string.
2092     use vars qw($inpat);
2093
2094     if (($inpat) = $cmd =~ m#\A/(.*)\z#) {
2095
2096         # Remove the final slash.
2097         $inpat =~ s:([^\\])/$:$1:;
2098
2099         # If the pattern isn't null ...
2100         if ( $inpat ne "" ) {
2101
2102             # Turn off warn and die processing for a bit.
2103             local $SIG{__DIE__};
2104             local $SIG{__WARN__};
2105
2106             # Create the pattern.
2107             eval 'no strict q/vars/; $inpat =~ m' . "\a$inpat\a";
2108             if ( $@ ne "" ) {
2109
2110                 # Oops. Bad pattern. No biscuit.
2111                 # Print the eval error and go back for more
2112                 # commands.
2113                 print {$OUT} "$@";
2114                 next CMD;
2115             }
2116             $obj->pat($inpat);
2117         } ## end if ($inpat ne "")
2118
2119         # Set up to stop on wrap-around.
2120         $end = $start;
2121
2122         # Don't move off the current line.
2123         $incr = -1;
2124
2125         my $pat = $obj->pat;
2126
2127         # Done in eval so nothing breaks if the pattern
2128         # does something weird.
2129         eval
2130         {
2131             no strict q/vars/;
2132             for (;;) {
2133                 # Move ahead one line.
2134                 ++$start;
2135
2136                 # Wrap if we pass the last line.
2137                 if ($start > $max) {
2138                     $start = 1;
2139                 }
2140
2141                 # Stop if we have gotten back to this line again,
2142                 last if ($start == $end);
2143
2144                 # A hit! (Note, though, that we are doing
2145                 # case-insensitive matching. Maybe a qr//
2146                 # expression would be better, so the user could
2147                 # do case-sensitive matching if desired.
2148                 if ($dbline[$start] =~ m/$pat/i) {
2149                     if ($slave_editor) {
2150                         # Handle proper escaping in the slave.
2151                         print {$OUT} "\032\032$filename:$start:0\n";
2152                     }
2153                     else {
2154                         # Just print the line normally.
2155                         print {$OUT} "$start:\t",$dbline[$start],"\n";
2156                     }
2157                     # And quit since we found something.
2158                     last;
2159                 }
2160             }
2161         };
2162
2163         if ($@) {
2164             warn $@;
2165         }
2166
2167         # If we wrapped, there never was a match.
2168         if ( $start == $end ) {
2169             print {$OUT} "/$pat/: not found\n";
2170         }
2171         next CMD;
2172     }
2173
2174     return;
2175 }
2176
2177 sub _DB__handle_question_mark_command {
2178     my ($obj) = @_;
2179
2180     # ? - backward pattern search.
2181     if (my ($inpat) = $cmd =~ m#\A\?(.*)\z#) {
2182
2183         # Get the pattern, remove trailing question mark.
2184         $inpat =~ s:([^\\])\?$:$1:;
2185
2186         # If we've got one ...
2187         if ( $inpat ne "" ) {
2188
2189             # Turn off die & warn handlers.
2190             local $SIG{__DIE__};
2191             local $SIG{__WARN__};
2192             eval '$inpat =~ m' . "\a$inpat\a";
2193
2194             if ( $@ ne "" ) {
2195
2196                 # Ouch. Not good. Print the error.
2197                 print $OUT $@;
2198                 next CMD;
2199             }
2200             $obj->pat($inpat);
2201         } ## end if ($inpat ne "")
2202
2203         # Where we are now is where to stop after wraparound.
2204         $end = $start;
2205
2206         # Don't move away from this line.
2207         $incr = -1;
2208
2209         my $pat = $obj->pat;
2210         # Search inside the eval to prevent pattern badness
2211         # from killing us.
2212         eval {
2213             no strict q/vars/;
2214             for (;;) {
2215                 # Back up a line.
2216                 --$start;
2217
2218                 # Wrap if we pass the first line.
2219
2220                 $start = $max if ($start <= 0);
2221
2222                 # Quit if we get back where we started,
2223                 last if ($start == $end);
2224
2225                 # Match?
2226                 if ($dbline[$start] =~ m/$pat/i) {
2227                     if ($slave_editor) {
2228                         # Yep, follow slave editor requirements.
2229                         print $OUT "\032\032$filename:$start:0\n";
2230                     }
2231                     else {
2232                         # Yep, just print normally.
2233                         print $OUT "$start:\t",$dbline[$start],"\n";
2234                     }
2235
2236                     # Found, so done.
2237                     last;
2238                 }
2239             }
2240         };
2241
2242         # Say we failed if the loop never found anything,
2243         if ( $start == $end ) {
2244             print {$OUT} "?$pat?: not found\n";
2245         }
2246         next CMD;
2247     }
2248
2249     return;
2250 }
2251
2252 sub _DB__handle_restart_and_rerun_commands {
2253     my ($obj) = @_;
2254
2255     my $cmd_cmd = $obj->cmd_verb;
2256     my $cmd_params = $obj->cmd_args;
2257     # R - restart execution.
2258     # rerun - controlled restart execution.
2259     if ($cmd_cmd eq 'rerun' or $cmd_params eq '') {
2260         my @args = ($cmd_cmd eq 'R' ? restart() : rerun($cmd_params));
2261
2262         # Close all non-system fds for a clean restart.  A more
2263         # correct method would be to close all fds that were not
2264         # open when the process started, but this seems to be
2265         # hard.  See "debugger 'R'estart and open database
2266         # connections" on p5p.
2267
2268         my $max_fd = 1024; # default if POSIX can't be loaded
2269         if (eval { require POSIX }) {
2270             eval { $max_fd = POSIX::sysconf(POSIX::_SC_OPEN_MAX()) };
2271         }
2272
2273         if (defined $max_fd) {
2274             foreach ($^F+1 .. $max_fd-1) {
2275                 next unless open FD_TO_CLOSE, "<&=$_";
2276                 close(FD_TO_CLOSE);
2277             }
2278         }
2279
2280         # And run Perl again.  We use exec() to keep the
2281         # PID stable (and that way $ini_pids is still valid).
2282         exec(@args) or print {$OUT} "exec failed: $!\n";
2283
2284         last CMD;
2285     }
2286
2287     return;
2288 }
2289
2290 sub _DB__handle_run_command_in_pager_command {
2291     my ($obj) = @_;
2292
2293     if ($cmd =~ m#\A\|\|?\s*[^|]#) {
2294         if ( $pager =~ /^\|/ ) {
2295
2296             # Default pager is into a pipe. Redirect I/O.
2297             open( SAVEOUT, ">&STDOUT" )
2298             || _db_warn("Can't save STDOUT");
2299             open( STDOUT, ">&OUT" )
2300             || _db_warn("Can't redirect STDOUT");
2301         } ## end if ($pager =~ /^\|/)
2302         else {
2303
2304             # Not into a pipe. STDOUT is safe.
2305             open( SAVEOUT, ">&OUT" ) || _db_warn("Can't save DB::OUT");
2306         }
2307
2308         # Fix up environment to record we have less if so.
2309         fix_less();
2310
2311         unless ( $obj->piped(scalar ( open( OUT, $pager ) ) ) ) {
2312
2313             # Couldn't open pipe to pager.
2314             _db_warn("Can't pipe output to '$pager'");
2315             if ( $pager =~ /^\|/ ) {
2316
2317                 # Redirect I/O back again.
2318                 open( OUT, ">&STDOUT" )    # XXX: lost message
2319                 || _db_warn("Can't restore DB::OUT");
2320                 open( STDOUT, ">&SAVEOUT" )
2321                 || _db_warn("Can't restore STDOUT");
2322                 close(SAVEOUT);
2323             } ## end if ($pager =~ /^\|/)
2324             else {
2325
2326                 # Redirect I/O. STDOUT already safe.
2327                 open( OUT, ">&STDOUT" )    # XXX: lost message
2328                 || _db_warn("Can't restore DB::OUT");
2329             }
2330             next CMD;
2331         } ## end unless ($piped = open(OUT,...
2332
2333         # Set up broken-pipe handler if necessary.
2334         $SIG{PIPE} = \&DB::catch
2335         if $pager =~ /^\|/
2336         && ( "" eq $SIG{PIPE} || "DEFAULT" eq $SIG{PIPE} );
2337
2338         _autoflush(\*OUT);
2339         # Save current filehandle, and put it back.
2340         $obj->selected(scalar( select(OUT) ));
2341         # Don't put it back if pager was a pipe.
2342         if ($cmd !~ /\A\|\|/)
2343         {
2344             select($obj->selected());
2345             $obj->selected("");
2346         }
2347
2348         # Trim off the pipe symbols and run the command now.
2349         $cmd =~ s#\A\|+\s*##;
2350         redo PIPE;
2351     }
2352
2353     return;
2354 }
2355
2356 sub _DB__handle_m_command {
2357     my ($obj) = @_;
2358
2359     if ($cmd =~ s#\Am\s+([\w:]+)\s*\z# #) {
2360         methods($1);
2361         next CMD;
2362     }
2363
2364     # m expr - set up DB::eval to do the work
2365     if ($cmd =~ s#\Am\b# #) {    # Rest gets done by DB::eval()
2366         $onetimeDump = 'methods';   #  method output gets used there
2367     }
2368
2369     return;
2370 }
2371
2372 sub _DB__at_end_of_every_command {
2373     my ($obj) = @_;
2374
2375     # At the end of every command:
2376     if ($obj->piped) {
2377
2378         # Unhook the pipe mechanism now.
2379         if ( $pager =~ /^\|/ ) {
2380
2381             # No error from the child.
2382             $? = 0;
2383
2384             # we cannot warn here: the handle is missing --tchrist
2385             close(OUT) || print SAVEOUT "\nCan't close DB::OUT\n";
2386
2387             # most of the $? crud was coping with broken cshisms
2388             # $? is explicitly set to 0, so this never runs.
2389             if ($?) {
2390                 print SAVEOUT "Pager '$pager' failed: ";
2391                 if ( $? == -1 ) {
2392                     print SAVEOUT "shell returned -1\n";
2393                 }
2394                 elsif ( $? >> 8 ) {
2395                     print SAVEOUT ( $? & 127 )
2396                     ? " (SIG#" . ( $? & 127 ) . ")"
2397                     : "", ( $? & 128 ) ? " -- core dumped" : "", "\n";
2398                 }
2399                 else {
2400                     print SAVEOUT "status ", ( $? >> 8 ), "\n";
2401                 }
2402             } ## end if ($?)
2403
2404             # Reopen filehandle for our output (if we can) and
2405             # restore STDOUT (if we can).
2406             open( OUT, ">&STDOUT" ) || _db_warn("Can't restore DB::OUT");
2407             open( STDOUT, ">&SAVEOUT" )
2408             || _db_warn("Can't restore STDOUT");
2409
2410             # Turn off pipe exception handler if necessary.
2411             $SIG{PIPE} = "DEFAULT" if $SIG{PIPE} eq \&DB::catch;
2412
2413             # Will stop ignoring SIGPIPE if done like nohup(1)
2414             # does SIGINT but Perl doesn't give us a choice.
2415         } ## end if ($pager =~ /^\|/)
2416         else {
2417
2418             # Non-piped "pager". Just restore STDOUT.
2419             open( OUT, ">&SAVEOUT" ) || _db_warn("Can't restore DB::OUT");
2420         }
2421
2422         # Let Readline know about the new filehandles.
2423         reset_IN_OUT( \*IN, \*OUT );
2424
2425         # Close filehandle pager was using, restore the normal one
2426         # if necessary,
2427         close(SAVEOUT);
2428
2429         if ($obj->selected() ne "") {
2430             select($obj->selected);
2431             $obj->selected("");
2432         }
2433
2434         # No pipes now.
2435         $obj->piped("");
2436     } ## end if ($piped)
2437
2438     return;
2439 }
2440
2441 sub _DB__handle_watch_expressions
2442 {
2443     my $self = shift;
2444
2445     if ( $DB::trace & 2 ) {
2446         for my $n (0 .. $#DB::to_watch) {
2447             $DB::evalarg = $DB::to_watch[$n];
2448             local $DB::onetimeDump;    # Tell DB::eval() to not output results
2449
2450             # Fix context DB::eval() wants to return an array, but
2451             # we need a scalar here.
2452             my ($val) = join( "', '", DB::eval(@_) );
2453             $val = ( ( defined $val ) ? "'$val'" : 'undef' );
2454
2455             # Did it change?
2456             if ( $val ne $DB::old_watch[$n] ) {
2457
2458                 # Yep! Show the difference, and fake an interrupt.
2459                 $DB::signal = 1;
2460                 print {$DB::OUT} <<EOP;
2461 Watchpoint $n:\t$DB::to_watch[$n] changed:
2462     old value:\t$DB::old_watch[$n]
2463     new value:\t$val
2464 EOP
2465                 $DB::old_watch[$n] = $val;
2466             } ## end if ($val ne $old_watch...
2467         } ## end for my $n (0 ..
2468     } ## end if ($trace & 2)
2469
2470     return;
2471 }
2472
2473 # 't' is type.
2474 # 'm' is method.
2475 # 'v' is the value (i.e: method name or subroutine ref).
2476 # 's' is subroutine.
2477 my %cmd_lookup =
2478 (
2479     '-' => { t => 'm', v => '_handle_dash_command', },
2480     '.' => { t => 's', v => \&_DB__handle_dot_command, },
2481     '=' => { t => 'm', v => '_handle_equal_sign_command', },
2482     'H' => { t => 'm', v => '_handle_H_command', },
2483     'S' => { t => 'm', v => '_handle_S_command', },
2484     'T' => { t => 'm', v => '_handle_T_command', },
2485     'W' => { t => 'm', v => '_handle_W_command', },
2486     'c' => { t => 's', v => \&_DB__handle_c_command, },
2487     'f' => { t => 's', v => \&_DB__handle_f_command, },
2488     'm' => { t => 's', v => \&_DB__handle_m_command, },
2489     'n' => { t => 'm', v => '_handle_n_command', },
2490     'p' => { t => 'm', v => '_handle_p_command', },
2491     'q' => { t => 'm', v => '_handle_q_command', },
2492     'r' => { t => 'm', v => '_handle_r_command', },
2493     's' => { t => 'm', v => '_handle_s_command', },
2494     'save' => { t => 'm', v => '_handle_save_command', },
2495     'source' => { t => 'm', v => '_handle_source_command', },
2496     't' => { t => 'm', v => '_handle_t_command', },
2497     'w' => { t => 'm', v => '_handle_w_command', },
2498     'x' => { t => 'm', v => '_handle_x_command', },
2499     'y' => { t => 's', v => \&_DB__handle_y_command, },
2500     (map { $_ => { t => 'm', v => '_handle_V_command_and_X_command', }, }
2501         ('X', 'V')),
2502     (map { $_ => { t => 'm', v => '_handle_enable_disable_commands', }, }
2503         qw(enable disable)),
2504     (map { $_ =>
2505         { t => 's', v => \&_DB__handle_restart_and_rerun_commands, },
2506         } qw(R rerun)),
2507     (map { $_ => {t => 'm', v => '_handle_cmd_wrapper_commands' }, }
2508         qw(a A b B e E h i l L M o O v w W)),
2509 );
2510
2511 sub DB {
2512
2513     # lock the debugger and get the thread id for the prompt
2514     lock($DBGR);
2515     my $tid;
2516     my $position;
2517     my ($prefix, $after, $infix);
2518     my $pat;
2519     my $explicit_stop;
2520     my $piped;
2521     my $selected;
2522
2523     if ($ENV{PERL5DB_THREADED}) {
2524         $tid = eval { "[".threads->tid."]" };
2525     }
2526
2527     my $cmd_verb;
2528     my $cmd_args;
2529
2530     my $obj = DB::Obj->new(
2531         {
2532             position => \$position,
2533             prefix => \$prefix,
2534             after => \$after,
2535             explicit_stop => \$explicit_stop,
2536             infix => \$infix,
2537             cmd_args => \$cmd_args,
2538             cmd_verb => \$cmd_verb,
2539             pat => \$pat,
2540             piped => \$piped,
2541             selected => \$selected,
2542         },
2543     );
2544
2545     $obj->_DB_on_init__initialize_globals(@_);
2546
2547     # Preserve current values of $@, $!, $^E, $,, $/, $\, $^W.
2548     # The code being debugged may have altered them.
2549     DB::save();
2550
2551     # Since DB::DB gets called after every line, we can use caller() to
2552     # figure out where we last were executing. Sneaky, eh? This works because
2553     # caller is returning all the extra information when called from the
2554     # debugger.
2555     local ( $package, $filename, $line ) = caller;
2556     $filename_ini = $filename;
2557
2558     # set up the context for DB::eval, so it can properly execute
2559     # code on behalf of the user. We add the package in so that the
2560     # code is eval'ed in the proper package (not in the debugger!).
2561     local $usercontext = _calc_usercontext($package);
2562
2563     # Create an alias to the active file magical array to simplify
2564     # the code here.
2565     local (*dbline) = $main::{ '_<' . $filename };
2566
2567     # Last line in the program.
2568     $max = $#dbline;
2569
2570     # The &-call is here to ascertain the mutability of @_.
2571     &_DB__determine_if_we_should_break;
2572
2573     # Preserve the current stop-or-not, and see if any of the W
2574     # (watch expressions) has changed.
2575     my $was_signal = $signal;
2576
2577     # If we have any watch expressions ...
2578     _DB__handle_watch_expressions($obj);
2579
2580 =head2 C<watchfunction()>
2581
2582 C<watchfunction()> is a function that can be defined by the user; it is a
2583 function which will be run on each entry to C<DB::DB>; it gets the
2584 current package, filename, and line as its parameters.
2585
2586 The watchfunction can do anything it likes; it is executing in the
2587 debugger's context, so it has access to all of the debugger's internal
2588 data structures and functions.
2589
2590 C<watchfunction()> can control the debugger's actions. Any of the following
2591 will cause the debugger to return control to the user's program after
2592 C<watchfunction()> executes:
2593
2594 =over 4
2595
2596 =item *
2597
2598 Returning a false value from the C<watchfunction()> itself.
2599
2600 =item *
2601
2602 Altering C<$single> to a false value.
2603
2604 =item *
2605
2606 Altering C<$signal> to a false value.
2607
2608 =item *
2609
2610 Turning off the C<4> bit in C<$trace> (this also disables the
2611 check for C<watchfunction()>. This can be done with
2612
2613     $trace &= ~4;
2614
2615 =back
2616
2617 =cut
2618
2619     # If there's a user-defined DB::watchfunction, call it with the
2620     # current package, filename, and line. The function executes in
2621     # the DB:: package.
2622     if ( $trace & 4 ) {    # User-installed watch
2623         return
2624           if watchfunction( $package, $filename, $line )
2625           and not $single
2626           and not $was_signal
2627           and not( $trace & ~4 );
2628     } ## end if ($trace & 4)
2629
2630     # Pick up any alteration to $signal in the watchfunction, and
2631     # turn off the signal now.
2632     $was_signal = $signal;
2633     $signal     = 0;
2634
2635 =head2 GETTING READY TO EXECUTE COMMANDS
2636
2637 The debugger decides to take control if single-step mode is on, the
2638 C<t> command was entered, or the user generated a signal. If the program
2639 has fallen off the end, we set things up so that entering further commands
2640 won't cause trouble, and we say that the program is over.
2641
2642 =cut
2643
2644     # Make sure that we always print if asked for explicitly regardless
2645     # of $trace_to_depth .
2646     $explicit_stop = ($single || $was_signal);
2647
2648     # Check to see if we should grab control ($single true,
2649     # trace set appropriately, or we got a signal).
2650     if ( $explicit_stop || ( $trace & 1 ) ) {
2651         $obj->_DB__grab_control(@_);
2652     } ## end if ($single || ($trace...
2653
2654 =pod
2655
2656 If there's an action to be executed for the line we stopped at, execute it.
2657 If there are any preprompt actions, execute those as well.
2658
2659 =cut
2660
2661     # If there's an action, do it now.
2662     if ($action) {
2663         $evalarg = $action;
2664         # The &-call is here to ascertain the mutability of @_.
2665         &DB::eval;
2666     }
2667
2668     # Are we nested another level (e.g., did we evaluate a function
2669     # that had a breakpoint in it at the debugger prompt)?
2670     if ( $single || $was_signal ) {
2671
2672         # Yes, go down a level.
2673         local $level = $level + 1;
2674
2675         # Do any pre-prompt actions.
2676         foreach $evalarg (@$pre) {
2677             # The &-call is here to ascertain the mutability of @_.
2678             &DB::eval;
2679         }
2680
2681         # Complain about too much recursion if we passed the limit.
2682         if ($single & 4) {
2683             print $OUT $stack_depth . " levels deep in subroutine calls!\n";
2684         }
2685
2686         # The line we're currently on. Set $incr to -1 to stay here
2687         # until we get a command that tells us to advance.
2688         $start = $line;
2689         $incr  = -1;      # for backward motion.
2690
2691         # Tack preprompt debugger actions ahead of any actual input.
2692         @typeahead = ( @$pretype, @typeahead );
2693
2694 =head2 WHERE ARE WE?
2695
2696 XXX Relocate this section?
2697
2698 The debugger normally shows the line corresponding to the current line of
2699 execution. Sometimes, though, we want to see the next line, or to move elsewhere
2700 in the file. This is done via the C<$incr>, C<$start>, and C<$max> variables.
2701
2702 C<$incr> controls by how many lines the I<current> line should move forward
2703 after a command is executed. If set to -1, this indicates that the I<current>
2704 line shouldn't change.
2705
2706 C<$start> is the I<current> line. It is used for things like knowing where to
2707 move forwards or backwards from when doing an C<L> or C<-> command.
2708
2709 C<$max> tells the debugger where the last line of the current file is. It's
2710 used to terminate loops most often.
2711
2712 =head2 THE COMMAND LOOP
2713
2714 Most of C<DB::DB> is actually a command parsing and dispatch loop. It comes
2715 in two parts:
2716
2717 =over 4
2718
2719 =item *
2720
2721 The outer part of the loop, starting at the C<CMD> label. This loop
2722 reads a command and then executes it.
2723
2724 =item *
2725
2726 The inner part of the loop, starting at the C<PIPE> label. This part
2727 is wholly contained inside the C<CMD> block and only executes a command.
2728 Used to handle commands running inside a pager.
2729
2730 =back
2731
2732 So why have two labels to restart the loop? Because sometimes, it's easier to
2733 have a command I<generate> another command and then re-execute the loop to do
2734 the new command. This is faster, but perhaps a bit more convoluted.
2735
2736 =cut
2737
2738         # The big command dispatch loop. It keeps running until the
2739         # user yields up control again.
2740         #
2741         # If we have a terminal for input, and we get something back
2742         # from readline(), keep on processing.
2743
2744       CMD:
2745         while (_DB__read_next_cmd($tid))
2746         {
2747
2748             share($cmd);
2749             # ... try to execute the input as debugger commands.
2750
2751             # Don't stop running.
2752             $single = 0;
2753
2754             # No signal is active.
2755             $signal = 0;
2756
2757             # Handle continued commands (ending with \):
2758             if ($cmd =~ s/\\\z/\n/) {
2759                 $cmd .= DB::readline("  cont: ");
2760                 redo CMD;
2761             }
2762
2763 =head4 The null command
2764
2765 A newline entered by itself means I<re-execute the last command>. We grab the
2766 command out of C<$laststep> (where it was recorded previously), and copy it
2767 back into C<$cmd> to be executed below. If there wasn't any previous command,
2768 we'll do nothing below (no command will match). If there was, we also save it
2769 in the command history and fall through to allow the command parsing to pick
2770 it up.
2771
2772 =cut
2773
2774             # Empty input means repeat the last command.
2775             if ($cmd eq '') {
2776                 $cmd = $laststep;
2777             }
2778             chomp($cmd);    # get rid of the annoying extra newline
2779             if (length($cmd) >= 2) {
2780                 push( @hist, $cmd );
2781             }
2782             push( @truehist, $cmd );
2783             share(@hist);
2784             share(@truehist);
2785
2786             # This is a restart point for commands that didn't arrive
2787             # via direct user input. It allows us to 'redo PIPE' to
2788             # re-execute command processing without reading a new command.
2789           PIPE: {
2790                 _DB__trim_command_and_return_first_component($obj);
2791
2792 =head3 COMMAND ALIASES
2793
2794 The debugger can create aliases for commands (these are stored in the
2795 C<%alias> hash). Before a command is executed, the command loop looks it up
2796 in the alias hash and substitutes the contents of the alias for the command,
2797 completely replacing it.
2798
2799 =cut
2800
2801                 # See if there's an alias for the command, and set it up if so.
2802                 if ( $alias{$cmd_verb} ) {
2803
2804                     # Squelch signal handling; we want to keep control here
2805                     # if something goes loco during the alias eval.
2806                     local $SIG{__DIE__};
2807                     local $SIG{__WARN__};
2808
2809                     # This is a command, so we eval it in the DEBUGGER's
2810                     # scope! Otherwise, we can't see the special debugger
2811                     # variables, or get to the debugger's subs. (Well, we
2812                     # _could_, but why make it even more complicated?)
2813                     eval "\$cmd =~ $alias{$cmd_verb}";
2814                     if ($@) {
2815                         local $\ = '';
2816                         print $OUT "Couldn't evaluate '$cmd_verb' alias: $@";
2817                         next CMD;
2818                     }
2819                     _DB__trim_command_and_return_first_component($obj);
2820                 } ## end if ($alias{$cmd_verb})
2821
2822 =head3 MAIN-LINE COMMANDS
2823
2824 All of these commands work up to and after the program being debugged has
2825 terminated.
2826
2827 =head4 C<q> - quit
2828
2829 Quit the debugger. This entails setting the C<$fall_off_end> flag, so we don't
2830 try to execute further, cleaning any restart-related stuff out of the
2831 environment, and executing with the last value of C<$?>.
2832
2833 =cut
2834
2835                 # All of these commands were remapped in perl 5.8.0;
2836                 # we send them off to the secondary dispatcher (see below).
2837                 $obj->_handle_special_char_cmd_wrapper_commands;
2838                 _DB__trim_command_and_return_first_component($obj);
2839
2840                 if (my $cmd_rec = $cmd_lookup{$cmd_verb}) {
2841                     my $type = $cmd_rec->{t};
2842                     my $val = $cmd_rec->{v};
2843                     if ($type eq 'm') {
2844                         $obj->$val();
2845                     }
2846                     elsif ($type eq 's') {
2847                         $val->($obj);
2848                     }
2849                 }
2850
2851 =head4 C<t> - trace [n]
2852
2853 Turn tracing on or off. Inverts the appropriate bit in C<$trace> (q.v.).
2854 If level is specified, set C<$trace_to_depth>.
2855
2856 =head4 C<S> - list subroutines matching/not matching a pattern
2857
2858 Walks through C<%sub>, checking to see whether or not to print the name.
2859
2860 =head4 C<X> - list variables in current package
2861
2862 Since the C<V> command actually processes this, just change this to the
2863 appropriate C<V> command and fall through.
2864
2865 =head4 C<V> - list variables
2866
2867 Uses C<dumpvar.pl> to dump out the current values for selected variables.
2868
2869 =head4 C<x> - evaluate and print an expression
2870
2871 Hands the expression off to C<DB::eval>, setting it up to print the value
2872 via C<dumpvar.pl> instead of just printing it directly.
2873
2874 =head4 C<m> - print methods
2875
2876 Just uses C<DB::methods> to determine what methods are available.
2877
2878 =head4 C<f> - switch files
2879
2880 Switch to a different filename.
2881
2882 =head4 C<.> - return to last-executed line.
2883
2884 We set C<$incr> to -1 to indicate that the debugger shouldn't move ahead,
2885 and then we look up the line in the magical C<%dbline> hash.
2886
2887 =head4 C<-> - back one window
2888
2889 We change C<$start> to be one window back; if we go back past the first line,
2890 we set it to be the first line. We ser C<$incr> to put us back at the
2891 currently-executing line, and then put a C<l $start +> (list one window from
2892 C<$start>) in C<$cmd> to be executed later.
2893
2894 =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>>
2895
2896 In Perl 5.8.0, a realignment of the commands was done to fix up a number of
2897 problems, most notably that the default case of several commands destroying
2898 the user's work in setting watchpoints, actions, etc. We wanted, however, to
2899 retain the old commands for those who were used to using them or who preferred
2900 them. At this point, we check for the new commands and call C<cmd_wrapper> to
2901 deal with them instead of processing them in-line.
2902
2903 =head4 C<y> - List lexicals in higher scope
2904
2905 Uses C<PadWalker> to find the lexicals supplied as arguments in a scope
2906 above the current one and then displays then using C<dumpvar.pl>.
2907
2908 =head3 COMMANDS NOT WORKING AFTER PROGRAM ENDS
2909
2910 All of the commands below this point don't work after the program being
2911 debugged has ended. All of them check to see if the program has ended; this
2912 allows the commands to be relocated without worrying about a 'line of
2913 demarcation' above which commands can be entered anytime, and below which
2914 they can't.
2915
2916 =head4 C<n> - single step, but don't trace down into subs
2917
2918 Done by setting C<$single> to 2, which forces subs to execute straight through
2919 when entered (see C<DB::sub>). We also save the C<n> command in C<$laststep>,
2920 so a null command knows what to re-execute.
2921
2922 =head4 C<s> - single-step, entering subs
2923
2924 Sets C<$single> to 1, which causes C<DB::sub> to continue tracing inside
2925 subs. Also saves C<s> as C<$lastcmd>.
2926
2927 =head4 C<c> - run continuously, setting an optional breakpoint
2928
2929 Most of the code for this command is taken up with locating the optional
2930 breakpoint, which is either a subroutine name or a line number. We set
2931 the appropriate one-time-break in C<@dbline> and then turn off single-stepping
2932 in this and all call levels above this one.
2933
2934 =head4 C<r> - return from a subroutine
2935
2936 For C<r> to work properly, the debugger has to stop execution again
2937 immediately after the return is executed. This is done by forcing
2938 single-stepping to be on in the call level above the current one. If
2939 we are printing return values when a C<r> is executed, set C<$doret>
2940 appropriately, and force us out of the command loop.
2941
2942 =head4 C<T> - stack trace
2943
2944 Just calls C<DB::print_trace>.
2945
2946 =head4 C<w> - List window around current line.
2947
2948 Just calls C<DB::cmd_w>.
2949
2950 =head4 C<W> - watch-expression processing.
2951
2952 Just calls C<DB::cmd_W>.
2953
2954 =head4 C</> - search forward for a string in the source
2955
2956 We take the argument and treat it as a pattern. If it turns out to be a
2957 bad one, we return the error we got from trying to C<eval> it and exit.
2958 If not, we create some code to do the search and C<eval> it so it can't
2959 mess us up.
2960
2961 =cut
2962
2963                 _DB__handle_forward_slash_command($obj);
2964
2965 =head4 C<?> - search backward for a string in the source
2966
2967 Same as for C</>, except the loop runs backwards.
2968
2969 =cut
2970
2971                 _DB__handle_question_mark_command($obj);
2972
2973 =head4 C<$rc> - Recall command
2974
2975 Manages the commands in C<@hist> (which is created if C<Term::ReadLine> reports
2976 that the terminal supports history). It finds the command required, puts it
2977 into C<$cmd>, and redoes the loop to execute it.
2978
2979 =cut
2980
2981                 # $rc - recall command.
2982                 $obj->_handle_rc_recall_command;
2983
2984 =head4 C<$sh$sh> - C<system()> command
2985
2986 Calls the C<_db_system()> to handle the command. This keeps the C<STDIN> and
2987 C<STDOUT> from getting messed up.
2988
2989 =cut
2990
2991                 $obj->_handle_sh_command;
2992
2993 =head4 C<$rc I<pattern> $rc> - Search command history
2994
2995 Another command to manipulate C<@hist>: this one searches it with a pattern.
2996 If a command is found, it is placed in C<$cmd> and executed via C<redo>.
2997
2998 =cut
2999
3000                 $obj->_handle_rc_search_history_command;
3001
3002 =head4 C<$sh> - Invoke a shell
3003
3004 Uses C<_db_system()> to invoke a shell.
3005
3006 =cut
3007
3008 =head4 C<$sh I<command>> - Force execution of a command in a shell
3009
3010 Like the above, but the command is passed to the shell. Again, we use
3011 C<_db_system()> to avoid problems with C<STDIN> and C<STDOUT>.
3012
3013 =head4 C<H> - display commands in history
3014
3015 Prints the contents of C<@hist> (if any).
3016
3017 =head4 C<man, doc, perldoc> - look up documentation
3018
3019 Just calls C<runman()> to print the appropriate document.
3020
3021 =cut
3022
3023                 $obj->_handle_doc_command;
3024
3025 =head4 C<p> - print
3026
3027 Builds a C<print EXPR> expression in the C<$cmd>; this will get executed at
3028 the bottom of the loop.
3029
3030 =head4 C<=> - define command alias
3031
3032 Manipulates C<%alias> to add or list command aliases.
3033
3034 =head4 C<source> - read commands from a file.
3035
3036 Opens a lexical filehandle and stacks it on C<@cmdfhs>; C<DB::readline> will
3037 pick it up.
3038
3039 =head4 C<enable> C<disable> - enable or disable breakpoints
3040
3041 This enables or disables breakpoints.
3042
3043 =head4 C<save> - send current history to a file
3044
3045 Takes the complete history, (not the shrunken version you see with C<H>),
3046 and saves it to the given filename, so it can be replayed using C<source>.
3047
3048 Note that all C<^(save|source)>'s are commented out with a view to minimise recursion.
3049
3050 =head4 C<R> - restart
3051
3052 Restart the debugger session.
3053
3054 =head4 C<rerun> - rerun the current session
3055
3056 Return to any given position in the B<true>-history list
3057
3058 =head4 C<|, ||> - pipe output through the pager.
3059
3060 For C<|>, we save C<OUT> (the debugger's output filehandle) and C<STDOUT>
3061 (the program's standard output). For C<||>, we only save C<OUT>. We open a
3062 pipe to the pager (restoring the output filehandles if this fails). If this
3063 is the C<|> command, we also set up a C<SIGPIPE> handler which will simply
3064 set C<$signal>, sending us back into the debugger.
3065
3066 We then trim off the pipe symbols and C<redo> the command loop at the
3067 C<PIPE> label, causing us to evaluate the command in C<$cmd> without
3068 reading another.
3069
3070 =cut
3071
3072                 # || - run command in the pager, with output to DB::OUT.
3073                 _DB__handle_run_command_in_pager_command($obj);
3074
3075 =head3 END OF COMMAND PARSING
3076
3077 Anything left in C<$cmd> at this point is a Perl expression that we want to
3078 evaluate. We'll always evaluate in the user's context, and fully qualify
3079 any variables we might want to address in the C<DB> package.
3080
3081 =cut
3082
3083             }    # PIPE:
3084
3085             # trace an expression
3086             $cmd =~ s/^t\s/\$DB::trace |= 1;\n/;
3087
3088             # Make sure the flag that says "the debugger's running" is
3089             # still on, to make sure we get control again.
3090             $evalarg = "\$^D = \$^D | \$DB::db_stop;\n$cmd";
3091
3092             # Run *our* eval that executes in the caller's context.
3093             # The &-call is here to ascertain the mutability of @_.
3094             &DB::eval;
3095
3096             # Turn off the one-time-dump stuff now.
3097             if ($onetimeDump) {
3098                 $onetimeDump      = undef;
3099                 $onetimedumpDepth = undef;
3100             }
3101             elsif ( $term_pid == $$ ) {
3102                 eval { # May run under miniperl, when not available...
3103                     STDOUT->flush();
3104                     STDERR->flush();
3105                 };
3106
3107                 # XXX If this is the master pid, print a newline.
3108                 print {$OUT} "\n";
3109             }
3110         } ## end while (($term || &setterm...
3111
3112 =head3 POST-COMMAND PROCESSING
3113
3114 After each command, we check to see if the command output was piped anywhere.
3115 If so, we go through the necessary code to unhook the pipe and go back to
3116 our standard filehandles for input and output.
3117
3118 =cut
3119
3120         continue {    # CMD:
3121             _DB__at_end_of_every_command($obj);
3122         }    # CMD:
3123
3124 =head3 COMMAND LOOP TERMINATION
3125
3126 When commands have finished executing, we come here. If the user closed the
3127 input filehandle, we turn on C<$fall_off_end> to emulate a C<q> command. We
3128 evaluate any post-prompt items. We restore C<$@>, C<$!>, C<$^E>, C<$,>, C<$/>,
3129 C<$\>, and C<$^W>, and return a null list as expected by the Perl interpreter.
3130 The interpreter will then execute the next line and then return control to us
3131 again.
3132
3133 =cut
3134
3135         # No more commands? Quit.
3136         $fall_off_end = 1 unless defined $cmd;    # Emulate 'q' on EOF
3137
3138         # Evaluate post-prompt commands.
3139         foreach $evalarg (@$post) {
3140             # The &-call is here to ascertain the mutability of @_.
3141             &DB::eval;
3142         }
3143     }    # if ($single || $signal)
3144
3145     # Put the user's globals back where you found them.
3146     ( $@, $!, $^E, $,, $/, $\, $^W ) = @saved;
3147     ();
3148 } ## end sub DB
3149
3150 # Because DB::Obj is used above,
3151 #
3152 #   my $obj = DB::Obj->new(
3153 #
3154 # The following package declaration must come before that,
3155 # or else runtime errors will occur with
3156 #
3157 #   PERLDB_OPTS="autotrace nonstop"
3158 #
3159 # ( rt#116771 )
3160 BEGIN {
3161
3162 package DB::Obj;
3163
3164 sub new {
3165     my $class = shift;
3166
3167     my $self = bless {}, $class;
3168
3169     $self->_init(@_);
3170
3171     return $self;
3172 }
3173
3174 sub _init {
3175     my ($self, $args) = @_;
3176
3177     %{$self} = (%$self, %$args);
3178
3179     return;
3180 }
3181
3182 {
3183     no strict 'refs';
3184     foreach my $slot_name (qw(
3185         after explicit_stop infix pat piped position prefix selected cmd_verb
3186         cmd_args
3187         )) {
3188         my $slot = $slot_name;
3189         *{$slot} = sub {
3190             my $self = shift;
3191
3192             if (@_) {
3193                 ${ $self->{$slot} } = shift;
3194             }
3195
3196             return ${ $self->{$slot} };
3197         };
3198
3199         *{"append_to_$slot"} = sub {
3200             my $self = shift;
3201             my $s = shift;
3202
3203             return $self->$slot($self->$slot . $s);
3204         };
3205     }
3206 }
3207
3208 sub _DB_on_init__initialize_globals
3209 {
3210     my $self = shift;
3211
3212     # Check for whether we should be running continuously or not.
3213     # _After_ the perl program is compiled, $single is set to 1:
3214     if ( $single and not $second_time++ ) {
3215
3216         # Options say run non-stop. Run until we get an interrupt.
3217         if ($runnonstop) {    # Disable until signal
3218                 # If there's any call stack in place, turn off single
3219                 # stepping into subs throughout the stack.
3220             for my $i (0 .. $stack_depth) {
3221                 $stack[ $i ] &= ~1;
3222             }
3223
3224             # And we are now no longer in single-step mode.
3225             $single = 0;
3226
3227             # If we simply returned at this point, we wouldn't get
3228             # the trace info. Fall on through.
3229             # return;
3230         } ## end if ($runnonstop)
3231
3232         elsif ($ImmediateStop) {
3233
3234             # We are supposed to stop here; XXX probably a break.
3235             $ImmediateStop = 0;    # We've processed it; turn it off
3236             $signal        = 1;    # Simulate an interrupt to force
3237                                    # us into the command loop
3238         }
3239     } ## end if ($single and not $second_time...
3240
3241     # If we're in single-step mode, or an interrupt (real or fake)
3242     # has occurred, turn off non-stop mode.
3243     $runnonstop = 0 if $single or $signal;
3244
3245     return;
3246 }
3247
3248 sub _my_print_lineinfo
3249 {
3250     my ($self, $i, $incr_pos) = @_;
3251
3252     if ($frame) {
3253         # Print it indented if tracing is on.
3254         DB::print_lineinfo( ' ' x $stack_depth,
3255             "$i:\t$DB::dbline[$i]" . $self->after );
3256     }
3257     else {
3258         DB::depth_print_lineinfo($self->explicit_stop, $incr_pos);
3259     }
3260 }
3261
3262 sub _curr_line {
3263     return $DB::dbline[$line];
3264 }
3265
3266 sub _is_full {
3267     my ($self, $letter) = @_;
3268
3269     return ($DB::cmd eq $letter);
3270 }
3271
3272 sub _DB__grab_control
3273 {
3274     my $self = shift;
3275
3276     # Yes, grab control.
3277     if ($slave_editor) {
3278
3279         # Tell the editor to update its position.
3280         $self->position("\032\032${DB::filename}:$line:0\n");
3281         DB::print_lineinfo($self->position());
3282     }
3283
3284 =pod
3285
3286 Special check: if we're in package C<DB::fake>, we've gone through the
3287 C<END> block at least once. We set up everything so that we can continue
3288 to enter commands and have a valid context to be in.
3289
3290 =cut
3291
3292     elsif ( $DB::package eq 'DB::fake' ) {
3293
3294         # Fallen off the end already.
3295         if (!$DB::term) {
3296             DB::setterm();
3297         }
3298
3299         DB::print_help(<<EOP);
3300 Debugged program terminated.  Use B<q> to quit or B<R> to restart,
3301 use B<o> I<inhibit_exit> to avoid stopping after program termination,
3302 B<h q>, B<h R> or B<h o> to get additional info.
3303 EOP
3304
3305         # Set the DB::eval context appropriately.
3306         $DB::package     = 'main';
3307         $DB::usercontext = DB::_calc_usercontext($DB::package);
3308     } ## end elsif ($package eq 'DB::fake')
3309
3310 =pod
3311
3312 If the program hasn't finished executing, we scan forward to the
3313 next executable line, print that out, build the prompt from the file and line
3314 number information, and print that.
3315
3316 =cut
3317
3318     else {
3319
3320
3321         # Still somewhere in the midst of execution. Set up the
3322         #  debugger prompt.
3323         $DB::sub =~ s/\'/::/;    # Swap Perl 4 package separators (') to
3324                              # Perl 5 ones (sorry, we don't print Klingon
3325                              #module names)
3326
3327         $self->prefix($DB::sub =~ /::/ ? "" : ($DB::package . '::'));
3328         $self->append_to_prefix( "$DB::sub(${DB::filename}:" );
3329         $self->after( $self->_curr_line =~ /\n$/ ? '' : "\n" );
3330
3331         # Break up the prompt if it's really long.
3332         if ( length($self->prefix()) > 30 ) {
3333             $self->position($self->prefix . "$line):\n$line:\t" . $self->_curr_line . $self->after);
3334             $self->prefix("");
3335             $self->infix(":\t");
3336         }
3337         else {
3338             $self->infix("):\t");
3339             $self->position(
3340                 $self->prefix . $line. $self->infix
3341                 . $self->_curr_line . $self->after
3342             );
3343         }
3344
3345         # Print current line info, indenting if necessary.
3346         $self->_my_print_lineinfo($line, $self->position);
3347
3348         my $i;
3349         my $line_i = sub { return $DB::dbline[$i]; };
3350
3351         # Scan forward, stopping at either the end or the next
3352         # unbreakable line.
3353         for ( $i = $line + 1 ; $i <= $DB::max && $line_i->() == 0 ; ++$i )
3354         {    #{ vi
3355
3356             # Drop out on null statements, block closers, and comments.
3357             last if $line_i->() =~ /^\s*[\;\}\#\n]/;
3358
3359             # Drop out if the user interrupted us.
3360             last if $signal;
3361
3362             # Append a newline if the line doesn't have one. Can happen
3363             # in eval'ed text, for instance.
3364             $self->after( $line_i->() =~ /\n$/ ? '' : "\n" );
3365
3366             # Next executable line.
3367             my $incr_pos = $self->prefix . $i . $self->infix . $line_i->()
3368                 . $self->after;
3369             $self->append_to_position($incr_pos);
3370             $self->_my_print_lineinfo($i, $incr_pos);
3371         } ## end for ($i = $line + 1 ; $i...
3372     } ## end else [ if ($slave_editor)
3373
3374     return;
3375 }
3376
3377 sub _handle_t_command {
3378     my $self = shift;
3379
3380     my $levels = $self->cmd_args();
3381
3382     if ((!length($levels)) or ($levels !~ /\D/)) {
3383         $trace ^= 1;
3384         local $\ = '';
3385         $DB::trace_to_depth = $levels ? $stack_depth + $levels : 1E9;
3386         print {$OUT} "Trace = "
3387         . ( ( $trace & 1 )
3388             ? ( $levels ? "on (to level $DB::trace_to_depth)" : "on" )
3389             : "off" ) . "\n";
3390         next CMD;
3391     }
3392
3393     return;
3394 }
3395
3396
3397 sub _handle_S_command {
3398     my $self = shift;
3399
3400     if (my ($print_all_subs, $should_reverse, $Spatt)
3401         = $self->cmd_args =~ /\A((!)?(.+))?\z/) {
3402         # $Spatt is the pattern (if any) to use.
3403         # Reverse scan?
3404         my $Srev     = defined $should_reverse;
3405         # No args - print all subs.
3406         my $Snocheck = !defined $print_all_subs;
3407
3408         # Need to make these sane here.
3409         local $\ = '';
3410         local $, = '';
3411
3412         # Search through the debugger's magical hash of subs.
3413         # If $nocheck is true, just print the sub name.
3414         # Otherwise, check it against the pattern. We then use
3415         # the XOR trick to reverse the condition as required.
3416         foreach $subname ( sort( keys %sub ) ) {
3417             if ( $Snocheck or $Srev ^ ( $subname =~ /$Spatt/ ) ) {
3418                 print $OUT $subname, "\n";
3419             }
3420         }
3421         next CMD;
3422     }
3423
3424     return;
3425 }
3426
3427 sub _handle_V_command_and_X_command {
3428     my $self = shift;
3429
3430     $DB::cmd =~ s/^X\b/V $DB::package/;
3431
3432     # Bare V commands get the currently-being-debugged package
3433     # added.
3434     if ($self->_is_full('V')) {
3435         $DB::cmd = "V $DB::package";
3436     }
3437
3438     # V - show variables in package.
3439     if (my ($new_packname, $new_vars_str) =
3440         $DB::cmd =~ /\AV\b\s*(\S+)\s*(.*)/) {
3441
3442         # Save the currently selected filehandle and
3443         # force output to debugger's filehandle (dumpvar
3444         # just does "print" for output).
3445         my $savout = select($OUT);
3446
3447         # Grab package name and variables to dump.
3448         $packname = $new_packname;
3449         my @vars     = split( ' ', $new_vars_str );
3450
3451         # If main::dumpvar isn't here, get it.
3452         do 'dumpvar.pl' || die $@ unless defined &main::dumpvar;
3453         if ( defined &main::dumpvar ) {
3454
3455             # We got it. Turn off subroutine entry/exit messages
3456             # for the moment, along with return values.
3457             local $frame = 0;
3458             local $doret = -2;
3459
3460             # must detect sigpipe failures  - not catching
3461             # then will cause the debugger to die.
3462             eval {
3463                 main::dumpvar(
3464                     $packname,
3465                     defined $option{dumpDepth}
3466                     ? $option{dumpDepth}
3467                     : -1,    # assume -1 unless specified
3468                     @vars
3469                 );
3470             };
3471
3472             # The die doesn't need to include the $@, because
3473             # it will automatically get propagated for us.
3474             if ($@) {
3475                 die unless $@ =~ /dumpvar print failed/;
3476             }
3477         } ## end if (defined &main::dumpvar)
3478         else {
3479
3480             # Couldn't load dumpvar.
3481             print $OUT "dumpvar.pl not available.\n";
3482         }
3483
3484         # Restore the output filehandle, and go round again.
3485         select($savout);
3486         next CMD;
3487     }
3488
3489     return;
3490 }
3491
3492 sub _handle_dash_command {
3493     my $self = shift;
3494
3495     if ($self->_is_full('-')) {
3496
3497         # back up by a window; go to 1 if back too far.
3498         $start -= $incr + $window + 1;
3499         $start = 1 if $start <= 0;
3500         $incr  = $window - 1;
3501
3502         # Generate and execute a "l +" command (handled below).
3503         $DB::cmd = 'l ' . ($start) . '+';
3504         redo CMD;
3505     }
3506     return;
3507 }
3508
3509 sub _n_or_s_commands_generic {
3510     my ($self, $new_val) = @_;
3511     # n - next
3512     next CMD if DB::_DB__is_finished();
3513
3514     # Single step, but don't enter subs.
3515     $single = $new_val;
3516
3517     # Save for empty command (repeat last).
3518     $laststep = $DB::cmd;
3519     last CMD;
3520 }
3521
3522 sub _n_or_s {
3523     my ($self, $letter, $new_val) = @_;
3524
3525     if ($self->_is_full($letter)) {
3526         $self->_n_or_s_commands_generic($new_val);
3527     }
3528     else {
3529         $self->_n_or_s_and_arg_commands_generic($letter, $new_val);
3530     }
3531
3532     return;
3533 }
3534
3535 sub _handle_n_command {
3536     my $self = shift;
3537
3538     return $self->_n_or_s('n', 2);
3539 }
3540
3541 sub _handle_s_command {
3542     my $self = shift;
3543
3544     return $self->_n_or_s('s', 1);
3545 }
3546
3547 sub _handle_r_command {
3548     my $self = shift;
3549
3550     # r - return from the current subroutine.
3551     if ($self->_is_full('r')) {
3552
3553         # Can't do anything if the program's over.
3554         next CMD if DB::_DB__is_finished();
3555
3556         # Turn on stack trace.
3557         $stack[$stack_depth] |= 1;
3558
3559         # Print return value unless the stack is empty.
3560         $doret = $option{PrintRet} ? $stack_depth - 1 : -2;
3561         last CMD;
3562     }
3563
3564     return;
3565 }
3566
3567 sub _handle_T_command {
3568     my $self = shift;
3569
3570     if ($self->_is_full('T')) {
3571         DB::print_trace( $OUT, 1 );    # skip DB
3572         next CMD;
3573     }
3574
3575     return;
3576 }
3577
3578 sub _handle_w_command {
3579     my $self = shift;
3580
3581     DB::cmd_w( 'w', $self->cmd_args() );
3582     next CMD;
3583
3584     return;
3585 }
3586
3587 sub _handle_W_command {
3588     my $self = shift;
3589
3590     if (my $arg = $self->cmd_args) {
3591         DB::cmd_W( 'W', $arg );
3592         next CMD;
3593     }
3594
3595     return;
3596 }
3597
3598 sub _handle_rc_recall_command {
3599     my $self = shift;
3600
3601     # $rc - recall command.
3602     if (my ($minus, $arg) = $DB::cmd =~ m#\A$rc+\s*(-)?(\d+)?\z#) {
3603
3604         # No arguments, take one thing off history.
3605         pop(@hist) if length($DB::cmd) > 1;
3606
3607         # Relative (- found)?
3608         #  Y - index back from most recent (by 1 if bare minus)
3609         #  N - go to that particular command slot or the last
3610         #      thing if nothing following.
3611
3612         $self->cmd_verb(
3613             scalar($minus ? ( $#hist - ( $arg || 1 ) ) : ( $arg || $#hist ))
3614         );
3615
3616         # Pick out the command desired.
3617         $DB::cmd = $hist[$self->cmd_verb];
3618
3619         # Print the command to be executed and restart the loop
3620         # with that command in the buffer.
3621         print {$OUT} $DB::cmd, "\n";
3622         redo CMD;
3623     }
3624
3625     return;
3626 }
3627
3628 sub _handle_rc_search_history_command {
3629     my $self = shift;
3630
3631     # $rc pattern $rc - find a command in the history.
3632     if (my ($arg) = $DB::cmd =~ /\A$rc([^$rc].*)\z/) {
3633
3634         # Create the pattern to use.
3635         my $pat = "^$arg";
3636         $self->pat($pat);
3637
3638         # Toss off last entry if length is >1 (and it always is).
3639         pop(@hist) if length($DB::cmd) > 1;
3640
3641         my $i;
3642
3643         # Look backward through the history.
3644         SEARCH_HIST:
3645         for ( $i = $#hist ; $i ; --$i ) {
3646             # Stop if we find it.
3647             last SEARCH_HIST if $hist[$i] =~ /$pat/;
3648         }
3649
3650         if ( !$i ) {
3651
3652             # Never found it.
3653             print $OUT "No such command!\n\n";
3654             next CMD;
3655         }
3656
3657         # Found it. Put it in the buffer, print it, and process it.
3658         $DB::cmd = $hist[$i];
3659         print $OUT $DB::cmd, "\n";
3660         redo CMD;
3661     }
3662
3663     return;
3664 }
3665
3666 sub _handle_H_command {
3667     my $self = shift;
3668
3669     if ($self->cmd_args =~ m#\A\*#) {
3670         @hist = @truehist = ();
3671         print $OUT "History cleansed\n";
3672         next CMD;
3673     }
3674
3675     if (my ($num) = $self->cmd_args =~ /\A(?:-(\d+))?/) {
3676
3677         # Anything other than negative numbers is ignored by
3678         # the (incorrect) pattern, so this test does nothing.
3679         $end = $num ? ( $#hist - $num ) : 0;
3680
3681         # Set to the minimum if less than zero.
3682         $hist = 0 if $hist < 0;
3683
3684         # Start at the end of the array.
3685         # Stay in while we're still above the ending value.
3686         # Tick back by one each time around the loop.
3687         my $i;
3688
3689         for ( $i = $#hist ; $i > $end ; $i-- ) {
3690
3691             # Print the command  unless it has no arguments.
3692             print $OUT "$i: ", $hist[$i], "\n"
3693             unless $hist[$i] =~ /^.?$/;
3694         }
3695
3696         next CMD;
3697     }
3698
3699     return;
3700 }
3701
3702 sub _handle_doc_command {
3703     my $self = shift;
3704
3705     # man, perldoc, doc - show manual pages.
3706     if (my ($man_page)
3707         = $DB::cmd =~ /\A(?:man|(?:perl)?doc)\b(?:\s+([^(]*))?\z/) {
3708         DB::runman($man_page);
3709         next CMD;
3710     }
3711
3712     return;
3713 }
3714
3715 sub _handle_p_command {
3716     my $self = shift;
3717
3718     my $print_cmd = 'print {$DB::OUT} ';
3719     # p - print (no args): print $_.
3720     if ($self->_is_full('p')) {
3721         $DB::cmd = $print_cmd . '$_';
3722     }
3723     else {
3724         # p - print the given expression.
3725         $DB::cmd =~ s/\Ap\b/$print_cmd /;
3726     }
3727
3728     return;
3729 }
3730
3731 sub _handle_equal_sign_command {
3732     my $self = shift;
3733
3734     if ($DB::cmd =~ s/\A=\s*//) {
3735         my @keys;
3736         if ( length $DB::cmd == 0 ) {
3737
3738             # No args, get current aliases.
3739             @keys = sort keys %alias;
3740         }
3741         elsif ( my ( $k, $v ) = ( $DB::cmd =~ /^(\S+)\s+(\S.*)/ ) ) {
3742
3743             # Creating a new alias. $k is alias name, $v is
3744             # alias value.
3745
3746             # can't use $_ or kill //g state
3747             for my $x ( $k, $v ) {
3748
3749                 # Escape "alarm" characters.
3750                 $x =~ s/\a/\\a/g;
3751             }
3752
3753             # Substitute key for value, using alarm chars
3754             # as separators (which is why we escaped them in
3755             # the command).
3756             $alias{$k} = "s\a$k\a$v\a";
3757
3758             # Turn off standard warn and die behavior.
3759             local $SIG{__DIE__};
3760             local $SIG{__WARN__};
3761
3762             # Is it valid Perl?
3763             unless ( eval "sub { s\a$k\a$v\a }; 1" ) {
3764
3765                 # Nope. Bad alias. Say so and get out.
3766                 print $OUT "Can't alias $k to $v: $@\n";
3767                 delete $alias{$k};
3768                 next CMD;
3769             }
3770
3771             # We'll only list the new one.
3772             @keys = ($k);
3773         } ## end elsif (my ($k, $v) = ($DB::cmd...
3774
3775         # The argument is the alias to list.
3776         else {
3777             @keys = ($DB::cmd);
3778         }
3779
3780         # List aliases.
3781         for my $k (@keys) {
3782
3783             # Messy metaquoting: Trim the substitution code off.
3784             # We use control-G as the delimiter because it's not
3785             # likely to appear in the alias.
3786             if ( ( my $v = $alias{$k} ) =~ s\as\a$k\a(.*)\a$\a1\a ) {
3787
3788                 # Print the alias.
3789                 print $OUT "$k\t= $1\n";
3790             }
3791             elsif ( defined $alias{$k} ) {
3792
3793                 # Couldn't trim it off; just print the alias code.
3794                 print $OUT "$k\t$alias{$k}\n";
3795             }
3796             else {
3797
3798                 # No such, dude.
3799                 print "No alias for $k\n";
3800             }
3801         } ## end for my $k (@keys)
3802         next CMD;
3803     }
3804
3805     return;
3806 }
3807
3808 sub _handle_source_command {
3809     my $self = shift;
3810
3811     # source - read commands from a file (or pipe!) and execute.
3812     if (my $sourced_fn = $self->cmd_args) {
3813         if ( open my $fh, $sourced_fn ) {
3814
3815             # Opened OK; stick it in the list of file handles.
3816             push @cmdfhs, $fh;
3817         }
3818         else {
3819
3820             # Couldn't open it.
3821             DB::_db_warn("Can't execute '$sourced_fn': $!\n");
3822         }
3823         next CMD;
3824     }
3825
3826     return;
3827 }
3828
3829 sub _handle_enable_disable_commands {
3830     my $self = shift;
3831
3832     my $which_cmd = $self->cmd_verb;
3833     my $position = $self->cmd_args;
3834
3835     if ($position !~ /\s/) {
3836         my ($fn, $line_num);
3837         if ($position =~ m{\A\d+\z})
3838         {
3839             $fn = $DB::filename;
3840             $line_num = $position;
3841         }
3842         elsif (my ($new_fn, $new_line_num)
3843             = $position =~ m{\A(.*):(\d+)\z}) {
3844             ($fn, $line_num) = ($new_fn, $new_line_num);
3845         }
3846         else
3847         {
3848             DB::_db_warn("Wrong spec for enable/disable argument.\n");
3849         }
3850
3851         if (defined($fn)) {
3852             if (DB::_has_breakpoint_data_ref($fn, $line_num)) {
3853                 DB::_set_breakpoint_enabled_status($fn, $line_num,
3854                     ($which_cmd eq 'enable' ? 1 : '')
3855                 );
3856             }
3857             else {
3858                 DB::_db_warn("No breakpoint set at ${fn}:${line_num}\n");
3859             }
3860         }
3861
3862         next CMD;
3863     }
3864
3865     return;
3866 }
3867
3868 sub _handle_save_command {
3869     my $self = shift;
3870
3871     if (my $new_fn = $self->cmd_args) {
3872         my $filename = $new_fn || '.perl5dbrc';    # default?
3873         if ( open my $fh, '>', $filename ) {
3874
3875             # chomp to remove extraneous newlines from source'd files
3876             chomp( my @truelist =
3877                 map { m/\A\s*(save|source)/ ? "#$_" : $_ }
3878                 @truehist );
3879             print {$fh} join( "\n", @truelist );
3880             print "commands saved in $filename\n";
3881         }
3882         else {
3883             DB::_db_warn("Can't save debugger commands in '$new_fn': $!\n");
3884         }
3885         next CMD;
3886     }
3887
3888     return;
3889 }
3890
3891 sub _n_or_s_and_arg_commands_generic {
3892     my ($self, $letter, $new_val) = @_;
3893
3894     # s - single-step. Remember the last command was 's'.
3895     if ($DB::cmd =~ s#\A\Q$letter\E\s#\$DB::single = $new_val;\n#) {
3896         $laststep = $letter;
3897     }
3898
3899     return;
3900 }
3901
3902 sub _handle_sh_command {
3903     my $self = shift;
3904
3905     # $sh$sh - run a shell command (if it's all ASCII).
3906     # Can't run shell commands with Unicode in the debugger, hmm.
3907     my $my_cmd = $DB::cmd;
3908     if ($my_cmd =~ m#\A$sh#gms) {
3909
3910         if ($my_cmd =~ m#\G\z#cgms) {
3911             # Run the user's shell. If none defined, run Bourne.
3912             # We resume execution when the shell terminates.
3913             DB::_db_system( $ENV{SHELL} || "/bin/sh" );
3914             next CMD;
3915         }
3916         elsif ($my_cmd =~ m#\G$sh\s*(.*)#cgms) {
3917             # System it.
3918             DB::_db_system($1);
3919             next CMD;
3920         }
3921         elsif ($my_cmd =~ m#\G\s*(.*)#cgms) {
3922             DB::_db_system( $ENV{SHELL} || "/bin/sh", "-c", $1 );
3923             next CMD;
3924         }
3925     }
3926 }
3927
3928 sub _handle_x_command {
3929     my $self = shift;
3930
3931     if ($DB::cmd =~ s#\Ax\b# #) {    # Remainder gets done by DB::eval()
3932         $onetimeDump = 'dump';    # main::dumpvar shows the output
3933
3934         # handle special  "x 3 blah" syntax XXX propagate
3935         # doc back to special variables.
3936         if ( $DB::cmd =~ s#\A\s*(\d+)(?=\s)# #) {
3937             $onetimedumpDepth = $1;
3938         }
3939     }
3940
3941     return;
3942 }
3943
3944 sub _handle_q_command {
3945     my $self = shift;
3946
3947     if ($self->_is_full('q')) {
3948         $fall_off_end = 1;
3949         DB::clean_ENV();
3950         exit $?;
3951     }
3952
3953     return;
3954 }
3955
3956 sub _handle_cmd_wrapper_commands {
3957     my $self = shift;
3958
3959     DB::cmd_wrapper( $self->cmd_verb, $self->cmd_args, $line );
3960     next CMD;
3961 }
3962
3963 sub _handle_special_char_cmd_wrapper_commands {
3964     my $self = shift;
3965
3966     # All of these commands were remapped in perl 5.8.0;
3967     # we send them off to the secondary dispatcher (see below).
3968     if (my ($cmd_letter, $my_arg) = $DB::cmd =~ /\A([<>\{]{1,2})\s*(.*)/so) {
3969         DB::cmd_wrapper( $cmd_letter, $my_arg, $line );
3970         next CMD;
3971     }
3972
3973     return;
3974 }
3975
3976 } ## end DB::Obj
3977
3978 package DB;
3979
3980 # The following code may be executed now:
3981 # BEGIN {warn 4}
3982
3983 =head2 sub
3984
3985 C<sub> is called whenever a subroutine call happens in the program being
3986 debugged. The variable C<$DB::sub> contains the name of the subroutine
3987 being called.
3988
3989 The core function of this subroutine is to actually call the sub in the proper
3990 context, capturing its output. This of course causes C<DB::DB> to get called
3991 again, repeating until the subroutine ends and returns control to C<DB::sub>
3992 again. Once control returns, C<DB::sub> figures out whether or not to dump the
3993 return value, and returns its captured copy of the return value as its own
3994 return value. The value then feeds back into the program being debugged as if
3995 C<DB::sub> hadn't been there at all.
3996
3997 C<sub> does all the work of printing the subroutine entry and exit messages
3998 enabled by setting C<$frame>. It notes what sub the autoloader got called for,
3999 and also prints the return value if needed (for the C<r> command and if
4000 the 16 bit is set in C<$frame>).
4001
4002 It also tracks the subroutine call depth by saving the current setting of
4003 C<$single> in the C<@stack> package global; if this exceeds the value in
4004 C<$deep>, C<sub> automatically turns on printing of the current depth by
4005 setting the C<4> bit in C<$single>. In any case, it keeps the current setting
4006 of stop/don't stop on entry to subs set as it currently is set.
4007
4008 =head3 C<caller()> support
4009
4010 If C<caller()> is called from the package C<DB>, it provides some
4011 additional data, in the following order:
4012
4013 =over 4
4014
4015 =item * C<$package>
4016
4017 The package name the sub was in
4018
4019 =item * C<$filename>
4020
4021 The filename it was defined in
4022
4023 =item * C<$line>
4024
4025 The line number it was defined on
4026
4027 =item * C<$subroutine>
4028
4029 The subroutine name; C<(eval)> if an C<eval>().
4030
4031 =item * C<$hasargs>
4032
4033 1 if it has arguments, 0 if not
4034
4035 =item * C<$wantarray>
4036
4037 1 if array context, 0 if scalar context
4038
4039 =item * C<$evaltext>
4040
4041 The C<eval>() text, if any (undefined for C<eval BLOCK>)
4042
4043 =item * C<$is_require>
4044
4045 frame was created by a C<use> or C<require> statement
4046
4047 =item * C<$hints>
4048
4049 pragma information; subject to change between versions
4050
4051 =item * C<$bitmask>
4052
4053 pragma information; subject to change between versions
4054
4055 =item * C<@DB::args>
4056
4057 arguments with which the subroutine was invoked
4058
4059 =back
4060
4061 =cut
4062
4063 use vars qw($deep);
4064
4065 # We need to fully qualify the name ("DB::sub") to make "use strict;"
4066 # happy. -- Shlomi Fish
4067
4068 sub _indent_print_line_info {
4069     my ($offset, $str) = @_;
4070
4071     print_lineinfo( ' ' x ($stack_depth - $offset), $str);
4072
4073     return;
4074 }
4075
4076 sub _print_frame_message {
4077     my ($al) = @_;
4078
4079     if ($frame) {
4080         if ($frame & 4) {   # Extended frame entry message
4081             _indent_print_line_info(-1, "in  ");
4082
4083             # Why -1? But it works! :-(
4084             # Because print_trace will call add 1 to it and then call
4085             # dump_trace; this results in our skipping -1+1 = 0 stack frames
4086             # in dump_trace.
4087             #
4088             # Now it's 0 because we extracted a function.
4089             print_trace( $LINEINFO, 0, 1, 1, "$sub$al" );
4090         }
4091         else {
4092             _indent_print_line_info(-1, "entering $sub$al\n" );
4093         }
4094     }
4095
4096     return;
4097 }
4098
4099 sub DB::sub {
4100     # lock ourselves under threads
4101     lock($DBGR);
4102
4103     # Whether or not the autoloader was running, a scalar to put the
4104     # sub's return value in (if needed), and an array to put the sub's
4105     # return value in (if needed).
4106     my ( $al, $ret, @ret ) = "";
4107     if ($sub eq 'threads::new' && $ENV{PERL5DB_THREADED}) {
4108         print "creating new thread\n";
4109     }
4110
4111     # If the last ten characters are '::AUTOLOAD', note we've traced
4112     # into AUTOLOAD for $sub.
4113     if ( length($sub) > 10 && substr( $sub, -10, 10 ) eq '::AUTOLOAD' ) {
4114         no strict 'refs';
4115         $al = " for $$sub" if defined $$sub;
4116     }
4117
4118     # We stack the stack pointer and then increment it to protect us
4119     # from a situation that might unwind a whole bunch of call frames
4120     # at once. Localizing the stack pointer means that it will automatically
4121     # unwind the same amount when multiple stack frames are unwound.
4122     local $stack_depth = $stack_depth + 1;    # Protect from non-local exits
4123
4124     # Expand @stack.
4125     $#stack = $stack_depth;
4126
4127     # Save current single-step setting.
4128     $stack[-1] = $single;
4129
4130     # Turn off all flags except single-stepping.
4131     $single &= 1;
4132
4133     # If we've gotten really deeply recursed, turn on the flag that will
4134     # make us stop with the 'deep recursion' message.
4135     $single |= 4 if $stack_depth == $deep;
4136
4137     # If frame messages are on ...
4138
4139     _print_frame_message($al);
4140     # standard frame entry message
4141
4142     my $print_exit_msg = sub {
4143         # Check for exit trace messages...
4144         if ($frame & 2)
4145         {
4146             if ($frame & 4)    # Extended exit message
4147             {
4148                 _indent_print_line_info(0, "out ");
4149                 print_trace( $LINEINFO, 0, 1, 1, "$sub$al" );
4150             }
4151             else
4152             {
4153                 _indent_print_line_info(0, "exited $sub$al\n" );
4154             }
4155         }
4156         return;
4157     };
4158
4159     # Determine the sub's return type, and capture appropriately.
4160     if (wantarray) {
4161
4162         # Called in array context. call sub and capture output.
4163         # DB::DB will recursively get control again if appropriate; we'll come
4164         # back here when the sub is finished.
4165         {
4166             no strict 'refs';
4167             @ret = &$sub;
4168         }
4169
4170         # Pop the single-step value back off the stack.
4171         $single |= $stack[ $stack_depth-- ];
4172
4173         $print_exit_msg->();
4174
4175         # Print the return info if we need to.
4176         if ( $doret eq $stack_depth or $frame & 16 ) {
4177
4178             # Turn off output record separator.
4179             local $\ = '';
4180             my $fh = ( $doret eq $stack_depth ? $OUT : $LINEINFO );
4181
4182             # Indent if we're printing because of $frame tracing.
4183             if ($frame & 16)
4184             {
4185                 print {$fh} ' ' x $stack_depth;
4186             }
4187
4188             # Print the return value.
4189             print {$fh} "list context return from $sub:\n";
4190             dumpit( $fh, \@ret );
4191
4192             # And don't print it again.
4193             $doret = -2;
4194         } ## end if ($doret eq $stack_depth...
4195             # And we have to return the return value now.
4196         @ret;
4197     } ## end if (wantarray)
4198
4199     # Scalar context.
4200     else {
4201         if ( defined wantarray ) {
4202             no strict 'refs';
4203             # Save the value if it's wanted at all.
4204             $ret = &$sub;
4205         }
4206         else {
4207             no strict 'refs';
4208             # Void return, explicitly.
4209             &$sub;
4210             undef $ret;
4211         }
4212
4213         # Pop the single-step value off the stack.
4214         $single |= $stack[ $stack_depth-- ];
4215
4216         # If we're doing exit messages...
4217         $print_exit_msg->();
4218
4219         # If we are supposed to show the return value... same as before.
4220         if ( $doret eq $stack_depth or $frame & 16 and defined wantarray ) {
4221             local $\ = '';
4222             my $fh = ( $doret eq $stack_depth ? $OUT : $LINEINFO );
4223             print $fh ( ' ' x $stack_depth ) if $frame & 16;
4224             print $fh (
4225                 defined wantarray
4226                 ? "scalar context return from $sub: "
4227                 : "void context return from $sub\n"
4228             );
4229             dumpit( $fh, $ret ) if defined wantarray;
4230             $doret = -2;
4231         } ## end if ($doret eq $stack_depth...
4232
4233         # Return the appropriate scalar value.
4234         $ret;
4235     } ## end else [ if (wantarray)
4236 } ## end sub _sub
4237
4238 sub lsub : lvalue {
4239
4240     no strict 'refs';
4241
4242     # lock ourselves under threads
4243     lock($DBGR);
4244
4245     # Whether or not the autoloader was running, a scalar to put the
4246     # sub's return value in (if needed), and an array to put the sub's
4247     # return value in (if needed).
4248     my ( $al, $ret, @ret ) = "";
4249     if ($sub =~ /^threads::new$/ && $ENV{PERL5DB_THREADED}) {
4250         print "creating new thread\n";
4251     }
4252
4253     # If the last ten characters are C'::AUTOLOAD', note we've traced
4254     # into AUTOLOAD for $sub.
4255     if ( length($sub) > 10 && substr( $sub, -10, 10 ) eq '::AUTOLOAD' ) {
4256         $al = " for $$sub";
4257     }
4258
4259     # We stack the stack pointer and then increment it to protect us
4260     # from a situation that might unwind a whole bunch of call frames
4261     # at once. Localizing the stack pointer means that it will automatically
4262     # unwind the same amount when multiple stack frames are unwound.
4263     local $stack_depth = $stack_depth + 1;    # Protect from non-local exits
4264
4265     # Expand @stack.
4266     $#stack = $stack_depth;
4267
4268     # Save current single-step setting.
4269     $stack[-1] = $single;
4270
4271     # Turn off all flags except single-stepping.
4272     # Use local so the single-step value is popped back off the
4273     # stack for us.
4274     local $single = $single & 1;
4275
4276     # If we've gotten really deeply recursed, turn on the flag that will
4277     # make us stop with the 'deep recursion' message.
4278     $single |= 4 if $stack_depth == $deep;
4279
4280     # If frame messages are on ...
4281     _print_frame_message($al);
4282
4283     # call the original lvalue sub.
4284     &$sub;
4285 }
4286
4287 # Abstracting common code from multiple places elsewhere:
4288 sub depth_print_lineinfo {
4289     my $always_print = shift;
4290
4291     print_lineinfo( @_ ) if ($always_print or $stack_depth < $trace_to_depth);
4292 }
4293
4294 =head1 EXTENDED COMMAND HANDLING AND THE COMMAND API
4295
4296 In Perl 5.8.0, there was a major realignment of the commands and what they did,
4297 Most of the changes were to systematize the command structure and to eliminate
4298 commands that threw away user input without checking.
4299
4300 The following sections describe the code added to make it easy to support
4301 multiple command sets with conflicting command names. This section is a start
4302 at unifying all command processing to make it simpler to develop commands.
4303
4304 Note that all the cmd_[a-zA-Z] subroutines require the command name, a line
4305 number, and C<$dbline> (the current line) as arguments.
4306
4307 Support functions in this section which have multiple modes of failure C<die>
4308 on error; the rest simply return a false value.
4309
4310 The user-interface functions (all of the C<cmd_*> functions) just output
4311 error messages.
4312
4313 =head2 C<%set>
4314
4315 The C<%set> hash defines the mapping from command letter to subroutine
4316 name suffix.
4317
4318 C<%set> is a two-level hash, indexed by set name and then by command name.
4319 Note that trying to set the CommandSet to C<foobar> simply results in the
4320 5.8.0 command set being used, since there's no top-level entry for C<foobar>.
4321
4322 =cut
4323
4324 ### The API section
4325
4326 my %set = (    #
4327     'pre580' => {
4328         'a' => 'pre580_a',
4329         'A' => 'pre580_null',
4330         'b' => 'pre580_b',
4331         'B' => 'pre580_null',
4332         'd' => 'pre580_null',
4333         'D' => 'pre580_D',
4334         'h' => 'pre580_h',
4335         'M' => 'pre580_null',
4336         'O' => 'o',
4337         'o' => 'pre580_null',
4338         'v' => 'M',
4339         'w' => 'v',
4340         'W' => 'pre580_W',
4341     },
4342     'pre590' => {
4343         '<'  => 'pre590_prepost',
4344         '<<' => 'pre590_prepost',
4345         '>'  => 'pre590_prepost',
4346         '>>' => 'pre590_prepost',
4347         '{'  => 'pre590_prepost',
4348         '{{' => 'pre590_prepost',
4349     },
4350 );
4351
4352 my %breakpoints_data;
4353
4354 sub _has_breakpoint_data_ref {
4355     my ($filename, $line) = @_;
4356
4357     return (
4358         exists( $breakpoints_data{$filename} )
4359             and
4360         exists( $breakpoints_data{$filename}{$line} )
4361     );
4362 }
4363
4364 sub _get_breakpoint_data_ref {
4365     my ($filename, $line) = @_;
4366
4367     return ($breakpoints_data{$filename}{$line} ||= +{});
4368 }
4369
4370 sub _delete_breakpoint_data_ref {
4371     my ($filename, $line) = @_;
4372
4373     delete($breakpoints_data{$filename}{$line});
4374     if (! scalar(keys( %{$breakpoints_data{$filename}} )) ) {
4375         delete($breakpoints_data{$filename});
4376     }
4377
4378     return;
4379 }
4380
4381 sub _set_breakpoint_enabled_status {
4382     my ($filename, $line, $status) = @_;
4383
4384     _get_breakpoint_data_ref($filename, $line)->{'enabled'} =
4385         ($status ? 1 : '')
4386         ;
4387
4388     return;
4389 }
4390
4391 sub _enable_breakpoint_temp_enabled_status {
4392     my ($filename, $line) = @_;
4393
4394     _get_breakpoint_data_ref($filename, $line)->{'temp_enabled'} = 1;
4395
4396     return;
4397 }
4398
4399 sub _cancel_breakpoint_temp_enabled_status {
4400     my ($filename, $line) = @_;
4401
4402     my $ref = _get_breakpoint_data_ref($filename, $line);
4403
4404     delete ($ref->{'temp_enabled'});
4405
4406     if (! %$ref) {
4407         _delete_breakpoint_data_ref($filename, $line);
4408     }
4409
4410     return;
4411 }
4412
4413 sub _is_breakpoint_enabled {
4414     my ($filename, $line) = @_;
4415
4416     my $data_ref = _get_breakpoint_data_ref($filename, $line);
4417     return ($data_ref->{'enabled'} || $data_ref->{'temp_enabled'});
4418 }
4419
4420 =head2 C<cmd_wrapper()> (API)
4421
4422 C<cmd_wrapper()> allows the debugger to switch command sets
4423 depending on the value of the C<CommandSet> option.
4424
4425 It tries to look up the command in the C<%set> package-level I<lexical>
4426 (which means external entities can't fiddle with it) and create the name of
4427 the sub to call based on the value found in the hash (if it's there). I<All>
4428 of the commands to be handled in a set have to be added to C<%set>; if they
4429 aren't found, the 5.8.0 equivalent is called (if there is one).
4430
4431 This code uses symbolic references.
4432
4433 =cut
4434
4435 sub cmd_wrapper {
4436     my $cmd      = shift;
4437     my $line     = shift;
4438     my $dblineno = shift;
4439
4440     # Assemble the command subroutine's name by looking up the
4441     # command set and command name in %set. If we can't find it,
4442     # default to the older version of the command.
4443     my $call = 'cmd_'
4444       . ( $set{$CommandSet}{$cmd}
4445           || ( $cmd =~ /\A[<>{]+/o ? 'prepost' : $cmd ) );
4446
4447     # Call the command subroutine, call it by name.
4448     return __PACKAGE__->can($call)->( $cmd, $line, $dblineno );
4449 } ## end sub cmd_wrapper
4450
4451 =head3 C<cmd_a> (command)
4452
4453 The C<a> command handles pre-execution actions. These are associated with a
4454 particular line, so they're stored in C<%dbline>. We default to the current
4455 line if none is specified.
4456
4457 =cut
4458
4459 sub cmd_a {
4460     my $cmd    = shift;
4461     my $line   = shift || '';    # [.|line] expr
4462     my $dbline = shift;
4463
4464     # If it's dot (here), or not all digits,  use the current line.
4465     $line =~ s/\A\./$dbline/;
4466
4467     # Should be a line number followed by an expression.
4468     if ( my ($lineno, $expr) = $line =~ /^\s*(\d*)\s*(\S.+)/ ) {
4469
4470         if (! length($lineno)) {
4471             $lineno = $dbline;
4472         }
4473
4474         # If we have an expression ...
4475         if ( length $expr ) {
4476
4477             # ... but the line isn't breakable, complain.
4478             if ( $dbline[$lineno] == 0 ) {
4479                 print $OUT
4480                   "Line $lineno($dbline[$lineno]) does not have an action?\n";
4481             }
4482             else {
4483
4484                 # It's executable. Record that the line has an action.
4485                 $had_breakpoints{$filename} |= 2;
4486
4487                 # Remove any action, temp breakpoint, etc.
4488                 $dbline{$lineno} =~ s/\0[^\0]*//;
4489
4490                 # Add the action to the line.
4491                 $dbline{$lineno} .= "\0" . action($expr);
4492
4493                 _set_breakpoint_enabled_status($filename, $lineno, 1);
4494             }
4495         } ## end if (length $expr)
4496     } ## end if ($line =~ /^\s*(\d*)\s*(\S.+)/)
4497     else {
4498
4499         # Syntax wrong.
4500         print $OUT
4501           "Adding an action requires an optional lineno and an expression\n"
4502           ;    # hint
4503     }
4504 } ## end sub cmd_a
4505
4506 =head3 C<cmd_A> (command)
4507
4508 Delete actions. Similar to above, except the delete code is in a separate
4509 subroutine, C<delete_action>.
4510
4511 =cut
4512
4513 sub cmd_A {
4514     my $cmd    = shift;
4515     my $line   = shift || '';
4516     my $dbline = shift;
4517
4518     # Dot is this line.
4519     $line =~ s/^\./$dbline/;
4520
4521     # Call delete_action with a null param to delete them all.
4522     # The '1' forces the eval to be true. It'll be false only
4523     # if delete_action blows up for some reason, in which case
4524     # we print $@ and get out.
4525     if ( $line eq '*' ) {
4526         if (! eval { _delete_all_actions(); 1 }) {
4527             print {$OUT} $@;
4528             return;
4529         }
4530     }
4531
4532     # There's a real line  number. Pass it to delete_action.
4533     # Error trapping is as above.
4534     elsif ( $line =~ /^(\S.*)/ ) {
4535         if (! eval { delete_action($1); 1 }) {
4536             print {$OUT} $@;
4537             return;
4538         }
4539     }
4540
4541     # Swing and a miss. Bad syntax.
4542     else {
4543         print $OUT
4544           "Deleting an action requires a line number, or '*' for all\n" ; # hint
4545     }
4546 } ## end sub cmd_A
4547
4548 =head3 C<delete_action> (API)
4549
4550 C<delete_action> accepts either a line number or C<undef>. If a line number
4551 is specified, we check for the line being executable (if it's not, it
4552 couldn't have had an  action). If it is, we just take the action off (this
4553 will get any kind of an action, including breakpoints).
4554
4555 =cut
4556
4557 sub _remove_action_from_dbline {
4558     my $i = shift;
4559
4560     $dbline{$i} =~ s/\0[^\0]*//;    # \^a
4561     delete $dbline{$i} if $dbline{$i} eq '';
4562
4563     return;
4564 }
4565
4566 sub _delete_all_actions {
4567     print {$OUT} "Deleting all actions...\n";
4568
4569     for my $file ( keys %had_breakpoints ) {
4570         local *dbline = $main::{ '_<' . $file };
4571         $max = $#dbline;
4572         my $was;
4573         for my $i (1 .. $max) {
4574             if ( defined $dbline{$i} ) {
4575                 _remove_action_from_dbline($i);
4576             }
4577         }
4578
4579         unless ( $had_breakpoints{$file} &= ~2 ) {
4580             delete $had_breakpoints{$file};
4581         }
4582     }
4583
4584     return;
4585 }
4586
4587 sub delete_action {
4588     my $i = shift;
4589
4590     if ( defined($i) ) {
4591         # Can there be one?
4592         die "Line $i has no action .\n" if $dbline[$i] == 0;
4593
4594         # Nuke whatever's there.
4595         _remove_action_from_dbline($i);
4596     }
4597     else {
4598         _delete_all_actions();
4599     }
4600 }
4601
4602 =head3 C<cmd_b> (command)
4603
4604 Set breakpoints. Since breakpoints can be set in so many places, in so many
4605 ways, conditionally or not, the breakpoint code is kind of complex. Mostly,
4606 we try to parse the command type, and then shuttle it off to an appropriate
4607 subroutine to actually do the work of setting the breakpoint in the right
4608 place.
4609
4610 =cut
4611
4612 sub cmd_b {
4613     my $cmd    = shift;
4614     my $line   = shift;    # [.|line] [cond]
4615     my $dbline = shift;
4616
4617     my $default_cond = sub {
4618         my $cond = shift;
4619         return length($cond) ? $cond : '1';
4620     };
4621
4622     # Make . the current line number if it's there..
4623     $line =~ s/^\.(\s|\z)/$dbline$1/;
4624
4625     # No line number, no condition. Simple break on current line.
4626     if ( $line =~ /^\s*$/ ) {
4627         cmd_b_line( $dbline, 1 );
4628     }
4629
4630     # Break on load for a file.
4631     elsif ( my ($file) = $line =~ /^load\b\s*(.*)/ ) {
4632         $file =~ s/\s+\z//;
4633         cmd_b_load($file);
4634     }
4635
4636     # b compile|postpone <some sub> [<condition>]
4637     # The interpreter actually traps this one for us; we just put the
4638     # necessary condition in the %postponed hash.
4639     elsif ( my ($action, $subname, $cond)
4640         = $line =~ /^(postpone|compile)\b\s*([':A-Za-z_][':\w]*)\s*(.*)/ ) {
4641
4642         # De-Perl4-ify the name - ' separators to ::.
4643         $subname =~ s/'/::/g;
4644
4645         # Qualify it into the current package unless it's already qualified.
4646         $subname = "${package}::" . $subname unless $subname =~ /::/;
4647
4648         # Add main if it starts with ::.
4649         $subname = "main" . $subname if substr( $subname, 0, 2 ) eq "::";
4650
4651         # Save the break type for this sub.
4652         $postponed{$subname} = (($action eq 'postpone')
4653             ? ( "break +0 if " . $default_cond->($cond) )
4654             : "compile");
4655     } ## end elsif ($line =~ ...
4656     # b <filename>:<line> [<condition>]
4657     elsif (my ($filename, $line_num, $cond)
4658         = $line =~ /\A(\S+[^:]):(\d+)\s*(.*)/ms) {
4659         cmd_b_filename_line(
4660             $filename,
4661             $line_num,
4662             (length($cond) ? $cond : '1'),
4663         );
4664     }
4665     # b <sub name> [<condition>]
4666     elsif ( my ($new_subname, $new_cond) =
4667         $line =~ /^([':A-Za-z_][':\w]*(?:\[.*\])?)\s*(.*)/ ) {
4668
4669         #
4670         $subname = $new_subname;
4671         cmd_b_sub( $subname, $default_cond->($new_cond) );
4672     }
4673
4674     # b <line> [<condition>].
4675     elsif ( my ($line_n, $cond) = $line =~ /^(\d*)\s*(.*)/ ) {
4676
4677         # Capture the line. If none, it's the current line.
4678         $line = $line_n || $dbline;
4679
4680         # Break on line.
4681         cmd_b_line( $line, $default_cond->($cond) );
4682     }
4683
4684     # Line didn't make sense.
4685     else {
4686         print "confused by line($line)?\n";
4687     }
4688
4689     return;
4690 } ## end sub cmd_b
4691
4692 =head3 C<break_on_load> (API)
4693
4694 We want to break when this file is loaded. Mark this file in the
4695 C<%break_on_load> hash, and note that it has a breakpoint in
4696 C<%had_breakpoints>.
4697
4698 =cut
4699
4700 sub break_on_load {
4701     my $file = shift;
4702     $break_on_load{$file} = 1;
4703     $had_breakpoints{$file} |= 1;
4704 }
4705
4706 =head3 C<report_break_on_load> (API)
4707
4708 Gives us an array of filenames that are set to break on load. Note that
4709 only files with break-on-load are in here, so simply showing the keys
4710 suffices.
4711
4712 =cut
4713
4714 sub report_break_on_load {
4715     sort keys %break_on_load;
4716 }
4717
4718 =head3 C<cmd_b_load> (command)
4719
4720 We take the file passed in and try to find it in C<%INC> (which maps modules
4721 to files they came from). We mark those files for break-on-load via
4722 C<break_on_load> and then report that it was done.
4723
4724 =cut
4725
4726 sub cmd_b_load {
4727     my $file = shift;
4728     my @files;
4729
4730     # This is a block because that way we can use a redo inside it
4731     # even without there being any looping structure at all outside it.
4732     {
4733
4734         # Save short name and full path if found.
4735         push @files, $file;
4736         push @files, $::INC{$file} if $::INC{$file};
4737
4738         # Tack on .pm and do it again unless there was a '.' in the name
4739         # already.
4740         $file .= '.pm', redo unless $file =~ /\./;
4741     }
4742
4743     # Do the real work here.
4744     break_on_load($_) for @files;
4745
4746     # All the files that have break-on-load breakpoints.
4747     @files = report_break_on_load;
4748
4749     # Normalize for the purposes of our printing this.
4750     local $\ = '';
4751     local $" = ' ';
4752     print $OUT "Will stop on load of '@files'.\n";
4753 } ## end sub cmd_b_load
4754
4755 =head3 C<$filename_error> (API package global)
4756
4757 Several of the functions we need to implement in the API need to work both
4758 on the current file and on other files. We don't want to duplicate code, so
4759 C<$filename_error> is used to contain the name of the file that's being
4760 worked on (if it's not the current one).
4761
4762 We can now build functions in pairs: the basic function works on the current
4763 file, and uses C<$filename_error> as part of its error message. Since this is
4764 initialized to C<"">, no filename will appear when we are working on the
4765 current file.
4766
4767 The second function is a wrapper which does the following:
4768
4769 =over 4
4770
4771 =item *
4772
4773 Localizes C<$filename_error> and sets it to the name of the file to be processed.
4774
4775 =item *
4776
4777 Localizes the C<*dbline> glob and reassigns it to point to the file we want to process.
4778
4779 =item *
4780
4781 Calls the first function.
4782
4783 The first function works on the I<current> file (i.e., the one we changed to),
4784 and prints C<$filename_error> in the error message (the name of the other file)
4785 if it needs to. When the functions return, C<*dbline> is restored to point
4786 to the actual current file (the one we're executing in) and
4787 C<$filename_error> is restored to C<"">. This restores everything to
4788 the way it was before the second function was called at all.
4789
4790 See the comments in C<breakable_line> and C<breakable_line_in_file> for more
4791 details.
4792
4793 =back
4794
4795 =cut
4796
4797 use vars qw($filename_error);
4798 $filename_error = '';
4799
4800 =head3 breakable_line(from, to) (API)
4801
4802 The subroutine decides whether or not a line in the current file is breakable.
4803 It walks through C<@dbline> within the range of lines specified, looking for
4804 the first line that is breakable.
4805
4806 If C<$to> is greater than C<$from>, the search moves forwards, finding the
4807 first line I<after> C<$to> that's breakable, if there is one.
4808
4809 If C<$from> is greater than C<$to>, the search goes I<backwards>, finding the
4810 first line I<before> C<$to> that's breakable, if there is one.
4811
4812 =cut
4813
4814 sub breakable_line {
4815
4816     my ( $from, $to ) = @_;
4817
4818     # $i is the start point. (Where are the FORTRAN programs of yesteryear?)
4819     my $i = $from;
4820
4821     # If there are at least 2 arguments, we're trying to search a range.
4822     if ( @_ >= 2 ) {
4823
4824         # $delta is positive for a forward search, negative for a backward one.
4825         my $delta = $from < $to ? +1 : -1;
4826
4827         # Keep us from running off the ends of the file.
4828         my $limit = $delta > 0 ? $#dbline : 1;
4829
4830         # Clever test. If you're a mathematician, it's obvious why this
4831         # test works. If not:
4832         # If $delta is positive (going forward), $limit will be $#dbline.
4833         #    If $to is less than $limit, ($limit - $to) will be positive, times
4834         #    $delta of 1 (positive), so the result is > 0 and we should use $to
4835         #    as the stopping point.
4836         #
4837         #    If $to is greater than $limit, ($limit - $to) is negative,
4838         #    times $delta of 1 (positive), so the result is < 0 and we should
4839         #    use $limit ($#dbline) as the stopping point.
4840         #
4841         # If $delta is negative (going backward), $limit will be 1.
4842         #    If $to is zero, ($limit - $to) will be 1, times $delta of -1
4843         #    (negative) so the result is > 0, and we use $to as the stopping
4844         #    point.
4845         #
4846         #    If $to is less than zero, ($limit - $to) will be positive,
4847         #    times $delta of -1 (negative), so the result is not > 0, and
4848         #    we use $limit (1) as the stopping point.
4849         #
4850         #    If $to is 1, ($limit - $to) will zero, times $delta of -1
4851         #    (negative), still giving zero; the result is not > 0, and
4852         #    we use $limit (1) as the stopping point.
4853         #
4854         #    if $to is >1, ($limit - $to) will be negative, times $delta of -1
4855         #    (negative), giving a positive (>0) value, so we'll set $limit to
4856         #    $to.
4857
4858         $limit = $to if ( $limit - $to ) * $delta > 0;
4859
4860         # The real search loop.
4861         # $i starts at $from (the point we want to start searching from).
4862         # We move through @dbline in the appropriate direction (determined
4863         # by $delta: either -1 (back) or +1 (ahead).
4864         # We stay in as long as we haven't hit an executable line
4865         # ($dbline[$i] == 0 means not executable) and we haven't reached
4866         # the limit yet (test similar to the above).
4867         $i += $delta while $dbline[$i] == 0 and ( $limit - $i ) * $delta > 0;
4868
4869     } ## end if (@_ >= 2)
4870
4871     # If $i points to a line that is executable, return that.
4872     return $i unless $dbline[$i] == 0;
4873
4874     # Format the message and print it: no breakable lines in range.
4875     my ( $pl, $upto ) = ( '', '' );
4876     ( $pl, $upto ) = ( 's', "..$to" ) if @_ >= 2 and $from != $to;
4877
4878     # If there's a filename in filename_error, we'll see it.
4879     # If not, not.
4880     die "Line$pl $from$upto$filename_error not breakable\n";
4881 } ## end sub breakable_line
4882
4883 =head3 breakable_line_in_filename(file, from, to) (API)
4884
4885 Like C<breakable_line>, but look in another file.
4886
4887 =cut
4888
4889 sub breakable_line_in_filename {
4890
4891     # Capture the file name.
4892     my ($f) = shift;
4893
4894     # Swap the magic line array over there temporarily.
4895     local *dbline = $main::{ '_<' . $f };
4896
4897     # If there's an error, it's in this other file.
4898     local $filename_error = " of '$f'";
4899
4900     # Find the breakable line.
4901     breakable_line(@_);
4902
4903     # *dbline and $filename_error get restored when this block ends.
4904
4905 } ## end sub breakable_line_in_filename
4906
4907 =head3 break_on_line(lineno, [condition]) (API)
4908
4909 Adds a breakpoint with the specified condition (or 1 if no condition was
4910 specified) to the specified line. Dies if it can't.
4911
4912 =cut
4913
4914 sub break_on_line {
4915     my $i = shift;
4916     my $cond = @_ ? shift(@_) : 1;
4917
4918     my $inii  = $i;
4919     my $after = '';
4920     my $pl    = '';
4921
4922     # Woops, not a breakable line. $filename_error allows us to say
4923     # if it was in a different file.
4924     die "Line $i$filename_error not breakable.\n" if $dbline[$i] == 0;
4925
4926     # Mark this file as having breakpoints in it.
4927     $had_breakpoints{$filename} |= 1;
4928
4929     # If there is an action or condition here already ...
4930     if ( $dbline{$i} ) {
4931
4932         # ... swap this condition for the existing one.
4933         $dbline{$i} =~ s/^[^\0]*/$cond/;
4934     }
4935     else {
4936
4937         # Nothing here - just add the condition.
4938         $dbline{$i} = $cond;
4939
4940         _set_breakpoint_enabled_status($filename, $i, 1);
4941     }
4942
4943     return;
4944 } ## end sub break_on_line
4945
4946 =head3 cmd_b_line(line, [condition]) (command)
4947
4948 Wrapper for C<break_on_line>. Prints the failure message if it
4949 doesn't work.
4950
4951 =cut
4952
4953 sub cmd_b_line {
4954     if (not eval { break_on_line(@_); 1 }) {
4955         local $\ = '';
4956         print $OUT $@ and return;
4957     }
4958
4959     return;
4960 } ## end sub cmd_b_line
4961
4962 =head3 cmd_b_filename_line(line, [condition]) (command)
4963
4964 Wrapper for C<break_on_filename_line>. Prints the failure message if it
4965 doesn't work.
4966
4967 =cut
4968
4969 sub cmd_b_filename_line {
4970     if (not eval { break_on_filename_line(@_); 1 }) {
4971         local $\ = '';
4972         print $OUT $@ and return;
4973     }
4974
4975     return;
4976 }
4977
4978 =head3 break_on_filename_line(file, line, [condition]) (API)
4979
4980 Switches to the file specified and then calls C<break_on_line> to set
4981 the breakpoint.
4982
4983 =cut
4984
4985 sub break_on_filename_line {
4986     my $f = shift;
4987     my $i = shift;
4988     my $cond = @_ ? shift(@_) : 1;
4989
4990     # Switch the magical hash temporarily.
4991     local *dbline = $main::{ '_<' . $f };
4992
4993     # Localize the variables that break_on_line uses to make its message.
4994     local $filename_error = " of '$f'";
4995     local $filename       = $f;
4996
4997     # Add the breakpoint.
4998     break_on_line( $i, $cond );
4999
5000     return;
5001 } ## end sub break_on_filename_line
5002
5003 =head3 break_on_filename_line_range(file, from, to, [condition]) (API)
5004
5005 Switch to another file, search the range of lines specified for an
5006 executable one, and put a breakpoint on the first one you find.
5007
5008 =cut
5009
5010 sub break_on_filename_line_range {
5011     my $f = shift;
5012     my $from = shift;
5013     my $to = shift;
5014     my $cond = @_ ? shift(@_) : 1;
5015
5016     # Find a breakable line if there is one.
5017     my $i = breakable_line_in_filename( $f, $from, $to );
5018
5019     # Add the breakpoint.
5020     break_on_filename_line( $f, $i, $cond );
5021
5022     return;
5023 } ## end sub break_on_filename_line_range
5024
5025 =head3 subroutine_filename_lines(subname, [condition]) (API)
5026
5027 Search for a subroutine within a given file. The condition is ignored.
5028 Uses C<find_sub> to locate the desired subroutine.
5029
5030 =cut
5031
5032 sub subroutine_filename_lines {
5033     my ( $subname ) = @_;
5034
5035     # Returned value from find_sub() is fullpathname:startline-endline.
5036     # The match creates the list (fullpathname, start, end).
5037     return (find_sub($subname) =~ /^(.*):(\d+)-(\d+)$/);
5038 } ## end sub subroutine_filename_lines
5039
5040 =head3 break_subroutine(subname) (API)
5041
5042 Places a break on the first line possible in the specified subroutine. Uses
5043 C<subroutine_filename_lines> to find the subroutine, and
5044 C<break_on_filename_line_range> to place the break.
5045
5046 =cut
5047
5048 sub break_subroutine {
5049     my $subname = shift;
5050
5051     # Get filename, start, and end.
5052     my ( $file, $s, $e ) = subroutine_filename_lines($subname)
5053       or die "Subroutine $subname not found.\n";
5054
5055
5056     # Null condition changes to '1' (always true).
5057     my $cond = @_ ? shift(@_) : 1;
5058
5059     # Put a break the first place possible in the range of lines
5060     # that make up this subroutine.
5061     break_on_filename_line_range( $file, $s, $e, $cond );
5062
5063     return;
5064 } ## end sub break_subroutine
5065
5066 =head3 cmd_b_sub(subname, [condition]) (command)
5067
5068 We take the incoming subroutine name and fully-qualify it as best we can.
5069
5070 =over 4
5071
5072 =item 1. If it's already fully-qualified, leave it alone.
5073
5074 =item 2. Try putting it in the current package.
5075
5076 =item 3. If it's not there, try putting it in CORE::GLOBAL if it exists there.
5077
5078 =item 4. If it starts with '::', put it in 'main::'.
5079
5080 =back
5081
5082 After all this cleanup, we call C<break_subroutine> to try to set the
5083 breakpoint.
5084
5085 =cut
5086
5087 sub cmd_b_sub {
5088     my $subname = shift;
5089     my $cond = @_ ? shift : 1;
5090
5091     # If the subname isn't a code reference, qualify it so that
5092     # break_subroutine() will work right.
5093     if ( ref($subname) ne 'CODE' ) {
5094
5095         # Not Perl 4.
5096         $subname =~ s/'/::/g;
5097         my $s = $subname;
5098
5099         # Put it in this package unless it's already qualified.
5100         if ($subname !~ /::/)
5101         {
5102             $subname = $package . '::' . $subname;
5103         };
5104
5105         # Requalify it into CORE::GLOBAL if qualifying it into this
5106         # package resulted in its not being defined, but only do so
5107         # if it really is in CORE::GLOBAL.
5108         my $core_name = "CORE::GLOBAL::$s";
5109         if ((!defined(&$subname))
5110                 and ($s !~ /::/)
5111                 and (defined &{$core_name}))
5112         {
5113             $subname = $core_name;
5114         }
5115
5116         # Put it in package 'main' if it has a leading ::.
5117         if ($subname =~ /\A::/)
5118         {
5119             $subname = "main" . $subname;
5120         }
5121     } ## end if ( ref($subname) ne 'CODE' ) {
5122
5123     # Try to set the breakpoint.
5124     if (not eval { break_subroutine( $subname, $cond ); 1 }) {
5125         local $\ = '';
5126         print {$OUT} $@;
5127         return;
5128     }
5129
5130     return;
5131 } ## end sub cmd_b_sub
5132
5133 =head3 C<cmd_B> - delete breakpoint(s) (command)
5134
5135 The command mostly parses the command line and tries to turn the argument
5136 into a line spec. If it can't, it uses the current line. It then calls
5137 C<delete_breakpoint> to actually do the work.
5138
5139 If C<*> is  specified, C<cmd_B> calls C<delete_breakpoint> with no arguments,
5140 thereby deleting all the breakpoints.
5141
5142 =cut
5143
5144 sub cmd_B {
5145     my $cmd = shift;
5146
5147     # No line spec? Use dbline.
5148     # If there is one, use it if it's non-zero, or wipe it out if it is.
5149     my $line   = ( $_[0] =~ /\A\./ ) ? $dbline : (shift || '');
5150     my $dbline = shift;
5151
5152     # If the line was dot, make the line the current one.
5153     $line =~ s/^\./$dbline/;
5154
5155     # If it's * we're deleting all the breakpoints.
5156     if ( $line eq '*' ) {
5157         if (not eval { delete_breakpoint(); 1 }) {
5158             print {$OUT} $@;
5159         }
5160     }
5161
5162     # If there is a line spec, delete the breakpoint on that line.
5163     elsif ( $line =~ /\A(\S.*)/ ) {
5164         if (not eval { delete_breakpoint( $line || $dbline ); 1 }) {
5165             local $\ = '';
5166             print {$OUT} $@;
5167         }
5168     } ## end elsif ($line =~ /^(\S.*)/)
5169
5170     # No line spec.
5171     else {
5172         print {$OUT}
5173           "Deleting a breakpoint requires a line number, or '*' for all\n"
5174           ;    # hint
5175     }
5176
5177     return;
5178 } ## end sub cmd_B
5179
5180 =head3 delete_breakpoint([line]) (API)
5181
5182 This actually does the work of deleting either a single breakpoint, or all
5183 of them.
5184
5185 For a single line, we look for it in C<@dbline>. If it's nonbreakable, we
5186 just drop out with a message saying so. If it is, we remove the condition
5187 part of the 'condition\0action' that says there's a breakpoint here. If,
5188 after we've done that, there's nothing left, we delete the corresponding
5189 line in C<%dbline> to signal that no action needs to be taken for this line.
5190
5191 For all breakpoints, we iterate through the keys of C<%had_breakpoints>,
5192 which lists all currently-loaded files which have breakpoints. We then look
5193 at each line in each of these files, temporarily switching the C<%dbline>
5194 and C<@dbline> structures to point to the files in question, and do what
5195 we did in the single line case: delete the condition in C<@dbline>, and
5196 delete the key in C<%dbline> if nothing's left.
5197
5198 We then wholesale delete C<%postponed>, C<%postponed_file>, and
5199 C<%break_on_load>, because these structures contain breakpoints for files
5200 and code that haven't been loaded yet. We can just kill these off because there
5201 are no magical debugger structures associated with them.
5202
5203 =cut
5204
5205 sub _remove_breakpoint_entry {
5206     my ($fn, $i) = @_;
5207
5208     delete $dbline{$i};
5209     _delete_breakpoint_data_ref($fn, $i);
5210
5211     return;
5212 }
5213
5214 sub _delete_all_breakpoints {
5215     print {$OUT} "Deleting all breakpoints...\n";
5216
5217     # %had_breakpoints lists every file that had at least one
5218     # breakpoint in it.
5219     for my $fn ( keys %had_breakpoints ) {
5220
5221         # Switch to the desired file temporarily.
5222         local *dbline = $main::{ '_<' . $fn };
5223
5224         $max = $#dbline;
5225
5226         # For all lines in this file ...
5227         for my $i (1 .. $max) {
5228
5229             # If there's a breakpoint or action on this line ...
5230             if ( defined $dbline{$i} ) {
5231
5232                 # ... remove the breakpoint.
5233                 $dbline{$i} =~ s/\A[^\0]+//;
5234                 if ( $dbline{$i} =~ s/\A\0?\z// ) {
5235                     # Remove the entry altogether if no action is there.
5236                     _remove_breakpoint_entry($fn, $i);
5237                 }
5238             } ## end if (defined $dbline{$i...
5239         } ## end for $i (1 .. $max)
5240
5241         # If, after we turn off the "there were breakpoints in this file"
5242         # bit, the entry in %had_breakpoints for this file is zero,
5243         # we should remove this file from the hash.
5244         if ( not $had_breakpoints{$fn} &= (~1) ) {
5245             delete $had_breakpoints{$fn};
5246         }
5247     } ## end for my $fn (keys %had_breakpoints)
5248
5249     # Kill off all the other breakpoints that are waiting for files that
5250     # haven't been loaded yet.
5251     undef %postponed;
5252     undef %postponed_file;
5253     undef %break_on_load;
5254
5255     return;
5256 }
5257
5258 sub _delete_breakpoint_from_line {
5259     my ($i) = @_;
5260
5261     # Woops. This line wasn't breakable at all.
5262     die "Line $i not breakable.\n" if $dbline[$i] == 0;
5263
5264     # Kill the condition, but leave any action.
5265     $dbline{$i} =~ s/\A[^\0]*//;
5266
5267     # Remove the entry entirely if there's no action left.
5268     if ($dbline{$i} eq '') {
5269         _remove_breakpoint_entry($filename, $i);
5270     }
5271
5272     return;
5273 }
5274
5275 sub delete_breakpoint {
5276     my $i = shift;
5277
5278     # If we got a line, delete just that one.
5279     if ( defined($i) ) {
5280         _delete_breakpoint_from_line($i);
5281     }
5282     # No line; delete them all.
5283     else {
5284         _delete_all_breakpoints();
5285     }
5286
5287     return;
5288 }
5289
5290 =head3 cmd_stop (command)
5291
5292 This is meant to be part of the new command API, but it isn't called or used
5293 anywhere else in the debugger. XXX It is probably meant for use in development
5294 of new commands.
5295
5296 =cut
5297
5298 sub cmd_stop {    # As on ^C, but not signal-safy.
5299     $signal = 1;
5300 }
5301
5302 =head3 C<cmd_e> - threads
5303
5304 Display the current thread id:
5305
5306     e
5307
5308 This could be how (when implemented) to send commands to this thread id (e cmd)
5309 or that thread id (e tid cmd).
5310
5311 =cut
5312
5313 sub cmd_e {
5314     my $cmd  = shift;
5315     my $line = shift;
5316     unless (exists($INC{'threads.pm'})) {
5317         print "threads not loaded($ENV{PERL5DB_THREADED})
5318         please run the debugger with PERL5DB_THREADED=1 set in the environment\n";
5319     } else {
5320         my $tid = threads->tid;
5321         print "thread id: $tid\n";
5322     }
5323 } ## end sub cmd_e
5324
5325 =head3 C<cmd_E> - list of thread ids
5326
5327 Display the list of available thread ids:
5328
5329     E
5330
5331 This could be used (when implemented) to send commands to all threads (E cmd).
5332
5333 =cut
5334
5335 sub cmd_E {
5336     my $cmd  = shift;
5337     my $line = shift;
5338     unless (exists($INC{'threads.pm'})) {
5339         print "threads not loaded($ENV{PERL5DB_THREADED})
5340         please run the debugger with PERL5DB_THREADED=1 set in the environment\n";
5341     } else {
5342         my $tid = threads->tid;
5343         print "thread ids: ".join(', ',
5344             map { ($tid == $_->tid ? '<'.$_->tid.'>' : $_->tid) } threads->list
5345         )."\n";
5346     }
5347 } ## end sub cmd_E
5348
5349 =head3 C<cmd_h> - help command (command)
5350
5351 Does the work of either
5352
5353 =over 4
5354
5355 =item *
5356
5357 Showing all the debugger help
5358
5359 =item *
5360
5361 Showing help for a specific command
5362
5363 =back
5364
5365 =cut
5366
5367 use vars qw($help);
5368 use vars qw($summary);
5369
5370 sub cmd_h {
5371     my $cmd = shift;
5372
5373     # If we have no operand, assume null.
5374     my $line = shift || '';
5375
5376     # 'h h'. Print the long-format help.
5377     if ( $line =~ /\Ah\s*\z/ ) {
5378         print_help($help);
5379     }
5380
5381     # 'h <something>'. Search for the command and print only its help.
5382     elsif ( my ($asked) = $line =~ /\A(\S.*)\z/ ) {
5383
5384         # support long commands; otherwise bogus errors
5385         # happen when you ask for h on <CR> for example
5386         my $qasked = quotemeta($asked);    # for searching; we don't
5387                                            # want to use it as a pattern.
5388                                            # XXX: finds CR but not <CR>
5389
5390         # Search the help string for the command.
5391         if (
5392             $help =~ /^                    # Start of a line
5393                       <?                   # Optional '<'
5394                       (?:[IB]<)            # Optional markup
5395                       $qasked              # The requested command
5396                      /mx
5397           )
5398         {
5399
5400             # It's there; pull it out and print it.
5401             while (
5402                 $help =~ /^
5403                               (<?            # Optional '<'
5404                                  (?:[IB]<)   # Optional markup
5405                                  $qasked     # The command
5406                                  ([\s\S]*?)  # Description line(s)
5407                               \n)            # End of last description line
5408                               (?!\s)         # Next line not starting with
5409                                              # whitespace
5410                              /mgx
5411               )
5412             {
5413                 print_help($1);
5414             }
5415         }
5416
5417         # Not found; not a debugger command.
5418         else {
5419             print_help("B<$asked> is not a debugger command.\n");
5420         }
5421     } ## end elsif ($line =~ /^(\S.*)$/)
5422
5423     # 'h' - print the summary help.
5424     else {
5425         print_help($summary);
5426     }
5427 } ## end sub cmd_h
5428
5429 =head3 C<cmd_i> - inheritance display
5430
5431 Display the (nested) parentage of the module or object given.
5432
5433 =cut
5434
5435 sub cmd_i {
5436     my $cmd  = shift;
5437     my $line = shift;
5438     foreach my $isa ( split( /\s+/, $line ) ) {
5439         $evalarg = $isa;
5440         # The &-call is here to ascertain the mutability of @_.
5441         ($isa) = &DB::eval;
5442         no strict 'refs';
5443         print join(
5444             ', ',
5445             map {
5446                 "$_"
5447                   . (
5448                     defined( ${"$_\::VERSION"} )
5449                     ? ' ' . ${"$_\::VERSION"}
5450                     : undef )
5451               } @{mro::get_linear_isa(ref($isa) || $isa)}
5452         );
5453         print "\n";
5454     }
5455 } ## end sub cmd_i
5456
5457 =head3 C<cmd_l> - list lines (command)
5458
5459 Most of the command is taken up with transforming all the different line
5460 specification syntaxes into 'start-stop'. After that is done, the command
5461 runs a loop over C<@dbline> for the specified range of lines. It handles
5462 the printing of each line and any markers (C<==E<gt>> for current line,
5463 C<b> for break on this line, C<a> for action on this line, C<:> for this
5464 line breakable).
5465
5466 We save the last line listed in the C<$start> global for further listing
5467 later.
5468
5469 =cut
5470
5471 sub _min {
5472     my $min = shift;
5473     foreach my $v (@_) {
5474         if ($min > $v) {
5475             $min = $v;
5476         }
5477     }
5478     return $min;
5479 }
5480
5481 sub _max {
5482     my $max = shift;
5483     foreach my $v (@_) {
5484         if ($max < $v) {
5485             $max = $v;
5486         }
5487     }
5488     return $max;
5489 }
5490
5491 sub _minify_to_max {
5492     my $ref = shift;
5493
5494     $$ref = _min($$ref, $max);
5495
5496     return;
5497 }
5498
5499 sub _cmd_l_handle_var_name {
5500     my $var_name = shift;
5501
5502     $evalarg = $var_name;
5503
5504     my ($s) = DB::eval();
5505
5506     # Ooops. Bad scalar.
5507     if ($@) {
5508         print {$OUT} "Error: $@\n";
5509         next CMD;
5510     }
5511
5512     # Good scalar. If it's a reference, find what it points to.
5513     $s = CvGV_name($s);
5514     print {$OUT} "Interpreted as: $1 $s\n";
5515     $line = "$1 $s";
5516
5517     # Call self recursively to really do the command.
5518     return _cmd_l_main( $s );
5519 }
5520
5521 sub _cmd_l_handle_subname {
5522
5523     my $s = $subname;
5524
5525     # De-Perl4.
5526     $subname =~ s/\'/::/;
5527
5528     # Put it in this package unless it starts with ::.
5529     $subname = $package . "::" . $subname unless $subname =~ /::/;
5530
5531     # Put it in CORE::GLOBAL if t doesn't start with :: and
5532     # it doesn't live in this package and it lives in CORE::GLOBAL.
5533     $subname = "CORE::GLOBAL::$s"
5534     if not defined &$subname
5535         and $s !~ /::/
5536         and defined &{"CORE::GLOBAL::$s"};
5537
5538     # Put leading '::' names into 'main::'.
5539     $subname = "main" . $subname if substr( $subname, 0, 2 ) eq "::";
5540
5541     # Get name:start-stop from find_sub, and break this up at
5542     # colons.
5543     my @pieces = split( /:/, find_sub($subname) || $sub{$subname} );
5544
5545     # Pull off start-stop.
5546     my $subrange = pop @pieces;
5547
5548     # If the name contained colons, the split broke it up.
5549     # Put it back together.
5550     $file = join( ':', @pieces );
5551
5552     # If we're not in that file, switch over to it.
5553     if ( $file ne $filename ) {
5554         if (! $slave_editor) {
5555             print {$OUT} "Switching to file '$file'.\n";
5556         }
5557
5558         # Switch debugger's magic structures.
5559         *dbline   = $main::{ '_<' . $file };
5560         $max      = $#dbline;
5561         $filename = $file;
5562     } ## end if ($file ne $filename)
5563
5564     # Subrange is 'start-stop'. If this is less than a window full,
5565     # swap it to 'start+', which will list a window from the start point.
5566     if ($subrange) {
5567         if ( eval($subrange) < -$window ) {
5568             $subrange =~ s/-.*/+/;
5569         }
5570
5571         # Call self recursively to list the range.
5572         return _cmd_l_main( $subrange );
5573     } ## end if ($subrange)
5574
5575     # Couldn't find it.
5576     else {
5577         print {$OUT} "Subroutine $subname not found.\n";
5578         return;
5579     }
5580 }
5581
5582 sub _cmd_l_empty {
5583     # Compute new range to list.
5584     $incr = $window - 1;
5585
5586     # Recurse to do it.
5587     return _cmd_l_main( $start . '-' . ( $start + $incr ) );
5588 }
5589
5590 sub _cmd_l_plus {
5591     my ($new_start, $new_incr) = @_;
5592
5593     # Don't reset start for 'l +nnn'.
5594     $start = $new_start if $new_start;
5595
5596     # Increment for list. Use window size if not specified.
5597     # (Allows 'l +' to work.)
5598     $incr = $new_incr || ($window - 1);
5599
5600     # Create a line range we'll understand, and recurse to do it.
5601     return _cmd_l_main( $start . '-' . ( $start + $incr ) );
5602 }
5603
5604 sub _cmd_l_calc_initial_end_and_i {
5605     my ($spec, $start_match, $end_match) = @_;
5606
5607     # Determine end point; use end of file if not specified.
5608     my $end = ( !defined $start_match ) ? $max :
5609     ( $end_match ? $end_match : $start_match );
5610
5611     # Go on to the end, and then stop.
5612     _minify_to_max(\$end);
5613
5614     # Determine start line.
5615     my $i = $start_match;
5616
5617     if ($i eq '.') {
5618         $i = $spec;
5619     }
5620
5621     $i = _max($i, 1);
5622
5623     $incr = $end - $i;
5624
5625     return ($end, $i);
5626 }
5627
5628 sub _cmd_l_range {
5629     my ($spec, $current_line, $start_match, $end_match) = @_;
5630
5631     my ($end, $i) =
5632         _cmd_l_calc_initial_end_and_i($spec, $start_match, $end_match);
5633
5634     # If we're running under a slave editor, force it to show the lines.
5635     if ($slave_editor) {
5636         print {$OUT} "\032\032$filename:$i:0\n";
5637         $i = $end;
5638     }
5639     # We're doing it ourselves. We want to show the line and special
5640     # markers for:
5641     # - the current line in execution
5642     # - whether a line is breakable or not
5643     # - whether a line has a break or not
5644     # - whether a line has an action or not
5645     else {
5646         I_TO_END:
5647         for ( ; $i <= $end ; $i++ ) {
5648
5649             # Check for breakpoints and actions.
5650             my ( $stop, $action );
5651             if ($dbline{$i}) {
5652                 ( $stop, $action ) = split( /\0/, $dbline{$i} );
5653             }
5654
5655             # ==> if this is the current line in execution,
5656             # : if it's breakable.
5657             my $arrow =
5658             ( $i == $current_line and $filename eq $filename_ini )
5659             ? '==>'
5660             : ( $dbline[$i] + 0 ? ':' : ' ' );
5661
5662             # Add break and action indicators.
5663             $arrow .= 'b' if $stop;
5664             $arrow .= 'a' if $action;
5665
5666             # Print the line.
5667             print {$OUT} "$i$arrow\t", $dbline[$i];
5668
5669             # Move on to the next line. Drop out on an interrupt.
5670             if ($signal) {
5671                 $i++;
5672                 last I_TO_END;
5673             }
5674         } ## end for (; $i <= $end ; $i++)
5675
5676         # Line the prompt up; print a newline if the last line listed
5677         # didn't have a newline.
5678         if ($dbline[ $i - 1 ] !~ /\n\z/) {
5679             print {$OUT} "\n";
5680         }
5681     } ## end else [ if ($slave_editor)
5682
5683     # Save the point we last listed to in case another relative 'l'
5684     # command is desired. Don't let it run off the end.
5685     $start = $i;
5686     _minify_to_max(\$start);
5687
5688     return;
5689 }
5690
5691 sub _cmd_l_main {
5692     my $spec = shift;
5693
5694     # If this is '-something', delete any spaces after the dash.
5695     $spec =~ s/\A-\s*\z/-/;
5696
5697     # If the line is '$something', assume this is a scalar containing a
5698     # line number.
5699     # Set up for DB::eval() - evaluate in *user* context.
5700     if ( my ($var_name) = $spec =~ /\A(\$.*)/s ) {
5701         return _cmd_l_handle_var_name($var_name);
5702     }
5703     # l name. Try to find a sub by that name.
5704     elsif ( ($subname) = $spec =~ /\A([\':A-Za-z_][\':\w]*(?:\[.*\])?)/s ) {
5705         return _cmd_l_handle_subname();
5706     }
5707     # Bare 'l' command.
5708     elsif ( $spec !~ /\S/ ) {
5709         return _cmd_l_empty();
5710     }
5711     # l [start]+number_of_lines
5712     elsif ( my ($new_start, $new_incr) = $spec =~ /\A(\d*)\+(\d*)\z/ ) {
5713         return _cmd_l_plus($new_start, $new_incr);
5714     }
5715     # l start-stop or l start,stop
5716     elsif (my ($s, $e) = $spec =~ /^(?:(-?[\d\$\.]+)(?:[-,]([\d\$\.]+))?)?/ ) {
5717         return _cmd_l_range($spec, $line, $s, $e);
5718     }
5719
5720     return;
5721 } ## end sub cmd_l
5722
5723 sub cmd_l {
5724     my (undef, $line) = @_;
5725
5726     return _cmd_l_main($line);
5727 }
5728
5729 =head3 C<cmd_L> - list breakpoints, actions, and watch expressions (command)
5730
5731 To list breakpoints, the command has to look determine where all of them are
5732 first. It starts a C<%had_breakpoints>, which tells us what all files have
5733 breakpoints and/or actions. For each file, we switch the C<*dbline> glob (the
5734 magic source and breakpoint data structures) to the file, and then look
5735 through C<%dbline> for lines with breakpoints and/or actions, listing them
5736 out. We look through C<%postponed> not-yet-compiled subroutines that have
5737 breakpoints, and through C<%postponed_file> for not-yet-C<require>'d files
5738 that have breakpoints.
5739
5740 Watchpoints are simpler: we just list the entries in C<@to_watch>.
5741
5742 =cut
5743
5744 sub _cmd_L_calc_arg {
5745     # If no argument, list everything. Pre-5.8.0 version always lists
5746     # everything
5747     my $arg = shift || 'abw';
5748     if ($CommandSet ne '580')
5749     {
5750         $arg = 'abw';
5751     }
5752
5753     return $arg;
5754 }
5755
5756 sub _cmd_L_calc_wanted_flags {
5757     my $arg = _cmd_L_calc_arg(shift);
5758
5759     return (map { index($arg, $_) >= 0 ? 1 : 0 } qw(a b w));
5760 }
5761
5762
5763 sub _cmd_L_handle_breakpoints {
5764     my ($handle_db_line) = @_;
5765
5766     BREAKPOINTS_SCAN:
5767     # Look in all the files with breakpoints...
5768     for my $file ( keys %had_breakpoints ) {
5769
5770         # Temporary switch to this file.
5771         local *dbline = $main::{ '_<' . $file };
5772
5773         # Set up to look through the whole file.
5774         $max = $#dbline;
5775         my $was;    # Flag: did we print something
5776         # in this file?
5777
5778         # For each line in the file ...
5779         for my $i (1 .. $max) {
5780
5781             # We've got something on this line.
5782             if ( defined $dbline{$i} ) {
5783
5784                 # Print the header if we haven't.
5785                 if (not $was++) {
5786                     print {$OUT} "$file:\n";
5787                 }
5788
5789                 # Print the line.
5790                 print {$OUT} " $i:\t", $dbline[$i];
5791
5792                 $handle_db_line->($dbline{$i});
5793
5794                 # Quit if the user hit interrupt.
5795                 if ($signal) {
5796                     last BREAKPOINTS_SCAN;
5797                 }
5798             } ## end if (defined $dbline{$i...
5799         } ## end for my $i (1 .. $max)
5800     } ## end for my $file (keys %had_breakpoints)
5801
5802     return;
5803 }
5804
5805 sub _cmd_L_handle_postponed_breakpoints {
5806     my ($handle_db_line) = @_;
5807
5808     print {$OUT} "Postponed breakpoints in files:\n";
5809
5810     POSTPONED_SCANS:
5811     for my $file ( keys %postponed_file ) {
5812         my $db = $postponed_file{$file};
5813         print {$OUT} " $file:\n";
5814         for my $line ( sort { $a <=> $b } keys %$db ) {
5815             print {$OUT} "  $line:\n";
5816
5817             $handle_db_line->($db->{$line});
5818
5819             if ($signal) {
5820                 last POSTPONED_SCANS;
5821             }
5822         }
5823         if ($signal) {
5824             last POSTPONED_SCANS;
5825         }
5826     }
5827
5828     return;
5829 }
5830
5831
5832 sub cmd_L {
5833     my $cmd = shift;
5834
5835     my ($action_wanted, $break_wanted, $watch_wanted) =
5836         _cmd_L_calc_wanted_flags(shift);
5837
5838     my $handle_db_line = sub {
5839         my ($l) = @_;
5840
5841         my ( $stop, $action ) = split( /\0/, $l );
5842
5843         if ($stop and $break_wanted) {
5844             print {$OUT} "    break if (", $stop, ")\n"
5845         }
5846
5847         if ($action && $action_wanted) {
5848             print {$OUT} "    action:  ", $action, "\n"
5849         }
5850
5851         return;
5852     };
5853
5854     # Breaks and actions are found together, so we look in the same place
5855     # for both.
5856     if ( $break_wanted or $action_wanted ) {
5857         _cmd_L_handle_breakpoints($handle_db_line);
5858     }
5859
5860     # Look for breaks in not-yet-compiled subs:
5861     if ( %postponed and $break_wanted ) {
5862         print {$OUT} "Postponed breakpoints in subroutines:\n";
5863         my $subname;
5864         SUBS_SCAN:
5865         for $subname ( keys %postponed ) {
5866             print {$OUT} " $subname\t$postponed{$subname}\n";
5867             if ($signal) {
5868                 last SUBS_SCAN;
5869             }
5870         }
5871     } ## end if (%postponed and $break_wanted)
5872
5873     # Find files that have not-yet-loaded breaks:
5874     my @have = map {    # Combined keys
5875         keys %{ $postponed_file{$_} }
5876     } keys %postponed_file;
5877
5878     # If there are any, list them.
5879     if ( @have and ( $break_wanted or $action_wanted ) ) {
5880         _cmd_L_handle_postponed_breakpoints($handle_db_line);
5881     } ## end if (@have and ($break_wanted...
5882
5883     if ( %break_on_load and $break_wanted ) {
5884         print {$OUT} "Breakpoints on load:\n";
5885         BREAK_ON_LOAD: for my $filename ( keys %break_on_load ) {
5886             print {$OUT} " $filename\n";
5887             last BREAK_ON_LOAD if $signal;
5888         }
5889     } ## end if (%break_on_load and...
5890
5891     if ($watch_wanted and ( $trace & 2 )) {
5892         print {$OUT} "Watch-expressions:\n" if @to_watch;
5893         TO_WATCH: for my $expr (@to_watch) {
5894             print {$OUT} " $expr\n";
5895             last TO_WATCH if $signal;
5896         }
5897     }
5898
5899     return;
5900 } ## end sub cmd_L
5901
5902 =head3 C<cmd_M> - list modules (command)
5903
5904 Just call C<list_modules>.
5905
5906 =cut
5907
5908 sub cmd_M {
5909     list_modules();
5910
5911     return;
5912 }
5913
5914 =head3 C<cmd_o> - options (command)
5915
5916 If this is just C<o> by itself, we list the current settings via
5917 C<dump_option>. If there's a nonblank value following it, we pass that on to
5918 C<parse_options> for processing.
5919
5920 =cut
5921
5922 sub cmd_o {
5923     my $cmd = shift;
5924     my $opt = shift || '';    # opt[=val]
5925
5926     # Nonblank. Try to parse and process.
5927     if ( $opt =~ /^(\S.*)/ ) {
5928         parse_options($1);
5929     }
5930
5931     # Blank. List the current option settings.
5932     else {
5933         for (@options) {
5934             dump_option($_);
5935         }
5936     }
5937 } ## end sub cmd_o
5938
5939 =head3 C<cmd_O> - nonexistent in 5.8.x (command)
5940
5941 Advises the user that the O command has been renamed.
5942
5943 =cut
5944
5945 sub cmd_O {
5946     print $OUT "The old O command is now the o command.\n";             # hint
5947     print $OUT "Use 'h' to get current command help synopsis or\n";     #
5948     print $OUT "use 'o CommandSet=pre580' to revert to old usage\n";    #
5949 }
5950
5951 =head3 C<cmd_v> - view window (command)
5952
5953 Uses the C<$preview> variable set in the second C<BEGIN> block (q.v.) to
5954 move back a few lines to list the selected line in context. Uses C<cmd_l>
5955 to do the actual listing after figuring out the range of line to request.
5956
5957 =cut
5958
5959 use vars qw($preview);
5960
5961 sub cmd_v {
5962     my $cmd  = shift;
5963     my $line = shift;
5964
5965     # Extract the line to list around. (Astute readers will have noted that
5966     # this pattern will match whether or not a numeric line is specified,
5967     # which means that we'll always enter this loop (though a non-numeric
5968     # argument results in no action at all)).
5969     if ( $line =~ /^(\d*)$/ ) {
5970
5971         # Total number of lines to list (a windowful).
5972         $incr = $window - 1;
5973
5974         # Set the start to the argument given (if there was one).
5975         $start = $1 if $1;
5976
5977         # Back up by the context amount.
5978         $start -= $preview;
5979
5980         # Put together a linespec that cmd_l will like.
5981         $line = $start . '-' . ( $start + $incr );
5982
5983         # List the lines.
5984         cmd_l( 'l', $line );
5985     } ## end if ($line =~ /^(\d*)$/)
5986 } ## end sub cmd_v
5987
5988 =head3 C<cmd_w> - add a watch expression (command)
5989
5990 The 5.8 version of this command adds a watch expression if one is specified;
5991 it does nothing if entered with no operands.
5992
5993 We extract the expression, save it, evaluate it in the user's context, and
5994 save the value. We'll re-evaluate it each time the debugger passes a line,
5995 and will stop (see the code at the top of the command loop) if the value
5996 of any of the expressions changes.
5997
5998 =cut
5999
6000 sub _add_watch_expr {
6001     my $expr = shift;
6002
6003     # ... save it.
6004     push @to_watch, $expr;
6005
6006     # Parameterize DB::eval and call it to get the expression's value
6007     # in the user's context. This version can handle expressions which
6008     # return a list value.
6009     $evalarg = $expr;
6010     # The &-call is here to ascertain the mutability of @_.
6011     my ($val) = join( ' ', &DB::eval);
6012     $val = ( defined $val ) ? "'$val'" : 'undef';
6013
6014     # Save the current value of the expression.
6015     push @old_watch, $val;
6016
6017     # We are now watching expressions.
6018     $trace |= 2;
6019
6020     return;
6021 }
6022
6023 sub cmd_w {
6024     my $cmd = shift;
6025
6026     # Null expression if no arguments.
6027     my $expr = shift || '';
6028
6029     # If expression is not null ...
6030     if ( $expr =~ /\A\S/ ) {
6031         _add_watch_expr($expr);
6032     } ## end if ($expr =~ /^(\S.*)/)
6033
6034     # You have to give one to get one.
6035     else {
6036         print $OUT "Adding a watch-expression requires an expression\n";  # hint
6037     }
6038
6039     return;
6040 }
6041
6042 =head3 C<cmd_W> - delete watch expressions (command)
6043
6044 This command accepts either a watch expression to be removed from the list
6045 of watch expressions, or C<*> to delete them all.
6046
6047 If C<*> is specified, we simply empty the watch expression list and the
6048 watch expression value list. We also turn off the bit that says we've got
6049 watch expressions.
6050
6051 If an expression (or partial expression) is specified, we pattern-match
6052 through the expressions and remove the ones that match. We also discard
6053 the corresponding values. If no watch expressions are left, we turn off
6054 the I<watching expressions> bit.
6055
6056 =cut
6057
6058 sub cmd_W {
6059     my $cmd  = shift;
6060     my $expr = shift || '';
6061
6062     # Delete them all.
6063     if ( $expr eq '*' ) {
6064
6065         # Not watching now.
6066         $trace &= ~2;
6067
6068         print $OUT "Deleting all watch expressions ...\n";
6069
6070         # And all gone.
6071         @to_watch = @old_watch = ();
6072     }
6073
6074     # Delete one of them.
6075     elsif ( $expr =~ /^(\S.*)/ ) {
6076
6077         # Where we are in the list.
6078         my $i_cnt = 0;
6079
6080         # For each expression ...
6081         foreach (@to_watch) {
6082             my $val = $to_watch[$i_cnt];
6083
6084             # Does this one match the command argument?
6085             if ( $val eq $expr ) {    # =~ m/^\Q$i$/) {
6086                                       # Yes. Turn it off, and its value too.
6087                 splice( @to_watch,  $i_cnt, 1 );
6088                 splice( @old_watch, $i_cnt, 1 );
6089             }
6090             $i_cnt++;
6091         } ## end foreach (@to_watch)
6092
6093         # We don't bother to turn watching off because
6094         #  a) we don't want to stop calling watchfunction() if it exists
6095         #  b) foreach over a null list doesn't do anything anyway
6096
6097     } ## end elsif ($expr =~ /^(\S.*)/)
6098
6099     # No command arguments entered.
6100     else {
6101         print $OUT
6102           "Deleting a watch-expression requires an expression, or '*' for all\n"
6103           ;    # hint
6104     }
6105 } ## end sub cmd_W
6106
6107 ### END of the API section
6108
6109 =head1 SUPPORT ROUTINES
6110
6111 These are general support routines that are used in a number of places
6112 throughout the debugger.
6113
6114 =head2 save
6115
6116 save() saves the user's versions of globals that would mess us up in C<@saved>,
6117 and installs the versions we like better.
6118
6119 =cut
6120
6121 sub save {
6122
6123     # Save eval failure, command failure, extended OS error, output field
6124     # separator, input record separator, output record separator and
6125     # the warning setting.
6126     @saved = ( $@, $!, $^E, $,, $/, $\, $^W );
6127
6128     $,  = "";      # output field separator is null string
6129     $/  = "\n";    # input record separator is newline
6130     $\  = "";      # output record separator is null string
6131     $^W = 0;       # warnings are off
6132 } ## end sub save
6133
6134 =head2 C<print_lineinfo> - show where we are now
6135
6136 print_lineinfo prints whatever it is that it is handed; it prints it to the
6137 C<$LINEINFO> filehandle instead of just printing it to STDOUT. This allows
6138 us to feed line information to a slave editor without messing up the
6139 debugger output.
6140
6141 =cut
6142
6143 sub print_lineinfo {
6144
6145     # Make the terminal sensible if we're not the primary debugger.
6146     resetterm(1) if $LINEINFO eq $OUT and $term_pid != $$;
6147     local $\ = '';
6148     local $, = '';
6149     # $LINEINFO may be undef if $noTTY is set or some other issue.
6150     if ($LINEINFO)
6151     {
6152         print {$LINEINFO} @_;
6153     }
6154 } ## end sub print_lineinfo
6155
6156 =head2 C<postponed_sub>
6157
6158 Handles setting postponed breakpoints in subroutines once they're compiled.
6159 For breakpoints, we use C<DB::find_sub> to locate the source file and line
6160 range for the subroutine, then mark the file as having a breakpoint,
6161 temporarily switch the C<*dbline> glob over to the source file, and then
6162 search the given range of lines to find a breakable line. If we find one,
6163 we set the breakpoint on it, deleting the breakpoint from C<%postponed>.
6164
6165 =cut
6166
6167 # The following takes its argument via $evalarg to preserve current @_
6168
6169 sub postponed_sub {
6170
6171     # Get the subroutine name.
6172     my $subname = shift;
6173
6174     # If this is a 'break +<n> if <condition>' ...
6175     if ( $postponed{$subname} =~ s/^break\s([+-]?\d+)\s+if\s// ) {
6176
6177         # If there's no offset, use '+0'.
6178         my $offset = $1 || 0;
6179
6180         # find_sub's value is 'fullpath-filename:start-stop'. It's
6181         # possible that the filename might have colons in it too.
6182         my ( $file, $i ) = ( find_sub($subname) =~ /^(.*):(\d+)-.*$/ );
6183         if ($i) {
6184
6185             # We got the start line. Add the offset '+<n>' from
6186             # $postponed{subname}.
6187             $i += $offset;
6188
6189             # Switch to the file this sub is in, temporarily.
6190             local *dbline = $main::{ '_<' . $file };
6191
6192             # No warnings, please.
6193             local $^W = 0;    # != 0 is magical below
6194
6195             # This file's got a breakpoint in it.
6196             $had_breakpoints{$file} |= 1;
6197
6198             # Last line in file.
6199             $max = $#dbline;
6200
6201             # Search forward until we hit a breakable line or get to
6202             # the end of the file.
6203             ++$i until $dbline[$i] != 0 or $i >= $max;
6204
6205             # Copy the breakpoint in and delete it from %postponed.
6206             $dbline{$i} = delete $postponed{$subname};
6207         } ## end if ($i)
6208
6209         # find_sub didn't find the sub.
6210         else {
6211             local $\ = '';
6212             print $OUT "Subroutine $subname not found.\n";
6213         }
6214         return;
6215     } ## end if ($postponed{$subname...
6216     elsif ( $postponed{$subname} eq 'compile' ) { $signal = 1 }
6217
6218     #print $OUT "In postponed_sub for '$subname'.\n";
6219 } ## end sub postponed_sub
6220
6221 =head2 C<postponed>
6222
6223 Called after each required file is compiled, but before it is executed;
6224 also called if the name of a just-compiled subroutine is a key of
6225 C<%postponed>. Propagates saved breakpoints (from C<b compile>, C<b load>,
6226 etc.) into the just-compiled code.
6227
6228 If this is a C<require>'d file, the incoming parameter is the glob
6229 C<*{"_<$filename"}>, with C<$filename> the name of the C<require>'d file.
6230
6231 If it's a subroutine, the incoming parameter is the subroutine name.
6232
6233 =cut
6234
6235 sub postponed {
6236
6237     # If there's a break, process it.
6238     if ($ImmediateStop) {
6239
6240         # Right, we've stopped. Turn it off.
6241         $ImmediateStop = 0;
6242
6243         # Enter the command loop when DB::DB gets called.
6244         $signal = 1;
6245     }
6246
6247     # If this is a subroutine, let postponed_sub() deal with it.
6248     if (ref(\$_[0]) ne 'GLOB') {
6249         return postponed_sub(@_);
6250     }
6251
6252     # Not a subroutine. Deal with the file.
6253     local *dbline = shift;
6254     my $filename = $dbline;
6255     $filename =~ s/^_<//;
6256     local $\ = '';
6257     $signal = 1, print $OUT "'$filename' loaded...\n"
6258       if $break_on_load{$filename};
6259     print_lineinfo( ' ' x $stack_depth, "Package $filename.\n" ) if $frame;
6260
6261     # Do we have any breakpoints to put in this file?
6262     return unless $postponed_file{$filename};
6263
6264     # Yes. Mark this file as having breakpoints.
6265     $had_breakpoints{$filename} |= 1;
6266
6267     # "Cannot be done: insufficient magic" - we can't just put the
6268     # breakpoints saved in %postponed_file into %dbline by assigning
6269     # the whole hash; we have to do it one item at a time for the
6270     # breakpoints to be set properly.
6271     #%dbline = %{$postponed_file{$filename}};
6272
6273     # Set the breakpoints, one at a time.
6274     my $key;
6275
6276     for $key ( keys %{ $postponed_file{$filename} } ) {
6277
6278         # Stash the saved breakpoint into the current file's magic line array.
6279         $dbline{$key} = ${ $postponed_file{$filename} }{$key};
6280     }
6281
6282     # This file's been compiled; discard the stored breakpoints.
6283     delete $postponed_file{$filename};
6284
6285 } ## end sub postponed
6286
6287 =head2 C<dumpit>
6288
6289 C<dumpit> is the debugger's wrapper around dumpvar.pl.
6290
6291 It gets a filehandle (to which C<dumpvar.pl>'s output will be directed) and
6292 a reference to a variable (the thing to be dumped) as its input.
6293
6294 The incoming filehandle is selected for output (C<dumpvar.pl> is printing to
6295 the currently-selected filehandle, thank you very much). The current
6296 values of the package globals C<$single> and C<$trace> are backed up in
6297 lexicals, and they are turned off (this keeps the debugger from trying
6298 to single-step through C<dumpvar.pl> (I think.)). C<$frame> is localized to
6299 preserve its current value and it is set to zero to prevent entry/exit
6300 messages from printing, and C<$doret> is localized as well and set to -2 to
6301 prevent return values from being shown.
6302
6303 C<dumpit()> then checks to see if it needs to load C<dumpvar.pl> and
6304 tries to load it (note: if you have a C<dumpvar.pl>  ahead of the
6305 installed version in C<@INC>, yours will be used instead. Possible security
6306 problem?).
6307
6308 It then checks to see if the subroutine C<main::dumpValue> is now defined
6309 it should have been defined by C<dumpvar.pl>). If it has, C<dumpit()>
6310 localizes the globals necessary for things to be sane when C<main::dumpValue()>
6311 is called, and picks up the variable to be dumped from the parameter list.
6312
6313 It checks the package global C<%options> to see if there's a C<dumpDepth>
6314 specified. If not, -1 is assumed; if so, the supplied value gets passed on to
6315 C<dumpvar.pl>. This tells C<dumpvar.pl> where to leave off when dumping a
6316 structure: -1 means dump everything.
6317
6318 C<dumpValue()> is then called if possible; if not, C<dumpit()>just prints a
6319 warning.
6320
6321 In either case, C<$single>, C<$trace>, C<$frame>, and C<$doret> are restored
6322 and we then return to the caller.
6323
6324 =cut
6325
6326 sub dumpit {
6327
6328     # Save the current output filehandle and switch to the one
6329     # passed in as the first parameter.
6330     my $savout = select(shift);
6331
6332     # Save current settings of $single and $trace, and then turn them off.
6333     my $osingle = $single;
6334     my $otrace  = $trace;
6335     $single = $trace = 0;
6336
6337     # XXX Okay, what do $frame and $doret do, again?
6338     local $frame = 0;
6339     local $doret = -2;
6340
6341     # Load dumpvar.pl unless we've already got the sub we need from it.
6342     unless ( defined &main::dumpValue ) {
6343         do 'dumpvar.pl' or die $@;
6344     }
6345
6346     # If the load succeeded (or we already had dumpvalue()), go ahead
6347     # and dump things.
6348     if ( defined &main::dumpValue ) {
6349         local $\ = '';
6350         local $, = '';
6351         local $" = ' ';
6352         my $v = shift;
6353         my $maxdepth = shift || $option{dumpDepth};
6354         $maxdepth = -1 unless defined $maxdepth;    # -1 means infinite depth
6355         main::dumpValue( $v, $maxdepth );
6356     } ## end if (defined &main::dumpValue)
6357
6358     # Oops, couldn't load dumpvar.pl.
6359     else {
6360         local $\ = '';
6361         print $OUT "dumpvar.pl not available.\n";
6362     }
6363
6364     # Reset $single and $trace to their old values.
6365     $single = $osingle;
6366     $trace  = $otrace;
6367
6368     # Restore the old filehandle.
6369     select($savout);
6370 } ## end sub dumpit
6371
6372 =head2 C<print_trace>
6373
6374 C<print_trace>'s job is to print a stack trace. It does this via the
6375 C<dump_trace> routine, which actually does all the ferreting-out of the
6376 stack trace data. C<print_trace> takes care of formatting it nicely and
6377 printing it to the proper filehandle.
6378
6379 Parameters:
6380
6381 =over 4
6382
6383 =item *
6384
6385 The filehandle to print to.
6386
6387 =item *
6388
6389 How many frames to skip before starting trace.
6390
6391 =item *
6392
6393 How many frames to print.
6394
6395 =item *
6396
6397 A flag: if true, print a I<short> trace without filenames, line numbers, or arguments
6398
6399 =back
6400
6401 The original comment below seems to be noting that the traceback may not be
6402 correct if this routine is called in a tied method.
6403
6404 =cut
6405
6406 # Tied method do not create a context, so may get wrong message:
6407
6408 sub print_trace {
6409     local $\ = '';
6410     my $fh = shift;
6411
6412     # If this is going to a slave editor, but we're not the primary
6413     # debugger, reset it first.
6414     resetterm(1)
6415       if $fh        eq $LINEINFO    # slave editor
6416       and $LINEINFO eq $OUT         # normal output
6417       and $term_pid != $$;          # not the primary
6418
6419     # Collect the actual trace information to be formatted.
6420     # This is an array of hashes of subroutine call info.
6421     my @sub = dump_trace( $_[0] + 1, $_[1] );
6422
6423     # Grab the "short report" flag from @_.
6424     my $short = $_[2];              # Print short report, next one for sub name
6425
6426     # Run through the traceback info, format it, and print it.
6427     my $s;
6428     for my $i (0 .. $#sub) {
6429
6430         # Drop out if the user has lost interest and hit control-C.
6431         last if $signal;
6432
6433         # Set the separator so arrays print nice.
6434         local $" = ', ';
6435
6436         # Grab and stringify the arguments if they are there.
6437         my $args =
6438           defined $sub[$i]{args}
6439           ? "(@{ $sub[$i]{args} })"
6440           : '';
6441
6442         # Shorten them up if $maxtrace says they're too long.
6443         $args = ( substr $args, 0, $maxtrace - 3 ) . '...'
6444           if length $args > $maxtrace;
6445
6446         # Get the file name.
6447         my $file = $sub[$i]{file};
6448
6449         # Put in a filename header if short is off.
6450         $file = $file eq '-e' ? $file : "file '$file'" unless $short;
6451
6452         # Get the actual sub's name, and shorten to $maxtrace's requirement.
6453         $s = $sub[$i]{'sub'};
6454         $s = ( substr $s, 0, $maxtrace - 3 ) . '...' if length $s > $maxtrace;
6455
6456         # Short report uses trimmed file and sub names.
6457         if ($short) {
6458             my $sub = @_ >= 4 ? $_[3] : $s;
6459             print $fh "$sub[$i]{context}=$sub$args from $file:$sub[$i]{line}\n";
6460         } ## end if ($short)
6461
6462         # Non-short report includes full names.
6463         else {
6464             print $fh "$sub[$i]{context} = $s$args"
6465               . " called from $file"
6466               . " line $sub[$i]{line}\n";
6467         }
6468     } ## end for my $i (0 .. $#sub)
6469 } ## end sub print_trace
6470
6471 =head2 dump_trace(skip[,count])
6472
6473 Actually collect the traceback information available via C<caller()>. It does
6474 some filtering and cleanup of the data, but mostly it just collects it to
6475 make C<print_trace()>'s job easier.
6476
6477 C<skip> defines the number of stack frames to be skipped, working backwards
6478 from the most current. C<count> determines the total number of frames to
6479 be returned; all of them (well, the first 10^9) are returned if C<count>
6480 is omitted.
6481
6482 This routine returns a list of hashes, from most-recent to least-recent
6483 stack frame. Each has the following keys and values:
6484
6485 =over 4
6486
6487 =item * C<context> - C<.> (null), C<$> (scalar), or C<@> (array)
6488
6489 =item * C<sub> - subroutine name, or C<eval> information
6490
6491 =item * C<args> - undef, or a reference to an array of arguments
6492
6493 =item * C<file> - the file in which this item was defined (if any)
6494
6495 =item * C<line> - the line on which it was defined
6496
6497 =back
6498
6499 =cut
6500
6501 sub _dump_trace_calc_saved_single_arg
6502 {
6503     my ($nothard, $arg) = @_;
6504
6505     my $type;
6506     if ( not defined $arg ) {    # undefined parameter
6507         return "undef";
6508     }
6509
6510     elsif ( $nothard and tied $arg ) {    # tied parameter
6511         return "tied";
6512     }
6513     elsif ( $nothard and $type = ref $arg ) {    # reference
6514         return "ref($type)";
6515     }
6516     else {                                       # can be stringified
6517         local $_ =
6518         "$arg";    # Safe to stringify now - should not call f().
6519
6520         # Backslash any single-quotes or backslashes.
6521         s/([\'\\])/\\$1/g;
6522
6523         # Single-quote it unless it's a number or a colon-separated
6524         # name.
6525         s/(.*)/'$1'/s
6526         unless /^(?: -?[\d.]+ | \*[\w:]* )$/x;
6527
6528         # Turn high-bit characters into meta-whatever.
6529         s/([\200-\377])/sprintf("M-%c",ord($1)&0177)/eg;
6530
6531         # Turn control characters into ^-whatever.
6532         s/([\0-\37\177])/sprintf("^%c",ord($1)^64)/eg;
6533
6534         return $_;
6535     }
6536 }
6537
6538 sub _dump_trace_calc_save_args {
6539     my ($nothard) = @_;
6540
6541     return [
6542         map { _dump_trace_calc_saved_single_arg($nothard, $_) } @args
6543     ];
6544 }
6545
6546 sub dump_trace {
6547
6548     # How many levels to skip.
6549     my $skip = shift;
6550
6551     # How many levels to show. (1e9 is a cheap way of saying "all of them";
6552     # it's unlikely that we'll have more than a billion stack frames. If you
6553     # do, you've got an awfully big machine...)
6554     my $count = shift || 1e9;
6555
6556     # We increment skip because caller(1) is the first level *back* from
6557     # the current one.  Add $skip to the count of frames so we have a
6558     # simple stop criterion, counting from $skip to $count+$skip.
6559     $skip++;
6560     $count += $skip;
6561
6562     # These variables are used to capture output from caller();
6563     my ( $p, $file, $line, $sub, $h, $context );
6564
6565     my ( $e, $r, @sub, $args );
6566
6567     # XXX Okay... why'd we do that?
6568     my $nothard = not $frame & 8;
6569     local $frame = 0;
6570
6571     # Do not want to trace this.
6572     my $otrace = $trace;
6573     $trace = 0;
6574
6575     # Start out at the skip count.
6576     # If we haven't reached the number of frames requested, and caller() is
6577     # still returning something, stay in the loop. (If we pass the requested
6578     # number of stack frames, or we run out - caller() returns nothing - we
6579     # quit.
6580     # Up the stack frame index to go back one more level each time.
6581     for (
6582         my $i = $skip ;
6583         $i < $count
6584         and ( $p, $file, $line, $sub, $h, $context, $e, $r ) = caller($i) ;
6585         $i++
6586     )
6587     {
6588
6589         # Go through the arguments and save them for later.
6590         my $save_args = _dump_trace_calc_save_args($nothard);
6591
6592         # If context is true, this is array (@)context.
6593         # If context is false, this is scalar ($) context.
6594         # If neither, context isn't defined. (This is apparently a 'can't
6595         # happen' trap.)
6596         $context = $context ? '@' : ( defined $context ? "\$" : '.' );
6597
6598         # if the sub has args ($h true), make an anonymous array of the
6599         # dumped args.
6600         $args = $h ? $save_args : undef;
6601
6602         # remove trailing newline-whitespace-semicolon-end of line sequence
6603         # from the eval text, if any.
6604         $e =~ s/\n\s*\;\s*\Z// if $e;
6605
6606         # Escape backslashed single-quotes again if necessary.
6607         $e =~ s/([\\\'])/\\$1/g if $e;
6608
6609         # if the require flag is true, the eval text is from a require.
6610         if ($r) {
6611             $sub = "require '$e'";
6612         }
6613
6614         # if it's false, the eval text is really from an eval.
6615         elsif ( defined $r ) {
6616             $sub = "eval '$e'";
6617         }
6618
6619         # If the sub is '(eval)', this is a block eval, meaning we don't
6620         # know what the eval'ed text actually was.
6621         elsif ( $sub eq '(eval)' ) {
6622             $sub = "eval {...}";
6623         }
6624
6625         # Stick the collected information into @sub as an anonymous hash.
6626         push(
6627             @sub,
6628             {
6629                 context => $context,
6630                 sub     => $sub,
6631                 args    => $args,
6632                 file    => $file,
6633                 line    => $line
6634             }
6635         );
6636
6637         # Stop processing frames if the user hit control-C.
6638         last if $signal;
6639     } ## end for ($i = $skip ; $i < ...
6640
6641     # Restore the trace value again.
6642     $trace = $otrace;
6643     @sub;
6644 } ## end sub dump_trace
6645
6646 =head2 C<action()>
6647
6648 C<action()> takes input provided as the argument to an add-action command,
6649 either pre- or post-, and makes sure it's a complete command. It doesn't do
6650 any fancy parsing; it just keeps reading input until it gets a string
6651 without a trailing backslash.
6652
6653 =cut
6654
6655 sub action {
6656     my $action = shift;
6657
6658     while ( $action =~ s/\\$// ) {
6659
6660         # We have a backslash on the end. Read more.
6661         $action .= gets();
6662     } ## end while ($action =~ s/\\$//)
6663
6664     # Return the assembled action.
6665     $action;
6666 } ## end sub action
6667
6668 =head2 unbalanced
6669
6670 This routine mostly just packages up a regular expression to be used
6671 to check that the thing it's being matched against has properly-matched
6672 curly braces.
6673
6674 Of note is the definition of the C<$balanced_brace_re> global via C<||=>, which
6675 speeds things up by only creating the qr//'ed expression once; if it's
6676 already defined, we don't try to define it again. A speed hack.
6677
6678 =cut
6679
6680 use vars qw($balanced_brace_re);
6681
6682 sub unbalanced {
6683
6684     # I hate using globals!
6685     $balanced_brace_re ||= qr{
6686         ^ \{
6687              (?:
6688                  (?> [^{}] + )              # Non-parens without backtracking
6689                 |
6690                  (??{ $balanced_brace_re }) # Group with matching parens
6691               ) *
6692           \} $
6693    }x;
6694     return $_[0] !~ m/$balanced_brace_re/;
6695 } ## end sub unbalanced
6696
6697 =head2 C<gets()>
6698
6699 C<gets()> is a primitive (very primitive) routine to read continuations.
6700 It was devised for reading continuations for actions.
6701 it just reads more input with C<readline()> and returns it.
6702
6703 =cut
6704
6705 sub gets {
6706     return DB::readline("cont: ");
6707 }
6708
6709 =head2 C<_db_system()> - handle calls to<system()> without messing up the debugger
6710
6711 The C<system()> function assumes that it can just go ahead and use STDIN and
6712 STDOUT, but under the debugger, we want it to use the debugger's input and
6713 outout filehandles.
6714
6715 C<_db_system()> socks away the program's STDIN and STDOUT, and then substitutes
6716 the debugger's IN and OUT filehandles for them. It does the C<system()> call,
6717 and then puts everything back again.
6718
6719 =cut
6720
6721 sub _db_system {
6722
6723     # We save, change, then restore STDIN and STDOUT to avoid fork() since
6724     # some non-Unix systems can do system() but have problems with fork().
6725     open( SAVEIN,  "<&STDIN" )  || db_warn("Can't save STDIN");
6726     open( SAVEOUT, ">&STDOUT" ) || db_warn("Can't save STDOUT");
6727     open( STDIN,   "<&IN" )     || db_warn("Can't redirect STDIN");
6728     open( STDOUT,  ">&OUT" )    || db_warn("Can't redirect STDOUT");
6729
6730     # XXX: using csh or tcsh destroys sigint retvals!
6731     system(@_);
6732     open( STDIN,  "<&SAVEIN" )  || db_warn("Can't restore STDIN");
6733     open( STDOUT, ">&SAVEOUT" ) || db_warn("Can't restore STDOUT");
6734     close(SAVEIN);
6735     close(SAVEOUT);
6736
6737     # most of the $? crud was coping with broken cshisms
6738     if ( $? >> 8 ) {
6739         db_warn( "(Command exited ", ( $? >> 8 ), ")\n" );
6740     }
6741     elsif ($?) {
6742         db_warn(
6743             "(Command died of SIG#",
6744             ( $? & 127 ),
6745             ( ( $? & 128 ) ? " -- core dumped" : "" ),
6746             ")", "\n"
6747         );
6748     } ## end elsif ($?)
6749
6750     return $?;
6751
6752 } ## end sub system
6753
6754 *system = \&_db_system;
6755
6756 =head1 TTY MANAGEMENT
6757
6758 The subs here do some of the terminal management for multiple debuggers.
6759
6760 =head2 setterm
6761
6762 Top-level function called when we want to set up a new terminal for use
6763 by the debugger.
6764
6765 If the C<noTTY> debugger option was set, we'll either use the terminal
6766 supplied (the value of the C<noTTY> option), or we'll use C<Term::Rendezvous>
6767 to find one. If we're a forked debugger, we call C<resetterm> to try to
6768 get a whole new terminal if we can.
6769
6770 In either case, we set up the terminal next. If the C<ReadLine> option was
6771 true, we'll get a C<Term::ReadLine> object for the current terminal and save
6772 the appropriate attributes. We then
6773
6774 =cut
6775
6776 use vars qw($ornaments);
6777 use vars qw($rl_attribs);
6778
6779 sub setterm {
6780
6781     # Load Term::Readline, but quietly; don't debug it and don't trace it.
6782     local $frame = 0;
6783     local $doret = -2;
6784     require Term::ReadLine;
6785
6786     # If noTTY is set, but we have a TTY name, go ahead and hook up to it.
6787     if ($notty) {
6788         if ($tty) {
6789             my ( $i, $o ) = split $tty, /,/;
6790             $o = $i unless defined $o;
6791             open( IN,  "<$i" ) or die "Cannot open TTY '$i' for read: $!";
6792             open( OUT, ">$o" ) or die "Cannot open TTY '$o' for write: $!";
6793             $IN  = \*IN;
6794             $OUT = \*OUT;
6795             _autoflush($OUT);
6796         } ## end if ($tty)
6797
6798         # We don't have a TTY - try to find one via Term::Rendezvous.
6799         else {
6800             require Term::Rendezvous;
6801
6802             # See if we have anything to pass to Term::Rendezvous.
6803             # Use $HOME/.perldbtty$$ if not.
6804             my $rv = $ENV{PERLDB_NOTTY} || "$ENV{HOME}/.perldbtty$$";
6805
6806             # Rendezvous and get the filehandles.
6807             my $term_rv = Term::Rendezvous->new( $rv );
6808             $IN  = $term_rv->IN;
6809             $OUT = $term_rv->OUT;
6810         } ## end else [ if ($tty)
6811     } ## end if ($notty)
6812
6813     # We're a daughter debugger. Try to fork off another TTY.
6814     if ( $term_pid eq '-1' ) {    # In a TTY with another debugger
6815         resetterm(2);
6816     }
6817
6818     # If we shouldn't use Term::ReadLine, don't.
6819     if ( !$rl ) {
6820         $term = Term::ReadLine::Stub->new( 'perldb', $IN, $OUT );
6821     }
6822
6823     # We're using Term::ReadLine. Get all the attributes for this terminal.
6824     else {
6825         $term = Term::ReadLine->new( 'perldb', $IN, $OUT );
6826
6827         $rl_attribs = $term->Attribs;
6828         $rl_attribs->{basic_word_break_characters} .= '-:+/*,[])}'
6829           if defined $rl_attribs->{basic_word_break_characters}
6830           and index( $rl_attribs->{basic_word_break_characters}, ":" ) == -1;
6831         $rl_attribs->{special_prefixes} = '$@&%';
6832         $rl_attribs->{completer_word_break_characters} .= '$@&%';
6833         $rl_attribs->{completion_function} = \&db_complete;
6834     } ## end else [ if (!$rl)
6835
6836     # Set up the LINEINFO filehandle.
6837     $LINEINFO = $OUT     unless defined $LINEINFO;
6838     $lineinfo = $console unless defined $lineinfo;
6839
6840     $term->MinLine(2);
6841
6842     load_hist();
6843
6844     if ( $term->Features->{setHistory} and "@hist" ne "?" ) {
6845         $term->SetHistory(@hist);
6846     }
6847
6848     # XXX Ornaments are turned on unconditionally, which is not
6849     # always a good thing.
6850     ornaments($ornaments) if defined $ornaments;
6851     $term_pid = $$;
6852 } ## end sub setterm
6853
6854 sub load_hist {
6855     $histfile //= option_val("HistFile", undef);
6856     return unless defined $histfile;
6857     open my $fh, "<", $histfile or return;
6858     local $/ = "\n";
6859     @hist = ();
6860     while (<$fh>) {
6861         chomp;
6862         push @hist, $_;
6863     }
6864     close $fh;
6865 }
6866
6867 sub save_hist {
6868     return unless defined $histfile;
6869     eval { require File::Path } or return;
6870     eval { require File::Basename } or return;
6871     File::Path::mkpath(File::Basename::dirname($histfile));
6872     open my $fh, ">", $histfile or die "Could not open '$histfile': $!";
6873     $histsize //= option_val("HistSize",100);
6874     my @copy = grep { $_ ne '?' } @hist;
6875     my $start = scalar(@copy) > $histsize ? scalar(@copy)-$histsize : 0;
6876     for ($start .. $#copy) {
6877         print $fh "$copy[$_]\n";
6878     }
6879     close $fh or die "Could not write '$histfile': $!";
6880 }
6881
6882 =head1 GET_FORK_TTY EXAMPLE FUNCTIONS
6883
6884 When the process being debugged forks, or the process invokes a command
6885 via C<system()> which starts a new debugger, we need to be able to get a new
6886 C<IN> and C<OUT> filehandle for the new debugger. Otherwise, the two processes
6887 fight over the terminal, and you can never quite be sure who's going to get the
6888 input you're typing.
6889
6890 C<get_fork_TTY> is a glob-aliased function which calls the real function that
6891 is tasked with doing all the necessary operating system mojo to get a new
6892 TTY (and probably another window) and to direct the new debugger to read and
6893 write there.
6894
6895 The debugger provides C<get_fork_TTY> functions which work for TCP
6896 socket servers, X11, OS/2, and Mac OS X. Other systems are not
6897 supported. You are encouraged to write C<get_fork_TTY> functions which
6898 work for I<your> platform and contribute them.
6899
6900 =head3 C<socket_get_fork_TTY>
6901
6902 =cut
6903
6904 sub connect_remoteport {
6905     require IO::Socket;
6906
6907     my $socket = IO::Socket::INET->new(
6908         Timeout  => '10',
6909         PeerAddr => $remoteport,
6910         Proto    => 'tcp',
6911     );
6912     if ( ! $socket ) {
6913         die "Unable to connect to remote host: $remoteport\n";
6914     }
6915     return $socket;
6916 }
6917
6918 sub socket_get_fork_TTY {
6919     $tty = $LINEINFO = $IN = $OUT = connect_remoteport();
6920
6921     # Do I need to worry about setting $term?
6922
6923     reset_IN_OUT( $IN, $OUT );
6924     return '';
6925 }
6926
6927 =head3 C<xterm_get_fork_TTY>
6928
6929 This function provides the C<get_fork_TTY> function for X11. If a
6930 program running under the debugger forks, a new <xterm> window is opened and
6931 the subsidiary debugger is directed there.
6932
6933 The C<open()> call is of particular note here. We have the new C<xterm>
6934 we're spawning route file number 3 to STDOUT, and then execute the C<tty>
6935 command (which prints the device name of the TTY we'll want to use for input
6936 and output to STDOUT, then C<sleep> for a very long time, routing this output
6937 to file number 3. This way we can simply read from the <XT> filehandle (which
6938 is STDOUT from the I<commands> we ran) to get the TTY we want to use.
6939
6940 Only works if C<xterm> is in your path and C<$ENV{DISPLAY}>, etc. are
6941 properly set up.
6942
6943 =cut
6944
6945 sub xterm_get_fork_TTY {
6946     ( my $name = $0 ) =~ s,^.*[/\\],,s;
6947     open XT,
6948 qq[3>&1 xterm -title "Daughter Perl debugger $pids $name" -e sh -c 'tty 1>&3;\
6949  sleep 10000000' |];
6950
6951     # Get the output from 'tty' and clean it up a little.
6952     my $tty = <XT>;
6953     chomp $tty;
6954
6955     $pidprompt = '';    # Shown anyway in titlebar
6956
6957     # We need $term defined or we can not switch to the newly created xterm
6958     if ($tty ne '' && !defined $term) {
6959         require Term::ReadLine;
6960         if ( !$rl ) {
6961             $term = Term::ReadLine::Stub->new( 'perldb', $IN, $OUT );
6962         }
6963         else {
6964             $term = Term::ReadLine->new( 'perldb', $IN, $OUT );
6965         }
6966     }
6967     # There's our new TTY.
6968     return $tty;
6969 } ## end sub xterm_get_fork_TTY
6970
6971 =head3 C<os2_get_fork_TTY>
6972
6973 XXX It behooves an OS/2 expert to write the necessary documentation for this!
6974
6975 =cut
6976
6977 # This example function resets $IN, $OUT itself
6978 my $c_pipe = 0;
6979 sub os2_get_fork_TTY { # A simplification of the following (and works without):
6980     local $\  = '';
6981     ( my $name = $0 ) =~ s,^.*[/\\],,s;
6982     my %opt = ( title => "Daughter Perl debugger $pids $name",
6983         ($rl ? (read_by_key => 1) : ()) );
6984     require OS2::Process;
6985     my ($in, $out, $pid) = eval { OS2::Process::io_term(related => 0, %opt) }
6986       or return;
6987     $pidprompt = '';    # Shown anyway in titlebar
6988     reset_IN_OUT($in, $out);
6989     $tty = '*reset*';
6990     return '';          # Indicate that reset_IN_OUT is called
6991 } ## end sub os2_get_fork_TTY
6992
6993 =head3 C<macosx_get_fork_TTY>
6994
6995 The Mac OS X version uses AppleScript to tell Terminal.app to create
6996 a new window.
6997
6998 =cut
6999
7000 # Notes about Terminal.app's AppleScript support,
7001 # (aka things that might break in future OS versions).
7002 #
7003 # The "do script" command doesn't return a reference to the new window
7004 # it creates, but since it appears frontmost and windows are enumerated
7005 # front to back, we can use "first window" === "window 1".
7006 #
7007 # Since "do script" is implemented by supplying the argument (plus a
7008 # return character) as terminal input, there's a potential race condition
7009 # where the debugger could beat the shell to reading the command.
7010 # To prevent this, we wait for the screen to clear before proceeding.
7011 #
7012 # 10.3 and 10.4:
7013 # There's no direct accessor for the tty device name, so we fiddle
7014 # with the window title options until it says what we want.
7015 #
7016 # 10.5:
7017 # There _is_ a direct accessor for the tty device name, _and_ there's
7018 # a new possible component of the window title (the name of the settings
7019 # set).  A separate version is needed.
7020
7021 my @script_versions=
7022
7023     ([237, <<'__LEOPARD__'],
7024 tell application "Terminal"
7025     do script "clear;exec sleep 100000"
7026     tell first tab of first window
7027         copy tty to thetty
7028         set custom title to "forked perl debugger"
7029         set title displays custom title to true
7030         repeat while (length of first paragraph of (get contents)) > 0
7031             delay 0.1
7032         end repeat
7033     end tell
7034 end tell
7035 thetty
7036 __LEOPARD__
7037
7038      [100, <<'__JAGUAR_TIGER__'],
7039 tell application "Terminal"
7040     do script "clear;exec sleep 100000"
7041     tell first window
7042         set title displays shell path to false
7043         set title displays window size to false
7044         set title displays file name to false
7045         set title displays device name to true
7046         set title displays custom title to true
7047         set custom title to ""
7048         copy "/dev/" & name to thetty
7049         set custom title to "forked perl debugger"
7050         repeat while (length of first paragraph of (get contents)) > 0
7051             delay 0.1
7052         end repeat
7053     end tell
7054 end tell
7055 thetty
7056 __JAGUAR_TIGER__
7057
7058 );
7059
7060 sub macosx_get_fork_TTY
7061 {
7062     my($version,$script,$pipe,$tty);
7063
7064     return unless $version=$ENV{TERM_PROGRAM_VERSION};
7065     foreach my $entry (@script_versions) {
7066         if ($version>=$entry->[0]) {
7067             $script=$entry->[1];
7068             last;
7069         }
7070     }
7071     return unless defined($script);
7072     return unless open($pipe,'-|','/usr/bin/osascript','-e',$script);
7073     $tty=readline($pipe);
7074     close($pipe);
7075     return unless defined($tty) && $tty =~ m(^/dev/);
7076     chomp $tty;
7077     return $tty;
7078 }
7079
7080 =head2 C<create_IN_OUT($flags)>
7081
7082 Create a new pair of filehandles, pointing to a new TTY. If impossible,
7083 try to diagnose why.
7084
7085 Flags are:
7086
7087 =over 4
7088
7089 =item * 1 - Don't know how to create a new TTY.
7090
7091 =item * 2 - Debugger has forked, but we can't get a new TTY.
7092
7093 =item * 4 - standard debugger startup is happening.
7094
7095 =back
7096
7097 =cut
7098
7099 use vars qw($fork_TTY);
7100
7101 sub create_IN_OUT {    # Create a window with IN/OUT handles redirected there
7102
7103     # If we know how to get a new TTY, do it! $in will have
7104     # the TTY name if get_fork_TTY works.
7105     my $in = get_fork_TTY(@_) if defined &get_fork_TTY;
7106
7107     # It used to be that
7108     $in = $fork_TTY if defined $fork_TTY;    # Backward compatibility
7109
7110     if ( not defined $in ) {
7111         my $why = shift;
7112
7113         # We don't know how.
7114         print_help(<<EOP) if $why == 1;
7115 I<#########> Forked, but do not know how to create a new B<TTY>. I<#########>
7116 EOP
7117
7118         # Forked debugger.
7119         print_help(<<EOP) if $why == 2;
7120 I<#########> Daughter session, do not know how to change a B<TTY>. I<#########>
7121   This may be an asynchronous session, so the parent debugger may be active.
7122 EOP
7123
7124         # Note that both debuggers are fighting over the same input.
7125         print_help(<<EOP) if $why != 4;
7126   Since two debuggers fight for the same TTY, input is severely entangled.
7127
7128 EOP
7129         print_help(<<EOP);
7130   I know how to switch the output to a different window in xterms, OS/2
7131   consoles, and Mac OS X Terminal.app only.  For a manual switch, put the name
7132   of the created I<TTY> in B<\$DB::fork_TTY>, or define a function
7133   B<DB::get_fork_TTY()> returning this.
7134
7135   On I<UNIX>-like systems one can get the name of a I<TTY> for the given window
7136   by typing B<tty>, and disconnect the I<shell> from I<TTY> by B<sleep 1000000>.
7137
7138 EOP
7139     } ## end if (not defined $in)
7140     elsif ( $in ne '' ) {
7141         TTY($in);
7142     }
7143     else {
7144         $console = '';    # Indicate no need to open-from-the-console
7145     }
7146     undef $fork_TTY;
7147 } ## end sub create_IN_OUT
7148
7149 =head2 C<resetterm>
7150
7151 Handles rejiggering the prompt when we've forked off a new debugger.
7152
7153 If the new debugger happened because of a C<system()> that invoked a
7154 program under the debugger, the arrow between the old pid and the new
7155 in the prompt has I<two> dashes instead of one.
7156
7157 We take the current list of pids and add this one to the end. If there
7158 isn't any list yet, we make one up out of the initial pid associated with
7159 the terminal and our new pid, sticking an arrow (either one-dashed or
7160 two dashed) in between them.
7161
7162 If C<CreateTTY> is off, or C<resetterm> was called with no arguments,
7163 we don't try to create a new IN and OUT filehandle. Otherwise, we go ahead
7164 and try to do that.
7165
7166 =cut
7167
7168 sub resetterm {    # We forked, so we need a different TTY
7169
7170     # Needs to be passed to create_IN_OUT() as well.
7171     my $in = shift;
7172
7173     # resetterm(2): got in here because of a system() starting a debugger.
7174     # resetterm(1): just forked.
7175     my $systemed = $in > 1 ? '-' : '';
7176
7177     # If there's already a list of pids, add this to the end.
7178     if ($pids) {
7179         $pids =~ s/\]/$systemed->$$]/;
7180     }
7181
7182     # No pid list. Time to make one.
7183     else {
7184         $pids = "[$term_pid->$$]";
7185     }
7186
7187     # The prompt we're going to be using for this debugger.
7188     $pidprompt = $pids;
7189
7190     # We now 0wnz this terminal.
7191     $term_pid = $$;
7192
7193     # Just return if we're not supposed to try to create a new TTY.
7194     return unless $CreateTTY & $in;
7195
7196     # Try to create a new IN/OUT pair.
7197     create_IN_OUT($in);
7198 } ## end sub resetterm
7199
7200 =head2 C<readline>
7201
7202 First, we handle stuff in the typeahead buffer. If there is any, we shift off
7203 the next line, print a message saying we got it, add it to the terminal
7204 history (if possible), and return it.
7205
7206 If there's nothing in the typeahead buffer, check the command filehandle stack.
7207 If there are any filehandles there, read from the last one, and return the line
7208 if we got one. If not, we pop the filehandle off and close it, and try the
7209 next one up the stack.
7210
7211 If we've emptied the filehandle stack, we check to see if we've got a socket
7212 open, and we read that and return it if we do. If we don't, we just call the
7213 core C<readline()> and return its value.
7214
7215 =cut
7216
7217 sub readline {
7218
7219     # Localize to prevent it from being smashed in the program being debugged.
7220     local $.;
7221
7222     # If there are stacked filehandles to read from ...
7223     # (Handle it before the typeahead, because we may call source/etc. from
7224     # the typeahead.)
7225     while (@cmdfhs) {
7226
7227         # Read from the last one in the stack.
7228         my $line = CORE::readline( $cmdfhs[-1] );
7229
7230         # If we got a line ...
7231         defined $line
7232           ? ( print $OUT ">> $line" and return $line )    # Echo and return
7233           : close pop @cmdfhs;                            # Pop and close
7234     } ## end while (@cmdfhs)
7235
7236     # Pull a line out of the typeahead if there's stuff there.
7237     if (@typeahead) {
7238
7239         # How many lines left.
7240         my $left = @typeahead;
7241
7242         # Get the next line.
7243         my $got = shift @typeahead;
7244
7245         # Print a message saying we got input from the typeahead.
7246         local $\ = '';
7247         print $OUT "auto(-$left)", shift, $got, "\n";
7248
7249         # Add it to the terminal history (if possible).
7250         $term->AddHistory($got)
7251           if length($got) > 1
7252           and defined $term->Features->{addHistory};
7253         return $got;
7254     } ## end if (@typeahead)
7255
7256     # We really need to read some input. Turn off entry/exit trace and
7257     # return value printing.
7258     local $frame = 0;
7259     local $doret = -2;
7260
7261     # Nothing on the filehandle stack. Socket?
7262     if ( ref $OUT and UNIVERSAL::isa( $OUT, 'IO::Socket::INET' ) ) {
7263
7264         # Send anything we have to send.
7265         $OUT->write( join( '', @_ ) );
7266
7267         # Receive anything there is to receive.
7268         my $stuff = '';
7269         my $buf;
7270         my $first_time = 1;
7271
7272         while ($first_time or (length($buf) && ($stuff .= $buf) !~ /\n/))
7273         {
7274             $first_time = 0;
7275             $IN->recv( $buf = '', 2048 );   # XXX "what's wrong with sysread?"
7276                                             # XXX Don't know. You tell me.
7277         }
7278
7279         # What we got.
7280         return $stuff;
7281     } ## end if (ref $OUT and UNIVERSAL::isa...
7282
7283     # No socket. Just read from the terminal.