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