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