lib/perl5db.pl

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