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