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