lib/perl5db.pl

   1
   2 =head1 NAME
   3
   4 C<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 isn't. 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 "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
 136 =item * First, doing an arithmetical or bitwise operation on a scalar is
 137 just about the fastest thing you can do in Perl: C<use constant> actually
 138 creates a subroutine call, and array hand hash lookups are much slower. Is
 139 this over-optimization at the expense of readability? Possibly, but the
 140 debugger accesses these  variables a I<lot>. Any rewrite of the code will
 141 probably have to benchmark alternate implementations and see which is the
 142 best balance of readability and speed, and then document how it actually
 143 works.
 144
 145 =item * Second, it's very easy to serialize a scalar number. This is done in
 146 the restart code; the debugger state variables are saved in C<%ENV> and then
 147 restored when the debugger is restarted. Having them be just numbers makes
 148 this trivial.
 149
 150 =item * Third, some of these variables are being shared with the Perl core
 151 smack in the middle of the interpreter's execution loop. It's much faster for
 152 a C program (like the interpreter) to check a bit in a scalar than to access
 153 several different variables (or a Perl array).
 154
 155 =back
 156
 157 =head2 What are those C<XXX> comments for?
 158
 159 Any comment containing C<XXX> means that the comment is either somewhat
 160 speculative - it's not exactly clear what a given variable or chunk of
 161 code is doing, or that it is incomplete - the basics may be clear, but the
 162 subtleties are not completely documented.
 163
 164 Send in a patch if you can clear up, fill out, or clarify an C<XXX>.
 165
 166 =head1 DATA STRUCTURES MAINTAINED BY CORE
 167
 168 There are a number of special data structures provided to the debugger by
 169 the Perl interpreter.
 170
 171 The array C<@{$main::{'_<'.$filename}}> (aliased locally to C<@dbline> via glob
 172 assignment) contains the text from C<$filename>, with each element
 173 corresponding to a single line of C<$filename>.
 174
 175 The hash C<%{'_<'.$filename}> (aliased locally to C<%dbline> via glob
 176 assignment) contains breakpoints and actions.  The keys are line numbers;
 177 you can set individual values, but not the whole hash. The Perl interpreter
 178 uses this hash to determine where breakpoints have been set. Any true value is
 179 considered to be a breakpoint; C<perl5db.pl> uses "$break_condition\0$action".
 180 Values are magical in numeric context: 1 if the line is breakable, 0 if not.
 181
 182 The scalar ${'_<'.$filename} contains $filename  XXX What?
 183
 184 =head1 DEBUGGER STARTUP
 185
 186 When C<perl5db.pl> starts, it reads an rcfile (C<perl5db.ini> for
 187 non-interactive sessions, C<.perldb> for interactive ones) that can set a number
 188 of options. In addition, this file may define a subroutine C<&afterinit>
 189 that will be executed (in the debugger's context) after the debugger has
 190 initialized itself.
 191
 192 Next, it checks the C<PERLDB_OPTS> environment variable and treats its
 193 contents as the argument of a debugger <C<o> command.
 194
 195 =head2 STARTUP-ONLY OPTIONS
 196
 197 The following options can only be specified at startup.
 198 To set them in your rcfile, add a call to
 199 C<&parse_options("optionName=new_value")>.
 200
 201 =over 4
 202
 203 =item * TTY
 204
 205 the TTY to use for debugging i/o.
 206
 207 =item * noTTY
 208
 209 if set, goes in NonStop mode.  On interrupt, if TTY is not set,
 210 uses the value of noTTY or "/tmp/perldbtty$$" to find TTY using
 211 Term::Rendezvous.  Current variant is to have the name of TTY in this
 212 file.
 213
 214 =item * ReadLine
 215
 216 If false, a dummy  ReadLine is used, so you can debug
 217 ReadLine applications.
 218
 219 =item * NonStop
 220
 221 if true, no i/o is performed until interrupt.
 222
 223 =item * LineInfo
 224
 225 file or pipe to print line number info to.  If it is a
 226 pipe, a short "emacs like" message is used.
 227
 228 =item * RemotePort
 229
 230 host:port to connect to on remote host for remote debugging.
 231
 232 =back
 233
 234 =head3 SAMPLE RCFILE
 235
 236  &parse_options("NonStop=1 LineInfo=db.out");
 237   sub afterinit { $trace = 1; }
 238
 239 The script will run without human intervention, putting trace
 240 information into C<db.out>.  (If you interrupt it, you had better
 241 reset C<LineInfo> to something "interactive"!)
 242
 243 =head1 INTERNALS DESCRIPTION
 244
 245 =head2 DEBUGGER INTERFACE VARIABLES
 246
 247 Perl supplies the values for C<%sub>.  It effectively inserts
 248 a C<&DB'DB();> in front of each place that can have a
 249 breakpoint. At each subroutine call, it calls C<&DB::sub> with
 250 C<$DB::sub> set to the called subroutine. It also inserts a C<BEGIN
 251 {require 'perl5db.pl'}> before the first line.
 252
 253 After each C<require>d file is compiled, but before it is executed, a
 254 call to C<&DB::postponed($main::{'_<'.$filename})> is done. C<$filename>
 255 is the expanded name of the C<require>d file (as found via C<%INC>).
 256
 257 =head3 IMPORTANT INTERNAL VARIABLES
 258
 259 =head4 C<$CreateTTY>
 260
 261 Used to control when the debugger will attempt to acquire another TTY to be
 262 used for input.
 263
 264 =over
 265
 266 =item * 1 -  on C<fork()>
 267
 268 =item * 2 - debugger is started inside debugger
 269
 270 =item * 4 -  on startup
 271
 272 =back
 273
 274 =head4 C<$doret>
 275
 276 The value -2 indicates that no return value should be printed.
 277 Any other positive value causes C<DB::sub> to print return values.
 278
 279 =head4 C<$evalarg>
 280
 281 The item to be eval'ed by C<DB::eval>. Used to prevent messing with the current
 282 contents of C<@_> when C<DB::eval> is called.
 283
 284 =head4 C<$frame>
 285
 286 Determines what messages (if any) will get printed when a subroutine (or eval)
 287 is entered or exited.
 288
 289 =over 4
 290
 291 =item * 0 -  No enter/exit messages
 292
 293 =item * 1 - Print "entering" messages on subroutine entry
 294
 295 =item * 2 - Adds exit messages on subroutine exit. If no other flag is on, acts like 1+2.
 296
 297 =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.
 298
 299 =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.
 300
 301 =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.
 302
 303 =back
 304
 305 To get everything, use C<$frame=30> (or C<o f-30> as a debugger command).
 306 The debugger internally juggles the value of C<$frame> during execution to
 307 protect external modules that the debugger uses from getting traced.
 308
 309 =head4 C<$level>
 310
 311 Tracks current debugger nesting level. Used to figure out how many
 312 C<E<lt>E<gt>> pairs to surround the line number with when the debugger
 313 outputs a prompt. Also used to help determine if the program has finished
 314 during command parsing.
 315
 316 =head4 C<$onetimeDump>
 317
 318 Controls what (if anything) C<DB::eval()> will print after evaluating an
 319 expression.
 320
 321 =over 4
 322
 323 =item * C<undef> - don't print anything
 324
 325 =item * C<dump> - use C<dumpvar.pl> to display the value returned
 326
 327 =item * C<methods> - print the methods callable on the first item returned
 328
 329 =back
 330
 331 =head4 C<$onetimeDumpDepth>
 332
 333 Controls how far down C<dumpvar.pl> will go before printing '...' while
 334 dumping a structure. Numeric. If C<undef>, print all levels.
 335
 336 =head4 C<$signal>
 337
 338 Used to track whether or not an C<INT> signal has been detected. C<DB::DB()>,
 339 which is called before every statement, checks this and puts the user into
 340 command mode if it finds C<$signal> set to a true value.
 341
 342 =head4 C<$single>
 343
 344 Controls behavior during single-stepping. Stacked in C<@stack> on entry to
 345 each subroutine; popped again at the end of each subroutine.
 346
 347 =over 4
 348
 349 =item * 0 - run continuously.
 350
 351 =item * 1 - single-step, go into subs. The 's' command.
 352
 353 =item * 2 - single-step, don't go into subs. The 'n' command.
 354
 355 =item * 4 - print current sub depth (turned on to force this when "too much
 356 recursion" occurs.
 357
 358 =back
 359
 360 =head4 C<$trace>
 361
 362 Controls the output of trace information.
 363
 364 =over 4
 365
 366 =item * 1 - The C<t> command was entered to turn on tracing (every line executed is printed)
 367
 368 =item * 2 - watch expressions are active
 369
 370 =item * 4 - user defined a C<watchfunction()> in C<afterinit()>
 371
 372 =back
 373
 374 =head4 C<$slave_editor>
 375
 376 1 if C<LINEINFO> was directed to a pipe; 0 otherwise.
 377
 378 =head4 C<@cmdfhs>
 379
 380 Stack of filehandles that C<DB::readline()> will read commands from.
 381 Manipulated by the debugger's C<source> command and C<DB::readline()> itself.
 382
 383 =head4 C<@dbline>
 384
 385 Local alias to the magical line array, C<@{$main::{'_<'.$filename}}> ,
 386 supplied by the Perl interpreter to the debugger. Contains the source.
 387
 388 =head4 C<@old_watch>
 389
 390 Previous values of watch expressions. First set when the expression is
 391 entered; reset whenever the watch expression changes.
 392
 393 =head4 C<@saved>
 394
 395 Saves important globals (C<$@>, C<$!>, C<$^E>, C<$,>, C<$/>, C<$\>, C<$^W>)
 396 so that the debugger can substitute safe values while it's running, and
 397 restore them when it returns control.
 398
 399 =head4 C<@stack>
 400
 401 Saves the current value of C<$single> on entry to a subroutine.
 402 Manipulated by the C<c> command to turn off tracing in all subs above the
 403 current one.
 404
 405 =head4 C<@to_watch>
 406
 407 The 'watch' expressions: to be evaluated before each line is executed.
 408
 409 =head4 C<@typeahead>
 410
 411 The typeahead buffer, used by C<DB::readline>.
 412
 413 =head4 C<%alias>
 414
 415 Command aliases. Stored as character strings to be substituted for a command
 416 entered.
 417
 418 =head4 C<%break_on_load>
 419
 420 Keys are file names, values are 1 (break when this file is loaded) or undef
 421 (don't break when it is loaded).
 422
 423 =head4 C<%dbline>
 424
 425 Keys are line numbers, values are "condition\0action". If used in numeric
 426 context, values are 0 if not breakable, 1 if breakable, no matter what is
 427 in the actual hash entry.
 428
 429 =head4 C<%had_breakpoints>
 430
 431 Keys are file names; values are bitfields:
 432
 433 =over 4
 434
 435 =item * 1 - file has a breakpoint in it.
 436
 437 =item * 2 - file has an action in it.
 438
 439 =back
 440
 441 A zero or undefined value means this file has neither.
 442
 443 =head4 C<%option>
 444
 445 Stores the debugger options. These are character string values.
 446
 447 =head4 C<%postponed>
 448
 449 Saves breakpoints for code that hasn't been compiled yet.
 450 Keys are subroutine names, values are:
 451
 452 =over 4
 453
 454 =item * 'compile' - break when this sub is compiled
 455
 456 =item * 'break +0 if <condition>' - break (conditionally) at the start of this routine. The condition will be '1' if no condition was specified.
 457
 458 =back
 459
 460 =head4 C<%postponed_file>
 461
 462 This hash keeps track of breakpoints that need to be set for files that have
 463 not yet been compiled. Keys are filenames; values are references to hashes.
 464 Each of these hashes is keyed by line number, and its values are breakpoint
 465 definitions ("condition\0action").
 466
 467 =head1 DEBUGGER INITIALIZATION
 468
 469 The debugger's initialization actually jumps all over the place inside this
 470 package. This is because there are several BEGIN blocks (which of course
 471 execute immediately) spread through the code. Why is that?
 472
 473 The debugger needs to be able to change some things and set some things up
 474 before the debugger code is compiled; most notably, the C<$deep> variable that
 475 C<DB::sub> uses to tell when a program has recursed deeply. In addition, the
 476 debugger has to turn off warnings while the debugger code is compiled, but then
 477 restore them to their original setting before the program being debugged begins
 478 executing.
 479
 480 The first C<BEGIN> block simply turns off warnings by saving the current
 481 setting of C<$^W> and then setting it to zero. The second one initializes
 482 the debugger variables that are needed before the debugger begins executing.
 483 The third one puts C<$^X> back to its former value.
 484
 485 We'll detail the second C<BEGIN> block later; just remember that if you need
 486 to initialize something before the debugger starts really executing, that's
 487 where it has to go.
 488
 489 =cut
 490
 491 package DB;
 492
 493 use IO::Handle;
 494
 495 # Debugger for Perl 5.00x; perl5db.pl patch level:
 496 $VERSION = 1.26;
 497
 498 $header = "perl5db.pl version $VERSION";
 499
 500 =head1 DEBUGGER ROUTINES
 501
 502 =head2 C<DB::eval()>
 503
 504 This function replaces straight C<eval()> inside the debugger; it simplifies
 505 the process of evaluating code in the user's context.
 506
 507 The code to be evaluated is passed via the package global variable
 508 C<$DB::evalarg>; this is done to avoid fiddling with the contents of C<@_>.
 509
 510 We preserve the current settings of X<C<$trace>>, X<C<$single>>, and X<C<$^D>>;
 511 add the X<C<$usercontext>> (that's the preserved values of C<$@>, C<$!>,
 512 C<$^E>, C<$,>, C<$/>, C<$\>, and C<$^W>, grabbed when C<DB::DB> got control,
 513 and the user's current package) and a add a newline before we do the C<eval()>.
 514 This causes the proper context to be used when the eval is actually done.
 515 Afterward, we restore C<$trace>, C<$single>, and C<$^D>.
 516
 517 Next we need to handle C<$@> without getting confused. We save C<$@> in a
 518 local lexical, localize C<$saved[0]> (which is where C<save()> will put
 519 C<$@>), and then call C<save()> to capture C<$@>, C<$!>, C<$^E>, C<$,>,
 520 C<$/>, C<$\>, and C<$^W>) and set C<$,>, C<$/>, C<$\>, and C<$^W> to values
 521 considered sane by the debugger. If there was an C<eval()> error, we print
 522 it on the debugger's output. If X<C<$onetimedump>> is defined, we call
 523 X<C<dumpit>> if it's set to 'dump', or X<C<methods>> if it's set to
 524 'methods'. Setting it to something else causes the debugger to do the eval
 525 but not print the result - handy if you want to do something else with it
 526 (the "watch expressions" code does this to get the value of the watch
 527 expression but not show it unless it matters).
 528
 529 In any case, we then return the list of output from C<eval> to the caller,
 530 and unwinding restores the former version of C<$@> in C<@saved> as well
 531 (the localization of C<$saved[0]> goes away at the end of this scope).
 532
 533 =head3 Parameters and variables influencing execution of DB::eval()
 534
 535 C<DB::eval> isn't parameterized in the standard way; this is to keep the
 536 debugger's calls to C<DB::eval()> from mucking with C<@_>, among other things.
 537 The variables listed below influence C<DB::eval()>'s execution directly.
 538
 539 =over 4
 540
 541 =item C<$evalarg> - the thing to actually be eval'ed
 542
 543 =item C<$trace> - Current state of execution tracing (see X<$trace>)
 544
 545 =item C<$single> - Current state of single-stepping (see X<$single>)
 546
 547 =item C<$onetimeDump> - what is to be displayed after the evaluation
 548
 549 =item C<$onetimeDumpDepth> - how deep C<dumpit()> should go when dumping results
 550
 551 =back
 552
 553 The following variables are altered by C<DB::eval()> during its execution. They
 554 are "stacked" via C<local()>, enabling recursive calls to C<DB::eval()>.
 555
 556 =over 4
 557
 558 =item C<@res> - used to capture output from actual C<eval>.
 559
 560 =item C<$otrace> - saved value of C<$trace>.
 561
 562 =item C<$osingle> - saved value of C<$single>.
 563
 564 =item C<$od> - saved value of C<$^D>.
 565
 566 =item C<$saved[0]> - saved value of C<$@>.
 567
 568 =item $\ - for output of C<$@> if there is an evaluation error.
 569
 570 =back
 571
 572 =head3 The problem of lexicals
 573
 574 The context of C<DB::eval()> presents us with some problems. Obviously,
 575 we want to be 'sandboxed' away from the debugger's internals when we do
 576 the eval, but we need some way to control how punctuation variables and
 577 debugger globals are used.
 578
 579 We can't use local, because the code inside C<DB::eval> can see localized
 580 variables; and we can't use C<my> either for the same reason. The code
 581 in this routine compromises and uses C<my>.
 582
 583 After this routine is over, we don't have user code executing in the debugger's
 584 context, so we can use C<my> freely.
 585
 586 =cut
 587
 588 ############################################## Begin lexical danger zone
 589
 590 # 'my' variables used here could leak into (that is, be visible in)
 591 # the context that the code being evaluated is executing in. This means that
 592 # the code could modify the debugger's variables.
 593 #
 594 # Fiddling with the debugger's context could be Bad. We insulate things as
 595 # much as we can.
 596
 597 sub eval {
 598
 599     # 'my' would make it visible from user code
 600     #    but so does local! --tchrist
 601     # Remember: this localizes @DB::res, not @main::res.
 602     local @res;
 603     {
 604
 605         # Try to keep the user code from messing  with us. Save these so that
 606         # even if the eval'ed code changes them, we can put them back again.
 607         # Needed because the user could refer directly to the debugger's
 608         # package globals (and any 'my' variables in this containing scope)
 609         # inside the eval(), and we want to try to stay safe.
 610         local $otrace  = $trace;
 611         local $osingle = $single;
 612         local $od      = $^D;
 613
 614         # Untaint the incoming eval() argument.
 615         { ($evalarg) = $evalarg =~ /(.*)/s; }
 616
 617         # $usercontext built in DB::DB near the comment
 618         # "set up the context for DB::eval ..."
 619         # Evaluate and save any results.
 620         @res = eval "$usercontext $evalarg;\n";  # '\n' for nice recursive debug
 621
 622         # Restore those old values.
 623         $trace  = $otrace;
 624         $single = $osingle;
 625         $^D     = $od;
 626     }
 627
 628     # Save the current value of $@, and preserve it in the debugger's copy
 629     # of the saved precious globals.
 630     my $at = $@;
 631
 632     # Since we're only saving $@, we only have to localize the array element
 633     # that it will be stored in.
 634     local $saved[0];    # Preserve the old value of $@
 635     eval { &DB::save };
 636
 637     # Now see whether we need to report an error back to the user.
 638     if ($at) {
 639         local $\ = '';
 640         print $OUT $at;
 641     }
 642
 643     # Display as required by the caller. $onetimeDump and $onetimedumpDepth
 644     # are package globals.
 645     elsif ($onetimeDump) {
 646         if ( $onetimeDump eq 'dump' ) {
 647             local $option{dumpDepth} = $onetimedumpDepth
 648               if defined $onetimedumpDepth;
 649             dumpit( $OUT, \@res );
 650         }
 651         elsif ( $onetimeDump eq 'methods' ) {
 652             methods( $res[0] );
 653         }
 654     } ## end elsif ($onetimeDump)
 655     @res;
 656 } ## end sub eval
 657
 658 ############################################## End lexical danger zone
 659
 660 # After this point it is safe to introduce lexicals.
 661 # The code being debugged will be executing in its own context, and
 662 # can't see the inside of the debugger.
 663 #
 664 # However, one should not overdo it: leave as much control from outside as
 665 # possible. If you make something a lexical, it's not going to be addressable
 666 # from outside the debugger even if you know its name.
 667
 668 # This file is automatically included if you do perl -d.
 669 # It's probably not useful to include this yourself.
 670 #
 671 # Before venturing further into these twisty passages, it is
 672 # wise to read the perldebguts man page or risk the ire of dragons.
 673 #
 674 # (It should be noted that perldebguts will tell you a lot about
 675 # the underlying mechanics of how the debugger interfaces into the
 676 # Perl interpreter, but not a lot about the debugger itself. The new
 677 # comments in this code try to address this problem.)
 678
 679 # Note that no subroutine call is possible until &DB::sub is defined
 680 # (for subroutines defined outside of the package DB). In fact the same is
 681 # true if $deep is not defined.
 682 #
 683 # $Log: perldb.pl,v $
 684
 685 # Enhanced by ilya@math.ohio-state.edu (Ilya Zakharevich)
 686
 687 # modified Perl debugger, to be run from Emacs in perldb-mode
 688 # Ray Lischner (uunet!mntgfx!lisch) as of 5 Nov 1990
 689 # Johan Vromans -- upgrade to 4.0 pl 10
 690 # Ilya Zakharevich -- patches after 5.001 (and some before ;-)
 691
 692 # (We have made efforts to  clarify the comments in the change log
 693 # in other places; some of them may seem somewhat obscure as they
 694 # were originally written, and explaining them away from the code
 695 # in question seems conterproductive.. -JM)
 696
 697 ########################################################################
 698 # Changes: 0.94
 699 #   + A lot of things changed after 0.94. First of all, core now informs
 700 #     debugger about entry into XSUBs, overloaded operators, tied operations,
 701 #     BEGIN and END. Handy with `O f=2'.
 702 #   + This can make debugger a little bit too verbose, please be patient
 703 #     and report your problems promptly.
 704 #   + Now the option frame has 3 values: 0,1,2. XXX Document!
 705 #   + Note that if DESTROY returns a reference to the object (or object),
 706 #     the deletion of data may be postponed until the next function call,
 707 #     due to the need to examine the return value.
 708 #
 709 # Changes: 0.95
 710 #   + `v' command shows versions.
 711 #
 712 # Changes: 0.96
 713 #   + `v' command shows version of readline.
 714 #     primitive completion works (dynamic variables, subs for `b' and `l',
 715 #     options). Can `p %var'
 716 #   + Better help (`h <' now works). New commands <<, >>, {, {{.
 717 #     {dump|print}_trace() coded (to be able to do it from <<cmd).
 718 #   + `c sub' documented.
 719 #   + At last enough magic combined to stop after the end of debuggee.
 720 #   + !! should work now (thanks to Emacs bracket matching an extra
 721 #     `]' in a regexp is caught).
 722 #   + `L', `D' and `A' span files now (as documented).
 723 #   + Breakpoints in `require'd code are possible (used in `R').
 724 #   +  Some additional words on internal work of debugger.
 725 #   + `b load filename' implemented.
 726 #   + `b postpone subr' implemented.
 727 #   + now only `q' exits debugger (overwritable on $inhibit_exit).
 728 #   + When restarting debugger breakpoints/actions persist.
 729 #   + Buglet: When restarting debugger only one breakpoint/action per
 730 #             autoloaded function persists.
 731 #
 732 # Changes: 0.97: NonStop will not stop in at_exit().
 733 #   + Option AutoTrace implemented.
 734 #   + Trace printed differently if frames are printed too.
 735 #   + new `inhibitExit' option.
 736 #   + printing of a very long statement interruptible.
 737 # Changes: 0.98: New command `m' for printing possible methods
 738 #   + 'l -' is a synonym for `-'.
 739 #   + Cosmetic bugs in printing stack trace.
 740 #   +  `frame' & 8 to print "expanded args" in stack trace.
 741 #   + Can list/break in imported subs.
 742 #   + new `maxTraceLen' option.
 743 #   + frame & 4 and frame & 8 granted.
 744 #   + new command `m'
 745 #   + nonstoppable lines do not have `:' near the line number.
 746 #   + `b compile subname' implemented.
 747 #   + Will not use $` any more.
 748 #   + `-' behaves sane now.
 749 # Changes: 0.99: Completion for `f', `m'.
 750 #   +  `m' will remove duplicate names instead of duplicate functions.
 751 #   + `b load' strips trailing whitespace.
 752 #     completion ignores leading `|'; takes into account current package
 753 #     when completing a subroutine name (same for `l').
 754 # Changes: 1.07: Many fixed by tchrist 13-March-2000
 755 #   BUG FIXES:
 756 #   + Added bare minimal security checks on perldb rc files, plus
 757 #     comments on what else is needed.
 758 #   + Fixed the ornaments that made "|h" completely unusable.
 759 #     They are not used in print_help if they will hurt.  Strip pod
 760 #     if we're paging to less.
 761 #   + Fixed mis-formatting of help messages caused by ornaments
 762 #     to restore Larry's original formatting.
 763 #   + Fixed many other formatting errors.  The code is still suboptimal,
 764 #     and needs a lot of work at restructuring.  It's also misindented
 765 #     in many places.
 766 #   + Fixed bug where trying to look at an option like your pager
 767 #     shows "1".
 768 #   + Fixed some $? processing.  Note: if you use csh or tcsh, you will
 769 #     lose.  You should consider shell escapes not using their shell,
 770 #     or else not caring about detailed status.  This should really be
 771 #     unified into one place, too.
 772 #   + Fixed bug where invisible trailing whitespace on commands hoses you,
 773 #     tricking Perl into thinking you weren't calling a debugger command!
 774 #   + Fixed bug where leading whitespace on commands hoses you.  (One
 775 #     suggests a leading semicolon or any other irrelevant non-whitespace
 776 #     to indicate literal Perl code.)
 777 #   + Fixed bugs that ate warnings due to wrong selected handle.
 778 #   + Fixed a precedence bug on signal stuff.
 779 #   + Fixed some unseemly wording.
 780 #   + Fixed bug in help command trying to call perl method code.
 781 #   + Fixed to call dumpvar from exception handler.  SIGPIPE killed us.
 782 #   ENHANCEMENTS:
 783 #   + Added some comments.  This code is still nasty spaghetti.
 784 #   + Added message if you clear your pre/post command stacks which was
 785 #     very easy to do if you just typed a bare >, <, or {.  (A command
 786 #     without an argument should *never* be a destructive action; this
 787 #     API is fundamentally screwed up; likewise option setting, which
 788 #     is equally buggered.)
 789 #   + Added command stack dump on argument of "?" for >, <, or {.
 790 #   + Added a semi-built-in doc viewer command that calls man with the
 791 #     proper %Config::Config path (and thus gets caching, man -k, etc),
 792 #     or else perldoc on obstreperous platforms.
 793 #   + Added to and rearranged the help information.
 794 #   + Detected apparent misuse of { ... } to declare a block; this used
 795 #     to work but now is a command, and mysteriously gave no complaint.
 796 #
 797 # Changes: 1.08: Apr 25, 2001  Jon Eveland <jweveland@yahoo.com>
 798 #   BUG FIX:
 799 #   + This patch to perl5db.pl cleans up formatting issues on the help
 800 #     summary (h h) screen in the debugger.  Mostly columnar alignment
 801 #     issues, plus converted the printed text to use all spaces, since
 802 #     tabs don't seem to help much here.
 803 #
 804 # Changes: 1.09: May 19, 2001  Ilya Zakharevich <ilya@math.ohio-state.edu>
 805 #   Minor bugs corrected;
 806 #   + Support for auto-creation of new TTY window on startup, either
 807 #     unconditionally, or if started as a kid of another debugger session;
 808 #   + New `O'ption CreateTTY
 809 #       I<CreateTTY>      bits control attempts to create a new TTY on events:
 810 #                         1: on fork()
 811 #                         2: debugger is started inside debugger
 812 #                         4: on startup
 813 #   + Code to auto-create a new TTY window on OS/2 (currently one
 814 #     extra window per session - need named pipes to have more...);
 815 #   + Simplified interface for custom createTTY functions (with a backward
 816 #     compatibility hack); now returns the TTY name to use; return of ''
 817 #     means that the function reset the I/O handles itself;
 818 #   + Better message on the semantic of custom createTTY function;
 819 #   + Convert the existing code to create a TTY into a custom createTTY
 820 #     function;
 821 #   + Consistent support for TTY names of the form "TTYin,TTYout";
 822 #   + Switch line-tracing output too to the created TTY window;
 823 #   + make `b fork' DWIM with CORE::GLOBAL::fork;
 824 #   + High-level debugger API cmd_*():
 825 #      cmd_b_load($filenamepart)            # b load filenamepart
 826 #      cmd_b_line($lineno [, $cond])        # b lineno [cond]
 827 #      cmd_b_sub($sub [, $cond])            # b sub [cond]
 828 #      cmd_stop()                           # Control-C
 829 #      cmd_d($lineno)                       # d lineno (B)
 830 #      The cmd_*() API returns FALSE on failure; in this case it outputs
 831 #      the error message to the debugging output.
 832 #   + Low-level debugger API
 833 #      break_on_load($filename)             # b load filename
 834 #      @files = report_break_on_load()      # List files with load-breakpoints
 835 #      breakable_line_in_filename($name, $from [, $to])
 836 #                                           # First breakable line in the
 837 #                                           # range $from .. $to.  $to defaults
 838 #                                           # to $from, and may be less than
 839 #                                           # $to
 840 #      breakable_line($from [, $to])        # Same for the current file
 841 #      break_on_filename_line($name, $lineno [, $cond])
 842 #                                           # Set breakpoint,$cond defaults to
 843 #                                           # 1
 844 #      break_on_filename_line_range($name, $from, $to [, $cond])
 845 #                                           # As above, on the first
 846 #                                           # breakable line in range
 847 #      break_on_line($lineno [, $cond])     # As above, in the current file
 848 #      break_subroutine($sub [, $cond])     # break on the first breakable line
 849 #      ($name, $from, $to) = subroutine_filename_lines($sub)
 850 #                                           # The range of lines of the text
 851 #      The low-level API returns TRUE on success, and die()s on failure.
 852 #
 853 # Changes: 1.10: May 23, 2001  Daniel Lewart <d-lewart@uiuc.edu>
 854 #   BUG FIXES:
 855 #   + Fixed warnings generated by "perl -dWe 42"
 856 #   + Corrected spelling errors
 857 #   + Squeezed Help (h) output into 80 columns
 858 #
 859 # Changes: 1.11: May 24, 2001  David Dyck <dcd@tc.fluke.com>
 860 #   + Made "x @INC" work like it used to
 861 #
 862 # Changes: 1.12: May 24, 2001  Daniel Lewart <d-lewart@uiuc.edu>
 863 #   + Fixed warnings generated by "O" (Show debugger options)
 864 #   + Fixed warnings generated by "p 42" (Print expression)
 865 # Changes: 1.13: Jun 19, 2001 Scott.L.Miller@compaq.com
 866 #   + Added windowSize option
 867 # Changes: 1.14: Oct  9, 2001 multiple
 868 #   + Clean up after itself on VMS (Charles Lane in 12385)
 869 #   + Adding "@ file" syntax (Peter Scott in 12014)
 870 #   + Debug reloading selfloaded stuff (Ilya Zakharevich in 11457)
 871 #   + $^S and other debugger fixes (Ilya Zakharevich in 11120)
 872 #   + Forgot a my() declaration (Ilya Zakharevich in 11085)
 873 # Changes: 1.15: Nov  6, 2001 Michael G Schwern <schwern@pobox.com>
 874 #   + Updated 1.14 change log
 875 #   + Added *dbline explainatory comments
 876 #   + Mentioning perldebguts man page
 877 # Changes: 1.16: Feb 15, 2002 Mark-Jason Dominus <mjd@plover.com>
 878 #   + $onetimeDump improvements
 879 # Changes: 1.17: Feb 20, 2002 Richard Foley <richard.foley@rfi.net>
 880 #   Moved some code to cmd_[.]()'s for clarity and ease of handling,
 881 #   rationalised the following commands and added cmd_wrapper() to
 882 #   enable switching between old and frighteningly consistent new
 883 #   behaviours for diehards: 'o CommandSet=pre580' (sigh...)
 884 #     a(add),       A(del)            # action expr   (added del by line)
 885 #   + b(add),       B(del)            # break  [line] (was b,D)
 886 #   + w(add),       W(del)            # watch  expr   (was W,W)
 887 #                                     # added del by expr
 888 #   + h(summary), h h(long)           # help (hh)     (was h h,h)
 889 #   + m(methods),   M(modules)        # ...           (was m,v)
 890 #   + o(option)                       # lc            (was O)
 891 #   + v(view code), V(view Variables) # ...           (was w,V)
 892 # Changes: 1.18: Mar 17, 2002 Richard Foley <richard.foley@rfi.net>
 893 #   + fixed missing cmd_O bug
 894 # Changes: 1.19: Mar 29, 2002 Spider Boardman
 895 #   + Added missing local()s -- DB::DB is called recursively.
 896 # Changes: 1.20: Feb 17, 2003 Richard Foley <richard.foley@rfi.net>
 897 #   + pre'n'post commands no longer trashed with no args
 898 #   + watch val joined out of eval()
 899 # Changes: 1.21: Jun 04, 2003 Joe McMahon <mcmahon@ibiblio.org>
 900 #   + Added comments and reformatted source. No bug fixes/enhancements.
 901 #   + Includes cleanup by Robin Barker and Jarkko Hietaniemi.
 902 # Changes: 1.22  Jun 09, 2003 Alex Vandiver <alexmv@MIT.EDU>
 903 #   + Flush stdout/stderr before the debugger prompt is printed.
 904 # Changes: 1.23: Dec 21, 2003 Dominique Quatravaux
 905 #   + Fix a side-effect of bug #24674 in the perl debugger ("odd taint bug")
 906 # Changes: 1.24: Mar 03, 2004 Richard Foley <richard.foley@rfi.net>
 907 #   + Added command to save all debugger commands for sourcing later.
 908 #   + Added command to display parent inheritence tree of given class.
 909 #   + Fixed minor newline in history bug.
 910 # Changes: 1.25: Apr 17, 2004 Richard Foley <richard.foley@rfi.net>
 911 #   + Fixed option bug (setting invalid options + not recognising valid short forms)
 912 # Changes: 1.26: Apr 22, 2004 Richard Foley <richard.foley@rfi.net>
 913 #   + unfork the 5.8.x and 5.9.x debuggers.
 914 #   + whitespace and assertions call cleanup across versions
 915 #   + H * deletes (resets) history
 916 #   + i now handles Class + blessed objects
 917 ####################################################################
 918
 919 =head1 DEBUGGER INITIALIZATION
 920
 921 The debugger starts up in phases.
 922
 923 =head2 BASIC SETUP
 924
 925 First, it initializes the environment it wants to run in: turning off
 926 warnings during its own compilation, defining variables which it will need
 927 to avoid warnings later, setting itself up to not exit when the program
 928 terminates, and defaulting to printing return values for the C<r> command.
 929
 930 =cut
 931
 932 # Needed for the statement after exec():
 933 #
 934 # This BEGIN block is simply used to switch off warnings during debugger
 935 # compiliation. Probably it would be better practice to fix the warnings,
 936 # but this is how it's done at the moment.
 937
 938 BEGIN {
 939     $ini_warn = $^W;
 940     $^W       = 0;
 941 }    # Switch compilation warnings off until another BEGIN.
 942
 943 # test if assertions are supported and actived:
 944 BEGIN {
 945     $ini_assertion = eval "sub asserting_test : assertion {1}; 1";
 946
 947     # $ini_assertion = undef => assertions unsupported,
 948     #        "       = 1     => assertions supported
 949     # print "\$ini_assertion=$ini_assertion\n";
 950 }
 951
 952 local ($^W) = 0;    # Switch run-time warnings off during init.
 953
 954 # This would probably be better done with "use vars", but that wasn't around
 955 # when this code was originally written. (Neither was "use strict".) And on
 956 # the principle of not fiddling with something that was working, this was
 957 # left alone.
 958 warn(               # Do not ;-)
 959                     # These variables control the execution of 'dumpvar.pl'.
 960     $dumpvar::hashDepth,
 961     $dumpvar::arrayDepth,
 962     $dumpvar::dumpDBFiles,
 963     $dumpvar::dumpPackages,
 964     $dumpvar::quoteHighBit,
 965     $dumpvar::printUndef,
 966     $dumpvar::globPrint,
 967     $dumpvar::usageOnly,
 968
 969     # used to save @ARGV and extract any debugger-related flags.
 970     @ARGS,
 971
 972     # used to control die() reporting in diesignal()
 973     $Carp::CarpLevel,
 974
 975     # used to prevent multiple entries to diesignal()
 976     # (if for instance diesignal() itself dies)
 977     $panic,
 978
 979     # used to prevent the debugger from running nonstop
 980     # after a restart
 981     $second_time,
 982   )
 983   if 0;
 984
 985 # Command-line + PERLLIB:
 986 # Save the contents of @INC before they are modified elsewhere.
 987 @ini_INC = @INC;
 988
 989 # This was an attempt to clear out the previous values of various
 990 # trapped errors. Apparently it didn't help. XXX More info needed!
 991 # $prevwarn = $prevdie = $prevbus = $prevsegv = ''; # Does not help?!
 992
 993 # We set these variables to safe values. We don't want to blindly turn
 994 # off warnings, because other packages may still want them.
 995 $trace = $signal = $single = 0;    # Uninitialized warning suppression
 996                                    # (local $^W cannot help - other packages!).
 997
 998 # Default to not exiting when program finishes; print the return
 999 # value when the 'r' command is used to return from a subroutine.
1000 $inhibit_exit = $option{PrintRet} = 1;
1001
1002 =head1 OPTION PROCESSING
1003
1004 The debugger's options are actually spread out over the debugger itself and
1005 C<dumpvar.pl>; some of these are variables to be set, while others are
1006 subs to be called with a value. To try to make this a little easier to
1007 manage, the debugger uses a few data structures to define what options
1008 are legal and how they are to be processed.
1009
1010 First, the C<@options> array defines the I<names> of all the options that
1011 are to be accepted.
1012
1013 =cut
1014
1015 @options = qw(
1016   CommandSet
1017   hashDepth    arrayDepth    dumpDepth
1018   DumpDBFiles  DumpPackages  DumpReused
1019   compactDump  veryCompact   quote
1020   HighBit      undefPrint    globPrint
1021   PrintRet     UsageOnly     frame
1022   AutoTrace    TTY           noTTY
1023   ReadLine     NonStop       LineInfo
1024   maxTraceLen  recallCommand ShellBang
1025   pager        tkRunning     ornaments
1026   signalLevel  warnLevel     dieLevel
1027   inhibit_exit ImmediateStop bareStringify
1028   CreateTTY    RemotePort    windowSize
1029   DollarCaretP OnlyAssertions WarnAssertions
1030 );
1031
1032 @RememberOnROptions = qw(DollarCaretP OnlyAssertions);
1033
1034 =pod
1035
1036 Second, C<optionVars> lists the variables that each option uses to save its
1037 state.
1038
1039 =cut
1040
1041 %optionVars = (
1042     hashDepth     => \$dumpvar::hashDepth,
1043     arrayDepth    => \$dumpvar::arrayDepth,
1044     CommandSet    => \$CommandSet,
1045     DumpDBFiles   => \$dumpvar::dumpDBFiles,
1046     DumpPackages  => \$dumpvar::dumpPackages,
1047     DumpReused    => \$dumpvar::dumpReused,
1048     HighBit       => \$dumpvar::quoteHighBit,
1049     undefPrint    => \$dumpvar::printUndef,
1050     globPrint     => \$dumpvar::globPrint,
1051     UsageOnly     => \$dumpvar::usageOnly,
1052     CreateTTY     => \$CreateTTY,
1053     bareStringify => \$dumpvar::bareStringify,
1054     frame         => \$frame,
1055     AutoTrace     => \$trace,
1056     inhibit_exit  => \$inhibit_exit,
1057     maxTraceLen   => \$maxtrace,
1058     ImmediateStop => \$ImmediateStop,
1059     RemotePort    => \$remoteport,
1060     windowSize    => \$window,
1061     WarnAssertions => \$warnassertions,
1062 );
1063
1064 =pod
1065
1066 Third, C<%optionAction> defines the subroutine to be called to process each
1067 option.
1068
1069 =cut
1070
1071 %optionAction = (
1072     compactDump   => \&dumpvar::compactDump,
1073     veryCompact   => \&dumpvar::veryCompact,
1074     quote         => \&dumpvar::quote,
1075     TTY           => \&TTY,
1076     noTTY         => \&noTTY,
1077     ReadLine      => \&ReadLine,
1078     NonStop       => \&NonStop,
1079     LineInfo      => \&LineInfo,
1080     recallCommand => \&recallCommand,
1081     ShellBang     => \&shellBang,
1082     pager         => \&pager,
1083     signalLevel   => \&signalLevel,
1084     warnLevel     => \&warnLevel,
1085     dieLevel      => \&dieLevel,
1086     tkRunning     => \&tkRunning,
1087     ornaments     => \&ornaments,
1088     RemotePort    => \&RemotePort,
1089     DollarCaretP  => \&DollarCaretP,
1090     OnlyAssertions=> \&OnlyAssertions,
1091 );
1092
1093 =pod
1094
1095 Last, the C<%optionRequire> notes modules that must be C<require>d if an
1096 option is used.
1097
1098 =cut
1099
1100 # Note that this list is not complete: several options not listed here
1101 # actually require that dumpvar.pl be loaded for them to work, but are
1102 # not in the table. A subsequent patch will correct this problem; for
1103 # the moment, we're just recommenting, and we are NOT going to change
1104 # function.
1105 %optionRequire = (
1106     compactDump => 'dumpvar.pl',
1107     veryCompact => 'dumpvar.pl',
1108     quote       => 'dumpvar.pl',
1109 );
1110
1111 =pod
1112
1113 There are a number of initialization-related variables which can be set
1114 by putting code to set them in a BEGIN block in the C<PERL5DB> environment
1115 variable. These are:
1116
1117 =over 4
1118
1119 =item C<$rl> - readline control XXX needs more explanation
1120
1121 =item C<$warnLevel> - whether or not debugger takes over warning handling
1122
1123 =item C<$dieLevel> - whether or not debugger takes over die handling
1124
1125 =item C<$signalLevel> - whether or not debugger takes over signal handling
1126
1127 =item C<$pre> - preprompt actions (array reference)
1128
1129 =item C<$post> - postprompt actions (array reference)
1130
1131 =item C<$pretype>
1132
1133 =item C<$CreateTTY> - whether or not to create a new TTY for this debugger
1134
1135 =item C<$CommandSet> - which command set to use (defaults to new, documented set)
1136
1137 =back
1138
1139 =cut
1140
1141 # These guys may be defined in $ENV{PERL5DB} :
1142 $rl          = 1     unless defined $rl;
1143 $warnLevel   = 1     unless defined $warnLevel;
1144 $dieLevel    = 1     unless defined $dieLevel;
1145 $signalLevel = 1     unless defined $signalLevel;
1146 $pre         = []    unless defined $pre;
1147 $post        = []    unless defined $post;
1148 $pretype     = []    unless defined $pretype;
1149 $CreateTTY   = 3     unless defined $CreateTTY;
1150 $CommandSet  = '580' unless defined $CommandSet;
1151
1152 =pod
1153
1154 The default C<die>, C<warn>, and C<signal> handlers are set up.
1155
1156 =cut
1157
1158 warnLevel($warnLevel);
1159 dieLevel($dieLevel);
1160 signalLevel($signalLevel);
1161
1162 =pod
1163
1164 The pager to be used is needed next. We try to get it from the
1165 environment first.  if it's not defined there, we try to find it in
1166 the Perl C<Config.pm>.  If it's not there, we default to C<more>. We
1167 then call the C<pager()> function to save the pager name.
1168
1169 =cut
1170
1171 # This routine makes sure $pager is set up so that '|' can use it.
1172 pager(
1173
1174     # If PAGER is defined in the environment, use it.
1175     defined $ENV{PAGER}
1176     ? $ENV{PAGER}
1177
1178       # If not, see if Config.pm defines it.
1179     : eval { require Config }
1180       && defined $Config::Config{pager}
1181     ? $Config::Config{pager}
1182
1183       # If not, fall back to 'more'.
1184     : 'more'
1185   )
1186   unless defined $pager;
1187
1188 =pod
1189
1190 We set up the command to be used to access the man pages, the command
1191 recall character ("!" unless otherwise defined) and the shell escape
1192 character ("!" unless otherwise defined). Yes, these do conflict, and
1193 neither works in the debugger at the moment.
1194
1195 =cut
1196
1197 setman();
1198
1199 # Set up defaults for command recall and shell escape (note:
1200 # these currently don't work in linemode debugging).
1201 &recallCommand("!") unless defined $prc;
1202 &shellBang("!")     unless defined $psh;
1203
1204 =pod
1205
1206 We then set up the gigantic string containing the debugger help.
1207 We also set the limit on the number of arguments we'll display during a
1208 trace.
1209
1210 =cut
1211
1212 sethelp();
1213
1214 # If we didn't get a default for the length of eval/stack trace args,
1215 # set it here.
1216 $maxtrace = 400 unless defined $maxtrace;
1217
1218 =head2 SETTING UP THE DEBUGGER GREETING
1219
1220 The debugger 'greeting'  helps to inform the user how many debuggers are
1221 running, and whether the current debugger is the primary or a child.
1222
1223 If we are the primary, we just hang onto our pid so we'll have it when
1224 or if we start a child debugger. If we are a child, we'll set things up
1225 so we'll have a unique greeting and so the parent will give us our own
1226 TTY later.
1227
1228 We save the current contents of the C<PERLDB_PIDS> environment variable
1229 because we mess around with it. We'll also need to hang onto it because
1230 we'll need it if we restart.
1231
1232 Child debuggers make a label out of the current PID structure recorded in
1233 PERLDB_PIDS plus the new PID. They also mark themselves as not having a TTY
1234 yet so the parent will give them one later via C<resetterm()>.
1235
1236 =cut
1237
1238 # Save the current contents of the environment; we're about to
1239 # much with it. We'll need this if we have to restart.
1240 $ini_pids = $ENV{PERLDB_PIDS};
1241
1242 if ( defined $ENV{PERLDB_PIDS} ) {
1243
1244     # We're a child. Make us a label out of the current PID structure
1245     # recorded in PERLDB_PIDS plus our (new) PID. Mark us as not having
1246     # a term yet so the parent will give us one later via resetterm().
1247     $pids = "[$ENV{PERLDB_PIDS}]";
1248     $ENV{PERLDB_PIDS} .= "->$$";
1249     $term_pid = -1;
1250 } ## end if (defined $ENV{PERLDB_PIDS...
1251 else {
1252
1253     # We're the parent PID. Initialize PERLDB_PID in case we end up with a
1254     # child debugger, and mark us as the parent, so we'll know to set up
1255     # more TTY's is we have to.
1256     $ENV{PERLDB_PIDS} = "$$";
1257     $pids             = "{pid=$$}";
1258     $term_pid         = $$;
1259 }
1260
1261 $pidprompt = '';
1262
1263 # Sets up $emacs as a synonym for $slave_editor.
1264 *emacs = $slave_editor if $slave_editor;    # May be used in afterinit()...
1265
1266 =head2 READING THE RC FILE
1267
1268 The debugger will read a file of initialization options if supplied. If
1269 running interactively, this is C<.perldb>; if not, it's C<perldb.ini>.
1270
1271 =cut
1272
1273 # As noted, this test really doesn't check accurately that the debugger
1274 # is running at a terminal or not.
1275
1276 if ( -e "/dev/tty" ) {                      # this is the wrong metric!
1277     $rcfile = ".perldb";
1278 }
1279 else {
1280     $rcfile = "perldb.ini";
1281 }
1282
1283 =pod
1284
1285 The debugger does a safety test of the file to be read. It must be owned
1286 either by the current user or root, and must only be writable by the owner.
1287
1288 =cut
1289
1290 # This wraps a safety test around "do" to read and evaluate the init file.
1291 #
1292 # This isn't really safe, because there's a race
1293 # between checking and opening.  The solution is to
1294 # open and fstat the handle, but then you have to read and
1295 # eval the contents.  But then the silly thing gets
1296 # your lexical scope, which is unfortunate at best.
1297 sub safe_do {
1298     my $file = shift;
1299
1300     # Just exactly what part of the word "CORE::" don't you understand?
1301     local $SIG{__WARN__};
1302     local $SIG{__DIE__};
1303
1304     unless ( is_safe_file($file) ) {
1305         CORE::warn <<EO_GRIPE;
1306 perldb: Must not source insecure rcfile $file.
1307         You or the superuser must be the owner, and it must not
1308         be writable by anyone but its owner.
1309 EO_GRIPE
1310         return;
1311     } ## end unless (is_safe_file($file...
1312
1313     do $file;
1314     CORE::warn("perldb: couldn't parse $file: $@") if $@;
1315 } ## end sub safe_do
1316
1317 # This is the safety test itself.
1318 #
1319 # Verifies that owner is either real user or superuser and that no
1320 # one but owner may write to it.  This function is of limited use
1321 # when called on a path instead of upon a handle, because there are
1322 # no guarantees that filename (by dirent) whose file (by ino) is
1323 # eventually accessed is the same as the one tested.
1324 # Assumes that the file's existence is not in doubt.
1325 sub is_safe_file {
1326     my $path = shift;
1327     stat($path) || return;    # mysteriously vaporized
1328     my ( $dev, $ino, $mode, $nlink, $uid, $gid ) = stat(_);
1329
1330     return 0 if $uid != 0 && $uid != $<;
1331     return 0 if $mode & 022;
1332     return 1;
1333 } ## end sub is_safe_file
1334
1335 # If the rcfile (whichever one we decided was the right one to read)
1336 # exists, we safely do it.
1337 if ( -f $rcfile ) {
1338     safe_do("./$rcfile");
1339 }
1340
1341 # If there isn't one here, try the user's home directory.
1342 elsif ( defined $ENV{HOME} && -f "$ENV{HOME}/$rcfile" ) {
1343     safe_do("$ENV{HOME}/$rcfile");
1344 }
1345
1346 # Else try the login directory.
1347 elsif ( defined $ENV{LOGDIR} && -f "$ENV{LOGDIR}/$rcfile" ) {
1348     safe_do("$ENV{LOGDIR}/$rcfile");
1349 }
1350
1351 # If the PERLDB_OPTS variable has options in it, parse those out next.
1352 if ( defined $ENV{PERLDB_OPTS} ) {
1353     parse_options( $ENV{PERLDB_OPTS} );
1354 }
1355
1356 =pod
1357
1358 The last thing we do during initialization is determine which subroutine is
1359 to be used to obtain a new terminal when a new debugger is started. Right now,
1360 the debugger only handles X Windows and OS/2.
1361
1362 =cut
1363
1364 # Set up the get_fork_TTY subroutine to be aliased to the proper routine.
1365 # Works if you're running an xterm or xterm-like window, or you're on
1366 # OS/2. This may need some expansion: for instance, this doesn't handle
1367 # OS X Terminal windows.
1368
1369 if (
1370     not defined &get_fork_TTY    # no routine exists,
1371     and defined $ENV{TERM}       # and we know what kind
1372                                  # of terminal this is,
1373     and $ENV{TERM} eq 'xterm'    # and it's an xterm,
1374     and defined $ENV{WINDOWID}   # and we know what
1375                                  # window this is,
1376     and defined $ENV{DISPLAY}
1377   )                              # and what display it's on,
1378 {
1379     *get_fork_TTY = \&xterm_get_fork_TTY;    # use the xterm version
1380 } ## end if (not defined &get_fork_TTY...
1381 elsif ( $^O eq 'os2' ) {                     # If this is OS/2,
1382     *get_fork_TTY = \&os2_get_fork_TTY;      # use the OS/2 version
1383 }
1384
1385 # untaint $^O, which may have been tainted by the last statement.
1386 # see bug [perl #24674]
1387 $^O =~ m/^(.*)\z/;
1388 $^O = $1;
1389
1390 # Here begin the unreadable code.  It needs fixing.
1391
1392 =head2 RESTART PROCESSING
1393
1394 This section handles the restart command. When the C<R> command is invoked, it
1395 tries to capture all of the state it can into environment variables, and
1396 then sets C<PERLDB_RESTART>. When we start executing again, we check to see
1397 if C<PERLDB_RESTART> is there; if so, we reload all the information that
1398 the R command stuffed into the environment variables.
1399
1400   PERLDB_RESTART   - flag only, contains no restart data itself.
1401   PERLDB_HIST      - command history, if it's available
1402   PERLDB_ON_LOAD   - breakpoints set by the rc file
1403   PERLDB_POSTPONE  - subs that have been loaded/not executed, and have actions
1404   PERLDB_VISITED   - files that had breakpoints
1405   PERLDB_FILE_...  - breakpoints for a file
1406   PERLDB_OPT       - active options
1407   PERLDB_INC       - the original @INC
1408   PERLDB_PRETYPE   - preprompt debugger actions
1409   PERLDB_PRE       - preprompt Perl code
1410   PERLDB_POST      - post-prompt Perl code
1411   PERLDB_TYPEAHEAD - typeahead captured by readline()
1412
1413 We chug through all these variables and plug the values saved in them
1414 back into the appropriate spots in the debugger.
1415
1416 =cut
1417
1418 if ( exists $ENV{PERLDB_RESTART} ) {
1419
1420     # We're restarting, so we don't need the flag that says to restart anymore.
1421     delete $ENV{PERLDB_RESTART};
1422
1423     # $restart = 1;
1424     @hist          = get_list('PERLDB_HIST');
1425     %break_on_load = get_list("PERLDB_ON_LOAD");
1426     %postponed     = get_list("PERLDB_POSTPONE");
1427
1428     # restore breakpoints/actions
1429     my @had_breakpoints = get_list("PERLDB_VISITED");
1430     for ( 0 .. $#had_breakpoints ) {
1431         my %pf = get_list("PERLDB_FILE_$_");
1432         $postponed_file{ $had_breakpoints[$_] } = \%pf if %pf;
1433     }
1434
1435     # restore options
1436     my %opt = get_list("PERLDB_OPT");
1437     my ( $opt, $val );
1438     while ( ( $opt, $val ) = each %opt ) {
1439         $val =~ s/[\\\']/\\$1/g;
1440         parse_options("$opt'$val'");
1441     }
1442
1443     # restore original @INC
1444     @INC     = get_list("PERLDB_INC");
1445     @ini_INC = @INC;
1446
1447     # return pre/postprompt actions and typeahead buffer
1448     $pretype   = [ get_list("PERLDB_PRETYPE") ];
1449     $pre       = [ get_list("PERLDB_PRE") ];
1450     $post      = [ get_list("PERLDB_POST") ];
1451     @typeahead = get_list( "PERLDB_TYPEAHEAD", @typeahead );
1452 } ## end if (exists $ENV{PERLDB_RESTART...
1453
1454 =head2 SETTING UP THE TERMINAL
1455
1456 Now, we'll decide how the debugger is going to interact with the user.
1457 If there's no TTY, we set the debugger to run non-stop; there's not going
1458 to be anyone there to enter commands.
1459
1460 =cut
1461
1462 if ($notty) {
1463     $runnonstop = 1;
1464 }
1465
1466 =pod
1467
1468 If there is a TTY, we have to determine who it belongs to before we can
1469 proceed. If this is a slave editor or graphical debugger (denoted by
1470 the first command-line switch being '-emacs'), we shift this off and
1471 set C<$rl> to 0 (XXX ostensibly to do straight reads).
1472
1473 =cut
1474
1475 else {
1476
1477     # Is Perl being run from a slave editor or graphical debugger?
1478     # If so, don't use readline, and set $slave_editor = 1.
1479     $slave_editor =
1480       ( ( defined $main::ARGV[0] ) and ( $main::ARGV[0] eq '-emacs' ) );
1481     $rl = 0, shift(@main::ARGV) if $slave_editor;
1482
1483     #require Term::ReadLine;
1484
1485 =pod
1486
1487 We then determine what the console should be on various systems:
1488
1489 =over 4
1490
1491 =item * Cygwin - We use C<stdin> instead of a separate device.
1492
1493 =cut
1494
1495     if ( $^O eq 'cygwin' ) {
1496
1497         # /dev/tty is binary. use stdin for textmode
1498         undef $console;
1499     }
1500
1501 =item * Unix - use C</dev/tty>.
1502
1503 =cut
1504
1505     elsif ( -e "/dev/tty" ) {
1506         $console = "/dev/tty";
1507     }
1508
1509 =item * Windows or MSDOS - use C<con>.
1510
1511 =cut
1512
1513     elsif ( $^O eq 'dos' or -e "con" or $^O eq 'MSWin32' ) {
1514         $console = "con";
1515     }
1516
1517 =item * MacOS - use C<Dev:Console:Perl Debug> if this is the MPW version; C<Dev:
1518 Console> if not. (Note that Mac OS X returns 'darwin', not 'MacOS'. Also note that the debugger doesn't do anything special for 'darwin'. Maybe it should.)
1519
1520 =cut
1521
1522     elsif ( $^O eq 'MacOS' ) {
1523         if ( $MacPerl::Version !~ /MPW/ ) {
1524             $console =
1525               "Dev:Console:Perl Debug";    # Separate window for application
1526         }
1527         else {
1528             $console = "Dev:Console";
1529         }
1530     } ## end elsif ($^O eq 'MacOS')
1531
1532 =item * VMS - use C<sys$command>.
1533
1534 =cut
1535
1536     else {
1537
1538         # everything else is ...
1539         $console = "sys\$command";
1540     }
1541
1542 =pod
1543
1544 =back
1545
1546 Several other systems don't use a specific console. We C<undef $console>
1547 for those (Windows using a slave editor/graphical debugger, NetWare, OS/2
1548 with a slave editor, Epoc).
1549
1550 =cut
1551
1552     if ( ( $^O eq 'MSWin32' ) and ( $slave_editor or defined $ENV{EMACS} ) ) {
1553
1554         # /dev/tty is binary. use stdin for textmode
1555         $console = undef;
1556     }
1557
1558     if ( $^O eq 'NetWare' ) {
1559
1560         # /dev/tty is binary. use stdin for textmode
1561         $console = undef;
1562     }
1563
1564     # In OS/2, we need to use STDIN to get textmode too, even though
1565     # it pretty much looks like Unix otherwise.
1566     if ( defined $ENV{OS2_SHELL} and ( $slave_editor or $ENV{WINDOWID} ) )
1567     {    # In OS/2
1568         $console = undef;
1569     }
1570
1571     # EPOC also falls into the 'got to use STDIN' camp.
1572     if ( $^O eq 'epoc' ) {
1573         $console = undef;
1574     }
1575
1576 =pod
1577
1578 If there is a TTY hanging around from a parent, we use that as the console.
1579
1580 =cut
1581
1582     $console = $tty if defined $tty;
1583
1584 =head2 SOCKET HANDLING
1585
1586 The debugger is capable of opening a socket and carrying out a debugging
1587 session over the socket.
1588
1589 If C<RemotePort> was defined in the options, the debugger assumes that it
1590 should try to start a debugging session on that port. It builds the socket
1591 and then tries to connect the input and output filehandles to it.
1592
1593 =cut
1594
1595     # Handle socket stuff.
1596
1597     if ( defined $remoteport ) {
1598
1599         # If RemotePort was defined in the options, connect input and output
1600         # to the socket.
1601         require IO::Socket;
1602         $OUT = new IO::Socket::INET(
1603             Timeout  => '10',
1604             PeerAddr => $remoteport,
1605             Proto    => 'tcp',
1606         );
1607         if ( !$OUT ) { die "Unable to connect to remote host: $remoteport\n"; }
1608         $IN = $OUT;
1609     } ## end if (defined $remoteport)
1610
1611 =pod
1612
1613 If no C<RemotePort> was defined, and we want to create a TTY on startup,
1614 this is probably a situation where multiple debuggers are running (for example,
1615 a backticked command that starts up another debugger). We create a new IN and
1616 OUT filehandle, and do the necessary mojo to create a new TTY if we know how
1617 and if we can.
1618
1619 =cut
1620
1621     # Non-socket.
1622     else {
1623
1624         # Two debuggers running (probably a system or a backtick that invokes
1625         # the debugger itself under the running one). create a new IN and OUT
1626         # filehandle, and do the necessary mojo to create a new tty if we
1627         # know how, and we can.
1628         create_IN_OUT(4) if $CreateTTY & 4;
1629         if ($console) {
1630
1631             # If we have a console, check to see if there are separate ins and
1632             # outs to open. (They are assumed identiical if not.)
1633
1634             my ( $i, $o ) = split /,/, $console;
1635             $o = $i unless defined $o;
1636
1637             # read/write on in, or just read, or read on STDIN.
1638             open( IN,      "+<$i" )
1639               || open( IN, "<$i" )
1640               || open( IN, "<&STDIN" );
1641
1642             # read/write/create/clobber out, or write/create/clobber out,
1643             # or merge with STDERR, or merge with STDOUT.
1644                  open( OUT, "+>$o" )
1645               || open( OUT, ">$o" )
1646               || open( OUT, ">&STDERR" )
1647               || open( OUT, ">&STDOUT" );    # so we don't dongle stdout
1648
1649         } ## end if ($console)
1650         elsif ( not defined $console ) {
1651
1652             # No console. Open STDIN.
1653             open( IN, "<&STDIN" );
1654
1655             # merge with STDERR, or with STDOUT.
1656             open( OUT,      ">&STDERR" )
1657               || open( OUT, ">&STDOUT" );    # so we don't dongle stdout
1658             $console = 'STDIN/OUT';
1659         } ## end elsif (not defined $console)
1660
1661         # Keep copies of the filehandles so that when the pager runs, it
1662         # can close standard input without clobbering ours.
1663         $IN = \*IN, $OUT = \*OUT if $console or not defined $console;
1664     } ## end elsif (from if(defined $remoteport))
1665
1666     # Unbuffer DB::OUT. We need to see responses right away.
1667     my $previous = select($OUT);
1668     $| = 1;                                  # for DB::OUT
1669     select($previous);
1670
1671     # Line info goes to debugger output unless pointed elsewhere.
1672     # Pointing elsewhere makes it possible for slave editors to
1673     # keep track of file and position. We have both a filehandle
1674     # and a I/O description to keep track of.
1675     $LINEINFO = $OUT     unless defined $LINEINFO;
1676     $lineinfo = $console unless defined $lineinfo;
1677
1678 =pod
1679
1680 To finish initialization, we show the debugger greeting,
1681 and then call the C<afterinit()> subroutine if there is one.
1682
1683 =cut
1684
1685     # Show the debugger greeting.
1686     $header =~ s/.Header: ([^,]+),v(\s+\S+\s+\S+).*$/$1$2/;
1687     unless ($runnonstop) {
1688         local $\ = '';
1689         local $, = '';
1690         if ( $term_pid eq '-1' ) {
1691             print $OUT "\nDaughter DB session started...\n";
1692         }
1693         else {
1694             print $OUT "\nLoading DB routines from $header\n";
1695             print $OUT (
1696                 "Editor support ",
1697                 $slave_editor ? "enabled" : "available", ".\n"
1698             );
1699             print $OUT
1700 "\nEnter h or `h h' for help, or `$doccmd perldebug' for more help.\n\n";
1701         } ## end else [ if ($term_pid eq '-1')
1702     } ## end unless ($runnonstop)
1703 } ## end else [ if ($notty)
1704
1705 # XXX This looks like a bug to me.
1706 # Why copy to @ARGS and then futz with @args?
1707 @ARGS = @ARGV;
1708 for (@args) {
1709     # Make sure backslashes before single quotes are stripped out, and
1710     # keep args unless they are numeric (XXX why?)
1711     # s/\'/\\\'/g;                      # removed while not justified understandably
1712     # s/(.*)/'$1'/ unless /^-?[\d.]+$/; # ditto
1713 }
1714
1715 # If there was an afterinit() sub defined, call it. It will get
1716 # executed in our scope, so it can fiddle with debugger globals.
1717 if ( defined &afterinit ) {    # May be defined in $rcfile
1718     &afterinit();
1719 }
1720
1721 # Inform us about "Stack dump during die enabled ..." in dieLevel().
1722 $I_m_init = 1;
1723
1724 ############################################################ Subroutines
1725
1726 =head1 SUBROUTINES
1727
1728 =head2 DB
1729
1730 This gigantic subroutine is the heart of the debugger. Called before every
1731 statement, its job is to determine if a breakpoint has been reached, and
1732 stop if so; read commands from the user, parse them, and execute
1733 them, and hen send execution off to the next statement.
1734
1735 Note that the order in which the commands are processed is very important;
1736 some commands earlier in the loop will actually alter the C<$cmd> variable
1737 to create other commands to be executed later. This is all highly "optimized"
1738 but can be confusing. Check the comments for each C<$cmd ... && do {}> to
1739 see what's happening in any given command.
1740
1741 =cut
1742
1743 sub DB {
1744
1745     # Check for whether we should be running continuously or not.
1746     # _After_ the perl program is compiled, $single is set to 1:
1747     if ( $single and not $second_time++ ) {
1748
1749         # Options say run non-stop. Run until we get an interrupt.
1750         if ($runnonstop) {    # Disable until signal
1751                 # If there's any call stack in place, turn off single
1752                 # stepping into subs throughout the stack.
1753             for ( $i = 0 ; $i <= $stack_depth ; ) {
1754                 $stack[ $i++ ] &= ~1;
1755             }
1756
1757             # And we are now no longer in single-step mode.
1758             $single = 0;
1759
1760             # If we simply returned at this point, we wouldn't get
1761             # the trace info. Fall on through.
1762             # return;
1763         } ## end if ($runnonstop)
1764
1765         elsif ($ImmediateStop) {
1766
1767             # We are supposed to stop here; XXX probably a break.
1768             $ImmediateStop = 0;    # We've processed it; turn it off
1769             $signal        = 1;    # Simulate an interrupt to force
1770                                    # us into the command loop
1771         }
1772     } ## end if ($single and not $second_time...
1773
1774     # If we're in single-step mode, or an interrupt (real or fake)
1775     # has occurred, turn off non-stop mode.
1776     $runnonstop = 0 if $single or $signal;
1777
1778     # Preserve current values of $@, $!, $^E, $,, $/, $\, $^W.
1779     # The code being debugged may have altered them.
1780     &save;
1781
1782     # Since DB::DB gets called after every line, we can use caller() to
1783     # figure out where we last were executing. Sneaky, eh? This works because
1784     # caller is returning all the extra information when called from the
1785     # debugger.
1786     local ( $package, $filename, $line ) = caller;
1787     local $filename_ini = $filename;
1788
1789     # set up the context for DB::eval, so it can properly execute
1790     # code on behalf of the user. We add the package in so that the
1791     # code is eval'ed in the proper package (not in the debugger!).
1792     local $usercontext =
1793       '($@, $!, $^E, $,, $/, $\, $^W) = @saved;' . "package $package;";
1794
1795     # Create an alias to the active file magical array to simplify
1796     # the code here.
1797     local (*dbline) = $main::{ '_<' . $filename };
1798
1799     # we need to check for pseudofiles on Mac OS (these are files
1800     # not attached to a filename, but instead stored in Dev:Pseudo)
1801     if ( $^O eq 'MacOS' && $#dbline < 0 ) {
1802         $filename_ini = $filename = 'Dev:Pseudo';
1803         *dbline = $main::{ '_<' . $filename };
1804     }
1805
1806     # Last line in the program.
1807     local $max = $#dbline;
1808
1809     # if we have something here, see if we should break.
1810     if ( $dbline{$line}
1811         && ( ( $stop, $action ) = split( /\0/, $dbline{$line} ) ) )
1812     {
1813
1814         # Stop if the stop criterion says to just stop.
1815         if ( $stop eq '1' ) {
1816             $signal |= 1;
1817         }
1818
1819         # It's a conditional stop; eval it in the user's context and
1820         # see if we should stop. If so, remove the one-time sigil.
1821         elsif ($stop) {
1822             $evalarg = "\$DB::signal |= 1 if do {$stop}";
1823             &eval;
1824             $dbline{$line} =~ s/;9($|\0)/$1/;
1825         }
1826     } ## end if ($dbline{$line} && ...
1827
1828     # Preserve the current stop-or-not, and see if any of the W
1829     # (watch expressions) has changed.
1830     my $was_signal = $signal;
1831
1832     # If we have any watch expressions ...
1833     if ( $trace & 2 ) {
1834         for ( my $n = 0 ; $n <= $#to_watch ; $n++ ) {
1835             $evalarg = $to_watch[$n];
1836             local $onetimeDump;    # Tell DB::eval() to not output results
1837
1838             # Fix context DB::eval() wants to return an array, but
1839             # we need a scalar here.
1840             my ($val) = join( "', '", &eval );
1841             $val = ( ( defined $val ) ? "'$val'" : 'undef' );
1842
1843             # Did it change?
1844             if ( $val ne $old_watch[$n] ) {
1845
1846                 # Yep! Show the difference, and fake an interrupt.
1847                 $signal = 1;
1848                 print $OUT <<EOP;
1849 Watchpoint $n:\t$to_watch[$n] changed:
1850     old value:\t$old_watch[$n]
1851     new value:\t$val
1852 EOP
1853                 $old_watch[$n] = $val;
1854             } ## end if ($val ne $old_watch...
1855         } ## end for (my $n = 0 ; $n <= ...
1856     } ## end if ($trace & 2)
1857
1858 =head2 C<watchfunction()>
1859
1860 C<watchfunction()> is a function that can be defined by the user; it is a
1861 function which will be run on each entry to C<DB::DB>; it gets the
1862 current package, filename, and line as its parameters.
1863
1864 The watchfunction can do anything it likes; it is executing in the
1865 debugger's context, so it has access to all of the debugger's internal
1866 data structures and functions.
1867
1868 C<watchfunction()> can control the debugger's actions. Any of the following
1869 will cause the debugger to return control to the user's program after
1870 C<watchfunction()> executes:
1871
1872 =over 4
1873
1874 =item * Returning a false value from the C<watchfunction()> itself.
1875
1876 =item * Altering C<$single> to a false value.
1877
1878 =item * Altering C<$signal> to a false value.
1879
1880 =item *  Turning off the '4' bit in C<$trace> (this also disables the
1881 check for C<watchfunction()>. This can be done with
1882
1883     $trace &= ~4;
1884
1885 =back
1886
1887 =cut
1888
1889     # If there's a user-defined DB::watchfunction, call it with the
1890     # current package, filename, and line. The function executes in
1891     # the DB:: package.
1892     if ( $trace & 4 ) {    # User-installed watch
1893         return
1894           if watchfunction( $package, $filename, $line )
1895           and not $single
1896           and not $was_signal
1897           and not( $trace & ~4 );
1898     } ## end if ($trace & 4)
1899
1900     # Pick up any alteration to $signal in the watchfunction, and
1901     # turn off the signal now.
1902     $was_signal = $signal;
1903     $signal     = 0;
1904
1905 =head2 GETTING READY TO EXECUTE COMMANDS
1906
1907 The debugger decides to take control if single-step mode is on, the
1908 C<t> command was entered, or the user generated a signal. If the program
1909 has fallen off the end, we set things up so that entering further commands
1910 won't cause trouble, and we say that the program is over.
1911
1912 =cut
1913
1914     # Check to see if we should grab control ($single true,
1915     # trace set appropriately, or we got a signal).
1916     if ( $single || ( $trace & 1 ) || $was_signal ) {
1917
1918         # Yes, grab control.
1919         if ($slave_editor) {
1920
1921             # Tell the editor to update its position.
1922             $position = "\032\032$filename:$line:0\n";
1923             print_lineinfo($position);
1924         }
1925
1926 =pod
1927
1928 Special check: if we're in package C<DB::fake>, we've gone through the
1929 C<END> block at least once. We set up everything so that we can continue
1930 to enter commands and have a valid context to be in.
1931
1932 =cut
1933
1934         elsif ( $package eq 'DB::fake' ) {
1935
1936             # Fallen off the end already.
1937             $term || &setterm;
1938             print_help(<<EOP);
1939 Debugged program terminated.  Use B<q> to quit or B<R> to restart,
1940   use B<O> I<inhibit_exit> to avoid stopping after program termination,
1941   B<h q>, B<h R> or B<h O> to get additional info.
1942 EOP
1943
1944             # Set the DB::eval context appropriately.
1945             $package     = 'main';
1946             $usercontext =
1947                 '($@, $!, $^E, $,, $/, $\, $^W) = @saved;'
1948               . "package $package;";    # this won't let them modify, alas
1949         } ## end elsif ($package eq 'DB::fake')
1950
1951 =pod
1952
1953 If the program hasn't finished executing, we scan forward to the
1954 next executable line, print that out, build the prompt from the file and line
1955 number information, and print that.
1956
1957 =cut
1958
1959         else {
1960
1961             # Still somewhere in the midst of execution. Set up the
1962             #  debugger prompt.
1963             $sub =~ s/\'/::/;    # Swap Perl 4 package separators (') to
1964                                  # Perl 5 ones (sorry, we don't print Klingon
1965                                  #module names)
1966
1967             $prefix = $sub =~ /::/ ? "" : "${'package'}::";
1968             $prefix .= "$sub($filename:";
1969             $after = ( $dbline[$line] =~ /\n$/ ? '' : "\n" );
1970
1971             # Break up the prompt if it's really long.
1972             if ( length($prefix) > 30 ) {
1973                 $position = "$prefix$line):\n$line:\t$dbline[$line]$after";
1974                 $prefix   = "";
1975                 $infix    = ":\t";
1976             }
1977             else {
1978                 $infix    = "):\t";
1979                 $position = "$prefix$line$infix$dbline[$line]$after";
1980             }
1981
1982             # Print current line info, indenting if necessary.
1983             if ($frame) {
1984                 print_lineinfo( ' ' x $stack_depth,
1985                     "$line:\t$dbline[$line]$after" );
1986             }
1987             else {
1988                 print_lineinfo($position);
1989             }
1990
1991             # Scan forward, stopping at either the end or the next
1992             # unbreakable line.
1993             for ( $i = $line + 1 ; $i <= $max && $dbline[$i] == 0 ; ++$i )
1994             {    #{ vi
1995
1996                 # Drop out on null statements, block closers, and comments.
1997                 last if $dbline[$i] =~ /^\s*[\;\}\#\n]/;
1998
1999                 # Drop out if the user interrupted us.
2000                 last if $signal;
2001
2002                 # Append a newline if the line doesn't have one. Can happen
2003                 # in eval'ed text, for instance.
2004                 $after = ( $dbline[$i] =~ /\n$/ ? '' : "\n" );
2005
2006                 # Next executable line.
2007                 $incr_pos = "$prefix$i$infix$dbline[$i]$after";
2008                 $position .= $incr_pos;
2009                 if ($frame) {
2010
2011                     # Print it indented if tracing is on.
2012                     print_lineinfo( ' ' x $stack_depth,
2013                         "$i:\t$dbline[$i]$after" );
2014                 }
2015                 else {
2016                     print_lineinfo($incr_pos);
2017                 }
2018             } ## end for ($i = $line + 1 ; $i...
2019         } ## end else [ if ($slave_editor)
2020     } ## end if ($single || ($trace...
2021
2022 =pod
2023
2024 If there's an action to be executed for the line we stopped at, execute it.
2025 If there are any preprompt actions, execute those as well.
2026
2027 =cut
2028
2029     # If there's an action, do it now.
2030     $evalarg = $action, &eval if $action;
2031
2032     # Are we nested another level (e.g., did we evaluate a function
2033     # that had a breakpoint in it at the debugger prompt)?
2034     if ( $single || $was_signal ) {
2035
2036         # Yes, go down a level.
2037         local $level = $level + 1;
2038
2039         # Do any pre-prompt actions.
2040         foreach $evalarg (@$pre) {
2041             &eval;
2042         }
2043
2044         # Complain about too much recursion if we passed the limit.
2045         print $OUT $stack_depth . " levels deep in subroutine calls!\n"
2046           if $single & 4;
2047
2048         # The line we're currently on. Set $incr to -1 to stay here
2049         # until we get a command that tells us to advance.
2050         $start = $line;
2051         $incr  = -1;      # for backward motion.
2052
2053         # Tack preprompt debugger actions ahead of any actual input.
2054         @typeahead = ( @$pretype, @typeahead );
2055
2056 =head2 WHERE ARE WE?
2057
2058 XXX Relocate this section?
2059
2060 The debugger normally shows the line corresponding to the current line of
2061 execution. Sometimes, though, we want to see the next line, or to move elsewhere
2062 in the file. This is done via the C<$incr>, C<$start>, and C<$max> variables.
2063
2064 C<$incr> controls by how many lines the "current" line should move forward
2065 after a command is executed. If set to -1, this indicates that the "current"
2066 line shouldn't change.
2067
2068 C<$start> is the "current" line. It is used for things like knowing where to
2069 move forwards or backwards from when doing an C<L> or C<-> command.
2070
2071 C<$max> tells the debugger where the last line of the current file is. It's
2072 used to terminate loops most often.
2073
2074 =head2 THE COMMAND LOOP
2075
2076 Most of C<DB::DB> is actually a command parsing and dispatch loop. It comes
2077 in two parts:
2078
2079 =over 4
2080
2081 =item * The outer part of the loop, starting at the C<CMD> label. This loop
2082 reads a command and then executes it.
2083
2084 =item * The inner part of the loop, starting at the C<PIPE> label. This part
2085 is wholly contained inside the C<CMD> block and only executes a command.
2086 Used to handle commands running inside a pager.
2087
2088 =back
2089
2090 So why have two labels to restart the loop? Because sometimes, it's easier to
2091 have a command I<generate> another command and then re-execute the loop to do
2092 the new command. This is faster, but perhaps a bit more convoluted.
2093
2094 =cut
2095
2096         # The big command dispatch loop. It keeps running until the
2097         # user yields up control again.
2098         #
2099         # If we have a terminal for input, and we get something back
2100         # from readline(), keep on processing.
2101       CMD:
2102         while (
2103
2104             # We have a terminal, or can get one ...
2105             ( $term || &setterm ),
2106
2107             # ... and it belogs to this PID or we get one for this PID ...
2108             ( $term_pid == $$ or resetterm(1) ),
2109
2110             # ... and we got a line of command input ...
2111             defined(
2112                 $cmd = &readline(
2113                         "$pidprompt  DB"
2114                       . ( '<' x $level )
2115                       . ( $#hist + 1 )
2116                       . ( '>' x $level ) . " "
2117                 )
2118             )
2119           )
2120         {
2121
2122             # ... try to execute the input as debugger commands.
2123
2124             # Don't stop running.
2125             $single = 0;
2126
2127             # No signal is active.
2128             $signal = 0;
2129
2130             # Handle continued commands (ending with \):
2131             $cmd =~ s/\\$/\n/ && do {
2132                 $cmd .= &readline("  cont: ");
2133                 redo CMD;
2134             };
2135
2136 =head4 The null command
2137
2138 A newline entered by itself means "re-execute the last command". We grab the
2139 command out of C<$laststep> (where it was recorded previously), and copy it
2140 back into C<$cmd> to be executed below. If there wasn't any previous command,
2141 we'll do nothing below (no command will match). If there was, we also save it
2142 in the command history and fall through to allow the command parsing to pick
2143 it up.
2144
2145 =cut
2146
2147             # Empty input means repeat the last command.
2148             $cmd =~ /^$/ && ( $cmd = $laststep );
2149             chomp($cmd);    # get rid of the annoying extra newline
2150             push( @hist, $cmd ) if length($cmd) > 1;
2151             push( @truehist, $cmd );
2152
2153             # This is a restart point for commands that didn't arrive
2154             # via direct user input. It allows us to 'redo PIPE' to
2155             # re-execute command processing without reading a new command.
2156           PIPE: {
2157                 $cmd =~ s/^\s+//s;    # trim annoying leading whitespace
2158                 $cmd =~ s/\s+$//s;    # trim annoying trailing whitespace
2159                 ($i) = split( /\s+/, $cmd );
2160
2161 =head3 COMMAND ALIASES
2162
2163 The debugger can create aliases for commands (these are stored in the
2164 C<%alias> hash). Before a command is executed, the command loop looks it up
2165 in the alias hash and substitutes the contents of the alias for the command,
2166 completely replacing it.
2167
2168 =cut
2169
2170                 # See if there's an alias for the command, and set it up if so.
2171                 if ( $alias{$i} ) {
2172
2173                     # Squelch signal handling; we want to keep control here
2174                     # if something goes loco during the alias eval.
2175                     local $SIG{__DIE__};
2176                     local $SIG{__WARN__};
2177
2178                     # This is a command, so we eval it in the DEBUGGER's
2179                     # scope! Otherwise, we can't see the special debugger
2180                     # variables, or get to the debugger's subs. (Well, we
2181                     # _could_, but why make it even more complicated?)
2182                     eval "\$cmd =~ $alias{$i}";
2183                     if ($@) {
2184                         local $\ = '';
2185                         print $OUT "Couldn't evaluate `$i' alias: $@";
2186                         next CMD;
2187                     }
2188                 } ## end if ($alias{$i})
2189
2190 =head3 MAIN-LINE COMMANDS
2191
2192 All of these commands work up to and after the program being debugged has
2193 terminated.
2194
2195 =head4 C<q> - quit
2196
2197 Quit the debugger. This entails setting the C<$fall_off_end> flag, so we don't
2198 try to execute further, cleaning any restart-related stuff out of the
2199 environment, and executing with the last value of C<$?>.
2200
2201 =cut
2202
2203                 $cmd =~ /^q$/ && do {
2204                     $fall_off_end = 1;
2205                     clean_ENV();
2206                     exit $?;
2207                 };
2208
2209 =head4 C<t> - trace
2210
2211 Turn tracing on or off. Inverts the appropriate bit in C<$trace> (q.v.).
2212
2213 =cut
2214
2215                 $cmd =~ /^t$/ && do {
2216                     $trace ^= 1;
2217                     local $\ = '';
2218                     print $OUT "Trace = "
2219                       . ( ( $trace & 1 ) ? "on" : "off" ) . "\n";
2220                     next CMD;
2221                 };
2222
2223 =head4 C<S> - list subroutines matching/not matching a pattern
2224
2225 Walks through C<%sub>, checking to see whether or not to print the name.
2226
2227 =cut
2228
2229                 $cmd =~ /^S(\s+(!)?(.+))?$/ && do {
2230
2231                     $Srev     = defined $2;     # Reverse scan?
2232                     $Spatt    = $3;             # The pattern (if any) to use.
2233                     $Snocheck = !defined $1;    # No args - print all subs.
2234
2235                     # Need to make these sane here.
2236                     local $\ = '';
2237                     local $, = '';
2238
2239                     # Search through the debugger's magical hash of subs.
2240                     # If $nocheck is true, just print the sub name.
2241                     # Otherwise, check it against the pattern. We then use
2242                     # the XOR trick to reverse the condition as required.
2243                     foreach $subname ( sort( keys %sub ) ) {
2244                         if ( $Snocheck or $Srev ^ ( $subname =~ /$Spatt/ ) ) {
2245                             print $OUT $subname, "\n";
2246                         }
2247                     }
2248                     next CMD;
2249                 };
2250
2251 =head4 C<X> - list variables in current package
2252
2253 Since the C<V> command actually processes this, just change this to the
2254 appropriate C<V> command and fall through.
2255
2256 =cut
2257
2258                 $cmd =~ s/^X\b/V $package/;
2259
2260 =head4 C<V> - list variables
2261
2262 Uses C<dumpvar.pl> to dump out the current values for selected variables.
2263
2264 =cut
2265
2266                 # Bare V commands get the currently-being-debugged package
2267                 # added.
2268                 $cmd =~ /^V$/ && do {
2269                     $cmd = "V $package";
2270                 };
2271
2272                 # V - show variables in package.
2273                 $cmd =~ /^V\b\s*(\S+)\s*(.*)/ && do {
2274
2275                     # Save the currently selected filehandle and
2276                     # force output to debugger's filehandle (dumpvar
2277                     # just does "print" for output).
2278                     local ($savout) = select($OUT);
2279
2280                     # Grab package name and variables to dump.
2281                     $packname = $1;
2282                     @vars     = split( ' ', $2 );
2283
2284                     # If main::dumpvar isn't here, get it.
2285                     do 'dumpvar.pl' unless defined &main::dumpvar;
2286                     if ( defined &main::dumpvar ) {
2287
2288                         # We got it. Turn off subroutine entry/exit messages
2289                         # for the moment, along with return values.
2290                         local $frame = 0;
2291                         local $doret = -2;
2292
2293                         # must detect sigpipe failures  - not catching
2294                         # then will cause the debugger to die.
2295                         eval {
2296                             &main::dumpvar(
2297                                 $packname,
2298                                 defined $option{dumpDepth}
2299                                 ? $option{dumpDepth}
2300                                 : -1,    # assume -1 unless specified
2301                                 @vars
2302                             );
2303                         };
2304
2305                         # The die doesn't need to include the $@, because
2306                         # it will automatically get propagated for us.
2307                         if ($@) {
2308                             die unless $@ =~ /dumpvar print failed/;
2309                         }
2310                     } ## end if (defined &main::dumpvar)
2311                     else {
2312
2313                         # Couldn't load dumpvar.
2314                         print $OUT "dumpvar.pl not available.\n";
2315                     }
2316
2317                     # Restore the output filehandle, and go round again.
2318                     select($savout);
2319                     next CMD;
2320                 };
2321
2322 =head4 C<x> - evaluate and print an expression
2323
2324 Hands the expression off to C<DB::eval>, setting it up to print the value
2325 via C<dumpvar.pl> instead of just printing it directly.
2326
2327 =cut
2328
2329                 $cmd =~ s/^x\b/ / && do {    # Remainder gets done by DB::eval()
2330                     $onetimeDump = 'dump';    # main::dumpvar shows the output
2331
2332                     # handle special  "x 3 blah" syntax XXX propagate
2333                     # doc back to special variables.
2334                     if ( $cmd =~ s/^\s*(\d+)(?=\s)/ / ) {
2335                         $onetimedumpDepth = $1;
2336                     }
2337                 };
2338
2339 =head4 C<m> - print methods
2340
2341 Just uses C<DB::methods> to determine what methods are available.
2342
2343 =cut
2344
2345                 $cmd =~ s/^m\s+([\w:]+)\s*$/ / && do {
2346                     methods($1);
2347                     next CMD;
2348                 };
2349
2350                 # m expr - set up DB::eval to do the work
2351                 $cmd =~ s/^m\b/ / && do {    # Rest gets done by DB::eval()
2352                     $onetimeDump = 'methods';   #  method output gets used there
2353                 };
2354
2355 =head4 C<f> - switch files
2356
2357 =cut
2358
2359                 $cmd =~ /^f\b\s*(.*)/ && do {
2360                     $file = $1;
2361                     $file =~ s/\s+$//;
2362
2363                     # help for no arguments (old-style was return from sub).
2364                     if ( !$file ) {
2365                         print $OUT
2366                           "The old f command is now the r command.\n";    # hint
2367                         print $OUT "The new f command switches filenames.\n";
2368                         next CMD;
2369                     } ## end if (!$file)
2370
2371                     # if not in magic file list, try a close match.
2372                     if ( !defined $main::{ '_<' . $file } ) {
2373                         if ( ($try) = grep( m#^_<.*$file#, keys %main:: ) ) {
2374                             {
2375                                 $try = substr( $try, 2 );
2376                                 print $OUT "Choosing $try matching `$file':\n";
2377                                 $file = $try;
2378                             }
2379                         } ## end if (($try) = grep(m#^_<.*$file#...
2380                     } ## end if (!defined $main::{ ...
2381
2382                     # If not successfully switched now, we failed.
2383                     if ( !defined $main::{ '_<' . $file } ) {
2384                         print $OUT "No file matching `$file' is loaded.\n";
2385                         next CMD;
2386                     }
2387
2388                     # We switched, so switch the debugger internals around.
2389                     elsif ( $file ne $filename ) {
2390                         *dbline   = $main::{ '_<' . $file };
2391                         $max      = $#dbline;
2392                         $filename = $file;
2393                         $start    = 1;
2394                         $cmd      = "l";
2395                     } ## end elsif ($file ne $filename)
2396
2397                     # We didn't switch; say we didn't.
2398                     else {
2399                         print $OUT "Already in $file.\n";
2400                         next CMD;
2401                     }
2402                 };
2403
2404 =head4 C<.> - return to last-executed line.
2405
2406 We set C<$incr> to -1 to indicate that the debugger shouldn't move ahead,
2407 and then we look up the line in the magical C<%dbline> hash.
2408
2409 =cut
2410
2411                 # . command.
2412                 $cmd =~ /^\.$/ && do {
2413                     $incr = -1;    # stay at current line
2414
2415                     # Reset everything to the old location.
2416                     $start    = $line;
2417                     $filename = $filename_ini;
2418                     *dbline   = $main::{ '_<' . $filename };
2419                     $max      = $#dbline;
2420
2421                     # Now where are we?
2422                     print_lineinfo($position);
2423                     next CMD;
2424                 };
2425
2426 =head4 C<-> - back one window
2427
2428 We change C<$start> to be one window back; if we go back past the first line,
2429 we set it to be the first line. We ser C<$incr> to put us back at the
2430 currently-executing line, and then put a C<l $start +> (list one window from
2431 C<$start>) in C<$cmd> to be executed later.
2432
2433 =cut
2434
2435                 # - - back a window.
2436                 $cmd =~ /^-$/ && do {
2437
2438                     # back up by a window; go to 1 if back too far.
2439                     $start -= $incr + $window + 1;
2440                     $start = 1 if $start <= 0;
2441                     $incr  = $window - 1;
2442
2443                     # Generate and execute a "l +" command (handled below).
2444                     $cmd = 'l ' . ($start) . '+';
2445                 };
2446
2447 =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>, {, {{>
2448
2449 In Perl 5.8.0, a realignment of the commands was done to fix up a number of
2450 problems, most notably that the default case of several commands destroying
2451 the user's work in setting watchpoints, actions, etc. We wanted, however, to
2452 retain the old commands for those who were used to using them or who preferred
2453 them. At this point, we check for the new commands and call C<cmd_wrapper> to
2454 deal with them instead of processing them in-line.
2455
2456 =cut
2457
2458                 # All of these commands were remapped in perl 5.8.0;
2459                 # we send them off to the secondary dispatcher (see below).
2460                 $cmd =~ /^([aAbBhilLMoOPvwW]\b|[<>\{]{1,2})\s*(.*)/so && do {
2461                     &cmd_wrapper( $1, $2, $line );
2462                     next CMD;
2463                 };
2464
2465 =head4 C<y> - List lexicals in higher scope
2466
2467 Uses C<PadWalker> to find the lexicals supplied as arguments in a scope
2468 above the current one and then displays then using C<dumpvar.pl>.
2469
2470 =cut
2471
2472                 $cmd =~ /^y(?:\s+(\d*)\s*(.*))?$/ && do {
2473
2474                     # See if we've got the necessary support.
2475                     eval { require PadWalker; PadWalker->VERSION(0.08) }
2476                       or &warn(
2477                         $@ =~ /locate/
2478                         ? "PadWalker module not found - please install\n"
2479                         : $@
2480                       )
2481                       and next CMD;
2482
2483                     # Load up dumpvar if we don't have it. If we can, that is.
2484                     do 'dumpvar.pl' unless defined &main::dumpvar;
2485                     defined &main::dumpvar
2486                       or print $OUT "dumpvar.pl not available.\n"
2487                       and next CMD;
2488
2489                     # Got all the modules we need. Find them and print them.
2490                     my @vars = split( ' ', $2 || '' );
2491
2492                     # Find the pad.
2493                     my $h = eval { PadWalker::peek_my( ( $1 || 0 ) + 1 ) };
2494
2495                     # Oops. Can't find it.
2496                     $@ and $@ =~ s/ at .*//, &warn($@), next CMD;
2497
2498                     # Show the desired vars with dumplex().
2499                     my $savout = select($OUT);
2500
2501                     # Have dumplex dump the lexicals.
2502                     dumpvar::dumplex( $_, $h->{$_},
2503                         defined $option{dumpDepth} ? $option{dumpDepth} : -1,
2504                         @vars )
2505                       for sort keys %$h;
2506                     select($savout);
2507                     next CMD;
2508                 };
2509
2510 =head3 COMMANDS NOT WORKING AFTER PROGRAM ENDS
2511
2512 All of the commands below this point don't work after the program being
2513 debugged has ended. All of them check to see if the program has ended; this
2514 allows the commands to be relocated without worrying about a 'line of
2515 demarcation' above which commands can be entered anytime, and below which
2516 they can't.
2517
2518 =head4 C<n> - single step, but don't trace down into subs
2519
2520 Done by setting C<$single> to 2, which forces subs to execute straight through
2521 when entered (see X<DB::sub>). We also save the C<n> command in C<$laststep>,
2522 so a null command knows what to re-execute.
2523
2524 =cut
2525
2526                 # n - next
2527                 $cmd =~ /^n$/ && do {
2528                     end_report(), next CMD if $finished and $level <= 1;
2529
2530                     # Single step, but don't enter subs.
2531                     $single = 2;
2532
2533                     # Save for empty command (repeat last).
2534                     $laststep = $cmd;
2535                     last CMD;
2536                 };
2537
2538 =head4 C<s> - single-step, entering subs
2539
2540 Sets C<$single> to 1, which causes X<DB::sub> to continue tracing inside
2541 subs. Also saves C<s> as C<$lastcmd>.
2542
2543 =cut
2544
2545                 # s - single step.
2546                 $cmd =~ /^s$/ && do {
2547
2548                     # Get out and restart the command loop if program
2549                     # has finished.
2550                     end_report(), next CMD if $finished and $level <= 1;
2551
2552                     # Single step should enter subs.
2553                     $single = 1;
2554
2555                     # Save for empty command (repeat last).
2556                     $laststep = $cmd;
2557                     last CMD;
2558                 };
2559
2560 =head4 C<c> - run continuously, setting an optional breakpoint
2561
2562 Most of the code for this command is taken up with locating the optional
2563 breakpoint, which is either a subroutine name or a line number. We set
2564 the appropriate one-time-break in C<@dbline> and then turn off single-stepping
2565 in this and all call levels above this one.
2566
2567 =cut
2568
2569                 # c - start continuous execution.
2570                 $cmd =~ /^c\b\s*([\w:]*)\s*$/ && do {
2571
2572                     # Hey, show's over. The debugged program finished
2573                     # executing already.
2574                     end_report(), next CMD if $finished and $level <= 1;
2575
2576                     # Capture the place to put a one-time break.
2577                     $subname = $i = $1;
2578
2579                     #  Probably not needed, since we finish an interactive
2580                     #  sub-session anyway...
2581                     # local $filename = $filename;
2582                     # local *dbline = *dbline; # XXX Would this work?!
2583                     #
2584                     # The above question wonders if localizing the alias
2585                     # to the magic array works or not. Since it's commented
2586                     # out, we'll just leave that to speculation for now.
2587
2588                     # If the "subname" isn't all digits, we'll assume it
2589                     # is a subroutine name, and try to find it.
2590                     if ( $subname =~ /\D/ ) {    # subroutine name
2591                             # Qualify it to the current package unless it's
2592                             # already qualified.
2593                         $subname = $package . "::" . $subname
2594                           unless $subname =~ /::/;
2595
2596                         # find_sub will return "file:line_number" corresponding
2597                         # to where the subroutine is defined; we call find_sub,
2598                         # break up the return value, and assign it in one
2599                         # operation.
2600                         ( $file, $i ) = ( find_sub($subname) =~ /^(.*):(.*)$/ );
2601
2602                         # Force the line number to be numeric.
2603                         $i += 0;
2604
2605                         # If we got a line number, we found the sub.
2606                         if ($i) {
2607
2608                             # Switch all the debugger's internals around so
2609                             # we're actually working with that file.
2610                             $filename = $file;
2611                             *dbline   = $main::{ '_<' . $filename };
2612
2613                             # Mark that there's a breakpoint in this file.
2614                             $had_breakpoints{$filename} |= 1;
2615
2616                             # Scan forward to the first executable line
2617                             # after the 'sub whatever' line.
2618                             $max = $#dbline;
2619                             ++$i while $dbline[$i] == 0 && $i < $max;
2620                         } ## end if ($i)
2621
2622                         # We didn't find a sub by that name.
2623                         else {
2624                             print $OUT "Subroutine $subname not found.\n";
2625                             next CMD;
2626                         }
2627                     } ## end if ($subname =~ /\D/)
2628
2629                     # At this point, either the subname was all digits (an
2630                     # absolute line-break request) or we've scanned through
2631                     # the code following the definition of the sub, looking
2632                     # for an executable, which we may or may not have found.
2633                     #
2634                     # If $i (which we set $subname from) is non-zero, we
2635                     # got a request to break at some line somewhere. On
2636                     # one hand, if there wasn't any real subroutine name
2637                     # involved, this will be a request to break in the current
2638                     # file at the specified line, so we have to check to make
2639                     # sure that the line specified really is breakable.
2640                     #
2641                     # On the other hand, if there was a subname supplied, the
2642                     # preceeding block has moved us to the proper file and
2643                     # location within that file, and then scanned forward
2644                     # looking for the next executable line. We have to make
2645                     # sure that one was found.
2646                     #
2647                     # On the gripping hand, we can't do anything unless the
2648                     # current value of $i points to a valid breakable line.
2649                     # Check that.
2650                     if ($i) {
2651
2652                         # Breakable?
2653                         if ( $dbline[$i] == 0 ) {
2654                             print $OUT "Line $i not breakable.\n";
2655                             next CMD;
2656                         }
2657
2658                         # Yes. Set up the one-time-break sigil.
2659                         $dbline{$i} =~ s/($|\0)/;9$1/;  # add one-time-only b.p.
2660                     } ## end if ($i)
2661
2662                     # Turn off stack tracing from here up.
2663                     for ( $i = 0 ; $i <= $stack_depth ; ) {
2664                         $stack[ $i++ ] &= ~1;
2665                     }
2666                     last CMD;
2667                 };
2668
2669 =head4 C<r> - return from a subroutine
2670
2671 For C<r> to work properly, the debugger has to stop execution again
2672 immediately after the return is executed. This is done by forcing
2673 single-stepping to be on in the call level above the current one. If
2674 we are printing return values when a C<r> is executed, set C<$doret>
2675 appropriately, and force us out of the command loop.
2676
2677 =cut
2678
2679                 # r - return from the current subroutine.
2680                 $cmd =~ /^r$/ && do {
2681
2682                     # Can't do anythign if the program's over.
2683                     end_report(), next CMD if $finished and $level <= 1;
2684
2685                     # Turn on stack trace.
2686                     $stack[$stack_depth] |= 1;
2687
2688                     # Print return value unless the stack is empty.
2689                     $doret = $option{PrintRet} ? $stack_depth - 1 : -2;
2690                     last CMD;
2691                 };
2692
2693 =head4 C<R> - restart
2694
2695 Restarting the debugger is a complex operation that occurs in several phases.
2696 First, we try to reconstruct the command line that was used to invoke Perl
2697 and the debugger.
2698
2699 =cut
2700
2701                 # R - restart execution.
2702                 $cmd =~ /^R$/ && do {
2703
2704                     # I may not be able to resurrect you, but here goes ...
2705                     print $OUT
2706 "Warning: some settings and command-line options may be lost!\n";
2707                     my ( @script, @flags, $cl );
2708
2709                     # If warn was on before, turn it on again.
2710                     push @flags, '-w' if $ini_warn;
2711                     if ( $ini_assertion and @{^ASSERTING} ) {
2712                         push @flags,
2713                           ( map { /\:\^\(\?\:(.*)\)\$\)/ ? "-A$1" : "-A$_" }
2714                               @{^ASSERTING} );
2715                     }
2716
2717                     # Rebuild the -I flags that were on the initial
2718                     # command line.
2719                     for (@ini_INC) {
2720                         push @flags, '-I', $_;
2721                     }
2722
2723                     # Turn on taint if it was on before.
2724                     push @flags, '-T' if ${^TAINT};
2725
2726                     # Arrange for setting the old INC:
2727                     # Save the current @init_INC in the environment.
2728                     set_list( "PERLDB_INC", @ini_INC );
2729
2730                     # If this was a perl one-liner, go to the "file"
2731                     # corresponding to the one-liner read all the lines
2732                     # out of it (except for the first one, which is going
2733                     # to be added back on again when 'perl -d' runs: that's
2734                     # the 'require perl5db.pl;' line), and add them back on
2735                     # to the command line to be executed.
2736                     if ( $0 eq '-e' ) {
2737                         for ( 1 .. $#{'::_<-e'} ) {  # The first line is PERL5DB
2738                             chomp( $cl = ${'::_<-e'}[$_] );
2739                             push @script, '-e', $cl;
2740                         }
2741                     } ## end if ($0 eq '-e')
2742
2743                     # Otherwise we just reuse the original name we had
2744                     # before.
2745                     else {
2746                         @script = $0;
2747                     }
2748
2749 =pod
2750
2751 After the command line  has been reconstructed, the next step is to save
2752 the debugger's status in environment variables. The C<DB::set_list> routine
2753 is used to save aggregate variables (both hashes and arrays); scalars are
2754 just popped into environment variables directly.
2755
2756 =cut
2757
2758                     # If the terminal supported history, grab it and
2759                     # save that in the environment.
2760                     set_list( "PERLDB_HIST",
2761                           $term->Features->{getHistory}
2762                         ? $term->GetHistory
2763                         : @hist );
2764
2765                     # Find all the files that were visited during this
2766                     # session (i.e., the debugger had magic hashes
2767                     # corresponding to them) and stick them in the environment.
2768                     my @had_breakpoints = keys %had_breakpoints;
2769                     set_list( "PERLDB_VISITED", @had_breakpoints );
2770
2771                     # Save the debugger options we chose.
2772                     set_list( "PERLDB_OPT", %option );
2773                     # set_list( "PERLDB_OPT", options2remember() );
2774
2775                     # Save the break-on-loads.
2776                     set_list( "PERLDB_ON_LOAD", %break_on_load );
2777
2778 =pod
2779
2780 The most complex part of this is the saving of all of the breakpoints. They
2781 can live in an awful lot of places, and we have to go through all of them,
2782 find the breakpoints, and then save them in the appropriate environment
2783 variable via C<DB::set_list>.
2784
2785 =cut
2786
2787                     # Go through all the breakpoints and make sure they're
2788                     # still valid.
2789                     my @hard;
2790                     for ( 0 .. $#had_breakpoints ) {
2791
2792                         # We were in this file.
2793                         my $file = $had_breakpoints[$_];
2794
2795                         # Grab that file's magic line hash.
2796                         *dbline = $main::{ '_<' . $file };
2797
2798                         # Skip out if it doesn't exist, or if the breakpoint
2799                         # is in a postponed file (we'll do postponed ones
2800                         # later).
2801                         next unless %dbline or $postponed_file{$file};
2802
2803                         # In an eval. This is a little harder, so we'll
2804                         # do more processing on that below.
2805                         ( push @hard, $file ), next
2806                           if $file =~ /^\(\w*eval/;
2807
2808                         # XXX I have no idea what this is doing. Yet.
2809                         my @add;
2810                         @add = %{ $postponed_file{$file} }
2811                           if $postponed_file{$file};
2812
2813                         # Save the list of all the breakpoints for this file.
2814                         set_list( "PERLDB_FILE_$_", %dbline, @add );
2815                     } ## end for (0 .. $#had_breakpoints)
2816
2817                     # The breakpoint was inside an eval. This is a little
2818                     # more difficult. XXX and I don't understand it.
2819                     for (@hard) {
2820                         # Get over to the eval in question.
2821                         *dbline = $main::{ '_<' . $_ };
2822                         my ( $quoted, $sub, %subs, $line ) = quotemeta $_;
2823                         for $sub ( keys %sub ) {
2824                             next unless $sub{$sub} =~ /^$quoted:(\d+)-(\d+)$/;
2825                             $subs{$sub} = [ $1, $2 ];
2826                         }
2827                         unless (%subs) {
2828                             print $OUT
2829                               "No subroutines in $_, ignoring breakpoints.\n";
2830                             next;
2831                         }
2832                       LINES: for $line ( keys %dbline ) {
2833
2834                             # One breakpoint per sub only:
2835                             my ( $offset, $sub, $found );
2836                           SUBS: for $sub ( keys %subs ) {
2837                                 if (
2838                                     $subs{$sub}->[1] >=
2839                                     $line    # Not after the subroutine
2840                                     and (
2841                                         not defined $offset    # Not caught
2842                                         or $offset < 0
2843                                     )
2844                                   )
2845                                 {                              # or badly caught
2846                                     $found  = $sub;
2847                                     $offset = $line - $subs{$sub}->[0];
2848                                     $offset = "+$offset", last SUBS
2849                                       if $offset >= 0;
2850                                 } ## end if ($subs{$sub}->[1] >=...
2851                             } ## end for $sub (keys %subs)
2852                             if ( defined $offset ) {
2853                                 $postponed{$found} =
2854                                   "break $offset if $dbline{$line}";
2855                             }
2856                             else {
2857                                 print $OUT
2858 "Breakpoint in $_:$line ignored: after all the subroutines.\n";
2859                             }
2860                         } ## end for $line (keys %dbline)
2861                     } ## end for (@hard)
2862
2863                     # Save the other things that don't need to be
2864                     # processed.
2865                     set_list( "PERLDB_POSTPONE",  %postponed );
2866                     set_list( "PERLDB_PRETYPE",   @$pretype );
2867                     set_list( "PERLDB_PRE",       @$pre );
2868                     set_list( "PERLDB_POST",      @$post );
2869                     set_list( "PERLDB_TYPEAHEAD", @typeahead );
2870
2871                     # We are oficially restarting.
2872                     $ENV{PERLDB_RESTART} = 1;
2873
2874                     # We are junking all child debuggers.
2875                     delete $ENV{PERLDB_PIDS};    # Restore ini state
2876
2877                     # Set this back to the initial pid.
2878                     $ENV{PERLDB_PIDS} = $ini_pids if defined $ini_pids;
2879
2880 =pod
2881
2882 After all the debugger status has been saved, we take the command we built
2883 up and then C<exec()> it. The debugger will spot the C<PERLDB_RESTART>
2884 environment variable and realize it needs to reload its state from the
2885 environment.
2886
2887 =cut
2888
2889                     # And run Perl again. Add the "-d" flag, all the
2890                     # flags we built up, the script (whether a one-liner
2891                     # or a file), add on the -emacs flag for a slave editor,
2892                     # and then the old arguments. We use exec() to keep the
2893                     # PID stable (and that way $ini_pids is still valid).
2894                     exec( $^X, '-d', @flags, @script,
2895                         ( $slave_editor ? '-emacs' : () ), @ARGS )
2896                       || print $OUT "exec failed: $!\n";
2897                     last CMD;
2898                 };
2899
2900 =head4 C<T> - stack trace
2901
2902 Just calls C<DB::print_trace>.
2903
2904 =cut
2905
2906                 $cmd =~ /^T$/ && do {
2907                     print_trace( $OUT, 1 );    # skip DB
2908                     next CMD;
2909                 };
2910
2911 =head4 C<w> - List window around current line.
2912
2913 Just calls C<DB::cmd_w>.
2914
2915 =cut
2916
2917                 $cmd =~ /^w\b\s*(.*)/s && do { &cmd_w( 'w', $1 ); next CMD; };
2918
2919 =head4 C<W> - watch-expression processing.
2920
2921 Just calls C<DB::cmd_W>.
2922
2923 =cut
2924
2925                 $cmd =~ /^W\b\s*(.*)/s && do { &cmd_W( 'W', $1 ); next CMD; };
2926
2927 =head4 C</> - search forward for a string in the source
2928
2929 We take the argument and treat it as a pattern. If it turns out to be a
2930 bad one, we return the error we got from trying to C<eval> it and exit.
2931 If not, we create some code to do the search and C<eval> it so it can't
2932 mess us up.
2933
2934 =cut
2935
2936                 $cmd =~ /^\/(.*)$/ && do {
2937
2938                     # The pattern as a string.
2939                     $inpat = $1;
2940
2941                     # Remove the final slash.
2942                     $inpat =~ s:([^\\])/$:$1:;
2943
2944                     # If the pattern isn't null ...
2945                     if ( $inpat ne "" ) {
2946
2947                         # Turn of warn and die procesing for a bit.
2948                         local $SIG{__DIE__};
2949                         local $SIG{__WARN__};
2950
2951                         # Create the pattern.
2952                         eval '$inpat =~ m' . "\a$inpat\a";
2953                         if ( $@ ne "" ) {
2954
2955                             # Oops. Bad pattern. No biscuit.
2956                             # Print the eval error and go back for more
2957                             # commands.
2958                             print $OUT "$@";
2959                             next CMD;
2960                         }
2961                         $pat = $inpat;
2962                     } ## end if ($inpat ne "")
2963
2964                     # Set up to stop on wrap-around.
2965                     $end = $start;
2966
2967                     # Don't move off the current line.
2968                     $incr = -1;
2969
2970                     # Done in eval so nothing breaks if the pattern
2971                     # does something weird.
2972                     eval '
2973                         for (;;) {
2974                             # Move ahead one line.
2975                             ++$start;
2976
2977                             # Wrap if we pass the last line.
2978                             $start = 1 if ($start > $max);
2979
2980                             # Stop if we have gotten back to this line again,
2981                             last if ($start == $end);
2982
2983                             # A hit! (Note, though, that we are doing
2984                             # case-insensitive matching. Maybe a qr//
2985                             # expression would be better, so the user could
2986                             # do case-sensitive matching if desired.
2987                             if ($dbline[$start] =~ m' . "\a$pat\a" . 'i) {
2988                                 if ($slave_editor) {
2989                                     # Handle proper escaping in the slave.
2990                                     print $OUT "\032\032$filename:$start:0\n";
2991                                 }
2992                                 else {
2993                                     # Just print the line normally.
2994                                     print $OUT "$start:\t",$dbline[$start],"\n";
2995                                 }
2996                                 # And quit since we found something.
2997                                 last;
2998                             }
2999                          } ';
3000
3001                     # If we wrapped, there never was a match.
3002                     print $OUT "/$pat/: not found\n" if ( $start == $end );
3003                     next CMD;
3004                 };
3005
3006 =head4 C<?> - search backward for a string in the source
3007
3008 Same as for C</>, except the loop runs backwards.
3009
3010 =cut
3011
3012                 # ? - backward pattern search.
3013                 $cmd =~ /^\?(.*)$/ && do {
3014
3015                     # Get the pattern, remove trailing question mark.
3016                     $inpat = $1;
3017                     $inpat =~ s:([^\\])\?$:$1:;
3018
3019                     # If we've got one ...
3020                     if ( $inpat ne "" ) {
3021
3022                         # Turn off die & warn handlers.
3023                         local $SIG{__DIE__};
3024                         local $SIG{__WARN__};
3025                         eval '$inpat =~ m' . "\a$inpat\a";
3026
3027                         if ( $@ ne "" ) {
3028
3029                             # Ouch. Not good. Print the error.
3030                             print $OUT $@;
3031                             next CMD;
3032                         }
3033                         $pat = $inpat;
3034                     } ## end if ($inpat ne "")
3035
3036                     # Where we are now is where to stop after wraparound.
3037                     $end = $start;
3038
3039                     # Don't move away from this line.
3040                     $incr = -1;
3041
3042                     # Search inside the eval to prevent pattern badness
3043                     # from killing us.
3044                     eval '
3045                         for (;;) {
3046                             # Back up a line.
3047                             --$start;
3048
3049                             # Wrap if we pass the first line.
3050
3051                             $start = $max if ($start <= 0);
3052
3053                             # Quit if we get back where we started,
3054                             last if ($start == $end);
3055
3056                             # Match?
3057                             if ($dbline[$start] =~ m' . "\a$pat\a" . 'i) {
3058                                 if ($slave_editor) {
3059                                     # Yep, follow slave editor requirements.
3060                                     print $OUT "\032\032$filename:$start:0\n";
3061                                 }
3062                                 else {
3063                                     # Yep, just print normally.
3064                                     print $OUT "$start:\t",$dbline[$start],"\n";
3065                                 }
3066
3067                                 # Found, so done.
3068                                 last;
3069                             }
3070                         } ';
3071
3072                     # Say we failed if the loop never found anything,
3073                     print $OUT "?$pat?: not found\n" if ( $start == $end );
3074                     next CMD;
3075                 };
3076
3077 =head4 C<$rc> - Recall command
3078
3079 Manages the commands in C<@hist> (which is created if C<Term::ReadLine> reports
3080 that the terminal supports history). It find the the command required, puts it
3081 into C<$cmd>, and redoes the loop to execute it.
3082
3083 =cut
3084
3085                 # $rc - recall command.
3086                 $cmd =~ /^$rc+\s*(-)?(\d+)?$/ && do {
3087
3088                     # No arguments, take one thing off history.
3089                     pop(@hist) if length($cmd) > 1;
3090
3091                     # Relative (- found)?
3092                     #  Y - index back from most recent (by 1 if bare minus)
3093                     #  N - go to that particular command slot or the last
3094                     #      thing if nothing following.
3095                     $i = $1 ? ( $#hist - ( $2 || 1 ) ) : ( $2 || $#hist );
3096
3097                     # Pick out the command desired.
3098                     $cmd = $hist[$i];
3099
3100                     # Print the command to be executed and restart the loop
3101                     # with that command in the buffer.
3102                     print $OUT $cmd, "\n";
3103                     redo CMD;
3104                 };
3105
3106 =head4 C<$sh$sh> - C<system()> command
3107
3108 Calls the C<DB::system()> to handle the command. This keeps the C<STDIN> and
3109 C<STDOUT> from getting messed up.
3110
3111 =cut
3112
3113                 # $sh$sh - run a shell command (if it's all ASCII).
3114                 # Can't run shell commands with Unicode in the debugger, hmm.
3115                 $cmd =~ /^$sh$sh\s*([\x00-\xff]*)/ && do {
3116
3117                     # System it.
3118                     &system($1);
3119                     next CMD;
3120                 };
3121
3122 =head4 C<$rc I<pattern> $rc> - Search command history
3123
3124 Another command to manipulate C<@hist>: this one searches it with a pattern.
3125 If a command is found, it is placed in C<$cmd> and executed via <redo>.
3126
3127 =cut
3128
3129                 # $rc pattern $rc - find a command in the history.
3130                 $cmd =~ /^$rc([^$rc].*)$/ && do {
3131
3132                     # Create the pattern to use.
3133                     $pat = "^$1";
3134
3135                     # Toss off last entry if length is >1 (and it always is).
3136                     pop(@hist) if length($cmd) > 1;
3137
3138                     # Look backward through the history.
3139                     for ( $i = $#hist ; $i ; --$i ) {
3140
3141                         # Stop if we find it.
3142                         last if $hist[$i] =~ /$pat/;
3143                     }
3144
3145                     if ( !$i ) {
3146
3147                         # Never found it.
3148                         print $OUT "No such command!\n\n";
3149                         next CMD;
3150                     }
3151
3152                     # Found it. Put it in the buffer, print it, and process it.
3153                     $cmd = $hist[$i];
3154                     print $OUT $cmd, "\n";
3155                     redo CMD;
3156                 };
3157
3158 =head4 C<$sh> - Invoke a shell
3159
3160 Uses C<DB::system> to invoke a shell.
3161
3162 =cut
3163
3164                 # $sh - start a shell.
3165                 $cmd =~ /^$sh$/ && do {
3166
3167                     # Run the user's shell. If none defined, run Bourne.
3168                     # We resume execution when the shell terminates.
3169                     &system( $ENV{SHELL} || "/bin/sh" );
3170                     next CMD;
3171                 };
3172
3173 =head4 C<$sh I<command>> - Force execution of a command in a shell
3174
3175 Like the above, but the command is passed to the shell. Again, we use
3176 C<DB::system> to avoid problems with C<STDIN> and C<STDOUT>.
3177
3178 =cut
3179
3180                 # $sh command - start a shell and run a command in it.
3181                 $cmd =~ /^$sh\s*([\x00-\xff]*)/ && do {
3182
3183                     # XXX: using csh or tcsh destroys sigint retvals!
3184                     #&system($1);  # use this instead
3185
3186                     # use the user's shell, or Bourne if none defined.
3187                     &system( $ENV{SHELL} || "/bin/sh", "-c", $1 );
3188                     next CMD;
3189                 };
3190
3191 =head4 C<H> - display commands in history
3192
3193 Prints the contents of C<@hist> (if any).
3194
3195 =cut
3196
3197                                 $cmd =~ /^H\b\s*\*/ && do {
3198                                         @hist = @truehist = ();
3199                                         print $OUT "History cleansed\n";
3200                                         next CMD;
3201                                 };
3202
3203                 $cmd =~ /^H\b\s*(-(\d+))?/ && do {
3204
3205                     # Anything other than negative numbers is ignored by
3206                     # the (incorrect) pattern, so this test does nothing.
3207                     $end = $2 ? ( $#hist - $2 ) : 0;
3208
3209                     # Set to the minimum if less than zero.
3210                     $hist = 0 if $hist < 0;
3211
3212                     # Start at the end of the array.
3213                     # Stay in while we're still above the ending value.
3214                     # Tick back by one each time around the loop.
3215                     for ( $i = $#hist ; $i > $end ; $i-- ) {
3216
3217                         # Print the command  unless it has no arguments.
3218                         print $OUT "$i: ", $hist[$i], "\n"
3219                           unless $hist[$i] =~ /^.?$/;
3220                     }
3221                     next CMD;
3222                 };
3223
3224 =head4 C<man, doc, perldoc> - look up documentation
3225
3226 Just calls C<runman()> to print the appropriate document.
3227
3228 =cut
3229
3230                 # man, perldoc, doc - show manual pages.
3231                 $cmd =~ /^(?:man|(?:perl)?doc)\b(?:\s+([^(]*))?$/ && do {
3232                     runman($1);
3233                     next CMD;
3234                 };
3235
3236 =head4 C<p> - print
3237
3238 Builds a C<print EXPR> expression in the C<$cmd>; this will get executed at
3239 the bottom of the loop.
3240
3241 =cut
3242
3243                 # p - print (no args): print $_.
3244                 $cmd =~ s/^p$/print {\$DB::OUT} \$_/;
3245
3246                 # p - print the given expression.
3247                 $cmd =~ s/^p\b/print {\$DB::OUT} /;
3248
3249 =head4 C<=> - define command alias
3250
3251 Manipulates C<%alias> to add or list command aliases.
3252
3253 =cut
3254
3255                 # = - set up a command alias.
3256                 $cmd =~ s/^=\s*// && do {
3257                     my @keys;
3258                     if ( length $cmd == 0 ) {
3259
3260                         # No args, get current aliases.
3261                         @keys = sort keys %alias;
3262                     }
3263                     elsif ( my ( $k, $v ) = ( $cmd =~ /^(\S+)\s+(\S.*)/ ) ) {
3264
3265                         # Creating a new alias. $k is alias name, $v is
3266                         # alias value.
3267
3268                         # can't use $_ or kill //g state
3269                         for my $x ( $k, $v ) {
3270
3271                             # Escape "alarm" characters.
3272                             $x =~ s/\a/\\a/g;
3273                         }
3274
3275                         # Substitute key for value, using alarm chars
3276                         # as separators (which is why we escaped them in
3277                         # the command).
3278                         $alias{$k} = "s\a$k\a$v\a";
3279
3280                         # Turn off standard warn and die behavior.
3281                         local $SIG{__DIE__};
3282                         local $SIG{__WARN__};
3283
3284                         # Is it valid Perl?
3285                         unless ( eval "sub { s\a$k\a$v\a }; 1" ) {
3286
3287                             # Nope. Bad alias. Say so and get out.
3288                             print $OUT "Can't alias $k to $v: $@\n";
3289                             delete $alias{$k};
3290                             next CMD;
3291                         }
3292
3293                         # We'll only list the new one.
3294                         @keys = ($k);
3295                     } ## end elsif (my ($k, $v) = ($cmd...
3296
3297                     # The argument is the alias to list.
3298                     else {
3299                         @keys = ($cmd);
3300                     }
3301
3302                     # List aliases.
3303                     for my $k (@keys) {
3304
3305                         # Messy metaquoting: Trim the substiution code off.
3306                         # We use control-G as the delimiter because it's not
3307                         # likely to appear in the alias.
3308                         if ( ( my $v = $alias{$k} ) =~ s\as\a$k\a(.*)\a$\a1\a ) {
3309
3310                             # Print the alias.
3311                             print $OUT "$k\t= $1\n";
3312                         }
3313                         elsif ( defined $alias{$k} ) {
3314
3315                             # Couldn't trim it off; just print the alias code.
3316                             print $OUT "$k\t$alias{$k}\n";
3317                         }
3318                         else {
3319
3320                             # No such, dude.
3321                             print "No alias for $k\n";
3322                         }
3323                     } ## end for my $k (@keys)
3324                     next CMD;
3325                 };
3326
3327 =head4 C<source> - read commands from a file.
3328
3329 Opens a lexical filehandle and stacks it on C<@cmdfhs>; C<DB::readline> will
3330 pick it up.
3331
3332 =cut
3333
3334                 # source - read commands from a file (or pipe!) and execute.
3335                 $cmd =~ /^source\s+(.*\S)/ && do {
3336                     if ( open my $fh, $1 ) {
3337
3338                         # Opened OK; stick it in the list of file handles.
3339                         push @cmdfhs, $fh;
3340                     }
3341                     else {
3342
3343                         # Couldn't open it.
3344                         &warn("Can't execute `$1': $!\n");
3345                     }
3346                     next CMD;
3347                 };
3348
3349 =head4 C<save> - send current history to a file
3350
3351 Takes the complete history, (not the shrunken version you see with C<H>),
3352 and saves it to the given filename, so it can be replayed using C<source>.
3353
3354 Note that all C<^(save|source)>'s are commented out with a view to minimise recursion.
3355
3356 =cut
3357
3358                 # save source - write commands to a file for later use
3359                 $cmd =~ /^save\s*(.*)$/ && do {
3360                     my $file = $1 || '.perl5dbrc';    # default?
3361                     if ( open my $fh, "> $file" ) {
3362
3363                        # chomp to remove extraneous newlines from source'd files
3364                         chomp( my @truelist =
3365                               map { m/^\s*(save|source)/ ? "#$_" : $_ }
3366                               @truehist );
3367                         print $fh join( "\n", @truelist );
3368                         print "commands saved in $file\n";
3369                     }
3370                     else {
3371                         &warn("Can't save debugger commands in '$1': $!\n");
3372                     }
3373                     next CMD;
3374                 };
3375
3376 =head4 C<|, ||> - pipe output through the pager.
3377
3378 FOR C<|>, we save C<OUT> (the debugger's output filehandle) and C<STDOUT>
3379 (the program's standard output). For C<||>, we only save C<OUT>. We open a
3380 pipe to the pager (restoring the output filehandles if this fails). If this
3381 is the C<|> command, we also set up a C<SIGPIPE> handler which will simply
3382 set C<$signal>, sending us back into the debugger.
3383
3384 We then trim off the pipe symbols and C<redo> the command loop at the
3385 C<PIPE> label, causing us to evaluate the command in C<$cmd> without
3386 reading another.
3387
3388 =cut
3389
3390                 # || - run command in the pager, with output to DB::OUT.
3391                 $cmd =~ /^\|\|?\s*[^|]/ && do {
3392                     if ( $pager =~ /^\|/ ) {
3393
3394                         # Default pager is into a pipe. Redirect I/O.
3395                         open( SAVEOUT, ">&STDOUT" )
3396                           || &warn("Can't save STDOUT");
3397                         open( STDOUT, ">&OUT" )
3398                           || &warn("Can't redirect STDOUT");
3399                     } ## end if ($pager =~ /^\|/)
3400                     else {
3401
3402                         # Not into a pipe. STDOUT is safe.
3403                         open( SAVEOUT, ">&OUT" ) || &warn("Can't save DB::OUT");
3404                     }
3405
3406                     # Fix up environment to record we have less if so.
3407                     fix_less();
3408
3409                     unless ( $piped = open( OUT, $pager ) ) {
3410
3411                         # Couldn't open pipe to pager.
3412                         &warn("Can't pipe output to `$pager'");
3413                         if ( $pager =~ /^\|/ ) {
3414
3415                             # Redirect I/O back again.
3416                             open( OUT, ">&STDOUT" )    # XXX: lost message
3417                               || &warn("Can't restore DB::OUT");
3418                             open( STDOUT, ">&SAVEOUT" )
3419                               || &warn("Can't restore STDOUT");
3420                             close(SAVEOUT);
3421                         } ## end if ($pager =~ /^\|/)
3422                         else {
3423
3424                             # Redirect I/O. STDOUT already safe.
3425                             open( OUT, ">&STDOUT" )    # XXX: lost message
3426                               || &warn("Can't restore DB::OUT");
3427                         }
3428                         next CMD;
3429                     } ## end unless ($piped = open(OUT,...
3430
3431                     # Set up broken-pipe handler if necessary.
3432                     $SIG{PIPE} = \&DB::catch
3433                       if $pager =~ /^\|/
3434                       && ( "" eq $SIG{PIPE} || "DEFAULT" eq $SIG{PIPE} );
3435
3436                     # Save current filehandle, unbuffer out, and put it back.
3437                     $selected = select(OUT);
3438                     $|        = 1;
3439
3440                     # Don't put it back if pager was a pipe.
3441                     select($selected), $selected = "" unless $cmd =~ /^\|\|/;
3442
3443                     # Trim off the pipe symbols and run the command now.
3444                     $cmd =~ s/^\|+\s*//;
3445                     redo PIPE;
3446                 };
3447
3448 =head3 END OF COMMAND PARSING
3449
3450 Anything left in C<$cmd> at this point is a Perl expression that we want to
3451 evaluate. We'll always evaluate in the user's context, and fully qualify
3452 any variables we might want to address in the C<DB> package.
3453
3454 =cut
3455
3456                 # t - turn trace on.
3457                 $cmd =~ s/^t\s/\$DB::trace |= 1;\n/;
3458
3459                 # s - single-step. Remember the last command was 's'.
3460                 $cmd =~ s/^s\s/\$DB::single = 1;\n/ && do { $laststep = 's' };
3461
3462                 # n - single-step, but not into subs. Remember last command
3463                 # was 'n'.
3464                 $cmd =~ s/^n\s/\$DB::single = 2;\n/ && do { $laststep = 'n' };
3465
3466             }    # PIPE:
3467
3468             # Make sure the flag that says "the debugger's running" is
3469             # still on, to make sure we get control again.
3470             $evalarg = "\$^D = \$^D | \$DB::db_stop;\n$cmd";
3471
3472             # Run *our* eval that executes in the caller's context.
3473             &eval;
3474
3475             # Turn off the one-time-dump stuff now.
3476             if ($onetimeDump) {
3477                 $onetimeDump      = undef;
3478                 $onetimedumpDepth = undef;
3479             }
3480             elsif ( $term_pid == $$ ) {
3481                 STDOUT->flush();
3482                 STDERR->flush();
3483
3484                 # XXX If this is the master pid, print a newline.
3485                 print $OUT "\n";
3486             }
3487         } ## end while (($term || &setterm...
3488
3489 =head3 POST-COMMAND PROCESSING
3490
3491 After each command, we check to see if the command output was piped anywhere.
3492 If so, we go through the necessary code to unhook the pipe and go back to
3493 our standard filehandles for input and output.
3494
3495 =cut
3496
3497         continue {    # CMD:
3498
3499             # At the end of every command:
3500             if ($piped) {
3501
3502                 # Unhook the pipe mechanism now.
3503                 if ( $pager =~ /^\|/ ) {
3504
3505                     # No error from the child.
3506                     $? = 0;
3507
3508                     # we cannot warn here: the handle is missing --tchrist
3509                     close(OUT) || print SAVEOUT "\nCan't close DB::OUT\n";
3510
3511                     # most of the $? crud was coping with broken cshisms
3512                     # $? is explicitly set to 0, so this never runs.
3513                     if ($?) {
3514                         print SAVEOUT "Pager `$pager' failed: ";
3515                         if ( $? == -1 ) {
3516                             print SAVEOUT "shell returned -1\n";
3517                         }
3518                         elsif ( $? >> 8 ) {
3519                             print SAVEOUT ( $? & 127 )
3520                               ? " (SIG#" . ( $? & 127 ) . ")"
3521                               : "", ( $? & 128 ) ? " -- core dumped" : "", "\n";
3522                         }
3523                         else {
3524                             print SAVEOUT "status ", ( $? >> 8 ), "\n";
3525                         }
3526                     } ## end if ($?)
3527
3528                     # Reopen filehandle for our output (if we can) and
3529                     # restore STDOUT (if we can).
3530                     open( OUT, ">&STDOUT" ) || &warn("Can't restore DB::OUT");
3531                     open( STDOUT, ">&SAVEOUT" )
3532                       || &warn("Can't restore STDOUT");
3533
3534                     # Turn off pipe exception handler if necessary.
3535                     $SIG{PIPE} = "DEFAULT" if $SIG{PIPE} eq \&DB::catch;
3536
3537                     # Will stop ignoring SIGPIPE if done like nohup(1)
3538                     # does SIGINT but Perl doesn't give us a choice.
3539                 } ## end if ($pager =~ /^\|/)
3540                 else {
3541
3542                     # Non-piped "pager". Just restore STDOUT.
3543                     open( OUT, ">&SAVEOUT" ) || &warn("Can't restore DB::OUT");
3544                 }
3545
3546                 # Close filehandle pager was using, restore the normal one
3547                 # if necessary,
3548                 close(SAVEOUT);
3549                 select($selected), $selected = "" unless $selected eq "";
3550
3551                 # No pipes now.
3552                 $piped = "";
3553             } ## end if ($piped)
3554         }    # CMD:
3555
3556 =head3 COMMAND LOOP TERMINATION
3557
3558 When commands have finished executing, we come here. If the user closed the
3559 input filehandle, we turn on C<$fall_off_end> to emulate a C<q> command. We
3560 evaluate any post-prompt items. We restore C<$@>, C<$!>, C<$^E>, C<$,>, C<$/>,
3561 C<$\>, and C<$^W>, and return a null list as expected by the Perl interpreter.
3562 The interpreter will then execute the next line and then return control to us
3563 again.
3564
3565 =cut
3566
3567         # No more commands? Quit.
3568         $fall_off_end = 1 unless defined $cmd;    # Emulate `q' on EOF
3569
3570         # Evaluate post-prompt commands.
3571         foreach $evalarg (@$post) {
3572             &eval;
3573         }
3574     }    # if ($single || $signal)
3575
3576     # Put the user's globals back where you found them.
3577     ( $@, $!, $^E, $,, $/, $\, $^W ) = @saved;
3578     ();
3579 } ## end sub DB
3580
3581 # The following code may be executed now:
3582 # BEGIN {warn 4}
3583
3584 =head2 sub
3585
3586 C<sub> is called whenever a subroutine call happens in the program being
3587 debugged. The variable C<$DB::sub> contains the name of the subroutine
3588 being called.
3589
3590 The core function of this subroutine is to actually call the sub in the proper
3591 context, capturing its output. This of course causes C<DB::DB> to get called
3592 again, repeating until the subroutine ends and returns control to C<DB::sub>
3593 again. Once control returns, C<DB::sub> figures out whether or not to dump the
3594 return value, and returns its captured copy of the return value as its own
3595 return value. The value then feeds back into the program being debugged as if
3596 C<DB::sub> hadn't been there at all.
3597
3598 C<sub> does all the work of printing the subroutine entry and exit messages
3599 enabled by setting C<$frame>. It notes what sub the autoloader got called for,
3600 and also prints the return value if needed (for the C<r> command and if
3601 the 16 bit is set in C<$frame>).
3602
3603 It also tracks the subroutine call depth by saving the current setting of
3604 C<$single> in the C<@stack> package global; if this exceeds the value in
3605 C<$deep>, C<sub> automatically turns on printing of the current depth by
3606 setting the 4 bit in C<$single>. In any case, it keeps the current setting
3607 of stop/don't stop on entry to subs set as it currently is set.
3608
3609 =head3 C<caller()> support
3610
3611 If C<caller()> is called from the package C<DB>, it provides some
3612 additional data, in the following order:
3613
3614 =over 4
3615
3616 =item * C<$package>
3617
3618 The package name the sub was in
3619
3620 =item * C<$filename>
3621
3622 The filename it was defined in
3623
3624 =item * C<$line>
3625
3626 The line number it was defined on
3627
3628 =item * C<$subroutine>
3629
3630 The subroutine name; C<'(eval)'> if an C<eval>().
3631
3632 =item * C<$hasargs>
3633
3634 1 if it has arguments, 0 if not
3635
3636 =item * C<$wantarray>
3637
3638 1 if array context, 0 if scalar context
3639
3640 =item * C<$evaltext>
3641
3642 The C<eval>() text, if any (undefined for C<eval BLOCK>)
3643
3644 =item * C<$is_require>
3645
3646 frame was created by a C<use> or C<require> statement
3647
3648 =item * C<$hints>
3649
3650 pragma information; subject to change between versions
3651
3652 =item * C<$bitmask>
3653
3654 pragma information: subject to change between versions
3655
3656 =item * C<@DB::args>
3657
3658 arguments with which the subroutine was invoked
3659
3660 =back
3661
3662 =cut
3663
3664 sub sub {
3665
3666     # Whether or not the autoloader was running, a scalar to put the
3667     # sub's return value in (if needed), and an array to put the sub's
3668     # return value in (if needed).
3669     my ( $al, $ret, @ret ) = "";
3670
3671     # If the last ten characters are C'::AUTOLOAD', note we've traced
3672     # into AUTOLOAD for $sub.
3673     if ( length($sub) > 10 && substr( $sub, -10, 10 ) eq '::AUTOLOAD' ) {
3674         $al = " for $$sub";
3675     }
3676
3677     # We stack the stack pointer and then increment it to protect us
3678     # from a situation that might unwind a whole bunch of call frames
3679     # at once. Localizing the stack pointer means that it will automatically
3680     # unwind the same amount when multiple stack frames are unwound.
3681     local $stack_depth = $stack_depth + 1;    # Protect from non-local exits
3682
3683     # Expand @stack.
3684     $#stack = $stack_depth;
3685
3686     # Save current single-step setting.
3687     $stack[-1] = $single;
3688
3689     # Turn off all flags except single-stepping.
3690     $single &= 1;
3691
3692     # If we've gotten really deeply recursed, turn on the flag that will
3693     # make us stop with the 'deep recursion' message.
3694     $single |= 4 if $stack_depth == $deep;
3695
3696     # If frame messages are on ...
3697     (
3698         $frame & 4    # Extended frame entry message
3699         ? (
3700             print_lineinfo( ' ' x ( $stack_depth - 1 ), "in  " ),
3701
3702             # Why -1? But it works! :-(
3703             # Because print_trace will call add 1 to it and then call
3704             # dump_trace; this results in our skipping -1+1 = 0 stack frames
3705             # in dump_trace.
3706             print_trace( $LINEINFO, -1, 1, 1, "$sub$al" )
3707           )
3708         : print_lineinfo( ' ' x ( $stack_depth - 1 ), "entering $sub$al\n" )
3709
3710           # standard frame entry message
3711       )
3712       if $frame;
3713
3714     # Determine the sub's return type,and capture approppriately.
3715     if (wantarray) {
3716
3717         # Called in array context. call sub and capture output.
3718         # DB::DB will recursively get control again if appropriate; we'll come
3719         # back here when the sub is finished.
3720         if ($assertion) {
3721             $assertion = 0;
3722             eval { @ret = &$sub; };
3723             if ($@) {
3724                 print $OUT $@;
3725                 $signal = 1 unless $warnassertions;
3726             }
3727         }
3728         else {
3729             @ret = &$sub;
3730         }
3731
3732         # Pop the single-step value back off the stack.
3733         $single |= $stack[ $stack_depth-- ];
3734
3735         # Check for exit trace messages...
3736         (
3737             $frame & 4    # Extended exit message
3738             ? (
3739                 print_lineinfo( ' ' x $stack_depth, "out " ),
3740                 print_trace( $LINEINFO, -1, 1, 1, "$sub$al" )
3741               )
3742             : print_lineinfo( ' ' x $stack_depth, "exited $sub$al\n" )
3743
3744               # Standard exit message
3745           )
3746           if $frame & 2;
3747
3748         # Print the return info if we need to.
3749         if ( $doret eq $stack_depth or $frame & 16 ) {
3750
3751             # Turn off output record separator.
3752             local $\ = '';
3753             my $fh = ( $doret eq $stack_depth ? $OUT : $LINEINFO );
3754
3755             # Indent if we're printing because of $frame tracing.
3756             print $fh ' ' x $stack_depth if $frame & 16;
3757
3758             # Print the return value.
3759             print $fh "list context return from $sub:\n";
3760             dumpit( $fh, \@ret );
3761
3762             # And don't print it again.
3763             $doret = -2;
3764         } ## end if ($doret eq $stack_depth...
3765             # And we have to return the return value now.
3766         @ret;
3767     } ## end if (wantarray)
3768
3769     # Scalar context.
3770     else {
3771         if ($assertion) {
3772             $assertion = 0;
3773             eval {
3774
3775                 # Save the value if it's wanted at all.
3776                 $ret = &$sub;
3777             };
3778             if ($@) {
3779                 print $OUT $@;
3780                 $signal = 1 unless $warnassertions;
3781             }
3782             $ret = undef unless defined wantarray;
3783         }
3784         else {
3785             if ( defined wantarray ) {
3786
3787                 # Save the value if it's wanted at all.
3788                 $ret = &$sub;
3789             }
3790             else {
3791
3792                 # Void return, explicitly.
3793                 &$sub;
3794                 undef $ret;
3795             }
3796         }    # if assertion
3797
3798         # Pop the single-step value off the stack.
3799         $single |= $stack[ $stack_depth-- ];
3800
3801         # If we're doing exit messages...
3802         (
3803             $frame & 4    # Extended messsages
3804             ? (
3805                 print_lineinfo( ' ' x $stack_depth, "out " ),
3806                 print_trace( $LINEINFO, -1, 1, 1, "$sub$al" )
3807               )
3808             : print_lineinfo( ' ' x $stack_depth, "exited $sub$al\n" )
3809
3810               # Standard messages
3811           )
3812           if $frame & 2;
3813
3814         # If we are supposed to show the return value... same as before.
3815         if ( $doret eq $stack_depth or $frame & 16 and defined wantarray ) {
3816             local $\ = '';
3817             my $fh = ( $doret eq $stack_depth ? $OUT : $LINEINFO );
3818             print $fh ( ' ' x $stack_depth ) if $frame & 16;
3819             print $fh (
3820                 defined wantarray
3821                 ? "scalar context return from $sub: "
3822                 : "void context return from $sub\n"
3823             );
3824             dumpit( $fh, $ret ) if defined wantarray;
3825             $doret = -2;
3826         } ## end if ($doret eq $stack_depth...
3827
3828         # Return the appropriate scalar value.
3829         $ret;
3830     } ## end else [ if (wantarray)
3831 } ## end sub sub
3832
3833 =head1 EXTENDED COMMAND HANDLING AND THE COMMAND API
3834
3835 In Perl 5.8.0, there was a major realignment of the commands and what they did,
3836 Most of the changes were to systematize the command structure and to eliminate
3837 commands that threw away user input without checking.
3838
3839 The following sections describe the code added to make it easy to support
3840 multiple command sets with conflicting command names. This section is a start
3841 at unifying all command processing to make it simpler to develop commands.
3842
3843 Note that all the cmd_[a-zA-Z] subroutines require the command name, a line
3844 number, and C<$dbline> (the current line) as arguments.
3845
3846 Support functions in this section which have multiple modes of failure C<die>
3847 on error; the rest simply return a false value.
3848
3849 The user-interface functions (all of the C<cmd_*> functions) just output
3850 error messages.
3851
3852 =head2 C<%set>
3853
3854 The C<%set> hash defines the mapping from command letter to subroutine
3855 name suffix.
3856
3857 C<%set> is a two-level hash, indexed by set name and then by command name.
3858 Note that trying to set the CommandSet to 'foobar' simply results in the
3859 5.8.0 command set being used, since there's no top-level entry for 'foobar'.
3860
3861 =cut
3862
3863 ### The API section
3864
3865 my %set = (    #
3866     'pre580' => {
3867         'a' => 'pre580_a',
3868         'A' => 'pre580_null',
3869         'b' => 'pre580_b',
3870         'B' => 'pre580_null',
3871         'd' => 'pre580_null',
3872         'D' => 'pre580_D',
3873         'h' => 'pre580_h',
3874         'M' => 'pre580_null',
3875         'O' => 'o',
3876         'o' => 'pre580_null',
3877         'v' => 'M',
3878         'w' => 'v',
3879         'W' => 'pre580_W',
3880     },
3881     'pre590' => {
3882         '<'  => 'pre590_prepost',
3883         '<<' => 'pre590_prepost',
3884         '>'  => 'pre590_prepost',
3885         '>>' => 'pre590_prepost',
3886         '{'  => 'pre590_prepost',
3887         '{{' => 'pre590_prepost',
3888     },
3889 );
3890
3891 =head2 C<cmd_wrapper()> (API)
3892
3893 C<cmd_wrapper()> allows the debugger to switch command sets
3894 depending on the value of the C<CommandSet> option.
3895
3896 It tries to look up the command in the X<C<%set>> package-level I<lexical>
3897 (which means external entities can't fiddle with it) and create the name of
3898 the sub to call based on the value found in the hash (if it's there). I<All>
3899 of the commands to be handled in a set have to be added to C<%set>; if they
3900 aren't found, the 5.8.0 equivalent is called (if there is one).
3901
3902 This code uses symbolic references.
3903
3904 =cut
3905
3906 sub cmd_wrapper {
3907     my $cmd      = shift;
3908     my $line     = shift;
3909     my $dblineno = shift;
3910
3911     # Assemble the command subroutine's name by looking up the
3912     # command set and command name in %set. If we can't find it,
3913     # default to the older version of the command.
3914     my $call = 'cmd_'
3915       . ( $set{$CommandSet}{$cmd}
3916           || ( $cmd =~ /^[<>{]+/o ? 'prepost' : $cmd ) );
3917
3918     # Call the command subroutine, call it by name.
3919     return &$call( $cmd, $line, $dblineno );
3920 } ## end sub cmd_wrapper
3921
3922 =head3 C<cmd_a> (command)
3923
3924 The C<a> command handles pre-execution actions. These are associated with a
3925 particular line, so they're stored in C<%dbline>. We default to the current
3926 line if none is specified.
3927
3928 =cut
3929
3930 sub cmd_a {
3931     my $cmd    = shift;
3932     my $line   = shift || '';    # [.|line] expr
3933     my $dbline = shift;
3934
3935     # If it's dot (here), or not all digits,  use the current line.
3936     $line =~ s/^(\.|(?:[^\d]))/$dbline/;
3937
3938     # Should be a line number followed by an expression.
3939     if ( $line =~ /^\s*(\d*)\s*(\S.+)/ ) {
3940         my ( $lineno, $expr ) = ( $1, $2 );
3941
3942         # If we have an expression ...
3943         if ( length $expr ) {
3944
3945             # ... but the line isn't breakable, complain.
3946             if ( $dbline[$lineno] == 0 ) {
3947                 print $OUT
3948                   "Line $lineno($dbline[$lineno]) does not have an action?\n";
3949             }
3950             else {
3951
3952                 # It's executable. Record that the line has an action.
3953                 $had_breakpoints{$filename} |= 2;
3954
3955                 # Remove any action, temp breakpoint, etc.
3956                 $dbline{$lineno} =~ s/\0[^\0]*//;
3957
3958                 # Add the action to the line.
3959                 $dbline{$lineno} .= "\0" . action($expr);
3960             }
3961         } ## end if (length $expr)
3962     } ## end if ($line =~ /^\s*(\d*)\s*(\S.+)/)
3963     else {
3964
3965         # Syntax wrong.
3966         print $OUT
3967           "Adding an action requires an optional lineno and an expression\n"
3968           ;    # hint
3969     }
3970 } ## end sub cmd_a
3971
3972 =head3 C<cmd_A> (command)
3973
3974 Delete actions. Similar to above, except the delete code is in a separate
3975 subroutine, C<delete_action>.
3976
3977 =cut
3978
3979 sub cmd_A {
3980     my $cmd    = shift;
3981     my $line   = shift || '';
3982     my $dbline = shift;
3983
3984     # Dot is this line.
3985     $line =~ s/^\./$dbline/;
3986
3987     # Call delete_action with a null param to delete them all.
3988     # The '1' forces the eval to be true. It'll be false only
3989     # if delete_action blows up for some reason, in which case
3990     # we print $@ and get out.
3991     if ( $line eq '*' ) {
3992         eval { &delete_action(); 1 } or print $OUT $@ and return;
3993     }
3994
3995     # There's a real line  number. Pass it to delete_action.
3996     # Error trapping is as above.
3997     elsif ( $line =~ /^(\S.*)/ ) {
3998         eval { &delete_action($1); 1 } or print $OUT $@ and return;
3999     }
4000
4001     # Swing and a miss. Bad syntax.
4002     else {
4003         print $OUT
4004           "Deleting an action requires a line number, or '*' for all\n" ; # hint
4005     }
4006 } ## end sub cmd_A
4007
4008 =head3 C<delete_action> (API)
4009
4010 C<delete_action> accepts either a line number or C<undef>. If a line number
4011 is specified, we check for the line being executable (if it's not, it
4012 couldn't have had an  action). If it is, we just take the action off (this
4013 will get any kind of an action, including breakpoints).
4014
4015 =cut
4016
4017 sub delete_action {
4018     my $i = shift;
4019     if ( defined($i) ) {
4020
4021         # Can there be one?
4022         die "Line $i has no action .\n" if $dbline[$i] == 0;
4023
4024         # Nuke whatever's there.
4025         $dbline{$i} =~ s/\0[^\0]*//;    # \^a
4026         delete $dbline{$i} if $dbline{$i} eq '';
4027     }
4028     else {
4029         print $OUT "Deleting all actions...\n";
4030         for my $file ( keys %had_breakpoints ) {
4031             local *dbline = $main::{ '_<' . $file };
4032             my $max = $#dbline;
4033             my $was;
4034             for ( $i = 1 ; $i <= $max ; $i++ ) {
4035                 if ( defined $dbline{$i} ) {
4036                     $dbline{$i} =~ s/\0[^\0]*//;
4037                     delete $dbline{$i} if $dbline{$i} eq '';
4038                 }
4039                 unless ( $had_breakpoints{$file} &= ~2 ) {
4040                     delete $had_breakpoints{$file};
4041                 }
4042             } ## end for ($i = 1 ; $i <= $max...
4043         } ## end for my $file (keys %had_breakpoints)
4044     } ## end else [ if (defined($i))
4045 } ## end sub delete_action
4046
4047 =head3 C<cmd_b> (command)
4048
4049 Set breakpoints. Since breakpoints can be set in so many places, in so many
4050 ways, conditionally or not, the breakpoint code is kind of complex. Mostly,
4051 we try to parse the command type, and then shuttle it off to an appropriate
4052 subroutine to actually do the work of setting the breakpoint in the right
4053 place.
4054
4055 =cut
4056
4057 sub cmd_b {
4058     my $cmd    = shift;
4059     my $line   = shift;    # [.|line] [cond]
4060     my $dbline = shift;
4061
4062     # Make . the current line number if it's there..
4063     $line =~ s/^\./$dbline/;
4064
4065     # No line number, no condition. Simple break on current line.
4066     if ( $line =~ /^\s*$/ ) {
4067         &cmd_b_line( $dbline, 1 );
4068     }
4069
4070     # Break on load for a file.
4071     elsif ( $line =~ /^load\b\s*(.*)/ ) {
4072         my $file = $1;
4073         $file =~ s/\s+$//;
4074         &cmd_b_load($file);
4075     }
4076
4077     # b compile|postpone <some sub> [<condition>]
4078     # The interpreter actually traps this one for us; we just put the
4079     # necessary condition in the %postponed hash.
4080     elsif ( $line =~ /^(postpone|compile)\b\s*([':A-Za-z_][':\w]*)\s*(.*)/ ) {
4081
4082         # Capture the condition if there is one. Make it true if none.
4083         my $cond = length $3 ? $3 : '1';
4084
4085         # Save the sub name and set $break to 1 if $1 was 'postpone', 0
4086         # if it was 'compile'.
4087         my ( $subname, $break ) = ( $2, $1 eq 'postpone' );
4088
4089         # De-Perl4-ify the name - ' separators to ::.
4090         $subname =~ s/\'/::/g;
4091
4092         # Qualify it into the current package unless it's already qualified.
4093         $subname = "${'package'}::" . $subname unless $subname =~ /::/;
4094
4095         # Add main if it starts with ::.
4096         $subname = "main" . $subname if substr( $subname, 0, 2 ) eq "::";
4097
4098         # Save the break type for this sub.
4099         $postponed{$subname} = $break ? "break +0 if $cond" : "compile";
4100     } ## end elsif ($line =~ ...
4101
4102     # b <sub name> [<condition>]
4103     elsif ( $line =~ /^([':A-Za-z_][':\w]*(?:\[.*\])?)\s*(.*)/ ) {
4104
4105         #
4106         $subname = $1;
4107         $cond = length $2 ? $2 : '1';
4108         &cmd_b_sub( $subname, $cond );
4109     }
4110
4111     # b <line> [<condition>].
4112     elsif ( $line =~ /^(\d*)\s*(.*)/ ) {
4113
4114         # Capture the line. If none, it's the current line.
4115         $line = $1 || $dbline;
4116
4117         # If there's no condition, make it '1'.
4118         $cond = length $2 ? $2 : '1';
4119
4120         # Break on line.
4121         &cmd_b_line( $line, $cond );
4122     }
4123
4124     # Line didn't make sense.
4125     else {
4126         print "confused by line($line)?\n";
4127     }
4128 } ## end sub cmd_b
4129
4130 =head3 C<break_on_load> (API)
4131
4132 We want to break when this file is loaded. Mark this file in the
4133 C<%break_on_load> hash, and note that it has a breakpoint in
4134 C<%had_breakpoints>.
4135
4136 =cut
4137
4138 sub break_on_load {
4139     my $file = shift;
4140     $break_on_load{$file} = 1;
4141     $had_breakpoints{$file} |= 1;
4142 }
4143
4144 =head3 C<report_break_on_load> (API)
4145
4146 Gives us an array of filenames that are set to break on load. Note that
4147 only files with break-on-load are in here, so simply showing the keys
4148 suffices.
4149
4150 =cut
4151
4152 sub report_break_on_load {
4153     sort keys %break_on_load;
4154 }
4155
4156 =head3 C<cmd_b_load> (command)
4157
4158 We take the file passed in and try to find it in C<%INC> (which maps modules
4159 to files they came from). We mark those files for break-on-load via
4160 C<break_on_load> and then report that it was done.
4161
4162 =cut
4163
4164 sub cmd_b_load {
4165     my $file = shift;
4166     my @files;
4167
4168     # This is a block because that way we can use a redo inside it
4169     # even without there being any looping structure at all outside it.
4170     {
4171
4172         # Save short name and full path if found.
4173         push @files, $file;
4174         push @files, $::INC{$file} if $::INC{$file};
4175
4176         # Tack on .pm and do it again unless there was a '.' in the name
4177         # already.
4178         $file .= '.pm', redo unless $file =~ /\./;
4179     }
4180
4181     # Do the real work here.
4182     break_on_load($_) for @files;
4183
4184     # All the files that have break-on-load breakpoints.
4185     @files = report_break_on_load;
4186
4187     # Normalize for the purposes of our printing this.
4188     local $\ = '';
4189     local $" = ' ';
4190     print $OUT "Will stop on load of `@files'.\n";
4191 } ## end sub cmd_b_load
4192
4193 =head3 C<$filename_error> (API package global)
4194
4195 Several of the functions we need to implement in the API need to work both
4196 on the current file and on other files. We don't want to duplicate code, so
4197 C<$filename_error> is used to contain the name of the file that's being
4198 worked on (if it's not the current one).
4199
4200 We can now build functions in pairs: the basic function works on the current
4201 file, and uses C<$filename_error> as part of its error message. Since this is
4202 initialized to C<''>, no filename will appear when we are working on the
4203 current file.
4204
4205 The second function is a wrapper which does the following:
4206
4207 =over 4
4208
4209 =item * Localizes C<$filename_error> and sets it to the name of the file to be processed.
4210
4211 =item * Localizes the C<*dbline> glob and reassigns it to point to the file we want to process.
4212
4213 =item * Calls the first function.
4214
4215 The first function works on the "current" (i.e., the one we changed to) file,
4216 and prints C<$filename_error> in the error message (the name of the other file)
4217 if it needs to. When the functions return, C<*dbline> is restored to point to the actual current file (the one we're executing in) and C<$filename_error> is
4218 restored to C<''>. This restores everything to the way it was before the
4219 second function was called at all.
4220
4221 See the comments in C<breakable_line> and C<breakable_line_in_file> for more
4222 details.
4223
4224 =back
4225
4226 =cut
4227
4228 $filename_error = '';
4229
4230 =head3 breakable_line($from, $to) (API)
4231
4232 The subroutine decides whether or not a line in the current file is breakable.
4233 It walks through C<@dbline> within the range of lines specified, looking for
4234 the first line that is breakable.
4235
4236 If C<$to> is greater than C<$from>, the search moves forwards, finding the
4237 first line I<after> C<$to> that's breakable, if there is one.
4238
4239 If C<$from> is greater than C<$to>, the search goes I<backwards>, finding the
4240 first line I<before> C<$to> that's breakable, if there is one.
4241
4242 =cut
4243
4244 sub breakable_line {
4245
4246     my ( $from, $to ) = @_;
4247
4248     # $i is the start point. (Where are the FORTRAN programs of yesteryear?)
4249     my $i = $from;
4250
4251     # If there are at least 2 arguments, we're trying to search a range.
4252     if ( @_ >= 2 ) {
4253
4254         # $delta is positive for a forward search, negative for a backward one.
4255         my $delta = $from < $to ? +1 : -1;
4256
4257         # Keep us from running off the ends of the file.
4258         my $limit = $delta > 0 ? $#dbline : 1;
4259
4260         # Clever test. If you're a mathematician, it's obvious why this
4261         # test works. If not:
4262         # If $delta is positive (going forward), $limit will be $#dbline.
4263         #    If $to is less than $limit, ($limit - $to) will be positive, times
4264         #    $delta of 1 (positive), so the result is > 0 and we should use $to
4265         #    as the stopping point.
4266         #
4267         #    If $to is greater than $limit, ($limit - $to) is negative,
4268         #    times $delta of 1 (positive), so the result is < 0 and we should
4269         #    use $limit ($#dbline) as the stopping point.
4270         #
4271         # If $delta is negative (going backward), $limit will be 1.
4272         #    If $to is zero, ($limit - $to) will be 1, times $delta of -1
4273         #    (negative) so the result is > 0, and we use $to as the stopping
4274         #    point.
4275         #
4276         #    If $to is less than zero, ($limit - $to) will be positive,
4277         #    times $delta of -1 (negative), so the result is not > 0, and
4278         #    we use $limit (1) as the stopping point.
4279         #
4280         #    If $to is 1, ($limit - $to) will zero, times $delta of -1
4281         #    (negative), still giving zero; the result is not > 0, and
4282         #    we use $limit (1) as the stopping point.
4283         #
4284         #    if $to is >1, ($limit - $to) will be negative, times $delta of -1
4285         #    (negative), giving a positive (>0) value, so we'll set $limit to
4286         #    $to.
4287
4288         $limit = $to if ( $limit - $to ) * $delta > 0;
4289
4290         # The real search loop.
4291         # $i starts at $from (the point we want to start searching from).
4292         # We move through @dbline in the appropriate direction (determined
4293         # by $delta: either -1 (back) or +1 (ahead).
4294         # We stay in as long as we haven't hit an executable line
4295         # ($dbline[$i] == 0 means not executable) and we haven't reached
4296         # the limit yet (test similar to the above).
4297         $i += $delta while $dbline[$i] == 0 and ( $limit - $i ) * $delta > 0;
4298
4299     } ## end if (@_ >= 2)
4300
4301     # If $i points to a line that is executable, return that.
4302     return $i unless $dbline[$i] == 0;
4303
4304     # Format the message and print it: no breakable lines in range.
4305     my ( $pl, $upto ) = ( '', '' );
4306     ( $pl, $upto ) = ( 's', "..$to" ) if @_ >= 2 and $from != $to;
4307
4308     # If there's a filename in filename_error, we'll see it.
4309     # If not, not.
4310     die "Line$pl $from$upto$filename_error not breakable\n";
4311 } ## end sub breakable_line
4312
4313 =head3 breakable_line_in_filename($file, $from, $to) (API)
4314
4315 Like C<breakable_line>, but look in another file.
4316
4317 =cut
4318
4319 sub breakable_line_in_filename {
4320
4321     # Capture the file name.
4322     my ($f) = shift;
4323
4324     # Swap the magic line array over there temporarily.
4325     local *dbline = $main::{ '_<' . $f };
4326
4327     # If there's an error, it's in this other file.
4328     local $filename_error = " of `$f'";
4329
4330     # Find the breakable line.
4331     breakable_line(@_);
4332
4333     # *dbline and $filename_error get restored when this block ends.
4334
4335 } ## end sub breakable_line_in_filename
4336
4337 =head3 break_on_line(lineno, [condition]) (API)
4338
4339 Adds a breakpoint with the specified condition (or 1 if no condition was
4340 specified) to the specified line. Dies if it can't.
4341
4342 =cut
4343
4344 sub break_on_line {
4345     my ( $i, $cond ) = @_;
4346
4347     # Always true if no condition supplied.
4348     $cond = 1 unless @_ >= 2;
4349
4350     my $inii  = $i;
4351     my $after = '';
4352     my $pl    = '';
4353
4354     # Woops, not a breakable line. $filename_error allows us to say
4355     # if it was in a different file.
4356     die "Line $i$filename_error not breakable.\n" if $dbline[$i] == 0;
4357
4358     # Mark this file as having breakpoints in it.
4359     $had_breakpoints{$filename} |= 1;
4360
4361     # If there is an action or condition here already ...
4362     if ( $dbline{$i} ) {
4363
4364         # ... swap this condition for the existing one.
4365         $dbline{$i} =~ s/^[^\0]*/$cond/;
4366     }
4367     else {
4368
4369         # Nothing here - just add the condition.
4370         $dbline{$i} = $cond;
4371     }
4372 } ## end sub break_on_line
4373
4374 =head3 cmd_b_line(line, [condition]) (command)
4375
4376 Wrapper for C<break_on_line>. Prints the failure message if it
4377 doesn't work.
4378
4379 =cut
4380
4381 sub cmd_b_line {
4382     eval { break_on_line(@_); 1 } or do {
4383         local $\ = '';
4384         print $OUT $@ and return;
4385     };
4386 } ## end sub cmd_b_line
4387
4388 =head3 break_on_filename_line(file, line, [condition]) (API)
4389
4390 Switches to the file specified and then calls C<break_on_line> to set
4391 the breakpoint.
4392
4393 =cut
4394
4395 sub break_on_filename_line {
4396     my ( $f, $i, $cond ) = @_;
4397
4398     # Always true if condition left off.
4399     $cond = 1 unless @_ >= 3;
4400
4401     # Switch the magical hash temporarily.
4402     local *dbline = $main::{ '_<' . $f };
4403
4404     # Localize the variables that break_on_line uses to make its message.
4405     local $filename_error = " of `$f'";
4406     local $filename       = $f;
4407
4408     # Add the breakpoint.
4409     break_on_line( $i, $cond );
4410 } ## end sub break_on_filename_line
4411
4412 =head3 break_on_filename_line_range(file, from, to, [condition]) (API)
4413
4414 Switch to another file, search the range of lines specified for an
4415 executable one, and put a breakpoint on the first one you find.
4416
4417 =cut
4418
4419 sub break_on_filename_line_range {
4420     my ( $f, $from, $to, $cond ) = @_;
4421
4422     # Find a breakable line if there is one.
4423     my $i = breakable_line_in_filename( $f, $from, $to );
4424
4425     # Always true if missing.
4426     $cond = 1 unless @_ >= 3;
4427
4428     # Add the breakpoint.
4429     break_on_filename_line( $f, $i, $cond );
4430 } ## end sub break_on_filename_line_range
4431
4432 =head3 subroutine_filename_lines(subname, [condition]) (API)
4433
4434 Search for a subroutine within a given file. The condition is ignored.
4435 Uses C<find_sub> to locate the desired subroutine.
4436
4437 =cut
4438
4439 sub subroutine_filename_lines {
4440     my ( $subname, $cond ) = @_;
4441
4442     # Returned value from find_sub() is fullpathname:startline-endline.
4443     # The match creates the list (fullpathname, start, end). Falling off
4444     # the end of the subroutine returns this implicitly.
4445     find_sub($subname) =~ /^(.*):(\d+)-(\d+)$/;
4446 } ## end sub subroutine_filename_lines
4447
4448 =head3 break_subroutine(subname) (API)
4449
4450 Places a break on the first line possible in the specified subroutine. Uses
4451 C<subroutine_filename_lines> to find the subroutine, and
4452 C<break_on_filename_line_range> to place the break.
4453
4454 =cut
4455
4456 sub break_subroutine {
4457     my $subname = shift;
4458
4459     # Get filename, start, and end.
4460     my ( $file, $s, $e ) = subroutine_filename_lines($subname)
4461       or die "Subroutine $subname not found.\n";
4462
4463     # Null condition changes to '1' (always true).
4464     $cond = 1 unless @_ >= 2;
4465
4466     # Put a break the first place possible in the range of lines
4467     # that make up this subroutine.
4468     break_on_filename_line_range( $file, $s, $e, @_ );
4469 } ## end sub break_subroutine
4470
4471 =head3 cmd_b_sub(subname, [condition]) (command)
4472
4473 We take the incoming subroutine name and fully-qualify it as best we can.
4474
4475 =over 4
4476
4477 =item 1. If it's already fully-qualified, leave it alone.
4478
4479 =item 2. Try putting it in the current package.
4480
4481 =item 3. If it's not there, try putting it in CORE::GLOBAL if it exists there.
4482
4483 =item 4. If it starts with '::', put it in 'main::'.
4484
4485 =back
4486
4487 After all this cleanup, we call C<break_subroutine> to try to set the
4488 breakpoint.
4489
4490 =cut
4491
4492 sub cmd_b_sub {
4493     my ( $subname, $cond ) = @_;
4494
4495     # Add always-true condition if we have none.
4496     $cond = 1 unless @_ >= 2;
4497
4498     # If the subname isn't a code reference, qualify it so that
4499     # break_subroutine() will work right.
4500     unless ( ref $subname eq 'CODE' ) {
4501
4502         # Not Perl4.
4503         $subname =~ s/\'/::/g;
4504         my $s = $subname;
4505
4506         # Put it in this package unless it's already qualified.
4507         $subname = "${'package'}::" . $subname
4508           unless $subname =~ /::/;
4509
4510         # Requalify it into CORE::GLOBAL if qualifying it into this
4511         # package resulted in its not being defined, but only do so
4512         # if it really is in CORE::GLOBAL.
4513         $subname = "CORE::GLOBAL::$s"
4514           if not defined &$subname
4515           and $s !~ /::/
4516           and defined &{"CORE::GLOBAL::$s"};
4517
4518         # Put it in package 'main' if it has a leading ::.
4519         $subname = "main" . $subname if substr( $subname, 0, 2 ) eq "::";
4520
4521     } ## end unless (ref $subname eq 'CODE')
4522
4523     # Try to set the breakpoint.
4524     eval { break_subroutine( $subname, $cond ); 1 } or do {
4525         local $\ = '';
4526         print $OUT $@ and return;
4527       }
4528 } ## end sub cmd_b_sub
4529
4530 =head3 C<cmd_B> - delete breakpoint(s) (command)
4531
4532 The command mostly parses the command line and tries to turn the argument
4533 into a line spec. If it can't, it uses the current line. It then calls
4534 C<delete_breakpoint> to actually do the work.
4535
4536 If C<*> is  specified, C<cmd_B> calls C<delete_breakpoint> with no arguments,
4537 thereby deleting all the breakpoints.
4538
4539 =cut
4540
4541 sub cmd_B {
4542     my $cmd = shift;
4543
4544     # No line spec? Use dbline.
4545     # If there is one, use it if it's non-zero, or wipe it out if it is.
4546     my $line   = ( $_[0] =~ /^\./ ) ? $dbline : shift || '';
4547     my $dbline = shift;
4548
4549     # If the line was dot, make the line the current one.
4550     $line =~ s/^\./$dbline/;
4551
4552     # If it's * we're deleting all the breakpoints.
4553     if ( $line eq '*' ) {
4554         eval { &delete_breakpoint(); 1 } or print $OUT $@ and return;
4555     }
4556
4557     # If there is a line spec, delete the breakpoint on that line.
4558     elsif ( $line =~ /^(\S.*)/ ) {
4559         eval { &delete_breakpoint( $line || $dbline ); 1 } or do {
4560             local $\ = '';
4561             print $OUT $@ and return;
4562         };
4563     } ## end elsif ($line =~ /^(\S.*)/)
4564
4565     # No line spec.
4566     else {
4567         print $OUT
4568           "Deleting a breakpoint requires a line number, or '*' for all\n"
4569           ;    # hint
4570     }
4571 } ## end sub cmd_B
4572
4573 =head3 delete_breakpoint([line]) (API)
4574
4575 This actually does the work of deleting either a single breakpoint, or all
4576 of them.
4577
4578 For a single line, we look for it in C<@dbline>. If it's nonbreakable, we
4579 just drop out with a message saying so. If it is, we remove the condition
4580 part of the 'condition\0action' that says there's a breakpoint here. If,
4581 after we've done that, there's nothing left, we delete the corresponding
4582 line in C<%dbline> to signal that no action needs to be taken for this line.
4583
4584 For all breakpoints, we iterate through the keys of C<%had_breakpoints>,
4585 which lists all currently-loaded files which have breakpoints. We then look
4586 at each line in each of these files, temporarily switching the C<%dbline>
4587 and C<@dbline> structures to point to the files in question, and do what
4588 we did in the single line case: delete the condition in C<@dbline>, and
4589 delete the key in C<%dbline> if nothing's left.
4590
4591 We then wholesale delete C<%postponed>, C<%postponed_file>, and
4592 C<%break_on_load>, because these structures contain breakpoints for files
4593 and code that haven't been loaded yet. We can just kill these off because there
4594 are no magical debugger structures associated with them.
4595
4596 =cut
4597
4598 sub delete_breakpoint {
4599     my $i = shift;
4600
4601     # If we got a line, delete just that one.
4602     if ( defined($i) ) {
4603
4604         # Woops. This line wasn't breakable at all.
4605         die "Line $i not breakable.\n" if $dbline[$i] == 0;
4606
4607         # Kill the condition, but leave any action.
4608         $dbline{$i} =~ s/^[^\0]*//;
4609
4610         # Remove the entry entirely if there's no action left.
4611         delete $dbline{$i} if $dbline{$i} eq '';
4612     }
4613
4614     # No line; delete them all.
4615     else {
4616         print $OUT "Deleting all breakpoints...\n";
4617
4618         # %had_breakpoints lists every file that had at least one
4619         # breakpoint in it.
4620         for my $file ( keys %had_breakpoints ) {
4621
4622             # Switch to the desired file temporarily.
4623             local *dbline = $main::{ '_<' . $file };
4624
4625             my $max = $#dbline;
4626             my $was;
4627
4628             # For all lines in this file ...
4629             for ( $i = 1 ; $i <= $max ; $i++ ) {
4630
4631                 # If there's a breakpoint or action on this line ...
4632                 if ( defined $dbline{$i} ) {
4633
4634                     # ... remove the breakpoint.
4635                     $dbline{$i} =~ s/^[^\0]+//;
4636                     if ( $dbline{$i} =~ s/^\0?$// ) {
4637
4638                         # Remove the entry altogether if no action is there.
4639                         delete $dbline{$i};
4640                     }
4641                 } ## end if (defined $dbline{$i...
4642             } ## end for ($i = 1 ; $i <= $max...
4643
4644             # If, after we turn off the "there were breakpoints in this file"
4645             # bit, the entry in %had_breakpoints for this file is zero,
4646             # we should remove this file from the hash.
4647             if ( not $had_breakpoints{$file} &= ~1 ) {
4648                 delete $had_breakpoints{$file};
4649             }
4650         } ## end for my $file (keys %had_breakpoints)
4651
4652         # Kill off all the other breakpoints that are waiting for files that
4653         # haven't been loaded yet.
4654         undef %postponed;
4655         undef %postponed_file;
4656         undef %break_on_load;
4657     } ## end else [ if (defined($i))
4658 } ## end sub delete_breakpoint
4659
4660 =head3 cmd_stop (command)
4661
4662 This is meant to be part of the new command API, but it isn't called or used
4663 anywhere else in the debugger. XXX It is probably meant for use in development
4664 of new commands.
4665
4666 =cut
4667
4668 sub cmd_stop {    # As on ^C, but not signal-safy.
4669     $signal = 1;
4670 }
4671
4672 =head3 C<cmd_h> - help command (command)
4673
4674 Does the work of either
4675
4676 =over 4
4677
4678 =item * Showing all the debugger help
4679
4680 =item * Showing help for a specific command
4681
4682 =back
4683
4684 =cut
4685
4686 sub cmd_h {
4687     my $cmd = shift;
4688
4689     # If we have no operand, assume null.
4690     my $line = shift || '';
4691
4692     # 'h h'. Print the long-format help.
4693     if ( $line =~ /^h\s*/ ) {
4694         print_help($help);
4695     }
4696
4697     # 'h <something>'. Search for the command and print only its help.
4698     elsif ( $line =~ /^(\S.*)$/ ) {
4699
4700         # support long commands; otherwise bogus errors
4701         # happen when you ask for h on <CR> for example
4702         my $asked = $1;    # the command requested
4703                            # (for proper error message)
4704
4705         my $qasked = quotemeta($asked);    # for searching; we don't
4706                                            # want to use it as a pattern.
4707                                            # XXX: finds CR but not <CR>
4708
4709         # Search the help string for the command.
4710         if (
4711             $help =~ /^                    # Start of a line
4712                       <?                   # Optional '<'
4713                       (?:[IB]<)            # Optional markup
4714                       $qasked              # The requested command
4715                      /mx
4716           )
4717         {
4718
4719             # It's there; pull it out and print it.
4720             while (
4721                 $help =~ /^
4722                               (<?            # Optional '<'
4723                                  (?:[IB]<)   # Optional markup
4724                                  $qasked     # The command
4725                                  ([\s\S]*?)  # Description line(s)
4726                               \n)            # End of last description line
4727                               (?!\s)         # Next line not starting with
4728                                              # whitespace
4729                              /mgx
4730               )
4731             {
4732                 print_help($1);
4733             }
4734         }
4735
4736         # Not found; not a debugger command.
4737         else {
4738             print_help("B<$asked> is not a debugger command.\n");
4739         }
4740     } ## end elsif ($line =~ /^(\S.*)$/)
4741
4742     # 'h' - print the summary help.
4743     else {
4744         print_help($summary);
4745     }
4746 } ## end sub cmd_h
4747
4748 =head3 C<cmd_i> - inheritance display
4749
4750 Display the (nested) parentage of the module or object given.
4751
4752 =cut
4753
4754 sub cmd_i {
4755     my $cmd  = shift;
4756     my $line = shift;
4757     eval { require Class::ISA };
4758     if ($@) {
4759         &warn( $@ =~ /locate/
4760             ? "Class::ISA module not found - please install\n"
4761             : $@ );
4762     }
4763     else {
4764       ISA:
4765         foreach my $isa ( split( /\s+/, $line ) ) {
4766                 $evalarg = $isa;
4767                         ($isa) = &eval;
4768             no strict 'refs';
4769             print join(
4770                 ', ',
4771                 map {    # snaffled unceremoniously from Class::ISA
4772                     "$_"
4773                       . (
4774                         defined( ${"$_\::VERSION"} )
4775                         ? ' ' . ${"$_\::VERSION"}
4776                         : undef )
4777                   } Class::ISA::self_and_super_path(ref($isa) || $isa)
4778             );
4779             print "\n";
4780         }
4781     }
4782 } ## end sub cmd_i
4783
4784 =head3 C<cmd_l> - list lines (command)
4785
4786 Most of the command is taken up with transforming all the different line
4787 specification syntaxes into 'start-stop'. After that is done, the command
4788 runs a loop over C<@dbline> for the specified range of lines. It handles
4789 the printing of each line and any markers (C<==E<gt>> for current line,
4790 C<b> for break on this line, C<a> for action on this line, C<:> for this
4791 line breakable).
4792
4793 We save the last line listed in the C<$start> global for further listing
4794 later.
4795
4796 =cut
4797
4798 sub cmd_l {
4799     my $current_line = $line;
4800     my $cmd  = shift;
4801     my $line = shift;
4802
4803     # If this is '-something', delete any spaces after the dash.
4804     $line =~ s/^-\s*$/-/;
4805
4806     # If the line is '$something', assume this is a scalar containing a
4807     # line number.
4808     if ( $line =~ /^(\$.*)/s ) {
4809
4810         # Set up for DB::eval() - evaluate in *user* context.
4811         $evalarg = $1;
4812         # $evalarg = $2;
4813         my ($s) = &eval;
4814
4815         # Ooops. Bad scalar.
4816         print( $OUT "Error: $@\n" ), next CMD if $@;
4817
4818         # Good scalar. If it's a reference, find what it points to.
4819         $s = CvGV_name($s);
4820         print( $OUT "Interpreted as: $1 $s\n" );
4821         $line = "$1 $s";
4822
4823         # Call self recursively to really do the command.
4824         &cmd_l( 'l', $s );
4825     } ## end if ($line =~ /^(\$.*)/s)
4826
4827     # l name. Try to find a sub by that name.
4828     elsif ( $line =~ /^([\':A-Za-z_][\':\w]*(\[.*\])?)/s ) {
4829         my $s = $subname = $1;
4830
4831         # De-Perl4.
4832         $subname =~ s/\'/::/;
4833
4834         # Put it in this package unless it starts with ::.
4835         $subname = $package . "::" . $subname unless $subname =~ /::/;
4836
4837         # Put it in CORE::GLOBAL if t doesn't start with :: and
4838         # it doesn't live in this package and it lives in CORE::GLOBAL.
4839         $subname = "CORE::GLOBAL::$s"
4840           if not defined &$subname
4841           and $s !~ /::/
4842           and defined &{"CORE::GLOBAL::$s"};
4843
4844         # Put leading '::' names into 'main::'.
4845         $subname = "main" . $subname if substr( $subname, 0, 2 ) eq "::";
4846
4847         # Get name:start-stop from find_sub, and break this up at
4848         # colons.
4849         @pieces = split( /:/, find_sub($subname) || $sub{$subname} );
4850
4851         # Pull off start-stop.
4852         $subrange = pop @pieces;
4853
4854         # If the name contained colons, the split broke it up.
4855         # Put it back together.
4856         $file = join( ':', @pieces );
4857
4858         # If we're not in that file, switch over to it.
4859         if ( $file ne $filename ) {
4860             print $OUT "Switching to file '$file'.\n"
4861               unless $slave_editor;
4862
4863             # Switch debugger's magic structures.
4864             *dbline   = $main::{ '_<' . $file };
4865             $max      = $#dbline;
4866             $filename = $file;
4867         } ## end if ($file ne $filename)
4868
4869         # Subrange is 'start-stop'. If this is less than a window full,
4870         # swap it to 'start+', which will list a window from the start point.
4871         if ($subrange) {
4872             if ( eval($subrange) < -$window ) {
4873                 $subrange =~ s/-.*/+/;
4874             }
4875
4876             # Call self recursively to list the range.
4877             $line = $subrange;
4878             &cmd_l( 'l', $subrange );
4879         } ## end if ($subrange)
4880
4881         # Couldn't find it.
4882         else {
4883             print $OUT "Subroutine $subname not found.\n";
4884         }
4885     } ## end elsif ($line =~ /^([\':A-Za-z_][\':\w]*(\[.*\])?)/s)
4886
4887     # Bare 'l' command.
4888     elsif ( $line =~ /^\s*$/ ) {
4889
4890         # Compute new range to list.
4891         $incr = $window - 1;
4892         $line = $start . '-' . ( $start + $incr );
4893
4894         # Recurse to do it.
4895         &cmd_l( 'l', $line );
4896     }
4897
4898     # l [start]+number_of_lines
4899     elsif ( $line =~ /^(\d*)\+(\d*)$/ ) {
4900
4901         # Don't reset start for 'l +nnn'.
4902         $start = $1 if $1;
4903
4904         # Increment for list. Use window size if not specified.
4905         # (Allows 'l +' to work.)
4906         $incr = $2;
4907         $incr = $window - 1 unless $incr;
4908
4909         # Create a line range we'll understand, and recurse to do it.
4910         $line = $start . '-' . ( $start + $incr );
4911         &cmd_l( 'l', $line );
4912     } ## end elsif ($line =~ /^(\d*)\+(\d*)$/)
4913
4914     # l start-stop or l start,stop
4915     elsif ( $line =~ /^((-?[\d\$\.]+)([-,]([\d\$\.]+))?)?/ ) {
4916
4917         # Determine end point; use end of file if not specified.
4918         $end = ( !defined $2 ) ? $max : ( $4 ? $4 : $2 );
4919
4920         # Go on to the end, and then stop.
4921         $end = $max if $end > $max;
4922
4923         # Determine start line.
4924         $i    = $2;
4925         $i    = $line if $i eq '.';
4926         $i    = 1 if $i < 1;
4927         $incr = $end - $i;
4928
4929         # If we're running under a slave editor, force it to show the lines.
4930         if ($slave_editor) {
4931             print $OUT "\032\032$filename:$i:0\n";
4932             $i = $end;
4933         }
4934
4935         # We're doing it ourselves. We want to show the line and special
4936         # markers for:
4937         # - the current line in execution
4938         # - whether a line is breakable or not
4939         # - whether a line has a break or not
4940         # - whether a line has an action or not
4941         else {
4942             for ( ; $i <= $end ; $i++ ) {
4943
4944                 # Check for breakpoints and actions.
4945                 my ( $stop, $action );
4946                 ( $stop, $action ) = split( /\0/, $dbline{$i} )
4947                   if $dbline{$i};
4948
4949                 # ==> if this is the current line in execution,
4950                 # : if it's breakable.
4951                 $arrow =
4952                   ( $i == $current_line and $filename eq $filename_ini )
4953                   ? '==>'
4954                   : ( $dbline[$i] + 0 ? ':' : ' ' );
4955
4956                 # Add break and action indicators.
4957                 $arrow .= 'b' if $stop;
4958                 $arrow .= 'a' if $action;
4959
4960                 # Print the line.
4961                 print $OUT "$i$arrow\t", $dbline[$i];
4962
4963                 # Move on to the next line. Drop out on an interrupt.
4964                 $i++, last if $signal;
4965             } ## end for (; $i <= $end ; $i++)
4966
4967             # Line the prompt up; print a newline if the last line listed
4968             # didn't have a newline.
4969             print $OUT "\n" unless $dbline[ $i - 1 ] =~ /\n$/;
4970         } ## end else [ if ($slave_editor)
4971
4972         # Save the point we last listed to in case another relative 'l'
4973         # command is desired. Don't let it run off the end.
4974         $start = $i;
4975         $start = $max if $start > $max;
4976     } ## end elsif ($line =~ /^((-?[\d\$\.]+)([-,]([\d\$\.]+))?)?/)
4977 } ## end sub cmd_l
4978
4979 =head3 C<cmd_L> - list breakpoints, actions, and watch expressions (command)
4980
4981 To list breakpoints, the command has to look determine where all of them are
4982 first. It starts a C<%had_breakpoints>, which tells us what all files have
4983 breakpoints and/or actions. For each file, we switch the C<*dbline> glob (the
4984 magic source and breakpoint data structures) to the file, and then look
4985 through C<%dbline> for lines with breakpoints and/or actions, listing them
4986 out. We look through C<%postponed> not-yet-compiled subroutines that have
4987 breakpoints, and through C<%postponed_file> for not-yet-C<require>'d files
4988 that have breakpoints.
4989
4990 Watchpoints are simpler: we just list the entries in C<@to_watch>.
4991
4992 =cut
4993
4994 sub cmd_L {
4995     my $cmd = shift;
4996
4997     # If no argument, list everything. Pre-5.8.0 version always lists
4998     # everything
4999     my $arg = shift || 'abw';
5000     $arg = 'abw' unless $CommandSet eq '580';    # sigh...
5001
5002     # See what is wanted.
5003     my $action_wanted = ( $arg =~ /a/ ) ? 1 : 0;
5004     my $break_wanted  = ( $arg =~ /b/ ) ? 1 : 0;
5005     my $watch_wanted  = ( $arg =~ /w/ ) ? 1 : 0;
5006
5007     # Breaks and actions are found together, so we look in the same place
5008     # for both.
5009     if ( $break_wanted or $action_wanted ) {
5010
5011         # Look in all the files with breakpoints...
5012         for my $file ( keys %had_breakpoints ) {
5013
5014             # Temporary switch to this file.
5015             local *dbline = $main::{ '_<' . $file };
5016
5017             # Set up to look through the whole file.
5018             my $max = $#dbline;
5019             my $was;    # Flag: did we print something
5020                         # in this file?
5021
5022             # For each line in the file ...
5023             for ( $i = 1 ; $i <= $max ; $i++ ) {
5024
5025                 # We've got something on this line.
5026                 if ( defined $dbline{$i} ) {
5027
5028                     # Print the header if we haven't.
5029                     print $OUT "$file:\n" unless $was++;
5030
5031                     # Print the line.
5032                     print $OUT " $i:\t", $dbline[$i];
5033
5034                     # Pull out the condition and the action.
5035                     ( $stop, $action ) = split( /\0/, $dbline{$i} );
5036
5037                     # Print the break if there is one and it's wanted.
5038                     print $OUT "   break if (", $stop, ")\n"
5039                       if $stop
5040                       and $break_wanted;
5041
5042                     # Print the action if there is one and it's wanted.
5043                     print $OUT "   action:  ", $action, "\n"
5044                       if $action
5045                       and $action_wanted;
5046
5047                     # Quit if the user hit interrupt.
5048                     last if $signal;
5049                 } ## end if (defined $dbline{$i...
5050             } ## end for ($i = 1 ; $i <= $max...
5051         } ## end for my $file (keys %had_breakpoints)
5052     } ## end if ($break_wanted or $action_wanted)
5053
5054     # Look for breaks in not-yet-compiled subs:
5055     if ( %postponed and $break_wanted ) {
5056         print $OUT "Postponed breakpoints in subroutines:\n";
5057         my $subname;
5058         for $subname ( keys %postponed ) {
5059             print $OUT " $subname\t$postponed{$subname}\n";
5060             last if $signal;
5061         }
5062     } ## end if (%postponed and $break_wanted)
5063
5064     # Find files that have not-yet-loaded breaks:
5065     my @have = map {    # Combined keys
5066         keys %{ $postponed_file{$_} }
5067     } keys %postponed_file;
5068
5069     # If there are any, list them.
5070     if ( @have and ( $break_wanted or $action_wanted ) ) {
5071         print $OUT "Postponed breakpoints in files:\n";
5072         my ( $file, $line );
5073
5074         for $file ( keys %postponed_file ) {
5075             my $db = $postponed_file{$file};
5076             print $OUT " $file:\n";
5077             for $line ( sort { $a <=> $b } keys %$db ) {
5078                 print $OUT "  $line:\n";
5079                 my ( $stop, $action ) = split( /\0/, $$db{$line} );
5080                 print $OUT "    break if (", $stop, ")\n"
5081                   if $stop
5082                   and $break_wanted;
5083                 print $OUT "    action:  ", $action, "\n"
5084                   if $action
5085                   and $action_wanted;
5086                 last if $signal;
5087             } ## end for $line (sort { $a <=>...
5088             last if $signal;
5089         } ## end for $file (keys %postponed_file)
5090     } ## end if (@have and ($break_wanted...
5091     if ( %break_on_load and $break_wanted ) {
5092         print $OUT "Breakpoints on load:\n";
5093         my $file;
5094         for $file ( keys %break_on_load ) {
5095             print $OUT " $file\n";
5096             last if $signal;
5097         }
5098     } ## end if (%break_on_load and...
5099     if ($watch_wanted) {
5100         if ( $trace & 2 ) {
5101             print $OUT "Watch-expressions:\n" if @to_watch;
5102             for my $expr (@to_watch) {
5103                 print $OUT " $expr\n";
5104                 last if $signal;
5105             }
5106         } ## end if ($trace & 2)
5107     } ## end if ($watch_wanted)
5108 } ## end sub cmd_L
5109
5110 =head3 C<cmd_M> - list modules (command)
5111
5112 Just call C<list_modules>.
5113
5114 =cut
5115
5116 sub cmd_M {
5117     &list_modules();
5118 }
5119
5120 =head3 C<cmd_o> - options (command)
5121
5122 If this is just C<o> by itself, we list the current settings via
5123 C<dump_option>. If there's a nonblank value following it, we pass that on to
5124 C<parse_options> for processing.
5125
5126 =cut
5127
5128 sub cmd_o {
5129     my $cmd = shift;
5130     my $opt = shift || '';    # opt[=val]
5131
5132     # Nonblank. Try to parse and process.
5133     if ( $opt =~ /^(\S.*)/ ) {
5134         &parse_options($1);
5135     }
5136
5137     # Blank. List the current option settings.
5138     else {
5139         for (@options) {
5140             &dump_option($_);
5141         }
5142     }
5143 } ## end sub cmd_o
5144
5145 =head3 C<cmd_O> - nonexistent in 5.8.x (command)
5146
5147 Advises the user that the O command has been renamed.
5148
5149 =cut
5150
5151 sub cmd_O {
5152     print $OUT "The old O command is now the o command.\n";             # hint
5153     print $OUT "Use 'h' to get current command help synopsis or\n";     #
5154     print $OUT "use 'o CommandSet=pre580' to revert to old usage\n";    #
5155 }
5156
5157 =head3 C<cmd_v> - view window (command)
5158
5159 Uses the C<$preview> variable set in the second C<BEGIN> block (q.v.) to
5160 move back a few lines to list the selected line in context. Uses C<cmd_l>
5161 to do the actual listing after figuring out the range of line to request.
5162
5163 =cut
5164
5165 sub cmd_v {
5166     my $cmd  = shift;
5167     my $line = shift;
5168
5169     # Extract the line to list around. (Astute readers will have noted that
5170     # this pattern will match whether or not a numeric line is specified,
5171     # which means that we'll always enter this loop (though a non-numeric
5172     # argument results in no action at all)).
5173     if ( $line =~ /^(\d*)$/ ) {
5174
5175         # Total number of lines to list (a windowful).
5176         $incr = $window - 1;
5177
5178         # Set the start to the argument given (if there was one).
5179         $start = $1 if $1;
5180
5181         # Back up by the context amount.
5182         $start -= $preview;
5183
5184         # Put together a linespec that cmd_l will like.
5185         $line = $start . '-' . ( $start + $incr );
5186
5187         # List the lines.
5188         &cmd_l( 'l', $line );
5189     } ## end if ($line =~ /^(\d*)$/)
5190 } ## end sub cmd_v
5191
5192 =head3 C<cmd_w> - add a watch expression (command)
5193
5194 The 5.8 version of this command adds a watch expression if one is specified;
5195 it does nothing if entered with no operands.
5196
5197 We extract the expression, save it, evaluate it in the user's context, and
5198 save the value. We'll re-evaluate it each time the debugger passes a line,
5199 and will stop (see the code at the top of the command loop) if the value
5200 of any of the expressions changes.
5201
5202 =cut
5203
5204 sub cmd_w {
5205     my $cmd = shift;
5206
5207     # Null expression if no arguments.
5208     my $expr = shift || '';
5209
5210     # If expression is not null ...
5211     if ( $expr =~ /^(\S.*)/ ) {
5212
5213         # ... save it.
5214         push @to_watch, $expr;
5215
5216         # Parameterize DB::eval and call it to get the expression's value
5217         # in the user's context. This version can handle expressions which
5218         # return a list value.
5219         $evalarg = $expr;
5220         my ($val) = join( ' ', &eval );
5221         $val = ( defined $val ) ? "'$val'" : 'undef';
5222
5223         # Save the current value of the expression.
5224         push @old_watch, $val;
5225
5226         # We are now watching expressions.
5227         $trace |= 2;
5228     } ## end if ($expr =~ /^(\S.*)/)
5229
5230     # You have to give one to get one.
5231     else {
5232         print $OUT "Adding a watch-expression requires an expression\n";  # hint
5233     }
5234 } ## end sub cmd_w
5235
5236 =head3 C<cmd_W> - delete watch expressions (command)
5237
5238 This command accepts either a watch expression to be removed from the list
5239 of watch expressions, or C<*> to delete them all.
5240
5241 If C<*> is specified, we simply empty the watch expression list and the
5242 watch expression value list. We also turn off the bit that says we've got
5243 watch expressions.
5244
5245 If an expression (or partial expression) is specified, we pattern-match
5246 through the expressions and remove the ones that match. We also discard
5247 the corresponding values. If no watch expressions are left, we turn off
5248 the 'watching expressions' bit.
5249
5250 =cut
5251
5252 sub cmd_W {
5253     my $cmd  = shift;
5254     my $expr = shift || '';
5255
5256     # Delete them all.
5257     if ( $expr eq '*' ) {
5258
5259         # Not watching now.
5260         $trace &= ~2;
5261
5262         print $OUT "Deleting all watch expressions ...\n";
5263
5264         # And all gone.
5265         @to_watch = @old_watch = ();
5266     }
5267
5268     # Delete one of them.
5269     elsif ( $expr =~ /^(\S.*)/ ) {
5270
5271         # Where we are in the list.
5272         my $i_cnt = 0;
5273
5274         # For each expression ...
5275         foreach (@to_watch) {
5276             my $val = $to_watch[$i_cnt];
5277
5278             # Does this one match the command argument?
5279             if ( $val eq $expr ) {    # =~ m/^\Q$i$/) {
5280                                       # Yes. Turn it off, and its value too.
5281                 splice( @to_watch,  $i_cnt, 1 );
5282                 splice( @old_watch, $i_cnt, 1 );
5283             }
5284             $i_cnt++;
5285         } ## end foreach (@to_watch)
5286
5287         # We don't bother to turn watching off because
5288         #  a) we don't want to stop calling watchfunction() it it exists
5289         #  b) foreach over a null list doesn't do anything anyway
5290
5291     } ## end elsif ($expr =~ /^(\S.*)/)
5292
5293     # No command arguments entered.
5294     else {
5295         print $OUT
5296           "Deleting a watch-expression requires an expression, or '*' for all\n"
5297           ;    # hint
5298     }
5299 } ## end sub cmd_W
5300
5301 ### END of the API section
5302
5303 =head1 SUPPORT ROUTINES
5304
5305 These are general support routines that are used in a number of places
5306 throughout the debugger.
5307
5308 =item cmd_P
5309
5310 Something to do with assertions
5311
5312 =cut
5313
5314 sub cmd_P {
5315         unless ($ini_assertion) {
5316                 print $OUT "Assertions not supported in this Perl interpreter\n";
5317         } else {
5318                 if ( $cmd =~ /^.\b\s*([+-]?)\s*(~?)\s*(\w+(\s*\|\s*\w+)*)\s*$/ ) {
5319                         my ( $how, $neg, $flags ) = ( $1, $2, $3 );
5320                         my $acu = parse_DollarCaretP_flags($flags);
5321                         if ( defined $acu ) {
5322                                 $acu = ~$acu if $neg;
5323                                 if ( $how eq '+' ) { $^P |= $acu }
5324                                 elsif ( $how eq '-' ) { $^P &= ~$acu }
5325                                 else { $^P = $acu }
5326                         }
5327
5328                         # else { print $OUT "undefined acu\n" }
5329                 }
5330                 my $expanded = expand_DollarCaretP_flags($^P);
5331                 print $OUT "Internal Perl debugger flags:\n\$^P=$expanded\n";
5332                 $expanded;
5333         }
5334 }
5335
5336 =head2 save
5337
5338 save() saves the user's versions of globals that would mess us up in C<@saved>,
5339 and installs the versions we like better.
5340
5341 =cut
5342
5343 sub save {
5344
5345     # Save eval failure, command failure, extended OS error, output field
5346     # separator, input record separator, output record separator and
5347     # the warning setting.
5348     @saved = ( $@, $!, $^E, $,, $/, $\, $^W );
5349
5350     $,  = "";      # output field separator is null string
5351     $/  = "\n";    # input record separator is newline
5352     $\  = "";      # output record separator is null string
5353     $^W = 0;       # warnings are off
5354 } ## end sub save
5355
5356 =head2 C<print_lineinfo> - show where we are now
5357
5358 print_lineinfo prints whatever it is that it is handed; it prints it to the
5359 C<$LINEINFO> filehandle instead of just printing it to STDOUT. This allows
5360 us to feed line information to a slave editor without messing up the
5361 debugger output.
5362
5363 =cut
5364
5365 sub print_lineinfo {
5366
5367     # Make the terminal sensible if we're not the primary debugger.
5368     resetterm(1) if $LINEINFO eq $OUT and $term_pid != $$;
5369     local $\ = '';
5370     local $, = '';
5371     print $LINEINFO @_;
5372 } ## end sub print_lineinfo
5373
5374 =head2 C<postponed_sub>
5375
5376 Handles setting postponed breakpoints in subroutines once they're compiled.
5377 For breakpoints, we use C<DB::find_sub> to locate the source file and line
5378 range for the subroutine, then mark the file as having a breakpoint,
5379 temporarily switch the C<*dbline> glob over to the source file, and then
5380 search the given range of lines to find a breakable line. If we find one,
5381 we set the breakpoint on it, deleting the breakpoint from C<%postponed>.
5382
5383 =cut
5384
5385 # The following takes its argument via $evalarg to preserve current @_
5386
5387 sub postponed_sub {
5388
5389     # Get the subroutine name.
5390     my $subname = shift;
5391
5392     # If this is a 'break +<n> if <condition>' ...
5393     if ( $postponed{$subname} =~ s/^break\s([+-]?\d+)\s+if\s// ) {
5394
5395         # If there's no offset, use '+0'.
5396         my $offset = $1 || 0;
5397
5398         # find_sub's value is 'fullpath-filename:start-stop'. It's
5399         # possible that the filename might have colons in it too.
5400         my ( $file, $i ) = ( find_sub($subname) =~ /^(.*):(\d+)-.*$/ );
5401         if ($i) {
5402
5403             # We got the start line. Add the offset '+<n>' from
5404             # $postponed{subname}.
5405             $i += $offset;
5406
5407             # Switch to the file this sub is in, temporarily.
5408             local *dbline = $main::{ '_<' . $file };
5409
5410             # No warnings, please.
5411             local $^W = 0;    # != 0 is magical below
5412
5413             # This file's got a breakpoint in it.
5414             $had_breakpoints{$file} |= 1;
5415
5416             # Last line in file.
5417             my $max = $#dbline;
5418
5419             # Search forward until we hit a breakable line or get to
5420             # the end of the file.
5421             ++$i until $dbline[$i] != 0 or $i >= $max;
5422
5423             # Copy the breakpoint in and delete it from %postponed.
5424             $dbline{$i} = delete $postponed{$subname};
5425         } ## end if ($i)
5426
5427         # find_sub didn't find the sub.
5428         else {
5429             local $\ = '';
5430             print $OUT "Subroutine $subname not found.\n";
5431         }
5432         return;
5433     } ## end if ($postponed{$subname...
5434     elsif ( $postponed{$subname} eq 'compile' ) { $signal = 1 }
5435
5436     #print $OUT "In postponed_sub for `$subname'.\n";
5437 } ## end sub postponed_sub
5438
5439 =head2 C<postponed>
5440
5441 Called after each required file is compiled, but before it is executed;
5442 also called if the name of a just-compiled subroutine is a key of
5443 C<%postponed>. Propagates saved breakpoints (from C<b compile>, C<b load>,
5444 etc.) into the just-compiled code.
5445
5446 If this is a C<require>'d file, the incoming parameter is the glob
5447 C<*{"_<$filename"}>, with C<$filename> the name of the C<require>'d file.
5448
5449 If it's a subroutine, the incoming parameter is the subroutine name.
5450
5451 =cut
5452
5453 sub postponed {
5454
5455     # If there's a break, process it.
5456     if ($ImmediateStop) {
5457
5458         # Right, we've stopped. Turn it off.
5459         $ImmediateStop = 0;
5460
5461         # Enter the command loop when DB::DB gets called.
5462         $signal = 1;
5463     }
5464
5465     # If this is a subroutine, let postponed_sub() deal with it.
5466     return &postponed_sub unless ref \$_[0] eq 'GLOB';
5467
5468     # Not a subroutine. Deal with the file.
5469     local *dbline = shift;
5470     my $filename = $dbline;
5471     $filename =~ s/^_<//;
5472     local $\ = '';
5473     $signal = 1, print $OUT "'$filename' loaded...\n"
5474       if $break_on_load{$filename};
5475     print_lineinfo( ' ' x $stack_depth, "Package $filename.\n" ) if $frame;
5476
5477     # Do we have any breakpoints to put in this file?
5478     return unless $postponed_file{$filename};
5479
5480     # Yes. Mark this file as having breakpoints.
5481     $had_breakpoints{$filename} |= 1;
5482
5483     # "Cannot be done: unsufficient magic" - we can't just put the
5484     # breakpoints saved in %postponed_file into %dbline by assigning
5485     # the whole hash; we have to do it one item at a time for the
5486     # breakpoints to be set properly.
5487     #%dbline = %{$postponed_file{$filename}};
5488
5489     # Set the breakpoints, one at a time.
5490     my $key;
5491
5492     for $key ( keys %{ $postponed_file{$filename} } ) {
5493
5494         # Stash the saved breakpoint into the current file's magic line array.
5495         $dbline{$key} = ${ $postponed_file{$filename} }{$key};
5496     }
5497
5498     # This file's been compiled; discard the stored breakpoints.
5499     delete $postponed_file{$filename};
5500
5501 } ## end sub postponed
5502
5503 =head2 C<dumpit>
5504
5505 C<dumpit> is the debugger's wrapper around dumpvar.pl.
5506
5507 It gets a filehandle (to which C<dumpvar.pl>'s output will be directed) and
5508 a reference to a variable (the thing to be dumped) as its input.
5509
5510 The incoming filehandle is selected for output (C<dumpvar.pl> is printing to
5511 the currently-selected filehandle, thank you very much). The current
5512 values of the package globals C<$single> and C<$trace> are backed up in
5513 lexicals, and they are turned off (this keeps the debugger from trying
5514 to single-step through C<dumpvar.pl> (I think.)). C<$frame> is localized to
5515 preserve its current value and it is set to zero to prevent entry/exit
5516 messages from printing, and C<$doret> is localized as well and set to -2 to
5517 prevent return values from being shown.
5518
5519 C<dumpit()> then checks to see if it needs to load C<dumpvar.pl> and
5520 tries to load it (note: if you have a C<dumpvar.pl>  ahead of the
5521 installed version in @INC, yours will be used instead. Possible security
5522 problem?).
5523
5524 It then checks to see if the subroutine C<main::dumpValue> is now defined
5525 (it should have been defined by C<dumpvar.pl>). If it has, C<dumpit()>
5526 localizes the globals necessary for things to be sane when C<main::dumpValue()>
5527 is called, and picks up the variable to be dumped from the parameter list.
5528
5529 It checks the package global C<%options> to see if there's a C<dumpDepth>
5530 specified. If not, -1 is assumed; if so, the supplied value gets passed on to
5531 C<dumpvar.pl>. This tells C<dumpvar.pl> where to leave off when dumping a
5532 structure: -1 means dump everything.
5533
5534 C<dumpValue()> is then called if possible; if not, C<dumpit()>just prints a
5535 warning.
5536
5537 In either case, C<$single>, C<$trace>, C<$frame>, and C<$doret> are restored
5538 and we then return to the caller.
5539
5540 =cut
5541
5542 sub dumpit {
5543
5544     # Save the current output filehandle and switch to the one
5545     # passed in as the first parameter.
5546     local ($savout) = select(shift);
5547
5548     # Save current settings of $single and $trace, and then turn them off.
5549     my $osingle = $single;
5550     my $otrace  = $trace;
5551     $single = $trace = 0;
5552
5553     # XXX Okay, what do $frame and $doret do, again?
5554     local $frame = 0;
5555     local $doret = -2;
5556
5557     # Load dumpvar.pl unless we've already got the sub we need from it.
5558     unless ( defined &main::dumpValue ) {
5559         do 'dumpvar.pl';
5560     }
5561
5562     # If the load succeeded (or we already had dumpvalue()), go ahead
5563     # and dump things.
5564     if ( defined &main::dumpValue ) {
5565         local $\ = '';
5566         local $, = '';
5567         local $" = ' ';
5568         my $v = shift;
5569         my $maxdepth = shift || $option{dumpDepth};
5570         $maxdepth = -1 unless defined $maxdepth;    # -1 means infinite depth
5571         &main::dumpValue( $v, $maxdepth );
5572     } ## end if (defined &main::dumpValue)
5573
5574     # Oops, couldn't load dumpvar.pl.
5575     else {
5576         local $\ = '';
5577         print $OUT "dumpvar.pl not available.\n";
5578     }
5579
5580     # Reset $single and $trace to their old values.
5581     $single = $osingle;
5582     $trace  = $otrace;
5583
5584     # Restore the old filehandle.
5585     select($savout);
5586 } ## end sub dumpit
5587
5588 =head2 C<print_trace>
5589
5590 C<print_trace>'s job is to print a stack trace. It does this via the
5591 C<dump_trace> routine, which actually does all the ferreting-out of the
5592 stack trace data. C<print_trace> takes care of formatting it nicely and
5593 printing it to the proper filehandle.
5594
5595 Parameters:
5596
5597 =over 4
5598
5599 =item * The filehandle to print to.
5600
5601 =item * How many frames to skip before starting trace.
5602
5603 =item * How many frames to print.
5604
5605 =item * A flag: if true, print a "short" trace without filenames, line numbers, or arguments
5606
5607 =back
5608
5609 The original comment below seems to be noting that the traceback may not be
5610 correct if this routine is called in a tied method.
5611
5612 =cut
5613
5614 # Tied method do not create a context, so may get wrong message:
5615
5616 sub print_trace {
5617     local $\ = '';
5618     my $fh = shift;
5619
5620     # If this is going to a slave editor, but we're not the primary
5621     # debugger, reset it first.
5622     resetterm(1)
5623       if $fh        eq $LINEINFO    # slave editor
5624       and $LINEINFO eq $OUT         # normal output
5625       and $term_pid != $$;          # not the primary
5626
5627     # Collect the actual trace information to be formatted.
5628     # This is an array of hashes of subroutine call info.
5629     my @sub = dump_trace( $_[0] + 1, $_[1] );
5630
5631     # Grab the "short report" flag from @_.
5632     my $short = $_[2];              # Print short report, next one for sub name
5633
5634     # Run through the traceback info, format it, and print it.
5635     my $s;
5636     for ( $i = 0 ; $i <= $#sub ; $i++ ) {
5637
5638         # Drop out if the user has lost interest and hit control-C.
5639         last if $signal;
5640
5641         # Set the separator so arrys print nice.
5642         local $" = ', ';
5643
5644         # Grab and stringify the arguments if they are there.
5645         my $args =
5646           defined $sub[$i]{args}
5647           ? "(@{ $sub[$i]{args} })"
5648           : '';
5649
5650         # Shorten them up if $maxtrace says they're too long.
5651         $args = ( substr $args, 0, $maxtrace - 3 ) . '...'
5652           if length $args > $maxtrace;
5653
5654         # Get the file name.
5655         my $file = $sub[$i]{file};
5656
5657         # Put in a filename header if short is off.
5658         $file = $file eq '-e' ? $file : "file `$file'" unless $short;
5659
5660         # Get the actual sub's name, and shorten to $maxtrace's requirement.
5661         $s = $sub[$i]{sub};
5662         $s = ( substr $s, 0, $maxtrace - 3 ) . '...' if length $s > $maxtrace;
5663
5664         # Short report uses trimmed file and sub names.
5665         if ($short) {
5666             my $sub = @_ >= 4 ? $_[3] : $s;
5667             print $fh "$sub[$i]{context}=$sub$args from $file:$sub[$i]{line}\n";
5668         } ## end if ($short)
5669
5670         # Non-short report includes full names.
5671         else {
5672             print $fh "$sub[$i]{context} = $s$args"
5673               . " called from $file"
5674               . " line $sub[$i]{line}\n";
5675         }
5676     } ## end for ($i = 0 ; $i <= $#sub...
5677 } ## end sub print_trace
5678
5679 =head2 dump_trace(skip[,count])
5680
5681 Actually collect the traceback information available via C<caller()>. It does
5682 some filtering and cleanup of the data, but mostly it just collects it to
5683 make C<print_trace()>'s job easier.
5684
5685 C<skip> defines the number of stack frames to be skipped, working backwards
5686 from the most current. C<count> determines the total number of frames to
5687 be returned; all of them (well, the first 10^9) are returned if C<count>
5688 is omitted.
5689
5690 This routine returns a list of hashes, from most-recent to least-recent
5691 stack frame. Each has the following keys and values:
5692
5693 =over 4
5694
5695 =item * C<context> - C<.> (null), C<$> (scalar), or C<@> (array)
5696
5697 =item * C<sub> - subroutine name, or C<eval> information
5698
5699 =item * C<args> - undef, or a reference to an array of arguments
5700
5701 =item * C<file> - the file in which this item was defined (if any)
5702
5703 =item * C<line> - the line on which it was defined
5704
5705 =back
5706
5707 =cut
5708
5709 sub dump_trace {
5710
5711     # How many levels to skip.
5712     my $skip = shift;
5713
5714     # How many levels to show. (1e9 is a cheap way of saying "all of them";
5715     # it's unlikely that we'll have more than a billion stack frames. If you
5716     # do, you've got an awfully big machine...)
5717     my $count = shift || 1e9;
5718
5719     # We increment skip because caller(1) is the first level *back* from
5720     # the current one.  Add $skip to the count of frames so we have a
5721     # simple stop criterion, counting from $skip to $count+$skip.
5722     $skip++;
5723     $count += $skip;
5724
5725     # These variables are used to capture output from caller();
5726     my ( $p, $file, $line, $sub, $h, $context );
5727
5728     my ( $e, $r, @a, @sub, $args );
5729
5730     # XXX Okay... why'd we do that?
5731     my $nothard = not $frame & 8;
5732     local $frame = 0;
5733
5734     # Do not want to trace this.
5735     my $otrace = $trace;
5736     $trace = 0;
5737
5738     # Start out at the skip count.
5739     # If we haven't reached the number of frames requested, and caller() is
5740     # still returning something, stay in the loop. (If we pass the requested
5741     # number of stack frames, or we run out - caller() returns nothing - we
5742     # quit.
5743     # Up the stack frame index to go back one more level each time.
5744     for (
5745         $i = $skip ;
5746         $i < $count
5747         and ( $p, $file, $line, $sub, $h, $context, $e, $r ) = caller($i) ;
5748         $i++
5749       )
5750     {
5751
5752         # Go through the arguments and save them for later.
5753         @a = ();
5754         for $arg (@args) {
5755             my $type;
5756             if ( not defined $arg ) {    # undefined parameter
5757                 push @a, "undef";
5758             }
5759
5760             elsif ( $nothard and tied $arg ) {    # tied parameter
5761                 push @a, "tied";
5762             }
5763             elsif ( $nothard and $type = ref $arg ) {    # reference
5764                 push @a, "ref($type)";
5765             }
5766             else {                                       # can be stringified
5767                 local $_ =
5768                   "$arg";    # Safe to stringify now - should not call f().
5769
5770                 # Backslash any single-quotes or backslashes.
5771                 s/([\'\\])/\\$1/g;
5772
5773                 # Single-quote it unless it's a number or a colon-separated
5774                 # name.
5775                 s/(.*)/'$1'/s
5776                   unless /^(?: -?[\d.]+ | \*[\w:]* )$/x;
5777
5778                 # Turn high-bit characters into meta-whatever.
5779                 s/([\200-\377])/sprintf("M-%c",ord($1)&0177)/eg;
5780
5781                 # Turn control characters into ^-whatever.
5782                 s/([\0-\37\177])/sprintf("^%c",ord($1)^64)/eg;
5783
5784                 push( @a, $_ );
5785             } ## end else [ if (not defined $arg)
5786         } ## end for $arg (@args)
5787
5788         # If context is true, this is array (@)context.
5789         # If context is false, this is scalar ($) context.
5790         # If neither, context isn't defined. (This is apparently a 'can't
5791         # happen' trap.)
5792         $context = $context ? '@' : ( defined $context ? "\$" : '.' );
5793
5794         # if the sub has args ($h true), make an anonymous array of the
5795         # dumped args.
5796         $args = $h ? [@a] : undef;
5797
5798         # remove trailing newline-whitespace-semicolon-end of line sequence
5799         # from the eval text, if any.
5800         $e =~ s/\n\s*\;\s*\Z// if $e;
5801
5802         # Escape backslashed single-quotes again if necessary.
5803         $e =~ s/([\\\'])/\\$1/g if $e;
5804
5805         # if the require flag is true, the eval text is from a require.
5806         if ($r) {
5807             $sub = "require '$e'";
5808         }
5809
5810         # if it's false, the eval text is really from an eval.
5811         elsif ( defined $r ) {
5812             $sub = "eval '$e'";
5813         }
5814
5815         # If the sub is '(eval)', this is a block eval, meaning we don't
5816         # know what the eval'ed text actually was.
5817         elsif ( $sub eq '(eval)' ) {
5818             $sub = "eval {...}";
5819         }
5820
5821         # Stick the collected information into @sub as an anonymous hash.
5822         push(
5823             @sub,
5824             {
5825                 context => $context,
5826                 sub     => $sub,
5827                 args    => $args,
5828                 file    => $file,
5829                 line    => $line
5830             }
5831         );
5832
5833         # Stop processing frames if the user hit control-C.
5834         last if $signal;
5835     } ## end for ($i = $skip ; $i < ...
5836
5837     # Restore the trace value again.
5838     $trace = $otrace;
5839     @sub;
5840 } ## end sub dump_trace
5841
5842 =head2 C<action()>
5843
5844 C<action()> takes input provided as the argument to an add-action command,
5845 either pre- or post-, and makes sure it's a complete command. It doesn't do
5846 any fancy parsing; it just keeps reading input until it gets a string
5847 without a trailing backslash.
5848
5849 =cut
5850
5851 sub action {
5852     my $action = shift;
5853
5854     while ( $action =~ s/\\$// ) {
5855
5856         # We have a backslash on the end. Read more.
5857         $action .= &gets;
5858     } ## end while ($action =~ s/\\$//)
5859
5860     # Return the assembled action.
5861     $action;
5862 } ## end sub action
5863
5864 =head2 unbalanced
5865
5866 This routine mostly just packages up a regular expression to be used
5867 to check that the thing it's being matched against has properly-matched
5868 curly braces.
5869
5870 Of note is the definition of the $balanced_brace_re global via ||=, which
5871 speeds things up by only creating the qr//'ed expression once; if it's
5872 already defined, we don't try to define it again. A speed hack.
5873
5874 =cut
5875
5876 sub unbalanced {
5877
5878     # I hate using globals!
5879     $balanced_brace_re ||= qr{
5880         ^ \{
5881              (?:
5882                  (?> [^{}] + )              # Non-parens without backtracking
5883                 |
5884                  (??{ $balanced_brace_re }) # Group with matching parens
5885               ) *
5886           \} $
5887    }x;
5888     return $_[0] !~ m/$balanced_brace_re/;
5889 } ## end sub unbalanced
5890
5891 =head2 C<gets()>
5892
5893 C<gets()> is a primitive (very primitive) routine to read continuations.
5894 It was devised for reading continuations for actions.
5895 it just reads more input with X<C<readline()>> and returns it.
5896
5897 =cut
5898
5899 sub gets {
5900     &readline("cont: ");
5901 }
5902
5903 =head2 C<DB::system()> - handle calls to<system()> without messing up the debugger
5904
5905 The C<system()> function assumes that it can just go ahead and use STDIN and
5906 STDOUT, but under the debugger, we want it to use the debugger's input and
5907 outout filehandles.
5908
5909 C<DB::system()> socks away the program's STDIN and STDOUT, and then substitutes
5910 the debugger's IN and OUT filehandles for them. It does the C<system()> call,
5911 and then puts everything back again.
5912
5913 =cut
5914
5915 sub system {
5916
5917     # We save, change, then restore STDIN and STDOUT to avoid fork() since
5918     # some non-Unix systems can do system() but have problems with fork().
5919     open( SAVEIN,  "<&STDIN" )  || &warn("Can't save STDIN");
5920     open( SAVEOUT, ">&STDOUT" ) || &warn("Can't save STDOUT");
5921     open( STDIN,   "<&IN" )     || &warn("Can't redirect STDIN");
5922     open( STDOUT,  ">&OUT" )    || &warn("Can't redirect STDOUT");
5923
5924     # XXX: using csh or tcsh destroys sigint retvals!
5925     system(@_);
5926     open( STDIN,  "<&SAVEIN" )  || &warn("Can't restore STDIN");
5927     open( STDOUT, ">&SAVEOUT" ) || &warn("Can't restore STDOUT");
5928     close(SAVEIN);
5929     close(SAVEOUT);
5930
5931     # most of the $? crud was coping with broken cshisms
5932     if ( $? >> 8 ) {
5933         &warn( "(Command exited ", ( $? >> 8 ), ")\n" );
5934     }
5935     elsif ($?) {
5936         &warn(
5937             "(Command died of SIG#",
5938             ( $? & 127 ),
5939             ( ( $? & 128 ) ? " -- core dumped" : "" ),
5940             ")", "\n"
5941         );
5942     } ## end elsif ($?)
5943
5944     return $?;
5945
5946 } ## end sub system
5947
5948 =head1 TTY MANAGEMENT
5949
5950 The subs here do some of the terminal management for multiple debuggers.
5951
5952 =head2 setterm
5953
5954 Top-level function called when we want to set up a new terminal for use
5955 by the debugger.
5956
5957 If the C<noTTY> debugger option was set, we'll either use the terminal
5958 supplied (the value of the C<noTTY> option), or we'll use C<Term::Rendezvous>
5959 to find one. If we're a forked debugger, we call C<resetterm> to try to
5960 get a whole new terminal if we can.
5961
5962 In either case, we set up the terminal next. If the C<ReadLine> option was
5963 true, we'll get a C<Term::ReadLine> object for the current terminal and save
5964 the appropriate attributes. We then
5965
5966 =cut
5967
5968 sub setterm {
5969
5970     # Load Term::Readline, but quietly; don't debug it and don't trace it.
5971     local $frame = 0;
5972     local $doret = -2;
5973     eval { require Term::ReadLine } or die $@;
5974
5975     # If noTTY is set, but we have a TTY name, go ahead and hook up to it.
5976     if ($notty) {
5977         if ($tty) {
5978             my ( $i, $o ) = split $tty, /,/;
5979             $o = $i unless defined $o;
5980             open( IN,  "<$i" ) or die "Cannot open TTY `$i' for read: $!";
5981             open( OUT, ">$o" ) or die "Cannot open TTY `$o' for write: $!";
5982             $IN  = \*IN;
5983             $OUT = \*OUT;
5984             my $sel = select($OUT);
5985             $| = 1;
5986             select($sel);
5987         } ## end if ($tty)
5988
5989         # We don't have a TTY - try to find one via Term::Rendezvous.
5990         else {
5991             eval "require Term::Rendezvous;" or die;
5992
5993             # See if we have anything to pass to Term::Rendezvous.
5994             # Use /tmp/perldbtty$$ if not.
5995             my $rv = $ENV{PERLDB_NOTTY} || "/tmp/perldbtty$$";
5996
5997             # Rendezvous and get the filehandles.
5998             my $term_rv = new Term::Rendezvous $rv;
5999             $IN  = $term_rv->IN;
6000             $OUT = $term_rv->OUT;
6001         } ## end else [ if ($tty)
6002     } ## end if ($notty)
6003
6004     # We're a daughter debugger. Try to fork off another TTY.
6005     if ( $term_pid eq '-1' ) {    # In a TTY with another debugger
6006         resetterm(2);
6007     }
6008
6009     # If we shouldn't use Term::ReadLine, don't.
6010     if ( !$rl ) {
6011         $term = new Term::ReadLine::Stub 'perldb', $IN, $OUT;
6012     }
6013
6014     # We're using Term::ReadLine. Get all the attributes for this terminal.
6015     else {
6016         $term = new Term::ReadLine 'perldb', $IN, $OUT;
6017
6018         $rl_attribs = $term->Attribs;
6019         $rl_attribs->{basic_word_break_characters} .= '-:+/*,[])}'
6020           if defined $rl_attribs->{basic_word_break_characters}
6021           and index( $rl_attribs->{basic_word_break_characters}, ":" ) == -1;
6022         $rl_attribs->{special_prefixes} = '$@&%';
6023         $rl_attribs->{completer_word_break_characters} .= '$@&%';
6024         $rl_attribs->{completion_function} = \&db_complete;
6025     } ## end else [ if (!$rl)
6026
6027     # Set up the LINEINFO filehandle.
6028     $LINEINFO = $OUT     unless defined $LINEINFO;
6029     $lineinfo = $console unless defined $lineinfo;
6030
6031     $term->MinLine(2);
6032
6033     if ( $term->Features->{setHistory} and "@hist" ne "?" ) {
6034         $term->SetHistory(@hist);
6035     }
6036
6037     # XXX Ornaments are turned on unconditionally, which is not
6038     # always a good thing.
6039     ornaments($ornaments) if defined $ornaments;
6040     $term_pid = $$;
6041 } ## end sub setterm
6042
6043 =head1 GET_FORK_TTY EXAMPLE FUNCTIONS
6044
6045 When the process being debugged forks, or the process invokes a command
6046 via C<system()> which starts a new debugger, we need to be able to get a new
6047 C<IN> and C<OUT> filehandle for the new debugger. Otherwise, the two processes
6048 fight over the terminal, and you can never quite be sure who's going to get the
6049 input you're typing.
6050
6051 C<get_fork_TTY> is a glob-aliased function which calls the real function that
6052 is tasked with doing all the necessary operating system mojo to get a new
6053 TTY (and probably another window) and to direct the new debugger to read and
6054 write there.
6055
6056 The debugger provides C<get_fork_TTY> functions which work for X Windows and
6057 OS/2. Other systems are not supported. You are encouraged to write
6058 C<get_fork_TTY> functions which work for I<your> platform and contribute them.
6059
6060 =head3 C<xterm_get_fork_TTY>
6061
6062 This function provides the C<get_fork_TTY> function for X windows. If a
6063 program running under the debugger forks, a new <xterm> window is opened and
6064 the subsidiary debugger is directed there.
6065
6066 The C<open()> call is of particular note here. We have the new C<xterm>
6067 we're spawning route file number 3 to STDOUT, and then execute the C<tty>
6068 command (which prints the device name of the TTY we'll want to use for input
6069 and output to STDOUT, then C<sleep> for a very long time, routing this output
6070 to file number 3. This way we can simply read from the <XT> filehandle (which
6071 is STDOUT from the I<commands> we ran) to get the TTY we want to use.
6072
6073 Only works if C<xterm> is in your path and C<$ENV{DISPLAY}>, etc. are
6074 properly set up.
6075
6076 =cut
6077
6078 sub xterm_get_fork_TTY {
6079     ( my $name = $0 ) =~ s,^.*[/\\],,s;
6080     open XT,
6081 qq[3>&1 xterm -title "Daughter Perl debugger $pids $name" -e sh -c 'tty 1>&3;\
6082  sleep 10000000' |];
6083
6084     # Get the output from 'tty' and clean it up a little.
6085     my $tty = <XT>;
6086     chomp $tty;
6087
6088     $pidprompt = '';    # Shown anyway in titlebar
6089
6090     # There's our new TTY.
6091     return $tty;
6092 } ## end sub xterm_get_fork_TTY
6093
6094 =head3 C<os2_get_fork_TTY>
6095
6096 XXX It behooves an OS/2 expert to write the necessary documentation for this!
6097
6098 =cut
6099
6100 # This example function resets $IN, $OUT itself
6101 sub os2_get_fork_TTY {
6102     local $^F = 40;    # XXXX Fixme!
6103     local $\  = '';
6104     my ( $in1, $out1, $in2, $out2 );
6105
6106     # Having -d in PERL5OPT would lead to a disaster...
6107     local $ENV{PERL5OPT} = $ENV{PERL5OPT} if $ENV{PERL5OPT};
6108     $ENV{PERL5OPT} =~ s/(?:^|(?<=\s))-d\b//  if $ENV{PERL5OPT};
6109     $ENV{PERL5OPT} =~ s/(?:^|(?<=\s))-d\B/-/ if $ENV{PERL5OPT};
6110     print $OUT "Making kid PERL5OPT->`$ENV{PERL5OPT}'.\n" if $ENV{PERL5OPT};
6111     local $ENV{PERL5LIB} = $ENV{PERL5LIB} ? $ENV{PERL5LIB} : $ENV{PERLLIB};
6112     $ENV{PERL5LIB} = '' unless defined $ENV{PERL5LIB};
6113     $ENV{PERL5LIB} = join ';', @ini_INC, split /;/, $ENV{PERL5LIB};
6114     ( my $name = $0 ) =~ s,^.*[/\\],,s;
6115     my @args;
6116
6117     if (
6118             pipe $in1, $out1
6119         and pipe $in2, $out2
6120
6121         # system P_SESSION will fail if there is another process
6122         # in the same session with a "dependent" asynchronous child session.
6123         and @args = (
6124             $rl, fileno $in1, fileno $out2, "Daughter Perl debugger $pids $name"
6125         )
6126         and (
6127             ( $kpid = CORE::system 4, $^X, '-we',
6128                 <<'ES', @args ) >= 0    # P_SESSION
6129 END {sleep 5 unless $loaded}
6130 BEGIN {open STDIN,  '</dev/con' or warn "reopen stdin: $!"}
6131 use OS2::Process;
6132
6133 my ($rl, $in) = (shift, shift);        # Read from $in and pass through
6134 set_title pop;
6135 system P_NOWAIT, $^X, '-we', <<EOS or die "Cannot start a grandkid";
6136   open IN, '<&=$in' or die "open <&=$in: \$!";
6137   \$| = 1; print while sysread IN, \$_, 1<<16;
6138 EOS
6139
6140 my $out = shift;
6141 open OUT, ">&=$out" or die "Cannot open &=$out for writing: $!";
6142 select OUT;    $| = 1;
6143 require Term::ReadKey if $rl;
6144 Term::ReadKey::ReadMode(4) if $rl; # Nodelay on kbd.  Pipe is automatically nodelay...
6145 print while sysread STDIN, $_, 1<<($rl ? 16 : 0);
6146 ES
6147             or warn "system P_SESSION: $!, $^E" and 0
6148         )
6149         and close $in1
6150         and close $out2
6151       )
6152     {
6153         $pidprompt = '';    # Shown anyway in titlebar
6154         reset_IN_OUT( $in2, $out1 );
6155         $tty = '*reset*';
6156         return '';          # Indicate that reset_IN_OUT is called
6157     } ## end if (pipe $in1, $out1 and...
6158     return;
6159 } ## end sub os2_get_fork_TTY
6160
6161 =head2 C<create_IN_OUT($flags)>
6162
6163 Create a new pair of filehandles, pointing to a new TTY. If impossible,
6164 try to diagnose why.
6165
6166 Flags are:
6167
6168 =over 4
6169
6170 =item * 1 - Don't know how to create a new TTY.
6171
6172 =item * 2 - Debugger has forked, but we can't get a new TTY.
6173
6174 =item * 4 - standard debugger startup is happening.
6175
6176 =back
6177
6178 =cut
6179
6180 sub create_IN_OUT {    # Create a window with IN/OUT handles redirected there
6181
6182     # If we know how to get a new TTY, do it! $in will have
6183     # the TTY name if get_fork_TTY works.
6184     my $in = &get_fork_TTY if defined &get_fork_TTY;
6185
6186     # It used to be that
6187     $in = $fork_TTY if defined $fork_TTY;    # Backward compatibility
6188
6189     if ( not defined $in ) {
6190         my $why = shift;
6191
6192         # We don't know how.
6193         print_help(<<EOP) if $why == 1;
6194 I<#########> Forked, but do not know how to create a new B<TTY>. I<#########>
6195 EOP
6196
6197         # Forked debugger.
6198         print_help(<<EOP) if $why == 2;
6199 I<#########> Daughter session, do not know how to change a B<TTY>. I<#########>
6200   This may be an asynchronous session, so the parent debugger may be active.
6201 EOP
6202
6203         # Note that both debuggers are fighting over the same input.
6204         print_help(<<EOP) if $why != 4;
6205   Since two debuggers fight for the same TTY, input is severely entangled.
6206
6207 EOP
6208         print_help(<<EOP);
6209   I know how to switch the output to a different window in xterms
6210   and OS/2 consoles only.  For a manual switch, put the name of the created I<TTY>
6211   in B<\$DB::fork_TTY>, or define a function B<DB::get_fork_TTY()> returning this.
6212
6213   On I<UNIX>-like systems one can get the name of a I<TTY> for the given window
6214   by typing B<tty>, and disconnect the I<shell> from I<TTY> by B<sleep 1000000>.
6215
6216 EOP
6217     } ## end if (not defined $in)
6218     elsif ( $in ne '' ) {
6219         TTY($in);
6220     }
6221     else {
6222         $console = '';    # Indicate no need to open-from-the-console
6223     }
6224     undef $fork_TTY;
6225 } ## end sub create_IN_OUT
6226
6227 =head2 C<resetterm>
6228
6229 Handles rejiggering the prompt when we've forked off a new debugger.
6230
6231 If the new debugger happened because of a C<system()> that invoked a
6232 program under the debugger, the arrow between the old pid and the new
6233 in the prompt has I<two> dashes instead of one.
6234
6235 We take the current list of pids and add this one to the end. If there
6236 isn't any list yet, we make one up out of the initial pid associated with
6237 the terminal and our new pid, sticking an arrow (either one-dashed or
6238 two dashed) in between them.
6239
6240 If C<CreateTTY> is off, or C<resetterm> was called with no arguments,
6241 we don't try to create a new IN and OUT filehandle. Otherwise, we go ahead
6242 and try to do that.
6243
6244 =cut
6245
6246 sub resetterm {    # We forked, so we need a different TTY
6247
6248     # Needs to be passed to create_IN_OUT() as well.
6249     my $in = shift;
6250
6251     # resetterm(2): got in here because of a system() starting a debugger.
6252     # resetterm(1): just forked.
6253     my $systemed = $in > 1 ? '-' : '';
6254
6255     # If there's already a list of pids, add this to the end.
6256     if ($pids) {
6257         $pids =~ s/\]/$systemed->$$]/;
6258     }
6259
6260     # No pid list. Time to make one.
6261     else {
6262         $pids = "[$term_pid->$$]";
6263     }
6264
6265     # The prompt we're going to be using for this debugger.
6266     $pidprompt = $pids;
6267
6268     # We now 0wnz this terminal.
6269     $term_pid = $$;
6270
6271     # Just return if we're not supposed to try to create a new TTY.
6272     return unless $CreateTTY & $in;
6273
6274     # Try to create a new IN/OUT pair.
6275     create_IN_OUT($in);
6276 } ## end sub resetterm
6277
6278 =head2 C<readline>
6279
6280 First, we handle stuff in the typeahead buffer. If there is any, we shift off
6281 the next line, print a message saying we got it, add it to the terminal
6282 history (if possible), and return it.
6283
6284 If there's nothing in the typeahead buffer, check the command filehandle stack.
6285 If there are any filehandles there, read from the last one, and return the line
6286 if we got one. If not, we pop the filehandle off and close it, and try the
6287 next one up the stack.
6288
6289 If we've emptied the filehandle stack, we check to see if we've got a socket
6290 open, and we read that and return it if we do. If we don't, we just call the
6291 core C<readline()> and return its value.
6292
6293 =cut
6294
6295 sub readline {
6296
6297     # Localize to prevent it from being smashed in the program being debugged.
6298     local $.;
6299
6300     # Pull a line out of the typeahead if there's stuff there.
6301     if (@typeahead) {
6302
6303         # How many lines left.
6304         my $left = @typeahead;
6305
6306         # Get the next line.
6307         my $got = shift @typeahead;
6308
6309         # Print a message saying we got input from the typeahead.
6310         local $\ = '';
6311         print $OUT "auto(-$left)", shift, $got, "\n";
6312
6313         # Add it to the terminal history (if possible).
6314         $term->AddHistory($got)
6315           if length($got) > 1
6316           and defined $term->Features->{addHistory};
6317         return $got;
6318     } ## end if (@typeahead)
6319
6320     # We really need to read some input. Turn off entry/exit trace and
6321     # return value printing.
6322     local $frame = 0;
6323     local $doret = -2;
6324
6325     # If there are stacked filehandles to read from ...
6326     while (@cmdfhs) {
6327
6328         # Read from the last one in the stack.
6329         my $line = CORE::readline( $cmdfhs[-1] );
6330
6331         # If we got a line ...
6332         defined $line
6333           ? ( print $OUT ">> $line" and return $line )    # Echo and return
6334           : close pop @cmdfhs;                            # Pop and close
6335     } ## end while (@cmdfhs)
6336
6337     # Nothing on the filehandle stack. Socket?
6338     if ( ref $OUT and UNIVERSAL::isa( $OUT, 'IO::Socket::INET' ) ) {
6339
6340         # Send anyting we have to send.
6341         $OUT->write( join( '', @_ ) );
6342
6343         # Receive anything there is to receive.
6344         my $stuff;
6345         $IN->recv( $stuff, 2048 );    # XXX "what's wrong with sysread?"
6346                                       # XXX Don't know. You tell me.
6347
6348         # What we got.
6349         $stuff;
6350     } ## end if (ref $OUT and UNIVERSAL::isa...
6351
6352     # No socket. Just read from the terminal.
6353     else {
6354         $term->readline(@_);
6355     }
6356 } ## end sub readline
6357
6358 =head1 OPTIONS SUPPORT ROUTINES
6359
6360 These routines handle listing and setting option values.
6361
6362 =head2 C<dump_option> - list the current value of an option setting
6363
6364 This routine uses C<option_val> to look up the value for an option.
6365 It cleans up escaped single-quotes and then displays the option and
6366 its value.
6367
6368 =cut
6369
6370 sub dump_option {
6371     my ( $opt, $val ) = @_;
6372     $val = option_val( $opt, 'N/A' );
6373     $val =~ s/([\\\'])/\\$1/g;
6374     printf $OUT "%20s = '%s'\n", $opt, $val;
6375 } ## end sub dump_option
6376
6377 sub options2remember {
6378     foreach my $k (@RememberOnROptions) {
6379         $option{$k} = option_val( $k, 'N/A' );
6380     }
6381     return %option;
6382 }
6383
6384 =head2 C<option_val> - find the current value of an option
6385
6386 This can't just be a simple hash lookup because of the indirect way that
6387 the option values are stored. Some are retrieved by calling a subroutine,
6388 some are just variables.
6389
6390 You must supply a default value to be used in case the option isn't set.
6391
6392 =cut
6393
6394 sub option_val {
6395     my ( $opt, $default ) = @_;
6396     my $val;
6397
6398     # Does this option exist, and is it a variable?
6399     # If so, retrieve the value via the value in %optionVars.
6400     if (    defined $optionVars{$opt}
6401         and defined ${ $optionVars{$opt} } )
6402     {
6403         $val = ${ $optionVars{$opt} };
6404     }
6405
6406     # Does this option exist, and it's a subroutine?
6407     # If so, call the subroutine via the ref in %optionAction
6408     # and capture the value.
6409     elsif ( defined $optionAction{$opt}
6410         and defined &{ $optionAction{$opt} } )
6411     {
6412         $val = &{ $optionAction{$opt} }();
6413     }
6414
6415     # If there's an action or variable for the supplied option,
6416     # but no value was set, use the default.
6417     elsif (defined $optionAction{$opt} and not defined $option{$opt}
6418         or defined $optionVars{$opt} and not defined ${ $optionVars{$opt} } )
6419     {
6420         $val = $default;
6421     }
6422
6423     # Otherwise, do the simple hash lookup.
6424     else {
6425         $val = $option{$opt};
6426     }
6427
6428     # If the value isn't defined, use the default.
6429     # Then return whatever the value is.
6430     $val = $default unless defined $val;
6431     $val;
6432 } ## end sub option_val
6433
6434 =head2 C<parse_options>
6435
6436 Handles the parsing and execution of option setting/displaying commands.
6437
6438 An option entered by itself is assumed to be 'set me to 1' (the default value)
6439 if the option is a boolean one. If not, the user is prompted to enter a valid
6440 value or to query the current value (via 'option? ').
6441
6442 If 'option=value' is entered, we try to extract a quoted string from the
6443 value (if it is quoted). If it's not, we just use the whole value as-is.
6444
6445 We load any modules required to service this option, and then we set it: if
6446 it just gets stuck in a variable, we do that; if there's a subroutine to
6447 handle setting the option, we call that.
6448
6449 Finally, if we're running in interactive mode, we display the effect of the
6450 user's command back to the terminal, skipping this if we're setting things
6451 during initialization.
6452
6453 =cut
6454
6455 sub parse_options {
6456     local ($_) = @_;
6457     local $\ = '';
6458
6459     # These options need a value. Don't allow them to be clobbered by accident.
6460     my %opt_needs_val = map { ( $_ => 1 ) } qw{
6461       dumpDepth arrayDepth hashDepth LineInfo maxTraceLen ornaments windowSize
6462       pager quote ReadLine recallCommand RemotePort ShellBang TTY CommandSet
6463     };
6464
6465     while (length) {
6466         my $val_defaulted;
6467
6468         # Clean off excess leading whitespace.
6469         s/^\s+// && next;
6470
6471         # Options are always all word characters, followed by a non-word
6472         # separator.
6473         s/^(\w+)(\W?)// or print( $OUT "Invalid option `$_'\n" ), last;
6474         my ( $opt, $sep ) = ( $1, $2 );
6475
6476         # Make sure that such an option exists.
6477         my $matches = grep( /^\Q$opt/ && ( $option = $_ ), @options )
6478           || grep( /^\Q$opt/i && ( $option = $_ ), @options );
6479
6480         print( $OUT "Unknown option `$opt'\n" ), next unless $matches;
6481         print( $OUT "Ambiguous option `$opt'\n" ), next if $matches > 1;
6482         my $val;
6483
6484         # '?' as separator means query, but must have whitespace after it.
6485         if ( "?" eq $sep ) {
6486             print( $OUT "Option query `$opt?' followed by non-space `$_'\n" ),
6487               last
6488               if /^\S/;
6489
6490             #&dump_option($opt);
6491         } ## end if ("?" eq $sep)
6492
6493         # Separator is whitespace (or just a carriage return).
6494         # They're going for a default, which we assume is 1.
6495         elsif ( $sep !~ /\S/ ) {
6496             $val_defaulted = 1;
6497             $val           = "1";   #  this is an evil default; make 'em set it!
6498         }
6499
6500         # Separator is =. Trying to set a value.
6501         elsif ( $sep eq "=" ) {
6502
6503             # If quoted, extract a quoted string.
6504             if (s/ (["']) ( (?: \\. | (?! \1 ) [^\\] )* ) \1 //x) {
6505                 my $quote = $1;
6506                 ( $val = $2 ) =~ s/\\([$quote\\])/$1/g;
6507             }
6508
6509             # Not quoted. Use the whole thing. Warn about 'option='.
6510             else {
6511                 s/^(\S*)//;
6512                 $val = $1;
6513                 print OUT qq(Option better cleared using $opt=""\n)
6514                   unless length $val;
6515             } ## end else [ if (s/ (["']) ( (?: \\. | (?! \1 ) [^\\] )* ) \1 //x)
6516
6517         } ## end elsif ($sep eq "=")
6518
6519         # "Quoted" with [], <>, or {}.
6520         else {    #{ to "let some poor schmuck bounce on the % key in B<vi>."
6521             my ($end) =
6522               "\\" . substr( ")]>}$sep", index( "([<{", $sep ), 1 );    #}
6523             s/^(([^\\$end]|\\[\\$end])*)$end($|\s+)//
6524               or print( $OUT "Unclosed option value `$opt$sep$_'\n" ), last;
6525             ( $val = $1 ) =~ s/\\([\\$end])/$1/g;
6526         } ## end else [ if ("?" eq $sep)
6527
6528         # Exclude non-booleans from getting set to 1 by default.
6529         if ( $opt_needs_val{$option} && $val_defaulted ) {
6530             my $cmd = ( $CommandSet eq '580' ) ? 'o' : 'O';
6531             print $OUT
6532 "Option `$opt' is non-boolean.  Use `$cmd $option=VAL' to set, `$cmd $option?' to query\n";
6533             next;
6534         } ## end if ($opt_needs_val{$option...
6535
6536         # Save the option value.
6537         $option{$option} = $val if defined $val;
6538
6539         # Load any module that this option requires.
6540         eval qq{
6541                 local \$frame = 0;
6542                 local \$doret = -2;
6543                 require '$optionRequire{$option}';
6544                 1;
6545                } || die    # XXX: shouldn't happen
6546           if defined $optionRequire{$option}
6547           && defined $val;
6548
6549         # Set it.
6550         # Stick it in the proper variable if it goes in a variable.
6551         ${ $optionVars{$option} } = $val
6552           if defined $optionVars{$option}
6553           && defined $val;
6554
6555         # Call the appropriate sub if it gets set via sub.
6556         &{ $optionAction{$option} }($val)
6557           if defined $optionAction{$option}
6558           && defined &{ $optionAction{$option} }
6559           && defined $val;
6560
6561         # Not initialization - echo the value we set it to.
6562         dump_option($option) unless $OUT eq \*STDERR;
6563     } ## end while (length)
6564 } ## end sub parse_options
6565
6566 =head1 RESTART SUPPORT
6567
6568 These routines are used to store (and restore) lists of items in environment
6569 variables during a restart.
6570
6571 =head2 set_list
6572
6573 Set_list packages up items to be stored in a set of environment variables
6574 (VAR_n, containing the number of items, and VAR_0, VAR_1, etc., containing
6575 the values). Values outside the standard ASCII charset are stored by encoding
6576 then as hexadecimal values.
6577
6578 =cut
6579
6580 sub set_list {
6581     my ( $stem, @list ) = @_;
6582     my $val;
6583
6584     # VAR_n: how many we have. Scalar assignment gets the number of items.
6585     $ENV{"${stem}_n"} = @list;
6586
6587     # Grab each item in the list, escape the backslashes, encode the non-ASCII
6588     # as hex, and then save in the appropriate VAR_0, VAR_1, etc.
6589     for $i ( 0 .. $#list ) {
6590         $val = $list[$i];
6591         $val =~ s/\\/\\\\/g;
6592         $val =~ s/([\0-\37\177\200-\377])/"\\0x" . unpack('H2',$1)/eg;
6593         $ENV{"${stem}_$i"} = $val;
6594     } ## end for $i (0 .. $#list)
6595 } ## end sub set_list
6596
6597 =head2 get_list
6598
6599 Reverse the set_list operation: grab VAR_n to see how many we should be getting
6600 back, and then pull VAR_0, VAR_1. etc. back out.
6601
6602 =cut
6603
6604 sub get_list {
6605     my $stem = shift;
6606     my @list;
6607     my $n = delete $ENV{"${stem}_n"};
6608     my $val;
6609     for $i ( 0 .. $n - 1 ) {
6610         $val = delete $ENV{"${stem}_$i"};
6611         $val =~ s/\\((\\)|0x(..))/ $2 ? $2 : pack('H2', $3) /ge;
6612         push @list, $val;
6613     }
6614     @list;
6615 } ## end sub get_list
6616
6617 =head1 MISCELLANEOUS SIGNAL AND I/O MANAGEMENT
6618
6619 =head2 catch()
6620
6621 The C<catch()> subroutine is the essence of fast and low-impact. We simply
6622 set an already-existing global scalar variable to a constant value. This
6623 avoids allocating any memory possibly in the middle of something that will
6624 get all confused if we do.
6625
6626 =cut
6627
6628 sub catch {
6629     $signal = 1;
6630     return;    # Put nothing on the stack - malloc/free land!
6631 }
6632
6633 =head2 C<warn()>
6634
6635 C<warn> emits a warning, by joining together its arguments and printing
6636 them, with couple of fillips.
6637
6638 If the composited message I<doesn't> end with a newline, we automatically
6639 add C<$!> and a newline to the end of the message. The subroutine expects $OUT
6640 to be set to the filehandle to be used to output warnings; it makes no
6641 assumptions about what filehandles are available.
6642
6643 =cut
6644
6645 sub warn {
6646     my ($msg) = join( "", @_ );
6647     $msg .= ": $!\n" unless $msg =~ /\n$/;
6648     local $\ = '';
6649     print $OUT $msg;
6650 } ## end sub warn
6651
6652 =head1 INITIALIZATION TTY SUPPORT
6653
6654 =head2 C<reset_IN_OUT>
6655
6656 This routine handles restoring the debugger's input and output filehandles
6657 after we've tried and failed to move them elsewhere.  In addition, it assigns
6658 the debugger's output filehandle to $LINEINFO if it was already open there.
6659
6660 =cut
6661
6662 sub reset_IN_OUT {
6663     my $switch_li = $LINEINFO eq $OUT;
6664
6665     # If there's a term and it's able to get a new tty, try to get one.
6666     if ( $term and $term->Features->{newTTY} ) {
6667         ( $IN, $OUT ) = ( shift, shift );
6668         $term->newTTY( $IN, $OUT );
6669     }
6670
6671     # This term can't get a new tty now. Better luck later.
6672     elsif ($term) {
6673         &warn("Too late to set IN/OUT filehandles, enabled on next `R'!\n");
6674     }
6675
6676     # Set the filehndles up as they were.
6677     else {
6678         ( $IN, $OUT ) = ( shift, shift );
6679     }
6680
6681     # Unbuffer the output filehandle.
6682     my $o = select $OUT;
6683     $| = 1;
6684     select $o;
6685
6686     # Point LINEINFO to the same output filehandle if it was there before.
6687     $LINEINFO = $OUT if $switch_li;
6688 } ## end sub reset_IN_OUT
6689
6690 =head1 OPTION SUPPORT ROUTINES
6691
6692 The following routines are used to process some of the more complicated
6693 debugger options.
6694
6695 =head2 C<TTY>
6696
6697 Sets the input and output filehandles to the specified files or pipes.
6698 If the terminal supports switching, we go ahead and do it. If not, and
6699 there's already a terminal in place, we save the information to take effect
6700 on restart.
6701
6702 If there's no terminal yet (for instance, during debugger initialization),
6703 we go ahead and set C<$console> and C<$tty> to the file indicated.
6704
6705 =cut
6706
6707 sub TTY {
6708     if ( @_ and $term and $term->Features->{newTTY} ) {
6709
6710         # This terminal supports switching to a new TTY.
6711         # Can be a list of two files, or on string containing both names,
6712         # comma-separated.
6713         # XXX Should this perhaps be an assignment from @_?
6714         my ( $in, $out ) = shift;
6715         if ( $in =~ /,/ ) {
6716
6717             # Split list apart if supplied.
6718             ( $in, $out ) = split /,/, $in, 2;
6719         }
6720         else {
6721
6722             # Use the same file for both input and output.
6723             $out = $in;
6724         }
6725
6726         # Open file onto the debugger's filehandles, if you can.
6727         open IN,  $in     or die "cannot open `$in' for read: $!";
6728         open OUT, ">$out" or die "cannot open `$out' for write: $!";
6729
6730         # Swap to the new filehandles.
6731         reset_IN_OUT( \*IN, \*OUT );
6732
6733         # Save the setting for later.
6734         return $tty = $in;
6735     } ## end if (@_ and $term and $term...
6736
6737     # Terminal doesn't support new TTY, or doesn't support readline.
6738     # Can't do it now, try restarting.
6739     &warn("Too late to set TTY, enabled on next `R'!\n") if $term and @_;
6740
6741     # Useful if done through PERLDB_OPTS:
6742     $console = $tty = shift if @_;
6743
6744     # Return whatever the TTY is.
6745     $tty or $console;
6746 } ## end sub TTY
6747
6748 =head2 C<noTTY>
6749
6750 Sets the C<$notty> global, controlling whether or not the debugger tries to
6751 get a terminal to read from. If called after a terminal is already in place,
6752 we save the value to use it if we're restarted.
6753
6754 =cut
6755
6756 sub noTTY {
6757     if ($term) {
6758         &warn("Too late to set noTTY, enabled on next `R'!\n") if @_;
6759     }
6760     $notty = shift if @_;
6761     $notty;
6762 } ## end sub noTTY
6763
6764 =head2 C<ReadLine>
6765
6766 Sets the C<$rl> option variable. If 0, we use C<Term::ReadLine::Stub>
6767 (essentially, no C<readline> processing on this "terminal"). Otherwise, we
6768 use C<Term::ReadLine>. Can't be changed after a terminal's in place; we save
6769 the value in case a restart is done so we can change it then.
6770
6771 =cut
6772
6773 sub ReadLine {
6774     if ($term) {
6775         &warn("Too late to set ReadLine, enabled on next `R'!\n") if @_;
6776     }
6777     $rl = shift if @_;
6778     $rl;
6779 } ## end sub ReadLine
6780
6781 =head2 C<RemotePort>
6782
6783 Sets the port that the debugger will try to connect to when starting up.
6784 If the terminal's already been set up, we can't do it, but we remember the
6785 setting in case the user does a restart.
6786
6787 =cut
6788
6789 sub RemotePort {
6790     if ($term) {
6791         &warn("Too late to set RemotePort, enabled on next 'R'!\n") if @_;
6792     }
6793     $remoteport = shift if @_;
6794     $remoteport;
6795 } ## end sub RemotePort
6796
6797 =head2 C<tkRunning>
6798
6799 Checks with the terminal to see if C<Tk> is running, and returns true or
6800 false. Returns false if the current terminal doesn't support C<readline>.
6801
6802 =cut
6803
6804 sub tkRunning {
6805     if ( ${ $term->Features }{tkRunning} ) {
6806         return $term->tkRunning(@_);
6807     }
6808     else {
6809         local $\ = '';
6810         print $OUT "tkRunning not supported by current ReadLine package.\n";
6811         0;
6812     }
6813 } ## end sub tkRunning
6814
6815 =head2 C<NonStop>
6816
6817 Sets nonstop mode. If a terminal's already been set up, it's too late; the
6818 debugger remembers the setting in case you restart, though.
6819
6820 =cut
6821
6822 sub NonStop {
6823     if ($term) {
6824         &warn("Too late to set up NonStop mode, enabled on next `R'!\n")
6825           if @_;
6826     }
6827     $runnonstop = shift if @_;
6828     $runnonstop;
6829 } ## end sub NonStop
6830
6831 sub DollarCaretP {
6832     if ($term) {
6833         &warn("Some flag changes could not take effect until next 'R'!\n")
6834           if @_;
6835     }
6836     $^P = parse_DollarCaretP_flags(shift) if @_;
6837     expand_DollarCaretP_flags($^P);
6838 }
6839
6840 sub OnlyAssertions {
6841     if ($term) {
6842         &warn("Too late to set up OnlyAssertions mode, enabled on next 'R'!\n")
6843           if @_;
6844     }
6845     if (@_) {
6846         unless ( defined $ini_assertion ) {
6847             if ($term) {
6848                 &warn("Current Perl interpreter doesn't support assertions");
6849             }
6850             return 0;
6851         }
6852         if (shift) {
6853             unless ($ini_assertion) {
6854                 print "Assertions will be active on next 'R'!\n";
6855                 $ini_assertion = 1;
6856             }
6857             $^P &= ~$DollarCaretP_flags{PERLDBf_SUB};
6858             $^P |= $DollarCaretP_flags{PERLDBf_ASSERTION};
6859         }
6860         else {
6861             $^P |= $DollarCaretP_flags{PERLDBf_SUB};
6862         }
6863     }
6864     !( $^P & $DollarCaretP_flags{PERLDBf_SUB} ) || 0;
6865 }
6866
6867 =head2 C<pager>
6868
6869 Set up the C<$pager> variable. Adds a pipe to the front unless there's one
6870 there already.
6871
6872 =cut
6873
6874 sub pager {
6875     if (@_) {
6876         $pager = shift;
6877         $pager = "|" . $pager unless $pager =~ /^(\+?\>|\|)/;
6878     }
6879     $pager;
6880 } ## end sub pager
6881
6882 =head2 C<shellBang>
6883
6884 Sets the shell escape command, and generates a printable copy to be used
6885 in the help.
6886
6887 =cut
6888
6889 sub shellBang {
6890
6891     # If we got an argument, meta-quote it, and add '\b' if it
6892     # ends in a word character.
6893     if (@_) {
6894         $sh = quotemeta shift;
6895         $sh .= "\\b" if $sh =~ /\w$/;
6896     }
6897
6898     # Generate the printable version for the help:
6899     $psh = $sh;    # copy it
6900     $psh =~ s/\\b$//;        # Take off trailing \b if any
6901     $psh =~ s/\\(.)/$1/g;    # De-escape
6902     $psh;                    # return the printable version
6903 } ## end sub shellBang
6904
6905 =head2 C<ornaments>
6906
6907 If the terminal has its own ornaments, fetch them. Otherwise accept whatever
6908 was passed as the argument. (This means you can't override the terminal's
6909 ornaments.)
6910
6911 =cut
6912
6913 sub ornaments {
6914     if ( defined $term ) {
6915
6916         # We don't want to show warning backtraces, but we do want die() ones.
6917         local ( $warnLevel, $dieLevel ) = ( 0, 1 );
6918
6919         # No ornaments if the terminal doesn't support them.
6920         return '' unless $term->Features->{ornaments};
6921         eval { $term->ornaments(@_) } || '';
6922     }
6923
6924     # Use what was passed in if we can't determine it ourselves.
6925     else {
6926         $ornaments = shift;
6927     }
6928 } ## end sub ornaments
6929
6930 =head2 C<recallCommand>
6931
6932 Sets the recall command, and builds a printable version which will appear in
6933 the help text.
6934
6935 =cut
6936
6937 sub recallCommand {
6938
6939     # If there is input, metaquote it. Add '\b' if it ends with a word
6940     # character.
6941     if (@_) {
6942         $rc = quotemeta shift;
6943         $rc .= "\\b" if $rc =~ /\w$/;
6944     }
6945
6946     # Build it into a printable version.
6947     $prc = $rc;    # Copy it
6948     $prc =~ s/\\b$//;        # Remove trailing \b
6949     $prc =~ s/\\(.)/$1/g;    # Remove escapes
6950     $prc;                    # Return the printable version
6951 } ## end sub recallCommand
6952
6953 =head2 C<LineInfo> - where the line number information goes
6954
6955 Called with no arguments, returns the file or pipe that line info should go to.
6956
6957 Called with an argument (a file or a pipe), it opens that onto the
6958 C<LINEINFO> filehandle, unbuffers the filehandle, and then returns the
6959 file or pipe again to the caller.
6960
6961 =cut
6962
6963 sub LineInfo {
6964     return $lineinfo unless @_;
6965     $lineinfo = shift;
6966
6967     #  If this is a valid "thing to be opened for output", tack a
6968     # '>' onto the front.
6969     my $stream = ( $lineinfo =~ /^(\+?\>|\|)/ ) ? $lineinfo : ">$lineinfo";
6970
6971     # If this is a pipe, the stream points to a slave editor.
6972     $slave_editor = ( $stream =~ /^\|/ );
6973
6974     # Open it up and unbuffer it.
6975     open( LINEINFO, "$stream" ) || &warn("Cannot open `$stream' for write");
6976     $LINEINFO = \*LINEINFO;
6977     my $save = select($LINEINFO);
6978     $| = 1;
6979     select($save);
6980
6981     # Hand the file or pipe back again.
6982     $lineinfo;
6983 } ## end sub LineInfo
6984
6985 =head1 COMMAND SUPPORT ROUTINES
6986
6987 These subroutines provide functionality for various commands.
6988
6989 =head2 C<list_modules>
6990
6991 For the C<M> command: list modules loaded and their versions.
6992 Essentially just runs through the keys in %INC, picks up the
6993 $VERSION package globals from each package, gets the file name, and formats the
6994 information for output.
6995
6996 =cut
6997
6998 sub list_modules {    # versions
6999     my %version;
7000     my $file;
7001
7002     # keys are the "as-loaded" name, values are the fully-qualified path
7003     # to the file itself.
7004     for ( keys %INC ) {
7005         $file = $_;                                # get the module name
7006         s,\.p[lm]$,,i;                             # remove '.pl' or '.pm'
7007         s,/,::,g;                                  # change '/' to '::'
7008         s/^perl5db$/DB/;                           # Special case: debugger
7009                                                    # moves to package DB
7010         s/^Term::ReadLine::readline$/readline/;    # simplify readline
7011
7012         # If the package has a $VERSION package global (as all good packages
7013         # should!) decode it and save as partial message.
7014         if ( defined ${ $_ . '::VERSION' } ) {
7015             $version{$file} = "${ $_ . '::VERSION' } from ";
7016         }
7017
7018         # Finish up the message with the file the package came from.
7019         $version{$file} .= $INC{$file};
7020     } ## end for (keys %INC)
7021
7022     # Hey, dumpit() formats a hash nicely, so why not use it?
7023     dumpit( $OUT, \%version );
7024 } ## end sub list_modules
7025
7026 =head2 C<sethelp()>
7027
7028 Sets up the monster string used to format and print the help.
7029
7030 =head3 HELP MESSAGE FORMAT
7031
7032 The help message is a peculiar format unto itself; it mixes C<pod> 'ornaments'
7033 (BE<lt>E<gt>, IE<gt>E<lt>) with tabs to come up with a format that's fairly
7034 easy to parse and portable, but which still allows the help to be a little
7035 nicer than just plain text.
7036
7037 Essentially, you define the command name (usually marked up with BE<gt>E<lt>
7038 and IE<gt>E<lt>), followed by a tab, and then the descriptive text, ending in a newline. The descriptive text can also be marked up in the same way. If you
7039 need to continue the descriptive text to another line, start that line with
7040 just tabs and then enter the marked-up text.
7041
7042 If you are modifying the help text, I<be careful>. The help-string parser is
7043 not very sophisticated, and if you don't follow these rules it will mangle the
7044 help beyond hope until you fix the string.
7045
7046 =cut
7047
7048 sub sethelp {
7049
7050     # XXX: make sure there are tabs between the command and explanation,
7051     #      or print_help will screw up your formatting if you have
7052     #      eeevil ornaments enabled.  This is an insane mess.
7053
7054     $help = "
7055 Help is currently only available for the new 5.8 command set.
7056 No help is available for the old command set.
7057 We assume you know what you're doing if you switch to it.
7058
7059 B<T>        Stack trace.
7060 B<s> [I<expr>]    Single step [in I<expr>].
7061 B<n> [I<expr>]    Next, steps over subroutine calls [in I<expr>].
7062 <B<CR>>        Repeat last B<n> or B<s> command.
7063 B<r>        Return from current subroutine.
7064 B<c> [I<line>|I<sub>]    Continue; optionally inserts a one-time-only breakpoint
7065         at the specified position.
7066 B<l> I<min>B<+>I<incr>    List I<incr>+1 lines starting at I<min>.
7067 B<l> I<min>B<->I<max>    List lines I<min> through I<max>.
7068 B<l> I<line>        List single I<line>.
7069 B<l> I<subname>    List first window of lines from subroutine.
7070 B<l> I<\$var>        List first window of lines from subroutine referenced by I<\$var>.
7071 B<l>        List next window of lines.
7072 B<->        List previous window of lines.
7073 B<v> [I<line>]    View window around I<line>.
7074 B<.>        Return to the executed line.
7075 B<f> I<filename>    Switch to viewing I<filename>. File must be already loaded.
7076         I<filename> may be either the full name of the file, or a regular
7077         expression matching the full file name:
7078         B<f> I</home/me/foo.pl> and B<f> I<oo\\.> may access the same file.
7079         Evals (with saved bodies) are considered to be filenames:
7080         B<f> I<(eval 7)> and B<f> I<eval 7\\b> access the body of the 7th eval
7081         (in the order of execution).
7082 B</>I<pattern>B</>    Search forwards for I<pattern>; final B</> is optional.
7083 B<?>I<pattern>B<?>    Search backwards for I<pattern>; final B<?> is optional.
7084 B<L> [I<a|b|w>]        List actions and or breakpoints and or watch-expressions.
7085 B<S> [[B<!>]I<pattern>]    List subroutine names [not] matching I<pattern>.
7086 B<t>        Toggle trace mode.
7087 B<t> I<expr>        Trace through execution of I<expr>.
7088 B<b>        Sets breakpoint on current line)
7089 B<b> [I<line>] [I<condition>]
7090         Set breakpoint; I<line> defaults to the current execution line;
7091         I<condition> breaks if it evaluates to true, defaults to '1'.
7092 B<b> I<subname> [I<condition>]
7093         Set breakpoint at first line of subroutine.
7094 B<b> I<\$var>        Set breakpoint at first line of subroutine referenced by I<\$var>.
7095 B<b> B<load> I<filename> Set breakpoint on 'require'ing the given file.
7096 B<b> B<postpone> I<subname> [I<condition>]
7097         Set breakpoint at first line of subroutine after
7098         it is compiled.
7099 B<b> B<compile> I<subname>
7100         Stop after the subroutine is compiled.
7101 B<B> [I<line>]    Delete the breakpoint for I<line>.
7102 B<B> I<*>             Delete all breakpoints.
7103 B<a> [I<line>] I<command>
7104         Set an action to be done before the I<line> is executed;
7105         I<line> defaults to the current execution line.
7106         Sequence is: check for breakpoint/watchpoint, print line
7107         if necessary, do action, prompt user if necessary,
7108         execute line.
7109 B<a>        Does nothing
7110 B<A> [I<line>]    Delete the action for I<line>.
7111 B<A> I<*>             Delete all actions.
7112 B<w> I<expr>        Add a global watch-expression.
7113 B<w>             Does nothing
7114 B<W> I<expr>        Delete a global watch-expression.
7115 B<W> I<*>             Delete all watch-expressions.
7116 B<V> [I<pkg> [I<vars>]]    List some (default all) variables in package (default current).
7117         Use B<~>I<pattern> and B<!>I<pattern> for positive and negative regexps.
7118 B<X> [I<vars>]    Same as \"B<V> I<currentpackage> [I<vars>]\".
7119 B<x> I<expr>        Evals expression in list context, dumps the result.
7120 B<m> I<expr>        Evals expression in list context, prints methods callable
7121         on the first element of the result.
7122 B<m> I<class>        Prints methods callable via the given class.
7123 B<M>        Show versions of loaded modules.
7124 B<i> I<class>       Prints nested parents of given class.
7125 B<y> [I<n> [I<Vars>]]   List lexicals in higher scope <n>.  Vars same as B<V>.
7126 B<P> Something to do with assertions...
7127
7128 B<<> ?            List Perl commands to run before each prompt.
7129 B<<> I<expr>        Define Perl command to run before each prompt.
7130 B<<<> I<expr>        Add to the list of Perl commands to run before each prompt.
7131 B<< *>                Delete the list of perl commands to run before each prompt.
7132 B<>> ?            List Perl commands to run after each prompt.
7133 B<>> I<expr>        Define Perl command to run after each prompt.
7134 B<>>B<>> I<expr>        Add to the list of Perl commands to run after each prompt.
7135 B<>>B< *>        Delete the list of Perl commands to run after each prompt.
7136 B<{> I<db_command>    Define debugger command to run before each prompt.
7137 B<{> ?            List debugger commands to run before each prompt.
7138 B<{{> I<db_command>    Add to the list of debugger commands to run before each prompt.
7139 B<{ *>             Delete the list of debugger commands to run before each prompt.
7140 B<$prc> I<number>    Redo a previous command (default previous command).
7141 B<$prc> I<-number>    Redo number'th-to-last command.
7142 B<$prc> I<pattern>    Redo last command that started with I<pattern>.
7143         See 'B<O> I<recallCommand>' too.
7144 B<$psh$psh> I<cmd>      Run cmd in a subprocess (reads from DB::IN, writes to DB::OUT)"
7145       . (
7146         $rc eq $sh
7147         ? ""
7148         : "
7149 B<$psh> [I<cmd>] Run I<cmd> in subshell (forces \"\$SHELL -c 'cmd'\")."
7150       ) . "
7151         See 'B<O> I<shellBang>' too.
7152 B<source> I<file>        Execute I<file> containing debugger commands (may nest).
7153 B<save> I<file>       Save current debugger session (actual history) to I<file>.
7154 B<H> I<-number>    Display last number commands (default all).
7155 B<H> I<*>          Delete complete history.
7156 B<p> I<expr>        Same as \"I<print {DB::OUT} expr>\" in current package.
7157 B<|>I<dbcmd>        Run debugger command, piping DB::OUT to current pager.
7158 B<||>I<dbcmd>        Same as B<|>I<dbcmd> but DB::OUT is temporarilly select()ed as well.
7159 B<\=> [I<alias> I<value>]    Define a command alias, or list current aliases.
7160 I<command>        Execute as a perl statement in current package.
7161 B<R>        Pure-man-restart of debugger, some of debugger state
7162         and command-line options may be lost.
7163         Currently the following settings are preserved:
7164         history, breakpoints and actions, debugger B<O>ptions
7165         and the following command-line options: I<-w>, I<-I>, I<-e>.
7166
7167 B<o> [I<opt>] ...    Set boolean option to true
7168 B<o> [I<opt>B<?>]    Query options
7169 B<o> [I<opt>B<=>I<val>] [I<opt>=B<\">I<val>B<\">] ...
7170         Set options.  Use quotes in spaces in value.
7171     I<recallCommand>, I<ShellBang>    chars used to recall command or spawn shell;
7172     I<pager>            program for output of \"|cmd\";
7173     I<tkRunning>            run Tk while prompting (with ReadLine);
7174     I<signalLevel> I<warnLevel> I<dieLevel>    level of verbosity;
7175     I<inhibit_exit>        Allows stepping off the end of the script.
7176     I<ImmediateStop>        Debugger should stop as early as possible.
7177     I<RemotePort>            Remote hostname:port for remote debugging
7178   The following options affect what happens with B<V>, B<X>, and B<x> commands:
7179     I<arrayDepth>, I<hashDepth>     print only first N elements ('' for all);
7180     I<compactDump>, I<veryCompact>     change style of array and hash dump;
7181     I<globPrint>             whether to print contents of globs;
7182     I<DumpDBFiles>         dump arrays holding debugged files;
7183     I<DumpPackages>         dump symbol tables of packages;
7184     I<DumpReused>             dump contents of \"reused\" addresses;
7185     I<quote>, I<HighBit>, I<undefPrint>     change style of string dump;
7186     I<bareStringify>         Do not print the overload-stringified value;
7187   Other options include:
7188     I<PrintRet>        affects printing of return value after B<r> command,
7189     I<frame>        affects printing messages on subroutine entry/exit.
7190     I<AutoTrace>    affects printing messages on possible breaking points.
7191     I<maxTraceLen>    gives max length of evals/args listed in stack trace.
7192     I<ornaments>     affects screen appearance of the command line.
7193     I<CreateTTY>     bits control attempts to create a new TTY on events:
7194             1: on fork()    2: debugger is started inside debugger
7195             4: on startup
7196     During startup options are initialized from \$ENV{PERLDB_OPTS}.
7197     You can put additional initialization options I<TTY>, I<noTTY>,
7198     I<ReadLine>, I<NonStop>, and I<RemotePort> there (or use
7199     `B<R>' after you set them).
7200
7201 B<q> or B<^D>        Quit. Set B<\$DB::finished = 0> to debug global destruction.
7202 B<h>        Summary of debugger commands.
7203 B<h> [I<db_command>]    Get help [on a specific debugger command], enter B<|h> to page.
7204 B<h h>        Long help for debugger commands
7205 B<$doccmd> I<manpage>    Runs the external doc viewer B<$doccmd> command on the
7206         named Perl I<manpage>, or on B<$doccmd> itself if omitted.
7207         Set B<\$DB::doccmd> to change viewer.
7208
7209 Type `|h h' for a paged display if this was too hard to read.
7210
7211 ";    # Fix balance of vi % matching: }}}}
7212
7213     #  note: tabs in the following section are not-so-helpful
7214     $summary = <<"END_SUM";
7215 I<List/search source lines:>               I<Control script execution:>
7216   B<l> [I<ln>|I<sub>]  List source code            B<T>           Stack trace
7217   B<-> or B<.>      List previous/current line  B<s> [I<expr>]    Single step [in expr]
7218   B<v> [I<line>]    View around line            B<n> [I<expr>]    Next, steps over subs
7219   B<f> I<filename>  View source in file         <B<CR>/B<Enter>>  Repeat last B<n> or B<s>
7220   B</>I<pattern>B</> B<?>I<patt>B<?>   Search forw/backw    B<r>           Return from subroutine
7221   B<M>           Show module versions        B<c> [I<ln>|I<sub>]  Continue until position
7222 I<Debugger controls:>                        B<L>           List break/watch/actions
7223   B<o> [...]     Set debugger options        B<t> [I<expr>]    Toggle trace [trace expr]
7224   B<<>[B<<>]|B<{>[B<{>]|B<>>[B<>>] [I<cmd>] Do pre/post-prompt B<b> [I<ln>|I<event>|I<sub>] [I<cnd>] Set breakpoint
7225   B<$prc> [I<N>|I<pat>]   Redo a previous command     B<B> I<ln|*>      Delete a/all breakpoints
7226   B<H> [I<-num>]    Display last num commands   B<a> [I<ln>] I<cmd>  Do cmd before line
7227   B<=> [I<a> I<val>]   Define/list an alias        B<A> I<ln|*>      Delete a/all actions
7228   B<h> [I<db_cmd>]  Get help on command         B<w> I<expr>      Add a watch expression
7229   B<h h>         Complete help page          B<W> I<expr|*>    Delete a/all watch exprs
7230   B<|>[B<|>]I<db_cmd>  Send output to pager        B<$psh>\[B<$psh>\] I<syscmd> Run cmd in a subprocess
7231   B<q> or B<^D>     Quit                        B<R>           Attempt a restart
7232 I<Data Examination:>     B<expr>     Execute perl code, also see: B<s>,B<n>,B<t> I<expr>
7233   B<x>|B<m> I<expr>       Evals expr in list context, dumps the result or lists methods.
7234   B<p> I<expr>         Print expression (uses script's current package).
7235   B<S> [[B<!>]I<pat>]     List subroutine names [not] matching pattern
7236   B<V> [I<Pk> [I<Vars>]]  List Variables in Package.  Vars can be ~pattern or !pattern.
7237   B<X> [I<Vars>]       Same as \"B<V> I<current_package> [I<Vars>]\".  B<i> I<class> inheritance tree.
7238   B<y> [I<n> [I<Vars>]]   List lexicals in higher scope <n>.  Vars same as B<V>.
7239 For more help, type B<h> I<cmd_letter>, or run B<$doccmd perldebug> for all docs.
7240 END_SUM
7241
7242     # ')}}; # Fix balance of vi % matching
7243
7244     # and this is really numb...
7245     $pre580_help = "
7246 B<T>        Stack trace.
7247 B<s> [I<expr>]    Single step [in I<expr>].
7248 B<n> [I<expr>]    Next, steps over subroutine calls [in I<expr>].
7249 B<CR>>        Repeat last B<n> or B<s> command.
7250 B<r>        Return from current subroutine.
7251 B<c> [I<line>|I<sub>]    Continue; optionally inserts a one-time-only breakpoint
7252         at the specified position.
7253 B<l> I<min>B<+>I<incr>    List I<incr>+1 lines starting at I<min>.
7254 B<l> I<min>B<->I<max>    List lines I<min> through I<max>.
7255 B<l> I<line>        List single I<line>.
7256 B<l> I<subname>    List first window of lines from subroutine.
7257 B<l> I<\$var>        List first window of lines from subroutine referenced by I<\$var>.
7258 B<l>        List next window of lines.
7259 B<->        List previous window of lines.
7260 B<w> [I<line>]    List window around I<line>.
7261 B<.>        Return to the executed line.
7262 B<f> I<filename>    Switch to viewing I<filename>. File must be already loaded.
7263         I<filename> may be either the full name of the file, or a regular
7264         expression matching the full file name:
7265         B<f> I</home/me/foo.pl> and B<f> I<oo\\.> may access the same file.
7266         Evals (with saved bodies) are considered to be filenames:
7267         B<f> I<(eval 7)> and B<f> I<eval 7\\b> access the body of the 7th eval
7268         (in the order of execution).
7269 B</>I<pattern>B</>    Search forwards for I<pattern>; final B</> is optional.
7270 B<?>I<pattern>B<?>    Search backwards for I<pattern>; final B<?> is optional.
7271 B<L>        List all breakpoints and actions.
7272 B<S> [[B<!>]I<pattern>]    List subroutine names [not] matching I<pattern>.
7273 B<t>        Toggle trace mode.
7274 B<t> I<expr>        Trace through execution of I<expr>.
7275 B<b> [I<line>] [I<condition>]
7276         Set breakpoint; I<line> defaults to the current execution line;
7277         I<condition> breaks if it evaluates to true, defaults to '1'.
7278 B<b> I<subname> [I<condition>]
7279         Set breakpoint at first line of subroutine.
7280 B<b> I<\$var>        Set breakpoint at first line of subroutine referenced by I<\$var>.
7281 B<b> B<load> I<filename> Set breakpoint on `require'ing the given file.
7282 B<b> B<postpone> I<subname> [I<condition>]
7283         Set breakpoint at first line of subroutine after
7284         it is compiled.
7285 B<b> B<compile> I<subname>
7286         Stop after the subroutine is compiled.
7287 B<d> [I<line>]    Delete the breakpoint for I<line>.
7288 B<D>        Delete all breakpoints.
7289 B<a> [I<line>] I<command>
7290         Set an action to be done before the I<line> is executed;
7291         I<line> defaults to the current execution line.
7292         Sequence is: check for breakpoint/watchpoint, print line
7293         if necessary, do action, prompt user if necessary,
7294         execute line.
7295 B<a> [I<line>]    Delete the action for I<line>.
7296 B<A>        Delete all actions.
7297 B<W> I<expr>        Add a global watch-expression.
7298 B<W>        Delete all watch-expressions.
7299 B<V> [I<pkg> [I<vars>]]    List some (default all) variables in package (default current).
7300         Use B<~>I<pattern> and B<!>I<pattern> for positive and negative regexps.
7301 B<X> [I<vars>]    Same as \"B<V> I<currentpackage> [I<vars>]\".
7302 B<x> I<expr>        Evals expression in list context, dumps the result.
7303 B<m> I<expr>        Evals expression in list context, prints methods callable
7304         on the first element of the result.
7305 B<m> I<class>        Prints methods callable via the given class.
7306
7307 B<<> ?            List Perl commands to run before each prompt.
7308 B<<> I<expr>        Define Perl command to run before each prompt.
7309 B<<<> I<expr>        Add to the list of Perl commands to run before each prompt.
7310 B<>> ?            List Perl commands to run after each prompt.
7311 B<>> I<expr>        Define Perl command to run after each prompt.
7312 B<>>B<>> I<expr>        Add to the list of Perl commands to run after each prompt.
7313 B<{> I<db_command>    Define debugger command to run before each prompt.
7314 B<{> ?            List debugger commands to run before each prompt.
7315 B<{{> I<db_command>    Add to the list of debugger commands to run before each prompt.
7316 B<$prc> I<number>    Redo a previous command (default previous command).
7317 B<$prc> I<-number>    Redo number'th-to-last command.
7318 B<$prc> I<pattern>    Redo last command that started with I<pattern>.
7319         See 'B<O> I<recallCommand>' too.
7320 B<$psh$psh> I<cmd>      Run cmd in a subprocess (reads from DB::IN, writes to DB::OUT)"
7321       . (
7322         $rc eq $sh
7323         ? ""
7324         : "
7325 B<$psh> [I<cmd>]     Run I<cmd> in subshell (forces \"\$SHELL -c 'cmd'\")."
7326       ) . "
7327         See 'B<O> I<shellBang>' too.
7328 B<source> I<file>        Execute I<file> containing debugger commands (may nest).
7329 B<H> I<-number>    Display last number commands (default all).
7330 B<p> I<expr>        Same as \"I<print {DB::OUT} expr>\" in current package.
7331 B<|>I<dbcmd>        Run debugger command, piping DB::OUT to current pager.
7332 B<||>I<dbcmd>        Same as B<|>I<dbcmd> but DB::OUT is temporarilly select()ed as well.
7333 B<\=> [I<alias> I<value>]    Define a command alias, or list current aliases.
7334 I<command>        Execute as a perl statement in current package.
7335 B<v>        Show versions of loaded modules.
7336 B<R>        Pure-man-restart of debugger, some of debugger state
7337         and command-line options may be lost.
7338         Currently the following settings are preserved:
7339         history, breakpoints and actions, debugger B<O>ptions
7340         and the following command-line options: I<-w>, I<-I>, I<-e>.
7341
7342 B<O> [I<opt>] ...    Set boolean option to true
7343 B<O> [I<opt>B<?>]    Query options
7344 B<O> [I<opt>B<=>I<val>] [I<opt>=B<\">I<val>B<\">] ...
7345         Set options.  Use quotes in spaces in value.
7346     I<recallCommand>, I<ShellBang>    chars used to recall command or spawn shell;
7347     I<pager>            program for output of \"|cmd\";
7348     I<tkRunning>            run Tk while prompting (with ReadLine);
7349     I<signalLevel> I<warnLevel> I<dieLevel>    level of verbosity;
7350     I<inhibit_exit>        Allows stepping off the end of the script.
7351     I<ImmediateStop>        Debugger should stop as early as possible.
7352     I<RemotePort>            Remote hostname:port for remote debugging
7353   The following options affect what happens with B<V>, B<X>, and B<x> commands:
7354     I<arrayDepth>, I<hashDepth>     print only first N elements ('' for all);
7355     I<compactDump>, I<veryCompact>     change style of array and hash dump;
7356     I<globPrint>             whether to print contents of globs;
7357     I<DumpDBFiles>         dump arrays holding debugged files;
7358     I<DumpPackages>         dump symbol tables of packages;
7359     I<DumpReused>             dump contents of \"reused\" addresses;
7360     I<quote>, I<HighBit>, I<undefPrint>     change style of string dump;
7361     I<bareStringify>         Do not print the overload-stringified value;
7362   Other options include:
7363     I<PrintRet>        affects printing of return value after B<r> command,
7364     I<frame>        affects printing messages on subroutine entry/exit.
7365     I<AutoTrace>    affects printing messages on possible breaking points.
7366     I<maxTraceLen>    gives max length of evals/args listed in stack trace.
7367     I<ornaments>     affects screen appearance of the command line.
7368     I<CreateTTY>     bits control attempts to create a new TTY on events:
7369             1: on fork()    2: debugger is started inside debugger
7370             4: on startup
7371     During startup options are initialized from \$ENV{PERLDB_OPTS}.
7372     You can put additional initialization options I<TTY>, I<noTTY>,
7373     I<ReadLine>, I<NonStop>, and I<RemotePort> there (or use
7374     `B<R>' after you set them).
7375
7376 B<q> or B<^D>        Quit. Set B<\$DB::finished = 0> to debug global destruction.
7377 B<h> [I<db_command>]    Get help [on a specific debugger command], enter B<|h> to page.
7378 B<h h>        Summary of debugger commands.
7379 B<$doccmd> I<manpage>    Runs the external doc viewer B<$doccmd> command on the
7380         named Perl I<manpage>, or on B<$doccmd> itself if omitted.
7381         Set B<\$DB::doccmd> to change viewer.
7382
7383 Type `|h' for a paged display if this was too hard to read.
7384
7385 ";    # Fix balance of vi % matching: }}}}
7386
7387     #  note: tabs in the following section are not-so-helpful
7388     $pre580_summary = <<"END_SUM";
7389 I<List/search source lines:>               I<Control script execution:>
7390   B<l> [I<ln>|I<sub>]  List source code            B<T>           Stack trace
7391   B<-> or B<.>      List previous/current line  B<s> [I<expr>]    Single step [in expr]
7392   B<w> [I<line>]    List around line            B<n> [I<expr>]    Next, steps over subs
7393   B<f> I<filename>  View source in file         <B<CR>/B<Enter>>  Repeat last B<n> or B<s>
7394   B</>I<pattern>B</> B<?>I<patt>B<?>   Search forw/backw    B<r>           Return from subroutine
7395   B<v>           Show versions of modules    B<c> [I<ln>|I<sub>]  Continue until position
7396 I<Debugger controls:>                        B<L>           List break/watch/actions
7397   B<O> [...]     Set debugger options        B<t> [I<expr>]    Toggle trace [trace expr]
7398   B<<>[B<<>]|B<{>[B<{>]|B<>>[B<>>] [I<cmd>] Do pre/post-prompt B<b> [I<ln>|I<event>|I<sub>] [I<cnd>] Set breakpoint
7399   B<$prc> [I<N>|I<pat>]   Redo a previous command     B<d> [I<ln>] or B<D> Delete a/all breakpoints
7400   B<H> [I<-num>]    Display last num commands   B<a> [I<ln>] I<cmd>  Do cmd before line
7401   B<=> [I<a> I<val>]   Define/list an alias        B<W> I<expr>      Add a watch expression
7402   B<h> [I<db_cmd>]  Get help on command         B<A> or B<W>      Delete all actions/watch
7403   B<|>[B<|>]I<db_cmd>  Send output to pager        B<$psh>\[B<$psh>\] I<syscmd> Run cmd in a subprocess
7404   B<q> or B<^D>     Quit                        B<R>           Attempt a restart
7405 I<Data Examination:>     B<expr>     Execute perl code, also see: B<s>,B<n>,B<t> I<expr>
7406   B<x>|B<m> I<expr>       Evals expr in list context, dumps the result or lists methods.
7407   B<p> I<expr>         Print expression (uses script's current package).
7408   B<S> [[B<!>]I<pat>]     List subroutine names [not] matching pattern
7409   B<V> [I<Pk> [I<Vars>]]  List Variables in Package.  Vars can be ~pattern or !pattern.
7410   B<X> [I<Vars>]       Same as \"B<V> I<current_package> [I<Vars>]\".
7411   B<y> [I<n> [I<Vars>]]   List lexicals in higher scope <n>.  Vars same as B<V>.
7412 For more help, type B<h> I<cmd_letter>, or run B<$doccmd perldebug> for all docs.
7413 END_SUM
7414
7415     # ')}}; # Fix balance of vi % matching
7416
7417 } ## end sub sethelp
7418
7419 =head2 C<print_help()>
7420
7421 Most of what C<print_help> does is just text formatting. It finds the
7422 C<B> and C<I> ornaments, cleans them off, and substitutes the proper
7423 terminal control characters to simulate them (courtesy of
7424 <Term::ReadLine::TermCap>).
7425
7426 =cut
7427
7428 sub print_help {
7429     local $_ = shift;
7430
7431     # Restore proper alignment destroyed by eeevil I<> and B<>
7432     # ornaments: A pox on both their houses!
7433     #
7434     # A help command will have everything up to and including
7435     # the first tab sequence padded into a field 16 (or if indented 20)
7436     # wide.  If it's wider than that, an extra space will be added.
7437     s{
7438         ^                       # only matters at start of line
7439           ( \040{4} | \t )*     # some subcommands are indented
7440           ( < ?                 # so <CR> works
7441             [BI] < [^\t\n] + )  # find an eeevil ornament
7442           ( \t+ )               # original separation, discarded
7443           ( .* )                # this will now start (no earlier) than
7444                                 # column 16
7445     } {
7446         my($leadwhite, $command, $midwhite, $text) = ($1, $2, $3, $4);
7447         my $clean = $command;
7448         $clean =~ s/[BI]<([^>]*)>/$1/g;
7449
7450         # replace with this whole string:
7451         ($leadwhite ? " " x 4 : "")
7452       . $command
7453       . ((" " x (16 + ($leadwhite ? 4 : 0) - length($clean))) || " ")
7454       . $text;
7455
7456     }mgex;
7457
7458     s{                          # handle bold ornaments
7459        B < ( [^>] + | > ) >
7460     } {
7461           $Term::ReadLine::TermCap::rl_term_set[2]
7462         . $1
7463         . $Term::ReadLine::TermCap::rl_term_set[3]
7464     }gex;
7465
7466     s{                         # handle italic ornaments
7467        I < ( [^>] + | > ) >
7468     } {
7469           $Term::ReadLine::TermCap::rl_term_set[0]
7470         . $1
7471         . $Term::ReadLine::TermCap::rl_term_set[1]
7472     }gex;
7473
7474     local $\ = '';
7475     print $OUT $_;
7476 } ## end sub print_help
7477
7478 =head2 C<fix_less>
7479
7480 This routine does a lot of gyrations to be sure that the pager is C<less>.
7481 It checks for C<less> masquerading as C<more> and records the result in
7482 C<$ENV{LESS}> so we don't have to go through doing the stats again.
7483
7484 =cut
7485
7486 sub fix_less {
7487
7488     # We already know if this is set.
7489     return if defined $ENV{LESS} && $ENV{LESS} =~ /r/;
7490
7491     # Pager is less for sure.
7492     my $is_less = $pager =~ /\bless\b/;
7493     if ( $pager =~ /\bmore\b/ ) {
7494
7495         # Nope, set to more. See what's out there.
7496         my @st_more = stat('/usr/bin/more');
7497         my @st_less = stat('/usr/bin/less');
7498
7499         # is it really less, pretending to be more?
7500              $is_less = @st_more
7501           && @st_less
7502           && $st_more[0] == $st_less[0]
7503           && $st_more[1] == $st_less[1];
7504     } ## end if ($pager =~ /\bmore\b/)
7505
7506     # changes environment!
7507     # 'r' added so we don't do (slow) stats again.
7508     $ENV{LESS} .= 'r' if $is_less;
7509 } ## end sub fix_less
7510
7511 =head1 DIE AND WARN MANAGEMENT
7512
7513 =head2 C<diesignal>
7514
7515 C<diesignal> is a just-drop-dead C<die> handler. It's most useful when trying
7516 to debug a debugger problem.
7517
7518 It does its best to report the error that occurred, and then forces the
7519 program, debugger, and everything to die.
7520
7521 =cut
7522
7523 sub diesignal {
7524
7525     # No entry/exit messages.
7526     local $frame = 0;
7527
7528     # No return value prints.
7529     local $doret = -2;
7530
7531     # set the abort signal handling to the default (just terminate).
7532     $SIG{'ABRT'} = 'DEFAULT';
7533
7534     # If we enter the signal handler recursively, kill myself with an
7535     # abort signal (so we just terminate).
7536     kill 'ABRT', $$ if $panic++;
7537
7538     # If we can show detailed info, do so.
7539     if ( defined &Carp::longmess ) {
7540
7541         # Don't recursively enter the warn handler, since we're carping.
7542         local $SIG{__WARN__} = '';
7543
7544         # Skip two levels before reporting traceback: we're skipping
7545         # mydie and confess.
7546         local $Carp::CarpLevel = 2;    # mydie + confess
7547
7548         # Tell us all about it.
7549         &warn( Carp::longmess("Signal @_") );
7550     }
7551
7552     # No Carp. Tell us about the signal as best we can.
7553     else {
7554         local $\ = '';
7555         print $DB::OUT "Got signal @_\n";
7556     }
7557
7558     # Drop dead.
7559     kill 'ABRT', $$;
7560 } ## end sub diesignal
7561
7562 =head2 C<dbwarn>
7563
7564 The debugger's own default C<$SIG{__WARN__}> handler. We load C<Carp> to
7565 be able to get a stack trace, and output the warning message vi C<DB::dbwarn()>.
7566
7567 =cut
7568
7569 sub dbwarn {
7570
7571     # No entry/exit trace.
7572     local $frame = 0;
7573
7574     # No return value printing.
7575     local $doret = -2;
7576
7577     # Turn off warn and die handling to prevent recursive entries to this
7578     # routine.
7579     local $SIG{__WARN__} = '';
7580     local $SIG{__DIE__}  = '';
7581
7582     # Load Carp if we can. If $^S is false (current thing being compiled isn't
7583     # done yet), we may not be able to do a require.
7584     eval { require Carp }
7585       if defined $^S;    # If error/warning during compilation,
7586                          # require may be broken.
7587
7588     # Use the core warn() unless Carp loaded OK.
7589     CORE::warn( @_,
7590         "\nCannot print stack trace, load with -MCarp option to see stack" ),
7591       return
7592       unless defined &Carp::longmess;
7593
7594     # Save the current values of $single and $trace, and then turn them off.
7595     my ( $mysingle, $mytrace ) = ( $single, $trace );
7596     $single = 0;
7597     $trace  = 0;
7598
7599     # We can call Carp::longmess without its being "debugged" (which we
7600     # don't want - we just want to use it!). Capture this for later.
7601     my $mess = Carp::longmess(@_);
7602
7603     # Restore $single and $trace to their original values.
7604     ( $single, $trace ) = ( $mysingle, $mytrace );
7605
7606     # Use the debugger's own special way of printing warnings to print
7607     # the stack trace message.
7608     &warn($mess);
7609 } ## end sub dbwarn
7610
7611 =head2 C<dbdie>
7612
7613 The debugger's own C<$SIG{__DIE__}> handler. Handles providing a stack trace
7614 by loading C<Carp> and calling C<Carp::longmess()> to get it. We turn off
7615 single stepping and tracing during the call to C<Carp::longmess> to avoid
7616 debugging it - we just want to use it.
7617
7618 If C<dieLevel> is zero, we let the program being debugged handle the
7619 exceptions. If it's 1, you get backtraces for any exception. If it's 2,
7620 the debugger takes over all exception handling, printing a backtrace and
7621 displaying the exception via its C<dbwarn()> routine.
7622
7623 =cut
7624
7625 sub dbdie {
7626     local $frame         = 0;
7627     local $doret         = -2;
7628     local $SIG{__DIE__}  = '';
7629     local $SIG{__WARN__} = '';
7630     my $i      = 0;
7631     my $ineval = 0;
7632     my $sub;
7633     if ( $dieLevel > 2 ) {
7634         local $SIG{__WARN__} = \&dbwarn;
7635         &warn(@_);    # Yell no matter what
7636         return;
7637     }
7638     if ( $dieLevel < 2 ) {
7639         die @_ if $^S;    # in eval propagate
7640     }
7641
7642     # The code used to check $^S to see if compiliation of the current thing
7643     # hadn't finished. We don't do it anymore, figuring eval is pretty stable.
7644     eval { require Carp };
7645
7646     die( @_,
7647         "\nCannot print stack trace, load with -MCarp option to see stack" )
7648       unless defined &Carp::longmess;
7649
7650     # We do not want to debug this chunk (automatic disabling works
7651     # inside DB::DB, but not in Carp). Save $single and $trace, turn them off,
7652     # get the stack trace from Carp::longmess (if possible), restore $signal
7653     # and $trace, and then die with the stack trace.
7654     my ( $mysingle, $mytrace ) = ( $single, $trace );
7655     $single = 0;
7656     $trace  = 0;
7657     my $mess = "@_";
7658     {
7659
7660         package Carp;    # Do not include us in the list
7661         eval { $mess = Carp::longmess(@_); };
7662     }
7663     ( $single, $trace ) = ( $mysingle, $mytrace );
7664     die $mess;
7665 } ## end sub dbdie
7666
7667 =head2 C<warnlevel()>
7668
7669 Set the C<$DB::warnLevel> variable that stores the value of the
7670 C<warnLevel> option. Calling C<warnLevel()> with a positive value
7671 results in the debugger taking over all warning handlers. Setting
7672 C<warnLevel> to zero leaves any warning handlers set up by the program
7673 being debugged in place.
7674
7675 =cut
7676
7677 sub warnLevel {
7678     if (@_) {
7679         $prevwarn = $SIG{__WARN__} unless $warnLevel;
7680         $warnLevel = shift;
7681         if ($warnLevel) {
7682             $SIG{__WARN__} = \&DB::dbwarn;
7683         }
7684         elsif ($prevwarn) {
7685             $SIG{__WARN__} = $prevwarn;
7686         }
7687     } ## end if (@_)
7688     $warnLevel;
7689 } ## end sub warnLevel
7690
7691 =head2 C<dielevel>
7692
7693 Similar to C<warnLevel>. Non-zero values for C<dieLevel> result in the
7694 C<DB::dbdie()> function overriding any other C<die()> handler. Setting it to
7695 zero lets you use your own C<die()> handler.
7696
7697 =cut
7698
7699 sub dieLevel {
7700     local $\ = '';
7701     if (@_) {
7702         $prevdie = $SIG{__DIE__} unless $dieLevel;
7703         $dieLevel = shift;
7704         if ($dieLevel) {
7705
7706             # Always set it to dbdie() for non-zero values.
7707             $SIG{__DIE__} = \&DB::dbdie;    # if $dieLevel < 2;
7708
7709             # No longer exists, so don't try  to use it.
7710             #$SIG{__DIE__} = \&DB::diehard if $dieLevel >= 2;
7711
7712             # If we've finished initialization, mention that stack dumps
7713             # are enabled, If dieLevel is 1, we won't stack dump if we die
7714             # in an eval().
7715             print $OUT "Stack dump during die enabled",
7716               ( $dieLevel == 1 ? " outside of evals" : "" ), ".\n"
7717               if $I_m_init;
7718
7719             # XXX This is probably obsolete, given that diehard() is gone.
7720             print $OUT "Dump printed too.\n" if $dieLevel > 2;
7721         } ## end if ($dieLevel)
7722
7723         # Put the old one back if there was one.
7724         elsif ($prevdie) {
7725             $SIG{__DIE__} = $prevdie;
7726             print $OUT "Default die handler restored.\n";
7727         }
7728     } ## end if (@_)
7729     $dieLevel;
7730 } ## end sub dieLevel
7731
7732 =head2 C<signalLevel>
7733
7734 Number three in a series: set C<signalLevel> to zero to keep your own
7735 signal handler for C<SIGSEGV> and/or C<SIGBUS>. Otherwise, the debugger
7736 takes over and handles them with C<DB::diesignal()>.
7737
7738 =cut
7739
7740 sub signalLevel {
7741     if (@_) {
7742         $prevsegv = $SIG{SEGV} unless $signalLevel;
7743         $prevbus  = $SIG{BUS}  unless $signalLevel;
7744         $signalLevel = shift;
7745         if ($signalLevel) {
7746             $SIG{SEGV} = \&DB::diesignal;
7747             $SIG{BUS}  = \&DB::diesignal;
7748         }
7749         else {
7750             $SIG{SEGV} = $prevsegv;
7751             $SIG{BUS}  = $prevbus;
7752         }
7753     } ## end if (@_)
7754     $signalLevel;
7755 } ## end sub signalLevel
7756
7757 =head1 SUBROUTINE DECODING SUPPORT
7758
7759 These subroutines are used during the C<x> and C<X> commands to try to
7760 produce as much information as possible about a code reference. They use
7761 L<Devel::Peek> to try to find the glob in which this code reference lives
7762 (if it does) - this allows us to actually code references which correspond
7763 to named subroutines (including those aliased via glob assignment).
7764
7765 =head2 C<CvGV_name()>
7766
7767 Wrapper for X<CvGV_name_or_bust>; tries to get the name of a reference
7768 via that routine. If this fails, return the reference again (when the
7769 reference is stringified, it'll come out as "SOMETHING(0X...)").
7770
7771 =cut
7772
7773 sub CvGV_name {
7774     my $in   = shift;
7775     my $name = CvGV_name_or_bust($in);
7776     defined $name ? $name : $in;
7777 }
7778
7779 =head2 C<CvGV_name_or_bust> I<coderef>
7780
7781 Calls L<Devel::Peek> to try to find the glob the ref lives in; returns
7782 C<undef> if L<Devel::Peek> can't be loaded, or if C<Devel::Peek::CvGV> can't
7783 find a glob for this ref.
7784
7785 Returns "I<package>::I<glob name>" if the code ref is found in a glob.
7786
7787 =cut
7788
7789 sub CvGV_name_or_bust {
7790     my $in = shift;
7791     return if $skipCvGV;    # Backdoor to avoid problems if XS broken...
7792     return unless ref $in;
7793     $in = \&$in;            # Hard reference...
7794     eval { require Devel::Peek; 1 } or return;
7795     my $gv = Devel::Peek::CvGV($in) or return;
7796     *$gv{PACKAGE} . '::' . *$gv{NAME};
7797 } ## end sub CvGV_name_or_bust
7798
7799 =head2 C<find_sub>
7800
7801 A utility routine used in various places; finds the file where a subroutine
7802 was defined, and returns that filename and a line-number range.
7803
7804 Tries to use X<@sub> first; if it can't find it there, it tries building a
7805 reference to the subroutine and uses X<CvGV_name_or_bust> to locate it,
7806 loading it into X<@sub> as a side effect (XXX I think). If it can't find it
7807 this way, it brute-force searches X<%sub>, checking for identical references.
7808
7809 =cut
7810
7811 sub find_sub {
7812     my $subr = shift;
7813     $sub{$subr} or do {
7814         return unless defined &$subr;
7815         my $name = CvGV_name_or_bust($subr);
7816         my $data;
7817         $data = $sub{$name} if defined $name;
7818         return $data if defined $data;
7819
7820         # Old stupid way...
7821         $subr = \&$subr;    # Hard reference
7822         my $s;
7823         for ( keys %sub ) {
7824             $s = $_, last if $subr eq \&$_;
7825         }
7826         $sub{$s} if $s;
7827       } ## end do
7828 } ## end sub find_sub
7829
7830 =head2 C<methods>
7831
7832 A subroutine that uses the utility function X<methods_via> to find all the
7833 methods in the class corresponding to the current reference and in
7834 C<UNIVERSAL>.
7835
7836 =cut
7837
7838 sub methods {
7839
7840     # Figure out the class - either this is the class or it's a reference
7841     # to something blessed into that class.
7842     my $class = shift;
7843     $class = ref $class if ref $class;
7844
7845     local %seen;
7846
7847     # Show the methods that this class has.
7848     methods_via( $class, '', 1 );
7849
7850     # Show the methods that UNIVERSAL has.
7851     methods_via( 'UNIVERSAL', 'UNIVERSAL', 0 );
7852 } ## end sub methods
7853
7854 =head2 C<methods_via($class, $prefix, $crawl_upward)>
7855
7856 C<methods_via> does the work of crawling up the C<@ISA> tree and reporting
7857 all the parent class methods. C<$class> is the name of the next class to
7858 try; C<$prefix> is the message prefix, which gets built up as we go up the
7859 C<@ISA> tree to show parentage; C<$crawl_upward> is 1 if we should try to go
7860 higher in the C<@ISA> tree, 0 if we should stop.
7861
7862 =cut
7863
7864 sub methods_via {
7865
7866     # If we've processed this class already, just quit.
7867     my $class = shift;
7868     return if $seen{$class}++;
7869
7870     # This is a package that is contributing the methods we're about to print.
7871     my $prefix  = shift;
7872     my $prepend = $prefix ? "via $prefix: " : '';
7873
7874     my $name;
7875     for $name (
7876
7877         # Keep if this is a defined subroutine in this class.
7878         grep { defined &{ ${"${class}::"}{$_} } }
7879
7880         # Extract from all the symbols in this class.
7881         sort keys %{"${class}::"}
7882       )
7883     {
7884
7885         # If we printed this already, skip it.
7886         next if $seen{$name}++;
7887
7888         # Print the new method name.
7889         local $\ = '';
7890         local $, = '';
7891         print $DB::OUT "$prepend$name\n";
7892     } ## end for $name (grep { defined...
7893
7894     # If the $crawl_upward argument is false, just quit here.
7895     return unless shift;
7896
7897     # $crawl_upward true: keep going up the tree.
7898     # Find all the classes this one is a subclass of.
7899     for $name ( @{"${class}::ISA"} ) {
7900
7901         # Set up the new prefix.
7902         $prepend = $prefix ? $prefix . " -> $name" : $name;
7903
7904         # Crawl up the tree and keep trying to crawl up.
7905         methods_via( $name, $prepend, 1 );
7906     }
7907 } ## end sub methods_via
7908
7909 =head2 C<setman> - figure out which command to use to show documentation
7910
7911 Just checks the contents of C<$^O> and sets the C<$doccmd> global accordingly.
7912
7913 =cut
7914
7915 sub setman {
7916     $doccmd = $^O !~ /^(?:MSWin32|VMS|os2|dos|amigaos|riscos|MacOS|NetWare)\z/s
7917       ? "man"         # O Happy Day!
7918       : "perldoc";    # Alas, poor unfortunates
7919 } ## end sub setman
7920
7921 =head2 C<runman> - run the appropriate command to show documentation
7922
7923 Accepts a man page name; runs the appropriate command to display it (set up
7924 during debugger initialization). Uses C<DB::system> to avoid mucking up the
7925 program's STDIN and STDOUT.
7926
7927 =cut
7928
7929 sub runman {
7930     my $page = shift;
7931     unless ($page) {
7932         &system("$doccmd $doccmd");
7933         return;
7934     }
7935
7936     # this way user can override, like with $doccmd="man -Mwhatever"
7937     # or even just "man " to disable the path check.
7938     unless ( $doccmd eq 'man' ) {
7939         &system("$doccmd $page");
7940         return;
7941     }
7942
7943     $page = 'perl' if lc($page) eq 'help';
7944
7945     require Config;
7946     my $man1dir = $Config::Config{'man1dir'};
7947     my $man3dir = $Config::Config{'man3dir'};
7948     for ( $man1dir, $man3dir ) { s#/[^/]*\z## if /\S/ }
7949     my $manpath = '';
7950     $manpath .= "$man1dir:" if $man1dir =~ /\S/;
7951     $manpath .= "$man3dir:" if $man3dir =~ /\S/ && $man1dir ne $man3dir;
7952     chop $manpath if $manpath;
7953
7954     # harmless if missing, I figure
7955     my $oldpath = $ENV{MANPATH};
7956     $ENV{MANPATH} = $manpath if $manpath;
7957     my $nopathopt = $^O =~ /dunno what goes here/;
7958     if (
7959         CORE::system(
7960             $doccmd,
7961
7962             # I just *know* there are men without -M
7963             ( ( $manpath && !$nopathopt ) ? ( "-M", $manpath ) : () ),
7964             split ' ', $page
7965         )
7966       )
7967     {
7968         unless ( $page =~ /^perl\w/ ) {
7969             if (
7970                 grep { $page eq $_ }
7971                 qw{
7972                 5004delta 5005delta amiga api apio book boot bot call compile
7973                 cygwin data dbmfilter debug debguts delta diag doc dos dsc embed
7974                 faq faq1 faq2 faq3 faq4 faq5 faq6 faq7 faq8 faq9 filter fork
7975                 form func guts hack hist hpux intern ipc lexwarn locale lol mod
7976                 modinstall modlib number obj op opentut os2 os390 pod port
7977                 ref reftut run sec style sub syn thrtut tie toc todo toot tootc
7978                 trap unicode var vms win32 xs xstut
7979                 }
7980               )
7981             {
7982                 $page =~ s/^/perl/;
7983                 CORE::system( $doccmd,
7984                     ( ( $manpath && !$nopathopt ) ? ( "-M", $manpath ) : () ),
7985                     $page );
7986             } ## end if (grep { $page eq $_...
7987         } ## end unless ($page =~ /^perl\w/)
7988     } ## end if (CORE::system($doccmd...
7989     if ( defined $oldpath ) {
7990         $ENV{MANPATH} = $manpath;
7991     }
7992     else {
7993         delete $ENV{MANPATH};
7994     }
7995 } ## end sub runman
7996
7997 #use Carp;                          # This did break, left for debugging
7998
7999 =head1 DEBUGGER INITIALIZATION - THE SECOND BEGIN BLOCK
8000
8001 Because of the way the debugger interface to the Perl core is designed, any
8002 debugger package globals that C<DB::sub()> requires have to be defined before
8003 any subroutines can be called. These are defined in the second C<BEGIN> block.
8004
8005 This block sets things up so that (basically) the world is sane
8006 before the debugger starts executing. We set up various variables that the
8007 debugger has to have set up before the Perl core starts running:
8008
8009 =over 4
8010
8011 =item * The debugger's own filehandles (copies of STD and STDOUT for now).
8012
8013 =item * Characters for shell escapes, the recall command, and the history command.
8014
8015 =item * The maximum recursion depth.
8016
8017 =item * The size of a C<w> command's window.
8018
8019 =item * The before-this-line context to be printed in a C<v> (view a window around this line) command.
8020
8021 =item * The fact that we're not in a sub at all right now.
8022
8023 =item * The default SIGINT handler for the debugger.
8024
8025 =item * The appropriate value of the flag in C<$^D> that says the debugger is running
8026
8027 =item * The current debugger recursion level
8028
8029 =item * The list of postponed (XXX define) items and the C<$single> stack
8030
8031 =item * That we want no return values and no subroutine entry/exit trace.
8032
8033 =back
8034
8035 =cut
8036
8037 # The following BEGIN is very handy if debugger goes havoc, debugging debugger?
8038
8039 BEGIN {    # This does not compile, alas. (XXX eh?)
8040     $IN  = \*STDIN;     # For bugs before DB::OUT has been opened
8041     $OUT = \*STDERR;    # For errors before DB::OUT has been opened
8042
8043     # Define characters used by command parsing.
8044     $sh       = '!';      # Shell escape (does not work)
8045     $rc       = ',';      # Recall command (does not work)
8046     @hist     = ('?');    # Show history (does not work)
8047     @truehist = ();       # Can be saved for replay (per session)
8048
8049     # This defines the point at which you get the 'deep recursion'
8050     # warning. It MUST be defined or the debugger will not load.
8051     $deep = 100;
8052
8053     # Number of lines around the current one that are shown in the
8054     # 'w' command.
8055     $window = 10;
8056
8057     # How much before-the-current-line context the 'v' command should
8058     # use in calculating the start of the window it will display.
8059     $preview = 3;
8060
8061     # We're not in any sub yet, but we need this to be a defined value.
8062     $sub = '';
8063
8064     # Set up the debugger's interrupt handler. It simply sets a flag
8065     # ($signal) that DB::DB() will check before each command is executed.
8066     $SIG{INT} = \&DB::catch;
8067
8068     # The following lines supposedly, if uncommented, allow the debugger to
8069     # debug itself. Perhaps we can try that someday.
8070     # This may be enabled to debug debugger:
8071     #$warnLevel = 1 unless defined $warnLevel;
8072     #$dieLevel = 1 unless defined $dieLevel;
8073     #$signalLevel = 1 unless defined $signalLevel;
8074
8075     # This is the flag that says "a debugger is running, please call
8076     # DB::DB and DB::sub". We will turn it on forcibly before we try to
8077     # execute anything in the user's context, because we always want to
8078     # get control back.
8079     $db_stop = 0;          # Compiler warning ...
8080     $db_stop = 1 << 30;    # ... because this is only used in an eval() later.
8081
8082     # This variable records how many levels we're nested in debugging. Used
8083     # Used in the debugger prompt, and in determining whether it's all over or
8084     # not.
8085     $level = 0;            # Level of recursive debugging
8086
8087     # "Triggers bug (?) in perl if we postpone this until runtime."
8088     # XXX No details on this yet, or whether we should fix the bug instead
8089     # of work around it. Stay tuned.
8090     @postponed = @stack = (0);
8091
8092     # Used to track the current stack depth using the auto-stacked-variable
8093     # trick.
8094     $stack_depth = 0;      # Localized repeatedly; simple way to track $#stack
8095
8096     # Don't print return values on exiting a subroutine.
8097     $doret = -2;
8098
8099     # No extry/exit tracing.
8100     $frame = 0;
8101
8102 } ## end BEGIN
8103
8104 BEGIN { $^W = $ini_warn; }    # Switch warnings back
8105
8106 =head1 READLINE SUPPORT - COMPLETION FUNCTION
8107
8108 =head2 db_complete
8109
8110 C<readline> support - adds command completion to basic C<readline>.
8111
8112 Returns a list of possible completions to C<readline> when invoked. C<readline>
8113 will print the longest common substring following the text already entered.
8114
8115 If there is only a single possible completion, C<readline> will use it in full.
8116
8117 This code uses C<map> and C<grep> heavily to create lists of possible
8118 completion. Think LISP in this section.
8119
8120 =cut
8121
8122 sub db_complete {
8123
8124     # Specific code for b c l V m f O, &blah, $blah, @blah, %blah
8125     # $text is the text to be completed.
8126     # $line is the incoming line typed by the user.
8127     # $start is the start of the text to be completed in the incoming line.
8128     my ( $text, $line, $start ) = @_;
8129
8130     # Save the initial text.
8131     # The search pattern is current package, ::, extract the next qualifier
8132     # Prefix and pack are set to undef.
8133     my ( $itext, $search, $prefix, $pack ) =
8134       ( $text, "^\Q${'package'}::\E([^:]+)\$" );
8135
8136 =head3 C<b postpone|compile>
8137
8138 =over 4
8139
8140 =item * Find all the subroutines that might match in this package
8141
8142 =item * Add "postpone", "load", and "compile" as possibles (we may be completing the keyword itself
8143
8144 =item * Include all the rest of the subs that are known
8145
8146 =item * C<grep> out the ones that match the text we have so far
8147
8148 =item * Return this as the list of possible completions
8149
8150 =back
8151
8152 =cut
8153
8154     return sort grep /^\Q$text/, ( keys %sub ),
8155       qw(postpone load compile),    # subroutines
8156       ( map { /$search/ ? ($1) : () } keys %sub )
8157       if ( substr $line, 0, $start ) =~ /^\|*[blc]\s+((postpone|compile)\s+)?$/;
8158
8159 =head3 C<b load>
8160
8161 Get all the possible files from @INC as it currently stands and
8162 select the ones that match the text so far.
8163
8164 =cut
8165
8166     return sort grep /^\Q$text/, values %INC    # files
8167       if ( substr $line, 0, $start ) =~ /^\|*b\s+load\s+$/;
8168
8169 =head3  C<V> (list variable) and C<m> (list modules)
8170
8171 There are two entry points for these commands:
8172
8173 =head4 Unqualified package names
8174
8175 Get the top-level packages and grab everything that matches the text
8176 so far. For each match, recursively complete the partial packages to
8177 get all possible matching packages. Return this sorted list.
8178
8179 =cut
8180
8181     return sort map { ( $_, db_complete( $_ . "::", "V ", 2 ) ) }
8182       grep /^\Q$text/, map { /^(.*)::$/ ? ($1) : () } keys %::    # top-packages
8183       if ( substr $line, 0, $start ) =~ /^\|*[Vm]\s+$/ and $text =~ /^\w*$/;
8184
8185 =head4 Qualified package names
8186
8187 Take a partially-qualified package and find all subpackages for it
8188 by getting all the subpackages for the package so far, matching all
8189 the subpackages against the text, and discarding all of them which
8190 start with 'main::'. Return this list.
8191
8192 =cut
8193
8194     return sort map { ( $_, db_complete( $_ . "::", "V ", 2 ) ) }
8195       grep !/^main::/, grep /^\Q$text/,
8196       map { /^(.*)::$/ ? ( $prefix . "::$1" ) : () } keys %{ $prefix . '::' }
8197       if ( substr $line, 0, $start ) =~ /^\|*[Vm]\s+$/
8198       and $text =~ /^(.*[^:])::?(\w*)$/
8199       and $prefix = $1;
8200
8201 =head3 C<f> - switch files
8202
8203 Here, we want to get a fully-qualified filename for the C<f> command.
8204 Possibilities are:
8205
8206 =over 4
8207
8208 =item 1. The original source file itself
8209
8210 =item 2. A file from C<@INC>
8211
8212 =item 3. An C<eval> (the debugger gets a C<(eval N)> fake file for each C<eval>).
8213
8214 =back
8215
8216 =cut
8217
8218     if ( $line =~ /^\|*f\s+(.*)/ ) {    # Loaded files
8219            # We might possibly want to switch to an eval (which has a "filename"
8220            # like '(eval 9)'), so we may need to clean up the completion text
8221            # before proceeding.
8222         $prefix = length($1) - length($text);
8223         $text   = $1;
8224
8225 =pod
8226
8227 Under the debugger, source files are represented as C<_E<lt>/fullpath/to/file>
8228 (C<eval>s are C<_E<lt>(eval NNN)>) keys in C<%main::>. We pull all of these
8229 out of C<%main::>, add the initial source file, and extract the ones that
8230 match the completion text so far.
8231
8232 =cut
8233
8234         return sort
8235           map { substr $_, 2 + $prefix } grep /^_<\Q$text/, ( keys %main:: ),
8236           $0;
8237     } ## end if ($line =~ /^\|*f\s+(.*)/)
8238
8239 =head3 Subroutine name completion
8240
8241 We look through all of the defined subs (the keys of C<%sub>) and
8242 return both all the possible matches to the subroutine name plus
8243 all the matches qualified to the current package.
8244
8245 =cut
8246
8247     if ( ( substr $text, 0, 1 ) eq '&' ) {    # subroutines
8248         $text = substr $text, 1;
8249         $prefix = "&";
8250         return sort map "$prefix$_", grep /^\Q$text/, ( keys %sub ),
8251           (
8252             map { /$search/ ? ($1) : () }
8253               keys %sub
8254           );
8255     } ## end if ((substr $text, 0, ...
8256
8257 =head3  Scalar, array, and hash completion: partially qualified package
8258
8259 Much like the above, except we have to do a little more cleanup:
8260
8261 =cut
8262
8263     if ( $text =~ /^[\$@%](.*)::(.*)/ ) {    # symbols in a package
8264
8265 =pod
8266
8267 =over 4
8268
8269 =item * Determine the package that the symbol is in. Put it in C<::> (effectively C<main::>) if no package is specified.
8270
8271 =cut
8272
8273         $pack = ( $1 eq 'main' ? '' : $1 ) . '::';
8274
8275 =pod
8276
8277 =item * Figure out the prefix vs. what needs completing.
8278
8279 =cut
8280
8281         $prefix = ( substr $text, 0, 1 ) . $1 . '::';
8282         $text   = $2;
8283
8284 =pod
8285
8286 =item * Look through all the symbols in the package. C<grep> out all the possible hashes/arrays/scalars, and then C<grep> the possible matches out of those. C<map> the prefix onto all the possibilities.
8287
8288 =cut
8289
8290         my @out = map "$prefix$_", grep /^\Q$text/, grep /^_?[a-zA-Z]/,
8291           keys %$pack;
8292
8293 =pod
8294
8295 =item * If there's only one hit, and it's a package qualifier, and it's not equal to the initial text, re-complete it using the symbol we actually found.
8296
8297 =cut
8298
8299         if ( @out == 1 and $out[0] =~ /::$/ and $out[0] ne $itext ) {
8300             return db_complete( $out[0], $line, $start );
8301         }
8302
8303         # Return the list of possibles.
8304         return sort @out;
8305
8306     } ## end if ($text =~ /^[\$@%](.*)::(.*)/)
8307
8308 =pod
8309
8310 =back
8311
8312 =head3 Symbol completion: current package or package C<main>.
8313
8314 =cut
8315
8316     if ( $text =~ /^[\$@%]/ ) {    # symbols (in $package + packages in main)
8317
8318 =pod
8319
8320 =over 4
8321
8322 =item * If it's C<main>, delete main to just get C<::> leading.
8323
8324 =cut
8325
8326         $pack = ( $package eq 'main' ? '' : $package ) . '::';
8327
8328 =pod
8329
8330 =item * We set the prefix to the item's sigil, and trim off the sigil to get the text to be completed.
8331
8332 =cut
8333
8334         $prefix = substr $text, 0, 1;
8335         $text   = substr $text, 1;
8336
8337 =pod
8338
8339 =item * If the package is C<::> (C<main>), create an empty list; if it's something else, create a list of all the packages known.  Append whichever list to a list of all the possible symbols in the current package. C<grep> out the matches to the text entered so far, then C<map> the prefix back onto the symbols.
8340
8341 =cut
8342
8343         my @out = map "$prefix$_", grep /^\Q$text/,
8344           ( grep /^_?[a-zA-Z]/, keys %$pack ),
8345           ( $pack eq '::' ? () : ( grep /::$/, keys %:: ) );
8346
8347 =item * If there's only one hit, it's a package qualifier, and it's not equal to the initial text, recomplete using this symbol.
8348
8349 =back
8350
8351 =cut
8352
8353         if ( @out == 1 and $out[0] =~ /::$/ and $out[0] ne $itext ) {
8354             return db_complete( $out[0], $line, $start );
8355         }
8356
8357         # Return the list of possibles.
8358         return sort @out;
8359     } ## end if ($text =~ /^[\$@%]/)
8360
8361 =head3 Options
8362
8363 We use C<option_val()> to look up the current value of the option. If there's
8364 only a single value, we complete the command in such a way that it is a
8365 complete command for setting the option in question. If there are multiple
8366 possible values, we generate a command consisting of the option plus a trailing
8367 question mark, which, if executed, will list the current value of the option.
8368
8369 =cut
8370
8371     if ( ( substr $line, 0, $start ) =~ /^\|*[oO]\b.*\s$/ )
8372     {    # Options after space
8373            # We look for the text to be matched in the list of possible options,
8374            # and fetch the current value.
8375         my @out = grep /^\Q$text/, @options;
8376         my $val = option_val( $out[0], undef );
8377
8378         # Set up a 'query option's value' command.
8379         my $out = '? ';
8380         if ( not defined $val or $val =~ /[\n\r]/ ) {
8381
8382             # There's really nothing else we can do.
8383         }
8384
8385         # We have a value. Create a proper option-setting command.
8386         elsif ( $val =~ /\s/ ) {
8387
8388             # XXX This may be an extraneous variable.
8389             my $found;
8390
8391             # We'll want to quote the string (because of the embedded
8392             # whtespace), but we want to make sure we don't end up with
8393             # mismatched quote characters. We try several possibilities.
8394             foreach $l ( split //, qq/\"\'\#\|/ ) {
8395
8396                 # If we didn't find this quote character in the value,
8397                 # quote it using this quote character.
8398                 $out = "$l$val$l ", last if ( index $val, $l ) == -1;
8399             }
8400         } ## end elsif ($val =~ /\s/)
8401
8402         # Don't need any quotes.
8403         else {
8404             $out = "=$val ";
8405         }
8406
8407         # If there were multiple possible values, return '? ', which
8408         # makes the command into a query command. If there was just one,
8409         # have readline append that.
8410         $rl_attribs->{completer_terminator_character} =
8411           ( @out == 1 ? $out : '? ' );
8412
8413         # Return list of possibilities.
8414         return sort @out;
8415     } ## end if ((substr $line, 0, ...
8416
8417 =head3 Filename completion
8418
8419 For entering filenames. We simply call C<readline>'s C<filename_list()>
8420 method with the completion text to get the possible completions.
8421
8422 =cut
8423
8424     return $term->filename_list($text);    # filenames
8425
8426 } ## end sub db_complete
8427
8428 =head1 MISCELLANEOUS SUPPORT FUNCTIONS
8429
8430 Functions that possibly ought to be somewhere else.
8431
8432 =head2 end_report
8433
8434 Say we're done.
8435
8436 =cut
8437
8438 sub end_report {
8439     local $\ = '';
8440     print $OUT "Use `q' to quit or `R' to restart.  `h q' for details.\n";
8441 }
8442
8443 =head2 clean_ENV
8444
8445 If we have $ini_pids, save it in the environment; else remove it from the
8446 environment. Used by the C<R> (restart) command.
8447
8448 =cut
8449
8450 sub clean_ENV {
8451     if ( defined($ini_pids) ) {
8452         $ENV{PERLDB_PIDS} = $ini_pids;
8453     }
8454     else {
8455         delete( $ENV{PERLDB_PIDS} );
8456     }
8457 } ## end sub clean_ENV
8458
8459 # PERLDBf_... flag names from perl.h
8460 our ( %DollarCaretP_flags, %DollarCaretP_flags_r );
8461
8462 BEGIN {
8463     %DollarCaretP_flags = (
8464         PERLDBf_SUB       => 0x01,     # Debug sub enter/exit
8465         PERLDBf_LINE      => 0x02,     # Keep line #
8466         PERLDBf_NOOPT     => 0x04,     # Switch off optimizations
8467         PERLDBf_INTER     => 0x08,     # Preserve more data
8468         PERLDBf_SUBLINE   => 0x10,     # Keep subr source lines
8469         PERLDBf_SINGLE    => 0x20,     # Start with single-step on
8470         PERLDBf_NONAME    => 0x40,     # For _SUB: no name of the subr
8471         PERLDBf_GOTO      => 0x80,     # Report goto: call DB::goto
8472         PERLDBf_NAMEEVAL  => 0x100,    # Informative names for evals
8473         PERLDBf_NAMEANON  => 0x200,    # Informative names for anon subs
8474         PERLDBf_ASSERTION => 0x400,    # Debug assertion subs enter/exit
8475         PERLDB_ALL        => 0x33f,    # No _NONAME, _GOTO, _ASSERTION
8476     );
8477
8478     %DollarCaretP_flags_r = reverse %DollarCaretP_flags;
8479 }
8480
8481 sub parse_DollarCaretP_flags {
8482     my $flags = shift;
8483     $flags =~ s/^\s+//;
8484     $flags =~ s/\s+$//;
8485     my $acu = 0;
8486     foreach my $f ( split /\s*\|\s*/, $flags ) {
8487         my $value;
8488         if ( $f =~ /^0x([[:xdigit:]]+)$/ ) {
8489             $value = hex $1;
8490         }
8491         elsif ( $f =~ /^(\d+)$/ ) {
8492             $value = int $1;
8493         }
8494         elsif ( $f =~ /^DEFAULT$/i ) {
8495             $value = $DollarCaretP_flags{PERLDB_ALL};
8496         }
8497         else {
8498             $f =~ /^(?:PERLDBf_)?(.*)$/i;
8499             $value = $DollarCaretP_flags{ 'PERLDBf_' . uc($1) };
8500             unless ( defined $value ) {
8501                 print $OUT (
8502                     "Unrecognized \$^P flag '$f'!\n",
8503                     "Acceptable flags are: "
8504                       . join( ', ', sort keys %DollarCaretP_flags ),
8505                     ", and hexadecimal and decimal numbers.\n"
8506                 );
8507                 return undef;
8508             }
8509         }
8510         $acu |= $value;
8511     }
8512     $acu;
8513 }
8514
8515 sub expand_DollarCaretP_flags {
8516     my $DollarCaretP = shift;
8517     my @bits         = (
8518         map {
8519             my $n = ( 1 << $_ );
8520             ( $DollarCaretP & $n )
8521               ? ( $DollarCaretP_flags_r{$n}
8522                   || sprintf( '0x%x', $n ) )
8523               : ()
8524           } 0 .. 31
8525     );
8526     return @bits ? join( '|', @bits ) : 0;
8527 }
8528
8529 =head1 END PROCESSING - THE C<END> BLOCK
8530
8531 Come here at the very end of processing. We want to go into a
8532 loop where we allow the user to enter commands and interact with the
8533 debugger, but we don't want anything else to execute.
8534
8535 First we set the C<$finished> variable, so that some commands that
8536 shouldn't be run after the end of program quit working.
8537
8538 We then figure out whether we're truly done (as in the user entered a C<q>
8539 command, or we finished execution while running nonstop). If we aren't,
8540 we set C<$single> to 1 (causing the debugger to get control again).
8541
8542 We then call C<DB::fake::at_exit()>, which returns the C<Use 'q' to quit ...">
8543 message and returns control to the debugger. Repeat.
8544
8545 When the user finally enters a C<q> command, C<$fall_off_end> is set to
8546 1 and the C<END> block simply exits with C<$single> set to 0 (don't
8547 break, run to completion.).
8548
8549 =cut
8550
8551 END {
8552     $finished = 1 if $inhibit_exit;    # So that some commands may be disabled.
8553     $fall_off_end = 1 unless $inhibit_exit;
8554
8555     # Do not stop in at_exit() and destructors on exit:
8556     $DB::single = !$fall_off_end && !$runnonstop;
8557     DB::fake::at_exit() unless $fall_off_end or $runnonstop;
8558 } ## end END
8559
8560 =head1 PRE-5.8 COMMANDS
8561
8562 Some of the commands changed function quite a bit in the 5.8 command
8563 realignment, so much so that the old code had to be replaced completely.
8564 Because we wanted to retain the option of being able to go back to the
8565 former command set, we moved the old code off to this section.
8566
8567 There's an awful lot of duplicated code here. We've duplicated the
8568 comments to keep things clear.
8569
8570 =head2 Null command
8571
8572 Does nothing. Used to 'turn off' commands.
8573
8574 =cut
8575
8576 sub cmd_pre580_null {
8577
8578     # do nothing...
8579 }
8580
8581 =head2 Old C<a> command.
8582
8583 This version added actions if you supplied them, and deleted them
8584 if you didn't.
8585
8586 =cut
8587
8588 sub cmd_pre580_a {
8589     my $xcmd = shift;
8590     my $cmd  = shift;
8591
8592     # Argument supplied. Add the action.
8593     if ( $cmd =~ /^(\d*)\s*(.*)/ ) {
8594
8595         # If the line isn't there, use the current line.
8596         $i = $1 || $line;
8597         $j = $2;
8598
8599         # If there is an action ...
8600         if ( length $j ) {
8601
8602             # ... but the line isn't breakable, skip it.
8603             if ( $dbline[$i] == 0 ) {
8604                 print $OUT "Line $i may not have an action.\n";
8605             }
8606             else {
8607
8608                 # ... and the line is breakable:
8609                 # Mark that there's an action in this file.
8610                 $had_breakpoints{$filename} |= 2;
8611
8612                 # Delete any current action.
8613                 $dbline{$i} =~ s/\0[^\0]*//;
8614
8615                 # Add the new action, continuing the line as needed.
8616                 $dbline{$i} .= "\0" . action($j);
8617             }
8618         } ## end if (length $j)
8619
8620         # No action supplied.
8621         else {
8622
8623             # Delete the action.
8624             $dbline{$i} =~ s/\0[^\0]*//;
8625
8626             # Mark as having no break or action if nothing's left.
8627             delete $dbline{$i} if $dbline{$i} eq '';
8628         }
8629     } ## end if ($cmd =~ /^(\d*)\s*(.*)/)
8630 } ## end sub cmd_pre580_a
8631
8632 =head2 Old C<b> command
8633
8634 Add breakpoints.
8635
8636 =cut
8637
8638 sub cmd_pre580_b {
8639     my $xcmd   = shift;
8640     my $cmd    = shift;
8641     my $dbline = shift;
8642
8643     # Break on load.
8644     if ( $cmd =~ /^load\b\s*(.*)/ ) {
8645         my $file = $1;
8646         $file =~ s/\s+$//;
8647         &cmd_b_load($file);
8648     }
8649
8650     # b compile|postpone <some sub> [<condition>]
8651     # The interpreter actually traps this one for us; we just put the
8652     # necessary condition in the %postponed hash.
8653     elsif ( $cmd =~ /^(postpone|compile)\b\s*([':A-Za-z_][':\w]*)\s*(.*)/ ) {
8654
8655         # Capture the condition if there is one. Make it true if none.
8656         my $cond = length $3 ? $3 : '1';
8657
8658         # Save the sub name and set $break to 1 if $1 was 'postpone', 0
8659         # if it was 'compile'.
8660         my ( $subname, $break ) = ( $2, $1 eq 'postpone' );
8661
8662         # De-Perl4-ify the name - ' separators to ::.
8663         $subname =~ s/\'/::/g;
8664
8665         # Qualify it into the current package unless it's already qualified.
8666         $subname = "${'package'}::" . $subname
8667           unless $subname =~ /::/;
8668
8669         # Add main if it starts with ::.
8670         $subname = "main" . $subname if substr( $subname, 0, 2 ) eq "::";
8671
8672         # Save the break type for this sub.
8673         $postponed{$subname} = $break ? "break +0 if $cond" : "compile";
8674     } ## end elsif ($cmd =~ ...
8675
8676     # b <sub name> [<condition>]
8677     elsif ( $cmd =~ /^([':A-Za-z_][':\w]*(?:\[.*\])?)\s*(.*)/ ) {
8678         my $subname = $1;
8679         my $cond = length $2 ? $2 : '1';
8680         &cmd_b_sub( $subname, $cond );
8681     }
8682
8683     # b <line> [<condition>].
8684     elsif ( $cmd =~ /^(\d*)\s*(.*)/ ) {
8685         my $i = $1 || $dbline;
8686         my $cond = length $2 ? $2 : '1';
8687         &cmd_b_line( $i, $cond );
8688     }
8689 } ## end sub cmd_pre580_b
8690
8691 =head2 Old C<D> command.
8692
8693 Delete all breakpoints unconditionally.
8694
8695 =cut
8696
8697 sub cmd_pre580_D {
8698     my $xcmd = shift;
8699     my $cmd  = shift;
8700     if ( $cmd =~ /^\s*$/ ) {
8701         print $OUT "Deleting all breakpoints...\n";
8702
8703         # %had_breakpoints lists every file that had at least one
8704         # breakpoint in it.
8705         my $file;
8706         for $file ( keys %had_breakpoints ) {
8707
8708             # Switch to the desired file temporarily.
8709             local *dbline = $main::{ '_<' . $file };
8710
8711             my $max = $#dbline;
8712             my $was;
8713
8714             # For all lines in this file ...
8715             for ( $i = 1 ; $i <= $max ; $i++ ) {
8716
8717                 # If there's a breakpoint or action on this line ...
8718                 if ( defined $dbline{$i} ) {
8719
8720                     # ... remove the breakpoint.
8721                     $dbline{$i} =~ s/^[^\0]+//;
8722                     if ( $dbline{$i} =~ s/^\0?$// ) {
8723
8724                         # Remove the entry altogether if no action is there.
8725                         delete $dbline{$i};
8726                     }
8727                 } ## end if (defined $dbline{$i...
8728             } ## end for ($i = 1 ; $i <= $max...
8729
8730             # If, after we turn off the "there were breakpoints in this file"
8731             # bit, the entry in %had_breakpoints for this file is zero,
8732             # we should remove this file from the hash.
8733             if ( not $had_breakpoints{$file} &= ~1 ) {
8734                 delete $had_breakpoints{$file};
8735             }
8736         } ## end for $file (keys %had_breakpoints)
8737
8738         # Kill off all the other breakpoints that are waiting for files that
8739         # haven't been loaded yet.
8740         undef %postponed;
8741         undef %postponed_file;
8742         undef %break_on_load;
8743     } ## end if ($cmd =~ /^\s*$/)
8744 } ## end sub cmd_pre580_D
8745
8746 =head2 Old C<h> command
8747
8748 Print help. Defaults to printing the long-form help; the 5.8 version
8749 prints the summary by default.
8750
8751 =cut
8752
8753 sub cmd_pre580_h {
8754     my $xcmd = shift;
8755     my $cmd  = shift;
8756
8757     # Print the *right* help, long format.
8758     if ( $cmd =~ /^\s*$/ ) {
8759         print_help($pre580_help);
8760     }
8761
8762     # 'h h' - explicitly-requested summary.
8763     elsif ( $cmd =~ /^h\s*/ ) {
8764         print_help($pre580_summary);
8765     }
8766
8767     # Find and print a command's help.
8768     elsif ( $cmd =~ /^h\s+(\S.*)$/ ) {
8769         my $asked  = $1;                   # for proper errmsg
8770         my $qasked = quotemeta($asked);    # for searching
8771                                            # XXX: finds CR but not <CR>
8772         if (
8773             $pre580_help =~ /^
8774                               <?           # Optional '<'
8775                               (?:[IB]<)    # Optional markup
8776                               $qasked      # The command name
8777                             /mx
8778           )
8779         {
8780
8781             while (
8782                 $pre580_help =~ /^
8783                                   (             # The command help:
8784                                    <?           # Optional '<'
8785                                    (?:[IB]<)    # Optional markup
8786                                    $qasked      # The command name
8787                                    ([\s\S]*?)   # Lines starting with tabs
8788                                    \n           # Final newline
8789                                   )
8790                                   (?!\s)/mgx
8791               )    # Line not starting with space
8792                    # (Next command's help)
8793             {
8794                 print_help($1);
8795             }
8796         } ## end if ($pre580_help =~ /^<?(?:[IB]<)$qasked/m)
8797
8798         # Help not found.
8799         else {
8800             print_help("B<$asked> is not a debugger command.\n");
8801         }
8802     } ## end elsif ($cmd =~ /^h\s+(\S.*)$/)
8803 } ## end sub cmd_pre580_h
8804
8805 =head2 Old C<W> command
8806
8807 C<W E<lt>exprE<gt>> adds a watch expression, C<W> deletes them all.
8808
8809 =cut
8810
8811 sub cmd_pre580_W {
8812     my $xcmd = shift;
8813     my $cmd  = shift;
8814
8815     # Delete all watch expressions.
8816     if ( $cmd =~ /^$/ ) {
8817
8818         # No watching is going on.
8819         $trace &= ~2;
8820
8821         # Kill all the watch expressions and values.
8822         @to_watch = @old_watch = ();
8823     }
8824
8825     # Add a watch expression.
8826     elsif ( $cmd =~ /^(.*)/s ) {
8827
8828         # add it to the list to be watched.
8829         push @to_watch, $1;
8830
8831         # Get the current value of the expression.
8832         # Doesn't handle expressions returning list values!
8833         $evalarg = $1;
8834         my ($val) = &eval;
8835         $val = ( defined $val ) ? "'$val'" : 'undef';
8836
8837         # Save it.
8838         push @old_watch, $val;
8839
8840         # We're watching stuff.
8841         $trace |= 2;
8842
8843     } ## end elsif ($cmd =~ /^(.*)/s)
8844 } ## end sub cmd_pre580_W
8845
8846 =head1 PRE-AND-POST-PROMPT COMMANDS AND ACTIONS
8847
8848 The debugger used to have a bunch of nearly-identical code to handle
8849 the pre-and-post-prompt action commands. C<cmd_pre590_prepost> and
8850 C<cmd_prepost> unify all this into one set of code to handle the
8851 appropriate actions.
8852
8853 =head2 C<cmd_pre590_prepost>
8854
8855 A small wrapper around C<cmd_prepost>; it makes sure that the default doesn't
8856 do something destructive. In pre 5.8 debuggers, the default action was to
8857 delete all the actions.
8858
8859 =cut
8860
8861 sub cmd_pre590_prepost {
8862     my $cmd    = shift;
8863     my $line   = shift || '*';
8864     my $dbline = shift;
8865
8866     return &cmd_prepost( $cmd, $line, $dbline );
8867 } ## end sub cmd_pre590_prepost
8868
8869 =head2 C<cmd_prepost>
8870
8871 Actually does all the handling foe C<E<lt>>, C<E<gt>>, C<{{>, C<{>, etc.
8872 Since the lists of actions are all held in arrays that are pointed to by
8873 references anyway, all we have to do is pick the right array reference and
8874 then use generic code to all, delete, or list actions.
8875
8876 =cut
8877
8878 sub cmd_prepost {
8879     my $cmd = shift;
8880
8881     # No action supplied defaults to 'list'.
8882     my $line = shift || '?';
8883
8884     # Figure out what to put in the prompt.
8885     my $which = '';
8886
8887     # Make sure we have some array or another to address later.
8888     # This means that if ssome reason the tests fail, we won't be
8889     # trying to stash actions or delete them from the wrong place.
8890     my $aref = [];
8891
8892     # < - Perl code to run before prompt.
8893     if ( $cmd =~ /^\</o ) {
8894         $which = 'pre-perl';
8895         $aref  = $pre;
8896     }
8897
8898     # > - Perl code to run after prompt.
8899     elsif ( $cmd =~ /^\>/o ) {
8900         $which = 'post-perl';
8901         $aref  = $post;
8902     }
8903
8904     # { - first check for properly-balanced braces.
8905     elsif ( $cmd =~ /^\{/o ) {
8906         if ( $cmd =~ /^\{.*\}$/o && unbalanced( substr( $cmd, 1 ) ) ) {
8907             print $OUT
8908 "$cmd is now a debugger command\nuse `;$cmd' if you mean Perl code\n";
8909         }
8910
8911         # Properly balanced. Pre-prompt debugger actions.
8912         else {
8913             $which = 'pre-debugger';
8914             $aref  = $pretype;
8915         }
8916     } ## end elsif ( $cmd =~ /^\{/o )
8917
8918     # Did we find something that makes sense?
8919     unless ($which) {
8920         print $OUT "Confused by command: $cmd\n";
8921     }
8922
8923     # Yes.
8924     else {
8925
8926         # List actions.
8927         if ( $line =~ /^\s*\?\s*$/o ) {
8928             unless (@$aref) {
8929
8930                 # Nothing there. Complain.
8931                 print $OUT "No $which actions.\n";
8932             }
8933             else {
8934
8935                 # List the actions in the selected list.
8936                 print $OUT "$which commands:\n";
8937                 foreach my $action (@$aref) {
8938                     print $OUT "\t$cmd -- $action\n";
8939                 }
8940             } ## end else
8941         } ## end if ( $line =~ /^\s*\?\s*$/o)
8942
8943         # Might be a delete.
8944         else {
8945             if ( length($cmd) == 1 ) {
8946                 if ( $line =~ /^\s*\*\s*$/o ) {
8947
8948                     # It's a delete. Get rid of the old actions in the
8949                     # selected list..
8950                     @$aref = ();
8951                     print $OUT "All $cmd actions cleared.\n";
8952                 }
8953                 else {
8954
8955                     # Replace all the actions. (This is a <, >, or {).
8956                     @$aref = action($line);
8957                 }
8958             } ## end if ( length($cmd) == 1)
8959             elsif ( length($cmd) == 2 ) {
8960
8961                 # Add the action to the line. (This is a <<, >>, or {{).
8962                 push @$aref, action($line);
8963             }
8964             else {
8965
8966                 # <<<, >>>>, {{{{{{ ... something not a command.
8967                 print $OUT
8968                   "Confused by strange length of $which command($cmd)...\n";
8969             }
8970         } ## end else [ if ( $line =~ /^\s*\?\s*$/o)
8971     } ## end else
8972 } ## end sub cmd_prepost
8973
8974 =head1 C<DB::fake>
8975
8976 Contains the C<at_exit> routine that the debugger uses to issue the
8977 C<Debugged program terminated ...> message after the program completes. See
8978 the C<END> block documentation for more details.
8979
8980 =cut
8981
8982 package DB::fake;
8983
8984 sub at_exit {
8985     "Debugged program terminated.  Use `q' to quit or `R' to restart.";
8986 }
8987
8988 package DB;    # Do not trace this 1; below!
8989
8990 1;
8991