This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
881a9ec0b083c44bd6823fc51029a8bedda0ffaf
[perl5.git] / lib / perl5db.pl
1
2 =head1 NAME
3
4 perl5db.pl - the perl debugger
5
6 =head1 SYNOPSIS
7
8     perl -d  your_Perl_script
9
10 =head1 DESCRIPTION
11
12 C<perl5db.pl> is the perl debugger. It is loaded automatically by Perl when
13 you invoke a script with C<perl -d>. This documentation tries to outline the
14 structure and services provided by C<perl5db.pl>, and to describe how you
15 can use them.
16
17 =head1 GENERAL NOTES
18
19 The debugger can look pretty forbidding to many Perl programmers. There are
20 a number of reasons for this, many stemming out of the debugger's history.
21
22 When the debugger was first written, Perl didn't have a lot of its nicer
23 features - no references, no lexical variables, no closures, no object-oriented
24 programming. So a lot of the things one would normally have done using such
25 features was done using global variables, globs and the C<local()> operator
26 in creative ways.
27
28 Some of these have survived into the current debugger; a few of the more
29 interesting and still-useful idioms are noted in this section, along with notes
30 on the comments themselves.
31
32 =head2 Why not use more lexicals?
33
34 Experienced Perl programmers will note that the debugger code tends to use
35 mostly package globals rather than lexically-scoped variables. This is done
36 to allow a significant amount of control of the debugger from outside the
37 debugger itself.
38
39 Unfortunately, though the variables are accessible, they're not well
40 documented, so it's generally been a decision that hasn't made a lot of
41 difference to most users. Where appropriate, comments have been added to
42 make variables more accessible and usable, with the understanding that these
43 I<are> debugger internals, and are therefore subject to change. Future
44 development should probably attempt to replace the globals with a well-defined
45 API, but for now, the variables are what we've got.
46
47 =head2 Automated variable stacking via C<local()>
48
49 As you may recall from reading C<perlfunc>, the C<local()> operator makes a
50 temporary copy of a variable in the current scope. When the scope ends, the
51 old copy is restored. This is often used in the debugger to handle the
52 automatic stacking of variables during recursive calls:
53
54      sub foo {
55         local $some_global++;
56
57         # Do some stuff, then ...
58         return;
59      }
60
61 What happens is that on entry to the subroutine, C<$some_global> is localized,
62 then altered. When the subroutine returns, Perl automatically undoes the
63 localization, restoring the previous value. Voila, automatic stack management.
64
65 The debugger uses this trick a I<lot>. Of particular note is C<DB::eval>,
66 which lets the debugger get control inside of C<eval>'ed code. The debugger
67 localizes a saved copy of C<$@> inside the subroutine, which allows it to
68 keep C<$@> safe until it C<DB::eval> returns, at which point the previous
69 value of C<$@> is restored. This makes it simple (well, I<simpler>) to keep
70 track of C<$@> inside C<eval>s which C<eval> other C<eval's>.
71
72 In any case, watch for this pattern. It occurs fairly often.
73
74 =head2 The C<^> trick
75
76 This is used to cleverly reverse the sense of a logical test depending on
77 the value of an auxiliary variable. For instance, the debugger's C<S>
78 (search for subroutines by pattern) allows you to negate the pattern
79 like this:
80
81    # Find all non-'foo' subs:
82    S !/foo/
83
84 Boolean algebra states that the truth table for XOR looks like this:
85
86 =over 4
87
88 =item * 0 ^ 0 = 0
89
90 (! not present and no match) --> false, don't print
91
92 =item * 0 ^ 1 = 1
93
94 (! not present and matches) --> true, print
95
96 =item * 1 ^ 0 = 1
97
98 (! present and no match) --> true, print
99
100 =item * 1 ^ 1 = 0
101
102 (! present and matches) --> false, don't print
103
104 =back
105
106 As you can see, the first pair applies when C<!> isn't supplied, and
107 the second pair applies when it is. The XOR simply allows us to
108 compact a more complicated if-then-elseif-else into a more elegant
109 (but perhaps overly clever) single test. After all, it needed this
110 explanation...
111
112 =head2 FLAGS, FLAGS, FLAGS
113
114 There is a certain C programming legacy in the debugger. Some variables,
115 such as C<$single>, C<$trace>, and C<$frame>, have I<magical> values composed
116 of 1, 2, 4, etc. (powers of 2) OR'ed together. This allows several pieces
117 of state to be stored independently in a single scalar.
118
119 A test like
120
121     if ($scalar & 4) ...
122
123 is checking to see if the appropriate bit is on. Since each bit can be
124 "addressed" independently in this way, C<$scalar> is acting sort of like
125 an array of bits. Obviously, since the contents of C<$scalar> are just a
126 bit-pattern, we can save and restore it easily (it will just look like
127 a number).
128
129 The problem, is of course, that this tends to leave magic numbers scattered
130 all over your program whenever a bit is set, cleared, or checked. So why do
131 it?
132
133 =over 4
134
135 =item *
136
137 First, doing an arithmetical or bitwise operation on a scalar is
138 just about the fastest thing you can do in Perl: C<use constant> actually
139 creates a subroutine call, and array and hash lookups are much slower. Is
140 this over-optimization at the expense of readability? Possibly, but the
141 debugger accesses these  variables a I<lot>. Any rewrite of the code will
142 probably have to benchmark alternate implementations and see which is the
143 best balance of readability and speed, and then document how it actually
144 works.
145
146 =item *
147
148 Second, it's very easy to serialize a scalar number. This is done in
149 the restart code; the debugger state variables are saved in C<%ENV> and then
150 restored when the debugger is restarted. Having them be just numbers makes
151 this trivial.
152
153 =item *
154
155 Third, some of these variables are being shared with the Perl core
156 smack in the middle of the interpreter's execution loop. It's much faster for
157 a C program (like the interpreter) to check a bit in a scalar than to access
158 several different variables (or a Perl array).
159
160 =back
161
162 =head2 What are those C<XXX> comments for?
163
164 Any comment containing C<XXX> means that the comment is either somewhat
165 speculative - it's not exactly clear what a given variable or chunk of
166 code is doing, or that it is incomplete - the basics may be clear, but the
167 subtleties are not completely documented.
168
169 Send in a patch if you can clear up, fill out, or clarify an C<XXX>.
170
171 =head1 DATA STRUCTURES MAINTAINED BY CORE
172
173 There are a number of special data structures provided to the debugger by
174 the Perl interpreter.
175
176 The array C<@{$main::{'_<'.$filename}}> (aliased locally to C<@dbline>
177 via glob assignment) contains the text from C<$filename>, with each
178 element corresponding to a single line of C<$filename>. Additionally,
179 breakable lines will be dualvars with the numeric component being the
180 memory address of a COP node. Non-breakable lines are dualvar to 0.
181
182 The hash C<%{'_<'.$filename}> (aliased locally to C<%dbline> via glob
183 assignment) contains breakpoints and actions.  The keys are line numbers;
184 you can set individual values, but not the whole hash. The Perl interpreter
185 uses this hash to determine where breakpoints have been set. Any true value is
186 considered to be a breakpoint; C<perl5db.pl> uses C<$break_condition\0$action>.
187 Values are magical in numeric context: 1 if the line is breakable, 0 if not.
188
189 The scalar C<${"_<$filename"}> simply contains the string C<$filename>.
190 This is also the case for evaluated strings that contain subroutines, or
191 which are currently being executed.  The $filename for C<eval>ed strings looks
192 like C<(eval 34).
193
194 =head1 DEBUGGER STARTUP
195
196 When C<perl5db.pl> starts, it reads an rcfile (C<perl5db.ini> for
197 non-interactive sessions, C<.perldb> for interactive ones) that can set a number
198 of options. In addition, this file may define a subroutine C<&afterinit>
199 that will be executed (in the debugger's context) after the debugger has
200 initialized itself.
201
202 Next, it checks the C<PERLDB_OPTS> environment variable and treats its
203 contents as the argument of a C<o> command in the debugger.
204
205 =head2 STARTUP-ONLY OPTIONS
206
207 The following options can only be specified at startup.
208 To set them in your rcfile, add a call to
209 C<&parse_options("optionName=new_value")>.
210
211 =over 4
212
213 =item * TTY
214
215 the TTY to use for debugging i/o.
216
217 =item * noTTY
218
219 if set, goes in NonStop mode.  On interrupt, if TTY is not set,
220 uses the value of noTTY or F<$HOME/.perldbtty$$> to find TTY using
221 Term::Rendezvous.  Current variant is to have the name of TTY in this
222 file.
223
224 =item * ReadLine
225
226 if false, a dummy ReadLine is used, so you can debug
227 ReadLine applications.
228
229 =item * NonStop
230
231 if true, no i/o is performed until interrupt.
232
233 =item * LineInfo
234
235 file or pipe to print line number info to.  If it is a
236 pipe, a short "emacs like" message is used.
237
238 =item * RemotePort
239
240 host:port to connect to on remote host for remote debugging.
241
242 =item * HistFile
243
244 file to store session history to. There is no default and so no
245 history file is written unless this variable is explicitly set.
246
247 =item * HistSize
248
249 number of commands to store to the file specified in C<HistFile>.
250 Default is 100.
251
252 =back
253
254 =head3 SAMPLE RCFILE
255
256  &parse_options("NonStop=1 LineInfo=db.out");
257   sub afterinit { $trace = 1; }
258
259 The script will run without human intervention, putting trace
260 information into C<db.out>.  (If you interrupt it, you had better
261 reset C<LineInfo> to something I<interactive>!)
262
263 =head1 INTERNALS DESCRIPTION
264
265 =head2 DEBUGGER INTERFACE VARIABLES
266
267 Perl supplies the values for C<%sub>.  It effectively inserts
268 a C<&DB::DB();> in front of each place that can have a
269 breakpoint. At each subroutine call, it calls C<&DB::sub> with
270 C<$DB::sub> set to the called subroutine. It also inserts a C<BEGIN
271 {require 'perl5db.pl'}> before the first line.
272
273 After each C<require>d file is compiled, but before it is executed, a
274 call to C<&DB::postponed($main::{'_<'.$filename})> is done. C<$filename>
275 is the expanded name of the C<require>d file (as found via C<%INC>).
276
277 =head3 IMPORTANT INTERNAL VARIABLES
278
279 =head4 C<$CreateTTY>
280
281 Used to control when the debugger will attempt to acquire another TTY to be
282 used for input.
283
284 =over
285
286 =item * 1 -  on C<fork()>
287
288 =item * 2 - debugger is started inside debugger
289
290 =item * 4 -  on startup
291
292 =back
293
294 =head4 C<$doret>
295
296 The value -2 indicates that no return value should be printed.
297 Any other positive value causes C<DB::sub> to print return values.
298
299 =head4 C<$evalarg>
300
301 The item to be eval'ed by C<DB::eval>. Used to prevent messing with the current
302 contents of C<@_> when C<DB::eval> is called.
303
304 =head4 C<$frame>
305
306 Determines what messages (if any) will get printed when a subroutine (or eval)
307 is entered or exited.
308
309 =over 4
310
311 =item * 0 -  No enter/exit messages
312
313 =item * 1 - Print I<entering> messages on subroutine entry
314
315 =item * 2 - Adds exit messages on subroutine exit. If no other flag is on, acts like 1+2.
316
317 =item * 4 - Extended messages: C<< <in|out> I<context>=I<fully-qualified sub name> from I<file>:I<line> >>. If no other flag is on, acts like 1+4.
318
319 =item * 8 - Adds parameter information to messages, and overloaded stringify and tied FETCH is enabled on the printed arguments. Ignored if C<4> is not on.
320
321 =item * 16 - Adds C<I<context> return from I<subname>: I<value>> messages on subroutine/eval exit. Ignored if C<4> is 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.40';
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, and have actions
1366   PERLDB_VISITED   - files that had breakpoints
1367   PERLDB_FILE_...  - breakpoints for a file
1368   PERLDB_OPT       - active options
1369   PERLDB_INC       - the original @INC
1370   PERLDB_PRETYPE   - preprompt debugger actions
1371   PERLDB_PRE       - preprompt Perl code
1372   PERLDB_POST      - post-prompt Perl code
1373   PERLDB_TYPEAHEAD - typeahead captured by readline()
1374
1375 We chug through all these variables and plug the values saved in them
1376 back into the appropriate spots in the debugger.
1377
1378 =cut
1379
1380 use vars qw(%postponed_file @typeahead);
1381
1382 our (@hist, @truehist);
1383
1384 sub _restore_shared_globals_after_restart
1385 {
1386     @hist          = get_list('PERLDB_HIST');
1387     %break_on_load = get_list("PERLDB_ON_LOAD");
1388     %postponed     = get_list("PERLDB_POSTPONE");
1389
1390     share(@hist);
1391     share(@truehist);
1392     share(%break_on_load);
1393     share(%postponed);
1394 }
1395
1396 sub _restore_breakpoints_and_actions {
1397
1398     my @had_breakpoints = get_list("PERLDB_VISITED");
1399
1400     for my $file_idx ( 0 .. $#had_breakpoints ) {
1401         my $filename = $had_breakpoints[$file_idx];
1402         my %pf = get_list("PERLDB_FILE_$file_idx");
1403         $postponed_file{ $filename } = \%pf if %pf;
1404         my @lines = sort {$a <=> $b} keys(%pf);
1405         my @enabled_statuses = get_list("PERLDB_FILE_ENABLED_$file_idx");
1406         for my $line_idx (0 .. $#lines) {
1407             _set_breakpoint_enabled_status(
1408                 $filename,
1409                 $lines[$line_idx],
1410                 ($enabled_statuses[$line_idx] ? 1 : ''),
1411             );
1412         }
1413     }
1414
1415     return;
1416 }
1417
1418 sub _restore_options_after_restart
1419 {
1420     my %options_map = get_list("PERLDB_OPT");
1421
1422     while ( my ( $opt, $val ) = each %options_map ) {
1423         $val =~ s/[\\\']/\\$1/g;
1424         parse_options("$opt'$val'");
1425     }
1426
1427     return;
1428 }
1429
1430 sub _restore_globals_after_restart
1431 {
1432     # restore original @INC
1433     @INC     = get_list("PERLDB_INC");
1434     @ini_INC = @INC;
1435
1436     # return pre/postprompt actions and typeahead buffer
1437     $pretype   = [ get_list("PERLDB_PRETYPE") ];
1438     $pre       = [ get_list("PERLDB_PRE") ];
1439     $post      = [ get_list("PERLDB_POST") ];
1440     @typeahead = get_list( "PERLDB_TYPEAHEAD", @typeahead );
1441
1442     return;
1443 }
1444
1445
1446 if ( exists $ENV{PERLDB_RESTART} ) {
1447
1448     # We're restarting, so we don't need the flag that says to restart anymore.
1449     delete $ENV{PERLDB_RESTART};
1450
1451     # $restart = 1;
1452     _restore_shared_globals_after_restart();
1453
1454     _restore_breakpoints_and_actions();
1455
1456     # restore options
1457     _restore_options_after_restart();
1458
1459     _restore_globals_after_restart();
1460 } ## end if (exists $ENV{PERLDB_RESTART...
1461
1462 =head2 SETTING UP THE TERMINAL
1463
1464 Now, we'll decide how the debugger is going to interact with the user.
1465 If there's no TTY, we set the debugger to run non-stop; there's not going
1466 to be anyone there to enter commands.
1467
1468 =cut
1469
1470 use vars qw($notty $console $tty $LINEINFO);
1471 use vars qw($lineinfo $doccmd);
1472
1473 our ($runnonstop);
1474
1475 # Local autoflush to avoid rt#116769,
1476 # as calling IO::File methods causes an unresolvable loop
1477 # that results in debugger failure.
1478 sub _autoflush {
1479     my $o = select($_[0]);
1480     $|++;
1481     select($o);
1482 }
1483
1484 if ($notty) {
1485     $runnonstop = 1;
1486     share($runnonstop);
1487 }
1488
1489 =pod
1490
1491 If there is a TTY, we have to determine who it belongs to before we can
1492 proceed. If this is a slave editor or graphical debugger (denoted by
1493 the first command-line switch being '-emacs'), we shift this off and
1494 set C<$rl> to 0 (XXX ostensibly to do straight reads).
1495
1496 =cut
1497
1498 else {
1499
1500     # Is Perl being run from a slave editor or graphical debugger?
1501     # If so, don't use readline, and set $slave_editor = 1.
1502     if ($slave_editor = ( @main::ARGV && ( $main::ARGV[0] eq '-emacs' ) )) {
1503         $rl = 0;
1504         shift(@main::ARGV);
1505     }
1506
1507     #require Term::ReadLine;
1508
1509 =pod
1510
1511 We then determine what the console should be on various systems:
1512
1513 =over 4
1514
1515 =item * Cygwin - We use C<stdin> instead of a separate device.
1516
1517 =cut
1518
1519     if ( $^O eq 'cygwin' ) {
1520
1521         # /dev/tty is binary. use stdin for textmode
1522         undef $console;
1523     }
1524
1525 =item * Unix - use F</dev/tty>.
1526
1527 =cut
1528
1529     elsif ( -e "/dev/tty" ) {
1530         $console = "/dev/tty";
1531     }
1532
1533 =item * Windows or MSDOS - use C<con>.
1534
1535 =cut
1536
1537     elsif ( $^O eq 'dos' or -e "con" or $^O eq 'MSWin32' ) {
1538         $console = "con";
1539     }
1540
1541 =item * VMS - use C<sys$command>.
1542
1543 =cut
1544
1545     else {
1546
1547         # everything else is ...
1548         $console = "sys\$command";
1549     }
1550
1551 =pod
1552
1553 =back
1554
1555 Several other systems don't use a specific console. We C<undef $console>
1556 for those (Windows using a slave editor/graphical debugger, NetWare, OS/2
1557 with a slave editor).
1558
1559 =cut
1560
1561     if ( ( $^O eq 'MSWin32' ) and ( $slave_editor or defined $ENV{EMACS} ) ) {
1562
1563         # /dev/tty is binary. use stdin for textmode
1564         $console = undef;
1565     }
1566
1567     if ( $^O eq 'NetWare' ) {
1568
1569         # /dev/tty is binary. use stdin for textmode
1570         $console = undef;
1571     }
1572
1573     # In OS/2, we need to use STDIN to get textmode too, even though
1574     # it pretty much looks like Unix otherwise.
1575     if ( defined $ENV{OS2_SHELL} and ( $slave_editor or $ENV{WINDOWID} ) )
1576     {    # In OS/2
1577         $console = undef;
1578     }
1579
1580 =pod
1581
1582 If there is a TTY hanging around from a parent, we use that as the console.
1583
1584 =cut
1585
1586     $console = $tty if defined $tty;
1587
1588 =head2 SOCKET HANDLING
1589
1590 The debugger is capable of opening a socket and carrying out a debugging
1591 session over the socket.
1592
1593 If C<RemotePort> was defined in the options, the debugger assumes that it
1594 should try to start a debugging session on that port. It builds the socket
1595 and then tries to connect the input and output filehandles to it.
1596
1597 =cut
1598
1599     # Handle socket stuff.
1600
1601     if ( defined $remoteport ) {
1602
1603         # If RemotePort was defined in the options, connect input and output
1604         # to the socket.
1605         $IN = $OUT = connect_remoteport();
1606     } ## end if (defined $remoteport)
1607
1608 =pod
1609
1610 If no C<RemotePort> was defined, and we want to create a TTY on startup,
1611 this is probably a situation where multiple debuggers are running (for example,
1612 a backticked command that starts up another debugger). We create a new IN and
1613 OUT filehandle, and do the necessary mojo to create a new TTY if we know how
1614 and if we can.
1615
1616 =cut
1617
1618     # Non-socket.
1619     else {
1620
1621         # Two debuggers running (probably a system or a backtick that invokes
1622         # the debugger itself under the running one). create a new IN and OUT
1623         # filehandle, and do the necessary mojo to create a new tty if we
1624         # know how, and we can.
1625         create_IN_OUT(4) if $CreateTTY & 4;
1626         if ($console) {
1627
1628             # If we have a console, check to see if there are separate ins and
1629             # outs to open. (They are assumed identical if not.)
1630
1631             my ( $i, $o ) = split /,/, $console;
1632             $o = $i unless defined $o;
1633
1634             # read/write on in, or just read, or read on STDIN.
1635             open( IN,      "+<$i" )
1636               || open( IN, "<$i" )
1637               || open( IN, "<&STDIN" );
1638
1639             # read/write/create/clobber out, or write/create/clobber out,
1640             # or merge with STDERR, or merge with STDOUT.
1641                  open( OUT, "+>$o" )
1642               || open( OUT, ">$o" )
1643               || open( OUT, ">&STDERR" )
1644               || open( OUT, ">&STDOUT" );    # so we don't dongle stdout
1645
1646         } ## end if ($console)
1647         elsif ( not defined $console ) {
1648
1649             # No console. Open STDIN.
1650             open( IN, "<&STDIN" );
1651
1652             # merge with STDERR, or with STDOUT.
1653             open( OUT,      ">&STDERR" )
1654               || open( OUT, ">&STDOUT" );    # so we don't dongle stdout
1655             $console = 'STDIN/OUT';
1656         } ## end elsif (not defined $console)
1657
1658         # Keep copies of the filehandles so that when the pager runs, it
1659         # can close standard input without clobbering ours.
1660         if ($console or (not defined($console))) {
1661             $IN = \*IN;
1662             $OUT = \*OUT;
1663         }
1664     } ## end elsif (from if(defined $remoteport))
1665
1666     # Unbuffer DB::OUT. We need to see responses right away.
1667     _autoflush($OUT);
1668
1669     # Line info goes to debugger output unless pointed elsewhere.
1670     # Pointing elsewhere makes it possible for slave editors to
1671     # keep track of file and position. We have both a filehandle
1672     # and a I/O description to keep track of.
1673     $LINEINFO = $OUT     unless defined $LINEINFO;
1674     $lineinfo = $console unless defined $lineinfo;
1675     # share($LINEINFO); # <- unable to share globs
1676     share($lineinfo);   #
1677
1678 =pod
1679
1680 To finish initialization, we show the debugger greeting,
1681 and then call the C<afterinit()> subroutine if there is one.
1682
1683 =cut
1684
1685     # Show the debugger greeting.
1686     $header =~ s/.Header: ([^,]+),v(\s+\S+\s+\S+).*$/$1$2/;
1687     unless ($runnonstop) {
1688         local $\ = '';
1689         local $, = '';
1690         if ( $term_pid eq '-1' ) {
1691             print $OUT "\nDaughter DB session started...\n";
1692         }
1693         else {
1694             print $OUT "\nLoading DB routines from $header\n";
1695             print $OUT (
1696                 "Editor support ",
1697                 $slave_editor ? "enabled" : "available", ".\n"
1698             );
1699             print $OUT
1700 "\nEnter h or 'h h' for help, or '$doccmd perldebug' for more help.\n\n";
1701         } ## end else [ if ($term_pid eq '-1')
1702     } ## end unless ($runnonstop)
1703 } ## end else [ if ($notty)
1704
1705 # XXX This looks like a bug to me.
1706 # Why copy to @ARGS and then futz with @args?
1707 @ARGS = @ARGV;
1708 # for (@args) {
1709     # Make sure backslashes before single quotes are stripped out, and
1710     # keep args unless they are numeric (XXX why?)
1711     # s/\'/\\\'/g;                      # removed while not justified understandably
1712     # s/(.*)/'$1'/ unless /^-?[\d.]+$/; # ditto
1713 # }
1714
1715 # If there was an afterinit() sub defined, call it. It will get
1716 # executed in our scope, so it can fiddle with debugger globals.
1717 if ( defined &afterinit ) {    # May be defined in $rcfile
1718     afterinit();
1719 }
1720
1721 # Inform us about "Stack dump during die enabled ..." in dieLevel().
1722 use vars qw($I_m_init);
1723
1724 $I_m_init = 1;
1725
1726 ############################################################ Subroutines
1727
1728 =head1 SUBROUTINES
1729
1730 =head2 DB
1731
1732 This gigantic subroutine is the heart of the debugger. Called before every
1733 statement, its job is to determine if a breakpoint has been reached, and
1734 stop if so; read commands from the user, parse them, and execute
1735 them, and then send execution off to the next statement.
1736
1737 Note that the order in which the commands are processed is very important;
1738 some commands earlier in the loop will actually alter the C<$cmd> variable
1739 to create other commands to be executed later. This is all highly I<optimized>
1740 but can be confusing. Check the comments for each C<$cmd ... && do {}> to
1741 see what's happening in any given command.
1742
1743 =cut
1744
1745 # $cmd cannot be an our() variable unfortunately (possible perl bug?).
1746
1747 use vars qw(
1748     $action
1749     $cmd
1750     $file
1751     $filename_ini
1752     $finished
1753     %had_breakpoints
1754     $level
1755     $max
1756     $package
1757     $try
1758 );
1759
1760 our (
1761     %alias,
1762     $doret,
1763     $end,
1764     $fall_off_end,
1765     $incr,
1766     $laststep,
1767     $rc,
1768     $sh,
1769     $stack_depth,
1770     @stack,
1771     @to_watch,
1772     @old_watch,
1773 );
1774
1775 sub _DB__determine_if_we_should_break
1776 {
1777     # if we have something here, see if we should break.
1778     # $stop is lexical and local to this block - $action on the other hand
1779     # is global.
1780     my $stop;
1781
1782     if ( $dbline{$line}
1783         && _is_breakpoint_enabled($filename, $line)
1784         && (( $stop, $action ) = split( /\0/, $dbline{$line} ) ) )
1785     {
1786
1787         # Stop if the stop criterion says to just stop.
1788         if ( $stop eq '1' ) {
1789             $signal |= 1;
1790         }
1791
1792         # It's a conditional stop; eval it in the user's context and
1793         # see if we should stop. If so, remove the one-time sigil.
1794         elsif ($stop) {
1795             $evalarg = "\$DB::signal |= 1 if do {$stop}";
1796             DB::eval();
1797             # If the breakpoint is temporary, then delete its enabled status.
1798             if ($dbline{$line} =~ s/;9($|\0)/$1/) {
1799                 _cancel_breakpoint_temp_enabled_status($filename, $line);
1800             }
1801         }
1802     } ## end if ($dbline{$line} && ...
1803 }
1804
1805 sub _DB__is_finished {
1806     if ($finished and $level <= 1) {
1807         end_report();
1808         return 1;
1809     }
1810     else {
1811         return;
1812     }
1813 }
1814
1815 sub _DB__read_next_cmd
1816 {
1817     my ($tid) = @_;
1818
1819     # We have a terminal, or can get one ...
1820     if (!$term) {
1821         setterm();
1822     }
1823
1824     # ... and it belongs to this PID or we get one for this PID ...
1825     if ($term_pid != $$) {
1826         resetterm(1);
1827     }
1828
1829     # ... and we got a line of command input ...
1830     $cmd = DB::readline(
1831         "$pidprompt $tid DB"
1832         . ( '<' x $level )
1833         . ( $#hist + 1 )
1834         . ( '>' x $level ) . " "
1835     );
1836
1837     return defined($cmd);
1838 }
1839
1840 sub _DB__trim_command_and_return_first_component {
1841     my ($obj) = @_;
1842
1843     $cmd =~ s/\A\s+//s;    # trim annoying leading whitespace
1844     $cmd =~ s/\s+\z//s;    # trim annoying trailing whitespace
1845
1846     my ($verb, $args) = $cmd =~ m{\A(\S*)\s*(.*)}s;
1847
1848     $obj->cmd_verb($verb);
1849     $obj->cmd_args($args);
1850
1851     return;
1852 }
1853
1854 sub _DB__handle_f_command {
1855     my ($obj) = @_;
1856
1857     if ($file = $obj->cmd_args) {
1858         # help for no arguments (old-style was return from sub).
1859         if ( !$file ) {
1860             print $OUT
1861             "The old f command is now the r command.\n";    # hint
1862             print $OUT "The new f command switches filenames.\n";
1863             next CMD;
1864         } ## end if (!$file)
1865
1866         # if not in magic file list, try a close match.
1867         if ( !defined $main::{ '_<' . $file } ) {
1868             if ( ($try) = grep( m#^_<.*$file#, keys %main:: ) ) {
1869                 {
1870                     $try = substr( $try, 2 );
1871                     print $OUT "Choosing $try matching '$file':\n";
1872                     $file = $try;
1873                 }
1874             } ## end if (($try) = grep(m#^_<.*$file#...
1875         } ## end if (!defined $main::{ ...
1876
1877         # If not successfully switched now, we failed.
1878         if ( !defined $main::{ '_<' . $file } ) {
1879             print $OUT "No file matching '$file' is loaded.\n";
1880             next CMD;
1881         }
1882
1883         # We switched, so switch the debugger internals around.
1884         elsif ( $file ne $filename ) {
1885             *dbline   = $main::{ '_<' . $file };
1886             $max      = $#dbline;
1887             $filename = $file;
1888             $start    = 1;
1889             $cmd      = "l";
1890         } ## end elsif ($file ne $filename)
1891
1892         # We didn't switch; say we didn't.
1893         else {
1894             print $OUT "Already in $file.\n";
1895             next CMD;
1896         }
1897     }
1898
1899     return;
1900 }
1901
1902 sub _DB__handle_dot_command {
1903     my ($obj) = @_;
1904
1905     # . command.
1906     if ($obj->_is_full('.')) {
1907         $incr = -1;    # stay at current line
1908
1909         # Reset everything to the old location.
1910         $start    = $line;
1911         $filename = $filename_ini;
1912         *dbline   = $main::{ '_<' . $filename };
1913         $max      = $#dbline;
1914
1915         # Now where are we?
1916         print_lineinfo($obj->position());
1917         next CMD;
1918     }
1919
1920     return;
1921 }
1922
1923 sub _DB__handle_y_command {
1924     my ($obj) = @_;
1925
1926     if (my ($match_level, $match_vars)
1927         = $obj->cmd_args =~ /\A(?:(\d*)\s*(.*))?\z/) {
1928
1929         # See if we've got the necessary support.
1930         if (!eval { require PadWalker; PadWalker->VERSION(0.08) }) {
1931             my $Err = $@;
1932             _db_warn(
1933                 $Err =~ /locate/
1934                 ? "PadWalker module not found - please install\n"
1935                 : $Err
1936             );
1937             next CMD;
1938         }
1939
1940         # Load up dumpvar if we don't have it. If we can, that is.
1941         do 'dumpvar.pl' || die $@ unless defined &main::dumpvar;
1942         defined &main::dumpvar
1943             or print $OUT "dumpvar.pl not available.\n"
1944             and next CMD;
1945
1946         # Got all the modules we need. Find them and print them.
1947         my @vars = split( ' ', $match_vars || '' );
1948
1949         # Find the pad.
1950         my $h = eval { PadWalker::peek_my( ( $match_level || 0 ) + 1 ) };
1951
1952         # Oops. Can't find it.
1953         if (my $Err = $@) {
1954             $Err =~ s/ at .*//;
1955             _db_warn($Err);
1956             next CMD;
1957         }
1958
1959         # Show the desired vars with dumplex().
1960         my $savout = select($OUT);
1961
1962         # Have dumplex dump the lexicals.
1963         foreach my $key (sort keys %$h) {
1964             dumpvar::dumplex( $key, $h->{$key},
1965                 defined $option{dumpDepth} ? $option{dumpDepth} : -1,
1966                 @vars );
1967         }
1968         select($savout);
1969         next CMD;
1970     }
1971 }
1972
1973 sub _DB__handle_c_command {
1974     my ($obj) = @_;
1975
1976     my $i = $obj->cmd_args;
1977
1978     if ($i =~ m#\A[\w:]*\z#) {
1979
1980         # Hey, show's over. The debugged program finished
1981         # executing already.
1982         next CMD if _DB__is_finished();
1983
1984         # Capture the place to put a one-time break.
1985         $subname = $i;
1986
1987         #  Probably not needed, since we finish an interactive
1988         #  sub-session anyway...
1989         # local $filename = $filename;
1990         # local *dbline = *dbline; # XXX Would this work?!
1991         #
1992         # The above question wonders if localizing the alias
1993         # to the magic array works or not. Since it's commented
1994         # out, we'll just leave that to speculation for now.
1995
1996         # If the "subname" isn't all digits, we'll assume it
1997         # is a subroutine name, and try to find it.
1998         if ( $subname =~ /\D/ ) {    # subroutine name
1999             # Qualify it to the current package unless it's
2000             # already qualified.
2001             $subname = $package . "::" . $subname
2002             unless $subname =~ /::/;
2003
2004             # find_sub will return "file:line_number" corresponding
2005             # to where the subroutine is defined; we call find_sub,
2006             # break up the return value, and assign it in one
2007             # operation.
2008             ( $file, $i ) = ( find_sub($subname) =~ /^(.*):(.*)$/ );
2009
2010             # Force the line number to be numeric.
2011             $i = $i + 0;
2012
2013             # If we got a line number, we found the sub.
2014             if ($i) {
2015
2016                 # Switch all the debugger's internals around so
2017                 # we're actually working with that file.
2018                 $filename = $file;
2019                 *dbline   = $main::{ '_<' . $filename };
2020
2021                 # Mark that there's a breakpoint in this file.
2022                 $had_breakpoints{$filename} |= 1;
2023
2024                 # Scan forward to the first executable line
2025                 # after the 'sub whatever' line.
2026                 $max = $#dbline;
2027                 my $_line_num = $i;
2028                 while ($dbline[$_line_num] == 0 && $_line_num< $max)
2029                 {
2030                     $_line_num++;
2031                 }
2032                 $i = $_line_num;
2033             } ## end if ($i)
2034
2035             # We didn't find a sub by that name.
2036             else {
2037                 print $OUT "Subroutine $subname not found.\n";
2038                 next CMD;
2039             }
2040         } ## end if ($subname =~ /\D/)
2041
2042         # At this point, either the subname was all digits (an
2043         # absolute line-break request) or we've scanned through
2044         # the code following the definition of the sub, looking
2045         # for an executable, which we may or may not have found.
2046         #
2047         # If $i (which we set $subname from) is non-zero, we
2048         # got a request to break at some line somewhere. On
2049         # one hand, if there wasn't any real subroutine name
2050         # involved, this will be a request to break in the current
2051         # file at the specified line, so we have to check to make
2052         # sure that the line specified really is breakable.
2053         #
2054         # On the other hand, if there was a subname supplied, the
2055         # preceding block has moved us to the proper file and
2056         # location within that file, and then scanned forward
2057         # looking for the next executable line. We have to make
2058         # sure that one was found.
2059         #
2060         # On the gripping hand, we can't do anything unless the
2061         # current value of $i points to a valid breakable line.
2062         # Check that.
2063         if ($i) {
2064
2065             # Breakable?
2066             if ( $dbline[$i] == 0 ) {
2067                 print $OUT "Line $i not breakable.\n";
2068                 next CMD;
2069             }
2070
2071             # Yes. Set up the one-time-break sigil.
2072             $dbline{$i} =~ s/($|\0)/;9$1/;  # add one-time-only b.p.
2073             _enable_breakpoint_temp_enabled_status($filename, $i);
2074         } ## end if ($i)
2075
2076         # Turn off stack tracing from here up.
2077         for my $j (0 .. $stack_depth) {
2078             $stack[ $j ] &= ~1;
2079         }
2080         last CMD;
2081     }
2082
2083     return;
2084 }
2085
2086 sub _DB__handle_forward_slash_command {
2087     my ($obj) = @_;
2088
2089     # The pattern as a string.
2090     use vars qw($inpat);
2091
2092     if (($inpat) = $cmd =~ m#\A/(.*)\z#) {
2093
2094         # Remove the final slash.
2095         $inpat =~ s:([^\\])/$:$1:;
2096
2097         # If the pattern isn't null ...
2098         if ( $inpat ne "" ) {
2099
2100             # Turn off warn and die processing for a bit.
2101             local $SIG{__DIE__};
2102             local $SIG{__WARN__};
2103
2104             # Create the pattern.
2105             eval 'no strict q/vars/; $inpat =~ m' . "\a$inpat\a";
2106             if ( $@ ne "" ) {
2107
2108                 # Oops. Bad pattern. No biscuit.
2109                 # Print the eval error and go back for more
2110                 # commands.
2111                 print {$OUT} "$@";
2112                 next CMD;
2113             }
2114             $obj->pat($inpat);
2115         } ## end if ($inpat ne "")
2116
2117         # Set up to stop on wrap-around.
2118         $end = $start;
2119
2120         # Don't move off the current line.
2121         $incr = -1;
2122
2123         my $pat = $obj->pat;
2124
2125         # Done in eval so nothing breaks if the pattern
2126         # does something weird.
2127         eval
2128         {
2129             no strict q/vars/;
2130             for (;;) {
2131                 # Move ahead one line.
2132                 ++$start;
2133
2134                 # Wrap if we pass the last line.
2135                 if ($start > $max) {
2136                     $start = 1;
2137                 }
2138
2139                 # Stop if we have gotten back to this line again,
2140                 last if ($start == $end);
2141
2142                 # A hit! (Note, though, that we are doing
2143                 # case-insensitive matching. Maybe a qr//
2144                 # expression would be better, so the user could
2145                 # do case-sensitive matching if desired.
2146                 if ($dbline[$start] =~ m/$pat/i) {
2147                     if ($slave_editor) {
2148                         # Handle proper escaping in the slave.
2149                         print {$OUT} "\032\032$filename:$start:0\n";
2150                     }
2151                     else {
2152                         # Just print the line normally.
2153                         print {$OUT} "$start:\t",$dbline[$start],"\n";
2154                     }
2155                     # And quit since we found something.
2156                     last;
2157                 }
2158             }
2159         };
2160
2161         if ($@) {
2162             warn $@;
2163         }
2164
2165         # If we wrapped, there never was a match.
2166         if ( $start == $end ) {
2167             print {$OUT} "/$pat/: not found\n";
2168         }
2169         next CMD;
2170     }
2171
2172     return;
2173 }
2174
2175 sub _DB__handle_question_mark_command {
2176     my ($obj) = @_;
2177
2178     # ? - backward pattern search.
2179     if (my ($inpat) = $cmd =~ m#\A\?(.*)\z#) {
2180
2181         # Get the pattern, remove trailing question mark.
2182         $inpat =~ s:([^\\])\?$:$1:;
2183
2184         # If we've got one ...
2185         if ( $inpat ne "" ) {
2186
2187             # Turn off die & warn handlers.
2188             local $SIG{__DIE__};
2189             local $SIG{__WARN__};
2190             eval '$inpat =~ m' . "\a$inpat\a";
2191
2192             if ( $@ ne "" ) {
2193
2194                 # Ouch. Not good. Print the error.
2195                 print $OUT $@;
2196                 next CMD;
2197             }
2198             $obj->pat($inpat);
2199         } ## end if ($inpat ne "")
2200
2201         # Where we are now is where to stop after wraparound.
2202         $end = $start;
2203
2204         # Don't move away from this line.
2205         $incr = -1;
2206
2207         my $pat = $obj->pat;
2208         # Search inside the eval to prevent pattern badness
2209         # from killing us.
2210         eval {
2211             no strict q/vars/;
2212             for (;;) {
2213                 # Back up a line.
2214                 --$start;
2215
2216                 # Wrap if we pass the first line.
2217
2218                 $start = $max if ($start <= 0);
2219
2220                 # Quit if we get back where we started,
2221                 last if ($start == $end);
2222
2223                 # Match?
2224                 if ($dbline[$start] =~ m/$pat/i) {
2225                     if ($slave_editor) {
2226                         # Yep, follow slave editor requirements.
2227                         print $OUT "\032\032$filename:$start:0\n";
2228                     }
2229                     else {
2230                         # Yep, just print normally.
2231                         print $OUT "$start:\t",$dbline[$start],"\n";
2232                     }
2233
2234                     # Found, so done.
2235                     last;
2236                 }
2237             }
2238         };
2239
2240         # Say we failed if the loop never found anything,
2241         if ( $start == $end ) {
2242             print {$OUT} "?$pat?: not found\n";
2243         }
2244         next CMD;
2245     }
2246
2247     return;
2248 }
2249
2250 sub _DB__handle_restart_and_rerun_commands {
2251     my ($obj) = @_;
2252
2253     my $cmd_cmd = $obj->cmd_verb;
2254     my $cmd_params = $obj->cmd_args;
2255     # R - restart execution.
2256     # rerun - controlled restart execution.
2257     if ($cmd_cmd eq 'rerun' or $cmd_params eq '') {
2258         my @args = ($cmd_cmd eq 'R' ? restart() : rerun($cmd_params));
2259
2260         # Close all non-system fds for a clean restart.  A more
2261         # correct method would be to close all fds that were not
2262         # open when the process started, but this seems to be
2263         # hard.  See "debugger 'R'estart and open database
2264         # connections" on p5p.
2265
2266         my $max_fd = 1024; # default if POSIX can't be loaded
2267         if (eval { require POSIX }) {
2268             eval { $max_fd = POSIX::sysconf(POSIX::_SC_OPEN_MAX()) };
2269         }
2270
2271         if (defined $max_fd) {
2272             foreach ($^F+1 .. $max_fd-1) {
2273                 next unless open FD_TO_CLOSE, "<&=$_";
2274                 close(FD_TO_CLOSE);
2275             }
2276         }
2277
2278         # And run Perl again.  We use exec() to keep the
2279         # PID stable (and that way $ini_pids is still valid).
2280         exec(@args) or print {$OUT} "exec failed: $!\n";
2281
2282         last CMD;
2283     }
2284
2285     return;
2286 }
2287
2288 sub _DB__handle_run_command_in_pager_command {
2289     my ($obj) = @_;
2290
2291     if ($cmd =~ m#\A\|\|?\s*[^|]#) {
2292         if ( $pager =~ /^\|/ ) {
2293
2294             # Default pager is into a pipe. Redirect I/O.
2295             open( SAVEOUT, ">&STDOUT" )
2296             || _db_warn("Can't save STDOUT");
2297             open( STDOUT, ">&OUT" )
2298             || _db_warn("Can't redirect STDOUT");
2299         } ## end if ($pager =~ /^\|/)
2300         else {
2301
2302             # Not into a pipe. STDOUT is safe.
2303             open( SAVEOUT, ">&OUT" ) || _db_warn("Can't save DB::OUT");
2304         }
2305
2306         # Fix up environment to record we have less if so.
2307         fix_less();
2308
2309         unless ( $obj->piped(scalar ( open( OUT, $pager ) ) ) ) {
2310
2311             # Couldn't open pipe to pager.
2312             _db_warn("Can't pipe output to '$pager'");
2313             if ( $pager =~ /^\|/ ) {
2314
2315                 # Redirect I/O back again.
2316                 open( OUT, ">&STDOUT" )    # XXX: lost message
2317                 || _db_warn("Can't restore DB::OUT");
2318                 open( STDOUT, ">&SAVEOUT" )
2319                 || _db_warn("Can't restore STDOUT");
2320                 close(SAVEOUT);
2321             } ## end if ($pager =~ /^\|/)
2322             else {
2323
2324                 # Redirect I/O. STDOUT already safe.
2325                 open( OUT, ">&STDOUT" )    # XXX: lost message
2326                 || _db_warn("Can't restore DB::OUT");
2327             }
2328             next CMD;
2329         } ## end unless ($piped = open(OUT,...
2330
2331         # Set up broken-pipe handler if necessary.
2332         $SIG{PIPE} = \&DB::catch
2333         if $pager =~ /^\|/
2334         && ( "" eq $SIG{PIPE} || "DEFAULT" eq $SIG{PIPE} );
2335
2336         _autoflush(\*OUT);
2337         # Save current filehandle, and put it back.
2338         $obj->selected(scalar( select(OUT) ));
2339         # Don't put it back if pager was a pipe.
2340         if ($cmd !~ /\A\|\|/)
2341         {
2342             select($obj->selected());
2343             $obj->selected("");
2344         }
2345
2346         # Trim off the pipe symbols and run the command now.
2347         $cmd =~ s#\A\|+\s*##;
2348         redo PIPE;
2349     }
2350
2351     return;
2352 }
2353
2354 sub _DB__handle_m_command {
2355     my ($obj) = @_;
2356
2357     if ($cmd =~ s#\Am\s+([\w:]+)\s*\z# #) {
2358         methods($1);
2359         next CMD;
2360     }
2361
2362     # m expr - set up DB::eval to do the work
2363     if ($cmd =~ s#\Am\b# #) {    # Rest gets done by DB::eval()
2364         $onetimeDump = 'methods';   #  method output gets used there
2365     }
2366
2367     return;
2368 }
2369
2370 sub _DB__at_end_of_every_command {
2371     my ($obj) = @_;
2372
2373     # At the end of every command:
2374     if ($obj->piped) {
2375
2376         # Unhook the pipe mechanism now.
2377         if ( $pager =~ /^\|/ ) {
2378
2379             # No error from the child.
2380             $? = 0;
2381
2382             # we cannot warn here: the handle is missing --tchrist
2383             close(OUT) || print SAVEOUT "\nCan't close DB::OUT\n";
2384
2385             # most of the $? crud was coping with broken cshisms
2386             # $? is explicitly set to 0, so this never runs.
2387             if ($?) {
2388                 print SAVEOUT "Pager '$pager' failed: ";
2389                 if ( $? == -1 ) {
2390                     print SAVEOUT "shell returned -1\n";
2391                 }
2392                 elsif ( $? >> 8 ) {
2393                     print SAVEOUT ( $? & 127 )
2394                     ? " (SIG#" . ( $? & 127 ) . ")"
2395                     : "", ( $? & 128 ) ? " -- core dumped" : "", "\n";
2396                 }
2397                 else {
2398                     print SAVEOUT "status ", ( $? >> 8 ), "\n";
2399                 }
2400             } ## end if ($?)
2401
2402             # Reopen filehandle for our output (if we can) and
2403             # restore STDOUT (if we can).
2404             open( OUT, ">&STDOUT" ) || _db_warn("Can't restore DB::OUT");
2405             open( STDOUT, ">&SAVEOUT" )
2406             || _db_warn("Can't restore STDOUT");
2407
2408             # Turn off pipe exception handler if necessary.
2409             $SIG{PIPE} = "DEFAULT" if $SIG{PIPE} eq \&DB::catch;
2410
2411             # Will stop ignoring SIGPIPE if done like nohup(1)
2412             # does SIGINT but Perl doesn't give us a choice.
2413         } ## end if ($pager =~ /^\|/)
2414         else {
2415
2416             # Non-piped "pager". Just restore STDOUT.
2417             open( OUT, ">&SAVEOUT" ) || _db_warn("Can't restore DB::OUT");
2418         }
2419
2420         # Close filehandle pager was using, restore the normal one
2421         # if necessary,
2422         close(SAVEOUT);
2423
2424         if ($obj->selected() ne "") {
2425             select($obj->selected);
2426             $obj->selected("");
2427         }
2428
2429         # No pipes now.
2430         $obj->piped("");
2431     } ## end if ($piped)
2432
2433     return;
2434 }
2435
2436 sub _DB__handle_watch_expressions
2437 {
2438     my $self = shift;
2439
2440     if ( $DB::trace & 2 ) {
2441         for my $n (0 .. $#DB::to_watch) {
2442             $DB::evalarg = $DB::to_watch[$n];
2443             local $DB::onetimeDump;    # Tell DB::eval() to not output results
2444
2445             # Fix context DB::eval() wants to return an array, but
2446             # we need a scalar here.
2447             my ($val) = join( "', '", DB::eval(@_) );
2448             $val = ( ( defined $val ) ? "'$val'" : 'undef' );
2449
2450             # Did it change?
2451             if ( $val ne $DB::old_watch[$n] ) {
2452
2453                 # Yep! Show the difference, and fake an interrupt.
2454                 $DB::signal = 1;
2455                 print {$DB::OUT} <<EOP;
2456 Watchpoint $n:\t$DB::to_watch[$n] changed:
2457     old value:\t$DB::old_watch[$n]
2458     new value:\t$val
2459 EOP
2460                 $DB::old_watch[$n] = $val;
2461             } ## end if ($val ne $old_watch...
2462         } ## end for my $n (0 ..
2463     } ## end if ($trace & 2)
2464
2465     return;
2466 }
2467
2468 # 't' is type.
2469 # 'm' is method.
2470 # 'v' is the value (i.e: method name or subroutine ref).
2471 # 's' is subroutine.
2472 my %cmd_lookup =
2473 (
2474     '-' => { t => 'm', v => '_handle_dash_command', },
2475     '.' => { t => 's', v => \&_DB__handle_dot_command, },
2476     '=' => { t => 'm', v => '_handle_equal_sign_command', },
2477     'H' => { t => 'm', v => '_handle_H_command', },
2478     'S' => { t => 'm', v => '_handle_S_command', },
2479     'T' => { t => 'm', v => '_handle_T_command', },
2480     'W' => { t => 'm', v => '_handle_W_command', },
2481     'c' => { t => 's', v => \&_DB__handle_c_command, },
2482     'f' => { t => 's', v => \&_DB__handle_f_command, },
2483     'm' => { t => 's', v => \&_DB__handle_m_command, },
2484     'n' => { t => 'm', v => '_handle_n_command', },
2485     'p' => { t => 'm', v => '_handle_p_command', },
2486     'q' => { t => 'm', v => '_handle_q_command', },
2487     'r' => { t => 'm', v => '_handle_r_command', },
2488     's' => { t => 'm', v => '_handle_s_command', },
2489     'save' => { t => 'm', v => '_handle_save_command', },
2490     'source' => { t => 'm', v => '_handle_source_command', },
2491     't' => { t => 'm', v => '_handle_t_command', },
2492     'w' => { t => 'm', v => '_handle_w_command', },
2493     'x' => { t => 'm', v => '_handle_x_command', },
2494     'y' => { t => 's', v => \&_DB__handle_y_command, },
2495     (map { $_ => { t => 'm', v => '_handle_V_command_and_X_command', }, }
2496         ('X', 'V')),
2497     (map { $_ => { t => 'm', v => '_handle_enable_disable_commands', }, }
2498         qw(enable disable)),
2499     (map { $_ =>
2500         { t => 's', v => \&_DB__handle_restart_and_rerun_commands, },
2501         } qw(R rerun)),
2502     (map { $_ => {t => 'm', v => '_handle_cmd_wrapper_commands' }, }
2503         qw(a A b B e E h i l L M o O v w W)),
2504 );
2505
2506 sub DB {
2507
2508     # lock the debugger and get the thread id for the prompt
2509     lock($DBGR);
2510     my $tid;
2511     my $position;
2512     my ($prefix, $after, $infix);
2513     my $pat;
2514     my $explicit_stop;
2515     my $piped;
2516     my $selected;
2517
2518     if ($ENV{PERL5DB_THREADED}) {
2519         $tid = eval { "[".threads->tid."]" };
2520     }
2521
2522     my $cmd_verb;
2523     my $cmd_args;
2524
2525     my $obj = DB::Obj->new(
2526         {
2527             position => \$position,
2528             prefix => \$prefix,
2529             after => \$after,
2530             explicit_stop => \$explicit_stop,
2531             infix => \$infix,
2532             cmd_args => \$cmd_args,
2533             cmd_verb => \$cmd_verb,
2534             pat => \$pat,
2535             piped => \$piped,
2536             selected => \$selected,
2537         },
2538     );
2539
2540     $obj->_DB_on_init__initialize_globals(@_);
2541
2542     # Preserve current values of $@, $!, $^E, $,, $/, $\, $^W.
2543     # The code being debugged may have altered them.
2544     DB::save();
2545
2546     # Since DB::DB gets called after every line, we can use caller() to
2547     # figure out where we last were executing. Sneaky, eh? This works because
2548     # caller is returning all the extra information when called from the
2549     # debugger.
2550     local ( $package, $filename, $line ) = caller;
2551     $filename_ini = $filename;
2552
2553     # set up the context for DB::eval, so it can properly execute
2554     # code on behalf of the user. We add the package in so that the
2555     # code is eval'ed in the proper package (not in the debugger!).
2556     local $usercontext = _calc_usercontext($package);
2557
2558     # Create an alias to the active file magical array to simplify
2559     # the code here.
2560     local (*dbline) = $main::{ '_<' . $filename };
2561
2562     # Last line in the program.
2563     $max = $#dbline;
2564
2565     _DB__determine_if_we_should_break(@_);
2566
2567     # Preserve the current stop-or-not, and see if any of the W
2568     # (watch expressions) has changed.
2569     my $was_signal = $signal;
2570
2571     # If we have any watch expressions ...
2572     _DB__handle_watch_expressions($obj);
2573
2574 =head2 C<watchfunction()>
2575
2576 C<watchfunction()> is a function that can be defined by the user; it is a
2577 function which will be run on each entry to C<DB::DB>; it gets the
2578 current package, filename, and line as its parameters.
2579
2580 The watchfunction can do anything it likes; it is executing in the
2581 debugger's context, so it has access to all of the debugger's internal
2582 data structures and functions.
2583
2584 C<watchfunction()> can control the debugger's actions. Any of the following
2585 will cause the debugger to return control to the user's program after
2586 C<watchfunction()> executes:
2587
2588 =over 4
2589
2590 =item *
2591
2592 Returning a false value from the C<watchfunction()> itself.
2593
2594 =item *
2595
2596 Altering C<$single> to a false value.
2597
2598 =item *
2599
2600 Altering C<$signal> to a false value.
2601
2602 =item *
2603
2604 Turning off the C<4> bit in C<$trace> (this also disables the
2605 check for C<watchfunction()>. This can be done with
2606
2607     $trace &= ~4;
2608
2609 =back
2610
2611 =cut
2612
2613     # If there's a user-defined DB::watchfunction, call it with the
2614     # current package, filename, and line. The function executes in
2615     # the DB:: package.
2616     if ( $trace & 4 ) {    # User-installed watch
2617         return
2618           if watchfunction( $package, $filename, $line )
2619           and not $single
2620           and not $was_signal
2621           and not( $trace & ~4 );
2622     } ## end if ($trace & 4)
2623
2624     # Pick up any alteration to $signal in the watchfunction, and
2625     # turn off the signal now.
2626     $was_signal = $signal;
2627     $signal     = 0;
2628
2629 =head2 GETTING READY TO EXECUTE COMMANDS
2630
2631 The debugger decides to take control if single-step mode is on, the
2632 C<t> command was entered, or the user generated a signal. If the program
2633 has fallen off the end, we set things up so that entering further commands
2634 won't cause trouble, and we say that the program is over.
2635
2636 =cut
2637
2638     # Make sure that we always print if asked for explicitly regardless
2639     # of $trace_to_depth .
2640     $explicit_stop = ($single || $was_signal);
2641
2642     # Check to see if we should grab control ($single true,
2643     # trace set appropriately, or we got a signal).
2644     if ( $explicit_stop || ( $trace & 1 ) ) {
2645         $obj->_DB__grab_control(@_);
2646     } ## end if ($single || ($trace...
2647
2648 =pod
2649
2650 If there's an action to be executed for the line we stopped at, execute it.
2651 If there are any preprompt actions, execute those as well.
2652
2653 =cut
2654
2655     # If there's an action, do it now.
2656     if ($action) {
2657         $evalarg = $action;
2658         DB::eval();
2659     }
2660
2661     # Are we nested another level (e.g., did we evaluate a function
2662     # that had a breakpoint in it at the debugger prompt)?
2663     if ( $single || $was_signal ) {
2664
2665         # Yes, go down a level.
2666         local $level = $level + 1;
2667
2668         # Do any pre-prompt actions.
2669         foreach $evalarg (@$pre) {
2670             DB::eval();
2671         }
2672
2673         # Complain about too much recursion if we passed the limit.
2674         if ($single & 4) {
2675             print $OUT $stack_depth . " levels deep in subroutine calls!\n";
2676         }
2677
2678         # The line we're currently on. Set $incr to -1 to stay here
2679         # until we get a command that tells us to advance.
2680         $start = $line;
2681         $incr  = -1;      # for backward motion.
2682
2683         # Tack preprompt debugger actions ahead of any actual input.
2684         @typeahead = ( @$pretype, @typeahead );
2685
2686 =head2 WHERE ARE WE?
2687
2688 XXX Relocate this section?
2689
2690 The debugger normally shows the line corresponding to the current line of
2691 execution. Sometimes, though, we want to see the next line, or to move elsewhere
2692 in the file. This is done via the C<$incr>, C<$start>, and C<$max> variables.
2693
2694 C<$incr> controls by how many lines the I<current> line should move forward
2695 after a command is executed. If set to -1, this indicates that the I<current>
2696 line shouldn't change.
2697
2698 C<$start> is the I<current> line. It is used for things like knowing where to
2699 move forwards or backwards from when doing an C<L> or C<-> command.
2700
2701 C<$max> tells the debugger where the last line of the current file is. It's
2702 used to terminate loops most often.
2703
2704 =head2 THE COMMAND LOOP
2705
2706 Most of C<DB::DB> is actually a command parsing and dispatch loop. It comes
2707 in two parts:
2708
2709 =over 4
2710
2711 =item *
2712
2713 The outer part of the loop, starting at the C<CMD> label. This loop
2714 reads a command and then executes it.
2715
2716 =item *
2717
2718 The inner part of the loop, starting at the C<PIPE> label. This part
2719 is wholly contained inside the C<CMD> block and only executes a command.
2720 Used to handle commands running inside a pager.
2721
2722 =back
2723
2724 So why have two labels to restart the loop? Because sometimes, it's easier to
2725 have a command I<generate> another command and then re-execute the loop to do
2726 the new command. This is faster, but perhaps a bit more convoluted.
2727
2728 =cut
2729
2730         # The big command dispatch loop. It keeps running until the
2731         # user yields up control again.
2732         #
2733         # If we have a terminal for input, and we get something back
2734         # from readline(), keep on processing.
2735
2736       CMD:
2737         while (_DB__read_next_cmd($tid))
2738         {
2739
2740             share($cmd);
2741             # ... try to execute the input as debugger commands.
2742
2743             # Don't stop running.
2744             $single = 0;
2745
2746             # No signal is active.
2747             $signal = 0;
2748
2749             # Handle continued commands (ending with \):
2750             if ($cmd =~ s/\\\z/\n/) {
2751                 $cmd .= DB::readline("  cont: ");
2752                 redo CMD;
2753             }
2754
2755 =head4 The null command
2756
2757 A newline entered by itself means I<re-execute the last command>. We grab the
2758 command out of C<$laststep> (where it was recorded previously), and copy it
2759 back into C<$cmd> to be executed below. If there wasn't any previous command,
2760 we'll do nothing below (no command will match). If there was, we also save it
2761 in the command history and fall through to allow the command parsing to pick
2762 it up.
2763
2764 =cut
2765
2766             # Empty input means repeat the last command.
2767             if ($cmd eq '') {
2768                 $cmd = $laststep;
2769             }
2770             chomp($cmd);    # get rid of the annoying extra newline
2771             if (length($cmd) >= 2) {
2772                 push( @hist, $cmd );
2773             }
2774             push( @truehist, $cmd );
2775             share(@hist);
2776             share(@truehist);
2777
2778             # This is a restart point for commands that didn't arrive
2779             # via direct user input. It allows us to 'redo PIPE' to
2780             # re-execute command processing without reading a new command.
2781           PIPE: {
2782                 _DB__trim_command_and_return_first_component($obj);
2783
2784 =head3 COMMAND ALIASES
2785
2786 The debugger can create aliases for commands (these are stored in the
2787 C<%alias> hash). Before a command is executed, the command loop looks it up
2788 in the alias hash and substitutes the contents of the alias for the command,
2789 completely replacing it.
2790
2791 =cut
2792
2793                 # See if there's an alias for the command, and set it up if so.
2794                 if ( $alias{$cmd_verb} ) {
2795
2796                     # Squelch signal handling; we want to keep control here
2797                     # if something goes loco during the alias eval.
2798                     local $SIG{__DIE__};
2799                     local $SIG{__WARN__};
2800
2801                     # This is a command, so we eval it in the DEBUGGER's
2802                     # scope! Otherwise, we can't see the special debugger
2803                     # variables, or get to the debugger's subs. (Well, we
2804                     # _could_, but why make it even more complicated?)
2805                     eval "\$cmd =~ $alias{$cmd_verb}";
2806                     if ($@) {
2807                         local $\ = '';
2808                         print $OUT "Couldn't evaluate '$cmd_verb' alias: $@";
2809                         next CMD;
2810                     }
2811                     _DB__trim_command_and_return_first_component($obj);
2812                 } ## end if ($alias{$cmd_verb})
2813
2814 =head3 MAIN-LINE COMMANDS
2815
2816 All of these commands work up to and after the program being debugged has
2817 terminated.
2818
2819 =head4 C<q> - quit
2820
2821 Quit the debugger. This entails setting the C<$fall_off_end> flag, so we don't
2822 try to execute further, cleaning any restart-related stuff out of the
2823 environment, and executing with the last value of C<$?>.
2824
2825 =cut
2826
2827                 # All of these commands were remapped in perl 5.8.0;
2828                 # we send them off to the secondary dispatcher (see below).
2829                 $obj->_handle_special_char_cmd_wrapper_commands;
2830                 _DB__trim_command_and_return_first_component($obj);
2831
2832                 if (my $cmd_rec = $cmd_lookup{$cmd_verb}) {
2833                     my $type = $cmd_rec->{t};
2834                     my $val = $cmd_rec->{v};
2835                     if ($type eq 'm') {
2836                         $obj->$val();
2837                     }
2838                     elsif ($type eq 's') {
2839                         $val->($obj);
2840                     }
2841                 }
2842
2843 =head4 C<t> - trace [n]
2844
2845 Turn tracing on or off. Inverts the appropriate bit in C<$trace> (q.v.).
2846 If level is specified, set C<$trace_to_depth>.
2847
2848 =head4 C<S> - list subroutines matching/not matching a pattern
2849
2850 Walks through C<%sub>, checking to see whether or not to print the name.
2851
2852 =head4 C<X> - list variables in current package
2853
2854 Since the C<V> command actually processes this, just change this to the
2855 appropriate C<V> command and fall through.
2856
2857 =head4 C<V> - list variables
2858
2859 Uses C<dumpvar.pl> to dump out the current values for selected variables.
2860
2861 =head4 C<x> - evaluate and print an expression
2862
2863 Hands the expression off to C<DB::eval>, setting it up to print the value
2864 via C<dumpvar.pl> instead of just printing it directly.
2865
2866 =head4 C<m> - print methods
2867
2868 Just uses C<DB::methods> to determine what methods are available.
2869
2870 =head4 C<f> - switch files
2871
2872 Switch to a different filename.
2873
2874 =head4 C<.> - return to last-executed line.
2875
2876 We set C<$incr> to -1 to indicate that the debugger shouldn't move ahead,
2877 and then we look up the line in the magical C<%dbline> hash.
2878
2879 =head4 C<-> - back one window
2880
2881 We change C<$start> to be one window back; if we go back past the first line,
2882 we set it to be the first line. We ser C<$incr> to put us back at the
2883 currently-executing line, and then put a C<l $start +> (list one window from
2884 C<$start>) in C<$cmd> to be executed later.
2885
2886 =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>>
2887
2888 In Perl 5.8.0, a realignment of the commands was done to fix up a number of
2889 problems, most notably that the default case of several commands destroying
2890 the user's work in setting watchpoints, actions, etc. We wanted, however, to
2891 retain the old commands for those who were used to using them or who preferred
2892 them. At this point, we check for the new commands and call C<cmd_wrapper> to
2893 deal with them instead of processing them in-line.
2894
2895 =head4 C<y> - List lexicals in higher scope
2896
2897 Uses C<PadWalker> to find the lexicals supplied as arguments in a scope
2898 above the current one and then displays then using C<dumpvar.pl>.
2899
2900 =head3 COMMANDS NOT WORKING AFTER PROGRAM ENDS
2901
2902 All of the commands below this point don't work after the program being
2903 debugged has ended. All of them check to see if the program has ended; this
2904 allows the commands to be relocated without worrying about a 'line of
2905 demarcation' above which commands can be entered anytime, and below which
2906 they can't.
2907
2908 =head4 C<n> - single step, but don't trace down into subs
2909
2910 Done by setting C<$single> to 2, which forces subs to execute straight through
2911 when entered (see C<DB::sub>). We also save the C<n> command in C<$laststep>,
2912 so a null command knows what to re-execute.
2913
2914 =head4 C<s> - single-step, entering subs
2915
2916 Sets C<$single> to 1, which causes C<DB::sub> to continue tracing inside
2917 subs. Also saves C<s> as C<$lastcmd>.
2918
2919 =head4 C<c> - run continuously, setting an optional breakpoint
2920
2921 Most of the code for this command is taken up with locating the optional
2922 breakpoint, which is either a subroutine name or a line number. We set
2923 the appropriate one-time-break in C<@dbline> and then turn off single-stepping
2924 in this and all call levels above this one.
2925
2926 =head4 C<r> - return from a subroutine
2927
2928 For C<r> to work properly, the debugger has to stop execution again
2929 immediately after the return is executed. This is done by forcing
2930 single-stepping to be on in the call level above the current one. If
2931 we are printing return values when a C<r> is executed, set C<$doret>
2932 appropriately, and force us out of the command loop.
2933
2934 =head4 C<T> - stack trace
2935
2936 Just calls C<DB::print_trace>.
2937
2938 =head4 C<w> - List window around current line.
2939
2940 Just calls C<DB::cmd_w>.
2941
2942 =head4 C<W> - watch-expression processing.
2943
2944 Just calls C<DB::cmd_W>.
2945
2946 =head4 C</> - search forward for a string in the source
2947
2948 We take the argument and treat it as a pattern. If it turns out to be a
2949 bad one, we return the error we got from trying to C<eval> it and exit.
2950 If not, we create some code to do the search and C<eval> it so it can't
2951 mess us up.
2952
2953 =cut
2954
2955                 _DB__handle_forward_slash_command($obj);
2956
2957 =head4 C<?> - search backward for a string in the source
2958
2959 Same as for C</>, except the loop runs backwards.
2960
2961 =cut
2962
2963                 _DB__handle_question_mark_command($obj);
2964
2965 =head4 C<$rc> - Recall command
2966
2967 Manages the commands in C<@hist> (which is created if C<Term::ReadLine> reports
2968 that the terminal supports history). It finds the command required, puts it
2969 into C<$cmd>, and redoes the loop to execute it.
2970
2971 =cut
2972
2973                 # $rc - recall command.
2974                 $obj->_handle_rc_recall_command;
2975
2976 =head4 C<$sh$sh> - C<system()> command
2977
2978 Calls the C<_db_system()> to handle the command. This keeps the C<STDIN> and
2979 C<STDOUT> from getting messed up.
2980
2981 =cut
2982
2983                 $obj->_handle_sh_command;
2984
2985 =head4 C<$rc I<pattern> $rc> - Search command history
2986
2987 Another command to manipulate C<@hist>: this one searches it with a pattern.
2988 If a command is found, it is placed in C<$cmd> and executed via C<redo>.
2989
2990 =cut
2991
2992                 $obj->_handle_rc_search_history_command;
2993
2994 =head4 C<$sh> - Invoke a shell
2995
2996 Uses C<_db_system()> to invoke a shell.
2997
2998 =cut
2999
3000 =head4 C<$sh I<command>> - Force execution of a command in a shell
3001
3002 Like the above, but the command is passed to the shell. Again, we use
3003 C<_db_system()> to avoid problems with C<STDIN> and C<STDOUT>.
3004
3005 =head4 C<H> - display commands in history
3006
3007 Prints the contents of C<@hist> (if any).
3008
3009 =head4 C<man, doc, perldoc> - look up documentation
3010
3011 Just calls C<runman()> to print the appropriate document.
3012
3013 =cut
3014
3015                 $obj->_handle_doc_command;
3016
3017 =head4 C<p> - print
3018
3019 Builds a C<print EXPR> expression in the C<$cmd>; this will get executed at
3020 the bottom of the loop.
3021
3022 =head4 C<=> - define command alias
3023
3024 Manipulates C<%alias> to add or list command aliases.
3025
3026 =head4 C<source> - read commands from a file.
3027
3028 Opens a lexical filehandle and stacks it on C<@cmdfhs>; C<DB::readline> will
3029 pick it up.
3030
3031 =head4 C<enable> C<disable> - enable or disable breakpoints
3032
3033 This enables or disables breakpoints.
3034
3035 =head4 C<save> - send current history to a file
3036
3037 Takes the complete history, (not the shrunken version you see with C<H>),
3038 and saves it to the given filename, so it can be replayed using C<source>.
3039
3040 Note that all C<^(save|source)>'s are commented out with a view to minimise recursion.
3041
3042 =head4 C<R> - restart
3043
3044 Restart the debugger session.
3045
3046 =head4 C<rerun> - rerun the current session
3047
3048 Return to any given position in the B<true>-history list
3049
3050 =head4 C<|, ||> - pipe output through the pager.
3051
3052 For C<|>, we save C<OUT> (the debugger's output filehandle) and C<STDOUT>
3053 (the program's standard output). For C<||>, we only save C<OUT>. We open a
3054 pipe to the pager (restoring the output filehandles if this fails). If this
3055 is the C<|> command, we also set up a C<SIGPIPE> handler which will simply
3056 set C<$signal>, sending us back into the debugger.
3057
3058 We then trim off the pipe symbols and C<redo> the command loop at the
3059 C<PIPE> label, causing us to evaluate the command in C<$cmd> without
3060 reading another.
3061
3062 =cut
3063
3064                 # || - run command in the pager, with output to DB::OUT.
3065                 _DB__handle_run_command_in_pager_command($obj);
3066
3067 =head3 END OF COMMAND PARSING
3068
3069 Anything left in C<$cmd> at this point is a Perl expression that we want to
3070 evaluate. We'll always evaluate in the user's context, and fully qualify
3071 any variables we might want to address in the C<DB> package.
3072
3073 =cut
3074
3075             }    # PIPE:
3076
3077             # trace an expression
3078             $cmd =~ s/^t\s/\$DB::trace |= 1;\n/;
3079
3080             # Make sure the flag that says "the debugger's running" is
3081             # still on, to make sure we get control again.
3082             $evalarg = "\$^D = \$^D | \$DB::db_stop;\n$cmd";
3083
3084             # Run *our* eval that executes in the caller's context.
3085             DB::eval();
3086
3087             # Turn off the one-time-dump stuff now.
3088             if ($onetimeDump) {
3089                 $onetimeDump      = undef;
3090                 $onetimedumpDepth = undef;
3091             }
3092             elsif ( $term_pid == $$ ) {
3093                 eval { # May run under miniperl, when not available...
3094                     STDOUT->flush();
3095                     STDERR->flush();
3096                 };
3097
3098                 # XXX If this is the master pid, print a newline.
3099                 print {$OUT} "\n";
3100             }
3101         } ## end while (($term || &setterm...
3102
3103 =head3 POST-COMMAND PROCESSING
3104
3105 After each command, we check to see if the command output was piped anywhere.
3106 If so, we go through the necessary code to unhook the pipe and go back to
3107 our standard filehandles for input and output.
3108
3109 =cut
3110
3111         continue {    # CMD:
3112             _DB__at_end_of_every_command($obj);
3113         }    # CMD:
3114
3115 =head3 COMMAND LOOP TERMINATION
3116
3117 When commands have finished executing, we come here. If the user closed the
3118 input filehandle, we turn on C<$fall_off_end> to emulate a C<q> command. We
3119 evaluate any post-prompt items. We restore C<$@>, C<$!>, C<$^E>, C<$,>, C<$/>,
3120 C<$\>, and C<$^W>, and return a null list as expected by the Perl interpreter.
3121 The interpreter will then execute the next line and then return control to us
3122 again.
3123
3124 =cut
3125
3126         # No more commands? Quit.
3127         $fall_off_end = 1 unless defined $cmd;    # Emulate 'q' on EOF
3128
3129         # Evaluate post-prompt commands.
3130         foreach $evalarg (@$post) {
3131             DB::eval();
3132         }
3133     }    # if ($single || $signal)
3134
3135     # Put the user's globals back where you found them.
3136     ( $@, $!, $^E, $,, $/, $\, $^W ) = @saved;
3137     ();
3138 } ## end sub DB
3139
3140 # Because DB::Obj is used above,
3141 #
3142 #   my $obj = DB::Obj->new(
3143 #
3144 # The following package declaration must come before that,
3145 # or else runtime errors will occur with
3146 #
3147 #   PERLDB_OPTS="autotrace nonstop"
3148 #
3149 # ( rt#116771 )
3150 BEGIN {
3151
3152 package DB::Obj;
3153
3154 sub new {
3155     my $class = shift;
3156
3157     my $self = bless {}, $class;
3158
3159     $self->_init(@_);
3160
3161     return $self;
3162 }
3163
3164 sub _init {
3165     my ($self, $args) = @_;
3166
3167     %{$self} = (%$self, %$args);
3168
3169     return;
3170 }
3171
3172 {
3173     no strict 'refs';
3174     foreach my $slot_name (qw(
3175         after explicit_stop infix pat piped position prefix selected cmd_verb
3176         cmd_args
3177         )) {
3178         my $slot = $slot_name;
3179         *{$slot} = sub {
3180             my $self = shift;
3181
3182             if (@_) {
3183                 ${ $self->{$slot} } = shift;
3184             }
3185
3186             return ${ $self->{$slot} };
3187         };
3188
3189         *{"append_to_$slot"} = sub {
3190             my $self = shift;
3191             my $s = shift;
3192
3193             return $self->$slot($self->$slot . $s);
3194         };
3195     }
3196 }
3197
3198 sub _DB_on_init__initialize_globals
3199 {
3200     my $self = shift;
3201
3202     # Check for whether we should be running continuously or not.
3203     # _After_ the perl program is compiled, $single is set to 1:
3204     if ( $single and not $second_time++ ) {
3205
3206         # Options say run non-stop. Run until we get an interrupt.
3207         if ($runnonstop) {    # Disable until signal
3208                 # If there's any call stack in place, turn off single
3209                 # stepping into subs throughout the stack.
3210             for my $i (0 .. $stack_depth) {
3211                 $stack[ $i ] &= ~1;
3212             }
3213
3214             # And we are now no longer in single-step mode.
3215             $single = 0;
3216
3217             # If we simply returned at this point, we wouldn't get
3218             # the trace info. Fall on through.
3219             # return;
3220         } ## end if ($runnonstop)
3221
3222         elsif ($ImmediateStop) {
3223
3224             # We are supposed to stop here; XXX probably a break.
3225             $ImmediateStop = 0;    # We've processed it; turn it off
3226             $signal        = 1;    # Simulate an interrupt to force
3227                                    # us into the command loop
3228         }
3229     } ## end if ($single and not $second_time...
3230
3231     # If we're in single-step mode, or an interrupt (real or fake)
3232     # has occurred, turn off non-stop mode.
3233     $runnonstop = 0 if $single or $signal;
3234
3235     return;
3236 }
3237
3238 sub _my_print_lineinfo
3239 {
3240     my ($self, $i, $incr_pos) = @_;
3241
3242     if ($frame) {
3243         # Print it indented if tracing is on.
3244         DB::print_lineinfo( ' ' x $stack_depth,
3245             "$i:\t$DB::dbline[$i]" . $self->after );
3246     }
3247     else {
3248         DB::depth_print_lineinfo($self->explicit_stop, $incr_pos);
3249     }
3250 }
3251
3252 sub _curr_line {
3253     return $DB::dbline[$line];
3254 }
3255
3256 sub _is_full {
3257     my ($self, $letter) = @_;
3258
3259     return ($DB::cmd eq $letter);
3260 }
3261
3262 sub _DB__grab_control
3263 {
3264     my $self = shift;
3265
3266     # Yes, grab control.
3267     if ($slave_editor) {
3268
3269         # Tell the editor to update its position.
3270         $self->position("\032\032${DB::filename}:$line:0\n");
3271         DB::print_lineinfo($self->position());
3272     }
3273
3274 =pod
3275
3276 Special check: if we're in package C<DB::fake>, we've gone through the
3277 C<END> block at least once. We set up everything so that we can continue
3278 to enter commands and have a valid context to be in.
3279
3280 =cut
3281
3282     elsif ( $DB::package eq 'DB::fake' ) {
3283
3284         # Fallen off the end already.
3285         if (!$DB::term) {
3286             DB::setterm();
3287         }
3288
3289         DB::print_help(<<EOP);
3290 Debugged program terminated.  Use B<q> to quit or B<R> to restart,
3291 use B<o> I<inhibit_exit> to avoid stopping after program termination,
3292 B<h q>, B<h R> or B<h o> to get additional info.
3293 EOP
3294
3295         # Set the DB::eval context appropriately.
3296         $DB::package     = 'main';
3297         $DB::usercontext = DB::_calc_usercontext($DB::package);
3298     } ## end elsif ($package eq 'DB::fake')
3299
3300 =pod
3301
3302 If the program hasn't finished executing, we scan forward to the
3303 next executable line, print that out, build the prompt from the file and line
3304 number information, and print that.
3305
3306 =cut
3307
3308     else {
3309
3310
3311         # Still somewhere in the midst of execution. Set up the
3312         #  debugger prompt.
3313         $DB::sub =~ s/\'/::/;    # Swap Perl 4 package separators (') to
3314                              # Perl 5 ones (sorry, we don't print Klingon
3315                              #module names)
3316
3317         $self->prefix($DB::sub =~ /::/ ? "" : ($DB::package . '::'));
3318         $self->append_to_prefix( "$DB::sub(${DB::filename}:" );
3319         $self->after( $self->_curr_line =~ /\n$/ ? '' : "\n" );
3320
3321         # Break up the prompt if it's really long.
3322         if ( length($self->prefix()) > 30 ) {
3323             $self->position($self->prefix . "$line):\n$line:\t" . $self->_curr_line . $self->after);
3324             $self->prefix("");
3325             $self->infix(":\t");
3326         }
3327         else {
3328             $self->infix("):\t");
3329             $self->position(
3330                 $self->prefix . $line. $self->infix
3331                 . $self->_curr_line . $self->after
3332             );
3333         }
3334
3335         # Print current line info, indenting if necessary.
3336         $self->_my_print_lineinfo($line, $self->position);
3337
3338         my $i;
3339         my $line_i = sub { return $DB::dbline[$i]; };
3340
3341         # Scan forward, stopping at either the end or the next
3342         # unbreakable line.
3343         for ( $i = $line + 1 ; $i <= $DB::max && $line_i->() == 0 ; ++$i )
3344         {    #{ vi
3345
3346             # Drop out on null statements, block closers, and comments.
3347             last if $line_i->() =~ /^\s*[\;\}\#\n]/;
3348
3349             # Drop out if the user interrupted us.
3350             last if $signal;
3351
3352             # Append a newline if the line doesn't have one. Can happen
3353             # in eval'ed text, for instance.
3354             $self->after( $line_i->() =~ /\n$/ ? '' : "\n" );
3355
3356             # Next executable line.
3357             my $incr_pos = $self->prefix . $i . $self->infix . $line_i->()
3358                 . $self->after;
3359             $self->append_to_position($incr_pos);
3360             $self->_my_print_lineinfo($i, $incr_pos);
3361         } ## end for ($i = $line + 1 ; $i...
3362     } ## end else [ if ($slave_editor)
3363
3364     return;
3365 }
3366
3367 sub _handle_t_command {
3368     my $self = shift;
3369
3370     my $levels = $self->cmd_args();
3371
3372     if ((!length($levels)) or ($levels !~ /\D/)) {
3373         $trace ^= 1;
3374         local $\ = '';
3375         $DB::trace_to_depth = $levels ? $stack_depth + $levels : 1E9;
3376         print {$OUT} "Trace = "
3377         . ( ( $trace & 1 )
3378             ? ( $levels ? "on (to level $DB::trace_to_depth)" : "on" )
3379             : "off" ) . "\n";
3380         next CMD;
3381     }
3382
3383     return;
3384 }
3385
3386
3387 sub _handle_S_command {
3388     my $self = shift;
3389
3390     if (my ($print_all_subs, $should_reverse, $Spatt)
3391         = $self->cmd_args =~ /\A((!)?(.+))?\z/) {
3392         # $Spatt is the pattern (if any) to use.
3393         # Reverse scan?
3394         my $Srev     = defined $should_reverse;
3395         # No args - print all subs.
3396         my $Snocheck = !defined $print_all_subs;
3397
3398         # Need to make these sane here.
3399         local $\ = '';
3400         local $, = '';
3401
3402         # Search through the debugger's magical hash of subs.
3403         # If $nocheck is true, just print the sub name.
3404         # Otherwise, check it against the pattern. We then use
3405         # the XOR trick to reverse the condition as required.
3406         foreach $subname ( sort( keys %sub ) ) {
3407             if ( $Snocheck or $Srev ^ ( $subname =~ /$Spatt/ ) ) {
3408                 print $OUT $subname, "\n";
3409             }
3410         }
3411         next CMD;
3412     }
3413
3414     return;
3415 }
3416
3417 sub _handle_V_command_and_X_command {
3418     my $self = shift;
3419
3420     $DB::cmd =~ s/^X\b/V $DB::package/;
3421
3422     # Bare V commands get the currently-being-debugged package
3423     # added.
3424     if ($self->_is_full('V')) {
3425         $DB::cmd = "V $DB::package";
3426     }
3427
3428     # V - show variables in package.
3429     if (my ($new_packname, $new_vars_str) =
3430         $DB::cmd =~ /\AV\b\s*(\S+)\s*(.*)/) {
3431
3432         # Save the currently selected filehandle and
3433         # force output to debugger's filehandle (dumpvar
3434         # just does "print" for output).
3435         my $savout = select($OUT);
3436
3437         # Grab package name and variables to dump.
3438         $packname = $new_packname;
3439         my @vars     = split( ' ', $new_vars_str );
3440
3441         # If main::dumpvar isn't here, get it.
3442         do 'dumpvar.pl' || die $@ unless defined &main::dumpvar;
3443         if ( defined &main::dumpvar ) {
3444
3445             # We got it. Turn off subroutine entry/exit messages
3446             # for the moment, along with return values.
3447             local $frame = 0;
3448             local $doret = -2;
3449
3450             # must detect sigpipe failures  - not catching
3451             # then will cause the debugger to die.
3452             eval {
3453                 main::dumpvar(
3454                     $packname,
3455                     defined $option{dumpDepth}
3456                     ? $option{dumpDepth}
3457                     : -1,    # assume -1 unless specified
3458                     @vars
3459                 );
3460             };
3461
3462             # The die doesn't need to include the $@, because
3463             # it will automatically get propagated for us.
3464             if ($@) {
3465                 die unless $@ =~ /dumpvar print failed/;
3466             }
3467         } ## end if (defined &main::dumpvar)
3468         else {
3469
3470             # Couldn't load dumpvar.
3471             print $OUT "dumpvar.pl not available.\n";
3472         }
3473
3474         # Restore the output filehandle, and go round again.
3475         select($savout);
3476         next CMD;
3477     }
3478
3479     return;
3480 }
3481
3482 sub _handle_dash_command {
3483     my $self = shift;
3484
3485     if ($self->_is_full('-')) {
3486
3487         # back up by a window; go to 1 if back too far.
3488         $start -= $incr + $window + 1;
3489         $start = 1 if $start <= 0;
3490         $incr  = $window - 1;
3491
3492         # Generate and execute a "l +" command (handled below).
3493         $DB::cmd = 'l ' . ($start) . '+';
3494         redo CMD;
3495     }
3496     return;
3497 }
3498
3499 sub _n_or_s_commands_generic {
3500     my ($self, $new_val) = @_;
3501     # n - next
3502     next CMD if DB::_DB__is_finished();
3503
3504     # Single step, but don't enter subs.
3505     $single = $new_val;
3506
3507     # Save for empty command (repeat last).
3508     $laststep = $DB::cmd;
3509     last CMD;
3510 }
3511
3512 sub _n_or_s {
3513     my ($self, $letter, $new_val) = @_;
3514
3515     if ($self->_is_full($letter)) {
3516         $self->_n_or_s_commands_generic($new_val);
3517     }
3518     else {
3519         $self->_n_or_s_and_arg_commands_generic($letter, $new_val);
3520     }
3521
3522     return;
3523 }
3524
3525 sub _handle_n_command {
3526     my $self = shift;
3527
3528     return $self->_n_or_s('n', 2);
3529 }
3530
3531 sub _handle_s_command {
3532     my $self = shift;
3533
3534     return $self->_n_or_s('s', 1);
3535 }
3536
3537 sub _handle_r_command {
3538     my $self = shift;
3539
3540     # r - return from the current subroutine.
3541     if ($self->_is_full('r')) {
3542
3543         # Can't do anything if the program's over.
3544         next CMD if DB::_DB__is_finished();
3545
3546         # Turn on stack trace.
3547         $stack[$stack_depth] |= 1;
3548
3549         # Print return value unless the stack is empty.
3550         $doret = $option{PrintRet} ? $stack_depth - 1 : -2;
3551         last CMD;
3552     }
3553
3554     return;
3555 }
3556
3557 sub _handle_T_command {
3558     my $self = shift;
3559
3560     if ($self->_is_full('T')) {
3561         DB::print_trace( $OUT, 1 );    # skip DB
3562         next CMD;
3563     }
3564
3565     return;
3566 }
3567
3568 sub _handle_w_command {
3569     my $self = shift;
3570
3571     DB::cmd_w( 'w', $self->cmd_args() );
3572     next CMD;
3573
3574     return;
3575 }
3576
3577 sub _handle_W_command {
3578     my $self = shift;
3579
3580     if (my $arg = $self->cmd_args) {
3581         DB::cmd_W( 'W', $arg );
3582         next CMD;
3583     }
3584
3585     return;
3586 }
3587
3588 sub _handle_rc_recall_command {
3589     my $self = shift;
3590
3591     # $rc - recall command.
3592     if (my ($minus, $arg) = $DB::cmd =~ m#\A$rc+\s*(-)?(\d+)?\z#) {
3593
3594         # No arguments, take one thing off history.
3595         pop(@hist) if length($DB::cmd) > 1;
3596
3597         # Relative (- found)?
3598         #  Y - index back from most recent (by 1 if bare minus)
3599         #  N - go to that particular command slot or the last
3600         #      thing if nothing following.
3601
3602         $self->cmd_verb(
3603             scalar($minus ? ( $#hist - ( $arg || 1 ) ) : ( $arg || $#hist ))
3604         );
3605
3606         # Pick out the command desired.
3607         $DB::cmd = $hist[$self->cmd_verb];
3608
3609         # Print the command to be executed and restart the loop
3610         # with that command in the buffer.
3611         print {$OUT} $DB::cmd, "\n";
3612         redo CMD;
3613     }
3614
3615     return;
3616 }
3617
3618 sub _handle_rc_search_history_command {
3619     my $self = shift;
3620
3621     # $rc pattern $rc - find a command in the history.
3622     if (my ($arg) = $DB::cmd =~ /\A$rc([^$rc].*)\z/) {
3623
3624         # Create the pattern to use.
3625         my $pat = "^$arg";
3626         $self->pat($pat);
3627
3628         # Toss off last entry if length is >1 (and it always is).
3629         pop(@hist) if length($DB::cmd) > 1;
3630
3631         my $i;
3632
3633         # Look backward through the history.
3634         SEARCH_HIST:
3635         for ( $i = $#hist ; $i ; --$i ) {
3636             # Stop if we find it.
3637             last SEARCH_HIST if $hist[$i] =~ /$pat/;
3638         }
3639
3640         if ( !$i ) {
3641
3642             # Never found it.
3643             print $OUT "No such command!\n\n";
3644             next CMD;
3645         }
3646
3647         # Found it. Put it in the buffer, print it, and process it.
3648         $DB::cmd = $hist[$i];
3649         print $OUT $DB::cmd, "\n";
3650         redo CMD;
3651     }
3652
3653     return;
3654 }
3655
3656 sub _handle_H_command {
3657     my $self = shift;
3658
3659     if ($self->cmd_args =~ m#\A\*#) {
3660         @hist = @truehist = ();
3661         print $OUT "History cleansed\n";
3662         next CMD;
3663     }
3664
3665     if (my ($num) = $self->cmd_args =~ /\A(?:-(\d+))?/) {
3666
3667         # Anything other than negative numbers is ignored by
3668         # the (incorrect) pattern, so this test does nothing.
3669         $end = $num ? ( $#hist - $num ) : 0;
3670
3671         # Set to the minimum if less than zero.
3672         $hist = 0 if $hist < 0;
3673
3674         # Start at the end of the array.
3675         # Stay in while we're still above the ending value.
3676         # Tick back by one each time around the loop.
3677         my $i;
3678
3679         for ( $i = $#hist ; $i > $end ; $i-- ) {
3680
3681             # Print the command  unless it has no arguments.
3682             print $OUT "$i: ", $hist[$i], "\n"
3683             unless $hist[$i] =~ /^.?$/;
3684         }
3685
3686         next CMD;
3687     }
3688
3689     return;
3690 }
3691
3692 sub _handle_doc_command {
3693     my $self = shift;
3694
3695     # man, perldoc, doc - show manual pages.
3696     if (my ($man_page)
3697         = $DB::cmd =~ /\A(?:man|(?:perl)?doc)\b(?:\s+([^(]*))?\z/) {
3698         DB::runman($man_page);
3699         next CMD;
3700     }
3701
3702     return;
3703 }
3704
3705 sub _handle_p_command {
3706     my $self = shift;
3707
3708     my $print_cmd = 'print {$DB::OUT} ';
3709     # p - print (no args): print $_.
3710     if ($self->_is_full('p')) {
3711         $DB::cmd = $print_cmd . '$_';
3712     }
3713     else {
3714         # p - print the given expression.
3715         $DB::cmd =~ s/\Ap\b/$print_cmd /;
3716     }
3717
3718     return;
3719 }
3720
3721 sub _handle_equal_sign_command {
3722     my $self = shift;
3723
3724     if ($DB::cmd =~ s/\A=\s*//) {
3725         my @keys;
3726         if ( length $DB::cmd == 0 ) {
3727
3728             # No args, get current aliases.
3729             @keys = sort keys %alias;
3730         }
3731         elsif ( my ( $k, $v ) = ( $DB::cmd =~ /^(\S+)\s+(\S.*)/ ) ) {
3732
3733             # Creating a new alias. $k is alias name, $v is
3734             # alias value.
3735
3736             # can't use $_ or kill //g state
3737             for my $x ( $k, $v ) {
3738
3739                 # Escape "alarm" characters.
3740                 $x =~ s/\a/\\a/g;
3741             }
3742
3743             # Substitute key for value, using alarm chars
3744             # as separators (which is why we escaped them in
3745             # the command).
3746             $alias{$k} = "s\a$k\a$v\a";
3747
3748             # Turn off standard warn and die behavior.
3749             local $SIG{__DIE__};
3750             local $SIG{__WARN__};
3751
3752             # Is it valid Perl?
3753             unless ( eval "sub { s\a$k\a$v\a }; 1" ) {
3754
3755                 # Nope. Bad alias. Say so and get out.
3756                 print $OUT "Can't alias $k to $v: $@\n";
3757                 delete $alias{$k};
3758                 next CMD;
3759             }
3760
3761             # We'll only list the new one.
3762             @keys = ($k);
3763         } ## end elsif (my ($k, $v) = ($DB::cmd...
3764
3765         # The argument is the alias to list.
3766         else {
3767             @keys = ($DB::cmd);
3768         }
3769
3770         # List aliases.
3771         for my $k (@keys) {
3772
3773             # Messy metaquoting: Trim the substitution code off.
3774             # We use control-G as the delimiter because it's not
3775             # likely to appear in the alias.
3776             if ( ( my $v = $alias{$k} ) =~ s\as\a$k\a(.*)\a$\a1\a ) {
3777
3778                 # Print the alias.
3779                 print $OUT "$k\t= $1\n";
3780             }
3781             elsif ( defined $alias{$k} ) {
3782
3783                 # Couldn't trim it off; just print the alias code.
3784                 print $OUT "$k\t$alias{$k}\n";
3785             }
3786             else {
3787
3788                 # No such, dude.
3789                 print "No alias for $k\n";
3790             }
3791         } ## end for my $k (@keys)
3792         next CMD;
3793     }
3794
3795     return;
3796 }
3797
3798 sub _handle_source_command {
3799     my $self = shift;
3800
3801     # source - read commands from a file (or pipe!) and execute.
3802     if (my $sourced_fn = $self->cmd_args) {
3803         if ( open my $fh, $sourced_fn ) {
3804
3805             # Opened OK; stick it in the list of file handles.
3806             push @cmdfhs, $fh;
3807         }
3808         else {
3809
3810             # Couldn't open it.
3811             DB::_db_warn("Can't execute '$sourced_fn': $!\n");
3812         }
3813         next CMD;
3814     }
3815
3816     return;
3817 }
3818
3819 sub _handle_enable_disable_commands {
3820     my $self = shift;
3821
3822     my $which_cmd = $self->cmd_verb;
3823     my $position = $self->cmd_args;
3824
3825     if ($position !~ /\s/) {
3826         my ($fn, $line_num);
3827         if ($position =~ m{\A\d+\z})
3828         {
3829             $fn = $DB::filename;
3830             $line_num = $position;
3831         }
3832         elsif (my ($new_fn, $new_line_num)
3833             = $position =~ m{\A(.*):(\d+)\z}) {
3834             ($fn, $line_num) = ($new_fn, $new_line_num);
3835         }
3836         else
3837         {
3838             DB::_db_warn("Wrong spec for enable/disable argument.\n");
3839         }
3840
3841         if (defined($fn)) {
3842             if (DB::_has_breakpoint_data_ref($fn, $line_num)) {
3843                 DB::_set_breakpoint_enabled_status($fn, $line_num,
3844                     ($which_cmd eq 'enable' ? 1 : '')
3845                 );
3846             }
3847             else {
3848                 DB::_db_warn("No breakpoint set at ${fn}:${line_num}\n");
3849             }
3850         }
3851
3852         next CMD;
3853     }
3854
3855     return;
3856 }
3857
3858 sub _handle_save_command {
3859     my $self = shift;
3860
3861     if (my $new_fn = $self->cmd_args) {
3862         my $filename = $new_fn || '.perl5dbrc';    # default?
3863         if ( open my $fh, '>', $filename ) {
3864
3865             # chomp to remove extraneous newlines from source'd files
3866             chomp( my @truelist =
3867                 map { m/\A\s*(save|source)/ ? "#$_" : $_ }
3868                 @truehist );
3869             print {$fh} join( "\n", @truelist );
3870             print "commands saved in $filename\n";
3871         }
3872         else {
3873             DB::_db_warn("Can't save debugger commands in '$new_fn': $!\n");
3874         }
3875         next CMD;
3876     }
3877
3878     return;
3879 }
3880
3881 sub _n_or_s_and_arg_commands_generic {
3882     my ($self, $letter, $new_val) = @_;
3883
3884     # s - single-step. Remember the last command was 's'.
3885     if ($DB::cmd =~ s#\A\Q$letter\E\s#\$DB::single = $new_val;\n#) {
3886         $laststep = $letter;
3887     }
3888
3889     return;
3890 }
3891
3892 sub _handle_sh_command {
3893     my $self = shift;
3894
3895     # $sh$sh - run a shell command (if it's all ASCII).
3896     # Can't run shell commands with Unicode in the debugger, hmm.
3897     my $my_cmd = $DB::cmd;
3898     if ($my_cmd =~ m#\A$sh#gms) {
3899
3900         if ($my_cmd =~ m#\G\z#cgms) {
3901             # Run the user's shell. If none defined, run Bourne.
3902             # We resume execution when the shell terminates.
3903             DB::_db_system( $ENV{SHELL} || "/bin/sh" );
3904             next CMD;
3905         }
3906         elsif ($my_cmd =~ m#\G$sh\s*(.*)#cgms) {
3907             # System it.
3908             DB::_db_system($1);
3909             next CMD;
3910         }
3911         elsif ($my_cmd =~ m#\G\s*(.*)#cgms) {
3912             DB::_db_system( $ENV{SHELL} || "/bin/sh", "-c", $1 );
3913             next CMD;
3914         }
3915     }
3916 }
3917
3918 sub _handle_x_command {
3919     my $self = shift;
3920
3921     if ($DB::cmd =~ s#\Ax\b# #) {    # Remainder gets done by DB::eval()
3922         $onetimeDump = 'dump';    # main::dumpvar shows the output
3923
3924         # handle special  "x 3 blah" syntax XXX propagate
3925         # doc back to special variables.
3926         if ( $DB::cmd =~ s#\A\s*(\d+)(?=\s)# #) {
3927             $onetimedumpDepth = $1;
3928         }
3929     }
3930
3931     return;
3932 }
3933
3934 sub _handle_q_command {
3935     my $self = shift;
3936
3937     if ($self->_is_full('q')) {
3938         $fall_off_end = 1;
3939         DB::clean_ENV();
3940         exit $?;
3941     }
3942
3943     return;
3944 }
3945
3946 sub _handle_cmd_wrapper_commands {
3947     my $self = shift;
3948
3949     DB::cmd_wrapper( $self->cmd_verb, $self->cmd_args, $line );
3950     next CMD;
3951 }
3952
3953 sub _handle_special_char_cmd_wrapper_commands {
3954     my $self = shift;
3955
3956     # All of these commands were remapped in perl 5.8.0;
3957     # we send them off to the secondary dispatcher (see below).
3958     if (my ($cmd_letter, $my_arg) = $DB::cmd =~ /\A([<>\{]{1,2})\s*(.*)/so) {
3959         DB::cmd_wrapper( $cmd_letter, $my_arg, $line );
3960         next CMD;
3961     }
3962
3963     return;
3964 }
3965
3966 } ## end DB::Obj
3967
3968 package DB;
3969
3970 # The following code may be executed now:
3971 # BEGIN {warn 4}
3972
3973 =head2 sub
3974
3975 C<sub> is called whenever a subroutine call happens in the program being
3976 debugged. The variable C<$DB::sub> contains the name of the subroutine
3977 being called.
3978
3979 The core function of this subroutine is to actually call the sub in the proper
3980 context, capturing its output. This of course causes C<DB::DB> to get called
3981 again, repeating until the subroutine ends and returns control to C<DB::sub>
3982 again. Once control returns, C<DB::sub> figures out whether or not to dump the
3983 return value, and returns its captured copy of the return value as its own
3984 return value. The value then feeds back into the program being debugged as if
3985 C<DB::sub> hadn't been there at all.
3986
3987 C<sub> does all the work of printing the subroutine entry and exit messages
3988 enabled by setting C<$frame>. It notes what sub the autoloader got called for,
3989 and also prints the return value if needed (for the C<r> command and if
3990 the 16 bit is set in C<$frame>).
3991
3992 It also tracks the subroutine call depth by saving the current setting of
3993 C<$single> in the C<@stack> package global; if this exceeds the value in
3994 C<$deep>, C<sub> automatically turns on printing of the current depth by
3995 setting the C<4> bit in C<$single>. In any case, it keeps the current setting
3996 of stop/don't stop on entry to subs set as it currently is set.
3997
3998 =head3 C<caller()> support
3999
4000 If C<caller()> is called from the package C<DB>, it provides some
4001 additional data, in the following order:
4002
4003 =over 4
4004
4005 =item * C<$package>
4006
4007 The package name the sub was in
4008
4009 =item * C<$filename>
4010
4011 The filename it was defined in
4012
4013 =item * C<$line>
4014
4015 The line number it was defined on
4016
4017 =item * C<$subroutine>
4018
4019 The subroutine name; C<(eval)> if an C<eval>().
4020
4021 =item * C<$hasargs>
4022
4023 1 if it has arguments, 0 if not
4024
4025 =item * C<$wantarray>
4026
4027 1 if array context, 0 if scalar context
4028
4029 =item * C<$evaltext>
4030
4031 The C<eval>() text, if any (undefined for C<eval BLOCK>)
4032
4033 =item * C<$is_require>
4034
4035 frame was created by a C<use> or C<require> statement
4036
4037 =item * C<$hints>
4038
4039 pragma information; subject to change between versions
4040
4041 =item * C<$bitmask>
4042
4043 pragma information; subject to change between versions
4044
4045 =item * C<@DB::args>
4046
4047 arguments with which the subroutine was invoked
4048
4049 =back
4050
4051 =cut
4052
4053 use vars qw($deep);
4054
4055 # We need to fully qualify the name ("DB::sub") to make "use strict;"
4056 # happy. -- Shlomi Fish
4057
4058 sub _indent_print_line_info {
4059     my ($offset, $str) = @_;
4060
4061     print_lineinfo( ' ' x ($stack_depth - $offset), $str);
4062
4063     return;
4064 }
4065
4066 sub _print_frame_message {
4067     my ($al) = @_;
4068
4069     if ($frame) {
4070         if ($frame & 4) {   # Extended frame entry message
4071             _indent_print_line_info(-1, "in  ");
4072
4073             # Why -1? But it works! :-(
4074             # Because print_trace will call add 1 to it and then call
4075             # dump_trace; this results in our skipping -1+1 = 0 stack frames
4076             # in dump_trace.
4077             #
4078             # Now it's 0 because we extracted a function.
4079             print_trace( $LINEINFO, 0, 1, 1, "$sub$al" );
4080         }
4081         else {
4082             _indent_print_line_info(-1, "entering $sub$al\n" );
4083         }
4084     }
4085
4086     return;
4087 }
4088
4089 sub DB::sub {
4090     # Do not use a regex in this subroutine -> results in corrupted memory
4091     # See: [perl #66110]
4092
4093     # lock ourselves under threads
4094     lock($DBGR);
4095
4096     # Whether or not the autoloader was running, a scalar to put the
4097     # sub's return value in (if needed), and an array to put the sub's
4098     # return value in (if needed).
4099     my ( $al, $ret, @ret ) = "";
4100     if ($sub eq 'threads::new' && $ENV{PERL5DB_THREADED}) {
4101         print "creating new thread\n";
4102     }
4103
4104     # If the last ten characters are '::AUTOLOAD', note we've traced
4105     # into AUTOLOAD for $sub.
4106     if ( length($sub) > 10 && substr( $sub, -10, 10 ) eq '::AUTOLOAD' ) {
4107         no strict 'refs';
4108         $al = " for $$sub" if defined $$sub;
4109     }
4110
4111     # We stack the stack pointer and then increment it to protect us
4112     # from a situation that might unwind a whole bunch of call frames
4113     # at once. Localizing the stack pointer means that it will automatically
4114     # unwind the same amount when multiple stack frames are unwound.
4115     local $stack_depth = $stack_depth + 1;    # Protect from non-local exits
4116
4117     # Expand @stack.
4118     $#stack = $stack_depth;
4119
4120     # Save current single-step setting.
4121     $stack[-1] = $single;
4122
4123     # Turn off all flags except single-stepping.
4124     $single &= 1;
4125
4126     # If we've gotten really deeply recursed, turn on the flag that will
4127     # make us stop with the 'deep recursion' message.
4128     $single |= 4 if $stack_depth == $deep;
4129
4130     # If frame messages are on ...
4131
4132     _print_frame_message($al);
4133     # standard frame entry message
4134
4135     my $print_exit_msg = sub {
4136         # Check for exit trace messages...
4137         if ($frame & 2)
4138         {
4139             if ($frame & 4)    # Extended exit message
4140             {
4141                 _indent_print_line_info(0, "out ");
4142                 print_trace( $LINEINFO, 0, 1, 1, "$sub$al" );
4143             }
4144             else
4145             {
4146                 _indent_print_line_info(0, "exited $sub$al\n" );
4147             }
4148         }
4149         return;
4150     };
4151
4152     # Determine the sub's return type, and capture appropriately.
4153     if (wantarray) {
4154
4155         # Called in array context. call sub and capture output.
4156         # DB::DB will recursively get control again if appropriate; we'll come
4157         # back here when the sub is finished.
4158         {
4159             no strict 'refs';
4160             @ret = &$sub;
4161         }
4162
4163         # Pop the single-step value back off the stack.
4164         $single |= $stack[ $stack_depth-- ];
4165
4166         $print_exit_msg->();
4167
4168         # Print the return info if we need to.
4169         if ( $doret eq $stack_depth or $frame & 16 ) {
4170
4171             # Turn off output record separator.
4172             local $\ = '';
4173             my $fh = ( $doret eq $stack_depth ? $OUT : $LINEINFO );
4174
4175             # Indent if we're printing because of $frame tracing.
4176             if ($frame & 16)
4177             {
4178                 print {$fh} ' ' x $stack_depth;
4179             }
4180
4181             # Print the return value.
4182             print {$fh} "list context return from $sub:\n";
4183             dumpit( $fh, \@ret );
4184
4185             # And don't print it again.
4186             $doret = -2;
4187         } ## end if ($doret eq $stack_depth...
4188             # And we have to return the return value now.
4189         @ret;
4190     } ## end if (wantarray)
4191
4192     # Scalar context.
4193     else {
4194         if ( defined wantarray ) {
4195             no strict 'refs';
4196             # Save the value if it's wanted at all.
4197             $ret = &$sub;
4198         }
4199         else {
4200             no strict 'refs';
4201             # Void return, explicitly.
4202             &$sub;
4203             undef $ret;
4204         }
4205
4206         # Pop the single-step value off the stack.
4207         $single |= $stack[ $stack_depth-- ];
4208
4209         # If we're doing exit messages...
4210         $print_exit_msg->();
4211
4212         # If we are supposed to show the return value... same as before.
4213         if ( $doret eq $stack_depth or $frame & 16 and defined wantarray ) {
4214             local $\ = '';
4215             my $fh = ( $doret eq $stack_depth ? $OUT : $LINEINFO );
4216             print $fh ( ' ' x $stack_depth ) if $frame & 16;
4217             print $fh (
4218                 defined wantarray
4219                 ? "scalar context return from $sub: "
4220                 : "void context return from $sub\n"
4221             );
4222             dumpit( $fh, $ret ) if defined wantarray;
4223             $doret = -2;
4224         } ## end if ($doret eq $stack_depth...
4225
4226         # Return the appropriate scalar value.
4227         $ret;
4228     } ## end else [ if (wantarray)
4229 } ## end sub _sub
4230
4231 sub lsub : lvalue {
4232
4233     no strict 'refs';
4234
4235     # lock ourselves under threads
4236     lock($DBGR);
4237
4238     # Whether or not the autoloader was running, a scalar to put the
4239     # sub's return value in (if needed), and an array to put the sub's
4240     # return value in (if needed).
4241     my ( $al, $ret, @ret ) = "";
4242     if ($sub =~ /^threads::new$/ && $ENV{PERL5DB_THREADED}) {
4243         print "creating new thread\n";
4244     }
4245
4246     # If the last ten characters are C'::AUTOLOAD', note we've traced
4247     # into AUTOLOAD for $sub.
4248     if ( length($sub) > 10 && substr( $sub, -10, 10 ) eq '::AUTOLOAD' ) {
4249         $al = " for $$sub";
4250     }
4251
4252     # We stack the stack pointer and then increment it to protect us
4253     # from a situation that might unwind a whole bunch of call frames
4254     # at once. Localizing the stack pointer means that it will automatically
4255     # unwind the same amount when multiple stack frames are unwound.
4256     local $stack_depth = $stack_depth + 1;    # Protect from non-local exits
4257
4258     # Expand @stack.
4259     $#stack = $stack_depth;
4260
4261     # Save current single-step setting.
4262     $stack[-1] = $single;
4263
4264     # Turn off all flags except single-stepping.
4265     $single &= 1;
4266
4267     # If we've gotten really deeply recursed, turn on the flag that will
4268     # make us stop with the 'deep recursion' message.
4269     $single |= 4 if $stack_depth == $deep;
4270
4271     # If frame messages are on ...
4272     _print_frame_message($al);
4273
4274     # Pop the single-step value back off the stack.
4275     $single |= $stack[ $stack_depth-- ];
4276
4277     # call the original lvalue sub.
4278     &$sub;
4279 }
4280
4281 # Abstracting common code from multiple places elsewhere:
4282 sub depth_print_lineinfo {
4283     my $always_print = shift;
4284
4285     print_lineinfo( @_ ) if ($always_print or $stack_depth < $trace_to_depth);
4286 }
4287
4288 =head1 EXTENDED COMMAND HANDLING AND THE COMMAND API
4289
4290 In Perl 5.8.0, there was a major realignment of the commands and what they did,
4291 Most of the changes were to systematize the command structure and to eliminate
4292 commands that threw away user input without checking.
4293
4294 The following sections describe the code added to make it easy to support
4295 multiple command sets with conflicting command names. This section is a start
4296 at unifying all command processing to make it simpler to develop commands.
4297
4298 Note that all the cmd_[a-zA-Z] subroutines require the command name, a line
4299 number, and C<$dbline> (the current line) as arguments.
4300
4301 Support functions in this section which have multiple modes of failure C<die>
4302 on error; the rest simply return a false value.
4303
4304 The user-interface functions (all of the C<cmd_*> functions) just output
4305 error messages.
4306
4307 =head2 C<%set>
4308
4309 The C<%set> hash defines the mapping from command letter to subroutine
4310 name suffix.
4311
4312 C<%set> is a two-level hash, indexed by set name and then by command name.
4313 Note that trying to set the CommandSet to C<foobar> simply results in the
4314 5.8.0 command set being used, since there's no top-level entry for C<foobar>.
4315
4316 =cut
4317
4318 ### The API section
4319
4320 my %set = (    #
4321     'pre580' => {
4322         'a' => 'pre580_a',
4323         'A' => 'pre580_null',
4324         'b' => 'pre580_b',
4325         'B' => 'pre580_null',
4326         'd' => 'pre580_null',
4327         'D' => 'pre580_D',
4328         'h' => 'pre580_h',
4329         'M' => 'pre580_null',
4330         'O' => 'o',
4331         'o' => 'pre580_null',
4332         'v' => 'M',
4333         'w' => 'v',
4334         'W' => 'pre580_W',
4335     },
4336     'pre590' => {
4337         '<'  => 'pre590_prepost',
4338         '<<' => 'pre590_prepost',
4339         '>'  => 'pre590_prepost',
4340         '>>' => 'pre590_prepost',
4341         '{'  => 'pre590_prepost',
4342         '{{' => 'pre590_prepost',
4343     },
4344 );
4345
4346 my %breakpoints_data;
4347
4348 sub _has_breakpoint_data_ref {
4349     my ($filename, $line) = @_;
4350
4351     return (
4352         exists( $breakpoints_data{$filename} )
4353             and
4354         exists( $breakpoints_data{$filename}{$line} )
4355     );
4356 }
4357
4358 sub _get_breakpoint_data_ref {
4359     my ($filename, $line) = @_;
4360
4361     return ($breakpoints_data{$filename}{$line} ||= +{});
4362 }
4363
4364 sub _delete_breakpoint_data_ref {
4365     my ($filename, $line) = @_;
4366
4367     delete($breakpoints_data{$filename}{$line});
4368     if (! scalar(keys( %{$breakpoints_data{$filename}} )) ) {
4369         delete($breakpoints_data{$filename});
4370     }
4371
4372     return;
4373 }
4374
4375 sub _set_breakpoint_enabled_status {
4376     my ($filename, $line, $status) = @_;
4377
4378     _get_breakpoint_data_ref($filename, $line)->{'enabled'} =
4379         ($status ? 1 : '')
4380         ;
4381
4382     return;
4383 }
4384
4385 sub _enable_breakpoint_temp_enabled_status {
4386     my ($filename, $line) = @_;
4387
4388     _get_breakpoint_data_ref($filename, $line)->{'temp_enabled'} = 1;
4389
4390     return;
4391 }
4392
4393 sub _cancel_breakpoint_temp_enabled_status {
4394     my ($filename, $line) = @_;
4395
4396     my $ref = _get_breakpoint_data_ref($filename, $line);
4397
4398     delete ($ref->{'temp_enabled'});
4399
4400     if (! %$ref) {
4401         _delete_breakpoint_data_ref($filename, $line);
4402     }
4403
4404     return;
4405 }
4406
4407 sub _is_breakpoint_enabled {
4408     my ($filename, $line) = @_;
4409
4410     my $data_ref = _get_breakpoint_data_ref($filename, $line);
4411     return ($data_ref->{'enabled'} || $data_ref->{'temp_enabled'});
4412 }
4413
4414 =head2 C<cmd_wrapper()> (API)
4415
4416 C<cmd_wrapper()> allows the debugger to switch command sets
4417 depending on the value of the C<CommandSet> option.
4418
4419 It tries to look up the command in the C<%set> package-level I<lexical>
4420 (which means external entities can't fiddle with it) and create the name of
4421 the sub to call based on the value found in the hash (if it's there). I<All>
4422 of the commands to be handled in a set have to be added to C<%set>; if they
4423 aren't found, the 5.8.0 equivalent is called (if there is one).
4424
4425 This code uses symbolic references.
4426
4427 =cut
4428
4429 sub cmd_wrapper {
4430     my $cmd      = shift;
4431     my $line     = shift;
4432     my $dblineno = shift;
4433
4434     # Assemble the command subroutine's name by looking up the
4435     # command set and command name in %set. If we can't find it,
4436     # default to the older version of the command.
4437     my $call = 'cmd_'
4438       . ( $set{$CommandSet}{$cmd}
4439           || ( $cmd =~ /\A[<>{]+/o ? 'prepost' : $cmd ) );
4440
4441     # Call the command subroutine, call it by name.
4442     return __PACKAGE__->can($call)->( $cmd, $line, $dblineno );
4443 } ## end sub cmd_wrapper
4444
4445 =head3 C<cmd_a> (command)
4446
4447 The C<a> command handles pre-execution actions. These are associated with a
4448 particular line, so they're stored in C<%dbline>. We default to the current
4449 line if none is specified.
4450
4451 =cut
4452
4453 sub cmd_a {
4454     my $cmd    = shift;
4455     my $line   = shift || '';    # [.|line] expr
4456     my $dbline = shift;
4457
4458     # If it's dot (here), or not all digits,  use the current line.
4459     $line =~ s/\A\./$dbline/;
4460
4461     # Should be a line number followed by an expression.
4462     if ( my ($lineno, $expr) = $line =~ /^\s*(\d*)\s*(\S.+)/ ) {
4463
4464         if (! length($lineno)) {
4465             $lineno = $dbline;
4466         }
4467
4468         # If we have an expression ...
4469         if ( length $expr ) {
4470
4471             # ... but the line isn't breakable, complain.
4472             if ( $dbline[$lineno] == 0 ) {
4473                 print $OUT
4474                   "Line $lineno($dbline[$lineno]) does not have an action?\n";
4475             }
4476             else {
4477
4478                 # It's executable. Record that the line has an action.
4479                 $had_breakpoints{$filename} |= 2;
4480
4481                 # Remove any action, temp breakpoint, etc.
4482                 $dbline{$lineno} =~ s/\0[^\0]*//;
4483
4484                 # Add the action to the line.
4485                 $dbline{$lineno} .= "\0" . action($expr);
4486
4487                 _set_breakpoint_enabled_status($filename, $lineno, 1);
4488             }
4489         } ## end if (length $expr)
4490     } ## end if ($line =~ /^\s*(\d*)\s*(\S.+)/)
4491     else {
4492
4493         # Syntax wrong.
4494         print $OUT
4495           "Adding an action requires an optional lineno and an expression\n"
4496           ;    # hint
4497     }
4498 } ## end sub cmd_a
4499
4500 =head3 C<cmd_A> (command)
4501
4502 Delete actions. Similar to above, except the delete code is in a separate
4503 subroutine, C<delete_action>.
4504
4505 =cut
4506
4507 sub cmd_A {
4508     my $cmd    = shift;
4509     my $line   = shift || '';
4510     my $dbline = shift;
4511
4512     # Dot is this line.
4513     $line =~ s/^\./$dbline/;
4514
4515     # Call delete_action with a null param to delete them all.
4516     # The '1' forces the eval to be true. It'll be false only
4517     # if delete_action blows up for some reason, in which case
4518     # we print $@ and get out.
4519     if ( $line eq '*' ) {
4520         if (! eval { _delete_all_actions(); 1 }) {
4521             print {$OUT} $@;
4522             return;
4523         }
4524     }
4525
4526     # There's a real line  number. Pass it to delete_action.
4527     # Error trapping is as above.
4528     elsif ( $line =~ /^(\S.*)/ ) {
4529         if (! eval { delete_action($1); 1 }) {
4530             print {$OUT} $@;
4531             return;
4532         }
4533     }
4534
4535     # Swing and a miss. Bad syntax.
4536     else {
4537         print $OUT
4538           "Deleting an action requires a line number, or '*' for all\n" ; # hint
4539     }
4540 } ## end sub cmd_A
4541
4542 =head3 C<delete_action> (API)
4543
4544 C<delete_action> accepts either a line number or C<undef>. If a line number
4545 is specified, we check for the line being executable (if it's not, it
4546 couldn't have had an  action). If it is, we just take the action off (this
4547 will get any kind of an action, including breakpoints).
4548
4549 =cut
4550
4551 sub _remove_action_from_dbline {
4552     my $i = shift;
4553
4554     $dbline{$i} =~ s/\0[^\0]*//;    # \^a
4555     delete $dbline{$i} if $dbline{$i} eq '';
4556
4557     return;
4558 }
4559
4560 sub _delete_all_actions {
4561     print {$OUT} "Deleting all actions...\n";
4562
4563     for my $file ( keys %had_breakpoints ) {
4564         local *dbline = $main::{ '_<' . $file };
4565         $max = $#dbline;
4566         my $was;
4567         for my $i (1 .. $max) {
4568             if ( defined $dbline{$i} ) {
4569                 _remove_action_from_dbline($i);
4570             }
4571         }
4572
4573         unless ( $had_breakpoints{$file} &= ~2 ) {
4574             delete $had_breakpoints{$file};
4575         }
4576     }
4577
4578     return;
4579 }
4580
4581 sub delete_action {
4582     my $i = shift;
4583
4584     if ( defined($i) ) {
4585         # Can there be one?
4586         die "Line $i has no action .\n" if $dbline[$i] == 0;
4587
4588         # Nuke whatever's there.
4589         _remove_action_from_dbline($i);
4590     }
4591     else {
4592         _delete_all_actions();
4593     }
4594 }
4595
4596 =head3 C<cmd_b> (command)
4597
4598 Set breakpoints. Since breakpoints can be set in so many places, in so many
4599 ways, conditionally or not, the breakpoint code is kind of complex. Mostly,
4600 we try to parse the command type, and then shuttle it off to an appropriate
4601 subroutine to actually do the work of setting the breakpoint in the right
4602 place.
4603
4604 =cut
4605
4606 sub cmd_b {
4607     my $cmd    = shift;
4608     my $line   = shift;    # [.|line] [cond]
4609     my $dbline = shift;
4610
4611     my $default_cond = sub {
4612         my $cond = shift;
4613         return length($cond) ? $cond : '1';
4614     };
4615
4616     # Make . the current line number if it's there..
4617     $line =~ s/^\.(\s|\z)/$dbline$1/;
4618
4619     # No line number, no condition. Simple break on current line.
4620     if ( $line =~ /^\s*$/ ) {
4621         cmd_b_line( $dbline, 1 );
4622     }
4623
4624     # Break on load for a file.
4625     elsif ( my ($file) = $line =~ /^load\b\s*(.*)/ ) {
4626         $file =~ s/\s+\z//;
4627         cmd_b_load($file);
4628     }
4629
4630     # b compile|postpone <some sub> [<condition>]
4631     # The interpreter actually traps this one for us; we just put the
4632     # necessary condition in the %postponed hash.
4633     elsif ( my ($action, $subname, $cond)
4634         = $line =~ /^(postpone|compile)\b\s*([':A-Za-z_][':\w]*)\s*(.*)/ ) {
4635
4636         # De-Perl4-ify the name - ' separators to ::.
4637         $subname =~ s/'/::/g;
4638
4639         # Qualify it into the current package unless it's already qualified.
4640         $subname = "${package}::" . $subname unless $subname =~ /::/;
4641
4642         # Add main if it starts with ::.
4643         $subname = "main" . $subname if substr( $subname, 0, 2 ) eq "::";
4644
4645         # Save the break type for this sub.
4646         $postponed{$subname} = (($action eq 'postpone')
4647             ? ( "break +0 if " . $default_cond->($cond) )
4648             : "compile");
4649     } ## end elsif ($line =~ ...
4650     # b <filename>:<line> [<condition>]
4651     elsif (my ($filename, $line_num, $cond)
4652         = $line =~ /\A(\S+[^:]):(\d+)\s*(.*)/ms) {
4653         cmd_b_filename_line(
4654             $filename,
4655             $line_num,
4656             (length($cond) ? $cond : '1'),
4657         );
4658     }
4659     # b <sub name> [<condition>]
4660     elsif ( my ($new_subname, $new_cond) =
4661         $line =~ /^([':A-Za-z_][':\w]*(?:\[.*\])?)\s*(.*)/ ) {
4662
4663         #
4664         $subname = $new_subname;
4665         cmd_b_sub( $subname, $default_cond->($new_cond) );
4666     }
4667
4668     # b <line> [<condition>].
4669     elsif ( my ($line_n, $cond) = $line =~ /^(\d*)\s*(.*)/ ) {
4670
4671         # Capture the line. If none, it's the current line.
4672         $line = $line_n || $dbline;
4673
4674         # Break on line.
4675         cmd_b_line( $line, $default_cond->($cond) );
4676     }
4677
4678     # Line didn't make sense.
4679     else {
4680         print "confused by line($line)?\n";
4681     }
4682
4683     return;
4684 } ## end sub cmd_b
4685
4686 =head3 C<break_on_load> (API)
4687
4688 We want to break when this file is loaded. Mark this file in the
4689 C<%break_on_load> hash, and note that it has a breakpoint in
4690 C<%had_breakpoints>.
4691
4692 =cut
4693
4694 sub break_on_load {
4695     my $file = shift;
4696     $break_on_load{$file} = 1;
4697     $had_breakpoints{$file} |= 1;
4698 }
4699
4700 =head3 C<report_break_on_load> (API)
4701
4702 Gives us an array of filenames that are set to break on load. Note that
4703 only files with break-on-load are in here, so simply showing the keys
4704 suffices.
4705
4706 =cut
4707
4708 sub report_break_on_load {
4709     sort keys %break_on_load;
4710 }
4711
4712 =head3 C<cmd_b_load> (command)
4713
4714 We take the file passed in and try to find it in C<%INC> (which maps modules
4715 to files they came from). We mark those files for break-on-load via
4716 C<break_on_load> and then report that it was done.
4717
4718 =cut
4719
4720 sub cmd_b_load {
4721     my $file = shift;
4722     my @files;
4723
4724     # This is a block because that way we can use a redo inside it
4725     # even without there being any looping structure at all outside it.
4726     {
4727
4728         # Save short name and full path if found.
4729         push @files, $file;
4730         push @files, $::INC{$file} if $::INC{$file};
4731
4732         # Tack on .pm and do it again unless there was a '.' in the name
4733         # already.
4734         $file .= '.pm', redo unless $file =~ /\./;
4735     }
4736
4737     # Do the real work here.
4738     break_on_load($_) for @files;
4739
4740     # All the files that have break-on-load breakpoints.
4741     @files = report_break_on_load;
4742
4743     # Normalize for the purposes of our printing this.
4744     local $\ = '';
4745     local $" = ' ';
4746     print $OUT "Will stop on load of '@files'.\n";
4747 } ## end sub cmd_b_load
4748
4749 =head3 C<$filename_error> (API package global)
4750
4751 Several of the functions we need to implement in the API need to work both
4752 on the current file and on other files. We don't want to duplicate code, so
4753 C<$filename_error> is used to contain the name of the file that's being
4754 worked on (if it's not the current one).
4755
4756 We can now build functions in pairs: the basic function works on the current
4757 file, and uses C<$filename_error> as part of its error message. Since this is
4758 initialized to C<"">, no filename will appear when we are working on the
4759 current file.
4760
4761 The second function is a wrapper which does the following:
4762
4763 =over 4
4764
4765 =item *
4766
4767 Localizes C<$filename_error> and sets it to the name of the file to be processed.
4768
4769 =item *
4770
4771 Localizes the C<*dbline> glob and reassigns it to point to the file we want to process.
4772
4773 =item *
4774
4775 Calls the first function.
4776
4777 The first function works on the I<current> file (i.e., the one we changed to),
4778 and prints C<$filename_error> in the error message (the name of the other file)
4779 if it needs to. When the functions return, C<*dbline> is restored to point
4780 to the actual current file (the one we're executing in) and
4781 C<$filename_error> is restored to C<"">. This restores everything to
4782 the way it was before the second function was called at all.
4783
4784 See the comments in C<breakable_line> and C<breakable_line_in_file> for more
4785 details.
4786
4787 =back
4788
4789 =cut
4790
4791 use vars qw($filename_error);
4792 $filename_error = '';
4793
4794 =head3 breakable_line(from, to) (API)
4795
4796 The subroutine decides whether or not a line in the current file is breakable.
4797 It walks through C<@dbline> within the range of lines specified, looking for
4798 the first line that is breakable.
4799
4800 If C<$to> is greater than C<$from>, the search moves forwards, finding the
4801 first line I<after> C<$to> that's breakable, if there is one.
4802
4803 If C<$from> is greater than C<$to>, the search goes I<backwards>, finding the
4804 first line I<before> C<$to> that's breakable, if there is one.
4805
4806 =cut
4807
4808 sub breakable_line {
4809
4810     my ( $from, $to ) = @_;
4811
4812     # $i is the start point. (Where are the FORTRAN programs of yesteryear?)
4813     my $i = $from;
4814
4815     # If there are at least 2 arguments, we're trying to search a range.
4816     if ( @_ >= 2 ) {
4817
4818         # $delta is positive for a forward search, negative for a backward one.
4819         my $delta = $from < $to ? +1 : -1;
4820
4821         # Keep us from running off the ends of the file.
4822         my $limit = $delta > 0 ? $#dbline : 1;
4823
4824         # Clever test. If you're a mathematician, it's obvious why this
4825         # test works. If not:
4826         # If $delta is positive (going forward), $limit will be $#dbline.
4827         #    If $to is less than $limit, ($limit - $to) will be positive, times
4828         #    $delta of 1 (positive), so the result is > 0 and we should use $to
4829         #    as the stopping point.
4830         #
4831         #    If $to is greater than $limit, ($limit - $to) is negative,
4832         #    times $delta of 1 (positive), so the result is < 0 and we should
4833         #    use $limit ($#dbline) as the stopping point.
4834         #
4835         # If $delta is negative (going backward), $limit will be 1.
4836         #    If $to is zero, ($limit - $to) will be 1, times $delta of -1
4837         #    (negative) so the result is > 0, and we use $to as the stopping
4838         #    point.
4839         #
4840         #    If $to is less than zero, ($limit - $to) will be positive,
4841         #    times $delta of -1 (negative), so the result is not > 0, and
4842         #    we use $limit (1) as the stopping point.
4843         #
4844         #    If $to is 1, ($limit - $to) will zero, times $delta of -1
4845         #    (negative), still giving zero; the result is not > 0, and
4846         #    we use $limit (1) as the sto