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