lib/perl5db.pl

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