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> via glob
 177 assignment) contains the text from C<$filename>, with each element
 178 corresponding to a single line of C<$filename>.
 179
 180 The hash C<%{'_<'.$filename}> (aliased locally to C<%dbline> via glob
 181 assignment) contains breakpoints and actions.  The keys are line numbers;
 182 you can set individual values, but not the whole hash. The Perl interpreter
 183 uses this hash to determine where breakpoints have been set. Any true value is
 184 considered to be a breakpoint; C<perl5db.pl> uses C<$break_condition\0$action>.
 185 Values are magical in numeric context: 1 if the line is breakable, 0 if not.
 186
 187 The scalar C<${"_<$filename"}> simply contains the string C<_<$filename>.
 188 This is also the case for evaluated strings that contain subroutines, or
 189 which are currently being executed.  The $filename for C<eval>ed strings looks
 190 like C<(eval 34)> or C<(re_eval 19)>.
 191
 192 =head1 DEBUGGER STARTUP
 193
 194 When C<perl5db.pl> starts, it reads an rcfile (C<perl5db.ini> for
 195 non-interactive sessions, C<.perldb> for interactive ones) that can set a number
 196 of options. In addition, this file may define a subroutine C<&afterinit>
 197 that will be executed (in the debugger's context) after the debugger has
 198 initialized itself.
 199
 200 Next, it checks the C<PERLDB_OPTS> environment variable and treats its
 201 contents as the argument of a C<o> command in the debugger.
 202
 203 =head2 STARTUP-ONLY OPTIONS
 204
 205 The following options can only be specified at startup.
 206 To set them in your rcfile, add a call to
 207 C<&parse_options("optionName=new_value")>.
 208
 209 =over 4
 210
 211 =item * TTY
 212
 213 the TTY to use for debugging i/o.
 214
 215 =item * noTTY
 216
 217 if set, goes in NonStop mode.  On interrupt, if TTY is not set,
 218 uses the value of noTTY or F<$HOME/.perldbtty$$> to find TTY using
 219 Term::Rendezvous.  Current variant is to have the name of TTY in this
 220 file.
 221
 222 =item * ReadLine
 223
 224 If false, a dummy  ReadLine is used, so you can debug
 225 ReadLine applications.
 226
 227 =item * NonStop
 228
 229 if true, no i/o is performed until interrupt.
 230
 231 =item * LineInfo
 232
 233 file or pipe to print line number info to.  If it is a
 234 pipe, a short "emacs like" message is used.
 235
 236 =item * RemotePort
 237
 238 host:port to connect to on remote host for remote debugging.
 239
 240 =back
 241
 242 =head3 SAMPLE RCFILE
 243
 244  &parse_options("NonStop=1 LineInfo=db.out");
 245   sub afterinit { $trace = 1; }
 246
 247 The script will run without human intervention, putting trace
 248 information into C<db.out>.  (If you interrupt it, you had better
 249 reset C<LineInfo> to something I<interactive>!)
 250
 251 =head1 INTERNALS DESCRIPTION
 252
 253 =head2 DEBUGGER INTERFACE VARIABLES
 254
 255 Perl supplies the values for C<%sub>.  It effectively inserts
 256 a C<&DB::DB();> in front of each place that can have a
 257 breakpoint. At each subroutine call, it calls C<&DB::sub> with
 258 C<$DB::sub> set to the called subroutine. It also inserts a C<BEGIN
 259 {require 'perl5db.pl'}> before the first line.
 260
 261 After each C<require>d file is compiled, but before it is executed, a
 262 call to C<&DB::postponed($main::{'_<'.$filename})> is done. C<$filename>
 263 is the expanded name of the C<require>d file (as found via C<%INC>).
 264
 265 =head3 IMPORTANT INTERNAL VARIABLES
 266
 267 =head4 C<$CreateTTY>
 268
 269 Used to control when the debugger will attempt to acquire another TTY to be
 270 used for input.
 271
 272 =over
 273
 274 =item * 1 -  on C<fork()>
 275
 276 =item * 2 - debugger is started inside debugger
 277
 278 =item * 4 -  on startup
 279
 280 =back
 281
 282 =head4 C<$doret>
 283
 284 The value -2 indicates that no return value should be printed.
 285 Any other positive value causes C<DB::sub> to print return values.
 286
 287 =head4 C<$evalarg>
 288
 289 The item to be eval'ed by C<DB::eval>. Used to prevent messing with the current
 290 contents of C<@_> when C<DB::eval> is called.
 291
 292 =head4 C<$frame>
 293
 294 Determines what messages (if any) will get printed when a subroutine (or eval)
 295 is entered or exited.
 296
 297 =over 4
 298
 299 =item * 0 -  No enter/exit messages
 300
 301 =item * 1 - Print I<entering> messages on subroutine entry
 302
 303 =item * 2 - Adds exit messages on subroutine exit. If no other flag is on, acts like 1+2.
 304
 305 =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.
 306
 307 =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.
 308
 309 =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.
 310
 311 =back
 312
 313 To get everything, use C<$frame=30> (or C<o f=30> as a debugger command).
 314 The debugger internally juggles the value of C<$frame> during execution to
 315 protect external modules that the debugger uses from getting traced.
 316
 317 =head4 C<$level>
 318
 319 Tracks current debugger nesting level. Used to figure out how many
 320 C<E<lt>E<gt>> pairs to surround the line number with when the debugger
 321 outputs a prompt. Also used to help determine if the program has finished
 322 during command parsing.
 323
 324 =head4 C<$onetimeDump>
 325
 326 Controls what (if anything) C<DB::eval()> will print after evaluating an
 327 expression.
 328
 329 =over 4
 330
 331 =item * C<undef> - don't print anything
 332
 333 =item * C<dump> - use C<dumpvar.pl> to display the value returned
 334
 335 =item * C<methods> - print the methods callable on the first item returned
 336
 337 =back
 338
 339 =head4 C<$onetimeDumpDepth>
 340
 341 Controls how far down C<dumpvar.pl> will go before printing C<...> while
 342 dumping a structure. Numeric. If C<undef>, print all levels.
 343
 344 =head4 C<$signal>
 345
 346 Used to track whether or not an C<INT> signal has been detected. C<DB::DB()>,
 347 which is called before every statement, checks this and puts the user into
 348 command mode if it finds C<$signal> set to a true value.
 349
 350 =head4 C<$single>
 351
 352 Controls behavior during single-stepping. Stacked in C<@stack> on entry to
 353 each subroutine; popped again at the end of each subroutine.
 354
 355 =over 4
 356
 357 =item * 0 - run continuously.
 358
 359 =item * 1 - single-step, go into subs. The C<s> command.
 360
 361 =item * 2 - single-step, don't go into subs. The C<n> command.
 362
 363 =item * 4 - print current sub depth (turned on to force this when C<too much
 364 recursion> occurs.
 365
 366 =back
 367
 368 =head4 C<$trace>
 369
 370 Controls the output of trace information.
 371
 372 =over 4
 373
 374 =item * 1 - The C<t> command was entered to turn on tracing (every line executed is printed)
 375
 376 =item * 2 - watch expressions are active
 377
 378 =item * 4 - user defined a C<watchfunction()> in C<afterinit()>
 379
 380 =back
 381
 382 =head4 C<$slave_editor>
 383
 384 1 if C<LINEINFO> was directed to a pipe; 0 otherwise.
 385
 386 =head4 C<@cmdfhs>
 387
 388 Stack of filehandles that C<DB::readline()> will read commands from.
 389 Manipulated by the debugger's C<source> command and C<DB::readline()> itself.
 390
 391 =head4 C<@dbline>
 392
 393 Local alias to the magical line array, C<@{$main::{'_<'.$filename}}> ,
 394 supplied by the Perl interpreter to the debugger. Contains the source.
 395
 396 =head4 C<@old_watch>
 397
 398 Previous values of watch expressions. First set when the expression is
 399 entered; reset whenever the watch expression changes.
 400
 401 =head4 C<@saved>
 402
 403 Saves important globals (C<$@>, C<$!>, C<$^E>, C<$,>, C<$/>, C<$\>, C<$^W>)
 404 so that the debugger can substitute safe values while it's running, and
 405 restore them when it returns control.
 406
 407 =head4 C<@stack>
 408
 409 Saves the current value of C<$single> on entry to a subroutine.
 410 Manipulated by the C<c> command to turn off tracing in all subs above the
 411 current one.
 412
 413 =head4 C<@to_watch>
 414
 415 The 'watch' expressions: to be evaluated before each line is executed.
 416
 417 =head4 C<@typeahead>
 418
 419 The typeahead buffer, used by C<DB::readline>.
 420
 421 =head4 C<%alias>
 422
 423 Command aliases. Stored as character strings to be substituted for a command
 424 entered.
 425
 426 =head4 C<%break_on_load>
 427
 428 Keys are file names, values are 1 (break when this file is loaded) or undef
 429 (don't break when it is loaded).
 430
 431 =head4 C<%dbline>
 432
 433 Keys are line numbers, values are C<condition\0action>. If used in numeric
 434 context, values are 0 if not breakable, 1 if breakable, no matter what is
 435 in the actual hash entry.
 436
 437 =head4 C<%had_breakpoints>
 438
 439 Keys are file names; values are bitfields:
 440
 441 =over 4
 442
 443 =item * 1 - file has a breakpoint in it.
 444
 445 =item * 2 - file has an action in it.
 446
 447 =back
 448
 449 A zero or undefined value means this file has neither.
 450
 451 =head4 C<%option>
 452
 453 Stores the debugger options. These are character string values.
 454
 455 =head4 C<%postponed>
 456
 457 Saves breakpoints for code that hasn't been compiled yet.
 458 Keys are subroutine names, values are:
 459
 460 =over 4
 461
 462 =item * C<compile> - break when this sub is compiled
 463
 464 =item * C<< break +0 if <condition> >> - break (conditionally) at the start of this routine. The condition will be '1' if no condition was specified.
 465
 466 =back
 467
 468 =head4 C<%postponed_file>
 469
 470 This hash keeps track of breakpoints that need to be set for files that have
 471 not yet been compiled. Keys are filenames; values are references to hashes.
 472 Each of these hashes is keyed by line number, and its values are breakpoint
 473 definitions (C<condition\0action>).
 474
 475 =head1 DEBUGGER INITIALIZATION
 476
 477 The debugger's initialization actually jumps all over the place inside this
 478 package. This is because there are several BEGIN blocks (which of course
 479 execute immediately) spread through the code. Why is that?
 480
 481 The debugger needs to be able to change some things and set some things up
 482 before the debugger code is compiled; most notably, the C<$deep> variable that
 483 C<DB::sub> uses to tell when a program has recursed deeply. In addition, the
 484 debugger has to turn off warnings while the debugger code is compiled, but then
 485 restore them to their original setting before the program being debugged begins
 486 executing.
 487
 488 The first C<BEGIN> block simply turns off warnings by saving the current
 489 setting of C<$^W> and then setting it to zero. The second one initializes
 490 the debugger variables that are needed before the debugger begins executing.
 491 The third one puts C<$^X> back to its former value.
 492
 493 We'll detail the second C<BEGIN> block later; just remember that if you need
 494 to initialize something before the debugger starts really executing, that's
 495 where it has to go.
 496
 497 =cut
 498
 499 package DB;
 500
 501 use IO::Handle;
 502
 503 # Debugger for Perl 5.00x; perl5db.pl patch level:
 504 $VERSION = 1.28;
 505
 506 $header = "perl5db.pl version $VERSION";
 507
 508 =head1 DEBUGGER ROUTINES
 509
 510 =head2 C<DB::eval()>
 511
 512 This function replaces straight C<eval()> inside the debugger; it simplifies
 513 the process of evaluating code in the user's context.
 514
 515 The code to be evaluated is passed via the package global variable
 516 C<$DB::evalarg>; this is done to avoid fiddling with the contents of C<@_>.
 517
 518 Before we do the C<eval()>, we preserve the current settings of C<$trace>,
 519 C<$single>, C<$^D> and C<$usercontext>.  The latter contains the
 520 preserved values of C<$@>, C<$!>, C<$^E>, C<$,>, C<$/>, C<$\>, C<$^W> and the
 521 user's current package, grabbed when C<DB::DB> got control.  This causes the
 522 proper context to be used when the eval is actually done.  Afterward, we
 523 restore C<$trace>, C<$single>, and C<$^D>.
 524
 525 Next we need to handle C<$@> without getting confused. We save C<$@> in a
 526 local lexical, localize C<$saved[0]> (which is where C<save()> will put
 527 C<$@>), and then call C<save()> to capture C<$@>, C<$!>, C<$^E>, C<$,>,
 528 C<$/>, C<$\>, and C<$^W>) and set C<$,>, C<$/>, C<$\>, and C<$^W> to values
 529 considered sane by the debugger. If there was an C<eval()> error, we print
 530 it on the debugger's output. If C<$onetimedump> is defined, we call
 531 C<dumpit> if it's set to 'dump', or C<methods> if it's set to
 532 'methods'. Setting it to something else causes the debugger to do the eval
 533 but not print the result - handy if you want to do something else with it
 534 (the "watch expressions" code does this to get the value of the watch
 535 expression but not show it unless it matters).
 536
 537 In any case, we then return the list of output from C<eval> to the caller,
 538 and unwinding restores the former version of C<$@> in C<@saved> as well
 539 (the localization of C<$saved[0]> goes away at the end of this scope).
 540
 541 =head3 Parameters and variables influencing execution of DB::eval()
 542
 543 C<DB::eval> isn't parameterized in the standard way; this is to keep the
 544 debugger's calls to C<DB::eval()> from mucking with C<@_>, among other things.
 545 The variables listed below influence C<DB::eval()>'s execution directly.
 546
 547 =over 4
 548
 549 =item C<$evalarg> - the thing to actually be eval'ed
 550
 551 =item C<$trace> - Current state of execution tracing
 552
 553 =item C<$single> - Current state of single-stepping
 554
 555 =item C<$onetimeDump> - what is to be displayed after the evaluation
 556
 557 =item C<$onetimeDumpDepth> - how deep C<dumpit()> should go when dumping results
 558
 559 =back
 560
 561 The following variables are altered by C<DB::eval()> during its execution. They
 562 are "stacked" via C<local()>, enabling recursive calls to C<DB::eval()>.
 563
 564 =over 4
 565
 566 =item C<@res> - used to capture output from actual C<eval>.
 567
 568 =item C<$otrace> - saved value of C<$trace>.
 569
 570 =item C<$osingle> - saved value of C<$single>.
 571
 572 =item C<$od> - saved value of C<$^D>.
 573
 574 =item C<$saved[0]> - saved value of C<$@>.
 575
 576 =item $\ - for output of C<$@> if there is an evaluation error.
 577
 578 =back
 579
 580 =head3 The problem of lexicals
 581
 582 The context of C<DB::eval()> presents us with some problems. Obviously,
 583 we want to be 'sandboxed' away from the debugger's internals when we do
 584 the eval, but we need some way to control how punctuation variables and
 585 debugger globals are used.
 586
 587 We can't use local, because the code inside C<DB::eval> can see localized
 588 variables; and we can't use C<my> either for the same reason. The code
 589 in this routine compromises and uses C<my>.
 590
 591 After this routine is over, we don't have user code executing in the debugger's
 592 context, so we can use C<my> freely.
 593
 594 =cut
 595
 596 ############################################## Begin lexical danger zone
 597
 598 # 'my' variables used here could leak into (that is, be visible in)
 599 # the context that the code being evaluated is executing in. This means that
 600 # the code could modify the debugger's variables.
 601 #
 602 # Fiddling with the debugger's context could be Bad. We insulate things as
 603 # much as we can.
 604
 605 sub eval {
 606
 607     # 'my' would make it visible from user code
 608     #    but so does local! --tchrist
 609     # Remember: this localizes @DB::res, not @main::res.
 610     local @res;
 611     {
 612
 613         # Try to keep the user code from messing  with us. Save these so that
 614         # even if the eval'ed code changes them, we can put them back again.
 615         # Needed because the user could refer directly to the debugger's
 616         # package globals (and any 'my' variables in this containing scope)
 617         # inside the eval(), and we want to try to stay safe.
 618         local $otrace  = $trace;
 619         local $osingle = $single;
 620         local $od      = $^D;
 621
 622         # Untaint the incoming eval() argument.
 623         { ($evalarg) = $evalarg =~ /(.*)/s; }
 624
 625         # $usercontext built in DB::DB near the comment
 626         # "set up the context for DB::eval ..."
 627         # Evaluate and save any results.
 628         @res = eval "$usercontext $evalarg;\n";  # '\n' for nice recursive debug
 629
 630         # Restore those old values.
 631         $trace  = $otrace;
 632         $single = $osingle;
 633         $^D     = $od;
 634     }
 635
 636     # Save the current value of $@, and preserve it in the debugger's copy
 637     # of the saved precious globals.
 638     my $at = $@;
 639
 640     # Since we're only saving $@, we only have to localize the array element
 641     # that it will be stored in.
 642     local $saved[0];    # Preserve the old value of $@
 643     eval { &DB::save };
 644
 645     # Now see whether we need to report an error back to the user.
 646     if ($at) {
 647         local $\ = '';
 648         print $OUT $at;
 649     }
 650
 651     # Display as required by the caller. $onetimeDump and $onetimedumpDepth
 652     # are package globals.
 653     elsif ($onetimeDump) {
 654         if ( $onetimeDump eq 'dump' ) {
 655             local $option{dumpDepth} = $onetimedumpDepth
 656               if defined $onetimedumpDepth;
 657             dumpit( $OUT, \@res );
 658         }
 659         elsif ( $onetimeDump eq 'methods' ) {
 660             methods( $res[0] );
 661         }
 662     } ## end elsif ($onetimeDump)
 663     @res;
 664 } ## end sub eval
 665
 666 ############################################## End lexical danger zone
 667
 668 # After this point it is safe to introduce lexicals.
 669 # The code being debugged will be executing in its own context, and
 670 # can't see the inside of the debugger.
 671 #
 672 # However, one should not overdo it: leave as much control from outside as
 673 # possible. If you make something a lexical, it's not going to be addressable
 674 # from outside the debugger even if you know its name.
 675
 676 # This file is automatically included if you do perl -d.
 677 # It's probably not useful to include this yourself.
 678 #
 679 # Before venturing further into these twisty passages, it is
 680 # wise to read the perldebguts man page or risk the ire of dragons.
 681 #
 682 # (It should be noted that perldebguts will tell you a lot about
 683 # the underlying mechanics of how the debugger interfaces into the
 684 # Perl interpreter, but not a lot about the debugger itself. The new
 685 # comments in this code try to address this problem.)
 686
 687 # Note that no subroutine call is possible until &DB::sub is defined
 688 # (for subroutines defined outside of the package DB). In fact the same is
 689 # true if $deep is not defined.
 690
 691 # Enhanced by ilya@math.ohio-state.edu (Ilya Zakharevich)
 692
 693 # modified Perl debugger, to be run from Emacs in perldb-mode
 694 # Ray Lischner (uunet!mntgfx!lisch) as of 5 Nov 1990
 695 # Johan Vromans -- upgrade to 4.0 pl 10
 696 # Ilya Zakharevich -- patches after 5.001 (and some before ;-)
 697
 698 # (We have made efforts to  clarify the comments in the change log
 699 # in other places; some of them may seem somewhat obscure as they
 700 # were originally written, and explaining them away from the code
 701 # in question seems conterproductive.. -JM)
 702
 703 ########################################################################
 704 # Changes: 0.94
 705 #   + A lot of things changed after 0.94. First of all, core now informs
 706 #     debugger about entry into XSUBs, overloaded operators, tied operations,
 707 #     BEGIN and END. Handy with `O f=2'.
 708 #   + This can make debugger a little bit too verbose, please be patient
 709 #     and report your problems promptly.
 710 #   + Now the option frame has 3 values: 0,1,2. XXX Document!
 711 #   + Note that if DESTROY returns a reference to the object (or object),
 712 #     the deletion of data may be postponed until the next function call,
 713 #     due to the need to examine the return value.
 714 #
 715 # Changes: 0.95
 716 #   + `v' command shows versions.
 717 #
 718 # Changes: 0.96
 719 #   + `v' command shows version of readline.
 720 #     primitive completion works (dynamic variables, subs for `b' and `l',
 721 #     options). Can `p %var'
 722 #   + Better help (`h <' now works). New commands <<, >>, {, {{.
 723 #     {dump|print}_trace() coded (to be able to do it from <<cmd).
 724 #   + `c sub' documented.
 725 #   + At last enough magic combined to stop after the end of debuggee.
 726 #   + !! should work now (thanks to Emacs bracket matching an extra
 727 #     `]' in a regexp is caught).
 728 #   + `L', `D' and `A' span files now (as documented).
 729 #   + Breakpoints in `require'd code are possible (used in `R').
 730 #   +  Some additional words on internal work of debugger.
 731 #   + `b load filename' implemented.
 732 #   + `b postpone subr' implemented.
 733 #   + now only `q' exits debugger (overwritable on $inhibit_exit).
 734 #   + When restarting debugger breakpoints/actions persist.
 735 #   + Buglet: When restarting debugger only one breakpoint/action per
 736 #             autoloaded function persists.
 737 #
 738 # Changes: 0.97: NonStop will not stop in at_exit().
 739 #   + Option AutoTrace implemented.
 740 #   + Trace printed differently if frames are printed too.
 741 #   + new `inhibitExit' option.
 742 #   + printing of a very long statement interruptible.
 743 # Changes: 0.98: New command `m' for printing possible methods
 744 #   + 'l -' is a synonym for `-'.
 745 #   + Cosmetic bugs in printing stack trace.
 746 #   +  `frame' & 8 to print "expanded args" in stack trace.
 747 #   + Can list/break in imported subs.
 748 #   + new `maxTraceLen' option.
 749 #   + frame & 4 and frame & 8 granted.
 750 #   + new command `m'
 751 #   + nonstoppable lines do not have `:' near the line number.
 752 #   + `b compile subname' implemented.
 753 #   + Will not use $` any more.
 754 #   + `-' behaves sane now.
 755 # Changes: 0.99: Completion for `f', `m'.
 756 #   +  `m' will remove duplicate names instead of duplicate functions.
 757 #   + `b load' strips trailing whitespace.
 758 #     completion ignores leading `|'; takes into account current package
 759 #     when completing a subroutine name (same for `l').
 760 # Changes: 1.07: Many fixed by tchrist 13-March-2000
 761 #   BUG FIXES:
 762 #   + Added bare minimal security checks on perldb rc files, plus
 763 #     comments on what else is needed.
 764 #   + Fixed the ornaments that made "|h" completely unusable.
 765 #     They are not used in print_help if they will hurt.  Strip pod
 766 #     if we're paging to less.
 767 #   + Fixed mis-formatting of help messages caused by ornaments
 768 #     to restore Larry's original formatting.
 769 #   + Fixed many other formatting errors.  The code is still suboptimal,
 770 #     and needs a lot of work at restructuring.  It's also misindented
 771 #     in many places.
 772 #   + Fixed bug where trying to look at an option like your pager
 773 #     shows "1".
 774 #   + Fixed some $? processing.  Note: if you use csh or tcsh, you will
 775 #     lose.  You should consider shell escapes not using their shell,
 776 #     or else not caring about detailed status.  This should really be
 777 #     unified into one place, too.
 778 #   + Fixed bug where invisible trailing whitespace on commands hoses you,
 779 #     tricking Perl into thinking you weren't calling a debugger command!
 780 #   + Fixed bug where leading whitespace on commands hoses you.  (One
 781 #     suggests a leading semicolon or any other irrelevant non-whitespace
 782 #     to indicate literal Perl code.)
 783 #   + Fixed bugs that ate warnings due to wrong selected handle.
 784 #   + Fixed a precedence bug on signal stuff.
 785 #   + Fixed some unseemly wording.
 786 #   + Fixed bug in help command trying to call perl method code.
 787 #   + Fixed to call dumpvar from exception handler.  SIGPIPE killed us.
 788 #   ENHANCEMENTS:
 789 #   + Added some comments.  This code is still nasty spaghetti.
 790 #   + Added message if you clear your pre/post command stacks which was
 791 #     very easy to do if you just typed a bare >, <, or {.  (A command
 792 #     without an argument should *never* be a destructive action; this
 793 #     API is fundamentally screwed up; likewise option setting, which
 794 #     is equally buggered.)
 795 #   + Added command stack dump on argument of "?" for >, <, or {.
 796 #   + Added a semi-built-in doc viewer command that calls man with the
 797 #     proper %Config::Config path (and thus gets caching, man -k, etc),
 798 #     or else perldoc on obstreperous platforms.
 799 #   + Added to and rearranged the help information.
 800 #   + Detected apparent misuse of { ... } to declare a block; this used
 801 #     to work but now is a command, and mysteriously gave no complaint.
 802 #
 803 # Changes: 1.08: Apr 25, 2001  Jon Eveland <jweveland@yahoo.com>
 804 #   BUG FIX:
 805 #   + This patch to perl5db.pl cleans up formatting issues on the help
 806 #     summary (h h) screen in the debugger.  Mostly columnar alignment
 807 #     issues, plus converted the printed text to use all spaces, since
 808 #     tabs don't seem to help much here.
 809 #
 810 # Changes: 1.09: May 19, 2001  Ilya Zakharevich <ilya@math.ohio-state.edu>
 811 #   Minor bugs corrected;
 812 #   + Support for auto-creation of new TTY window on startup, either
 813 #     unconditionally, or if started as a kid of another debugger session;
 814 #   + New `O'ption CreateTTY
 815 #       I<CreateTTY>      bits control attempts to create a new TTY on events:
 816 #                         1: on fork()
 817 #                         2: debugger is started inside debugger
 818 #                         4: on startup
 819 #   + Code to auto-create a new TTY window on OS/2 (currently one
 820 #     extra window per session - need named pipes to have more...);
 821 #   + Simplified interface for custom createTTY functions (with a backward
 822 #     compatibility hack); now returns the TTY name to use; return of ''
 823 #     means that the function reset the I/O handles itself;
 824 #   + Better message on the semantic of custom createTTY function;
 825 #   + Convert the existing code to create a TTY into a custom createTTY
 826 #     function;
 827 #   + Consistent support for TTY names of the form "TTYin,TTYout";
 828 #   + Switch line-tracing output too to the created TTY window;
 829 #   + make `b fork' DWIM with CORE::GLOBAL::fork;
 830 #   + High-level debugger API cmd_*():
 831 #      cmd_b_load($filenamepart)            # b load filenamepart
 832 #      cmd_b_line($lineno [, $cond])        # b lineno [cond]
 833 #      cmd_b_sub($sub [, $cond])            # b sub [cond]
 834 #      cmd_stop()                           # Control-C
 835 #      cmd_d($lineno)                       # d lineno (B)
 836 #      The cmd_*() API returns FALSE on failure; in this case it outputs
 837 #      the error message to the debugging output.
 838 #   + Low-level debugger API
 839 #      break_on_load($filename)             # b load filename
 840 #      @files = report_break_on_load()      # List files with load-breakpoints
 841 #      breakable_line_in_filename($name, $from [, $to])
 842 #                                           # First breakable line in the
 843 #                                           # range $from .. $to.  $to defaults
 844 #                                           # to $from, and may be less than
 845 #                                           # $to
 846 #      breakable_line($from [, $to])        # Same for the current file
 847 #      break_on_filename_line($name, $lineno [, $cond])
 848 #                                           # Set breakpoint,$cond defaults to
 849 #                                           # 1
 850 #      break_on_filename_line_range($name, $from, $to [, $cond])
 851 #                                           # As above, on the first
 852 #                                           # breakable line in range
 853 #      break_on_line($lineno [, $cond])     # As above, in the current file
 854 #      break_subroutine($sub [, $cond])     # break on the first breakable line
 855 #      ($name, $from, $to) = subroutine_filename_lines($sub)
 856 #                                           # The range of lines of the text
 857 #      The low-level API returns TRUE on success, and die()s on failure.
 858 #
 859 # Changes: 1.10: May 23, 2001  Daniel Lewart <d-lewart@uiuc.edu>
 860 #   BUG FIXES:
 861 #   + Fixed warnings generated by "perl -dWe 42"
 862 #   + Corrected spelling errors
 863 #   + Squeezed Help (h) output into 80 columns
 864 #
 865 # Changes: 1.11: May 24, 2001  David Dyck <dcd@tc.fluke.com>
 866 #   + Made "x @INC" work like it used to
 867 #
 868 # Changes: 1.12: May 24, 2001  Daniel Lewart <d-lewart@uiuc.edu>
 869 #   + Fixed warnings generated by "O" (Show debugger options)
 870 #   + Fixed warnings generated by "p 42" (Print expression)
 871 # Changes: 1.13: Jun 19, 2001 Scott.L.Miller@compaq.com
 872 #   + Added windowSize option
 873 # Changes: 1.14: Oct  9, 2001 multiple
 874 #   + Clean up after itself on VMS (Charles Lane in 12385)
 875 #   + Adding "@ file" syntax (Peter Scott in 12014)
 876 #   + Debug reloading selfloaded stuff (Ilya Zakharevich in 11457)
 877 #   + $^S and other debugger fixes (Ilya Zakharevich in 11120)
 878 #   + Forgot a my() declaration (Ilya Zakharevich in 11085)
 879 # Changes: 1.15: Nov  6, 2001 Michael G Schwern <schwern@pobox.com>
 880 #   + Updated 1.14 change log
 881 #   + Added *dbline explainatory comments
 882 #   + Mentioning perldebguts man page
 883 # Changes: 1.16: Feb 15, 2002 Mark-Jason Dominus <mjd@plover.com>
 884 #   + $onetimeDump improvements
 885 # Changes: 1.17: Feb 20, 2002 Richard Foley <richard.foley@rfi.net>
 886 #   Moved some code to cmd_[.]()'s for clarity and ease of handling,
 887 #   rationalised the following commands and added cmd_wrapper() to
 888 #   enable switching between old and frighteningly consistent new
 889 #   behaviours for diehards: 'o CommandSet=pre580' (sigh...)
 890 #     a(add),       A(del)            # action expr   (added del by line)
 891 #   + b(add),       B(del)            # break  [line] (was b,D)
 892 #   + w(add),       W(del)            # watch  expr   (was W,W)
 893 #                                     # added del by expr
 894 #   + h(summary), h h(long)           # help (hh)     (was h h,h)
 895 #   + m(methods),   M(modules)        # ...           (was m,v)
 896 #   + o(option)                       # lc            (was O)
 897 #   + v(view code), V(view Variables) # ...           (was w,V)
 898 # Changes: 1.18: Mar 17, 2002 Richard Foley <richard.foley@rfi.net>
 899 #   + fixed missing cmd_O bug
 900 # Changes: 1.19: Mar 29, 2002 Spider Boardman
 901 #   + Added missing local()s -- DB::DB is called recursively.
 902 # Changes: 1.20: Feb 17, 2003 Richard Foley <richard.foley@rfi.net>
 903 #   + pre'n'post commands no longer trashed with no args
 904 #   + watch val joined out of eval()
 905 # Changes: 1.21: Jun 04, 2003 Joe McMahon <mcmahon@ibiblio.org>
 906 #   + Added comments and reformatted source. No bug fixes/enhancements.
 907 #   + Includes cleanup by Robin Barker and Jarkko Hietaniemi.
 908 # Changes: 1.22  Jun 09, 2003 Alex Vandiver <alexmv@MIT.EDU>
 909 #   + Flush stdout/stderr before the debugger prompt is printed.
 910 # Changes: 1.23: Dec 21, 2003 Dominique Quatravaux
 911 #   + Fix a side-effect of bug #24674 in the perl debugger ("odd taint bug")
 912 # Changes: 1.24: Mar 03, 2004 Richard Foley <richard.foley@rfi.net>
 913 #   + Added command to save all debugger commands for sourcing later.
 914 #   + Added command to display parent inheritance tree of given class.
 915 #   + Fixed minor newline in history bug.
 916 # Changes: 1.25: Apr 17, 2004 Richard Foley <richard.foley@rfi.net>
 917 #   + Fixed option bug (setting invalid options + not recognising valid short forms)
 918 # Changes: 1.26: Apr 22, 2004 Richard Foley <richard.foley@rfi.net>
 919 #   + unfork the 5.8.x and 5.9.x debuggers.
 920 #   + whitespace and assertions call cleanup across versions
 921 #   + H * deletes (resets) history
 922 #   + i now handles Class + blessed objects
 923 # Changes: 1.27: May 09, 2004 Richard Foley <richard.foley@rfi.net>
 924 #   + updated pod page references - clunky.
 925 #   + removed windowid restriction for forking into an xterm.
 926 #   + more whitespace again.
 927 #   + wrapped restart and enabled rerun [-n] (go back n steps) command.
 928 # Changes: 1.28: Oct 12, 2004 Richard Foley <richard.foley@rfi.net>
 929 #   + Added threads support (inc. e and E commands)
 930 ####################################################################
 931
 932 =head1 DEBUGGER INITIALIZATION
 933
 934 The debugger starts up in phases.
 935
 936 =head2 BASIC SETUP
 937
 938 First, it initializes the environment it wants to run in: turning off
 939 warnings during its own compilation, defining variables which it will need
 940 to avoid warnings later, setting itself up to not exit when the program
 941 terminates, and defaulting to printing return values for the C<r> command.
 942
 943 =cut
 944
 945 # Needed for the statement after exec():
 946 #
 947 # This BEGIN block is simply used to switch off warnings during debugger
 948 # compiliation. Probably it would be better practice to fix the warnings,
 949 # but this is how it's done at the moment.
 950
 951 BEGIN {
 952     $ini_warn = $^W;
 953     $^W       = 0;
 954 }    # Switch compilation warnings off until another BEGIN.
 955
 956 # test if assertions are supported and actived:
 957 BEGIN {
 958     $ini_assertion = eval "sub asserting_test : assertion {1}; 1";
 959
 960     # $ini_assertion = undef => assertions unsupported,
 961     #        "       = 1     => assertions supported
 962     # print "\$ini_assertion=$ini_assertion\n";
 963 }
 964
 965 local ($^W) = 0;    # Switch run-time warnings off during init.
 966
 967 =head2 THREADS SUPPORT
 968
 969 If we are running under a threaded Perl, we require threads and threads::shared
 970 if the environment variable C<PERL5DB_THREADED> is set, to enable proper
 971 threaded debugger control.  C<-dt> can also be used to set this.
 972
 973 Each new thread will be announced and the debugger prompt will always inform
 974 you of each new thread created.  It will also indicate the thread id in which
 975 we are currently running within the prompt like this:
 976
 977         [tid] DB<$i>
 978
 979 Where C<[tid]> is an integer thread id and C<$i> is the familiar debugger
 980 command prompt.  The prompt will show: C<[0]> when running under threads, but
 981 not actually in a thread.  C<[tid]> is consistent with C<gdb> usage.
 982
 983 While running under threads, when you set or delete a breakpoint (etc.), this
 984 will apply to all threads, not just the currently running one.  When you are
 985 in a currently executing thread, you will stay there until it completes.  With
 986 the current implementation it is not currently possible to hop from one thread
 987 to another.
 988
 989 The C<e> and C<E> commands are currently fairly minimal - see C<h e> and C<h E>.
 990
 991 Note that threading support was built into the debugger as of Perl version
 992 C<5.8.6> and debugger version C<1.2.8>.
 993
 994 =cut
 995
 996 BEGIN {
 997   # ensure we can share our non-threaded variables or no-op
 998   if ($ENV{PERL5DB_THREADED}) {
 999         require threads;
1000         require threads::shared;
1001         import threads::shared qw(share);
1002         $DBGR;
1003         share(\$DBGR);
1004         lock($DBGR);
1005         print "Threads support enabled\n";
1006   } else {
1007         *lock  = sub(*) {};
1008         *share = sub(*) {};
1009   }
1010 }
1011
1012 # This would probably be better done with "use vars", but that wasn't around
1013 # when this code was originally written. (Neither was "use strict".) And on
1014 # the principle of not fiddling with something that was working, this was
1015 # left alone.
1016 warn(               # Do not ;-)
1017     # These variables control the execution of 'dumpvar.pl'.
1018     $dumpvar::hashDepth,
1019     $dumpvar::arrayDepth,
1020     $dumpvar::dumpDBFiles,
1021     $dumpvar::dumpPackages,
1022     $dumpvar::quoteHighBit,
1023     $dumpvar::printUndef,
1024     $dumpvar::globPrint,
1025     $dumpvar::usageOnly,
1026
1027     # used to save @ARGV and extract any debugger-related flags.
1028     @ARGS,
1029
1030     # used to control die() reporting in diesignal()
1031     $Carp::CarpLevel,
1032
1033     # used to prevent multiple entries to diesignal()
1034     # (if for instance diesignal() itself dies)
1035     $panic,
1036
1037     # used to prevent the debugger from running nonstop
1038     # after a restart
1039     $second_time,
1040   )
1041   if 0;
1042
1043 foreach my $k (keys (%INC)) {
1044         &share(\$main::{'_<'.$filename});
1045 };
1046
1047 # Command-line + PERLLIB:
1048 # Save the contents of @INC before they are modified elsewhere.
1049 @ini_INC = @INC;
1050
1051 # This was an attempt to clear out the previous values of various
1052 # trapped errors. Apparently it didn't help. XXX More info needed!
1053 # $prevwarn = $prevdie = $prevbus = $prevsegv = ''; # Does not help?!
1054
1055 # We set these variables to safe values. We don't want to blindly turn
1056 # off warnings, because other packages may still want them.
1057 $trace = $signal = $single = 0;    # Uninitialized warning suppression
1058                                    # (local $^W cannot help - other packages!).
1059
1060 # Default to not exiting when program finishes; print the return
1061 # value when the 'r' command is used to return from a subroutine.
1062 $inhibit_exit = $option{PrintRet} = 1;
1063
1064 =head1 OPTION PROCESSING
1065
1066 The debugger's options are actually spread out over the debugger itself and
1067 C<dumpvar.pl>; some of these are variables to be set, while others are
1068 subs to be called with a value. To try to make this a little easier to
1069 manage, the debugger uses a few data structures to define what options
1070 are legal and how they are to be processed.
1071
1072 First, the C<@options> array defines the I<names> of all the options that
1073 are to be accepted.
1074
1075 =cut
1076
1077 @options = qw(
1078   CommandSet
1079   hashDepth    arrayDepth    dumpDepth
1080   DumpDBFiles  DumpPackages  DumpReused
1081   compactDump  veryCompact   quote
1082   HighBit      undefPrint    globPrint
1083   PrintRet     UsageOnly     frame
1084   AutoTrace    TTY           noTTY
1085   ReadLine     NonStop       LineInfo
1086   maxTraceLen  recallCommand ShellBang
1087   pager        tkRunning     ornaments
1088   signalLevel  warnLevel     dieLevel
1089   inhibit_exit ImmediateStop bareStringify
1090   CreateTTY    RemotePort    windowSize
1091   DollarCaretP OnlyAssertions WarnAssertions
1092 );
1093
1094 @RememberOnROptions = qw(DollarCaretP OnlyAssertions);
1095
1096 =pod
1097
1098 Second, C<optionVars> lists the variables that each option uses to save its
1099 state.
1100
1101 =cut
1102
1103 %optionVars = (
1104     hashDepth     => \$dumpvar::hashDepth,
1105     arrayDepth    => \$dumpvar::arrayDepth,
1106     CommandSet    => \$CommandSet,
1107     DumpDBFiles   => \$dumpvar::dumpDBFiles,
1108     DumpPackages  => \$dumpvar::dumpPackages,
1109     DumpReused    => \$dumpvar::dumpReused,
1110     HighBit       => \$dumpvar::quoteHighBit,
1111     undefPrint    => \$dumpvar::printUndef,
1112     globPrint     => \$dumpvar::globPrint,
1113     UsageOnly     => \$dumpvar::usageOnly,
1114     CreateTTY     => \$CreateTTY,
1115     bareStringify => \$dumpvar::bareStringify,
1116     frame         => \$frame,
1117     AutoTrace     => \$trace,
1118     inhibit_exit  => \$inhibit_exit,
1119     maxTraceLen   => \$maxtrace,
1120     ImmediateStop => \$ImmediateStop,
1121     RemotePort    => \$remoteport,
1122     windowSize    => \$window,
1123     WarnAssertions => \$warnassertions,
1124 );
1125
1126 =pod
1127
1128 Third, C<%optionAction> defines the subroutine to be called to process each
1129 option.
1130
1131 =cut
1132
1133 %optionAction = (
1134     compactDump   => \&dumpvar::compactDump,
1135     veryCompact   => \&dumpvar::veryCompact,
1136     quote         => \&dumpvar::quote,
1137     TTY           => \&TTY,
1138     noTTY         => \&noTTY,
1139     ReadLine      => \&ReadLine,
1140     NonStop       => \&NonStop,
1141     LineInfo      => \&LineInfo,
1142     recallCommand => \&recallCommand,
1143     ShellBang     => \&shellBang,
1144     pager         => \&pager,
1145     signalLevel   => \&signalLevel,
1146     warnLevel     => \&warnLevel,
1147     dieLevel      => \&dieLevel,
1148     tkRunning     => \&tkRunning,
1149     ornaments     => \&ornaments,
1150     RemotePort    => \&RemotePort,
1151     DollarCaretP  => \&DollarCaretP,
1152     OnlyAssertions=> \&OnlyAssertions,
1153 );
1154
1155 =pod
1156
1157 Last, the C<%optionRequire> notes modules that must be C<require>d if an
1158 option is used.
1159
1160 =cut
1161
1162 # Note that this list is not complete: several options not listed here
1163 # actually require that dumpvar.pl be loaded for them to work, but are
1164 # not in the table. A subsequent patch will correct this problem; for
1165 # the moment, we're just recommenting, and we are NOT going to change
1166 # function.
1167 %optionRequire = (
1168     compactDump => 'dumpvar.pl',
1169     veryCompact => 'dumpvar.pl',
1170     quote       => 'dumpvar.pl',
1171 );
1172
1173 =pod
1174
1175 There are a number of initialization-related variables which can be set
1176 by putting code to set them in a BEGIN block in the C<PERL5DB> environment
1177 variable. These are:
1178
1179 =over 4
1180
1181 =item C<$rl> - readline control XXX needs more explanation
1182
1183 =item C<$warnLevel> - whether or not debugger takes over warning handling
1184
1185 =item C<$dieLevel> - whether or not debugger takes over die handling
1186
1187 =item C<$signalLevel> - whether or not debugger takes over signal handling
1188
1189 =item C<$pre> - preprompt actions (array reference)
1190
1191 =item C<$post> - postprompt actions (array reference)
1192
1193 =item C<$pretype>
1194
1195 =item C<$CreateTTY> - whether or not to create a new TTY for this debugger
1196
1197 =item C<$CommandSet> - which command set to use (defaults to new, documented set)
1198
1199 =back
1200
1201 =cut
1202
1203 # These guys may be defined in $ENV{PERL5DB} :
1204 $rl          = 1     unless defined $rl;
1205 $warnLevel   = 1     unless defined $warnLevel;
1206 $dieLevel    = 1     unless defined $dieLevel;
1207 $signalLevel = 1     unless defined $signalLevel;
1208 $pre         = []    unless defined $pre;
1209 $post        = []    unless defined $post;
1210 $pretype     = []    unless defined $pretype;
1211 $CreateTTY   = 3     unless defined $CreateTTY;
1212 $CommandSet  = '580' unless defined $CommandSet;
1213
1214 share($rl);
1215 share($warnLevel);
1216 share($dieLevel);
1217 share($signalLevel);
1218 share($pre);
1219 share($post);
1220 share($pretype);
1221 share($rl);
1222 share($CreateTTY);
1223 share($CommandSet);
1224
1225 =pod
1226
1227 The default C<die>, C<warn>, and C<signal> handlers are set up.
1228
1229 =cut
1230
1231 warnLevel($warnLevel);
1232 dieLevel($dieLevel);
1233 signalLevel($signalLevel);
1234
1235 =pod
1236
1237 The pager to be used is needed next. We try to get it from the
1238 environment first.  if it's not defined there, we try to find it in
1239 the Perl C<Config.pm>.  If it's not there, we default to C<more>. We
1240 then call the C<pager()> function to save the pager name.
1241
1242 =cut
1243
1244 # This routine makes sure $pager is set up so that '|' can use it.
1245 pager(
1246
1247     # If PAGER is defined in the environment, use it.
1248     defined $ENV{PAGER}
1249     ? $ENV{PAGER}
1250
1251       # If not, see if Config.pm defines it.
1252     : eval { require Config }
1253       && defined $Config::Config{pager}
1254     ? $Config::Config{pager}
1255
1256       # If not, fall back to 'more'.
1257     : 'more'
1258   )
1259   unless defined $pager;
1260
1261 =pod
1262
1263 We set up the command to be used to access the man pages, the command
1264 recall character (C<!> unless otherwise defined) and the shell escape
1265 character (C<!> unless otherwise defined). Yes, these do conflict, and
1266 neither works in the debugger at the moment.
1267
1268 =cut
1269
1270 setman();
1271
1272 # Set up defaults for command recall and shell escape (note:
1273 # these currently don't work in linemode debugging).
1274 &recallCommand("!") unless defined $prc;
1275 &shellBang("!")     unless defined $psh;
1276
1277 =pod
1278
1279 We then set up the gigantic string containing the debugger help.
1280 We also set the limit on the number of arguments we'll display during a
1281 trace.
1282
1283 =cut
1284
1285 sethelp();
1286
1287 # If we didn't get a default for the length of eval/stack trace args,
1288 # set it here.
1289 $maxtrace = 400 unless defined $maxtrace;
1290
1291 =head2 SETTING UP THE DEBUGGER GREETING
1292
1293 The debugger I<greeting> helps to inform the user how many debuggers are
1294 running, and whether the current debugger is the primary or a child.
1295
1296 If we are the primary, we just hang onto our pid so we'll have it when
1297 or if we start a child debugger. If we are a child, we'll set things up
1298 so we'll have a unique greeting and so the parent will give us our own
1299 TTY later.
1300
1301 We save the current contents of the C<PERLDB_PIDS> environment variable
1302 because we mess around with it. We'll also need to hang onto it because
1303 we'll need it if we restart.
1304
1305 Child debuggers make a label out of the current PID structure recorded in
1306 PERLDB_PIDS plus the new PID. They also mark themselves as not having a TTY
1307 yet so the parent will give them one later via C<resetterm()>.
1308
1309 =cut
1310
1311 # Save the current contents of the environment; we're about to
1312 # much with it. We'll need this if we have to restart.
1313 $ini_pids = $ENV{PERLDB_PIDS};
1314
1315 if ( defined $ENV{PERLDB_PIDS} ) {
1316
1317     # We're a child. Make us a label out of the current PID structure
1318     # recorded in PERLDB_PIDS plus our (new) PID. Mark us as not having
1319     # a term yet so the parent will give us one later via resetterm().
1320     $pids = "[$ENV{PERLDB_PIDS}]";
1321     $ENV{PERLDB_PIDS} .= "->$$";
1322     $term_pid = -1;
1323 } ## end if (defined $ENV{PERLDB_PIDS...
1324 else {
1325
1326     # We're the parent PID. Initialize PERLDB_PID in case we end up with a
1327     # child debugger, and mark us as the parent, so we'll know to set up
1328     # more TTY's is we have to.
1329     $ENV{PERLDB_PIDS} = "$$";
1330     $pids             = "{pid=$$}";
1331     $term_pid         = $$;
1332 }
1333
1334 $pidprompt = '';
1335
1336 # Sets up $emacs as a synonym for $slave_editor.
1337 *emacs = $slave_editor if $slave_editor;    # May be used in afterinit()...
1338
1339 =head2 READING THE RC FILE
1340
1341 The debugger will read a file of initialization options if supplied. If
1342 running interactively, this is C<.perldb>; if not, it's C<perldb.ini>.
1343
1344 =cut
1345
1346 # As noted, this test really doesn't check accurately that the debugger
1347 # is running at a terminal or not.
1348
1349 if ( -e "/dev/tty" ) {                      # this is the wrong metric!
1350     $rcfile = ".perldb";
1351 }
1352 else {
1353     $rcfile = "perldb.ini";
1354 }
1355
1356 =pod
1357
1358 The debugger does a safety test of the file to be read. It must be owned
1359 either by the current user or root, and must only be writable by the owner.
1360
1361 =cut
1362
1363 # This wraps a safety test around "do" to read and evaluate the init file.
1364 #
1365 # This isn't really safe, because there's a race
1366 # between checking and opening.  The solution is to
1367 # open and fstat the handle, but then you have to read and
1368 # eval the contents.  But then the silly thing gets
1369 # your lexical scope, which is unfortunate at best.
1370 sub safe_do {
1371     my $file = shift;
1372
1373     # Just exactly what part of the word "CORE::" don't you understand?
1374     local $SIG{__WARN__};
1375     local $SIG{__DIE__};
1376
1377     unless ( is_safe_file($file) ) {
1378         CORE::warn <<EO_GRIPE;
1379 perldb: Must not source insecure rcfile $file.
1380         You or the superuser must be the owner, and it must not
1381         be writable by anyone but its owner.
1382 EO_GRIPE
1383         return;
1384     } ## end unless (is_safe_file($file...
1385
1386     do $file;
1387     CORE::warn("perldb: couldn't parse $file: $@") if $@;
1388 } ## end sub safe_do
1389
1390 # This is the safety test itself.
1391 #
1392 # Verifies that owner is either real user or superuser and that no
1393 # one but owner may write to it.  This function is of limited use
1394 # when called on a path instead of upon a handle, because there are
1395 # no guarantees that filename (by dirent) whose file (by ino) is
1396 # eventually accessed is the same as the one tested.
1397 # Assumes that the file's existence is not in doubt.
1398 sub is_safe_file {
1399     my $path = shift;
1400     stat($path) || return;    # mysteriously vaporized
1401     my ( $dev, $ino, $mode, $nlink, $uid, $gid ) = stat(_);
1402
1403     return 0 if $uid != 0 && $uid != $<;
1404     return 0 if $mode & 022;
1405     return 1;
1406 } ## end sub is_safe_file
1407
1408 # If the rcfile (whichever one we decided was the right one to read)
1409 # exists, we safely do it.
1410 if ( -f $rcfile ) {
1411     safe_do("./$rcfile");
1412 }
1413
1414 # If there isn't one here, try the user's home directory.
1415 elsif ( defined $ENV{HOME} && -f "$ENV{HOME}/$rcfile" ) {
1416     safe_do("$ENV{HOME}/$rcfile");
1417 }
1418
1419 # Else try the login directory.
1420 elsif ( defined $ENV{LOGDIR} && -f "$ENV{LOGDIR}/$rcfile" ) {
1421     safe_do("$ENV{LOGDIR}/$rcfile");
1422 }
1423
1424 # If the PERLDB_OPTS variable has options in it, parse those out next.
1425 if ( defined $ENV{PERLDB_OPTS} ) {
1426     parse_options( $ENV{PERLDB_OPTS} );
1427 }
1428
1429 =pod
1430
1431 The last thing we do during initialization is determine which subroutine is
1432 to be used to obtain a new terminal when a new debugger is started. Right now,
1433 the debugger only handles X Windows and OS/2.
1434
1435 =cut
1436
1437 # Set up the get_fork_TTY subroutine to be aliased to the proper routine.
1438 # Works if you're running an xterm or xterm-like window, or you're on
1439 # OS/2. This may need some expansion: for instance, this doesn't handle
1440 # OS X Terminal windows.
1441
1442 if (
1443     not defined &get_fork_TTY    # no routine exists,
1444     and defined $ENV{TERM}       # and we know what kind
1445                                  # of terminal this is,
1446     and $ENV{TERM} eq 'xterm'    # and it's an xterm,
1447 #   and defined $ENV{WINDOWID}   # and we know what window this is, <- wrong metric
1448     and defined $ENV{DISPLAY}    # and what display it's on,
1449   )
1450 {
1451     *get_fork_TTY = \&xterm_get_fork_TTY;    # use the xterm version
1452 } ## end if (not defined &get_fork_TTY...
1453 elsif ( $^O eq 'os2' ) {                     # If this is OS/2,
1454     *get_fork_TTY = \&os2_get_fork_TTY;      # use the OS/2 version
1455 }
1456
1457 # untaint $^O, which may have been tainted by the last statement.
1458 # see bug [perl #24674]
1459 $^O =~ m/^(.*)\z/;
1460 $^O = $1;
1461
1462 # Here begin the unreadable code.  It needs fixing.
1463
1464 =head2 RESTART PROCESSING
1465
1466 This section handles the restart command. When the C<R> command is invoked, it
1467 tries to capture all of the state it can into environment variables, and
1468 then sets C<PERLDB_RESTART>. When we start executing again, we check to see
1469 if C<PERLDB_RESTART> is there; if so, we reload all the information that
1470 the R command stuffed into the environment variables.
1471
1472   PERLDB_RESTART   - flag only, contains no restart data itself.
1473   PERLDB_HIST      - command history, if it's available
1474   PERLDB_ON_LOAD   - breakpoints set by the rc file
1475   PERLDB_POSTPONE  - subs that have been loaded/not executed, and have actions
1476   PERLDB_VISITED   - files that had breakpoints
1477   PERLDB_FILE_...  - breakpoints for a file
1478   PERLDB_OPT       - active options
1479   PERLDB_INC       - the original @INC
1480   PERLDB_PRETYPE   - preprompt debugger actions
1481   PERLDB_PRE       - preprompt Perl code
1482   PERLDB_POST      - post-prompt Perl code
1483   PERLDB_TYPEAHEAD - typeahead captured by readline()
1484
1485 We chug through all these variables and plug the values saved in them
1486 back into the appropriate spots in the debugger.
1487
1488 =cut
1489
1490 if ( exists $ENV{PERLDB_RESTART} ) {
1491
1492     # We're restarting, so we don't need the flag that says to restart anymore.
1493     delete $ENV{PERLDB_RESTART};
1494
1495     # $restart = 1;
1496     @hist          = get_list('PERLDB_HIST');
1497     %break_on_load = get_list("PERLDB_ON_LOAD");
1498     %postponed     = get_list("PERLDB_POSTPONE");
1499
1500         share(@hist);
1501         share(@truehist);
1502         share(%break_on_load);
1503         share(%postponed);
1504
1505     # restore breakpoints/actions
1506     my @had_breakpoints = get_list("PERLDB_VISITED");
1507     for ( 0 .. $#had_breakpoints ) {
1508         my %pf = get_list("PERLDB_FILE_$_");
1509         $postponed_file{ $had_breakpoints[$_] } = \%pf if %pf;
1510     }
1511
1512     # restore options
1513     my %opt = get_list("PERLDB_OPT");
1514     my ( $opt, $val );
1515     while ( ( $opt, $val ) = each %opt ) {
1516         $val =~ s/[\\\']/\\$1/g;
1517         parse_options("$opt'$val'");
1518     }
1519
1520     # restore original @INC
1521     @INC     = get_list("PERLDB_INC");
1522     @ini_INC = @INC;
1523
1524     # return pre/postprompt actions and typeahead buffer
1525     $pretype   = [ get_list("PERLDB_PRETYPE") ];
1526     $pre       = [ get_list("PERLDB_PRE") ];
1527     $post      = [ get_list("PERLDB_POST") ];
1528     @typeahead = get_list( "PERLDB_TYPEAHEAD", @typeahead );
1529 } ## end if (exists $ENV{PERLDB_RESTART...
1530
1531 =head2 SETTING UP THE TERMINAL
1532
1533 Now, we'll decide how the debugger is going to interact with the user.
1534 If there's no TTY, we set the debugger to run non-stop; there's not going
1535 to be anyone there to enter commands.
1536
1537 =cut
1538
1539 if ($notty) {
1540     $runnonstop = 1;
1541         share($runnonstop);
1542 }
1543
1544 =pod
1545
1546 If there is a TTY, we have to determine who it belongs to before we can
1547 proceed. If this is a slave editor or graphical debugger (denoted by
1548 the first command-line switch being '-emacs'), we shift this off and
1549 set C<$rl> to 0 (XXX ostensibly to do straight reads).
1550
1551 =cut
1552
1553 else {
1554
1555     # Is Perl being run from a slave editor or graphical debugger?
1556     # If so, don't use readline, and set $slave_editor = 1.
1557     $slave_editor =
1558       ( ( defined $main::ARGV[0] ) and ( $main::ARGV[0] eq '-emacs' ) );
1559     $rl = 0, shift(@main::ARGV) if $slave_editor;
1560
1561     #require Term::ReadLine;
1562
1563 =pod
1564
1565 We then determine what the console should be on various systems:
1566
1567 =over 4
1568
1569 =item * Cygwin - We use C<stdin> instead of a separate device.
1570
1571 =cut
1572
1573     if ( $^O eq 'cygwin' ) {
1574
1575         # /dev/tty is binary. use stdin for textmode
1576         undef $console;
1577     }
1578
1579 =item * Unix - use C</dev/tty>.
1580
1581 =cut
1582
1583     elsif ( -e "/dev/tty" ) {
1584         $console = "/dev/tty";
1585     }
1586
1587 =item * Windows or MSDOS - use C<con>.
1588
1589 =cut
1590
1591     elsif ( $^O eq 'dos' or -e "con" or $^O eq 'MSWin32' ) {
1592         $console = "con";
1593     }
1594
1595 =item * MacOS - use C<Dev:Console:Perl Debug> if this is the MPW version; C<Dev:
1596 Console> if not.
1597
1598 Note that Mac OS X returns C<darwin>, not C<MacOS>. Also note that the debugger doesn't do anything special for C<darwin>. Maybe it should.
1599
1600 =cut
1601
1602     elsif ( $^O eq 'MacOS' ) {
1603         if ( $MacPerl::Version !~ /MPW/ ) {
1604             $console =
1605               "Dev:Console:Perl Debug";    # Separate window for application
1606         }
1607         else {
1608             $console = "Dev:Console";
1609         }
1610     } ## end elsif ($^O eq 'MacOS')
1611
1612 =item * VMS - use C<sys$command>.
1613
1614 =cut
1615
1616     else {
1617
1618         # everything else is ...
1619         $console = "sys\$command";
1620     }
1621
1622 =pod
1623
1624 =back
1625
1626 Several other systems don't use a specific console. We C<undef $console>
1627 for those (Windows using a slave editor/graphical debugger, NetWare, OS/2
1628 with a slave editor, Epoc).
1629
1630 =cut
1631
1632     if ( ( $^O eq 'MSWin32' ) and ( $slave_editor or defined $ENV{EMACS} ) ) {
1633
1634         # /dev/tty is binary. use stdin for textmode
1635         $console = undef;
1636     }
1637
1638     if ( $^O eq 'NetWare' ) {
1639
1640         # /dev/tty is binary. use stdin for textmode
1641         $console = undef;
1642     }
1643
1644     # In OS/2, we need to use STDIN to get textmode too, even though
1645     # it pretty much looks like Unix otherwise.
1646     if ( defined $ENV{OS2_SHELL} and ( $slave_editor or $ENV{WINDOWID} ) )
1647     {    # In OS/2
1648         $console = undef;
1649     }
1650
1651     # EPOC also falls into the 'got to use STDIN' camp.
1652     if ( $^O eq 'epoc' ) {
1653         $console = undef;
1654     }
1655
1656 =pod
1657
1658 If there is a TTY hanging around from a parent, we use that as the console.
1659
1660 =cut
1661
1662     $console = $tty if defined $tty;
1663
1664 =head2 SOCKET HANDLING
1665
1666 The debugger is capable of opening a socket and carrying out a debugging
1667 session over the socket.
1668
1669 If C<RemotePort> was defined in the options, the debugger assumes that it
1670 should try to start a debugging session on that port. It builds the socket
1671 and then tries to connect the input and output filehandles to it.
1672
1673 =cut
1674
1675     # Handle socket stuff.
1676
1677     if ( defined $remoteport ) {
1678
1679         # If RemotePort was defined in the options, connect input and output
1680         # to the socket.
1681         require IO::Socket;
1682         $OUT = new IO::Socket::INET(
1683             Timeout  => '10',
1684             PeerAddr => $remoteport,
1685             Proto    => 'tcp',
1686         );
1687         if ( !$OUT ) { die "Unable to connect to remote host: $remoteport\n"; }
1688         $IN = $OUT;
1689     } ## end if (defined $remoteport)
1690
1691 =pod
1692
1693 If no C<RemotePort> was defined, and we want to create a TTY on startup,
1694 this is probably a situation where multiple debuggers are running (for example,
1695 a backticked command that starts up another debugger). We create a new IN and
1696 OUT filehandle, and do the necessary mojo to create a new TTY if we know how
1697 and if we can.
1698
1699 =cut
1700
1701     # Non-socket.
1702     else {
1703
1704         # Two debuggers running (probably a system or a backtick that invokes
1705         # the debugger itself under the running one). create a new IN and OUT
1706         # filehandle, and do the necessary mojo to create a new tty if we
1707         # know how, and we can.
1708         create_IN_OUT(4) if $CreateTTY & 4;
1709         if ($console) {
1710
1711             # If we have a console, check to see if there are separate ins and
1712             # outs to open. (They are assumed identiical if not.)
1713
1714             my ( $i, $o ) = split /,/, $console;
1715             $o = $i unless defined $o;
1716
1717             # read/write on in, or just read, or read on STDIN.
1718             open( IN,      "+<$i" )
1719               || open( IN, "<$i" )
1720               || open( IN, "<&STDIN" );
1721
1722             # read/write/create/clobber out, or write/create/clobber out,
1723             # or merge with STDERR, or merge with STDOUT.
1724                  open( OUT, "+>$o" )
1725               || open( OUT, ">$o" )
1726               || open( OUT, ">&STDERR" )
1727               || open( OUT, ">&STDOUT" );    # so we don't dongle stdout
1728
1729         } ## end if ($console)
1730         elsif ( not defined $console ) {
1731
1732             # No console. Open STDIN.
1733             open( IN, "<&STDIN" );
1734
1735             # merge with STDERR, or with STDOUT.
1736             open( OUT,      ">&STDERR" )
1737               || open( OUT, ">&STDOUT" );    # so we don't dongle stdout
1738             $console = 'STDIN/OUT';
1739         } ## end elsif (not defined $console)
1740
1741         # Keep copies of the filehandles so that when the pager runs, it
1742         # can close standard input without clobbering ours.
1743         $IN = \*IN, $OUT = \*OUT if $console or not defined $console;
1744     } ## end elsif (from if(defined $remoteport))
1745
1746     # Unbuffer DB::OUT. We need to see responses right away.
1747     my $previous = select($OUT);
1748     $| = 1;                                  # for DB::OUT
1749     select($previous);
1750
1751     # Line info goes to debugger output unless pointed elsewhere.
1752     # Pointing elsewhere makes it possible for slave editors to
1753     # keep track of file and position. We have both a filehandle
1754     # and a I/O description to keep track of.
1755     $LINEINFO = $OUT     unless defined $LINEINFO;
1756     $lineinfo = $console unless defined $lineinfo;
1757         # share($LINEINFO); # <- unable to share globs
1758         share($lineinfo);   #
1759
1760 =pod
1761
1762 To finish initialization, we show the debugger greeting,
1763 and then call the C<afterinit()> subroutine if there is one.
1764
1765 =cut
1766
1767     # Show the debugger greeting.
1768     $header =~ s/.Header: ([^,]+),v(\s+\S+\s+\S+).*$/$1$2/;
1769     unless ($runnonstop) {
1770         local $\ = '';
1771         local $, = '';
1772         if ( $term_pid eq '-1' ) {
1773             print $OUT "\nDaughter DB session started...\n";
1774         }
1775         else {
1776             print $OUT "\nLoading DB routines from $header\n";
1777             print $OUT (
1778                 "Editor support ",
1779                 $slave_editor ? "enabled" : "available", ".\n"
1780             );
1781             print $OUT
1782 "\nEnter h or `h h' for help, or `$doccmd perldebug' for more help.\n\n";
1783         } ## end else [ if ($term_pid eq '-1')
1784     } ## end unless ($runnonstop)
1785 } ## end else [ if ($notty)
1786
1787 # XXX This looks like a bug to me.
1788 # Why copy to @ARGS and then futz with @args?
1789 @ARGS = @ARGV;
1790 for (@args) {
1791     # Make sure backslashes before single quotes are stripped out, and
1792     # keep args unless they are numeric (XXX why?)
1793     # s/\'/\\\'/g;                      # removed while not justified understandably
1794     # s/(.*)/'$1'/ unless /^-?[\d.]+$/; # ditto
1795 }
1796
1797 # If there was an afterinit() sub defined, call it. It will get
1798 # executed in our scope, so it can fiddle with debugger globals.
1799 if ( defined &afterinit ) {    # May be defined in $rcfile
1800     &afterinit();
1801 }
1802
1803 # Inform us about "Stack dump during die enabled ..." in dieLevel().
1804 $I_m_init = 1;
1805
1806 ############################################################ Subroutines
1807
1808 =head1 SUBROUTINES
1809
1810 =head2 DB
1811
1812 This gigantic subroutine is the heart of the debugger. Called before every
1813 statement, its job is to determine if a breakpoint has been reached, and
1814 stop if so; read commands from the user, parse them, and execute
1815 them, and hen send execution off to the next statement.
1816
1817 Note that the order in which the commands are processed is very important;
1818 some commands earlier in the loop will actually alter the C<$cmd> variable
1819 to create other commands to be executed later. This is all highly I<optimized>
1820 but can be confusing. Check the comments for each C<$cmd ... && do {}> to
1821 see what's happening in any given command.
1822
1823 =cut
1824
1825 sub DB {
1826
1827     # lock the debugger and get the thread id for the prompt
1828         lock($DBGR);
1829         my $tid;
1830         if ($ENV{PERL5DB_THREADED}) {
1831                 $tid = eval { "[".threads->self->tid."]" };
1832         }
1833
1834     # Check for whether we should be running continuously or not.
1835     # _After_ the perl program is compiled, $single is set to 1:
1836     if ( $single and not $second_time++ ) {
1837
1838         # Options say run non-stop. Run until we get an interrupt.
1839         if ($runnonstop) {    # Disable until signal
1840                 # If there's any call stack in place, turn off single
1841                 # stepping into subs throughout the stack.
1842             for ( $i = 0 ; $i <= $stack_depth ; ) {
1843                 $stack[ $i++ ] &= ~1;
1844             }
1845
1846             # And we are now no longer in single-step mode.
1847             $single = 0;
1848
1849             # If we simply returned at this point, we wouldn't get
1850             # the trace info. Fall on through.
1851             # return;
1852         } ## end if ($runnonstop)
1853
1854         elsif ($ImmediateStop) {
1855
1856             # We are supposed to stop here; XXX probably a break.
1857             $ImmediateStop = 0;    # We've processed it; turn it off
1858             $signal        = 1;    # Simulate an interrupt to force
1859                                    # us into the command loop
1860         }
1861     } ## end if ($single and not $second_time...
1862
1863     # If we're in single-step mode, or an interrupt (real or fake)
1864     # has occurred, turn off non-stop mode.
1865     $runnonstop = 0 if $single or $signal;
1866
1867     # Preserve current values of $@, $!, $^E, $,, $/, $\, $^W.
1868     # The code being debugged may have altered them.
1869     &save;
1870
1871     # Since DB::DB gets called after every line, we can use caller() to
1872     # figure out where we last were executing. Sneaky, eh? This works because
1873     # caller is returning all the extra information when called from the
1874     # debugger.
1875     local ( $package, $filename, $line ) = caller;
1876     local $filename_ini = $filename;
1877
1878     # set up the context for DB::eval, so it can properly execute
1879     # code on behalf of the user. We add the package in so that the
1880     # code is eval'ed in the proper package (not in the debugger!).
1881     local $usercontext =
1882       '($@, $!, $^E, $,, $/, $\, $^W) = @saved;' . "package $package;";
1883
1884     # Create an alias to the active file magical array to simplify
1885     # the code here.
1886     local (*dbline) = $main::{ '_<' . $filename };
1887
1888     # we need to check for pseudofiles on Mac OS (these are files
1889     # not attached to a filename, but instead stored in Dev:Pseudo)
1890     if ( $^O eq 'MacOS' && $#dbline < 0 ) {
1891         $filename_ini = $filename = 'Dev:Pseudo';
1892         *dbline = $main::{ '_<' . $filename };
1893     }
1894
1895     # Last line in the program.
1896     local $max = $#dbline;
1897
1898     # if we have something here, see if we should break.
1899     if ( $dbline{$line}
1900         && ( ( $stop, $action ) = split( /\0/, $dbline{$line} ) ) )
1901     {
1902
1903         # Stop if the stop criterion says to just stop.
1904         if ( $stop eq '1' ) {
1905             $signal |= 1;
1906         }
1907
1908         # It's a conditional stop; eval it in the user's context and
1909         # see if we should stop. If so, remove the one-time sigil.
1910         elsif ($stop) {
1911             $evalarg = "\$DB::signal |= 1 if do {$stop}";
1912             &eval;
1913             $dbline{$line} =~ s/;9($|\0)/$1/;
1914         }
1915     } ## end if ($dbline{$line} && ...
1916
1917     # Preserve the current stop-or-not, and see if any of the W
1918     # (watch expressions) has changed.
1919     my $was_signal = $signal;
1920
1921     # If we have any watch expressions ...
1922     if ( $trace & 2 ) {
1923         for ( my $n = 0 ; $n <= $#to_watch ; $n++ ) {
1924             $evalarg = $to_watch[$n];
1925             local $onetimeDump;    # Tell DB::eval() to not output results
1926
1927             # Fix context DB::eval() wants to return an array, but
1928             # we need a scalar here.
1929             my ($val) = join( "', '", &eval );
1930             $val = ( ( defined $val ) ? "'$val'" : 'undef' );
1931
1932             # Did it change?
1933             if ( $val ne $old_watch[$n] ) {
1934
1935                 # Yep! Show the difference, and fake an interrupt.
1936                 $signal = 1;
1937                 print $OUT <<EOP;
1938 Watchpoint $n:\t$to_watch[$n] changed:
1939     old value:\t$old_watch[$n]
1940     new value:\t$val
1941 EOP
1942                 $old_watch[$n] = $val;
1943             } ## end if ($val ne $old_watch...
1944         } ## end for (my $n = 0 ; $n <= ...
1945     } ## end if ($trace & 2)
1946
1947 =head2 C<watchfunction()>
1948
1949 C<watchfunction()> is a function that can be defined by the user; it is a
1950 function which will be run on each entry to C<DB::DB>; it gets the
1951 current package, filename, and line as its parameters.
1952
1953 The watchfunction can do anything it likes; it is executing in the
1954 debugger's context, so it has access to all of the debugger's internal
1955 data structures and functions.
1956
1957 C<watchfunction()> can control the debugger's actions. Any of the following
1958 will cause the debugger to return control to the user's program after
1959 C<watchfunction()> executes:
1960
1961 =over 4
1962
1963 =item *
1964
1965 Returning a false value from the C<watchfunction()> itself.
1966
1967 =item *
1968
1969 Altering C<$single> to a false value.
1970
1971 =item *
1972
1973 Altering C<$signal> to a false value.
1974
1975 =item *
1976
1977 Turning off the C<4> bit in C<$trace> (this also disables the
1978 check for C<watchfunction()>. This can be done with
1979
1980     $trace &= ~4;
1981
1982 =back
1983
1984 =cut
1985
1986     # If there's a user-defined DB::watchfunction, call it with the
1987     # current package, filename, and line. The function executes in
1988     # the DB:: package.
1989     if ( $trace & 4 ) {    # User-installed watch
1990         return
1991           if watchfunction( $package, $filename, $line )
1992           and not $single
1993           and not $was_signal
1994           and not( $trace & ~4 );
1995     } ## end if ($trace & 4)
1996
1997     # Pick up any alteration to $signal in the watchfunction, and
1998     # turn off the signal now.
1999     $was_signal = $signal;
2000     $signal     = 0;
2001
2002 =head2 GETTING READY TO EXECUTE COMMANDS
2003
2004 The debugger decides to take control if single-step mode is on, the
2005 C<t> command was entered, or the user generated a signal. If the program
2006 has fallen off the end, we set things up so that entering further commands
2007 won't cause trouble, and we say that the program is over.
2008
2009 =cut
2010
2011     # Check to see if we should grab control ($single true,
2012     # trace set appropriately, or we got a signal).
2013     if ( $single || ( $trace & 1 ) || $was_signal ) {
2014
2015         # Yes, grab control.
2016         if ($slave_editor) {
2017
2018             # Tell the editor to update its position.
2019             $position = "\032\032$filename:$line:0\n";
2020             print_lineinfo($position);
2021         }
2022
2023 =pod
2024
2025 Special check: if we're in package C<DB::fake>, we've gone through the
2026 C<END> block at least once. We set up everything so that we can continue
2027 to enter commands and have a valid context to be in.
2028
2029 =cut
2030
2031         elsif ( $package eq 'DB::fake' ) {
2032
2033             # Fallen off the end already.
2034             $term || &setterm;
2035             print_help(<<EOP);
2036 Debugged program terminated.  Use B<q> to quit or B<R> to restart,
2037   use B<o> I<inhibit_exit> to avoid stopping after program termination,
2038   B<h q>, B<h R> or B<h o> to get additional info.
2039 EOP
2040
2041             # Set the DB::eval context appropriately.
2042             $package     = 'main';
2043             $usercontext =
2044                 '($@, $!, $^E, $,, $/, $\, $^W) = @saved;'
2045               . "package $package;";    # this won't let them modify, alas
2046         } ## end elsif ($package eq 'DB::fake')
2047
2048 =pod
2049
2050 If the program hasn't finished executing, we scan forward to the
2051 next executable line, print that out, build the prompt from the file and line
2052 number information, and print that.
2053
2054 =cut
2055
2056         else {
2057
2058             # Still somewhere in the midst of execution. Set up the
2059             #  debugger prompt.
2060             $sub =~ s/\'/::/;    # Swap Perl 4 package separators (') to
2061                                  # Perl 5 ones (sorry, we don't print Klingon
2062                                  #module names)
2063
2064             $prefix = $sub =~ /::/ ? "" : "${'package'}::";
2065             $prefix .= "$sub($filename:";
2066             $after = ( $dbline[$line] =~ /\n$/ ? '' : "\n" );
2067
2068             # Break up the prompt if it's really long.
2069             if ( length($prefix) > 30 ) {
2070                 $position = "$prefix$line):\n$line:\t$dbline[$line]$after";
2071                 $prefix   = "";
2072                 $infix    = ":\t";
2073             }
2074             else {
2075                 $infix    = "):\t";
2076                 $position = "$prefix$line$infix$dbline[$line]$after";
2077             }
2078
2079             # Print current line info, indenting if necessary.
2080             if ($frame) {
2081                 print_lineinfo( ' ' x $stack_depth,
2082                     "$line:\t$dbline[$line]$after" );
2083             }
2084             else {
2085                 print_lineinfo($position);
2086             }
2087
2088             # Scan forward, stopping at either the end or the next
2089             # unbreakable line.
2090             for ( $i = $line + 1 ; $i <= $max && $dbline[$i] == 0 ; ++$i )
2091             {    #{ vi
2092
2093                 # Drop out on null statements, block closers, and comments.
2094                 last if $dbline[$i] =~ /^\s*[\;\}\#\n]/;
2095
2096                 # Drop out if the user interrupted us.
2097                 last if $signal;
2098
2099                 # Append a newline if the line doesn't have one. Can happen
2100                 # in eval'ed text, for instance.
2101                 $after = ( $dbline[$i] =~ /\n$/ ? '' : "\n" );
2102
2103                 # Next executable line.
2104                 $incr_pos = "$prefix$i$infix$dbline[$i]$after";
2105                 $position .= $incr_pos;
2106                 if ($frame) {
2107
2108                     # Print it indented if tracing is on.
2109                     print_lineinfo( ' ' x $stack_depth,
2110                         "$i:\t$dbline[$i]$after" );
2111                 }
2112                 else {
2113                     print_lineinfo($incr_pos);
2114                 }
2115             } ## end for ($i = $line + 1 ; $i...
2116         } ## end else [ if ($slave_editor)
2117     } ## end if ($single || ($trace...
2118
2119 =pod
2120
2121 If there's an action to be executed for the line we stopped at, execute it.
2122 If there are any preprompt actions, execute those as well.
2123
2124 =cut
2125
2126     # If there's an action, do it now.
2127     $evalarg = $action, &eval if $action;
2128
2129     # Are we nested another level (e.g., did we evaluate a function
2130     # that had a breakpoint in it at the debugger prompt)?
2131     if ( $single || $was_signal ) {
2132
2133         # Yes, go down a level.
2134         local $level = $level + 1;
2135
2136         # Do any pre-prompt actions.
2137         foreach $evalarg (@$pre) {
2138             &eval;
2139         }
2140
2141         # Complain about too much recursion if we passed the limit.
2142         print $OUT $stack_depth . " levels deep in subroutine calls!\n"
2143           if $single & 4;
2144
2145         # The line we're currently on. Set $incr to -1 to stay here
2146         # until we get a command that tells us to advance.
2147         $start = $line;
2148         $incr  = -1;      # for backward motion.
2149
2150         # Tack preprompt debugger actions ahead of any actual input.
2151         @typeahead = ( @$pretype, @typeahead );
2152
2153 =head2 WHERE ARE WE?
2154
2155 XXX Relocate this section?
2156
2157 The debugger normally shows the line corresponding to the current line of
2158 execution. Sometimes, though, we want to see the next line, or to move elsewhere
2159 in the file. This is done via the C<$incr>, C<$start>, and C<$max> variables.
2160
2161 C<$incr> controls by how many lines the I<current> line should move forward
2162 after a command is executed. If set to -1, this indicates that the I<current>
2163 line shouldn't change.
2164
2165 C<$start> is the I<current> line. It is used for things like knowing where to
2166 move forwards or backwards from when doing an C<L> or C<-> command.
2167
2168 C<$max> tells the debugger where the last line of the current file is. It's
2169 used to terminate loops most often.
2170
2171 =head2 THE COMMAND LOOP
2172
2173 Most of C<DB::DB> is actually a command parsing and dispatch loop. It comes
2174 in two parts:
2175
2176 =over 4
2177
2178 =item *
2179
2180 The outer part of the loop, starting at the C<CMD> label. This loop
2181 reads a command and then executes it.
2182
2183 =item *
2184
2185 The inner part of the loop, starting at the C<PIPE> label. This part
2186 is wholly contained inside the C<CMD> block and only executes a command.
2187 Used to handle commands running inside a pager.
2188
2189 =back
2190
2191 So why have two labels to restart the loop? Because sometimes, it's easier to
2192 have a command I<generate> another command and then re-execute the loop to do
2193 the new command. This is faster, but perhaps a bit more convoluted.
2194
2195 =cut
2196
2197         # The big command dispatch loop. It keeps running until the
2198         # user yields up control again.
2199         #
2200         # If we have a terminal for input, and we get something back
2201         # from readline(), keep on processing.
2202       CMD:
2203         while (
2204
2205             # We have a terminal, or can get one ...
2206             ( $term || &setterm ),
2207
2208             # ... and it belogs to this PID or we get one for this PID ...
2209             ( $term_pid == $$ or resetterm(1) ),
2210
2211             # ... and we got a line of command input ...
2212             defined(
2213                 $cmd = &readline(
2214                         "$pidprompt $tid DB"
2215                       . ( '<' x $level )
2216                       . ( $#hist + 1 )
2217                       . ( '>' x $level ) . " "
2218                 )
2219             )
2220           )
2221         {
2222
2223                         share($cmd);
2224             # ... try to execute the input as debugger commands.
2225
2226             # Don't stop running.
2227             $single = 0;
2228
2229             # No signal is active.
2230             $signal = 0;
2231
2232             # Handle continued commands (ending with \):
2233             $cmd =~ s/\\$/\n/ && do {
2234                 $cmd .= &readline("  cont: ");
2235                 redo CMD;
2236             };
2237
2238 =head4 The null command
2239
2240 A newline entered by itself means I<re-execute the last command>. We grab the
2241 command out of C<$laststep> (where it was recorded previously), and copy it
2242 back into C<$cmd> to be executed below. If there wasn't any previous command,
2243 we'll do nothing below (no command will match). If there was, we also save it
2244 in the command history and fall through to allow the command parsing to pick
2245 it up.
2246
2247 =cut
2248
2249             # Empty input means repeat the last command.
2250             $cmd =~ /^$/ && ( $cmd = $laststep );
2251             chomp($cmd);    # get rid of the annoying extra newline
2252             push( @hist, $cmd ) if length($cmd) > 1;
2253             push( @truehist, $cmd );
2254                         share(@hist);
2255                         share(@truehist);
2256
2257             # This is a restart point for commands that didn't arrive
2258             # via direct user input. It allows us to 'redo PIPE' to
2259             # re-execute command processing without reading a new command.
2260           PIPE: {
2261                 $cmd =~ s/^\s+//s;    # trim annoying leading whitespace
2262                 $cmd =~ s/\s+$//s;    # trim annoying trailing whitespace
2263                 ($i) = split( /\s+/, $cmd );
2264
2265 =head3 COMMAND ALIASES
2266
2267 The debugger can create aliases for commands (these are stored in the
2268 C<%alias> hash). Before a command is executed, the command loop looks it up
2269 in the alias hash and substitutes the contents of the alias for the command,
2270 completely replacing it.
2271
2272 =cut
2273
2274                 # See if there's an alias for the command, and set it up if so.
2275                 if ( $alias{$i} ) {
2276
2277                     # Squelch signal handling; we want to keep control here
2278                     # if something goes loco during the alias eval.
2279                     local $SIG{__DIE__};
2280                     local $SIG{__WARN__};
2281
2282                     # This is a command, so we eval it in the DEBUGGER's
2283                     # scope! Otherwise, we can't see the special debugger
2284                     # variables, or get to the debugger's subs. (Well, we
2285                     # _could_, but why make it even more complicated?)
2286                     eval "\$cmd =~ $alias{$i}";
2287                     if ($@) {
2288                         local $\ = '';
2289                         print $OUT "Couldn't evaluate `$i' alias: $@";
2290                         next CMD;
2291                     }
2292                 } ## end if ($alias{$i})
2293
2294 =head3 MAIN-LINE COMMANDS
2295
2296 All of these commands work up to and after the program being debugged has
2297 terminated.
2298
2299 =head4 C<q> - quit
2300
2301 Quit the debugger. This entails setting the C<$fall_off_end> flag, so we don't
2302 try to execute further, cleaning any restart-related stuff out of the
2303 environment, and executing with the last value of C<$?>.
2304
2305 =cut
2306
2307                 $cmd =~ /^q$/ && do {
2308                     $fall_off_end = 1;
2309                     clean_ENV();
2310                     exit $?;
2311                 };
2312
2313 =head4 C<t> - trace
2314
2315 Turn tracing on or off. Inverts the appropriate bit in C<$trace> (q.v.).
2316
2317 =cut
2318
2319                 $cmd =~ /^t$/ && do {
2320                     $trace ^= 1;
2321                     local $\ = '';
2322                     print $OUT "Trace = "
2323                       . ( ( $trace & 1 ) ? "on" : "off" ) . "\n";
2324                     next CMD;
2325                 };
2326
2327 =head4 C<S> - list subroutines matching/not matching a pattern
2328
2329 Walks through C<%sub>, checking to see whether or not to print the name.
2330
2331 =cut
2332
2333                 $cmd =~ /^S(\s+(!)?(.+))?$/ && do {
2334
2335                     $Srev     = defined $2;     # Reverse scan?
2336                     $Spatt    = $3;             # The pattern (if any) to use.
2337                     $Snocheck = !defined $1;    # No args - print all subs.
2338
2339                     # Need to make these sane here.
2340                     local $\ = '';
2341                     local $, = '';
2342
2343                     # Search through the debugger's magical hash of subs.
2344                     # If $nocheck is true, just print the sub name.
2345                     # Otherwise, check it against the pattern. We then use
2346                     # the XOR trick to reverse the condition as required.
2347                     foreach $subname ( sort( keys %sub ) ) {
2348                         if ( $Snocheck or $Srev ^ ( $subname =~ /$Spatt/ ) ) {
2349                             print $OUT $subname, "\n";
2350                         }
2351                     }
2352                     next CMD;
2353                 };
2354
2355 =head4 C<X> - list variables in current package
2356
2357 Since the C<V> command actually processes this, just change this to the
2358 appropriate C<V> command and fall through.
2359
2360 =cut
2361
2362                 $cmd =~ s/^X\b/V $package/;
2363
2364 =head4 C<V> - list variables
2365
2366 Uses C<dumpvar.pl> to dump out the current values for selected variables.
2367
2368 =cut
2369
2370                 # Bare V commands get the currently-being-debugged package
2371                 # added.
2372                 $cmd =~ /^V$/ && do {
2373                     $cmd = "V $package";
2374                 };
2375
2376                 # V - show variables in package.
2377                 $cmd =~ /^V\b\s*(\S+)\s*(.*)/ && do {
2378
2379                     # Save the currently selected filehandle and
2380                     # force output to debugger's filehandle (dumpvar
2381                     # just does "print" for output).
2382                     local ($savout) = select($OUT);
2383
2384                     # Grab package name and variables to dump.
2385                     $packname = $1;
2386                     @vars     = split( ' ', $2 );
2387
2388                     # If main::dumpvar isn't here, get it.
2389                     do 'dumpvar.pl' unless defined &main::dumpvar;
2390                     if ( defined &main::dumpvar ) {
2391
2392                         # We got it. Turn off subroutine entry/exit messages
2393                         # for the moment, along with return values.
2394                         local $frame = 0;
2395                         local $doret = -2;
2396
2397                         # must detect sigpipe failures  - not catching
2398                         # then will cause the debugger to die.
2399                         eval {
2400                             &main::dumpvar(
2401                                 $packname,
2402                                 defined $option{dumpDepth}
2403                                 ? $option{dumpDepth}
2404                                 : -1,    # assume -1 unless specified
2405                                 @vars
2406                             );
2407                         };
2408
2409                         # The die doesn't need to include the $@, because
2410                         # it will automatically get propagated for us.
2411                         if ($@) {
2412                             die unless $@ =~ /dumpvar print failed/;
2413                         }
2414                     } ## end if (defined &main::dumpvar)
2415                     else {
2416
2417                         # Couldn't load dumpvar.
2418                         print $OUT "dumpvar.pl not available.\n";
2419                     }
2420
2421                     # Restore the output filehandle, and go round again.
2422                     select($savout);
2423                     next CMD;
2424                 };
2425
2426 =head4 C<x> - evaluate and print an expression
2427
2428 Hands the expression off to C<DB::eval>, setting it up to print the value
2429 via C<dumpvar.pl> instead of just printing it directly.
2430
2431 =cut
2432
2433                 $cmd =~ s/^x\b/ / && do {    # Remainder gets done by DB::eval()
2434                     $onetimeDump = 'dump';    # main::dumpvar shows the output
2435
2436                     # handle special  "x 3 blah" syntax XXX propagate
2437                     # doc back to special variables.
2438                     if ( $cmd =~ s/^\s*(\d+)(?=\s)/ / ) {
2439                         $onetimedumpDepth = $1;
2440                     }
2441                 };
2442
2443 =head4 C<m> - print methods
2444
2445 Just uses C<DB::methods> to determine what methods are available.
2446
2447 =cut
2448
2449                 $cmd =~ s/^m\s+([\w:]+)\s*$/ / && do {
2450                     methods($1);
2451                     next CMD;
2452                 };
2453
2454                 # m expr - set up DB::eval to do the work
2455                 $cmd =~ s/^m\b/ / && do {    # Rest gets done by DB::eval()
2456                     $onetimeDump = 'methods';   #  method output gets used there
2457                 };
2458
2459 =head4 C<f> - switch files
2460
2461 =cut
2462
2463                 $cmd =~ /^f\b\s*(.*)/ && do {
2464                     $file = $1;
2465                     $file =~ s/\s+$//;
2466
2467                     # help for no arguments (old-style was return from sub).
2468                     if ( !$file ) {
2469                         print $OUT
2470                           "The old f command is now the r command.\n";    # hint
2471                         print $OUT "The new f command switches filenames.\n";
2472                         next CMD;
2473                     } ## end if (!$file)
2474
2475                     # if not in magic file list, try a close match.
2476                     if ( !defined $main::{ '_<' . $file } ) {
2477                         if ( ($try) = grep( m#^_<.*$file#, keys %main:: ) ) {
2478                             {
2479                                 $try = substr( $try, 2 );
2480                                 print $OUT "Choosing $try matching `$file':\n";
2481                                 $file = $try;
2482                             }
2483                         } ## end if (($try) = grep(m#^_<.*$file#...
2484                     } ## end if (!defined $main::{ ...
2485
2486                     # If not successfully switched now, we failed.
2487                     if ( !defined $main::{ '_<' . $file } ) {
2488                         print $OUT "No file matching `$file' is loaded.\n";
2489                         next CMD;
2490                     }
2491
2492                     # We switched, so switch the debugger internals around.
2493                     elsif ( $file ne $filename ) {
2494                         *dbline   = $main::{ '_<' . $file };
2495                         $max      = $#dbline;
2496                         $filename = $file;
2497                         $start    = 1;
2498                         $cmd      = "l";
2499                     } ## end elsif ($file ne $filename)
2500
2501                     # We didn't switch; say we didn't.
2502                     else {
2503                         print $OUT "Already in $file.\n";
2504                         next CMD;
2505                     }
2506                 };
2507
2508 =head4 C<.> - return to last-executed line.
2509
2510 We set C<$incr> to -1 to indicate that the debugger shouldn't move ahead,
2511 and then we look up the line in the magical C<%dbline> hash.
2512
2513 =cut
2514
2515                 # . command.
2516                 $cmd =~ /^\.$/ && do {
2517                     $incr = -1;    # stay at current line
2518
2519                     # Reset everything to the old location.
2520                     $start    = $line;
2521                     $filename = $filename_ini;
2522                     *dbline   = $main::{ '_<' . $filename };
2523                     $max      = $#dbline;
2524
2525                     # Now where are we?
2526                     print_lineinfo($position);
2527                     next CMD;
2528                 };
2529
2530 =head4 C<-> - back one window
2531
2532 We change C<$start> to be one window back; if we go back past the first line,
2533 we set it to be the first line. We ser C<$incr> to put us back at the
2534 currently-executing line, and then put a C<l $start +> (list one window from
2535 C<$start>) in C<$cmd> to be executed later.
2536
2537 =cut
2538
2539                 # - - back a window.
2540                 $cmd =~ /^-$/ && do {
2541
2542                     # back up by a window; go to 1 if back too far.
2543                     $start -= $incr + $window + 1;
2544                     $start = 1 if $start <= 0;
2545                     $incr  = $window - 1;
2546
2547                     # Generate and execute a "l +" command (handled below).
2548                     $cmd = 'l ' . ($start) . '+';
2549                 };
2550
2551 =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>, {, {{>
2552
2553 In Perl 5.8.0, a realignment of the commands was done to fix up a number of
2554 problems, most notably that the default case of several commands destroying
2555 the user's work in setting watchpoints, actions, etc. We wanted, however, to
2556 retain the old commands for those who were used to using them or who preferred
2557 them. At this point, we check for the new commands and call C<cmd_wrapper> to
2558 deal with them instead of processing them in-line.
2559
2560 =cut
2561
2562                 # All of these commands were remapped in perl 5.8.0;
2563                 # we send them off to the secondary dispatcher (see below).
2564                 $cmd =~ /^([aAbBeEhilLMoOPvwW]\b|[<>\{]{1,2})\s*(.*)/so && do {
2565                     &cmd_wrapper( $1, $2, $line );
2566                     next CMD;
2567                 };
2568
2569 =head4 C<y> - List lexicals in higher scope
2570
2571 Uses C<PadWalker> to find the lexicals supplied as arguments in a scope
2572 above the current one and then displays then using C<dumpvar.pl>.
2573
2574 =cut
2575
2576                 $cmd =~ /^y(?:\s+(\d*)\s*(.*))?$/ && do {
2577
2578                     # See if we've got the necessary support.
2579                     eval { require PadWalker; PadWalker->VERSION(0.08) }
2580                       or &warn(
2581                         $@ =~ /locate/
2582                         ? "PadWalker module not found - please install\n"
2583                         : $@
2584                       )
2585                       and next CMD;
2586
2587                     # Load up dumpvar if we don't have it. If we can, that is.
2588                     do 'dumpvar.pl' unless defined &main::dumpvar;
2589                     defined &main::dumpvar
2590                       or print $OUT "dumpvar.pl not available.\n"
2591                       and next CMD;
2592
2593                     # Got all the modules we need. Find them and print them.
2594                     my @vars = split( ' ', $2 || '' );
2595
2596                     # Find the pad.
2597                     my $h = eval { PadWalker::peek_my( ( $1 || 0 ) + 1 ) };
2598
2599                     # Oops. Can't find it.
2600                     $@ and $@ =~ s/ at .*//, &warn($@), next CMD;
2601
2602                     # Show the desired vars with dumplex().
2603                     my $savout = select($OUT);
2604
2605                     # Have dumplex dump the lexicals.
2606                     dumpvar::dumplex( $_, $h->{$_},
2607                         defined $option{dumpDepth} ? $option{dumpDepth} : -1,
2608                         @vars )
2609                       for sort keys %$h;
2610                     select($savout);
2611                     next CMD;
2612                 };
2613
2614 =head3 COMMANDS NOT WORKING AFTER PROGRAM ENDS
2615
2616 All of the commands below this point don't work after the program being
2617 debugged has ended. All of them check to see if the program has ended; this
2618 allows the commands to be relocated without worrying about a 'line of
2619 demarcation' above which commands can be entered anytime, and below which
2620 they can't.
2621
2622 =head4 C<n> - single step, but don't trace down into subs
2623
2624 Done by setting C<$single> to 2, which forces subs to execute straight through
2625 when entered (see C<DB::sub>). We also save the C<n> command in C<$laststep>,
2626 so a null command knows what to re-execute.
2627
2628 =cut
2629
2630                 # n - next
2631                 $cmd =~ /^n$/ && do {
2632                     end_report(), next CMD if $finished and $level <= 1;
2633
2634                     # Single step, but don't enter subs.
2635                     $single = 2;
2636
2637                     # Save for empty command (repeat last).
2638                     $laststep = $cmd;
2639                     last CMD;
2640                 };
2641
2642 =head4 C<s> - single-step, entering subs
2643
2644 Sets C<$single> to 1, which causes C<DB::sub> to continue tracing inside
2645 subs. Also saves C<s> as C<$lastcmd>.
2646
2647 =cut
2648
2649                 # s - single step.
2650                 $cmd =~ /^s$/ && do {
2651
2652                     # Get out and restart the command loop if program
2653                     # has finished.
2654                     end_report(), next CMD if $finished and $level <= 1;
2655
2656                     # Single step should enter subs.
2657                     $single = 1;
2658
2659                     # Save for empty command (repeat last).
2660                     $laststep = $cmd;
2661                     last CMD;
2662                 };
2663
2664 =head4 C<c> - run continuously, setting an optional breakpoint
2665
2666 Most of the code for this command is taken up with locating the optional
2667 breakpoint, which is either a subroutine name or a line number. We set
2668 the appropriate one-time-break in C<@dbline> and then turn off single-stepping
2669 in this and all call levels above this one.
2670
2671 =cut
2672
2673                 # c - start continuous execution.
2674                 $cmd =~ /^c\b\s*([\w:]*)\s*$/ && do {
2675
2676                     # Hey, show's over. The debugged program finished
2677                     # executing already.
2678                     end_report(), next CMD if $finished and $level <= 1;
2679
2680                     # Capture the place to put a one-time break.
2681                     $subname = $i = $1;
2682
2683                     #  Probably not needed, since we finish an interactive
2684                     #  sub-session anyway...
2685                     # local $filename = $filename;
2686                     # local *dbline = *dbline; # XXX Would this work?!
2687                     #
2688                     # The above question wonders if localizing the alias
2689                     # to the magic array works or not. Since it's commented
2690                     # out, we'll just leave that to speculation for now.
2691
2692                     # If the "subname" isn't all digits, we'll assume it
2693                     # is a subroutine name, and try to find it.
2694                     if ( $subname =~ /\D/ ) {    # subroutine name
2695                             # Qualify it to the current package unless it's
2696                             # already qualified.
2697                         $subname = $package . "::" . $subname
2698                           unless $subname =~ /::/;
2699
2700                         # find_sub will return "file:line_number" corresponding
2701                         # to where the subroutine is defined; we call find_sub,
2702                         # break up the return value, and assign it in one
2703                         # operation.
2704                         ( $file, $i ) = ( find_sub($subname) =~ /^(.*):(.*)$/ );
2705
2706                         # Force the line number to be numeric.
2707                         $i += 0;
2708
2709                         # If we got a line number, we found the sub.
2710                         if ($i) {
2711
2712                             # Switch all the debugger's internals around so
2713                             # we're actually working with that file.
2714                             $filename = $file;
2715                             *dbline   = $main::{ '_<' . $filename };
2716
2717                             # Mark that there's a breakpoint in this file.
2718                             $had_breakpoints{$filename} |= 1;
2719
2720                             # Scan forward to the first executable line
2721                             # after the 'sub whatever' line.
2722                             $max = $#dbline;
2723                             ++$i while $dbline[$i] == 0 && $i < $max;
2724                         } ## end if ($i)
2725
2726                         # We didn't find a sub by that name.
2727                         else {
2728                             print $OUT "Subroutine $subname not found.\n";
2729                             next CMD;
2730                         }
2731                     } ## end if ($subname =~ /\D/)
2732
2733                     # At this point, either the subname was all digits (an
2734                     # absolute line-break request) or we've scanned through
2735                     # the code following the definition of the sub, looking
2736                     # for an executable, which we may or may not have found.
2737                     #
2738                     # If $i (which we set $subname from) is non-zero, we
2739                     # got a request to break at some line somewhere. On
2740                     # one hand, if there wasn't any real subroutine name
2741                     # involved, this will be a request to break in the current
2742                     # file at the specified line, so we have to check to make
2743                     # sure that the line specified really is breakable.
2744                     #
2745                     # On the other hand, if there was a subname supplied, the
2746                     # preceding block has moved us to the proper file and
2747                     # location within that file, and then scanned forward
2748                     # looking for the next executable line. We have to make
2749                     # sure that one was found.
2750                     #
2751                     # On the gripping hand, we can't do anything unless the
2752                     # current value of $i points to a valid breakable line.
2753                     # Check that.
2754                     if ($i) {
2755
2756                         # Breakable?
2757                         if ( $dbline[$i] == 0 ) {
2758                             print $OUT "Line $i not breakable.\n";
2759                             next CMD;
2760                         }
2761
2762                         # Yes. Set up the one-time-break sigil.
2763                         $dbline{$i} =~ s/($|\0)/;9$1/;  # add one-time-only b.p.
2764                     } ## end if ($i)
2765
2766                     # Turn off stack tracing from here up.
2767                     for ( $i = 0 ; $i <= $stack_depth ; ) {
2768                         $stack[ $i++ ] &= ~1;
2769                     }
2770                     last CMD;
2771                 };
2772
2773 =head4 C<r> - return from a subroutine
2774
2775 For C<r> to work properly, the debugger has to stop execution again
2776 immediately after the return is executed. This is done by forcing
2777 single-stepping to be on in the call level above the current one. If
2778 we are printing return values when a C<r> is executed, set C<$doret>
2779 appropriately, and force us out of the command loop.
2780
2781 =cut
2782
2783                 # r - return from the current subroutine.
2784                 $cmd =~ /^r$/ && do {
2785
2786                     # Can't do anythign if the program's over.
2787                     end_report(), next CMD if $finished and $level <= 1;
2788
2789                     # Turn on stack trace.
2790                     $stack[$stack_depth] |= 1;
2791
2792                     # Print return value unless the stack is empty.
2793                     $doret = $option{PrintRet} ? $stack_depth - 1 : -2;
2794                     last CMD;
2795                 };
2796
2797 =head4 C<T> - stack trace
2798
2799 Just calls C<DB::print_trace>.
2800
2801 =cut
2802
2803                 $cmd =~ /^T$/ && do {
2804                     print_trace( $OUT, 1 );    # skip DB
2805                     next CMD;
2806                 };
2807
2808 =head4 C<w> - List window around current line.
2809
2810 Just calls C<DB::cmd_w>.
2811
2812 =cut
2813
2814                 $cmd =~ /^w\b\s*(.*)/s && do { &cmd_w( 'w', $1 ); next CMD; };
2815
2816 =head4 C<W> - watch-expression processing.
2817
2818 Just calls C<DB::cmd_W>.
2819
2820 =cut
2821
2822                 $cmd =~ /^W\b\s*(.*)/s && do { &cmd_W( 'W', $1 ); next CMD; };
2823
2824 =head4 C</> - search forward for a string in the source
2825
2826 We take the argument and treat it as a pattern. If it turns out to be a
2827 bad one, we return the error we got from trying to C<eval> it and exit.
2828 If not, we create some code to do the search and C<eval> it so it can't
2829 mess us up.
2830
2831 =cut
2832
2833                 $cmd =~ /^\/(.*)$/ && do {
2834
2835                     # The pattern as a string.
2836                     $inpat = $1;
2837
2838                     # Remove the final slash.
2839                     $inpat =~ s:([^\\])/$:$1:;
2840
2841                     # If the pattern isn't null ...
2842                     if ( $inpat ne "" ) {
2843
2844                         # Turn of warn and die procesing for a bit.
2845                         local $SIG{__DIE__};
2846                         local $SIG{__WARN__};
2847
2848                         # Create the pattern.
2849                         eval '$inpat =~ m' . "\a$inpat\a";
2850                         if ( $@ ne "" ) {
2851
2852                             # Oops. Bad pattern. No biscuit.
2853                             # Print the eval error and go back for more
2854                             # commands.
2855                             print $OUT "$@";
2856                             next CMD;
2857                         }
2858                         $pat = $inpat;
2859                     } ## end if ($inpat ne "")
2860
2861                     # Set up to stop on wrap-around.
2862                     $end = $start;
2863
2864                     # Don't move off the current line.
2865                     $incr = -1;
2866
2867                     # Done in eval so nothing breaks if the pattern
2868                     # does something weird.
2869                     eval '
2870                         for (;;) {
2871                             # Move ahead one line.
2872                             ++$start;
2873
2874                             # Wrap if we pass the last line.
2875                             $start = 1 if ($start > $max);
2876
2877                             # Stop if we have gotten back to this line again,
2878                             last if ($start == $end);
2879
2880                             # A hit! (Note, though, that we are doing
2881                             # case-insensitive matching. Maybe a qr//
2882                             # expression would be better, so the user could
2883                             # do case-sensitive matching if desired.
2884                             if ($dbline[$start] =~ m' . "\a$pat\a" . 'i) {
2885                                 if ($slave_editor) {
2886                                     # Handle proper escaping in the slave.
2887                                     print $OUT "\032\032$filename:$start:0\n";
2888                                 }
2889                                 else {
2890                                     # Just print the line normally.
2891                                     print $OUT "$start:\t",$dbline[$start],"\n";
2892                                 }
2893                                 # And quit since we found something.
2894                                 last;
2895                             }
2896                          } ';
2897
2898                     # If we wrapped, there never was a match.
2899                     print $OUT "/$pat/: not found\n" if ( $start == $end );
2900                     next CMD;
2901                 };
2902
2903 =head4 C<?> - search backward for a string in the source
2904
2905 Same as for C</>, except the loop runs backwards.
2906
2907 =cut
2908
2909                 # ? - backward pattern search.
2910                 $cmd =~ /^\?(.*)$/ && do {
2911
2912                     # Get the pattern, remove trailing question mark.
2913                     $inpat = $1;
2914                     $inpat =~ s:([^\\])\?$:$1:;
2915
2916                     # If we've got one ...
2917                     if ( $inpat ne "" ) {
2918
2919                         # Turn off die & warn handlers.
2920                         local $SIG{__DIE__};
2921                         local $SIG{__WARN__};
2922                         eval '$inpat =~ m' . "\a$inpat\a";
2923
2924                         if ( $@ ne "" ) {
2925
2926                             # Ouch. Not good. Print the error.
2927                             print $OUT $@;
2928                             next CMD;
2929                         }
2930                         $pat = $inpat;
2931                     } ## end if ($inpat ne "")
2932
2933                     # Where we are now is where to stop after wraparound.
2934                     $end = $start;
2935
2936                     # Don't move away from this line.
2937                     $incr = -1;
2938
2939                     # Search inside the eval to prevent pattern badness
2940                     # from killing us.
2941                     eval '
2942                         for (;;) {
2943                             # Back up a line.
2944                             --$start;
2945
2946                             # Wrap if we pass the first line.
2947
2948                             $start = $max if ($start <= 0);
2949
2950                             # Quit if we get back where we started,
2951                             last if ($start == $end);
2952
2953                             # Match?
2954                             if ($dbline[$start] =~ m' . "\a$pat\a" . 'i) {
2955                                 if ($slave_editor) {
2956                                     # Yep, follow slave editor requirements.
2957                                     print $OUT "\032\032$filename:$start:0\n";
2958                                 }
2959                                 else {
2960                                     # Yep, just print normally.
2961                                     print $OUT "$start:\t",$dbline[$start],"\n";
2962                                 }
2963
2964                                 # Found, so done.
2965                                 last;
2966                             }
2967                         } ';
2968
2969                     # Say we failed if the loop never found anything,
2970                     print $OUT "?$pat?: not found\n" if ( $start == $end );
2971                     next CMD;
2972                 };
2973
2974 =head4 C<$rc> - Recall command
2975
2976 Manages the commands in C<@hist> (which is created if C<Term::ReadLine> reports
2977 that the terminal supports history). It find the the command required, puts it
2978 into C<$cmd>, and redoes the loop to execute it.
2979
2980 =cut
2981
2982                 # $rc - recall command.
2983                 $cmd =~ /^$rc+\s*(-)?(\d+)?$/ && do {
2984
2985                     # No arguments, take one thing off history.
2986                     pop(@hist) if length($cmd) > 1;
2987
2988                     # Relative (- found)?
2989                     #  Y - index back from most recent (by 1 if bare minus)
2990                     #  N - go to that particular command slot or the last
2991                     #      thing if nothing following.
2992                     $i = $1 ? ( $#hist - ( $2 || 1 ) ) : ( $2 || $#hist );
2993
2994                     # Pick out the command desired.
2995                     $cmd = $hist[$i];
2996
2997                     # Print the command to be executed and restart the loop
2998                     # with that command in the buffer.
2999                     print $OUT $cmd, "\n";
3000                     redo CMD;
3001                 };
3002
3003 =head4 C<$sh$sh> - C<system()> command
3004
3005 Calls the C<DB::system()> to handle the command. This keeps the C<STDIN> and
3006 C<STDOUT> from getting messed up.
3007
3008 =cut
3009
3010                 # $sh$sh - run a shell command (if it's all ASCII).
3011                 # Can't run shell commands with Unicode in the debugger, hmm.
3012                 $cmd =~ /^$sh$sh\s*([\x00-\xff]*)/ && do {
3013
3014                     # System it.
3015                     &system($1);
3016                     next CMD;
3017                 };
3018
3019 =head4 C<$rc I<pattern> $rc> - Search command history
3020
3021 Another command to manipulate C<@hist>: this one searches it with a pattern.
3022 If a command is found, it is placed in C<$cmd> and executed via C<redo>.
3023
3024 =cut
3025
3026                 # $rc pattern $rc - find a command in the history.
3027                 $cmd =~ /^$rc([^$rc].*)$/ && do {
3028
3029                     # Create the pattern to use.
3030                     $pat = "^$1";
3031
3032                     # Toss off last entry if length is >1 (and it always is).
3033                     pop(@hist) if length($cmd) > 1;
3034
3035                     # Look backward through the history.
3036                     for ( $i = $#hist ; $i ; --$i ) {
3037
3038                         # Stop if we find it.
3039                         last if $hist[$i] =~ /$pat/;
3040                     }
3041
3042                     if ( !$i ) {
3043
3044                         # Never found it.
3045                         print $OUT "No such command!\n\n";
3046                         next CMD;
3047                     }
3048
3049                     # Found it. Put it in the buffer, print it, and process it.
3050                     $cmd = $hist[$i];
3051                     print $OUT $cmd, "\n";
3052                     redo CMD;
3053                 };
3054
3055 =head4 C<$sh> - Invoke a shell
3056
3057 Uses C<DB::system> to invoke a shell.
3058
3059 =cut
3060
3061                 # $sh - start a shell.
3062                 $cmd =~ /^$sh$/ && do {
3063
3064                     # Run the user's shell. If none defined, run Bourne.
3065                     # We resume execution when the shell terminates.
3066                     &system( $ENV{SHELL} || "/bin/sh" );
3067                     next CMD;
3068                 };
3069
3070 =head4 C<$sh I<command>> - Force execution of a command in a shell
3071
3072 Like the above, but the command is passed to the shell. Again, we use
3073 C<DB::system> to avoid problems with C<STDIN> and C<STDOUT>.
3074
3075 =cut
3076
3077                 # $sh command - start a shell and run a command in it.
3078                 $cmd =~ /^$sh\s*([\x00-\xff]*)/ && do {
3079
3080                     # XXX: using csh or tcsh destroys sigint retvals!
3081                     #&system($1);  # use this instead
3082
3083                     # use the user's shell, or Bourne if none defined.
3084                     &system( $ENV{SHELL} || "/bin/sh", "-c", $1 );
3085                     next CMD;
3086                 };
3087
3088 =head4 C<H> - display commands in history
3089
3090 Prints the contents of C<@hist> (if any).
3091
3092 =cut
3093
3094                 $cmd =~ /^H\b\s*\*/ && do {
3095                     @hist = @truehist = ();
3096                     print $OUT "History cleansed\n";
3097                     next CMD;
3098                 };
3099
3100                 $cmd =~ /^H\b\s*(-(\d+))?/ && do {
3101
3102                     # Anything other than negative numbers is ignored by
3103                     # the (incorrect) pattern, so this test does nothing.
3104                     $end = $2 ? ( $#hist - $2 ) : 0;
3105
3106                     # Set to the minimum if less than zero.
3107                     $hist = 0 if $hist < 0;
3108
3109                     # Start at the end of the array.
3110                     # Stay in while we're still above the ending value.
3111                     # Tick back by one each time around the loop.
3112                     for ( $i = $#hist ; $i > $end ; $i-- ) {
3113
3114                         # Print the command  unless it has no arguments.
3115                         print $OUT "$i: ", $hist[$i], "\n"
3116                           unless $hist[$i] =~ /^.?$/;
3117                     }
3118                     next CMD;
3119                 };
3120
3121 =head4 C<man, doc, perldoc> - look up documentation
3122
3123 Just calls C<runman()> to print the appropriate document.
3124
3125 =cut
3126
3127                 # man, perldoc, doc - show manual pages.
3128                 $cmd =~ /^(?:man|(?:perl)?doc)\b(?:\s+([^(]*))?$/ && do {
3129                     runman($1);
3130                     next CMD;
3131                 };
3132
3133 =head4 C<p> - print
3134
3135 Builds a C<print EXPR> expression in the C<$cmd>; this will get executed at
3136 the bottom of the loop.
3137
3138 =cut
3139
3140                 # p - print (no args): print $_.
3141                 $cmd =~ s/^p$/print {\$DB::OUT} \$_/;
3142
3143                 # p - print the given expression.
3144                 $cmd =~ s/^p\b/print {\$DB::OUT} /;
3145
3146 =head4 C<=> - define command alias
3147
3148 Manipulates C<%alias> to add or list command aliases.
3149
3150 =cut
3151
3152                 # = - set up a command alias.
3153                 $cmd =~ s/^=\s*// && do {
3154                     my @keys;
3155                     if ( length $cmd == 0 ) {
3156
3157                         # No args, get current aliases.
3158                         @keys = sort keys %alias;
3159                     }
3160                     elsif ( my ( $k, $v ) = ( $cmd =~ /^(\S+)\s+(\S.*)/ ) ) {
3161
3162                         # Creating a new alias. $k is alias name, $v is
3163                         # alias value.
3164
3165                         # can't use $_ or kill //g state
3166                         for my $x ( $k, $v ) {
3167
3168                             # Escape "alarm" characters.
3169                             $x =~ s/\a/\\a/g;
3170                         }
3171
3172                         # Substitute key for value, using alarm chars
3173                         # as separators (which is why we escaped them in
3174                         # the command).
3175                         $alias{$k} = "s\a$k\a$v\a";
3176
3177                         # Turn off standard warn and die behavior.
3178                         local $SIG{__DIE__};
3179                         local $SIG{__WARN__};
3180
3181                         # Is it valid Perl?
3182                         unless ( eval "sub { s\a$k\a$v\a }; 1" ) {
3183
3184                             # Nope. Bad alias. Say so and get out.
3185                             print $OUT "Can't alias $k to $v: $@\n";
3186                             delete $alias{$k};
3187                             next CMD;
3188                         }
3189
3190                         # We'll only list the new one.
3191                         @keys = ($k);
3192                     } ## end elsif (my ($k, $v) = ($cmd...
3193
3194                     # The argument is the alias to list.
3195                     else {
3196                         @keys = ($cmd);
3197                     }
3198
3199                     # List aliases.
3200                     for my $k (@keys) {
3201
3202                         # Messy metaquoting: Trim the substiution code off.
3203                         # We use control-G as the delimiter because it's not
3204                         # likely to appear in the alias.
3205                         if ( ( my $v = $alias{$k} ) =~ s\as\a$k\a(.*)\a$\a1\a ) {
3206
3207                             # Print the alias.
3208                             print $OUT "$k\t= $1\n";
3209                         }
3210                         elsif ( defined $alias{$k} ) {
3211
3212                             # Couldn't trim it off; just print the alias code.
3213                             print $OUT "$k\t$alias{$k}\n";
3214                         }
3215                         else {
3216
3217                             # No such, dude.
3218                             print "No alias for $k\n";
3219                         }
3220                     } ## end for my $k (@keys)
3221                     next CMD;
3222                 };
3223
3224 =head4 C<source> - read commands from a file.
3225
3226 Opens a lexical filehandle and stacks it on C<@cmdfhs>; C<DB::readline> will
3227 pick it up.
3228
3229 =cut
3230
3231                 # source - read commands from a file (or pipe!) and execute.
3232                 $cmd =~ /^source\s+(.*\S)/ && do {
3233                     if ( open my $fh, $1 ) {
3234
3235                         # Opened OK; stick it in the list of file handles.
3236                         push @cmdfhs, $fh;
3237                     }
3238                     else {
3239
3240                         # Couldn't open it.
3241                         &warn("Can't execute `$1': $!\n");
3242                     }
3243                     next CMD;
3244                 };
3245
3246 =head4 C<save> - send current history to a file
3247
3248 Takes the complete history, (not the shrunken version you see with C<H>),
3249 and saves it to the given filename, so it can be replayed using C<source>.
3250
3251 Note that all C<^(save|source)>'s are commented out with a view to minimise recursion.
3252
3253 =cut
3254
3255                 # save source - write commands to a file for later use
3256                 $cmd =~ /^save\s*(.*)$/ && do {
3257                     my $file = $1 || '.perl5dbrc';    # default?
3258                     if ( open my $fh, "> $file" ) {
3259
3260                        # chomp to remove extraneous newlines from source'd files
3261                         chomp( my @truelist =
3262                               map { m/^\s*(save|source)/ ? "#$_" : $_ }
3263                               @truehist );
3264                         print $fh join( "\n", @truelist );
3265                         print "commands saved in $file\n";
3266                     }
3267                     else {
3268                         &warn("Can't save debugger commands in '$1': $!\n");
3269                     }
3270                     next CMD;
3271                 };
3272
3273 =head4 C<R> - restart
3274
3275 Restart the debugger session.
3276
3277 =head4 C<rerun> - rerun the current session
3278
3279 Return to any given position in the B<true>-history list
3280
3281 =cut
3282
3283                 # R - restart execution.
3284                 # rerun - controlled restart execution.
3285                 $cmd =~ /^(R|rerun\s*(.*))$/ && do {
3286                     my @args = ($1 eq 'R' ? restart() : rerun($2));
3287
3288                     # Close all non-system fds for a clean restart.  A more
3289                     # correct method would be to close all fds that were not
3290                     # open when the process started, but this seems to be
3291                     # hard.  See "debugger 'R'estart and open database
3292                     # connections" on p5p.
3293
3294                     my $max_fd = 1024; # default if POSIX can't be loaded
3295                     if (eval { require POSIX }) {
3296                         $max_fd = POSIX::sysconf(POSIX::_SC_OPEN_MAX());
3297                     }
3298
3299                     if (defined $max_fd) {
3300                         foreach ($^F+1 .. $max_fd-1) {
3301                             next unless open FD_TO_CLOSE, "<&=$_";
3302                             close(FD_TO_CLOSE);
3303                         }
3304                     }
3305
3306                     # And run Perl again.  We use exec() to keep the
3307                     # PID stable (and that way $ini_pids is still valid).
3308                     exec(@args) || print $OUT "exec failed: $!\n";
3309
3310                     last CMD;
3311                 };
3312
3313 =head4 C<|, ||> - pipe output through the pager.
3314
3315 For C<|>, we save C<OUT> (the debugger's output filehandle) and C<STDOUT>
3316 (the program's standard output). For C<||>, we only save C<OUT>. We open a
3317 pipe to the pager (restoring the output filehandles if this fails). If this
3318 is the C<|> command, we also set up a C<SIGPIPE> handler which will simply
3319 set C<$signal>, sending us back into the debugger.
3320
3321 We then trim off the pipe symbols and C<redo> the command loop at the
3322 C<PIPE> label, causing us to evaluate the command in C<$cmd> without
3323 reading another.
3324
3325 =cut
3326
3327                 # || - run command in the pager, with output to DB::OUT.
3328                 $cmd =~ /^\|\|?\s*[^|]/ && do {
3329                     if ( $pager =~ /^\|/ ) {
3330
3331                         # Default pager is into a pipe. Redirect I/O.
3332                         open( SAVEOUT, ">&STDOUT" )
3333                           || &warn("Can't save STDOUT");
3334                         open( STDOUT, ">&OUT" )
3335                           || &warn("Can't redirect STDOUT");
3336                     } ## end if ($pager =~ /^\|/)
3337                     else {
3338
3339                         # Not into a pipe. STDOUT is safe.
3340                         open( SAVEOUT, ">&OUT" ) || &warn("Can't save DB::OUT");
3341                     }
3342
3343                     # Fix up environment to record we have less if so.
3344                     fix_less();
3345
3346                     unless ( $piped = open( OUT, $pager ) ) {
3347
3348                         # Couldn't open pipe to pager.
3349                         &warn("Can't pipe output to `$pager'");
3350                         if ( $pager =~ /^\|/ ) {
3351
3352                             # Redirect I/O back again.
3353                             open( OUT, ">&STDOUT" )    # XXX: lost message
3354                               || &warn("Can't restore DB::OUT");
3355                             open( STDOUT, ">&SAVEOUT" )
3356                               || &warn("Can't restore STDOUT");
3357                             close(SAVEOUT);
3358                         } ## end if ($pager =~ /^\|/)
3359                         else {
3360
3361                             # Redirect I/O. STDOUT already safe.
3362                             open( OUT, ">&STDOUT" )    # XXX: lost message
3363                               || &warn("Can't restore DB::OUT");
3364                         }
3365                         next CMD;
3366                     } ## end unless ($piped = open(OUT,...
3367
3368                     # Set up broken-pipe handler if necessary.
3369                     $SIG{PIPE} = \&DB::catch
3370                       if $pager =~ /^\|/
3371                       && ( "" eq $SIG{PIPE} || "DEFAULT" eq $SIG{PIPE} );
3372
3373                     # Save current filehandle, unbuffer out, and put it back.
3374                     $selected = select(OUT);
3375                     $|        = 1;
3376
3377                     # Don't put it back if pager was a pipe.
3378                     select($selected), $selected = "" unless $cmd =~ /^\|\|/;
3379
3380                     # Trim off the pipe symbols and run the command now.
3381                     $cmd =~ s/^\|+\s*//;
3382                     redo PIPE;
3383                 };
3384
3385 =head3 END OF COMMAND PARSING
3386
3387 Anything left in C<$cmd> at this point is a Perl expression that we want to
3388 evaluate. We'll always evaluate in the user's context, and fully qualify
3389 any variables we might want to address in the C<DB> package.
3390
3391 =cut
3392
3393                 # t - turn trace on.
3394                 $cmd =~ s/^t\s/\$DB::trace |= 1;\n/;
3395
3396                 # s - single-step. Remember the last command was 's'.
3397                 $cmd =~ s/^s\s/\$DB::single = 1;\n/ && do { $laststep = 's' };
3398
3399                 # n - single-step, but not into subs. Remember last command
3400                 # was 'n'.
3401                 $cmd =~ s/^n\s/\$DB::single = 2;\n/ && do { $laststep = 'n' };
3402
3403             }    # PIPE:
3404
3405             # Make sure the flag that says "the debugger's running" is
3406             # still on, to make sure we get control again.
3407             $evalarg = "\$^D = \$^D | \$DB::db_stop;\n$cmd";
3408
3409             # Run *our* eval that executes in the caller's context.
3410             &eval;
3411
3412             # Turn off the one-time-dump stuff now.
3413             if ($onetimeDump) {
3414                 $onetimeDump      = undef;
3415                 $onetimedumpDepth = undef;
3416             }
3417             elsif ( $term_pid == $$ ) {
3418                 STDOUT->flush();
3419                 STDERR->flush();
3420
3421                 # XXX If this is the master pid, print a newline.
3422                 print $OUT "\n";
3423             }
3424         } ## end while (($term || &setterm...
3425
3426 =head3 POST-COMMAND PROCESSING
3427
3428 After each command, we check to see if the command output was piped anywhere.
3429 If so, we go through the necessary code to unhook the pipe and go back to
3430 our standard filehandles for input and output.
3431
3432 =cut
3433
3434         continue {    # CMD:
3435
3436             # At the end of every command:
3437             if ($piped) {
3438
3439                 # Unhook the pipe mechanism now.
3440                 if ( $pager =~ /^\|/ ) {
3441
3442                     # No error from the child.
3443                     $? = 0;
3444
3445                     # we cannot warn here: the handle is missing --tchrist
3446                     close(OUT) || print SAVEOUT "\nCan't close DB::OUT\n";
3447
3448                     # most of the $? crud was coping with broken cshisms
3449                     # $? is explicitly set to 0, so this never runs.
3450                     if ($?) {
3451                         print SAVEOUT "Pager `$pager' failed: ";
3452                         if ( $? == -1 ) {
3453                             print SAVEOUT "shell returned -1\n";
3454                         }
3455                         elsif ( $? >> 8 ) {
3456                             print SAVEOUT ( $? & 127 )
3457                               ? " (SIG#" . ( $? & 127 ) . ")"
3458                               : "", ( $? & 128 ) ? " -- core dumped" : "", "\n";
3459                         }
3460                         else {
3461                             print SAVEOUT "status ", ( $? >> 8 ), "\n";
3462                         }
3463                     } ## end if ($?)
3464
3465                     # Reopen filehandle for our output (if we can) and
3466                     # restore STDOUT (if we can).
3467                     open( OUT, ">&STDOUT" ) || &warn("Can't restore DB::OUT");
3468                     open( STDOUT, ">&SAVEOUT" )
3469                       || &warn("Can't restore STDOUT");
3470
3471                     # Turn off pipe exception handler if necessary.
3472                     $SIG{PIPE} = "DEFAULT" if $SIG{PIPE} eq \&DB::catch;
3473
3474                     # Will stop ignoring SIGPIPE if done like nohup(1)
3475                     # does SIGINT but Perl doesn't give us a choice.
3476                 } ## end if ($pager =~ /^\|/)
3477                 else {
3478
3479                     # Non-piped "pager". Just restore STDOUT.
3480                     open( OUT, ">&SAVEOUT" ) || &warn("Can't restore DB::OUT");
3481                 }
3482
3483                 # Close filehandle pager was using, restore the normal one
3484                 # if necessary,
3485                 close(SAVEOUT);
3486                 select($selected), $selected = "" unless $selected eq "";
3487
3488                 # No pipes now.
3489                 $piped = "";
3490             } ## end if ($piped)
3491         }    # CMD:
3492
3493 =head3 COMMAND LOOP TERMINATION
3494
3495 When commands have finished executing, we come here. If the user closed the
3496 input filehandle, we turn on C<$fall_off_end> to emulate a C<q> command. We
3497 evaluate any post-prompt items. We restore C<$@>, C<$!>, C<$^E>, C<$,>, C<$/>,
3498 C<$\>, and C<$^W>, and return a null list as expected by the Perl interpreter.
3499 The interpreter will then execute the next line and then return control to us
3500 again.
3501
3502 =cut
3503
3504         # No more commands? Quit.
3505         $fall_off_end = 1 unless defined $cmd;    # Emulate `q' on EOF
3506
3507         # Evaluate post-prompt commands.
3508         foreach $evalarg (@$post) {
3509             &eval;
3510         }
3511     }    # if ($single || $signal)
3512
3513     # Put the user's globals back where you found them.
3514     ( $@, $!, $^E, $,, $/, $\, $^W ) = @saved;
3515     ();
3516 } ## end sub DB
3517
3518 # The following code may be executed now:
3519 # BEGIN {warn 4}
3520
3521 =head2 sub
3522
3523 C<sub> is called whenever a subroutine call happens in the program being
3524 debugged. The variable C<$DB::sub> contains the name of the subroutine
3525 being called.
3526
3527 The core function of this subroutine is to actually call the sub in the proper
3528 context, capturing its output. This of course causes C<DB::DB> to get called
3529 again, repeating until the subroutine ends and returns control to C<DB::sub>
3530 again. Once control returns, C<DB::sub> figures out whether or not to dump the
3531 return value, and returns its captured copy of the return value as its own
3532 return value. The value then feeds back into the program being debugged as if
3533 C<DB::sub> hadn't been there at all.
3534
3535 C<sub> does all the work of printing the subroutine entry and exit messages
3536 enabled by setting C<$frame>. It notes what sub the autoloader got called for,
3537 and also prints the return value if needed (for the C<r> command and if
3538 the 16 bit is set in C<$frame>).
3539
3540 It also tracks the subroutine call depth by saving the current setting of
3541 C<$single> in the C<@stack> package global; if this exceeds the value in
3542 C<$deep>, C<sub> automatically turns on printing of the current depth by
3543 setting the C<4> bit in C<$single>. In any case, it keeps the current setting
3544 of stop/don't stop on entry to subs set as it currently is set.
3545
3546 =head3 C<caller()> support
3547
3548 If C<caller()> is called from the package C<DB>, it provides some
3549 additional data, in the following order:
3550
3551 =over 4
3552
3553 =item * C<$package>
3554
3555 The package name the sub was in
3556
3557 =item * C<$filename>
3558
3559 The filename it was defined in
3560
3561 =item * C<$line>
3562
3563 The line number it was defined on
3564
3565 =item * C<$subroutine>
3566
3567 The subroutine name; C<(eval)> if an C<eval>().
3568
3569 =item * C<$hasargs>
3570
3571 1 if it has arguments, 0 if not
3572
3573 =item * C<$wantarray>
3574
3575 1 if array context, 0 if scalar context
3576
3577 =item * C<$evaltext>
3578
3579 The C<eval>() text, if any (undefined for C<eval BLOCK>)
3580
3581 =item * C<$is_require>
3582
3583 frame was created by a C<use> or C<require> statement
3584
3585 =item * C<$hints>
3586
3587 pragma information; subject to change between versions
3588
3589 =item * C<$bitmask>
3590
3591 pragma information; subject to change between versions
3592
3593 =item * C<@DB::args>
3594
3595 arguments with which the subroutine was invoked
3596
3597 =back
3598
3599 =cut
3600
3601 sub sub {
3602
3603         # lock ourselves under threads
3604         lock($DBGR);
3605
3606     # Whether or not the autoloader was running, a scalar to put the
3607     # sub's return value in (if needed), and an array to put the sub's
3608     # return value in (if needed).
3609     my ( $al, $ret, @ret ) = "";
3610         if ($sub =~ /^threads::new$/ && $ENV{PERL5DB_THREADED}) {
3611                 print "creating new thread\n";
3612         }
3613
3614     # If the last ten characters are C'::AUTOLOAD', note we've traced
3615     # into AUTOLOAD for $sub.
3616     if ( length($sub) > 10 && substr( $sub, -10, 10 ) eq '::AUTOLOAD' ) {
3617         $al = " for $$sub";
3618     }
3619
3620     # We stack the stack pointer and then increment it to protect us
3621     # from a situation that might unwind a whole bunch of call frames
3622     # at once. Localizing the stack pointer means that it will automatically
3623     # unwind the same amount when multiple stack frames are unwound.
3624     local $stack_depth = $stack_depth + 1;    # Protect from non-local exits
3625
3626     # Expand @stack.
3627     $#stack = $stack_depth;
3628
3629     # Save current single-step setting.
3630     $stack[-1] = $single;
3631
3632     # Turn off all flags except single-stepping.
3633     $single &= 1;
3634
3635     # If we've gotten really deeply recursed, turn on the flag that will
3636     # make us stop with the 'deep recursion' message.
3637     $single |= 4 if $stack_depth == $deep;
3638
3639     # If frame messages are on ...
3640     (
3641         $frame & 4    # Extended frame entry message
3642         ? (
3643             print_lineinfo( ' ' x ( $stack_depth - 1 ), "in  " ),
3644
3645             # Why -1? But it works! :-(
3646             # Because print_trace will call add 1 to it and then call
3647             # dump_trace; this results in our skipping -1+1 = 0 stack frames
3648             # in dump_trace.
3649             print_trace( $LINEINFO, -1, 1, 1, "$sub$al" )
3650           )
3651         : print_lineinfo( ' ' x ( $stack_depth - 1 ), "entering $sub$al\n" )
3652
3653           # standard frame entry message
3654       )
3655       if $frame;
3656
3657     # Determine the sub's return type,and capture approppriately.
3658     if (wantarray) {
3659
3660         # Called in array context. call sub and capture output.
3661         # DB::DB will recursively get control again if appropriate; we'll come
3662         # back here when the sub is finished.
3663         if ($assertion) {
3664             $assertion = 0;
3665             eval { @ret = &$sub; };
3666             if ($@) {
3667                 print $OUT $@;
3668                 $signal = 1 unless $warnassertions;
3669             }
3670         }
3671         else {
3672             @ret = &$sub;
3673         }
3674
3675         # Pop the single-step value back off the stack.
3676         $single |= $stack[ $stack_depth-- ];
3677
3678         # Check for exit trace messages...
3679         (
3680             $frame & 4    # Extended exit message
3681             ? (
3682                 print_lineinfo( ' ' x $stack_depth, "out " ),
3683                 print_trace( $LINEINFO, -1, 1, 1, "$sub$al" )
3684               )
3685             : print_lineinfo( ' ' x $stack_depth, "exited $sub$al\n" )
3686
3687               # Standard exit message
3688           )
3689           if $frame & 2;
3690
3691         # Print the return info if we need to.
3692         if ( $doret eq $stack_depth or $frame & 16 ) {
3693
3694             # Turn off output record separator.
3695             local $\ = '';
3696             my $fh = ( $doret eq $stack_depth ? $OUT : $LINEINFO );
3697
3698             # Indent if we're printing because of $frame tracing.
3699             print $fh ' ' x $stack_depth if $frame & 16;
3700
3701             # Print the return value.
3702             print $fh "list context return from $sub:\n";
3703             dumpit( $fh, \@ret );
3704
3705             # And don't print it again.
3706             $doret = -2;
3707         } ## end if ($doret eq $stack_depth...
3708             # And we have to return the return value now.
3709         @ret;
3710     } ## end if (wantarray)
3711
3712     # Scalar context.
3713     else {
3714         if ($assertion) {
3715             $assertion = 0;
3716             eval {
3717
3718                 # Save the value if it's wanted at all.
3719                 $ret = &$sub;
3720             };
3721             if ($@) {
3722                 print $OUT $@;
3723                 $signal = 1 unless $warnassertions;
3724             }
3725             $ret = undef unless defined wantarray;
3726         }
3727         else {
3728             if ( defined wantarray ) {
3729
3730                 # Save the value if it's wanted at all.
3731                 $ret = &$sub;
3732             }
3733             else {
3734
3735                 # Void return, explicitly.
3736                 &$sub;
3737                 undef $ret;
3738             }
3739         }    # if assertion
3740
3741         # Pop the single-step value off the stack.
3742         $single |= $stack[ $stack_depth-- ];
3743
3744         # If we're doing exit messages...
3745         (
3746             $frame & 4    # Extended messsages
3747             ? (
3748                 print_lineinfo( ' ' x $stack_depth, "out " ),
3749                 print_trace( $LINEINFO, -1, 1, 1, "$sub$al" )
3750               )
3751             : print_lineinfo( ' ' x $stack_depth, "exited $sub$al\n" )
3752
3753               # Standard messages
3754           )
3755           if $frame & 2;
3756
3757         # If we are supposed to show the return value... same as before.
3758         if ( $doret eq $stack_depth or $frame & 16 and defined wantarray ) {
3759             local $\ = '';
3760             my $fh = ( $doret eq $stack_depth ? $OUT : $LINEINFO );
3761             print $fh ( ' ' x $stack_depth ) if $frame & 16;
3762             print $fh (
3763                 defined wantarray
3764                 ? "scalar context return from $sub: "
3765                 : "void context return from $sub\n"
3766             );
3767             dumpit( $fh, $ret ) if defined wantarray;
3768             $doret = -2;
3769         } ## end if ($doret eq $stack_depth...
3770
3771         # Return the appropriate scalar value.
3772         $ret;
3773     } ## end else [ if (wantarray)
3774 } ## end sub sub
3775
3776 =head1 EXTENDED COMMAND HANDLING AND THE COMMAND API
3777
3778 In Perl 5.8.0, there was a major realignment of the commands and what they did,
3779 Most of the changes were to systematize the command structure and to eliminate
3780 commands that threw away user input without checking.
3781
3782 The following sections describe the code added to make it easy to support
3783 multiple command sets with conflicting command names. This section is a start
3784 at unifying all command processing to make it simpler to develop commands.
3785
3786 Note that all the cmd_[a-zA-Z] subroutines require the command name, a line
3787 number, and C<$dbline> (the current line) as arguments.
3788
3789 Support functions in this section which have multiple modes of failure C<die>
3790 on error; the rest simply return a false value.
3791
3792 The user-interface functions (all of the C<cmd_*> functions) just output
3793 error messages.
3794
3795 =head2 C<%set>
3796
3797 The C<%set> hash defines the mapping from command letter to subroutine
3798 name suffix.
3799
3800 C<%set> is a two-level hash, indexed by set name and then by command name.
3801 Note that trying to set the CommandSet to C<foobar> simply results in the
3802 5.8.0 command set being used, since there's no top-level entry for C<foobar>.
3803
3804 =cut
3805
3806 ### The API section
3807
3808 my %set = (    #
3809     'pre580' => {
3810         'a' => 'pre580_a',
3811         'A' => 'pre580_null',
3812         'b' => 'pre580_b',
3813         'B' => 'pre580_null',
3814         'd' => 'pre580_null',
3815         'D' => 'pre580_D',
3816         'h' => 'pre580_h',
3817         'M' => 'pre580_null',
3818         'O' => 'o',
3819         'o' => 'pre580_null',
3820         'v' => 'M',
3821         'w' => 'v',
3822         'W' => 'pre580_W',
3823     },
3824     'pre590' => {
3825         '<'  => 'pre590_prepost',
3826         '<<' => 'pre590_prepost',
3827         '>'  => 'pre590_prepost',
3828         '>>' => 'pre590_prepost',
3829         '{'  => 'pre590_prepost',
3830         '{{' => 'pre590_prepost',
3831     },
3832 );
3833
3834 =head2 C<cmd_wrapper()> (API)
3835
3836 C<cmd_wrapper()> allows the debugger to switch command sets
3837 depending on the value of the C<CommandSet> option.
3838
3839 It tries to look up the command in the C<%set> package-level I<lexical>
3840 (which means external entities can't fiddle with it) and create the name of
3841 the sub to call based on the value found in the hash (if it's there). I<All>
3842 of the commands to be handled in a set have to be added to C<%set>; if they
3843 aren't found, the 5.8.0 equivalent is called (if there is one).
3844
3845 This code uses symbolic references.
3846
3847 =cut
3848
3849 sub cmd_wrapper {
3850     my $cmd      = shift;
3851     my $line     = shift;
3852     my $dblineno = shift;
3853
3854     # Assemble the command subroutine's name by looking up the
3855     # command set and command name in %set. If we can't find it,
3856     # default to the older version of the command.
3857     my $call = 'cmd_'
3858       . ( $set{$CommandSet}{$cmd}
3859           || ( $cmd =~ /^[<>{]+/o ? 'prepost' : $cmd ) );
3860
3861     # Call the command subroutine, call it by name.
3862     return &$call( $cmd, $line, $dblineno );
3863 } ## end sub cmd_wrapper
3864
3865 =head3 C<cmd_a> (command)
3866
3867 The C<a> command handles pre-execution actions. These are associated with a
3868 particular line, so they're stored in C<%dbline>. We default to the current
3869 line if none is specified.
3870
3871 =cut
3872
3873 sub cmd_a {
3874     my $cmd    = shift;
3875     my $line   = shift || '';    # [.|line] expr
3876     my $dbline = shift;
3877
3878     # If it's dot (here), or not all digits,  use the current line.
3879     $line =~ s/^(\.|(?:[^\d]))/$dbline/;
3880
3881     # Should be a line number followed by an expression.
3882     if ( $line =~ /^\s*(\d*)\s*(\S.+)/ ) {
3883         my ( $lineno, $expr ) = ( $1, $2 );
3884
3885         # If we have an expression ...
3886         if ( length $expr ) {
3887
3888             # ... but the line isn't breakable, complain.
3889             if ( $dbline[$lineno] == 0 ) {
3890                 print $OUT
3891                   "Line $lineno($dbline[$lineno]) does not have an action?\n";
3892             }
3893             else {
3894
3895                 # It's executable. Record that the line has an action.
3896                 $had_breakpoints{$filename} |= 2;
3897
3898                 # Remove any action, temp breakpoint, etc.
3899                 $dbline{$lineno} =~ s/\0[^\0]*//;
3900
3901                 # Add the action to the line.
3902                 $dbline{$lineno} .= "\0" . action($expr);
3903             }
3904         } ## end if (length $expr)
3905     } ## end if ($line =~ /^\s*(\d*)\s*(\S.+)/)
3906     else {
3907
3908         # Syntax wrong.
3909         print $OUT
3910           "Adding an action requires an optional lineno and an expression\n"
3911           ;    # hint
3912     }
3913 } ## end sub cmd_a
3914
3915 =head3 C<cmd_A> (command)
3916
3917 Delete actions. Similar to above, except the delete code is in a separate
3918 subroutine, C<delete_action>.
3919
3920 =cut
3921
3922 sub cmd_A {
3923     my $cmd    = shift;
3924     my $line   = shift || '';
3925     my $dbline = shift;
3926
3927     # Dot is this line.
3928     $line =~ s/^\./$dbline/;
3929
3930     # Call delete_action with a null param to delete them all.
3931     # The '1' forces the eval to be true. It'll be false only
3932     # if delete_action blows up for some reason, in which case
3933     # we print $@ and get out.
3934     if ( $line eq '*' ) {
3935         eval { &delete_action(); 1 } or print $OUT $@ and return;
3936     }
3937
3938     # There's a real line  number. Pass it to delete_action.
3939     # Error trapping is as above.
3940     elsif ( $line =~ /^(\S.*)/ ) {
3941         eval { &delete_action($1); 1 } or print $OUT $@ and return;
3942     }
3943
3944     # Swing and a miss. Bad syntax.
3945     else {
3946         print $OUT
3947           "Deleting an action requires a line number, or '*' for all\n" ; # hint
3948     }
3949 } ## end sub cmd_A
3950
3951 =head3 C<delete_action> (API)
3952
3953 C<delete_action> accepts either a line number or C<undef>. If a line number
3954 is specified, we check for the line being executable (if it's not, it
3955 couldn't have had an  action). If it is, we just take the action off (this
3956 will get any kind of an action, including breakpoints).
3957
3958 =cut
3959
3960 sub delete_action {
3961     my $i = shift;
3962     if ( defined($i) ) {
3963
3964         # Can there be one?
3965         die "Line $i has no action .\n" if $dbline[$i] == 0;
3966
3967         # Nuke whatever's there.
3968         $dbline{$i} =~ s/\0[^\0]*//;    # \^a
3969         delete $dbline{$i} if $dbline{$i} eq '';
3970     }
3971     else {
3972         print $OUT "Deleting all actions...\n";
3973         for my $file ( keys %had_breakpoints ) {
3974             local *dbline = $main::{ '_<' . $file };
3975             my $max = $#dbline;
3976             my $was;
3977             for ( $i = 1 ; $i <= $max ; $i++ ) {
3978                 if ( defined $dbline{$i} ) {
3979                     $dbline{$i} =~ s/\0[^\0]*//;
3980                     delete $dbline{$i} if $dbline{$i} eq '';
3981                 }
3982                 unless ( $had_breakpoints{$file} &= ~2 ) {
3983                     delete $had_breakpoints{$file};
3984                 }
3985             } ## end for ($i = 1 ; $i <= $max...
3986         } ## end for my $file (keys %had_breakpoints)
3987     } ## end else [ if (defined($i))
3988 } ## end sub delete_action
3989
3990 =head3 C<cmd_b> (command)
3991
3992 Set breakpoints. Since breakpoints can be set in so many places, in so many
3993 ways, conditionally or not, the breakpoint code is kind of complex. Mostly,
3994 we try to parse the command type, and then shuttle it off to an appropriate
3995 subroutine to actually do the work of setting the breakpoint in the right
3996 place.
3997
3998 =cut
3999
4000 sub cmd_b {
4001     my $cmd    = shift;
4002     my $line   = shift;    # [.|line] [cond]
4003     my $dbline = shift;
4004
4005     # Make . the current line number if it's there..
4006     $line =~ s/^\./$dbline/;
4007
4008     # No line number, no condition. Simple break on current line.
4009     if ( $line =~ /^\s*$/ ) {
4010         &cmd_b_line( $dbline, 1 );
4011     }
4012
4013     # Break on load for a file.
4014     elsif ( $line =~ /^load\b\s*(.*)/ ) {
4015         my $file = $1;
4016         $file =~ s/\s+$//;
4017         &cmd_b_load($file);
4018     }
4019
4020     # b compile|postpone <some sub> [<condition>]
4021     # The interpreter actually traps this one for us; we just put the
4022     # necessary condition in the %postponed hash.
4023     elsif ( $line =~ /^(postpone|compile)\b\s*([':A-Za-z_][':\w]*)\s*(.*)/ ) {
4024
4025         # Capture the condition if there is one. Make it true if none.
4026         my $cond = length $3 ? $3 : '1';
4027
4028         # Save the sub name and set $break to 1 if $1 was 'postpone', 0
4029         # if it was 'compile'.
4030         my ( $subname, $break ) = ( $2, $1 eq 'postpone' );
4031
4032         # De-Perl4-ify the name - ' separators to ::.
4033         $subname =~ s/\'/::/g;
4034
4035         # Qualify it into the current package unless it's already qualified.
4036         $subname = "${'package'}::" . $subname unless $subname =~ /::/;
4037
4038         # Add main if it starts with ::.
4039         $subname = "main" . $subname if substr( $subname, 0, 2 ) eq "::";
4040
4041         # Save the break type for this sub.
4042         $postponed{$subname} = $break ? "break +0 if $cond" : "compile";
4043     } ## end elsif ($line =~ ...
4044
4045     # b <sub name> [<condition>]
4046     elsif ( $line =~ /^([':A-Za-z_][':\w]*(?:\[.*\])?)\s*(.*)/ ) {
4047
4048         #
4049         $subname = $1;
4050         $cond = length $2 ? $2 : '1';
4051         &cmd_b_sub( $subname, $cond );
4052     }
4053
4054     # b <line> [<condition>].
4055     elsif ( $line =~ /^(\d*)\s*(.*)/ ) {
4056
4057         # Capture the line. If none, it's the current line.
4058         $line = $1 || $dbline;
4059
4060         # If there's no condition, make it '1'.
4061         $cond = length $2 ? $2 : '1';
4062
4063         # Break on line.
4064         &cmd_b_line( $line, $cond );
4065     }
4066
4067     # Line didn't make sense.
4068     else {
4069         print "confused by line($line)?\n";
4070     }
4071 } ## end sub cmd_b
4072
4073 =head3 C<break_on_load> (API)
4074
4075 We want to break when this file is loaded. Mark this file in the
4076 C<%break_on_load> hash, and note that it has a breakpoint in
4077 C<%had_breakpoints>.
4078
4079 =cut
4080
4081 sub break_on_load {
4082     my $file = shift;
4083     $break_on_load{$file} = 1;
4084     $had_breakpoints{$file} |= 1;
4085 }
4086
4087 =head3 C<report_break_on_load> (API)
4088
4089 Gives us an array of filenames that are set to break on load. Note that
4090 only files with break-on-load are in here, so simply showing the keys
4091 suffices.
4092
4093 =cut
4094
4095 sub report_break_on_load {
4096     sort keys %break_on_load;
4097 }
4098
4099 =head3 C<cmd_b_load> (command)
4100
4101 We take the file passed in and try to find it in C<%INC> (which maps modules
4102 to files they came from). We mark those files for break-on-load via
4103 C<break_on_load> and then report that it was done.
4104
4105 =cut
4106
4107 sub cmd_b_load {
4108     my $file = shift;
4109     my @files;
4110
4111     # This is a block because that way we can use a redo inside it
4112     # even without there being any looping structure at all outside it.
4113     {
4114
4115         # Save short name and full path if found.
4116         push @files, $file;
4117         push @files, $::INC{$file} if $::INC{$file};
4118
4119         # Tack on .pm and do it again unless there was a '.' in the name
4120         # already.
4121         $file .= '.pm', redo unless $file =~ /\./;
4122     }
4123
4124     # Do the real work here.
4125     break_on_load($_) for @files;
4126
4127     # All the files that have break-on-load breakpoints.
4128     @files = report_break_on_load;
4129
4130     # Normalize for the purposes of our printing this.
4131     local $\ = '';
4132     local $" = ' ';
4133     print $OUT "Will stop on load of `@files'.\n";
4134 } ## end sub cmd_b_load
4135
4136 =head3 C<$filename_error> (API package global)
4137
4138 Several of the functions we need to implement in the API need to work both
4139 on the current file and on other files. We don't want to duplicate code, so
4140 C<$filename_error> is used to contain the name of the file that's being
4141 worked on (if it's not the current one).
4142
4143 We can now build functions in pairs: the basic function works on the current
4144 file, and uses C<$filename_error> as part of its error message. Since this is
4145 initialized to C<"">, no filename will appear when we are working on the
4146 current file.
4147
4148 The second function is a wrapper which does the following:
4149
4150 =over 4
4151
4152 =item *
4153
4154 Localizes C<$filename_error> and sets it to the name of the file to be processed.
4155
4156 =item *
4157
4158 Localizes the C<*dbline> glob and reassigns it to point to the file we want to process.
4159
4160 =item *
4161
4162 Calls the first function.
4163
4164 The first function works on the I<current> file (i.e., the one we changed to),
4165 and prints C<$filename_error> in the error message (the name of the other file)
4166 if it needs to. When the functions return, C<*dbline> is restored to point
4167 to the actual current file (the one we're executing in) and
4168 C<$filename_error> is restored to C<"">. This restores everything to
4169 the way it was before the second function was called at all.
4170
4171 See the comments in C<breakable_line> and C<breakable_line_in_file> for more
4172 details.
4173
4174 =back
4175
4176 =cut
4177
4178 $filename_error = '';
4179
4180 =head3 breakable_line(from, to) (API)
4181
4182 The subroutine decides whether or not a line in the current file is breakable.
4183 It walks through C<@dbline> within the range of lines specified, looking for
4184 the first line that is breakable.
4185
4186 If C<$to> is greater than C<$from>, the search moves forwards, finding the
4187 first line I<after> C<$to> that's breakable, if there is one.
4188
4189 If C<$from> is greater than C<$to>, the search goes I<backwards>, finding the
4190 first line I<before> C<$to> that's breakable, if there is one.
4191
4192 =cut
4193
4194 sub breakable_line {
4195
4196     my ( $from, $to ) = @_;
4197
4198     # $i is the start point. (Where are the FORTRAN programs of yesteryear?)
4199     my $i = $from;
4200
4201     # If there are at least 2 arguments, we're trying to search a range.
4202     if ( @_ >= 2 ) {
4203
4204         # $delta is positive for a forward search, negative for a backward one.
4205         my $delta = $from < $to ? +1 : -1;
4206
4207         # Keep us from running off the ends of the file.
4208         my $limit = $delta > 0 ? $#dbline : 1;
4209
4210         # Clever test. If you're a mathematician, it's obvious why this
4211         # test works. If not:
4212         # If $delta is positive (going forward), $limit will be $#dbline.
4213         #    If $to is less than $limit, ($limit - $to) will be positive, times
4214         #    $delta of 1 (positive), so the result is > 0 and we should use $to
4215         #    as the stopping point.
4216         #
4217         #    If $to is greater than $limit, ($limit - $to) is negative,
4218         #    times $delta of 1 (positive), so the result is < 0 and we should
4219         #    use $limit ($#dbline) as the stopping point.
4220         #
4221         # If $delta is negative (going backward), $limit will be 1.
4222         #    If $to is zero, ($limit - $to) will be 1, times $delta of -1
4223         #    (negative) so the result is > 0, and we use $to as the stopping
4224         #    point.
4225         #
4226         #    If $to is less than zero, ($limit - $to) will be positive,
4227         #    times $delta of -1 (negative), so the result is not > 0, and
4228         #    we use $limit (1) as the stopping point.
4229         #
4230         #    If $to is 1, ($limit - $to) will zero, times $delta of -1
4231         #    (negative), still giving zero; the result is not > 0, and
4232         #    we use $limit (1) as the stopping point.
4233         #
4234         #    if $to is >1, ($limit - $to) will be negative, times $delta of -1
4235         #    (negative), giving a positive (>0) value, so we'll set $limit to
4236         #    $to.
4237
4238         $limit = $to if ( $limit - $to ) * $delta > 0;
4239
4240         # The real search loop.
4241         # $i starts at $from (the point we want to start searching from).
4242         # We move through @dbline in the appropriate direction (determined
4243         # by $delta: either -1 (back) or +1 (ahead).
4244         # We stay in as long as we haven't hit an executable line
4245         # ($dbline[$i] == 0 means not executable) and we haven't reached
4246         # the limit yet (test similar to the above).
4247         $i += $delta while $dbline[$i] == 0 and ( $limit - $i ) * $delta > 0;
4248
4249     } ## end if (@_ >= 2)
4250
4251     # If $i points to a line that is executable, return that.
4252     return $i unless $dbline[$i] == 0;
4253
4254     # Format the message and print it: no breakable lines in range.
4255     my ( $pl, $upto ) = ( '', '' );
4256     ( $pl, $upto ) = ( 's', "..$to" ) if @_ >= 2 and $from != $to;
4257
4258     # If there's a filename in filename_error, we'll see it.
4259     # If not, not.
4260     die "Line$pl $from$upto$filename_error not breakable\n";
4261 } ## end sub breakable_line
4262
4263 =head3 breakable_line_in_filename(file, from, to) (API)
4264
4265 Like C<breakable_line>, but look in another file.
4266
4267 =cut
4268
4269 sub breakable_line_in_filename {
4270
4271     # Capture the file name.
4272     my ($f) = shift;
4273
4274     # Swap the magic line array over there temporarily.
4275     local *dbline = $main::{ '_<' . $f };
4276
4277     # If there's an error, it's in this other file.
4278     local $filename_error = " of `$f'";
4279
4280     # Find the breakable line.
4281     breakable_line(@_);
4282
4283     # *dbline and $filename_error get restored when this block ends.
4284
4285 } ## end sub breakable_line_in_filename
4286
4287 =head3 break_on_line(lineno, [condition]) (API)
4288
4289 Adds a breakpoint with the specified condition (or 1 if no condition was
4290 specified) to the specified line. Dies if it can't.
4291
4292 =cut
4293
4294 sub break_on_line {
4295     my ( $i, $cond ) = @_;
4296
4297     # Always true if no condition supplied.
4298     $cond = 1 unless @_ >= 2;
4299
4300     my $inii  = $i;
4301     my $after = '';
4302     my $pl    = '';
4303
4304     # Woops, not a breakable line. $filename_error allows us to say
4305     # if it was in a different file.
4306     die "Line $i$filename_error not breakable.\n" if $dbline[$i] == 0;
4307
4308     # Mark this file as having breakpoints in it.
4309     $had_breakpoints{$filename} |= 1;
4310
4311     # If there is an action or condition here already ...
4312     if ( $dbline{$i} ) {
4313
4314         # ... swap this condition for the existing one.
4315         $dbline{$i} =~ s/^[^\0]*/$cond/;
4316     }
4317     else {
4318
4319         # Nothing here - just add the condition.
4320         $dbline{$i} = $cond;
4321     }
4322 } ## end sub break_on_line
4323
4324 =head3 cmd_b_line(line, [condition]) (command)
4325
4326 Wrapper for C<break_on_line>. Prints the failure message if it
4327 doesn't work.
4328
4329 =cut
4330
4331 sub cmd_b_line {
4332     eval { break_on_line(@_); 1 } or do {
4333         local $\ = '';
4334         print $OUT $@ and return;
4335     };
4336 } ## end sub cmd_b_line
4337
4338 =head3 break_on_filename_line(file, line, [condition]) (API)
4339
4340 Switches to the file specified and then calls C<break_on_line> to set
4341 the breakpoint.
4342
4343 =cut
4344
4345 sub break_on_filename_line {
4346     my ( $f, $i, $cond ) = @_;
4347
4348     # Always true if condition left off.
4349     $cond = 1 unless @_ >= 3;
4350
4351     # Switch the magical hash temporarily.
4352     local *dbline = $main::{ '_<' . $f };
4353
4354     # Localize the variables that break_on_line uses to make its message.
4355     local $filename_error = " of `$f'";
4356     local $filename       = $f;
4357
4358     # Add the breakpoint.
4359     break_on_line( $i, $cond );
4360 } ## end sub break_on_filename_line
4361
4362 =head3 break_on_filename_line_range(file, from, to, [condition]) (API)
4363
4364 Switch to another file, search the range of lines specified for an
4365 executable one, and put a breakpoint on the first one you find.
4366
4367 =cut
4368
4369 sub break_on_filename_line_range {
4370     my ( $f, $from, $to, $cond ) = @_;
4371
4372     # Find a breakable line if there is one.
4373     my $i = breakable_line_in_filename( $f, $from, $to );
4374
4375     # Always true if missing.
4376     $cond = 1 unless @_ >= 3;
4377
4378     # Add the breakpoint.
4379     break_on_filename_line( $f, $i, $cond );
4380 } ## end sub break_on_filename_line_range
4381
4382 =head3 subroutine_filename_lines(subname, [condition]) (API)
4383
4384 Search for a subroutine within a given file. The condition is ignored.
4385 Uses C<find_sub> to locate the desired subroutine.
4386
4387 =cut
4388
4389 sub subroutine_filename_lines {
4390     my ( $subname, $cond ) = @_;
4391
4392     # Returned value from find_sub() is fullpathname:startline-endline.
4393     # The match creates the list (fullpathname, start, end). Falling off
4394     # the end of the subroutine returns this implicitly.
4395     find_sub($subname) =~ /^(.*):(\d+)-(\d+)$/;
4396 } ## end sub subroutine_filename_lines
4397
4398 =head3 break_subroutine(subname) (API)
4399
4400 Places a break on the first line possible in the specified subroutine. Uses
4401 C<subroutine_filename_lines> to find the subroutine, and
4402 C<break_on_filename_line_range> to place the break.
4403
4404 =cut
4405
4406 sub break_subroutine {
4407     my $subname = shift;
4408
4409     # Get filename, start, and end.
4410     my ( $file, $s, $e ) = subroutine_filename_lines($subname)
4411       or die "Subroutine $subname not found.\n";
4412
4413     # Null condition changes to '1' (always true).
4414     $cond = 1 unless @_ >= 2;
4415
4416     # Put a break the first place possible in the range of lines
4417     # that make up this subroutine.
4418     break_on_filename_line_range( $file, $s, $e, @_ );
4419 } ## end sub break_subroutine
4420
4421 =head3 cmd_b_sub(subname, [condition]) (command)
4422
4423 We take the incoming subroutine name and fully-qualify it as best we can.
4424
4425 =over 4
4426
4427 =item 1. If it's already fully-qualified, leave it alone.
4428
4429 =item 2. Try putting it in the current package.
4430
4431 =item 3. If it's not there, try putting it in CORE::GLOBAL if it exists there.
4432
4433 =item 4. If it starts with '::', put it in 'main::'.
4434
4435 =back
4436
4437 After all this cleanup, we call C<break_subroutine> to try to set the
4438 breakpoint.
4439
4440 =cut
4441
4442 sub cmd_b_sub {
4443     my ( $subname, $cond ) = @_;
4444
4445     # Add always-true condition if we have none.
4446     $cond = 1 unless @_ >= 2;
4447
4448     # If the subname isn't a code reference, qualify it so that
4449     # break_subroutine() will work right.
4450     unless ( ref $subname eq 'CODE' ) {
4451
4452         # Not Perl4.
4453         $subname =~ s/\'/::/g;
4454         my $s = $subname;
4455
4456         # Put it in this package unless it's already qualified.
4457         $subname = "${'package'}::" . $subname
4458           unless $subname =~ /::/;
4459
4460         # Requalify it into CORE::GLOBAL if qualifying it into this
4461         # package resulted in its not being defined, but only do so
4462         # if it really is in CORE::GLOBAL.
4463         $subname = "CORE::GLOBAL::$s"
4464           if not defined &$subname
4465           and $s !~ /::/
4466           and defined &{"CORE::GLOBAL::$s"};
4467