ext/B/B/Deparse.pm

   1 # B::Deparse.pm
   2 # Copyright (c) 1998-2000, 2002, 2003, 2004, 2005, 2006 Stephen McCamant.
   3 # All rights reserved.
   4 # This module is free software; you can redistribute and/or modify
   5 # it under the same terms as Perl itself.
   6
   7 # This is based on the module of the same name by Malcolm Beattie,
   8 # but essentially none of his code remains.
   9
  10 package B::Deparse;
  11 use Carp;
  12 use B qw(class main_root main_start main_cv svref_2object opnumber perlstring
  13          OPf_WANT OPf_WANT_VOID OPf_WANT_SCALAR OPf_WANT_LIST
  14          OPf_KIDS OPf_REF OPf_STACKED OPf_SPECIAL OPf_MOD OPpPAD_STATE
  15          OPpLVAL_INTRO OPpOUR_INTRO OPpENTERSUB_AMPER OPpSLICE OPpCONST_BARE
  16          OPpTRANS_SQUASH OPpTRANS_DELETE OPpTRANS_COMPLEMENT OPpTARGET_MY
  17          OPpCONST_ARYBASE OPpEXISTS_SUB OPpSORT_NUMERIC OPpSORT_INTEGER
  18          OPpSORT_REVERSE OPpSORT_INPLACE OPpSORT_DESCEND OPpITER_REVERSED
  19          SVf_IOK SVf_NOK SVf_ROK SVf_POK SVpad_OUR SVf_FAKE SVs_RMG SVs_SMG
  20          CVf_METHOD CVf_LOCKED CVf_LVALUE CVf_ASSERTION
  21          PMf_KEEP PMf_GLOBAL PMf_CONTINUE PMf_EVAL PMf_ONCE PMf_SKIPWHITE
  22          PMf_MULTILINE PMf_SINGLELINE PMf_FOLD PMf_EXTENDED);
  23 $VERSION = 0.76;
  24 use strict;
  25 use vars qw/$AUTOLOAD/;
  26 use warnings ();
  27
  28 # Changes between 0.50 and 0.51:
  29 # - fixed nulled leave with live enter in sort { }
  30 # - fixed reference constants (\"str")
  31 # - handle empty programs gracefully
  32 # - handle infinte loops (for (;;) {}, while (1) {})
  33 # - differentiate between `for my $x ...' and `my $x; for $x ...'
  34 # - various minor cleanups
  35 # - moved globals into an object
  36 # - added `-u', like B::C
  37 # - package declarations using cop_stash
  38 # - subs, formats and code sorted by cop_seq
  39 # Changes between 0.51 and 0.52:
  40 # - added pp_threadsv (special variables under USE_5005THREADS)
  41 # - added documentation
  42 # Changes between 0.52 and 0.53:
  43 # - many changes adding precedence contexts and associativity
  44 # - added `-p' and `-s' output style options
  45 # - various other minor fixes
  46 # Changes between 0.53 and 0.54:
  47 # - added support for new `for (1..100)' optimization,
  48 #   thanks to Gisle Aas
  49 # Changes between 0.54 and 0.55:
  50 # - added support for new qr// construct
  51 # - added support for new pp_regcreset OP
  52 # Changes between 0.55 and 0.56:
  53 # - tested on base/*.t, cmd/*.t, comp/*.t, io/*.t
  54 # - fixed $# on non-lexicals broken in last big rewrite
  55 # - added temporary fix for change in opcode of OP_STRINGIFY
  56 # - fixed problem in 0.54's for() patch in `for (@ary)'
  57 # - fixed precedence in conditional of ?:
  58 # - tweaked list paren elimination in `my($x) = @_'
  59 # - made continue-block detection trickier wrt. null ops
  60 # - fixed various prototype problems in pp_entersub
  61 # - added support for sub prototypes that never get GVs
  62 # - added unquoting for special filehandle first arg in truncate
  63 # - print doubled rv2gv (a bug) as `*{*GV}' instead of illegal `**GV'
  64 # - added semicolons at the ends of blocks
  65 # - added -l `#line' declaration option -- fixes cmd/subval.t 27,28
  66 # Changes between 0.56 and 0.561:
  67 # - fixed multiply-declared my var in pp_truncate (thanks to Sarathy)
  68 # - used new B.pm symbolic constants (done by Nick Ing-Simmons)
  69 # Changes between 0.561 and 0.57:
  70 # - stylistic changes to symbolic constant stuff
  71 # - handled scope in s///e replacement code
  72 # - added unquote option for expanding "" into concats, etc.
  73 # - split method and proto parts of pp_entersub into separate functions
  74 # - various minor cleanups
  75 # Changes after 0.57:
  76 # - added parens in \&foo (patch by Albert Dvornik)
  77 # Changes between 0.57 and 0.58:
  78 # - fixed `0' statements that weren't being printed
  79 # - added methods for use from other programs
  80 #   (based on patches from James Duncan and Hugo van der Sanden)
  81 # - added -si and -sT to control indenting (also based on a patch from Hugo)
  82 # - added -sv to print something else instead of '???'
  83 # - preliminary version of utf8 tr/// handling
  84 # Changes after 0.58:
  85 # - uses of $op->ppaddr changed to new $op->name (done by Sarathy)
  86 # - added support for Hugo's new OP_SETSTATE (like nextstate)
  87 # Changes between 0.58 and 0.59
  88 # - added support for Chip's OP_METHOD_NAMED
  89 # - added support for Ilya's OPpTARGET_MY optimization
  90 # - elided arrows before `()' subscripts when possible
  91 # Changes between 0.59 and 0.60
  92 # - support for method attribues was added
  93 # - some warnings fixed
  94 # - separate recognition of constant subs
  95 # - rewrote continue block handling, now recoginizing for loops
  96 # - added more control of expanding control structures
  97 # Changes between 0.60 and 0.61 (mostly by Robin Houston)
  98 # - many bug-fixes
  99 # - support for pragmas and 'use'
 100 # - support for the little-used $[ variable
 101 # - support for __DATA__ sections
 102 # - UTF8 support
 103 # - BEGIN, CHECK, INIT and END blocks
 104 # - scoping of subroutine declarations fixed
 105 # - compile-time output from the input program can be suppressed, so that the
 106 #   output is just the deparsed code. (a change to O.pm in fact)
 107 # - our() declarations
 108 # - *all* the known bugs are now listed in the BUGS section
 109 # - comprehensive test mechanism (TEST -deparse)
 110 # Changes between 0.62 and 0.63 (mostly by Rafael Garcia-Suarez)
 111 # - bug-fixes
 112 # - new switch -P
 113 # - support for command-line switches (-l, -0, etc.)
 114 # Changes between 0.63 and 0.64
 115 # - support for //, CHECK blocks, and assertions
 116 # - improved handling of foreach loops and lexicals
 117 # - option to use Data::Dumper for constants
 118 # - more bug fixes
 119 # - discovered lots more bugs not yet fixed
 120 #
 121 # ...
 122 #
 123 # Changes between 0.72 and 0.73
 124 # - support new switch constructs
 125
 126 # Todo:
 127 #  (See also BUGS section at the end of this file)
 128 #
 129 # - finish tr/// changes
 130 # - add option for even more parens (generalize \&foo change)
 131 # - left/right context
 132 # - copy comments (look at real text with $^P?)
 133 # - avoid semis in one-statement blocks
 134 # - associativity of &&=, ||=, ?:
 135 # - ',' => '=>' (auto-unquote?)
 136 # - break long lines ("\r" as discretionary break?)
 137 # - configurable syntax highlighting: ANSI color, HTML, TeX, etc.
 138 # - more style options: brace style, hex vs. octal, quotes, ...
 139 # - print big ints as hex/octal instead of decimal (heuristic?)
 140 # - handle `my $x if 0'?
 141 # - version using op_next instead of op_first/sibling?
 142 # - avoid string copies (pass arrays, one big join?)
 143 # - here-docs?
 144
 145 # Current test.deparse failures
 146 # comp/assertions 38 - disabled assertions should be like "my($x) if 0"
 147 #    'sub f : assertion {}; no assertions; my $x=1; {f(my $x=2); print "$x\n"}'
 148 # comp/hints 6 - location of BEGIN blocks wrt. block openings
 149 # run/switchI 1 - missing -I switches entirely
 150 #    perl -Ifoo -e 'print @INC'
 151 # op/caller 2 - warning mask propagates backwards before warnings::register
 152 #    'use warnings; BEGIN {${^WARNING_BITS} eq "U"x12;} use warnings::register'
 153 # op/getpid 2 - can't assign to shared my() declaration (threads only)
 154 #    'my $x : shared = 5'
 155 # op/override 7 - parens on overriden require change v-string interpretation
 156 #    'BEGIN{*CORE::GLOBAL::require=sub {}} require v5.6'
 157 #    c.f. 'BEGIN { *f = sub {0} }; f 2'
 158 # op/pat 774 - losing Unicode-ness of Latin1-only strings
 159 #    'use charnames ":short"; $x="\N{latin:a with acute}"'
 160 # op/recurse 12 - missing parens on recursive call makes it look like method
 161 #    'sub f { f($x) }'
 162 # op/subst 90 - inconsistent handling of utf8 under "use utf8"
 163 # op/taint 29 - "use re 'taint'" deparsed in the wrong place wrt. block open
 164 # op/tiehandle compile - "use strict" deparsed in the wrong place
 165 # uni/tr_ several
 166 # ext/B/t/xref 11 - line numbers when we add newlines to one-line subs
 167 # ext/Data/Dumper/t/dumper compile
 168 # ext/DB_file/several
 169 # ext/Encode/several
 170 # ext/Ernno/Errno warnings
 171 # ext/IO/lib/IO/t/io_sel 23
 172 # ext/PerlIO/t/encoding compile
 173 # ext/POSIX/t/posix 6
 174 # ext/Socket/Socket 8
 175 # ext/Storable/t/croak compile
 176 # lib/Attribute/Handlers/t/multi compile
 177 # lib/bignum/ several
 178 # lib/charnames 35
 179 # lib/constant 32
 180 # lib/English 40
 181 # lib/ExtUtils/t/bytes 4
 182 # lib/File/DosGlob compile
 183 # lib/Filter/Simple/t/data 1
 184 # lib/Math/BigInt/t/constant 1
 185 # lib/Net/t/config Deparse-warning
 186 # lib/overload compile
 187 # lib/Switch/ several
 188 # lib/Symbol 4
 189 # lib/Test/Simple several
 190 # lib/Term/Complete
 191 # lib/Tie/File/t/29_downcopy 5
 192 # lib/vars 22
 193
 194 # Object fields (were globals):
 195 #
 196 # avoid_local:
 197 # (local($a), local($b)) and local($a, $b) have the same internal
 198 # representation but the short form looks better. We notice we can
 199 # use a large-scale local when checking the list, but need to prevent
 200 # individual locals too. This hash holds the addresses of OPs that
 201 # have already had their local-ness accounted for. The same thing
 202 # is done with my().
 203 #
 204 # curcv:
 205 # CV for current sub (or main program) being deparsed
 206 #
 207 # curcvlex:
 208 # Cached hash of lexical variables for curcv: keys are names,
 209 # each value is an array of pairs, indicating the cop_seq of scopes
 210 # in which a var of that name is valid.
 211 #
 212 # curcop:
 213 # COP for statement being deparsed
 214 #
 215 # curstash:
 216 # name of the current package for deparsed code
 217 #
 218 # subs_todo:
 219 # array of [cop_seq, CV, is_format?] for subs and formats we still
 220 # want to deparse
 221 #
 222 # protos_todo:
 223 # as above, but [name, prototype] for subs that never got a GV
 224 #
 225 # subs_done, forms_done:
 226 # keys are addresses of GVs for subs and formats we've already
 227 # deparsed (or at least put into subs_todo)
 228 #
 229 # subs_declared
 230 # keys are names of subs for which we've printed declarations.
 231 # That means we can omit parentheses from the arguments.
 232 #
 233 # subs_deparsed
 234 # Keeps track of fully qualified names of all deparsed subs.
 235 #
 236 # parens: -p
 237 # linenums: -l
 238 # unquote: -q
 239 # cuddle: ` ' or `\n', depending on -sC
 240 # indent_size: -si
 241 # use_tabs: -sT
 242 # ex_const: -sv
 243
 244 # A little explanation of how precedence contexts and associativity
 245 # work:
 246 #
 247 # deparse() calls each per-op subroutine with an argument $cx (short
 248 # for context, but not the same as the cx* in the perl core), which is
 249 # a number describing the op's parents in terms of precedence, whether
 250 # they're inside an expression or at statement level, etc.  (see
 251 # chart below). When ops with children call deparse on them, they pass
 252 # along their precedence. Fractional values are used to implement
 253 # associativity (`($x + $y) + $z' => `$x + $y + $y') and related
 254 # parentheses hacks. The major disadvantage of this scheme is that
 255 # it doesn't know about right sides and left sides, so say if you
 256 # assign a listop to a variable, it can't tell it's allowed to leave
 257 # the parens off the listop.
 258
 259 # Precedences:
 260 # 26             [TODO] inside interpolation context ("")
 261 # 25 left        terms and list operators (leftward)
 262 # 24 left        ->
 263 # 23 nonassoc    ++ --
 264 # 22 right       **
 265 # 21 right       ! ~ \ and unary + and -
 266 # 20 left        =~ !~
 267 # 19 left        * / % x
 268 # 18 left        + - .
 269 # 17 left        << >>
 270 # 16 nonassoc    named unary operators
 271 # 15 nonassoc    < > <= >= lt gt le ge
 272 # 14 nonassoc    == != <=> eq ne cmp
 273 # 13 left        &
 274 # 12 left        | ^
 275 # 11 left        &&
 276 # 10 left        ||
 277 #  9 nonassoc    ..  ...
 278 #  8 right       ?:
 279 #  7 right       = += -= *= etc.
 280 #  6 left        , =>
 281 #  5 nonassoc    list operators (rightward)
 282 #  4 right       not
 283 #  3 left        and
 284 #  2 left        or xor
 285 #  1             statement modifiers
 286 #  0.5           statements, but still print scopes as do { ... }
 287 #  0             statement level
 288
 289 # Nonprinting characters with special meaning:
 290 # \cS - steal parens (see maybe_parens_unop)
 291 # \n - newline and indent
 292 # \t - increase indent
 293 # \b - decrease indent (`outdent')
 294 # \f - flush left (no indent)
 295 # \cK - kill following semicolon, if any
 296
 297 sub null {
 298     my $op = shift;
 299     return class($op) eq "NULL";
 300 }
 301
 302 sub todo {
 303     my $self = shift;
 304     my($cv, $is_form) = @_;
 305     return unless ($cv->FILE eq $0 || exists $self->{files}{$cv->FILE});
 306     my $seq;
 307     if ($cv->OUTSIDE_SEQ) {
 308         $seq = $cv->OUTSIDE_SEQ;
 309     } elsif (!null($cv->START) and is_state($cv->START)) {
 310         $seq = $cv->START->cop_seq;
 311     } else {
 312         $seq = 0;
 313     }
 314     push @{$self->{'subs_todo'}}, [$seq, $cv, $is_form];
 315     unless ($is_form || class($cv->STASH) eq 'SPECIAL') {
 316         $self->{'subs_deparsed'}{$cv->STASH->NAME."::".$cv->GV->NAME} = 1;
 317     }
 318 }
 319
 320 sub next_todo {
 321     my $self = shift;
 322     my $ent = shift @{$self->{'subs_todo'}};
 323     my $cv = $ent->[1];
 324     my $gv = $cv->GV;
 325     my $name = $self->gv_name($gv);
 326     if ($ent->[2]) {
 327         return "format $name =\n"
 328             . $self->deparse_format($ent->[1]). "\n";
 329     } else {
 330         $self->{'subs_declared'}{$name} = 1;
 331         if ($name eq "BEGIN") {
 332             my $use_dec = $self->begin_is_use($cv);
 333             if (defined ($use_dec) and $self->{'expand'} < 5) {
 334                 return () if 0 == length($use_dec);
 335                 return $use_dec;
 336             }
 337         }
 338         my $l = '';
 339         if ($self->{'linenums'}) {
 340             my $line = $gv->LINE;
 341             my $file = $gv->FILE;
 342             $l = "\n\f#line $line \"$file\"\n";
 343         }
 344         my $p = '';
 345         if (class($cv->STASH) ne "SPECIAL") {
 346             my $stash = $cv->STASH->NAME;
 347             if ($stash ne $self->{'curstash'}) {
 348                 $p = "package $stash;\n";
 349                 $name = "$self->{'curstash'}::$name" unless $name =~ /::/;
 350                 $self->{'curstash'} = $stash;
 351             }
 352             $name =~ s/^\Q$stash\E:://;
 353         }
 354         return "${p}${l}sub $name " . $self->deparse_sub($cv);
 355     }
 356 }
 357
 358 # Return a "use" declaration for this BEGIN block, if appropriate
 359 sub begin_is_use {
 360     my ($self, $cv) = @_;
 361     my $root = $cv->ROOT;
 362     local @$self{qw'curcv curcvlex'} = ($cv);
 363 #require B::Debug;
 364 #B::walkoptree($cv->ROOT, "debug");
 365     my $lineseq = $root->first;
 366     return if $lineseq->name ne "lineseq";
 367
 368     my $req_op = $lineseq->first->sibling;
 369     return if $req_op->name ne "require";
 370
 371     my $module;
 372     if ($req_op->first->private & OPpCONST_BARE) {
 373         # Actually it should always be a bareword
 374         $module = $self->const_sv($req_op->first)->PV;
 375         $module =~ s[/][::]g;
 376         $module =~ s/.pm$//;
 377     }
 378     else {
 379         $module = $self->const($self->const_sv($req_op->first), 6);
 380     }
 381
 382     my $version;
 383     my $version_op = $req_op->sibling;
 384     return if class($version_op) eq "NULL";
 385     if ($version_op->name eq "lineseq") {
 386         # We have a version parameter; skip nextstate & pushmark
 387         my $constop = $version_op->first->next->next;
 388
 389         return unless $self->const_sv($constop)->PV eq $module;
 390         $constop = $constop->sibling;
 391         $version = $self->const_sv($constop);
 392         if (class($version) eq "IV") {
 393             $version = $version->int_value;
 394         } elsif (class($version) eq "NV") {
 395             $version = $version->NV;
 396         } elsif (class($version) ne "PVMG") {
 397             # Includes PVIV and PVNV
 398             $version = $version->PV;
 399         } else {
 400             # version specified as a v-string
 401             $version = 'v'.join '.', map ord, split //, $version->PV;
 402         }
 403         $constop = $constop->sibling;
 404         return if $constop->name ne "method_named";
 405         return if $self->const_sv($constop)->PV ne "VERSION";
 406     }
 407
 408     $lineseq = $version_op->sibling;
 409     return if $lineseq->name ne "lineseq";
 410     my $entersub = $lineseq->first->sibling;
 411     if ($entersub->name eq "stub") {
 412         return "use $module $version ();\n" if defined $version;
 413         return "use $module ();\n";
 414     }
 415     return if $entersub->name ne "entersub";
 416
 417     # See if there are import arguments
 418     my $args = '';
 419
 420     my $svop = $entersub->first->sibling; # Skip over pushmark
 421     return unless $self->const_sv($svop)->PV eq $module;
 422
 423     # Pull out the arguments
 424     for ($svop=$svop->sibling; $svop->name ne "method_named";
 425                 $svop = $svop->sibling) {
 426         $args .= ", " if length($args);
 427         $args .= $self->deparse($svop, 6);
 428     }
 429
 430     my $use = 'use';
 431     my $method_named = $svop;
 432     return if $method_named->name ne "method_named";
 433     my $method_name = $self->const_sv($method_named)->PV;
 434
 435     if ($method_name eq "unimport") {
 436         $use = 'no';
 437     }
 438
 439     # Certain pragmas are dealt with using hint bits,
 440     # so we ignore them here
 441     if ($module eq 'strict' || $module eq 'integer'
 442         || $module eq 'bytes' || $module eq 'warnings') {
 443         return "";
 444     }
 445
 446     if (defined $version && length $args) {
 447         return "$use $module $version ($args);\n";
 448     } elsif (defined $version) {
 449         return "$use $module $version;\n";
 450     } elsif (length $args) {
 451         return "$use $module ($args);\n";
 452     } else {
 453         return "$use $module;\n";
 454     }
 455 }
 456
 457 sub stash_subs {
 458     my ($self, $pack) = @_;
 459     my (@ret, $stash);
 460     if (!defined $pack) {
 461         $pack = '';
 462         $stash = \%::;
 463     }
 464     else {
 465         $pack =~ s/(::)?$/::/;
 466         no strict 'refs';
 467         $stash = \%$pack;
 468     }
 469     my %stash = svref_2object($stash)->ARRAY;
 470     while (my ($key, $val) = each %stash) {
 471         next if $key eq 'main::';       # avoid infinite recursion
 472         my $class = class($val);
 473         if ($class eq "PV") {
 474             # Just a prototype. As an ugly but fairly effective way
 475             # to find out if it belongs here is to see if the AUTOLOAD
 476             # (if any) for the stash was defined in one of our files.
 477             my $A = $stash{"AUTOLOAD"};
 478             if (defined ($A) && class($A) eq "GV" && defined($A->CV)
 479                 && class($A->CV) eq "CV") {
 480                 my $AF = $A->FILE;
 481                 next unless $AF eq $0 || exists $self->{'files'}{$AF};
 482             }
 483             push @{$self->{'protos_todo'}}, [$pack . $key, $val->PV];
 484         } elsif ($class eq "IV") {
 485             # Just a name. As above.
 486             my $A = $stash{"AUTOLOAD"};
 487             if (defined ($A) && class($A) eq "GV" && defined($A->CV)
 488                 && class($A->CV) eq "CV") {
 489                 my $AF = $A->FILE;
 490                 next unless $AF eq $0 || exists $self->{'files'}{$AF};
 491             }
 492             push @{$self->{'protos_todo'}}, [$pack . $key, undef];
 493         } elsif ($class eq "GV") {
 494             if (class(my $cv = $val->CV) ne "SPECIAL") {
 495                 next if $self->{'subs_done'}{$$val}++;
 496                 next if $$val != ${$cv->GV};   # Ignore imposters
 497                 $self->todo($cv, 0);
 498             }
 499             if (class(my $cv = $val->FORM) ne "SPECIAL") {
 500                 next if $self->{'forms_done'}{$$val}++;
 501                 next if $$val != ${$cv->GV};   # Ignore imposters
 502                 $self->todo($cv, 1);
 503             }
 504             if (class($val->HV) ne "SPECIAL" && $key =~ /::$/) {
 505                 $self->stash_subs($pack . $key);
 506             }
 507         }
 508     }
 509 }
 510
 511 sub print_protos {
 512     my $self = shift;
 513     my $ar;
 514     my @ret;
 515     foreach $ar (@{$self->{'protos_todo'}}) {
 516         my $proto = (defined $ar->[1] ? " (". $ar->[1] . ")" : "");
 517         push @ret, "sub " . $ar->[0] .  "$proto;\n";
 518     }
 519     delete $self->{'protos_todo'};
 520     return @ret;
 521 }
 522
 523 sub style_opts {
 524     my $self = shift;
 525     my $opts = shift;
 526     my $opt;
 527     while (length($opt = substr($opts, 0, 1))) {
 528         if ($opt eq "C") {
 529             $self->{'cuddle'} = " ";
 530             $opts = substr($opts, 1);
 531         } elsif ($opt eq "i") {
 532             $opts =~ s/^i(\d+)//;
 533             $self->{'indent_size'} = $1;
 534         } elsif ($opt eq "T") {
 535             $self->{'use_tabs'} = 1;
 536             $opts = substr($opts, 1);
 537         } elsif ($opt eq "v") {
 538             $opts =~ s/^v([^.]*)(.|$)//;
 539             $self->{'ex_const'} = $1;
 540         }
 541     }
 542 }
 543
 544 sub new {
 545     my $class = shift;
 546     my $self = bless {}, $class;
 547     $self->{'cuddle'} = "\n";
 548     $self->{'curcop'} = undef;
 549     $self->{'curstash'} = "main";
 550     $self->{'ex_const'} = "'???'";
 551     $self->{'expand'} = 0;
 552     $self->{'files'} = {};
 553     $self->{'indent_size'} = 4;
 554     $self->{'linenums'} = 0;
 555     $self->{'parens'} = 0;
 556     $self->{'subs_todo'} = [];
 557     $self->{'unquote'} = 0;
 558     $self->{'use_dumper'} = 0;
 559     $self->{'use_tabs'} = 0;
 560
 561     $self->{'ambient_arybase'} = 0;
 562     $self->{'ambient_warnings'} = undef; # Assume no lexical warnings
 563     $self->{'ambient_hints'} = 0;
 564     $self->init();
 565
 566     while (my $arg = shift @_) {
 567         if ($arg eq "-d") {
 568             $self->{'use_dumper'} = 1;
 569             require Data::Dumper;
 570         } elsif ($arg =~ /^-f(.*)/) {
 571             $self->{'files'}{$1} = 1;
 572         } elsif ($arg eq "-l") {
 573             $self->{'linenums'} = 1;
 574         } elsif ($arg eq "-p") {
 575             $self->{'parens'} = 1;
 576         } elsif ($arg eq "-P") {
 577             $self->{'noproto'} = 1;
 578         } elsif ($arg eq "-q") {
 579             $self->{'unquote'} = 1;
 580         } elsif (substr($arg, 0, 2) eq "-s") {
 581             $self->style_opts(substr $arg, 2);
 582         } elsif ($arg =~ /^-x(\d)$/) {
 583             $self->{'expand'} = $1;
 584         }
 585     }
 586     return $self;
 587 }
 588
 589 {
 590     # Mask out the bits that L<warnings::register> uses
 591     my $WARN_MASK;
 592     BEGIN {
 593         $WARN_MASK = $warnings::Bits{all} | $warnings::DeadBits{all};
 594     }
 595     sub WARN_MASK () {
 596         return $WARN_MASK;
 597     }
 598 }
 599
 600 # Initialise the contextual information, either from
 601 # defaults provided with the ambient_pragmas method,
 602 # or from perl's own defaults otherwise.
 603 sub init {
 604     my $self = shift;
 605
 606     $self->{'arybase'}  = $self->{'ambient_arybase'};
 607     $self->{'warnings'} = defined ($self->{'ambient_warnings'})
 608                                 ? $self->{'ambient_warnings'} & WARN_MASK
 609                                 : undef;
 610     $self->{'hints'}    = $self->{'ambient_hints'};
 611
 612     # also a convenient place to clear out subs_declared
 613     delete $self->{'subs_declared'};
 614 }
 615
 616 sub compile {
 617     my(@args) = @_;
 618     return sub {
 619         my $self = B::Deparse->new(@args);
 620         # First deparse command-line args
 621         if (defined $^I) { # deparse -i
 622             print q(BEGIN { $^I = ).perlstring($^I).qq(; }\n);
 623         }
 624         if ($^W) { # deparse -w
 625             print qq(BEGIN { \$^W = $^W; }\n);
 626         }
 627         if ($/ ne "\n" or defined $O::savebackslash) { # deparse -l and -0
 628             my $fs = perlstring($/) || 'undef';
 629             my $bs = perlstring($O::savebackslash) || 'undef';
 630             print qq(BEGIN { \$/ = $fs; \$\\ = $bs; }\n);
 631         }
 632         my @BEGINs  = B::begin_av->isa("B::AV") ? B::begin_av->ARRAY : ();
 633         my @CHECKs  = B::check_av->isa("B::AV") ? B::check_av->ARRAY : ();
 634         my @INITs   = B::init_av->isa("B::AV") ? B::init_av->ARRAY : ();
 635         my @ENDs    = B::end_av->isa("B::AV") ? B::end_av->ARRAY : ();
 636         for my $block (@BEGINs, @CHECKs, @INITs, @ENDs) {
 637             $self->todo($block, 0);
 638         }
 639         $self->stash_subs();
 640         local($SIG{"__DIE__"}) =
 641           sub {
 642               if ($self->{'curcop'}) {
 643                   my $cop = $self->{'curcop'};
 644                   my($line, $file) = ($cop->line, $cop->file);
 645                   print STDERR "While deparsing $file near line $line,\n";
 646               }
 647             };
 648         $self->{'curcv'} = main_cv;
 649         $self->{'curcvlex'} = undef;
 650         print $self->print_protos;
 651         @{$self->{'subs_todo'}} =
 652           sort {$a->[0] <=> $b->[0]} @{$self->{'subs_todo'}};
 653         print $self->indent($self->deparse_root(main_root)), "\n"
 654           unless null main_root;
 655         my @text;
 656         while (scalar(@{$self->{'subs_todo'}})) {
 657             push @text, $self->next_todo;
 658         }
 659         print $self->indent(join("", @text)), "\n" if @text;
 660
 661         # Print __DATA__ section, if necessary
 662         no strict 'refs';
 663         my $laststash = defined $self->{'curcop'}
 664             ? $self->{'curcop'}->stash->NAME : $self->{'curstash'};
 665         if (defined *{$laststash."::DATA"}{IO}) {
 666             print "package $laststash;\n"
 667                 unless $laststash eq $self->{'curstash'};
 668             print "__DATA__\n";
 669             print readline(*{$laststash."::DATA"});
 670         }
 671     }
 672 }
 673
 674 sub coderef2text {
 675     my $self = shift;
 676     my $sub = shift;
 677     croak "Usage: ->coderef2text(CODEREF)" unless UNIVERSAL::isa($sub, "CODE");
 678
 679     $self->init();
 680     return $self->indent($self->deparse_sub(svref_2object($sub)));
 681 }
 682
 683 sub ambient_pragmas {
 684     my $self = shift;
 685     my ($arybase, $hint_bits, $warning_bits) = (0, 0);
 686
 687     while (@_ > 1) {
 688         my $name = shift();
 689         my $val  = shift();
 690
 691         if ($name eq 'strict') {
 692             require strict;
 693
 694             if ($val eq 'none') {
 695                 $hint_bits &= ~strict::bits(qw/refs subs vars/);
 696                 next();
 697             }
 698
 699             my @names;
 700             if ($val eq "all") {
 701                 @names = qw/refs subs vars/;
 702             }
 703             elsif (ref $val) {
 704                 @names = @$val;
 705             }
 706             else {
 707                 @names = split' ', $val;
 708             }
 709             $hint_bits |= strict::bits(@names);
 710         }
 711
 712         elsif ($name eq '$[') {
 713             $arybase = $val;
 714         }
 715
 716         elsif ($name eq 'integer'
 717             || $name eq 'bytes'
 718             || $name eq 'utf8') {
 719             require "$name.pm";
 720             if ($val) {
 721                 $hint_bits |= ${$::{"${name}::"}{"hint_bits"}};
 722             }
 723             else {
 724                 $hint_bits &= ~${$::{"${name}::"}{"hint_bits"}};
 725             }
 726         }
 727
 728         elsif ($name eq 're') {
 729             require re;
 730             if ($val eq 'none') {
 731                 $hint_bits &= ~re::bits(qw/taint eval/);
 732                 next();
 733             }
 734
 735             my @names;
 736             if ($val eq 'all') {
 737                 @names = qw/taint eval/;
 738             }
 739             elsif (ref $val) {
 740                 @names = @$val;
 741             }
 742             else {
 743                 @names = split' ',$val;
 744             }
 745             $hint_bits |= re::bits(@names);
 746         }
 747
 748         elsif ($name eq 'warnings') {
 749             if ($val eq 'none') {
 750                 $warning_bits = $warnings::NONE;
 751                 next();
 752             }
 753
 754             my @names;
 755             if (ref $val) {
 756                 @names = @$val;
 757             }
 758             else {
 759                 @names = split/\s+/, $val;
 760             }
 761
 762             $warning_bits = $warnings::NONE if !defined ($warning_bits);
 763             $warning_bits |= warnings::bits(@names);
 764         }
 765
 766         elsif ($name eq 'warning_bits') {
 767             $warning_bits = $val;
 768         }
 769
 770         elsif ($name eq 'hint_bits') {
 771             $hint_bits = $val;
 772         }
 773
 774         else {
 775             croak "Unknown pragma type: $name";
 776         }
 777     }
 778     if (@_) {
 779         croak "The ambient_pragmas method expects an even number of args";
 780     }
 781
 782     $self->{'ambient_arybase'} = $arybase;
 783     $self->{'ambient_warnings'} = $warning_bits;
 784     $self->{'ambient_hints'} = $hint_bits;
 785 }
 786
 787 # This method is the inner loop, so try to keep it simple
 788 sub deparse {
 789     my $self = shift;
 790     my($op, $cx) = @_;
 791
 792     Carp::confess("Null op in deparse") if !defined($op)
 793                                         || class($op) eq "NULL";
 794     my $meth = "pp_" . $op->name;
 795     return $self->$meth($op, $cx);
 796 }
 797
 798 sub indent {
 799     my $self = shift;
 800     my $txt = shift;
 801     my @lines = split(/\n/, $txt);
 802     my $leader = "";
 803     my $level = 0;
 804     my $line;
 805     for $line (@lines) {
 806         my $cmd = substr($line, 0, 1);
 807         if ($cmd eq "\t" or $cmd eq "\b") {
 808             $level += ($cmd eq "\t" ? 1 : -1) * $self->{'indent_size'};
 809             if ($self->{'use_tabs'}) {
 810                 $leader = "\t" x ($level / 8) . " " x ($level % 8);
 811             } else {
 812                 $leader = " " x $level;
 813             }
 814             $line = substr($line, 1);
 815         }
 816         if (substr($line, 0, 1) eq "\f") {
 817             $line = substr($line, 1); # no indent
 818         } else {
 819             $line = $leader . $line;
 820         }
 821         $line =~ s/\cK;?//g;
 822     }
 823     return join("\n", @lines);
 824 }
 825
 826 sub deparse_sub {
 827     my $self = shift;
 828     my $cv = shift;
 829     my $proto = "";
 830 Carp::confess("NULL in deparse_sub") if !defined($cv) || $cv->isa("B::NULL");
 831 Carp::confess("SPECIAL in deparse_sub") if $cv->isa("B::SPECIAL");
 832     local $self->{'curcop'} = $self->{'curcop'};
 833     if ($cv->FLAGS & SVf_POK) {
 834         $proto = "(". $cv->PV . ") ";
 835     }
 836     if ($cv->CvFLAGS & (CVf_METHOD|CVf_LOCKED|CVf_LVALUE|CVf_ASSERTION)) {
 837         $proto .= ": ";
 838         $proto .= "lvalue " if $cv->CvFLAGS & CVf_LVALUE;
 839         $proto .= "locked " if $cv->CvFLAGS & CVf_LOCKED;
 840         $proto .= "method " if $cv->CvFLAGS & CVf_METHOD;
 841         $proto .= "assertion " if $cv->CvFLAGS & CVf_ASSERTION;
 842     }
 843
 844     local($self->{'curcv'}) = $cv;
 845     local($self->{'curcvlex'});
 846     local(@$self{qw'curstash warnings hints'})
 847                 = @$self{qw'curstash warnings hints'};
 848     my $body;
 849     if (not null $cv->ROOT) {
 850         my $lineseq = $cv->ROOT->first;
 851         if ($lineseq->name eq "lineseq") {
 852             my @ops;
 853             for(my$o=$lineseq->first; $$o; $o=$o->sibling) {
 854                 push @ops, $o;
 855             }
 856             $body = $self->lineseq(undef, @ops).";";
 857             my $scope_en = $self->find_scope_en($lineseq);
 858             if (defined $scope_en) {
 859                 my $subs = join"", $self->seq_subs($scope_en);
 860                 $body .= ";\n$subs" if length($subs);
 861             }
 862         }
 863         else {
 864             $body = $self->deparse($cv->ROOT->first, 0);
 865         }
 866     }
 867     else {
 868         my $sv = $cv->const_sv;
 869         if ($$sv) {
 870             # uh-oh. inlinable sub... format it differently
 871             return $proto . "{ " . $self->const($sv, 0) . " }\n";
 872         } else { # XSUB? (or just a declaration)
 873             return "$proto;\n";
 874         }
 875     }
 876     return $proto ."{\n\t$body\n\b}" ."\n";
 877 }
 878
 879 sub deparse_format {
 880     my $self = shift;
 881     my $form = shift;
 882     my @text;
 883     local($self->{'curcv'}) = $form;
 884     local($self->{'curcvlex'});
 885     local($self->{'in_format'}) = 1;
 886     local(@$self{qw'curstash warnings hints'})
 887                 = @$self{qw'curstash warnings hints'};
 888     my $op = $form->ROOT;
 889     my $kid;
 890     return "\f." if $op->first->name eq 'stub'
 891                 || $op->first->name eq 'nextstate';
 892     $op = $op->first->first; # skip leavewrite, lineseq
 893     while (not null $op) {
 894         $op = $op->sibling; # skip nextstate
 895         my @exprs;
 896         $kid = $op->first->sibling; # skip pushmark
 897         push @text, "\f".$self->const_sv($kid)->PV;
 898         $kid = $kid->sibling;
 899         for (; not null $kid; $kid = $kid->sibling) {
 900             push @exprs, $self->deparse($kid, 0);
 901         }
 902         push @text, "\f".join(", ", @exprs)."\n" if @exprs;
 903         $op = $op->sibling;
 904     }
 905     return join("", @text) . "\f.";
 906 }
 907
 908 sub is_scope {
 909     my $op = shift;
 910     return $op->name eq "leave" || $op->name eq "scope"
 911       || $op->name eq "lineseq"
 912         || ($op->name eq "null" && class($op) eq "UNOP"
 913             && (is_scope($op->first) || $op->first->name eq "enter"));
 914 }
 915
 916 sub is_state {
 917     my $name = $_[0]->name;
 918     return $name eq "nextstate" || $name eq "dbstate" || $name eq "setstate";
 919 }
 920
 921 sub is_miniwhile { # check for one-line loop (`foo() while $y--')
 922     my $op = shift;
 923     return (!null($op) and null($op->sibling)
 924             and $op->name eq "null" and class($op) eq "UNOP"
 925             and (($op->first->name =~ /^(and|or)$/
 926                   and $op->first->first->sibling->name eq "lineseq")
 927                  or ($op->first->name eq "lineseq"
 928                      and not null $op->first->first->sibling
 929                      and $op->first->first->sibling->name eq "unstack")
 930                  ));
 931 }
 932
 933 # Check if the op and its sibling are the initialization and the rest of a
 934 # for (..;..;..) { ... } loop
 935 sub is_for_loop {
 936     my $op = shift;
 937     # This OP might be almost anything, though it won't be a
 938     # nextstate. (It's the initialization, so in the canonical case it
 939     # will be an sassign.) The sibling is a lineseq whose first child
 940     # is a nextstate and whose second is a leaveloop.
 941     my $lseq = $op->sibling;
 942     if (!is_state $op and !null($lseq) and $lseq->name eq "lineseq") {
 943         if ($lseq->first && !null($lseq->first) && is_state($lseq->first)
 944             && (my $sib = $lseq->first->sibling)) {
 945             return (!null($sib) && $sib->name eq "leaveloop");
 946         }
 947     }
 948     return 0;
 949 }
 950
 951 sub is_scalar {
 952     my $op = shift;
 953     return ($op->name eq "rv2sv" or
 954             $op->name eq "padsv" or
 955             $op->name eq "gv" or # only in array/hash constructs
 956             $op->flags & OPf_KIDS && !null($op->first)
 957               && $op->first->name eq "gvsv");
 958 }
 959
 960 sub maybe_parens {
 961     my $self = shift;
 962     my($text, $cx, $prec) = @_;
 963     if ($prec < $cx              # unary ops nest just fine
 964         or $prec == $cx and $cx != 4 and $cx != 16 and $cx != 21
 965         or $self->{'parens'})
 966     {
 967         $text = "($text)";
 968         # In a unop, let parent reuse our parens; see maybe_parens_unop
 969         $text = "\cS" . $text if $cx == 16;
 970         return $text;
 971     } else {
 972         return $text;
 973     }
 974 }
 975
 976 # same as above, but get around the `if it looks like a function' rule
 977 sub maybe_parens_unop {
 978     my $self = shift;
 979     my($name, $kid, $cx) = @_;
 980     if ($cx > 16 or $self->{'parens'}) {
 981         $kid =  $self->deparse($kid, 1);
 982         if ($name eq "umask" && $kid =~ /^\d+$/) {
 983             $kid = sprintf("%#o", $kid);
 984         }
 985         return "$name($kid)";
 986     } else {
 987         $kid = $self->deparse($kid, 16);
 988         if ($name eq "umask" && $kid =~ /^\d+$/) {
 989             $kid = sprintf("%#o", $kid);
 990         }
 991         if (substr($kid, 0, 1) eq "\cS") {
 992             # use kid's parens
 993             return $name . substr($kid, 1);
 994         } elsif (substr($kid, 0, 1) eq "(") {
 995             # avoid looks-like-a-function trap with extra parens
 996             # (`+' can lead to ambiguities)
 997             return "$name(" . $kid  . ")";
 998         } else {
 999             return "$name $kid";
1000         }
1001     }
1002 }
1003
1004 sub maybe_parens_func {
1005     my $self = shift;
1006     my($func, $text, $cx, $prec) = @_;
1007     if ($prec <= $cx or substr($text, 0, 1) eq "(" or $self->{'parens'}) {
1008         return "$func($text)";
1009     } else {
1010         return "$func $text";
1011     }
1012 }
1013
1014 sub maybe_local {
1015     my $self = shift;
1016     my($op, $cx, $text) = @_;
1017     my $our_intro = ($op->name =~ /^(gv|rv2)[ash]v$/) ? OPpOUR_INTRO : 0;
1018     if ($op->private & (OPpLVAL_INTRO|$our_intro)
1019         and not $self->{'avoid_local'}{$$op}) {
1020         my $our_local = ($op->private & OPpLVAL_INTRO) ? "local" : "our";
1021         if( $our_local eq 'our' ) {
1022             # XXX This assertion fails code with non-ASCII identifiers,
1023             # like ./ext/Encode/t/jperl.t
1024             die "Unexpected our($text)\n" unless $text =~ /^\W(\w+::)*\w+\z/;
1025             $text =~ s/(\w+::)+//;
1026         }
1027         if (want_scalar($op)) {
1028             return "$our_local $text";
1029         } else {
1030             return $self->maybe_parens_func("$our_local", $text, $cx, 16);
1031         }
1032     } else {
1033         return $text;
1034     }
1035 }
1036
1037 sub maybe_targmy {
1038     my $self = shift;
1039     my($op, $cx, $func, @args) = @_;
1040     if ($op->private & OPpTARGET_MY) {
1041         my $var = $self->padname($op->targ);
1042         my $val = $func->($self, $op, 7, @args);
1043         return $self->maybe_parens("$var = $val", $cx, 7);
1044     } else {
1045         return $func->($self, $op, $cx, @args);
1046     }
1047 }
1048
1049 sub padname_sv {
1050     my $self = shift;
1051     my $targ = shift;
1052     return $self->{'curcv'}->PADLIST->ARRAYelt(0)->ARRAYelt($targ);
1053 }
1054
1055 sub maybe_my {
1056     my $self = shift;
1057     my($op, $cx, $text) = @_;
1058     if ($op->private & OPpLVAL_INTRO and not $self->{'avoid_local'}{$$op}) {
1059         my $my = $op->private & OPpPAD_STATE ? "state" : "my";
1060         if (want_scalar($op)) {
1061             return "$my $text";
1062         } else {
1063             return $self->maybe_parens_func($my, $text, $cx, 16);
1064         }
1065     } else {
1066         return $text;
1067     }
1068 }
1069
1070 # The following OPs don't have functions:
1071
1072 # pp_padany -- does not exist after parsing
1073
1074 sub AUTOLOAD {
1075     if ($AUTOLOAD =~ s/^.*::pp_//) {
1076         warn "unexpected OP_".uc $AUTOLOAD;
1077         return "XXX";
1078     } else {
1079         die "Undefined subroutine $AUTOLOAD called";
1080     }
1081 }
1082
1083 sub DESTROY {}  #       Do not AUTOLOAD
1084
1085 # $root should be the op which represents the root of whatever
1086 # we're sequencing here. If it's undefined, then we don't append
1087 # any subroutine declarations to the deparsed ops, otherwise we
1088 # append appropriate declarations.
1089 sub lineseq {
1090     my($self, $root, @ops) = @_;
1091     my($expr, @exprs);
1092
1093     my $out_cop = $self->{'curcop'};
1094     my $out_seq = defined($out_cop) ? $out_cop->cop_seq : undef;
1095     my $limit_seq;
1096     if (defined $root) {
1097         $limit_seq = $out_seq;
1098         my $nseq;
1099         $nseq = $self->find_scope_st($root->sibling) if ${$root->sibling};
1100         $limit_seq = $nseq if !defined($limit_seq)
1101                            or defined($nseq) && $nseq < $limit_seq;
1102     }
1103     $limit_seq = $self->{'limit_seq'}
1104         if defined($self->{'limit_seq'})
1105         && (!defined($limit_seq) || $self->{'limit_seq'} < $limit_seq);
1106     local $self->{'limit_seq'} = $limit_seq;
1107     for (my $i = 0; $i < @ops; $i++) {
1108         $expr = "";
1109         if (is_state $ops[$i]) {
1110             $expr = $self->deparse($ops[$i], 0);
1111             $i++;
1112             if ($i > $#ops) {
1113                 push @exprs, $expr;
1114                 last;
1115             }
1116         }
1117         if (!is_state $ops[$i] and (my $ls = $ops[$i+1]) and
1118             !null($ops[$i+1]) and $ops[$i+1]->name eq "lineseq")
1119         {
1120             if ($ls->first && !null($ls->first) && is_state($ls->first)
1121                 && (my $sib = $ls->first->sibling)) {
1122                 if (!null($sib) && $sib->name eq "leaveloop") {
1123                     push @exprs, $expr . $self->for_loop($ops[$i], 0);
1124                     $i++;
1125                     next;
1126                 }
1127             }
1128         }
1129         $expr .= $self->deparse($ops[$i], (@ops != 1)/2);
1130         $expr =~ s/;\n?\z//;
1131         push @exprs, $expr;
1132     }
1133     my $body = join(";\n", grep {length} @exprs);
1134     my $subs = "";
1135     if (defined $root && defined $limit_seq && !$self->{'in_format'}) {
1136         $subs = join "\n", $self->seq_subs($limit_seq);
1137     }
1138     return join(";\n", grep {length} $body, $subs);
1139 }
1140
1141 sub scopeop {
1142     my($real_block, $self, $op, $cx) = @_;
1143     my $kid;
1144     my @kids;
1145
1146     local(@$self{qw'curstash warnings hints'})
1147                 = @$self{qw'curstash warnings hints'} if $real_block;
1148     if ($real_block) {
1149         $kid = $op->first->sibling; # skip enter
1150         if (is_miniwhile($kid)) {
1151             my $top = $kid->first;
1152             my $name = $top->name;
1153             if ($name eq "and") {
1154                 $name = "while";
1155             } elsif ($name eq "or") {
1156                 $name = "until";
1157             } else { # no conditional -> while 1 or until 0
1158                 return $self->deparse($top->first, 1) . " while 1";
1159             }
1160             my $cond = $top->first;
1161             my $body = $cond->sibling->first; # skip lineseq
1162             $cond = $self->deparse($cond, 1);
1163             $body = $self->deparse($body, 1);
1164             return "$body $name $cond";
1165         }
1166     } else {
1167         $kid = $op->first;
1168     }
1169     for (; !null($kid); $kid = $kid->sibling) {
1170         push @kids, $kid;
1171     }
1172     if ($cx > 0) { # inside an expression, (a do {} while for lineseq)
1173         return "do {\n\t" . $self->lineseq($op, @kids) . "\n\b}";
1174     } else {
1175         my $lineseq = $self->lineseq($op, @kids);
1176         return (length ($lineseq) ? "$lineseq;" : "");
1177     }
1178 }
1179
1180 sub pp_scope { scopeop(0, @_); }
1181 sub pp_lineseq { scopeop(0, @_); }
1182 sub pp_leave { scopeop(1, @_); }
1183
1184 # This is a special case of scopeop and lineseq, for the case of the
1185 # main_root. The difference is that we print the output statements as
1186 # soon as we get them, for the sake of impatient users.
1187 sub deparse_root {
1188     my $self = shift;
1189     my($op) = @_;
1190     local(@$self{qw'curstash warnings hints'})
1191       = @$self{qw'curstash warnings hints'};
1192     my @kids;
1193     return if null $op->first; # Can happen, e.g., for Bytecode without -k
1194     for (my $kid = $op->first->sibling; !null($kid); $kid = $kid->sibling) {
1195         push @kids, $kid;
1196     }
1197     for (my $i = 0; $i < @kids; $i++) {
1198         my $expr = "";
1199         if (is_state $kids[$i]) {
1200             $expr = $self->deparse($kids[$i], 0);
1201             $i++;
1202             if ($i > $#kids) {
1203                 print $self->indent($expr);
1204                 last;
1205             }
1206         }
1207         if (is_for_loop($kids[$i])) {
1208             $expr .= $self->for_loop($kids[$i], 0);
1209             $expr .= ";\n" unless $i == $#kids;
1210             print $self->indent($expr);
1211             $i++;
1212             next;
1213         }
1214         $expr .= $self->deparse($kids[$i], (@kids != 1)/2);
1215         $expr =~ s/;\n?\z//;
1216         $expr .= ";";
1217         print $self->indent($expr);
1218         print "\n" unless $i == $#kids;
1219     }
1220 }
1221
1222 # The BEGIN {} is used here because otherwise this code isn't executed
1223 # when you run B::Deparse on itself.
1224 my %globalnames;
1225 BEGIN { map($globalnames{$_}++, "SIG", "STDIN", "STDOUT", "STDERR", "INC",
1226             "ENV", "ARGV", "ARGVOUT", "_"); }
1227
1228 sub gv_name {
1229     my $self = shift;
1230     my $gv = shift;
1231 Carp::confess() unless ref($gv) eq "B::GV";
1232     my $stash = $gv->STASH->NAME;
1233     my $name = $gv->SAFENAME;
1234     if (($stash eq 'main' && $globalnames{$name})
1235         or ($stash eq $self->{'curstash'} && !$globalnames{$name})
1236         or $name =~ /^[^A-Za-z_:]/)
1237     {
1238         $stash = "";
1239     } else {
1240         $stash = $stash . "::";
1241     }
1242     if ($name =~ /^(\^..|{)/) {
1243         $name = "{$name}";       # ${^WARNING_BITS}, etc and ${
1244     }
1245     return $stash . $name;
1246 }
1247
1248 # Return the name to use for a stash variable.
1249 # If a lexical with the same name is in scope, it may need to be
1250 # fully-qualified.
1251 sub stash_variable {
1252     my ($self, $prefix, $name) = @_;
1253
1254     return "$prefix$name" if $name =~ /::/;
1255
1256     unless ($prefix eq '$' || $prefix eq '@' || #'
1257             $prefix eq '%' || $prefix eq '$#') {
1258         return "$prefix$name";
1259     }
1260
1261     my $v = ($prefix eq '$#' ? '@' : $prefix) . $name;
1262     return $prefix .$self->{'curstash'}.'::'. $name if $self->lex_in_scope($v);
1263     return "$prefix$name";
1264 }
1265
1266 sub lex_in_scope {
1267     my ($self, $name) = @_;
1268     $self->populate_curcvlex() if !defined $self->{'curcvlex'};
1269
1270     return 0 if !defined($self->{'curcop'});
1271     my $seq = $self->{'curcop'}->cop_seq;
1272     return 0 if !exists $self->{'curcvlex'}{$name};
1273     for my $a (@{$self->{'curcvlex'}{$name}}) {
1274         my ($st, $en) = @$a;
1275         return 1 if $seq > $st && $seq <= $en;
1276     }
1277     return 0;
1278 }
1279
1280 sub populate_curcvlex {
1281     my $self = shift;
1282     for (my $cv = $self->{'curcv'}; class($cv) eq "CV"; $cv = $cv->OUTSIDE) {
1283         my $padlist = $cv->PADLIST;
1284         # an undef CV still in lexical chain
1285         next if class($padlist) eq "SPECIAL";
1286         my @padlist = $padlist->ARRAY;
1287         my @ns = $padlist[0]->ARRAY;
1288
1289         for (my $i=0; $i<@ns; ++$i) {
1290             next if class($ns[$i]) eq "SPECIAL";
1291             next if $ns[$i]->FLAGS & SVpad_OUR;  # Skip "our" vars
1292             if (class($ns[$i]) eq "PV") {
1293                 # Probably that pesky lexical @_
1294                 next;
1295             }
1296             my $name = $ns[$i]->PVX;
1297             my ($seq_st, $seq_en) =
1298                 ($ns[$i]->FLAGS & SVf_FAKE)
1299                     ? (0, 999999)
1300                     : ($ns[$i]->NVX, $ns[$i]->IVX);
1301
1302             push @{$self->{'curcvlex'}{$name}}, [$seq_st, $seq_en];
1303         }
1304     }
1305 }
1306
1307 sub find_scope_st { ((find_scope(@_))[0]); }
1308 sub find_scope_en { ((find_scope(@_))[1]); }
1309
1310 # Recurses down the tree, looking for pad variable introductions and COPs
1311 sub find_scope {
1312     my ($self, $op, $scope_st, $scope_en) = @_;
1313     carp("Undefined op in find_scope") if !defined $op;
1314     return ($scope_st, $scope_en) unless $op->flags & OPf_KIDS;
1315
1316     for (my $o=$op->first; $$o; $o=$o->sibling) {
1317         if ($o->name =~ /^pad.v$/ && $o->private & OPpLVAL_INTRO) {
1318             my $s = int($self->padname_sv($o->targ)->NVX);
1319             my $e = $self->padname_sv($o->targ)->IVX;
1320             $scope_st = $s if !defined($scope_st) || $s < $scope_st;
1321             $scope_en = $e if !defined($scope_en) || $e > $scope_en;
1322         }
1323         elsif (is_state($o)) {
1324             my $c = $o->cop_seq;
1325             $scope_st = $c if !defined($scope_st) || $c < $scope_st;
1326             $scope_en = $c if !defined($scope_en) || $c > $scope_en;
1327         }
1328         elsif ($o->flags & OPf_KIDS) {
1329             ($scope_st, $scope_en) =
1330                 $self->find_scope($o, $scope_st, $scope_en)
1331         }
1332     }
1333
1334     return ($scope_st, $scope_en);
1335 }
1336
1337 # Returns a list of subs which should be inserted before the COP
1338 sub cop_subs {
1339     my ($self, $op, $out_seq) = @_;
1340     my $seq = $op->cop_seq;
1341     # If we have nephews, then our sequence number indicates
1342     # the cop_seq of the end of some sort of scope.
1343     if (class($op->sibling) ne "NULL" && $op->sibling->flags & OPf_KIDS
1344         and my $nseq = $self->find_scope_st($op->sibling) ) {
1345         $seq = $nseq;
1346     }
1347     $seq = $out_seq if defined($out_seq) && $out_seq < $seq;
1348     return $self->seq_subs($seq);
1349 }
1350
1351 sub seq_subs {
1352     my ($self, $seq) = @_;
1353     my @text;
1354 #push @text, "# ($seq)\n";
1355
1356     return "" if !defined $seq;
1357     while (scalar(@{$self->{'subs_todo'}})
1358            and $seq > $self->{'subs_todo'}[0][0]) {
1359         push @text, $self->next_todo;
1360     }
1361     return @text;
1362 }
1363
1364 # Notice how subs and formats are inserted between statements here;
1365 # also $[ assignments and pragmas.
1366 sub pp_nextstate {
1367     my $self = shift;
1368     my($op, $cx) = @_;
1369     $self->{'curcop'} = $op;
1370     my @text;
1371     push @text, $self->cop_subs($op);
1372     push @text, $op->label . ": " if $op->label;
1373     my $stash = $op->stashpv;
1374     if ($stash ne $self->{'curstash'}) {
1375         push @text, "package $stash;\n";
1376         $self->{'curstash'} = $stash;
1377     }
1378
1379     if ($self->{'arybase'} != $op->arybase) {
1380         push @text, '$[ = '. $op->arybase .";\n";
1381         $self->{'arybase'} = $op->arybase;
1382     }
1383
1384     my $warnings = $op->warnings;
1385     my $warning_bits;
1386     if ($warnings->isa("B::SPECIAL") && $$warnings == 4) {
1387         $warning_bits = $warnings::Bits{"all"} & WARN_MASK;
1388     }
1389     elsif ($warnings->isa("B::SPECIAL") && $$warnings == 5) {
1390         $warning_bits = $warnings::NONE;
1391     }
1392     elsif ($warnings->isa("B::SPECIAL")) {
1393         $warning_bits = undef;
1394     }
1395     else {
1396         $warning_bits = $warnings->PV & WARN_MASK;
1397     }
1398
1399     if (defined ($warning_bits) and
1400        !defined($self->{warnings}) || $self->{'warnings'} ne $warning_bits) {
1401         push @text, declare_warnings($self->{'warnings'}, $warning_bits);
1402         $self->{'warnings'} = $warning_bits;
1403     }
1404
1405     if ($self->{'hints'} != $op->hints) {
1406         push @text, declare_hints($self->{'hints'}, $op->hints);
1407         $self->{'hints'} = $op->hints;
1408     }
1409
1410     # This should go after of any branches that add statements, to
1411     # increase the chances that it refers to the same line it did in
1412     # the original program.
1413     if ($self->{'linenums'}) {
1414         push @text, "\f#line " . $op->line .
1415           ' "' . $op->file, qq'"\n';
1416     }
1417
1418     return join("", @text);
1419 }
1420
1421 sub declare_warnings {
1422     my ($from, $to) = @_;
1423     if (($to & WARN_MASK) eq (warnings::bits("all") & WARN_MASK)) {
1424         return "use warnings;\n";
1425     }
1426     elsif (($to & WARN_MASK) eq ("\0"x length($to) & WARN_MASK)) {
1427         return "no warnings;\n";
1428     }
1429     return "BEGIN {\${^WARNING_BITS} = ".perlstring($to)."}\n";
1430 }
1431
1432 sub declare_hints {
1433     my ($from, $to) = @_;
1434     my $use = $to   & ~$from;
1435     my $no  = $from & ~$to;
1436     my $decls = "";
1437     for my $pragma (hint_pragmas($use)) {
1438         $decls .= "use $pragma;\n";
1439     }
1440     for my $pragma (hint_pragmas($no)) {
1441         $decls .= "no $pragma;\n";
1442     }
1443     return $decls;
1444 }
1445
1446 sub hint_pragmas {
1447     my ($bits) = @_;
1448     my @pragmas;
1449     push @pragmas, "integer" if $bits & 0x1;
1450     push @pragmas, "strict 'refs'" if $bits & 0x2;
1451     push @pragmas, "bytes" if $bits & 0x8;
1452     return @pragmas;
1453 }
1454
1455 sub pp_dbstate { pp_nextstate(@_) }
1456 sub pp_setstate { pp_nextstate(@_) }
1457
1458 sub pp_unstack { return "" } # see also leaveloop
1459
1460 sub baseop {
1461     my $self = shift;
1462     my($op, $cx, $name) = @_;
1463     return $name;
1464 }
1465
1466 sub pp_stub {
1467     my $self = shift;
1468     my($op, $cx, $name) = @_;
1469     if ($cx >= 1) {
1470         return "()";
1471     }
1472     else {
1473         return "();";
1474     }
1475 }
1476 sub pp_wantarray { baseop(@_, "wantarray") }
1477 sub pp_fork { baseop(@_, "fork") }
1478 sub pp_wait { maybe_targmy(@_, \&baseop, "wait") }
1479 sub pp_getppid { maybe_targmy(@_, \&baseop, "getppid") }
1480 sub pp_time { maybe_targmy(@_, \&baseop, "time") }
1481 sub pp_tms { baseop(@_, "times") }
1482 sub pp_ghostent { baseop(@_, "gethostent") }
1483 sub pp_gnetent { baseop(@_, "getnetent") }
1484 sub pp_gprotoent { baseop(@_, "getprotoent") }
1485 sub pp_gservent { baseop(@_, "getservent") }
1486 sub pp_ehostent { baseop(@_, "endhostent") }
1487 sub pp_enetent { baseop(@_, "endnetent") }
1488 sub pp_eprotoent { baseop(@_, "endprotoent") }
1489 sub pp_eservent { baseop(@_, "endservent") }
1490 sub pp_gpwent { baseop(@_, "getpwent") }
1491 sub pp_spwent { baseop(@_, "setpwent") }
1492 sub pp_epwent { baseop(@_, "endpwent") }
1493 sub pp_ggrent { baseop(@_, "getgrent") }
1494 sub pp_sgrent { baseop(@_, "setgrent") }
1495 sub pp_egrent { baseop(@_, "endgrent") }
1496 sub pp_getlogin { baseop(@_, "getlogin") }
1497
1498 sub POSTFIX () { 1 }
1499
1500 # I couldn't think of a good short name, but this is the category of
1501 # symbolic unary operators with interesting precedence
1502
1503 sub pfixop {
1504     my $self = shift;
1505     my($op, $cx, $name, $prec, $flags) = (@_, 0);
1506     my $kid = $op->first;
1507     $kid = $self->deparse($kid, $prec);
1508     return $self->maybe_parens(($flags & POSTFIX) ? "$kid$name" : "$name$kid",
1509                                $cx, $prec);
1510 }
1511
1512 sub pp_preinc { pfixop(@_, "++", 23) }
1513 sub pp_predec { pfixop(@_, "--", 23) }
1514 sub pp_postinc { maybe_targmy(@_, \&pfixop, "++", 23, POSTFIX) }
1515 sub pp_postdec { maybe_targmy(@_, \&pfixop, "--", 23, POSTFIX) }
1516 sub pp_i_preinc { pfixop(@_, "++", 23) }
1517 sub pp_i_predec { pfixop(@_, "--", 23) }
1518 sub pp_i_postinc { maybe_targmy(@_, \&pfixop, "++", 23, POSTFIX) }
1519 sub pp_i_postdec { maybe_targmy(@_, \&pfixop, "--", 23, POSTFIX) }
1520 sub pp_complement { maybe_targmy(@_, \&pfixop, "~", 21) }
1521
1522 sub pp_negate { maybe_targmy(@_, \&real_negate) }
1523 sub real_negate {
1524     my $self = shift;
1525     my($op, $cx) = @_;
1526     if ($op->first->name =~ /^(i_)?negate$/) {
1527         # avoid --$x
1528         $self->pfixop($op, $cx, "-", 21.5);
1529     } else {
1530         $self->pfixop($op, $cx, "-", 21);
1531     }
1532 }
1533 sub pp_i_negate { pp_negate(@_) }
1534
1535 sub pp_not {
1536     my $self = shift;
1537     my($op, $cx) = @_;
1538     if ($cx <= 4) {
1539         $self->pfixop($op, $cx, "not ", 4);
1540     } else {
1541         $self->pfixop($op, $cx, "!", 21);
1542     }
1543 }
1544
1545 sub unop {
1546     my $self = shift;
1547     my($op, $cx, $name) = @_;
1548     my $kid;
1549     if ($op->flags & OPf_KIDS) {
1550         $kid = $op->first;
1551         if (defined prototype("CORE::$name")
1552            && prototype("CORE::$name") =~ /^;?\*/
1553            && $kid->name eq "rv2gv") {
1554             $kid = $kid->first;
1555         }
1556
1557         return $self->maybe_parens_unop($name, $kid, $cx);
1558     } else {
1559         return $name .  ($op->flags & OPf_SPECIAL ? "()" : "");
1560     }
1561 }
1562
1563 sub pp_chop { maybe_targmy(@_, \&unop, "chop") }
1564 sub pp_chomp { maybe_targmy(@_, \&unop, "chomp") }
1565 sub pp_schop { maybe_targmy(@_, \&unop, "chop") }
1566 sub pp_schomp { maybe_targmy(@_, \&unop, "chomp") }
1567 sub pp_defined { unop(@_, "defined") }
1568 sub pp_undef { unop(@_, "undef") }
1569 sub pp_study { unop(@_, "study") }
1570 sub pp_ref { unop(@_, "ref") }
1571 sub pp_pos { maybe_local(@_, unop(@_, "pos")) }
1572
1573 sub pp_sin { maybe_targmy(@_, \&unop, "sin") }
1574 sub pp_cos { maybe_targmy(@_, \&unop, "cos") }
1575 sub pp_rand { maybe_targmy(@_, \&unop, "rand") }
1576 sub pp_srand { unop(@_, "srand") }
1577 sub pp_exp { maybe_targmy(@_, \&unop, "exp") }
1578 sub pp_log { maybe_targmy(@_, \&unop, "log") }
1579 sub pp_sqrt { maybe_targmy(@_, \&unop, "sqrt") }
1580 sub pp_int { maybe_targmy(@_, \&unop, "int") }
1581 sub pp_hex { maybe_targmy(@_, \&unop, "hex") }
1582 sub pp_oct { maybe_targmy(@_, \&unop, "oct") }
1583 sub pp_abs { maybe_targmy(@_, \&unop, "abs") }
1584
1585 sub pp_length { maybe_targmy(@_, \&unop, "length") }
1586 sub pp_ord { maybe_targmy(@_, \&unop, "ord") }
1587 sub pp_chr { maybe_targmy(@_, \&unop, "chr") }
1588
1589 sub pp_each { unop(@_, "each") }
1590 sub pp_values { unop(@_, "values") }
1591 sub pp_keys { unop(@_, "keys") }
1592 sub pp_pop { unop(@_, "pop") }
1593 sub pp_shift { unop(@_, "shift") }
1594
1595 sub pp_caller { unop(@_, "caller") }
1596 sub pp_reset { unop(@_, "reset") }
1597 sub pp_exit { unop(@_, "exit") }
1598 sub pp_prototype { unop(@_, "prototype") }
1599
1600 sub pp_close { unop(@_, "close") }
1601 sub pp_fileno { unop(@_, "fileno") }
1602 sub pp_umask { unop(@_, "umask") }
1603 sub pp_untie { unop(@_, "untie") }
1604 sub pp_tied { unop(@_, "tied") }
1605 sub pp_dbmclose { unop(@_, "dbmclose") }
1606 sub pp_getc { unop(@_, "getc") }
1607 sub pp_eof { unop(@_, "eof") }
1608 sub pp_tell { unop(@_, "tell") }
1609 sub pp_getsockname { unop(@_, "getsockname") }
1610 sub pp_getpeername { unop(@_, "getpeername") }
1611
1612 sub pp_chdir { maybe_targmy(@_, \&unop, "chdir") }
1613 sub pp_chroot { maybe_targmy(@_, \&unop, "chroot") }
1614 sub pp_readlink { unop(@_, "readlink") }
1615 sub pp_rmdir { maybe_targmy(@_, \&unop, "rmdir") }
1616 sub pp_readdir { unop(@_, "readdir") }
1617 sub pp_telldir { unop(@_, "telldir") }
1618 sub pp_rewinddir { unop(@_, "rewinddir") }
1619 sub pp_closedir { unop(@_, "closedir") }
1620 sub pp_getpgrp { maybe_targmy(@_, \&unop, "getpgrp") }
1621 sub pp_localtime { unop(@_, "localtime") }
1622 sub pp_gmtime { unop(@_, "gmtime") }
1623 sub pp_alarm { unop(@_, "alarm") }
1624 sub pp_sleep { maybe_targmy(@_, \&unop, "sleep") }
1625
1626 sub pp_dofile { unop(@_, "do") }
1627 sub pp_entereval { unop(@_, "eval") }
1628
1629 sub pp_ghbyname { unop(@_, "gethostbyname") }
1630 sub pp_gnbyname { unop(@_, "getnetbyname") }
1631 sub pp_gpbyname { unop(@_, "getprotobyname") }
1632 sub pp_shostent { unop(@_, "sethostent") }
1633 sub pp_snetent { unop(@_, "setnetent") }
1634 sub pp_sprotoent { unop(@_, "setprotoent") }
1635 sub pp_sservent { unop(@_, "setservent") }
1636 sub pp_gpwnam { unop(@_, "getpwnam") }
1637 sub pp_gpwuid { unop(@_, "getpwuid") }
1638 sub pp_ggrnam { unop(@_, "getgrnam") }
1639 sub pp_ggrgid { unop(@_, "getgrgid") }
1640
1641 sub pp_lock { unop(@_, "lock") }
1642
1643 sub pp_continue { unop(@_, "continue"); }
1644 sub pp_break {
1645     my ($self, $op) = @_;
1646     return "" if $op->flags & OPf_SPECIAL;
1647     unop(@_, "break");
1648 }
1649
1650 sub givwhen {
1651     my $self = shift;
1652     my($op, $cx, $givwhen) = @_;
1653
1654     my $enterop = $op->first;
1655     my ($head, $block);
1656     if ($enterop->flags & OPf_SPECIAL) {
1657         $head = "default";
1658         $block = $self->deparse($enterop->first, 0);
1659     }
1660     else {
1661         my $cond = $enterop->first;
1662         my $cond_str = $self->deparse($cond, 1);
1663         $head = "$givwhen ($cond_str)";
1664         $block = $self->deparse($cond->sibling, 0);
1665     }
1666
1667     return "$head {\n".
1668         "\t$block\n".
1669         "\b}\cK";
1670 }
1671
1672 sub pp_leavegiven { givwhen(@_, "given"); }
1673 sub pp_leavewhen  { givwhen(@_, "when"); }
1674
1675 sub pp_exists {
1676     my $self = shift;
1677     my($op, $cx) = @_;
1678     my $arg;
1679     if ($op->private & OPpEXISTS_SUB) {
1680         # Checking for the existence of a subroutine
1681         return $self->maybe_parens_func("exists",
1682                                 $self->pp_rv2cv($op->first, 16), $cx, 16);
1683     }
1684     if ($op->flags & OPf_SPECIAL) {
1685         # Array element, not hash element
1686         return $self->maybe_parens_func("exists",
1687                                 $self->pp_aelem($op->first, 16), $cx, 16);
1688     }
1689     return $self->maybe_parens_func("exists", $self->pp_helem($op->first, 16),
1690                                     $cx, 16);
1691 }
1692
1693 sub pp_delete {
1694     my $self = shift;
1695     my($op, $cx) = @_;
1696     my $arg;
1697     if ($op->private & OPpSLICE) {
1698         if ($op->flags & OPf_SPECIAL) {
1699             # Deleting from an array, not a hash
1700             return $self->maybe_parens_func("delete",
1701                                         $self->pp_aslice($op->first, 16),
1702                                         $cx, 16);
1703         }
1704         return $self->maybe_parens_func("delete",
1705                                         $self->pp_hslice($op->first, 16),
1706                                         $cx, 16);
1707     } else {
1708         if ($op->flags & OPf_SPECIAL) {
1709             # Deleting from an array, not a hash
1710             return $self->maybe_parens_func("delete",
1711                                         $self->pp_aelem($op->first, 16),
1712                                         $cx, 16);
1713         }
1714         return $self->maybe_parens_func("delete",
1715                                         $self->pp_helem($op->first, 16),
1716                                         $cx, 16);
1717     }
1718 }
1719
1720 sub pp_require {
1721     my $self = shift;
1722     my($op, $cx) = @_;
1723     my $opname = $op->flags & OPf_SPECIAL ? 'CORE::require' : 'require';
1724     if (class($op) eq "UNOP" and $op->first->name eq "const"
1725         and $op->first->private & OPpCONST_BARE)
1726     {
1727         my $name = $self->const_sv($op->first)->PV;
1728         $name =~ s[/][::]g;
1729         $name =~ s/\.pm//g;
1730         return "$opname $name";
1731     } else {
1732         $self->unop($op, $cx, $opname);
1733     }
1734 }
1735
1736 sub pp_scalar {
1737     my $self = shift;
1738     my($op, $cv) = @_;
1739     my $kid = $op->first;
1740     if (not null $kid->sibling) {
1741         # XXX Was a here-doc
1742         return $self->dquote($op);
1743     }
1744     $self->unop(@_, "scalar");
1745 }
1746
1747
1748 sub padval {
1749     my $self = shift;
1750     my $targ = shift;
1751     return $self->{'curcv'}->PADLIST->ARRAYelt(1)->ARRAYelt($targ);
1752 }
1753
1754 sub pp_refgen {
1755     my $self = shift;
1756     my($op, $cx) = @_;
1757     my $kid = $op->first;
1758     if ($kid->name eq "null") {
1759         $kid = $kid->first;
1760         if ($kid->name eq "anonlist" || $kid->name eq "anonhash") {
1761             my($pre, $post) = @{{"anonlist" => ["[","]"],
1762                                  "anonhash" => ["{","}"]}->{$kid->name}};
1763             my($expr, @exprs);
1764             $kid = $kid->first->sibling; # skip pushmark
1765             for (; !null($kid); $kid = $kid->sibling) {
1766                 $expr = $self->deparse($kid, 6);
1767                 push @exprs, $expr;
1768             }
1769             return $pre . join(", ", @exprs) . $post;
1770         } elsif (!null($kid->sibling) and
1771                  $kid->sibling->name eq "anoncode") {
1772             return "sub " .
1773                 $self->deparse_sub($self->padval($kid->sibling->targ));
1774         } elsif ($kid->name eq "pushmark") {
1775             my $sib_name = $kid->sibling->name;
1776             if ($sib_name =~ /^(pad|rv2)[ah]v$/
1777                 and not $kid->sibling->flags & OPf_REF)
1778             {
1779                 # The @a in \(@a) isn't in ref context, but only when the
1780                 # parens are there.
1781                 return "\\(" . $self->pp_list($op->first) . ")";
1782             } elsif ($sib_name eq 'entersub') {
1783                 my $text = $self->deparse($kid->sibling, 1);
1784                 # Always show parens for \(&func()), but only with -p otherwise
1785                 $text = "($text)" if $self->{'parens'}
1786                                  or $kid->sibling->private & OPpENTERSUB_AMPER;
1787                 return "\\$text";
1788             }
1789         }
1790     }
1791     $self->pfixop($op, $cx, "\\", 20);
1792 }
1793
1794 sub pp_srefgen { pp_refgen(@_) }
1795
1796 sub pp_readline {
1797     my $self = shift;
1798     my($op, $cx) = @_;
1799     my $kid = $op->first;
1800     $kid = $kid->first if $kid->name eq "rv2gv"; # <$fh>
1801     return "<" . $self->deparse($kid, 1) . ">" if is_scalar($kid);
1802     return $self->unop($op, $cx, "readline");
1803 }
1804
1805 sub pp_rcatline {
1806     my $self = shift;
1807     my($op) = @_;
1808     return "<" . $self->gv_name($self->gv_or_padgv($op)) . ">";
1809 }
1810
1811 # Unary operators that can occur as pseudo-listops inside double quotes
1812 sub dq_unop {
1813     my $self = shift;
1814     my($op, $cx, $name, $prec, $flags) = (@_, 0, 0);
1815     my $kid;
1816     if ($op->flags & OPf_KIDS) {
1817        $kid = $op->first;
1818        # If there's more than one kid, the first is an ex-pushmark.
1819        $kid = $kid->sibling if not null $kid->sibling;
1820        return $self->maybe_parens_unop($name, $kid, $cx);
1821     } else {
1822        return $name .  ($op->flags & OPf_SPECIAL ? "()" : "");
1823     }
1824 }
1825
1826 sub pp_ucfirst { dq_unop(@_, "ucfirst") }
1827 sub pp_lcfirst { dq_unop(@_, "lcfirst") }
1828 sub pp_uc { dq_unop(@_, "uc") }
1829 sub pp_lc { dq_unop(@_, "lc") }
1830 sub pp_quotemeta { maybe_targmy(@_, \&dq_unop, "quotemeta") }
1831
1832 sub loopex {
1833     my $self = shift;
1834     my ($op, $cx, $name) = @_;
1835     if (class($op) eq "PVOP") {
1836         return "$name " . $op->pv;
1837     } elsif (class($op) eq "OP") {
1838         return $name;
1839     } elsif (class($op) eq "UNOP") {
1840         # Note -- loop exits are actually exempt from the
1841         # looks-like-a-func rule, but a few extra parens won't hurt
1842         return $self->maybe_parens_unop($name, $op->first, $cx);
1843     }
1844 }
1845
1846 sub pp_last { loopex(@_, "last") }
1847 sub pp_next { loopex(@_, "next") }
1848 sub pp_redo { loopex(@_, "redo") }
1849 sub pp_goto { loopex(@_, "goto") }
1850 sub pp_dump { loopex(@_, "dump") }
1851
1852 sub ftst {
1853     my $self = shift;
1854     my($op, $cx, $name) = @_;
1855     if (class($op) eq "UNOP") {
1856         # Genuine `-X' filetests are exempt from the LLAFR, but not
1857         # l?stat(); for the sake of clarity, give'em all parens
1858         return $self->maybe_parens_unop($name, $op->first, $cx);
1859     } elsif (class($op) =~ /^(SV|PAD)OP$/) {
1860         return $self->maybe_parens_func($name, $self->pp_gv($op, 1), $cx, 16);
1861     } else { # I don't think baseop filetests ever survive ck_ftst, but...
1862         return $name;
1863     }
1864 }
1865
1866 sub pp_lstat    { ftst(@_, "lstat") }
1867 sub pp_stat     { ftst(@_, "stat") }
1868 sub pp_ftrread  { ftst(@_, "-R") }
1869 sub pp_ftrwrite { ftst(@_, "-W") }
1870 sub pp_ftrexec  { ftst(@_, "-X") }
1871 sub pp_fteread  { ftst(@_, "-r") }
1872 sub pp_ftewrite { ftst(@_, "-w") }
1873 sub pp_fteexec  { ftst(@_, "-x") }
1874 sub pp_ftis     { ftst(@_, "-e") }
1875 sub pp_fteowned { ftst(@_, "-O") }
1876 sub pp_ftrowned { ftst(@_, "-o") }
1877 sub pp_ftzero   { ftst(@_, "-z") }
1878 sub pp_ftsize   { ftst(@_, "-s") }
1879 sub pp_ftmtime  { ftst(@_, "-M") }
1880 sub pp_ftatime  { ftst(@_, "-A") }
1881 sub pp_ftctime  { ftst(@_, "-C") }
1882 sub pp_ftsock   { ftst(@_, "-S") }
1883 sub pp_ftchr    { ftst(@_, "-c") }
1884 sub pp_ftblk    { ftst(@_, "-b") }
1885 sub pp_ftfile   { ftst(@_, "-f") }
1886 sub pp_ftdir    { ftst(@_, "-d") }
1887 sub pp_ftpipe   { ftst(@_, "-p") }
1888 sub pp_ftlink   { ftst(@_, "-l") }
1889 sub pp_ftsuid   { ftst(@_, "-u") }
1890 sub pp_ftsgid   { ftst(@_, "-g") }
1891 sub pp_ftsvtx   { ftst(@_, "-k") }
1892 sub pp_fttty    { ftst(@_, "-t") }
1893 sub pp_fttext   { ftst(@_, "-T") }
1894 sub pp_ftbinary { ftst(@_, "-B") }
1895
1896 sub SWAP_CHILDREN () { 1 }
1897 sub ASSIGN () { 2 } # has OP= variant
1898 sub LIST_CONTEXT () { 4 } # Assignment is in list context
1899
1900 my(%left, %right);
1901
1902 sub assoc_class {
1903     my $op = shift;
1904     my $name = $op->name;
1905     if ($name eq "concat" and $op->first->name eq "concat") {
1906         # avoid spurious `=' -- see comment in pp_concat
1907         return "concat";
1908     }
1909     if ($name eq "null" and class($op) eq "UNOP"
1910         and $op->first->name =~ /^(and|x?or)$/
1911         and null $op->first->sibling)
1912     {
1913         # Like all conditional constructs, OP_ANDs and OP_ORs are topped
1914         # with a null that's used as the common end point of the two
1915         # flows of control. For precedence purposes, ignore it.
1916         # (COND_EXPRs have these too, but we don't bother with
1917         # their associativity).
1918         return assoc_class($op->first);
1919     }
1920     return $name . ($op->flags & OPf_STACKED ? "=" : "");
1921 }
1922
1923 # Left associative operators, like `+', for which
1924 # $a + $b + $c is equivalent to ($a + $b) + $c
1925
1926 BEGIN {
1927     %left = ('multiply' => 19, 'i_multiply' => 19,
1928              'divide' => 19, 'i_divide' => 19,
1929              'modulo' => 19, 'i_modulo' => 19,
1930              'repeat' => 19,
1931              'add' => 18, 'i_add' => 18,
1932              'subtract' => 18, 'i_subtract' => 18,
1933              'concat' => 18,
1934              'left_shift' => 17, 'right_shift' => 17,
1935              'bit_and' => 13,
1936              'bit_or' => 12, 'bit_xor' => 12,
1937              'and' => 3,
1938              'or' => 2, 'xor' => 2,
1939             );
1940 }
1941
1942 sub deparse_binop_left {
1943     my $self = shift;
1944     my($op, $left, $prec) = @_;
1945     if ($left{assoc_class($op)} && $left{assoc_class($left)}
1946         and $left{assoc_class($op)} == $left{assoc_class($left)})
1947     {
1948         return $self->deparse($left, $prec - .00001);
1949     } else {
1950         return $self->deparse($left, $prec);
1951     }
1952 }
1953
1954 # Right associative operators, like `=', for which
1955 # $a = $b = $c is equivalent to $a = ($b = $c)
1956
1957 BEGIN {
1958     %right = ('pow' => 22,
1959               'sassign=' => 7, 'aassign=' => 7,
1960               'multiply=' => 7, 'i_multiply=' => 7,
1961               'divide=' => 7, 'i_divide=' => 7,
1962               'modulo=' => 7, 'i_modulo=' => 7,
1963               'repeat=' => 7,
1964               'add=' => 7, 'i_add=' => 7,
1965               'subtract=' => 7, 'i_subtract=' => 7,
1966               'concat=' => 7,
1967               'left_shift=' => 7, 'right_shift=' => 7,
1968               'bit_and=' => 7,
1969               'bit_or=' => 7, 'bit_xor=' => 7,
1970               'andassign' => 7,
1971               'orassign' => 7,
1972              );
1973 }
1974
1975 sub deparse_binop_right {
1976     my $self = shift;
1977     my($op, $right, $prec) = @_;
1978     if ($right{assoc_class($op)} && $right{assoc_class($right)}
1979         and $right{assoc_class($op)} == $right{assoc_class($right)})
1980     {
1981         return $self->deparse($right, $prec - .00001);
1982     } else {
1983         return $self->deparse($right, $prec);
1984     }
1985 }
1986
1987 sub binop {
1988     my $self = shift;
1989     my ($op, $cx, $opname, $prec, $flags) = (@_, 0);
1990     my $left = $op->first;
1991     my $right = $op->last;
1992     my $eq = "";
1993     if ($op->flags & OPf_STACKED && $flags & ASSIGN) {
1994         $eq = "=";
1995         $prec = 7;
1996     }
1997     if ($flags & SWAP_CHILDREN) {
1998         ($left, $right) = ($right, $left);
1999     }
2000     $left = $self->deparse_binop_left($op, $left, $prec);
2001     $left = "($left)" if $flags & LIST_CONTEXT
2002                 && $left !~ /^(my|our|local|)[\@\(]/;
2003     $right = $self->deparse_binop_right($op, $right, $prec);
2004     return $self->maybe_parens("$left $opname$eq $right", $cx, $prec);
2005 }
2006
2007 sub pp_add { maybe_targmy(@_, \&binop, "+", 18, ASSIGN) }
2008 sub pp_multiply { maybe_targmy(@_, \&binop, "*", 19, ASSIGN) }
2009 sub pp_subtract { maybe_targmy(@_, \&binop, "-",18,  ASSIGN) }
2010 sub pp_divide { maybe_targmy(@_, \&binop, "/", 19, ASSIGN) }
2011 sub pp_modulo { maybe_targmy(@_, \&binop, "%", 19, ASSIGN) }
2012 sub pp_i_add { maybe_targmy(@_, \&binop, "+", 18, ASSIGN) }
2013 sub pp_i_multiply { maybe_targmy(@_, \&binop, "*", 19, ASSIGN) }
2014 sub pp_i_subtract { maybe_targmy(@_, \&binop, "-", 18, ASSIGN) }
2015 sub pp_i_divide { maybe_targmy(@_, \&binop, "/", 19, ASSIGN) }
2016 sub pp_i_modulo { maybe_targmy(@_, \&binop, "%", 19, ASSIGN) }
2017 sub pp_pow { maybe_targmy(@_, \&binop, "**", 22, ASSIGN) }
2018
2019 sub pp_left_shift { maybe_targmy(@_, \&binop, "<<", 17, ASSIGN) }
2020 sub pp_right_shift { maybe_targmy(@_, \&binop, ">>", 17, ASSIGN) }
2021 sub pp_bit_and { maybe_targmy(@_, \&binop, "&", 13, ASSIGN) }
2022 sub pp_bit_or { maybe_targmy(@_, \&binop, "|", 12, ASSIGN) }
2023 sub pp_bit_xor { maybe_targmy(@_, \&binop, "^", 12, ASSIGN) }
2024
2025 sub pp_eq { binop(@_, "==", 14) }
2026 sub pp_ne { binop(@_, "!=", 14) }
2027 sub pp_lt { binop(@_, "<", 15) }
2028 sub pp_gt { binop(@_, ">", 15) }
2029 sub pp_ge { binop(@_, ">=", 15) }
2030 sub pp_le { binop(@_, "<=", 15) }
2031 sub pp_ncmp { binop(@_, "<=>", 14) }
2032 sub pp_i_eq { binop(@_, "==", 14) }
2033 sub pp_i_ne { binop(@_, "!=", 14) }
2034 sub pp_i_lt { binop(@_, "<", 15) }
2035 sub pp_i_gt { binop(@_, ">", 15) }
2036 sub pp_i_ge { binop(@_, ">=", 15) }
2037 sub pp_i_le { binop(@_, "<=", 15) }
2038 sub pp_i_ncmp { binop(@_, "<=>", 14) }
2039
2040 sub pp_seq { binop(@_, "eq", 14) }
2041 sub pp_sne { binop(@_, "ne", 14) }
2042 sub pp_slt { binop(@_, "lt", 15) }
2043 sub pp_sgt { binop(@_, "gt", 15) }
2044 sub pp_sge { binop(@_, "ge", 15) }
2045 sub pp_sle { binop(@_, "le", 15) }
2046 sub pp_scmp { binop(@_, "cmp", 14) }
2047
2048 sub pp_sassign { binop(@_, "=", 7, SWAP_CHILDREN) }
2049 sub pp_aassign { binop(@_, "=", 7, SWAP_CHILDREN | LIST_CONTEXT) }
2050
2051 sub pp_smartmatch {
2052     my ($self, $op, $cx) = @_;
2053     if ($op->flags & OPf_SPECIAL) {
2054         return $self->deparse($op->first, $cx);
2055     }
2056     else {
2057         binop(@_, "~~", 14);
2058     }
2059 }
2060
2061 # `.' is special because concats-of-concats are optimized to save copying
2062 # by making all but the first concat stacked. The effect is as if the
2063 # programmer had written `($a . $b) .= $c', except legal.
2064 sub pp_concat { maybe_targmy(@_, \&real_concat) }
2065 sub real_concat {
2066     my $self = shift;
2067     my($op, $cx) = @_;
2068     my $left = $op->first;
2069     my $right = $op->last;
2070     my $eq = "";
2071     my $prec = 18;
2072     if ($op->flags & OPf_STACKED and $op->first->name ne "concat") {
2073         $eq = "=";
2074         $prec = 7;
2075     }
2076     $left = $self->deparse_binop_left($op, $left, $prec);
2077     $right = $self->deparse_binop_right($op, $right, $prec);
2078     return $self->maybe_parens("$left .$eq $right", $cx, $prec);
2079 }
2080
2081 # `x' is weird when the left arg is a list
2082 sub pp_repeat {
2083     my $self = shift;
2084     my($op, $cx) = @_;
2085     my $left = $op->first;
2086     my $right = $op->last;
2087     my $eq = "";
2088     my $prec = 19;
2089     if ($op->flags & OPf_STACKED) {
2090         $eq = "=";
2091         $prec = 7;
2092     }
2093     if (null($right)) { # list repeat; count is inside left-side ex-list
2094         my $kid = $left->first->sibling; # skip pushmark
2095         my @exprs;
2096         for (; !null($kid->sibling); $kid = $kid->sibling) {
2097             push @exprs, $self->deparse($kid, 6);
2098         }
2099         $right = $kid;
2100         $left = "(" . join(", ", @exprs). ")";
2101     } else {
2102         $left = $self->deparse_binop_left($op, $left, $prec);
2103     }
2104     $right = $self->deparse_binop_right($op, $right, $prec);
2105     return $self->maybe_parens("$left x$eq $right", $cx, $prec);
2106 }
2107
2108 sub range {
2109     my $self = shift;
2110     my ($op, $cx, $type) = @_;
2111     my $left = $op->first;
2112     my $right = $left->sibling;
2113     $left = $self->deparse($left, 9);
2114     $right = $self->deparse($right, 9);
2115     return $self->maybe_parens("$left $type $right", $cx, 9);
2116 }
2117
2118 sub pp_flop {
2119     my $self = shift;
2120     my($op, $cx) = @_;
2121     my $flip = $op->first;
2122     my $type = ($flip->flags & OPf_SPECIAL) ? "..." : "..";
2123     return $self->range($flip->first, $cx, $type);
2124 }
2125
2126 # one-line while/until is handled in pp_leave
2127
2128 sub logop {
2129     my $self = shift;
2130     my ($op, $cx, $lowop, $lowprec, $highop, $highprec, $blockname) = @_;
2131     my $left = $op->first;
2132     my $right = $op->first->sibling;
2133     if ($cx < 1 and is_scope($right) and $blockname
2134         and $self->{'expand'} < 7)
2135     { # if ($a) {$b}
2136         $left = $self->deparse($left, 1);
2137         $right = $self->deparse($right, 0);
2138         return "$blockname ($left) {\n\t$right\n\b}\cK";
2139     } elsif ($cx < 1 and $blockname and not $self->{'parens'}
2140              and $self->{'expand'} < 7) { # $b if $a
2141         $right = $self->deparse($right, 1);
2142         $left = $self->deparse($left, 1);
2143         return "$right $blockname $left";
2144     } elsif ($cx > $lowprec and $highop) { # $a && $b
2145         $left = $self->deparse_binop_left($op, $left, $highprec);
2146         $right = $self->deparse_binop_right($op, $right, $highprec);
2147         return $self->maybe_parens("$left $highop $right", $cx, $highprec);
2148     } else { # $a and $b
2149         $left = $self->deparse_binop_left($op, $left, $lowprec);
2150         $right = $self->deparse_binop_right($op, $right, $lowprec);
2151         return $self->maybe_parens("$left $lowop $right", $cx, $lowprec);
2152     }
2153 }
2154
2155 sub pp_and { logop(@_, "and", 3, "&&", 11, "if") }
2156 sub pp_or  { logop(@_, "or",  2, "||", 10, "unless") }
2157 sub pp_dor { logop(@_, "err", 2, "//", 10, "") }
2158
2159 # xor is syntactically a logop, but it's really a binop (contrary to
2160 # old versions of opcode.pl). Syntax is what matters here.
2161 sub pp_xor { logop(@_, "xor", 2, "",   0,  "") }
2162
2163 sub logassignop {
2164     my $self = shift;
2165     my ($op, $cx, $opname) = @_;
2166     my $left = $op->first;
2167     my $right = $op->first->sibling->first; # skip sassign
2168     $left = $self->deparse($left, 7);
2169     $right = $self->deparse($right, 7);
2170     return $self->maybe_parens("$left $opname $right", $cx, 7);
2171 }
2172
2173 sub pp_andassign { logassignop(@_, "&&=") }
2174 sub pp_orassign  { logassignop(@_, "||=") }
2175 sub pp_dorassign { logassignop(@_, "//=") }
2176
2177 sub listop {
2178     my $self = shift;
2179     my($op, $cx, $name) = @_;
2180     my(@exprs);
2181     my $parens = ($cx >= 5) || $self->{'parens'};
2182     my $kid = $op->first->sibling;
2183     return $name if null $kid;
2184     my $first;
2185     $name = "socketpair" if $name eq "sockpair";
2186     my $proto = prototype("CORE::$name");
2187     if (defined $proto
2188         && $proto =~ /^;?\*/
2189         && $kid->name eq "rv2gv") {
2190         $first = $self->deparse($kid->first, 6);
2191     }
2192     else {
2193         $first = $self->deparse($kid, 6);
2194     }
2195     if ($name eq "chmod" && $first =~ /^\d+$/) {
2196         $first = sprintf("%#o", $first);
2197     }
2198     $first = "+$first" if not $parens and substr($first, 0, 1) eq "(";
2199     push @exprs, $first;
2200     $kid = $kid->sibling;
2201     if (defined $proto && $proto =~ /^\*\*/ && $kid->name eq "rv2gv") {
2202         push @exprs, $self->deparse($kid->first, 6);
2203         $kid = $kid->sibling;
2204     }
2205     for (; !null($kid); $kid = $kid->sibling) {
2206         push @exprs, $self->deparse($kid, 6);
2207     }
2208     if ($parens) {
2209         return "$name(" . join(", ", @exprs) . ")";
2210     } else {
2211         return "$name " . join(", ", @exprs);
2212     }
2213 }
2214
2215 sub pp_bless { listop(@_, "bless") }
2216 sub pp_atan2 { maybe_targmy(@_, \&listop, "atan2") }
2217 sub pp_substr { maybe_local(@_, listop(@_, "substr")) }
2218 sub pp_vec { maybe_local(@_, listop(@_, "vec")) }
2219 sub pp_index { maybe_targmy(@_, \&listop, "index") }
2220 sub pp_rindex { maybe_targmy(@_, \&listop, "rindex") }
2221 sub pp_sprintf { maybe_targmy(@_, \&listop, "sprintf") }
2222 sub pp_formline { listop(@_, "formline") } # see also deparse_format
2223 sub pp_crypt { maybe_targmy(@_, \&listop, "crypt") }
2224 sub pp_unpack { listop(@_, "unpack") }
2225 sub pp_pack { listop(@_, "pack") }
2226 sub pp_join { maybe_targmy(@_, \&listop, "join") }
2227 sub pp_splice { listop(@_, "splice") }
2228 sub pp_push { maybe_targmy(@_, \&listop, "push") }
2229 sub pp_unshift { maybe_targmy(@_, \&listop, "unshift") }
2230 sub pp_reverse { listop(@_, "reverse") }
2231 sub pp_warn { listop(@_, "warn") }
2232 sub pp_die { listop(@_, "die") }
2233 # Actually, return is exempt from the LLAFR (see examples in this very
2234 # module!), but for consistency's sake, ignore that fact
2235 sub pp_return { listop(@_, "return") }
2236 sub pp_open { listop(@_, "open") }
2237 sub pp_pipe_op { listop(@_, "pipe") }
2238 sub pp_tie { listop(@_, "tie") }
2239 sub pp_binmode { listop(@_, "binmode") }
2240 sub pp_dbmopen { listop(@_, "dbmopen") }
2241 sub pp_sselect { listop(@_, "select") }
2242 sub pp_select { listop(@_, "select") }
2243 sub pp_read { listop(@_, "read") }
2244 sub pp_sysopen { listop(@_, "sysopen") }
2245 sub pp_sysseek { listop(@_, "sysseek") }
2246 sub pp_sysread { listop(@_, "sysread") }
2247 sub pp_syswrite { listop(@_, "syswrite") }
2248 sub pp_send { listop(@_, "send") }
2249 sub pp_recv { listop(@_, "recv") }
2250 sub pp_seek { listop(@_, "seek") }
2251 sub pp_fcntl { listop(@_, "fcntl") }
2252 sub pp_ioctl { listop(@_, "ioctl") }
2253 sub pp_flock { maybe_targmy(@_, \&listop, "flock") }
2254 sub pp_socket { listop(@_, "socket") }
2255 sub pp_sockpair { listop(@_, "sockpair") }
2256 sub pp_bind { listop(@_, "bind") }
2257 sub pp_connect { listop(@_, "connect") }
2258 sub pp_listen { listop(@_, "listen") }
2259 sub pp_accept { listop(@_, "accept") }
2260 sub pp_shutdown { listop(@_, "shutdown") }
2261 sub pp_gsockopt { listop(@_, "getsockopt") }
2262 sub pp_ssockopt { listop(@_, "setsockopt") }
2263 sub pp_chown { maybe_targmy(@_, \&listop, "chown") }
2264 sub pp_unlink { maybe_targmy(@_, \&listop, "unlink") }
2265 sub pp_chmod { maybe_targmy(@_, \&listop, "chmod") }
2266 sub pp_utime { maybe_targmy(@_, \&listop, "utime") }
2267 sub pp_rename { maybe_targmy(@_, \&listop, "rename") }
2268 sub pp_link { maybe_targmy(@_, \&listop, "link") }
2269 sub pp_symlink { maybe_targmy(@_, \&listop, "symlink") }
2270 sub pp_mkdir { maybe_targmy(@_, \&listop, "mkdir") }
2271 sub pp_open_dir { listop(@_, "opendir") }
2272 sub pp_seekdir { listop(@_, "seekdir") }
2273 sub pp_waitpid { maybe_targmy(@_, \&listop, "waitpid") }
2274 sub pp_system { maybe_targmy(@_, \&listop, "system") }
2275 sub pp_exec { maybe_targmy(@_, \&listop, "exec") }
2276 sub pp_kill { maybe_targmy(@_, \&listop, "kill") }
2277 sub pp_setpgrp { maybe_targmy(@_, \&listop, "setpgrp") }
2278 sub pp_getpriority { maybe_targmy(@_, \&listop, "getpriority") }
2279 sub pp_setpriority { maybe_targmy(@_, \&listop, "setpriority") }
2280 sub pp_shmget { listop(@_, "shmget") }
2281 sub pp_shmctl { listop(@_, "shmctl") }
2282 sub pp_shmread { listop(@_, "shmread") }
2283 sub pp_shmwrite { listop(@_, "shmwrite") }
2284 sub pp_msgget { listop(@_, "msgget") }
2285 sub pp_msgctl { listop(@_, "msgctl") }
2286 sub pp_msgsnd { listop(@_, "msgsnd") }
2287 sub pp_msgrcv { listop(@_, "msgrcv") }
2288 sub pp_semget { listop(@_, "semget") }
2289 sub pp_semctl { listop(@_, "semctl") }
2290 sub pp_semop { listop(@_, "semop") }
2291 sub pp_ghbyaddr { listop(@_, "gethostbyaddr") }
2292 sub pp_gnbyaddr { listop(@_, "getnetbyaddr") }
2293 sub pp_gpbynumber { listop(@_, "getprotobynumber") }
2294 sub pp_gsbyname { listop(@_, "getservbyname") }
2295 sub pp_gsbyport { listop(@_, "getservbyport") }
2296 sub pp_syscall { listop(@_, "syscall") }
2297
2298 sub pp_glob {
2299     my $self = shift;
2300     my($op, $cx) = @_;
2301     my $text = $self->dq($op->first->sibling);  # skip pushmark
2302     if ($text =~ /^\$?(\w|::|\`)+$/ # could look like a readline
2303         or $text =~ /[<>]/) {
2304         return 'glob(' . single_delim('qq', '"', $text) . ')';
2305     } else {
2306         return '<' . $text . '>';
2307     }
2308 }
2309
2310 # Truncate is special because OPf_SPECIAL makes a bareword first arg
2311 # be a filehandle. This could probably be better fixed in the core
2312 # by moving the GV lookup into ck_truc.
2313
2314 sub pp_truncate {
2315     my $self = shift;
2316     my($op, $cx) = @_;
2317     my(@exprs);
2318     my $parens = ($cx >= 5) || $self->{'parens'};
2319     my $kid = $op->first->sibling;
2320     my $fh;
2321     if ($op->flags & OPf_SPECIAL) {
2322         # $kid is an OP_CONST
2323         $fh = $self->const_sv($kid)->PV;
2324     } else {
2325         $fh = $self->deparse($kid, 6);
2326         $fh = "+$fh" if not $parens and substr($fh, 0, 1) eq "(";
2327     }
2328     my $len = $self->deparse($kid->sibling, 6);
2329     if ($parens) {
2330         return "truncate($fh, $len)";
2331     } else {
2332         return "truncate $fh, $len";
2333     }
2334 }
2335
2336 sub indirop {
2337     my $self = shift;
2338     my($op, $cx, $name) = @_;
2339     my($expr, @exprs);
2340     my $kid = $op->first->sibling;
2341     my $indir = "";
2342     if ($op->flags & OPf_STACKED) {
2343         $indir = $kid;
2344         $indir = $indir->first; # skip rv2gv
2345         if (is_scope($indir)) {
2346             $indir = "{" . $self->deparse($indir, 0) . "}";
2347             $indir = "{;}" if $indir eq "{}";
2348         } elsif ($indir->name eq "const" && $indir->private & OPpCONST_BARE) {
2349             $indir = $self->const_sv($indir)->PV;
2350         } else {
2351             $indir = $self->deparse($indir, 24);
2352         }
2353         $indir = $indir . " ";
2354         $kid = $kid->sibling;
2355     }
2356     if ($name eq "sort" && $op->private & (OPpSORT_NUMERIC | OPpSORT_INTEGER)) {
2357         $indir = ($op->private & OPpSORT_DESCEND) ? '{$b <=> $a} '
2358                                                   : '{$a <=> $b} ';
2359     }
2360     elsif ($name eq "sort" && $op->private & OPpSORT_DESCEND) {
2361         $indir = '{$b cmp $a} ';
2362     }
2363     for (; !null($kid); $kid = $kid->sibling) {
2364         $expr = $self->deparse($kid, 6);
2365         push @exprs, $expr;
2366     }
2367     my $name2 = $name;
2368     if ($name eq "sort" && $op->private & OPpSORT_REVERSE) {
2369         $name2 = 'reverse sort';
2370     }
2371     if ($name eq "sort" && ($op->private & OPpSORT_INPLACE)) {
2372         return "$exprs[0] = $name2 $indir $exprs[0]";
2373     }
2374
2375     my $args = $indir . join(", ", @exprs);
2376     if ($indir ne "" and $name eq "sort") {
2377         # We don't want to say "sort(f 1, 2, 3)", since perl -w will
2378         # give bareword warnings in that case. Therefore if context
2379         # requires, we'll put parens around the outside "(sort f 1, 2,
2380         # 3)". Unfortunately, we'll currently think the parens are
2381         # necessary more often that they really are, because we don't
2382         # distinguish which side of an assignment we're on.
2383         if ($cx >= 5) {
2384             return "($name2 $args)";
2385         } else {
2386             return "$name2 $args";
2387         }
2388     } else {
2389         return $self->maybe_parens_func($name2, $args, $cx, 5);
2390     }
2391
2392 }
2393
2394 sub pp_prtf { indirop(@_, "printf") }
2395 sub pp_print { indirop(@_, "print") }
2396 sub pp_sort { indirop(@_, "sort") }
2397
2398 sub mapop {
2399     my $self = shift;
2400     my($op, $cx, $name) = @_;
2401     my($expr, @exprs);
2402     my $kid = $op->first; # this is the (map|grep)start
2403     $kid = $kid->first->sibling; # skip a pushmark
2404     my $code = $kid->first; # skip a null
2405     if (is_scope $code) {
2406         $code = "{" . $self->deparse($code, 0) . "} ";
2407     } else {
2408         $code = $self->deparse($code, 24) . ", ";
2409     }
2410     $kid = $kid->sibling;
2411     for (; !null($kid); $kid = $kid->sibling) {
2412         $expr = $self->deparse($kid, 6);
2413         push @exprs, $expr if defined $expr;
2414     }
2415     return $self->maybe_parens_func($name, $code . join(", ", @exprs), $cx, 5);
2416 }
2417
2418 sub pp_mapwhile { mapop(@_, "map") }
2419 sub pp_grepwhile { mapop(@_, "grep") }
2420 sub pp_mapstart { baseop(@_, "map") }
2421 sub pp_grepstart { baseop(@_, "grep") }
2422
2423 sub pp_list {
2424     my $self = shift;
2425     my($op, $cx) = @_;
2426     my($expr, @exprs);
2427     my $kid = $op->first->sibling; # skip pushmark
2428     my $lop;
2429     my $local = "either"; # could be local(...), my(...), state(...) or our(...)
2430     for ($lop = $kid; !null($lop); $lop = $lop->sibling) {
2431         # This assumes that no other private flags equal 128, and that
2432         # OPs that store things other than flags in their op_private,
2433         # like OP_AELEMFAST, won't be immediate children of a list.
2434         #
2435         # OP_ENTERSUB can break this logic, so check for it.
2436         # I suspect that open and exit can too.
2437
2438         if (!($lop->private & (OPpLVAL_INTRO|OPpOUR_INTRO)
2439                 or $lop->name eq "undef")
2440             or $lop->name eq "entersub"
2441             or $lop->name eq "exit"
2442             or $lop->name eq "open")
2443         {
2444             $local = ""; # or not
2445             last;
2446         }
2447         if ($lop->name =~ /^pad[ash]v$/) {
2448             if ($lop->private & OPpPAD_STATE) { # state()
2449                 ($local = "", last) if $local =~ /^(?:local|our|my)$/;
2450                 $local = "state";
2451             } else { # my()
2452                 ($local = "", last) if $local =~ /^(?:local|our|state)$/;
2453                 $local = "my";
2454             }
2455         } elsif ($lop->name =~ /^(gv|rv2)[ash]v$/
2456                         && $lop->private & OPpOUR_INTRO
2457                 or $lop->name eq "null" && $lop->first->name eq "gvsv"
2458                         && $lop->first->private & OPpOUR_INTRO) { # our()
2459             ($local = "", last) if $local =~ /^(?:my|local|state)$/;
2460             $local = "our";
2461         } elsif ($lop->name ne "undef"
2462                 # specifically avoid the "reverse sort" optimisation,
2463                 # where "reverse" is nullified
2464                 && !($lop->name eq 'sort' && ($lop->flags & OPpSORT_REVERSE)))
2465         {
2466             # local()
2467             ($local = "", last) if $local =~ /^(?:my|our|state)$/;
2468             $local = "local";
2469         }
2470     }
2471     $local = "" if $local eq "either"; # no point if it's all undefs
2472     return $self->deparse($kid, $cx) if null $kid->sibling and not $local;
2473     for (; !null($kid); $kid = $kid->sibling) {
2474         if ($local) {
2475             if (class($kid) eq "UNOP" and $kid->first->name eq "gvsv") {
2476                 $lop = $kid->first;
2477             } else {
2478                 $lop = $kid;
2479             }
2480             $self->{'avoid_local'}{$$lop}++;
2481             $expr = $self->deparse($kid, 6);
2482             delete $self->{'avoid_local'}{$$lop};
2483         } else {
2484             $expr = $self->deparse($kid, 6);
2485         }
2486         push @exprs, $expr;
2487     }
2488     if ($local) {
2489         return "$local(" . join(", ", @exprs) . ")";
2490     } else {
2491         return $self->maybe_parens( join(", ", @exprs), $cx, 6);
2492     }
2493 }
2494
2495 sub is_ifelse_cont {
2496     my $op = shift;
2497     return ($op->name eq "null" and class($op) eq "UNOP"
2498             and $op->first->name =~ /^(and|cond_expr)$/
2499             and is_scope($op->first->first->sibling));
2500 }
2501
2502 sub pp_cond_expr {
2503     my $self = shift;
2504     my($op, $cx) = @_;
2505     my $cond = $op->first;
2506     my $true = $cond->sibling;
2507     my $false = $true->sibling;
2508     my $cuddle = $self->{'cuddle'};
2509     unless ($cx < 1 and (is_scope($true) and $true->name ne "null") and
2510             (is_scope($false) || is_ifelse_cont($false))
2511             and $self->{'expand'} < 7) {
2512         $cond = $self->deparse($cond, 8);
2513         $true = $self->deparse($true, 6);
2514         $false = $self->deparse($false, 8);
2515         return $self->maybe_parens("$cond ? $true : $false", $cx, 8);
2516     }
2517
2518     $cond = $self->deparse($cond, 1);
2519     $true = $self->deparse($true, 0);
2520     my $head = "if ($cond) {\n\t$true\n\b}";
2521     my @elsifs;
2522     while (!null($false) and is_ifelse_cont($false)) {
2523         my $newop = $false->first;
2524         my $newcond = $newop->first;
2525         my $newtrue = $newcond->sibling;
2526         $false = $newtrue->sibling; # last in chain is OP_AND => no else
2527         $newcond = $self->deparse($newcond, 1);
2528         $newtrue = $self->deparse($newtrue, 0);
2529         push @elsifs, "elsif ($newcond) {\n\t$newtrue\n\b}";
2530     }
2531     if (!null($false)) {
2532         $false = $cuddle . "else {\n\t" .
2533           $self->deparse($false, 0) . "\n\b}\cK";
2534     } else {
2535         $false = "\cK";
2536     }
2537     return $head . join($cuddle, "", @elsifs) . $false;
2538 }
2539
2540 sub loop_common {
2541     my $self = shift;
2542     my($op, $cx, $init) = @_;
2543     my $enter = $op->first;
2544     my $kid = $enter->sibling;
2545     local(@$self{qw'curstash warnings hints'})
2546                 = @$self{qw'curstash warnings hints'};
2547     my $head = "";
2548     my $bare = 0;
2549     my $body;
2550     my $cond = undef;
2551     if ($kid->name eq "lineseq") { # bare or infinite loop
2552         if ($kid->last->name eq "unstack") { # infinite
2553             $head = "while (1) "; # Can't use for(;;) if there's a continue
2554             $cond = "";
2555         } else {
2556             $bare = 1;
2557         }
2558         $body = $kid;
2559     } elsif ($enter->name eq "enteriter") { # foreach
2560         my $ary = $enter->first->sibling; # first was pushmark
2561         my $var = $ary->sibling;
2562         if ($ary->name eq 'null' and $enter->private & OPpITER_REVERSED) {
2563             # "reverse" was optimised away
2564             $ary = listop($self, $ary->first->sibling, 1, 'reverse');
2565         } elsif ($enter->flags & OPf_STACKED
2566             and not null $ary->first->sibling->sibling)
2567         {
2568             $ary = $self->deparse($ary->first->sibling, 9) . " .. " .
2569               $self->deparse($ary->first->sibling->sibling, 9);
2570         } else {
2571             $ary = $self->deparse($ary, 1);
2572         }
2573         if (null $var) {
2574             if ($enter->flags & OPf_SPECIAL) { # thread special var
2575                 $var = $self->pp_threadsv($enter, 1);
2576             } else { # regular my() variable
2577                 $var = $self->pp_padsv($enter, 1);
2578             }
2579         } elsif ($var->name eq "rv2gv") {
2580             $var = $self->pp_rv2sv($var, 1);
2581             if ($enter->private & OPpOUR_INTRO) {
2582                 # our declarations don't have package names
2583                 $var =~ s/^(.).*::/$1/;
2584                 $var = "our $var";
2585             }
2586         } elsif ($var->name eq "gv") {
2587             $var = "\$" . $self->deparse($var, 1);
2588         }
2589         $body = $kid->first->first->sibling; # skip OP_AND and OP_ITER
2590         if (!is_state $body->first and $body->first->name ne "stub") {
2591             confess unless $var eq '$_';
2592             $body = $body->first;
2593             return $self->deparse($body, 2) . " foreach ($ary)";
2594         }
2595         $head = "foreach $var ($ary) ";
2596     } elsif ($kid->name eq "null") { # while/until
2597         $kid = $kid->first;
2598         my $name = {"and" => "while", "or" => "until"}->{$kid->name};
2599         $cond = $self->deparse($kid->first, 1);
2600         $head = "$name ($cond) ";
2601         $body = $kid->first->sibling;
2602     } elsif ($kid->name eq "stub") { # bare and empty
2603         return "{;}"; # {} could be a hashref
2604     }
2605     # If there isn't a continue block, then the next pointer for the loop
2606     # will point to the unstack, which is kid's last child, except
2607     # in a bare loop, when it will point to the leaveloop. When neither of
2608     # these conditions hold, then the second-to-last child is the continue
2609     # block (or the last in a bare loop).
2610     my $cont_start = $enter->nextop;
2611     my $cont;
2612     if ($$cont_start != $$op && ${$cont_start} != ${$body->last}) {
2613         if ($bare) {
2614             $cont = $body->last;
2615         } else {
2616             $cont = $body->first;
2617             while (!null($cont->sibling->sibling)) {
2618                 $cont = $cont->sibling;
2619             }
2620         }
2621         my $state = $body->first;
2622         my $cuddle = $self->{'cuddle'};
2623         my @states;
2624         for (; $$state != $$cont; $state = $state->sibling) {
2625             push @states, $state;
2626         }
2627         $body = $self->lineseq(undef, @states);
2628         if (defined $cond and not is_scope $cont and $self->{'expand'} < 3) {
2629             $head = "for ($init; $cond; " . $self->deparse($cont, 1) .") ";
2630             $cont = "\cK";
2631         } else {
2632             $cont = $cuddle . "continue {\n\t" .
2633               $self->deparse($cont, 0) . "\n\b}\cK";
2634         }
2635     } else {
2636         return "" if !defined $body;
2637         if (length $init) {
2638             $head = "for ($init; $cond;) ";
2639         }
2640         $cont = "\cK";
2641         $body = $self->deparse($body, 0);
2642     }
2643     $body =~ s/;?$/;\n/;
2644
2645     return $head . "{\n\t" . $body . "\b}" . $cont;
2646 }
2647
2648 sub pp_leaveloop { loop_common(@_, "") }
2649
2650 sub for_loop {
2651     my $self = shift;
2652     my($op, $cx) = @_;
2653     my $init = $self->deparse($op, 1);
2654     return $self->loop_common($op->sibling->first->sibling, $cx, $init);
2655 }
2656
2657 sub pp_leavetry {
2658     my $self = shift;
2659     return "eval {\n\t" . $self->pp_leave(@_) . "\n\b}";
2660 }
2661
2662 BEGIN { eval "sub OP_CONST () {" . opnumber("const") . "}" }
2663 BEGIN { eval "sub OP_STRINGIFY () {" . opnumber("stringify") . "}" }
2664 BEGIN { eval "sub OP_RV2SV () {" . opnumber("rv2sv") . "}" }
2665 BEGIN { eval "sub OP_LIST () {" . opnumber("list") . "}" }
2666
2667 sub pp_null {
2668     my $self = shift;
2669     my($op, $cx) = @_;
2670     if (class($op) eq "OP") {
2671         # old value is lost
2672         return $self->{'ex_const'} if $op->targ == OP_CONST;
2673     } elsif ($op->first->name eq "pushmark") {
2674         return $self->pp_list($op, $cx);
2675     } elsif ($op->first->name eq "enter") {
2676         return $self->pp_leave($op, $cx);
2677     } elsif ($op->targ == OP_STRINGIFY) {
2678         return $self->dquote($op, $cx);
2679     } elsif (!null($op->first->sibling) and
2680              $op->first->sibling->name eq "readline" and
2681              $op->first->sibling->flags & OPf_STACKED) {
2682         return $self->maybe_parens($self->deparse($op->first, 7) . " = "
2683                                    . $self->deparse($op->first->sibling, 7),
2684                                    $cx, 7);
2685     } elsif (!null($op->first->sibling) and
2686              $op->first->sibling->name eq "trans" and
2687              $op->first->sibling->flags & OPf_STACKED) {
2688         return $self->maybe_parens($self->deparse($op->first, 20) . " =~ "
2689                                    . $self->deparse($op->first->sibling, 20),
2690                                    $cx, 20);
2691     } elsif ($op->flags & OPf_SPECIAL && $cx < 1 && !$op->targ) {
2692         return "do {\n\t". $self->deparse($op->first, $cx) ."\n\b};";
2693     } elsif (!null($op->first->sibling) and
2694              $op->first->sibling->name eq "null" and
2695              class($op->first->sibling) eq "UNOP" and
2696              $op->first->sibling->first->flags & OPf_STACKED and
2697              $op->first->sibling->first->name eq "rcatline") {
2698         return $self->maybe_parens($self->deparse($op->first, 18) . " .= "
2699                                    . $self->deparse($op->first->sibling, 18),
2700                                    $cx, 18);
2701     } else {
2702         return $self->deparse($op->first, $cx);
2703     }
2704 }
2705
2706 sub padname {
2707     my $self = shift;
2708     my $targ = shift;
2709     return $self->padname_sv($targ)->PVX;
2710 }
2711
2712 sub padany {
2713     my $self = shift;
2714     my $op = shift;
2715     return substr($self->padname($op->targ), 1); # skip $/@/%
2716 }
2717
2718 sub pp_padsv {
2719     my $self = shift;
2720     my($op, $cx) = @_;
2721     return $self->maybe_my($op, $cx, $self->padname($op->targ));
2722 }
2723
2724 sub pp_padav { pp_padsv(@_) }
2725 sub pp_padhv { pp_padsv(@_) }
2726
2727 my @threadsv_names;
2728
2729 BEGIN {
2730     @threadsv_names = ("_", "1", "2", "3", "4", "5", "6", "7", "8", "9",
2731                        "&", "`", "'", "+", "/", ".", ",", "\\", '"', ";",
2732                        "^", "-", "%", "=", "|", "~", ":", "^A", "^E",
2733                        "!", "@");
2734 }
2735
2736 sub pp_threadsv {
2737     my $self = shift;
2738     my($op, $cx) = @_;
2739     return $self->maybe_local($op, $cx, "\$" .  $threadsv_names[$op->targ]);
2740 }
2741
2742 sub gv_or_padgv {
2743     my $self = shift;
2744     my $op = shift;
2745     if (class($op) eq "PADOP") {
2746         return $self->padval($op->padix);
2747     } else { # class($op) eq "SVOP"
2748         return $op->gv;
2749     }
2750 }
2751
2752 sub pp_gvsv {
2753     my $self = shift;
2754     my($op, $cx) = @_;
2755     my $gv = $self->gv_or_padgv($op);
2756     return $self->maybe_local($op, $cx, $self->stash_variable("\$",
2757                                  $self->gv_name($gv)));
2758 }
2759
2760 sub pp_gv {
2761     my $self = shift;
2762     my($op, $cx) = @_;
2763     my $gv = $self->gv_or_padgv($op);
2764     return $self->gv_name($gv);
2765 }
2766
2767 sub pp_aelemfast {
2768     my $self = shift;
2769     my($op, $cx) = @_;
2770     my $name;
2771     if ($op->flags & OPf_SPECIAL) { # optimised PADAV
2772         $name = $self->padname($op->targ);
2773         $name =~ s/^@/\$/;
2774     }
2775     else {
2776         my $gv = $self->gv_or_padgv($op);
2777         $name = $self->gv_name($gv);
2778         $name = $self->{'curstash'}."::$name"
2779             if $name !~ /::/ && $self->lex_in_scope('@'.$name);
2780         $name = '$' . $name;
2781     }
2782
2783     return $name . "[" .  ($op->private + $self->{'arybase'}) . "]";
2784 }
2785
2786 sub rv2x {
2787     my $self = shift;
2788     my($op, $cx, $type) = @_;
2789
2790     if (class($op) eq 'NULL' || !$op->can("first")) {
2791         carp("Unexpected op in pp_rv2x");
2792         return 'XXX';
2793     }
2794     my $kid = $op->first;
2795     if ($kid->name eq "gv") {
2796         return $self->stash_variable($type, $self->deparse($kid, 0));
2797     } elsif (is_scalar $kid) {
2798         my $str = $self->deparse($kid, 0);
2799         if ($str =~ /^\$([^\w\d])\z/) {
2800             # "$$+" isn't a legal way to write the scalar dereference
2801             # of $+, since the lexer can't tell you aren't trying to
2802             # do something like "$$ + 1" to get one more than your
2803             # PID. Either "${$+}" or "$${+}" are workable
2804             # disambiguations, but if the programmer did the former,
2805             # they'd be in the "else" clause below rather than here.
2806             # It's not clear if this should somehow be unified with
2807             # the code in dq and re_dq that also adds lexer
2808             # disambiguation braces.
2809             $str = '$' . "{$1}"; #'
2810         }
2811         return $type . $str;
2812     } else {
2813         return $type . "{" . $self->deparse($kid, 0) . "}";
2814     }
2815 }
2816
2817 sub pp_rv2sv { maybe_local(@_, rv2x(@_, "\$")) }
2818 sub pp_rv2hv { maybe_local(@_, rv2x(@_, "%")) }
2819 sub pp_rv2gv { maybe_local(@_, rv2x(@_, "*")) }
2820
2821 # skip rv2av
2822 sub pp_av2arylen {
2823     my $self = shift;
2824     my($op, $cx) = @_;
2825     if ($op->first->name eq "padav") {
2826         return $self->maybe_local($op, $cx, '$#' . $self->padany($op->first));
2827     } else {
2828         return $self->maybe_local($op, $cx,
2829                                   $self->rv2x($op->first, $cx, '$#'));
2830     }
2831 }
2832
2833 # skip down to the old, ex-rv2cv
2834 sub pp_rv2cv {
2835     my ($self, $op, $cx) = @_;
2836     if (!null($op->first) && $op->first->name eq 'null' &&
2837         $op->first->targ eq OP_LIST)
2838     {
2839         return $self->rv2x($op->first->first->sibling, $cx, "&")
2840     }
2841     else {
2842         return $self->rv2x($op, $cx, "")
2843     }
2844 }
2845
2846 sub list_const {
2847     my $self = shift;
2848     my($cx, @list) = @_;
2849     my @a = map $self->const($_, 6), @list;
2850     if (@a == 0) {
2851         return "()";
2852     } elsif (@a == 1) {
2853         return $a[0];
2854     } elsif ( @a > 2 and !grep(!/^-?\d+$/, @a)) {
2855         # collapse (-1,0,1,2) into (-1..2)
2856         my ($s, $e) = @a[0,-1];
2857         my $i = $s;
2858         return $self->maybe_parens("$s..$e", $cx, 9)
2859           unless grep $i++ != $_, @a;
2860     }
2861     return $self->maybe_parens(join(", ", @a), $cx, 6);
2862 }
2863
2864 sub pp_rv2av {
2865     my $self = shift;
2866     my($op, $cx) = @_;
2867     my $kid = $op->first;
2868     if ($kid->name eq "const") { # constant list
2869         my $av = $self->const_sv($kid);
2870         return $self->list_const($cx, $av->ARRAY);
2871     } else {
2872         return $self->maybe_local($op, $cx, $self->rv2x($op, $cx, "\@"));
2873     }
2874  }
2875
2876 sub is_subscriptable {
2877     my $op = shift;
2878     if ($op->name =~ /^[ahg]elem/) {
2879         return 1;
2880     } elsif ($op->name eq "entersub") {
2881         my $kid = $op->first;
2882         return 0 unless null $kid->sibling;
2883         $kid = $kid->first;
2884         $kid = $kid->sibling until null $kid->sibling;
2885         return 0 if is_scope($kid);
2886         $kid = $kid->first;
2887         return 0 if $kid->name eq "gv";
2888         return 0 if is_scalar($kid);
2889         return is_subscriptable($kid);
2890     } else {
2891         return 0;
2892     }
2893 }
2894
2895 sub elem {
2896     my $self = shift;
2897     my ($op, $cx, $left, $right, $padname) = @_;
2898     my($array, $idx) = ($op->first, $op->first->sibling);
2899     unless ($array->name eq $padname) { # Maybe this has been fixed
2900         $array = $array->first; # skip rv2av (or ex-rv2av in _53+)
2901     }
2902     if ($array->name eq $padname) {
2903         $array = $self->padany($array);
2904     } elsif (is_scope($array)) { # ${expr}[0]
2905         $array = "{" . $self->deparse($array, 0) . "}";
2906     } elsif ($array->name eq "gv") {
2907         $array = $self->gv_name($self->gv_or_padgv($array));
2908         if ($array !~ /::/) {
2909             my $prefix = ($left eq '[' ? '@' : '%');
2910             $array = $self->{curstash}.'::'.$array
2911                 if $self->lex_in_scope($prefix . $array);
2912         }
2913     } elsif (is_scalar $array) { # $x[0], $$x[0], ...
2914         $array = $self->deparse($array, 24);
2915     } else {
2916         # $x[20][3]{hi} or expr->[20]
2917         my $arrow = is_subscriptable($array) ? "" : "->";
2918         return $self->deparse($array, 24) . $arrow .
2919             $left . $self->deparse($idx, 1) . $right;
2920     }
2921     $idx = $self->deparse($idx, 1);
2922
2923     # Outer parens in an array index will confuse perl
2924     # if we're interpolating in a regular expression, i.e.
2925     # /$x$foo[(-1)]/ is *not* the same as /$x$foo[-1]/
2926     #
2927     # If $self->{parens}, then an initial '(' will
2928     # definitely be paired with a final ')'. If
2929     # !$self->{parens}, the misleading parens won't
2930     # have been added in the first place.
2931     #
2932     # [You might think that we could get "(...)...(...)"
2933     # where the initial and final parens do not match
2934     # each other. But we can't, because the above would
2935     # only happen if there's an infix binop between the
2936     # two pairs of parens, and *that* means that the whole
2937     # expression would be parenthesized as well.]
2938     #
2939     $idx =~ s/^\((.*)\)$/$1/ if $self->{'parens'};
2940
2941     # Hash-element braces will autoquote a bareword inside themselves.
2942     # We need to make sure that C<$hash{warn()}> doesn't come out as
2943     # C<$hash{warn}>, which has a quite different meaning. Currently
2944     # B::Deparse will always quote strings, even if the string was a
2945     # bareword in the original (i.e. the OPpCONST_BARE flag is ignored
2946     # for constant strings.) So we can cheat slightly here - if we see
2947     # a bareword, we know that it is supposed to be a function call.
2948     #
2949     $idx =~ s/^([A-Za-z_]\w*)$/$1()/;
2950
2951     return "\$" . $array . $left . $idx . $right;
2952 }
2953
2954 sub pp_aelem { maybe_local(@_, elem(@_, "[", "]", "padav")) }
2955 sub pp_helem { maybe_local(@_, elem(@_, "{", "}", "padhv")) }
2956
2957 sub pp_gelem {
2958     my $self = shift;
2959     my($op, $cx) = @_;
2960     my($glob, $part) = ($op->first, $op->last);
2961     $glob = $glob->first; # skip rv2gv
2962     $glob = $glob->first if $glob->name eq "rv2gv"; # this one's a bug
2963     my $scope = is_scope($glob);
2964     $glob = $self->deparse($glob, 0);
2965     $part = $self->deparse($part, 1);
2966     return "*" . ($scope ? "{$glob}" : $glob) . "{$part}";
2967 }
2968
2969 sub slice {
2970     my $self = shift;
2971     my ($op, $cx, $left, $right, $regname, $padname) = @_;
2972     my $last;
2973     my(@elems, $kid, $array, $list);
2974     if (class($op) eq "LISTOP") {
2975         $last = $op->last;
2976     } else { # ex-hslice inside delete()
2977         for ($kid = $op->first; !null $kid->sibling; $kid = $kid->sibling) {}
2978         $last = $kid;
2979     }
2980     $array = $last;
2981     $array = $array->first
2982         if $array->name eq $regname or $array->name eq "null";
2983     if (is_scope($array)) {
2984         $array = "{" . $self->deparse($array, 0) . "}";
2985     } elsif ($array->name eq $padname) {
2986         $array = $self->padany($array);
2987     } else {
2988         $array = $self->deparse($array, 24);
2989     }
2990     $kid = $op->first->sibling; # skip pushmark
2991     if ($kid->name eq "list") {
2992         $kid = $kid->first->sibling; # skip list, pushmark
2993         for (; !null $kid; $kid = $kid->sibling) {
2994             push @elems, $self->deparse($kid, 6);
2995         }
2996         $list = join(", ", @elems);
2997     } else {
2998         $list = $self->deparse($kid, 1);
2999     }
3000     return "\@" . $array . $left . $list . $right;
3001 }
3002
3003 sub pp_aslice { maybe_local(@_, slice(@_, "[", "]", "rv2av", "padav")) }
3004 sub pp_hslice { maybe_local(@_, slice(@_, "{", "}", "rv2hv", "padhv")) }
3005
3006 sub pp_lslice {
3007     my $self = shift;
3008     my($op, $cx) = @_;
3009     my $idx = $op->first;
3010     my $list = $op->last;
3011     my(@elems, $kid);
3012     $list = $self->deparse($list, 1);
3013     $idx = $self->deparse($idx, 1);
3014     return "($list)" . "[$idx]";
3015 }
3016
3017 sub want_scalar {
3018     my $op = shift;
3019     return ($op->flags & OPf_WANT) == OPf_WANT_SCALAR;
3020 }
3021
3022 sub want_list {
3023     my $op = shift;
3024     return ($op->flags & OPf_WANT) == OPf_WANT_LIST;
3025 }
3026
3027 sub method {
3028     my $self = shift;
3029     my($op, $cx) = @_;
3030     my $kid = $op->first->sibling; # skip pushmark
3031     my($meth, $obj, @exprs);
3032     if ($kid->name eq "list" and want_list $kid) {
3033         # When an indirect object isn't a bareword but the args are in
3034         # parens, the parens aren't part of the method syntax (the LLAFR
3035         # doesn't apply), but they make a list with OPf_PARENS set that
3036         # doesn't get flattened by the append_elem that adds the method,
3037         # making a (object, arg1, arg2, ...) list where the object
3038         # usually is. This can be distinguished from
3039         # `($obj, $arg1, $arg2)->meth()' (which is legal if $arg2 is an
3040         # object) because in the later the list is in scalar context
3041         # as the left side of -> always is, while in the former
3042         # the list is in list context as method arguments always are.
3043         # (Good thing there aren't method prototypes!)
3044         $meth = $kid->sibling;
3045         $kid = $kid->first->sibling; # skip pushmark
3046         $obj = $kid;
3047         $kid = $kid->sibling;
3048         for (; not null $kid; $kid = $kid->sibling) {
3049             push @exprs, $self->deparse($kid, 6);
3050         }
3051     } else {
3052         $obj = $kid;
3053         $kid = $kid->sibling;
3054         for (; !null ($kid->sibling) && $kid->name ne "method_named";
3055               $kid = $kid->sibling) {
3056             push @exprs, $self->deparse($kid, 6);
3057         }
3058         $meth = $kid;
3059     }
3060     $obj = $self->deparse($obj, 24);
3061     if ($meth->name eq "method_named") {
3062         $meth = $self->const_sv($meth)->PV;
3063     } else {
3064         $meth = $meth->first;
3065         if ($meth->name eq "const") {
3066             # As of 5.005_58, this case is probably obsoleted by the
3067             # method_named case above
3068             $meth = $self->const_sv($meth)->PV; # needs to be bare
3069         } else {
3070             $meth = $self->deparse($meth, 1);
3071         }
3072     }
3073     my $args = join(", ", @exprs);
3074     $kid = $obj . "->" . $meth;
3075     if (length $args) {
3076         return $kid . "(" . $args . ")"; # parens mandatory
3077     } else {
3078         return $kid;
3079     }
3080 }
3081
3082 # returns "&" if the prototype doesn't match the args,
3083 # or ("", $args_after_prototype_demunging) if it does.
3084 sub check_proto {
3085     my $self = shift;
3086     return "&" if $self->{'noproto'};
3087     my($proto, @args) = @_;
3088     my($arg, $real);
3089     my $doneok = 0;
3090     my @reals;
3091     # An unbackslashed @ or % gobbles up the rest of the args
3092     1 while $proto =~ s/(?<!\\)([@%])[^\]]+$/$1/;
3093     while ($proto) {
3094         $proto =~ s/^(\\?[\$\@&%*]|\\\[[\$\@&%*]+\]|;)//;
3095         my $chr = $1;
3096         if ($chr eq "") {
3097             return "&" if @args;
3098         } elsif ($chr eq ";") {
3099             $doneok = 1;
3100         } elsif ($chr eq "@" or $chr eq "%") {
3101             push @reals, map($self->deparse($_, 6), @args);
3102             @args = ();
3103         } else {
3104             $arg = shift @args;
3105             last unless $arg;
3106             if ($chr eq "\$") {
3107                 if (want_scalar $arg) {
3108                     push @reals, $self->deparse($arg, 6);
3109                 } else {
3110                     return "&";
3111                 }
3112             } elsif ($chr eq "&") {
3113                 if ($arg->name =~ /^(s?refgen|undef)$/) {
3114                     push @reals, $self->deparse($arg, 6);
3115                 } else {
3116                     return "&";
3117                 }
3118             } elsif ($chr eq "*") {
3119                 if ($arg->name =~ /^s?refgen$/
3120                     and $arg->first->first->name eq "rv2gv")
3121                   {
3122                       $real = $arg->first->first; # skip refgen, null
3123                       if ($real->first->name eq "gv") {
3124                           push @reals, $self->deparse($real, 6);
3125                       } else {
3126                           push @reals, $self->deparse($real->first, 6);
3127                       }
3128                   } else {
3129                       return "&";
3130                   }
3131             } elsif (substr($chr, 0, 1) eq "\\") {
3132                 $chr =~ tr/\\[]//d;
3133                 if ($arg->name =~ /^s?refgen$/ and
3134                     !null($real = $arg->first) and
3135                     ($chr =~ /\$/ && is_scalar($real->first)
3136                      or ($chr =~ /@/
3137                          && class($real->first->sibling) ne 'NULL'
3138                          && $real->first->sibling->name
3139                          =~ /^(rv2|pad)av$/)
3140                      or ($chr =~ /%/
3141                          && class($real->first->sibling) ne 'NULL'
3142                          && $real->first->sibling->name
3143                          =~ /^(rv2|pad)hv$/)
3144                      #or ($chr =~ /&/ # This doesn't work
3145                      #   && $real->first->name eq "rv2cv")
3146                      or ($chr =~ /\*/
3147                          && $real->first->name eq "rv2gv")))
3148                   {
3149                       push @reals, $self->deparse($real, 6);
3150                   } else {
3151                       return "&";
3152                   }
3153             }
3154        }
3155     }
3156     return "&" if $proto and !$doneok; # too few args and no `;'
3157     return "&" if @args;               # too many args
3158     return ("", join ", ", @reals);
3159 }
3160
3161 sub pp_entersub {
3162     my $self = shift;
3163     my($op, $cx) = @_;
3164     return $self->method($op, $cx) unless null $op->first->sibling;
3165     my $prefix = "";
3166     my $amper = "";
3167     my($kid, @exprs);
3168     if ($op->flags & OPf_SPECIAL && !($op->flags & OPf_MOD)) {
3169         $prefix = "do ";
3170     } elsif ($op->private & OPpENTERSUB_AMPER) {
3171         $amper = "&";
3172     }
3173     $kid = $op->first;
3174     $kid = $kid->first->sibling; # skip ex-list, pushmark
3175     for (; not null $kid->sibling; $kid = $kid->sibling) {
3176         push @exprs, $kid;
3177     }
3178     my $simple = 0;
3179     my $proto = undef;
3180     if (is_scope($kid)) {
3181         $amper = "&";
3182         $kid = "{" . $self->deparse($kid, 0) . "}";
3183     } elsif ($kid->first->name eq "gv") {
3184         my $gv = $self->gv_or_padgv($kid->first);
3185         if (class($gv->CV) ne "SPECIAL") {
3186             $proto = $gv->CV->PV if $gv->CV->FLAGS & SVf_POK;
3187         }
3188         $simple = 1; # only calls of named functions can be prototyped
3189         $kid = $self->deparse($kid, 24);
3190     } elsif (is_scalar ($kid->first) && $kid->first->name ne 'rv2cv') {
3191         $amper = "&";
3192         $kid = $self->deparse($kid, 24);
3193     } else {
3194         $prefix = "";
3195         my $arrow = is_subscriptable($kid->first) ? "" : "->";
3196         $kid = $self->deparse($kid, 24) . $arrow;
3197     }
3198
3199     # Doesn't matter how many prototypes there are, if
3200     # they haven't happened yet!
3201     my $declared;
3202     {
3203         no strict 'refs';
3204         no warnings 'uninitialized';
3205         $declared = exists $self->{'subs_declared'}{$kid}
3206             || (
3207                  defined &{ ${$self->{'curstash'}."::"}{$kid} }
3208                  && !exists
3209                      $self->{'subs_deparsed'}{$self->{'curstash'}."::".$kid}
3210                  && defined prototype $self->{'curstash'}."::".$kid
3211                );
3212         if (!$declared && defined($proto)) {
3213             # Avoid "too early to check prototype" warning
3214             ($amper, $proto) = ('&');
3215         }
3216     }
3217
3218     my $args;
3219     if ($declared and defined $proto and not $amper) {
3220         ($amper, $args) = $self->check_proto($proto, @exprs);
3221         if ($amper eq "&") {
3222             $args = join(", ", map($self->deparse($_, 6), @exprs));
3223         }
3224     } else {
3225         $args = join(", ", map($self->deparse($_, 6), @exprs));
3226     }
3227     if ($prefix or $amper) {
3228         if ($op->flags & OPf_STACKED) {
3229             return $prefix . $amper . $kid . "(" . $args . ")";
3230         } else {
3231             return $prefix . $amper. $kid;
3232         }
3233     } else {
3234         # glob() invocations can be translated into calls of
3235         # CORE::GLOBAL::glob with a second parameter, a number.
3236         # Reverse this.
3237         if ($kid eq "CORE::GLOBAL::glob") {
3238             $kid = "glob";
3239             $args =~ s/\s*,[^,]+$//;
3240         }
3241
3242         # It's a syntax error to call CORE::GLOBAL::foo without a prefix,
3243         # so it must have been translated from a keyword call. Translate
3244         # it back.
3245         $kid =~ s/^CORE::GLOBAL:://;
3246
3247         my $dproto = defined($proto) ? $proto : "undefined";
3248         if (!$declared) {
3249             return "$kid(" . $args . ")";
3250         } elsif ($dproto eq "") {
3251             return $kid;
3252         } elsif ($dproto eq "\$" and is_scalar($exprs[0])) {
3253             # is_scalar is an excessively conservative test here:
3254             # really, we should be comparing to the precedence of the
3255             # top operator of $exprs[0] (ala unop()), but that would
3256             # take some major code restructuring to do right.
3257             return $self->maybe_parens_func($kid, $args, $cx, 16);
3258         } elsif ($dproto ne '$' and defined($proto) || $simple) { #'
3259             return $self->maybe_parens_func($kid, $args, $cx, 5);
3260         } else {
3261             return "$kid(" . $args . ")";
3262         }
3263     }
3264 }
3265
3266 sub pp_enterwrite { unop(@_, "write") }
3267
3268 # escape things that cause interpolation in double quotes,
3269 # but not character escapes
3270 sub uninterp {
3271     my($str) = @_;
3272     $str =~ s/(^|\G|[^\\])((?:\\\\)*)([\$\@]|\\[uUlLQE])/$1$2\\$3/g;
3273     return $str;
3274 }
3275
3276 {
3277 my $bal;
3278 BEGIN {
3279     use re "eval";
3280     # Matches any string which is balanced with respect to {braces}
3281     $bal = qr(
3282       (?:
3283         [^\\{}]
3284       | \\\\
3285       | \\[{}]
3286       | \{(??{$bal})\}
3287       )*
3288     )x;
3289 }
3290
3291 # the same, but treat $|, $), $( and $ at the end of the string differently
3292 sub re_uninterp {
3293     my($str) = @_;
3294
3295     $str =~ s/
3296           ( ^|\G                  # $1
3297           | [^\\]
3298           )
3299
3300           (                       # $2
3301             (?:\\\\)*
3302           )
3303
3304           (                       # $3
3305             (\(\?\??\{$bal\}\))   # $4
3306           | [\$\@]
3307             (?!\||\)|\(|$)
3308           | \\[uUlLQE]
3309           )
3310
3311         /defined($4) && length($4) ? "$1$2$4" : "$1$2\\$3"/xeg;
3312
3313     return $str;
3314 }
3315
3316 # This is for regular expressions with the /x modifier
3317 # We have to leave comments unmangled.
3318 sub re_uninterp_extended {
3319     my($str) = @_;
3320
3321     $str =~ s/
3322           ( ^|\G                  # $1
3323           | [^\\]
3324           )
3325
3326           (                       # $2
3327             (?:\\\\)*
3328           )
3329
3330           (                       # $3
3331             ( \(\?\??\{$bal\}\)   # $4  (skip over (?{}) and (??{}) blocks)
3332             | \#[^\n]*            #     (skip over comments)
3333             )
3334           | [\$\@]
3335             (?!\||\)|\(|$|\s)
3336           | \\[uUlLQE]
3337           )
3338
3339         /defined($4) && length($4) ? "$1$2$4" : "$1$2\\$3"/xeg;
3340
3341     return $str;
3342 }
3343 }
3344
3345 my %unctrl = # portable to to EBCDIC
3346     (
3347      "\c@" => '\c@',    # unused
3348      "\cA" => '\cA',
3349      "\cB" => '\cB',
3350      "\cC" => '\cC',
3351      "\cD" => '\cD',
3352      "\cE" => '\cE',
3353      "\cF" => '\cF',
3354      "\cG" => '\cG',
3355      "\cH" => '\cH',
3356      "\cI" => '\cI',
3357      "\cJ" => '\cJ',
3358      "\cK" => '\cK',
3359      "\cL" => '\cL',
3360      "\cM" => '\cM',
3361      "\cN" => '\cN',
3362      "\cO" => '\cO',
3363      "\cP" => '\cP',
3364      "\cQ" => '\cQ',
3365      "\cR" => '\cR',
3366      "\cS" => '\cS',
3367      "\cT" => '\cT',
3368      "\cU" => '\cU',
3369      "\cV" => '\cV',
3370      "\cW" => '\cW',
3371      "\cX" => '\cX',
3372      "\cY" => '\cY',
3373      "\cZ" => '\cZ',
3374      "\c[" => '\c[',    # unused
3375      "\c\\" => '\c\\',  # unused
3376      "\c]" => '\c]',    # unused
3377      "\c_" => '\c_',    # unused
3378     );
3379
3380 # character escapes, but not delimiters that might need to be escaped
3381 sub escape_str { # ASCII, UTF8
3382     my($str) = @_;
3383     $str =~ s/(.)/ord($1) > 255 ? sprintf("\\x{%x}", ord($1)) : $1/eg;
3384     $str =~ s/\a/\\a/g;
3385 #    $str =~ s/\cH/\\b/g; # \b means something different in a regex
3386     $str =~ s/\t/\\t/g;
3387     $str =~ s/\n/\\n/g;
3388     $str =~ s/\e/\\e/g;
3389     $str =~ s/\f/\\f/g;
3390     $str =~ s/\r/\\r/g;
3391     $str =~ s/([\cA-\cZ])/$unctrl{$1}/ge;
3392     $str =~ s/([[:^print:]])/sprintf("\\%03o", ord($1))/ge;
3393     return $str;
3394 }
3395
3396 # For regexes with the /x modifier.
3397 # Leave whitespace unmangled.
3398 sub escape_extended_re {
3399     my($str) = @_;
3400     $str =~ s/(.)/ord($1) > 255 ? sprintf("\\x{%x}", ord($1)) : $1/eg;
3401     $str =~ s/([[:^print:]])/
3402         ($1 =~ y! \t\n!!) ? $1 : sprintf("\\%03o", ord($1))/ge;
3403     $str =~ s/\n/\n\f/g;
3404     return $str;
3405 }
3406
3407 # Don't do this for regexen
3408 sub unback {
3409     my($str) = @_;
3410     $str =~ s/\\/\\\\/g;
3411     return $str;
3412 }
3413
3414 # Remove backslashes which precede literal control characters,
3415 # to avoid creating ambiguity when we escape the latter.
3416 sub re_unback {
3417     my($str) = @_;
3418
3419     # the insane complexity here is due to the behaviour of "\c\"
3420     $str =~ s/(^|[^\\]|\\c\\)(?<!\\c)\\(\\\\)*(?=[[:^print:]])/$1$2/g;
3421     return $str;
3422 }
3423
3424 sub balanced_delim {
3425     my($str) = @_;
3426     my @str = split //, $str;
3427     my($ar, $open, $close, $fail, $c, $cnt, $last_bs);
3428     for $ar (['[',']'], ['(',')'], ['<','>'], ['{','}']) {
3429         ($open, $close) = @$ar;
3430         $fail = 0; $cnt = 0; $last_bs = 0;
3431         for $c (@str) {
3432             if ($c eq $open) {
3433                 $fail = 1 if $last_bs;
3434                 $cnt++;
3435             } elsif ($c eq $close) {
3436                 $fail = 1 if $last_bs;
3437                 $cnt--;
3438                 if ($cnt < 0) {
3439                     # qq()() isn't ")("
3440                     $fail = 1;
3441                     last;
3442                 }
3443             }
3444             $last_bs = $c eq '\\';
3445         }
3446         $fail = 1 if $cnt != 0;
3447         return ($open, "$open$str$close") if not $fail;
3448     }
3449     return ("", $str);
3450 }
3451
3452 sub single_delim {
3453     my($q, $default, $str) = @_;
3454     return "$default$str$default" if $default and index($str, $default) == -1;
3455     if ($q ne 'qr') {
3456         (my $succeed, $str) = balanced_delim($str);
3457         return "$q$str" if $succeed;
3458     }
3459     for my $delim ('/', '"', '#') {
3460         return "$q$delim" . $str . $delim if index($str, $delim) == -1;
3461     }
3462     if ($default) {
3463         $str =~ s/$default/\\$default/g;
3464         return "$default$str$default";
3465     } else {
3466         $str =~ s[/][\\/]g;
3467         return "$q/$str/";
3468     }
3469 }
3470
3471 my $max_prec;
3472 BEGIN { $max_prec = int(0.999 + 8*length(pack("F", 42))*log(2)/log(10)); }
3473
3474 # Split a floating point number into an integer mantissa and a binary
3475 # exponent. Assumes you've already made sure the number isn't zero or
3476 # some weird infinity or NaN.
3477 sub split_float {
3478     my($f) = @_;
3479     my $exponent = 0;
3480     if ($f == int($f)) {
3481         while ($f % 2 == 0) {
3482             $f /= 2;
3483             $exponent++;
3484         }
3485     } else {
3486         while ($f != int($f)) {
3487             $f *= 2;
3488             $exponent--;
3489         }
3490     }
3491     my $mantissa = sprintf("%.0f", $f);
3492     return ($mantissa, $exponent);
3493 }
3494
3495 sub const {
3496     my $self = shift;
3497     my($sv, $cx) = @_;
3498     if ($self->{'use_dumper'}) {
3499         return $self->const_dumper($sv, $cx);
3500     }
3501     if (class($sv) eq "SPECIAL") {
3502         # sv_undef, sv_yes, sv_no
3503         return ('undef', '1', $self->maybe_parens("!1", $cx, 21))[$$sv-1];
3504     } elsif (class($sv) eq "NULL") {
3505        return 'undef';
3506     }
3507     # convert a version object into the "v1.2.3" string in its V magic
3508     if ($sv->FLAGS & SVs_RMG) {
3509         for (my $mg = $sv->MAGIC; $mg; $mg = $mg->MOREMAGIC) {
3510             return $mg->PTR if $mg->TYPE eq 'V';
3511         }
3512     }
3513
3514     if ($sv->FLAGS & SVf_IOK) {
3515         my $str = $sv->int_value;
3516         $str = $self->maybe_parens($str, $cx, 21) if $str < 0;
3517         return $str;
3518     } elsif ($sv->FLAGS & SVf_NOK) {
3519         my $nv = $sv->NV;
3520         if ($nv == 0) {
3521             if (pack("F", $nv) eq pack("F", 0)) {
3522                 # positive zero
3523                 return "0";
3524             } else {
3525                 # negative zero
3526                 return $self->maybe_parens("-.0", $cx, 21);
3527             }
3528         } elsif (1/$nv == 0) {
3529             if ($nv > 0) {
3530                 # positive infinity
3531                 return $self->maybe_parens("9**9**9", $cx, 22);
3532             } else {
3533                 # negative infinity
3534                 return $self->maybe_parens("-9**9**9", $cx, 21);
3535             }
3536         } elsif ($nv != $nv) {
3537             # NaN
3538             if (pack("F", $nv) eq pack("F", sin(9**9**9))) {
3539                 # the normal kind
3540                 return "sin(9**9**9)";
3541             } elsif (pack("F", $nv) eq pack("F", -sin(9**9**9))) {
3542                 # the inverted kind
3543                 return $self->maybe_parens("-sin(9**9**9)", $cx, 21);
3544             } else {
3545                 # some other kind
3546                 my $hex = unpack("h*", pack("F", $nv));
3547                 return qq'unpack("F", pack("h*", "$hex"))';
3548             }
3549         }
3550         # first, try the default stringification
3551         my $str = "$nv";
3552         if ($str != $nv) {
3553             # failing that, try using more precision
3554             $str = sprintf("%.${max_prec}g", $nv);
3555 #           if (pack("F", $str) ne pack("F", $nv)) {
3556             if ($str != $nv) {
3557                 # not representable in decimal with whatever sprintf()
3558                 # and atof() Perl is using here.
3559                 my($mant, $exp) = split_float($nv);
3560                 return $self->maybe_parens("$mant * 2**$exp", $cx, 19);
3561             }
3562         }
3563         $str = $self->maybe_parens($str, $cx, 21) if $nv < 0;
3564         return $str;
3565     } elsif ($sv->FLAGS & SVf_ROK && $sv->can("RV")) {
3566         my $ref = $sv->RV;
3567         if (class($ref) eq "AV") {
3568             return "[" . $self->list_const(2, $ref->ARRAY) . "]";
3569         } elsif (class($ref) eq "HV") {
3570             my %hash = $ref->ARRAY;
3571             my @elts;
3572             for my $k (sort keys %hash) {
3573                 push @elts, "$k => " . $self->const($hash{$k}, 6);
3574             }
3575             return "{" . join(", ", @elts) . "}";
3576         } elsif (class($ref) eq "CV") {
3577             return "sub " . $self->deparse_sub($ref);
3578         }
3579         if ($ref->FLAGS & SVs_SMG) {
3580             for (my $mg = $ref->MAGIC; $mg; $mg = $mg->MOREMAGIC) {
3581                 if ($mg->TYPE eq 'r') {
3582                     my $re = re_uninterp(escape_str(re_unback($mg->precomp)));
3583                     return single_delim("qr", "", $re);
3584                 }
3585             }
3586         }
3587
3588         return $self->maybe_parens("\\" . $self->const($ref, 20), $cx, 20);
3589     } elsif ($sv->FLAGS & SVf_POK) {
3590         my $str = $sv->PV;
3591         if ($str =~ /[^ -~]/) { # ASCII for non-printing
3592             return single_delim("qq", '"', uninterp escape_str unback $str);
3593         } else {
3594             return single_delim("q", "'", unback $str);
3595         }
3596     } else {
3597         return "undef";
3598     }
3599 }
3600
3601 sub const_dumper {
3602     my $self = shift;
3603     my($sv, $cx) = @_;
3604     my $ref = $sv->object_2svref();
3605     my $dumper = Data::Dumper->new([$$ref], ['$v']);
3606     $dumper->Purity(1)->Terse(1)->Deparse(1)->Indent(0)->Useqq(1)->Sortkeys(1);
3607     my $str = $dumper->Dump();
3608     if ($str =~ /^\$v/) {
3609         return '${my ' . $str . ' \$v}';
3610     } else {
3611         return $str;
3612     }
3613 }
3614
3615 sub const_sv {
3616     my $self = shift;
3617     my $op = shift;
3618     my $sv = $op->sv;
3619     # the constant could be in the pad (under useithreads)
3620     $sv = $self->padval($op->targ) unless $$sv;
3621     return $sv;
3622 }
3623
3624 sub pp_const {
3625     my $self = shift;
3626     my($op, $cx) = @_;
3627     if ($op->private & OPpCONST_ARYBASE) {
3628         return '$[';
3629     }
3630 #    if ($op->private & OPpCONST_BARE) { # trouble with `=>' autoquoting
3631 #       return $self->const_sv($op)->PV;
3632 #    }
3633     my $sv = $self->const_sv($op);
3634     return $self->const($sv, $cx);
3635 }
3636
3637 sub dq {
3638     my $self = shift;
3639     my $op = shift;
3640     my $type = $op->name;
3641     if ($type eq "const") {
3642         return '$[' if $op->private & OPpCONST_ARYBASE;
3643         return uninterp(escape_str(unback($self->const_sv($op)->as_string)));
3644     } elsif ($type eq "concat") {
3645         my $first = $self->dq($op->first);
3646         my $last  = $self->dq($op->last);
3647
3648         # Disambiguate "${foo}bar", "${foo}{bar}", "${foo}[1]", "$foo\::bar"
3649         ($last =~ /^[A-Z\\\^\[\]_?]/ &&
3650             $first =~ s/([\$@])\^$/${1}{^}/)  # "${^}W" etc
3651             || ($last =~ /^[:'{\[\w_]/ && #'
3652                 $first =~ s/([\$@])([A-Za-z_]\w*)$/${1}{$2}/);
3653
3654         return $first . $last;
3655     } elsif ($type eq "uc") {
3656         return '\U' . $self->dq($op->first->sibling) . '\E';
3657     } elsif ($type eq "lc") {
3658         return '\L' . $self->dq($op->first->sibling) . '\E';
3659     } elsif ($type eq "ucfirst") {
3660         return '\u' . $self->dq($op->first->sibling);
3661     } elsif ($type eq "lcfirst") {
3662         return '\l' . $self->dq($op->first->sibling);
3663     } elsif ($type eq "quotemeta") {
3664         return '\Q' . $self->dq($op->first->sibling) . '\E';
3665     } elsif ($type eq "join") {
3666         return $self->deparse($op->last, 26); # was join($", @ary)
3667     } else {
3668         return $self->deparse($op, 26);
3669     }
3670 }
3671
3672 sub pp_backtick {
3673     my $self = shift;
3674     my($op, $cx) = @_;
3675     # skip pushmark
3676     return single_delim("qx", '`', $self->dq($op->first->sibling));
3677 }
3678
3679 sub dquote {
3680     my $self = shift;
3681     my($op, $cx) = @_;
3682     my $kid = $op->first->sibling; # skip ex-stringify, pushmark
3683     return $self->deparse($kid, $cx) if $self->{'unquote'};
3684     $self->maybe_targmy($kid, $cx,
3685                         sub {single_delim("qq", '"', $self->dq($_[1]))});
3686 }
3687
3688 # OP_STRINGIFY is a listop, but it only ever has one arg
3689 sub pp_stringify { maybe_targmy(@_, \&dquote) }
3690
3691 # tr/// and s/// (and tr[][], tr[]//, tr###, etc)
3692 # note that tr(from)/to/ is OK, but not tr/from/(to)
3693 sub double_delim {
3694     my($from, $to) = @_;
3695     my($succeed, $delim);
3696     if ($from !~ m[/] and $to !~ m[/]) {
3697         return "/$from/$to/";
3698     } elsif (($succeed, $from) = balanced_delim($from) and $succeed) {
3699         if (($succeed, $to) = balanced_delim($to) and $succeed) {
3700             return "$from$to";
3701         } else {
3702             for $delim ('/', '"', '#') { # note no `'' -- s''' is special
3703                 return "$from$delim$to$delim" if index($to, $delim) == -1;
3704             }
3705             $to =~ s[/][\\/]g;
3706             return "$from/$to/";
3707         }
3708     } else {
3709         for $delim ('/', '"', '#') { # note no '
3710             return "$delim$from$delim$to$delim"
3711                 if index($to . $from, $delim) == -1;
3712         }
3713         $from =~ s[/][\\/]g;
3714         $to =~ s[/][\\/]g;
3715         return "/$from/$to/";
3716     }
3717 }
3718
3719 # Only used by tr///, so backslashes hyphens
3720 sub pchr { # ASCII
3721     my($n) = @_;
3722     if ($n == ord '\\') {
3723         return '\\\\';
3724     } elsif ($n == ord "-") {
3725         return "\\-";
3726     } elsif ($n >= ord(' ') and $n <= ord('~')) {
3727         return chr($n);
3728     } elsif ($n == ord "\a") {
3729         return '\\a';
3730     } elsif ($n == ord "\b") {
3731         return '\\b';
3732     } elsif ($n == ord "\t") {
3733         return '\\t';
3734     } elsif ($n == ord "\n") {
3735         return '\\n';
3736     } elsif ($n == ord "\e") {
3737         return '\\e';
3738     } elsif ($n == ord "\f") {
3739         return '\\f';
3740     } elsif ($n == ord "\r") {
3741         return '\\r';
3742     } elsif ($n >= ord("\cA") and $n <= ord("\cZ")) {
3743         return '\\c' . chr(ord("@") + $n);
3744     } else {
3745 #       return '\x' . sprintf("%02x", $n);
3746         return '\\' . sprintf("%03o", $n);
3747     }
3748 }
3749
3750 sub collapse {
3751     my(@chars) = @_;
3752     my($str, $c, $tr) = ("");
3753     for ($c = 0; $c < @chars; $c++) {
3754         $tr = $chars[$c];
3755         $str .= pchr($tr);
3756         if ($c <= $#chars - 2 and $chars[$c + 1] == $tr + 1 and
3757             $chars[$c + 2] == $tr + 2)
3758         {
3759             for (; $c <= $#chars-1 and $chars[$c + 1] == $chars[$c] + 1; $c++)
3760               {}
3761             $str .= "-";
3762             $str .= pchr($chars[$c]);
3763         }
3764     }
3765     return $str;
3766 }
3767
3768 sub tr_decode_byte {
3769     my($table, $flags) = @_;
3770     my(@table) = unpack("s*", $table);
3771     splice @table, 0x100, 1;   # Number of subsequent elements
3772     my($c, $tr, @from, @to, @delfrom, $delhyphen);
3773     if ($table[ord "-"] != -1 and
3774         $table[ord("-") - 1] == -1 || $table[ord("-") + 1] == -1)
3775     {
3776         $tr = $table[ord "-"];
3777         $table[ord "-"] = -1;
3778         if ($tr >= 0) {
3779             @from = ord("-");
3780             @to = $tr;
3781         } else { # -2 ==> delete
3782             $delhyphen = 1;
3783         }
3784     }
3785     for ($c = 0; $c < @table; $c++) {
3786         $tr = $table[$c];
3787         if ($tr >= 0) {
3788             push @from, $c; push @to, $tr;
3789         } elsif ($tr == -2) {
3790             push @delfrom, $c;
3791         }
3792     }
3793     @from = (@from, @delfrom);
3794     if ($flags & OPpTRANS_COMPLEMENT) {
3795         my @newfrom = ();
3796         my %from;
3797         @from{@from} = (1) x @from;
3798         for ($c = 0; $c < 256; $c++) {
3799             push @newfrom, $c unless $from{$c};
3800         }
3801         @from = @newfrom;
3802     }
3803     unless ($flags & OPpTRANS_DELETE || !@to) {
3804         pop @to while $#to and $to[$#to] == $to[$#to -1];
3805     }
3806     my($from, $to);
3807     $from = collapse(@from);
3808     $to = collapse(@to);
3809     $from .= "-" if $delhyphen;
3810     return ($from, $to);
3811 }
3812
3813 sub tr_chr {
3814     my $x = shift;
3815     if ($x == ord "-") {
3816         return "\\-";
3817     } elsif ($x == ord "\\") {
3818         return "\\\\";
3819     } else {
3820         return chr $x;
3821     }
3822 }
3823
3824 # XXX This doesn't yet handle all cases correctly either
3825
3826 sub tr_decode_utf8 {
3827     my($swash_hv, $flags) = @_;
3828     my %swash = $swash_hv->ARRAY;
3829     my $final = undef;
3830     $final = $swash{'FINAL'}->IV if exists $swash{'FINAL'};
3831     my $none = $swash{"NONE"}->IV;
3832     my $extra = $none + 1;
3833     my(@from, @delfrom, @to);
3834     my $line;
3835     foreach $line (split /\n/, $swash{'LIST'}->PV) {
3836         my($min, $max, $result) = split(/\t/, $line);
3837         $min = hex $min;
3838         if (length $max) {
3839             $max = hex $max;
3840         } else {
3841             $max = $min;
3842         }
3843         $result = hex $result;
3844         if ($result == $extra) {
3845             push @delfrom, [$min, $max];
3846         } else {
3847             push @from, [$min, $max];
3848             push @to, [$result, $result + $max - $min];
3849         }
3850     }
3851     for my $i (0 .. $#from) {
3852         if ($from[$i][0] == ord '-') {
3853             unshift @from, splice(@from, $i, 1);
3854             unshift @to, splice(@to, $i, 1);
3855             last;
3856         } elsif ($from[$i][1] == ord '-') {
3857             $from[$i][1]--;
3858             $to[$i][1]--;
3859             unshift @from, ord '-';
3860             unshift @to, ord '-';
3861             last;
3862         }
3863     }
3864     for my $i (0 .. $#delfrom) {
3865         if ($delfrom[$i][0] == ord '-') {
3866             push @delfrom, splice(@delfrom, $i, 1);
3867             last;
3868         } elsif ($delfrom[$i][1] == ord '-') {
3869             $delfrom[$i][1]--;
3870             push @delfrom, ord '-';
3871             last;
3872         }
3873     }
3874     if (defined $final and $to[$#to][1] != $final) {
3875         push @to, [$final, $final];
3876     }
3877     push @from, @delfrom;
3878     if ($flags & OPpTRANS_COMPLEMENT) {
3879         my @newfrom;
3880         my $next = 0;
3881         for my $i (0 .. $#from) {
3882             push @newfrom, [$next, $from[$i][0] - 1];
3883             $next = $from[$i][1] + 1;
3884         }
3885         @from = ();
3886         for my $range (@newfrom) {
3887             if ($range->[0] <= $range->[1]) {
3888                 push @from, $range;
3889             }
3890         }
3891     }
3892     my($from, $to, $diff);
3893     for my $chunk (@from) {
3894         $diff = $chunk->[1] - $chunk->[0];
3895         if ($diff > 1) {
3896             $from .= tr_chr($chunk->[0]) . "-" . tr_chr($chunk->[1]);
3897         } elsif ($diff == 1) {
3898             $from .= tr_chr($chunk->[0]) . tr_chr($chunk->[1]);
3899         } else {
3900             $from .= tr_chr($chunk->[0]);
3901         }
3902     }
3903     for my $chunk (@to) {
3904         $diff = $chunk->[1] - $chunk->[0];
3905         if ($diff > 1) {
3906             $to .= tr_chr($chunk->[0]) . "-" . tr_chr($chunk->[1]);
3907         } elsif ($diff == 1) {
3908             $to .= tr_chr($chunk->[0]) . tr_chr($chunk->[1]);
3909         } else {
3910             $to .= tr_chr($chunk->[0]);
3911         }
3912     }
3913     #$final = sprintf("%04x", $final) if defined $final;
3914     #$none = sprintf("%04x", $none) if defined $none;
3915     #$extra = sprintf("%04x", $extra) if defined $extra;
3916     #print STDERR "final: $final\n none: $none\nextra: $extra\n";
3917     #print STDERR $swash{'LIST'}->PV;
3918     return (escape_str($from), escape_str($to));
3919 }
3920
3921 sub pp_trans {
3922     my $self = shift;
3923     my($op, $cx) = @_;
3924     my($from, $to);
3925     if (class($op) eq "PVOP") {
3926         ($from, $to) = tr_decode_byte($op->pv, $op->private);
3927     } else { # class($op) eq "SVOP"
3928         ($from, $to) = tr_decode_utf8($op->sv->RV, $op->private);
3929     }
3930     my $flags = "";
3931     $flags .= "c" if $op->private & OPpTRANS_COMPLEMENT;
3932     $flags .= "d" if $op->private & OPpTRANS_DELETE;
3933     $to = "" if $from eq $to and $flags eq "";
3934     $flags .= "s" if $op->private & OPpTRANS_SQUASH;
3935     return "tr" . double_delim($from, $to) . $flags;
3936 }
3937
3938 # Like dq(), but different
3939 sub re_dq {
3940     my $self = shift;
3941     my ($op, $extended) = @_;
3942
3943     my $type = $op->name;
3944     if ($type eq "const") {
3945         return '$[' if $op->private & OPpCONST_ARYBASE;
3946         my $unbacked = re_unback($self->const_sv($op)->as_string);
3947         return re_uninterp_extended(escape_extended_re($unbacked))
3948             if $extended;
3949         return re_uninterp(escape_str($unbacked));
3950     } elsif ($type eq "concat") {
3951         my $first = $self->re_dq($op->first, $extended);
3952         my $last  = $self->re_dq($op->last,  $extended);
3953
3954         # Disambiguate "${foo}bar", "${foo}{bar}", "${foo}[1]"
3955         ($last =~ /^[A-Z\\\^\[\]_?]/ &&
3956             $first =~ s/([\$@])\^$/${1}{^}/)  # "${^}W" etc
3957             || ($last =~ /^[{\[\w_]/ &&
3958                 $first =~ s/([\$@])([A-Za-z_]\w*)$/${1}{$2}/);
3959
3960         return $first . $last;
3961     } elsif ($type eq "uc") {
3962         return '\U' . $self->re_dq($op->first->sibling, $extended) . '\E';
3963     } elsif ($type eq "lc") {
3964         return '\L' . $self->re_dq($op->first->sibling, $extended) . '\E';
3965     } elsif ($type eq "ucfirst") {
3966         return '\u' . $self->re_dq($op->first->sibling, $extended);
3967     } elsif ($type eq "lcfirst") {
3968         return '\l' . $self->re_dq($op->first->sibling, $extended);
3969     } elsif ($type eq "quotemeta") {
3970         return '\Q' . $self->re_dq($op->first->sibling, $extended) . '\E';
3971     } elsif ($type eq "join") {
3972         return $self->deparse($op->last, 26); # was join($", @ary)
3973     } else {
3974         return $self->deparse($op, 26);
3975     }
3976 }
3977
3978 sub pure_string {
3979     my ($self, $op) = @_;
3980     return 0 if null $op;
3981     my $type = $op->name;
3982
3983     if ($type eq 'const') {
3984         return 1;
3985     }
3986     elsif ($type =~ /^[ul]c(first)?$/ || $type eq 'quotemeta') {
3987         return $self->pure_string($op->first->sibling);
3988     }
3989     elsif ($type eq 'join') {
3990         my $join_op = $op->first->sibling;  # Skip pushmark
3991         return 0 unless $join_op->name eq 'null' && $join_op->targ eq OP_RV2SV;
3992
3993         my $gvop = $join_op->first;
3994         return 0 unless $gvop->name eq 'gvsv';
3995         return 0 unless '"' eq $self->gv_name($self->gv_or_padgv($gvop));
3996
3997         return 0 unless ${$join_op->sibling} eq ${$op->last};
3998         return 0 unless $op->last->name =~ /^(rv2|pad)av$/;
3999     }
4000     elsif ($type eq 'concat') {
4001         return $self->pure_string($op->first)
4002             && $self->pure_string($op->last);
4003     }
4004     elsif (is_scalar($op) || $type =~ /^[ah]elem$/) {
4005         return 1;
4006     }
4007     elsif ($type eq "null" and $op->can('first') and not null $op->first and
4008            $op->first->name eq "null" and $op->first->can('first')
4009            and not null $op->first->first and
4010            $op->first->first->name eq "aelemfast") {
4011         return 1;
4012     }
4013     else {
4014         return 0;
4015     }
4016
4017     return 1;
4018 }
4019
4020 sub regcomp {
4021     my $self = shift;
4022     my($op, $cx, $extended) = @_;
4023     my $kid = $op->first;
4024     $kid = $kid->first if $kid->name eq "regcmaybe";
4025     $kid = $kid->first if $kid->name eq "regcreset";
4026     if ($kid->name eq "null" and !null($kid->first)
4027         and $kid->first->name eq 'pushmark')
4028     {
4029         my $str = '';
4030         $kid = $kid->first->sibling;
4031         while (!null($kid)) {
4032             $str .= $self->re_dq($kid, $extended);
4033             $kid = $kid->sibling;
4034         }
4035         return $str, 1;
4036     }
4037
4038     return ($self->re_dq($kid, $extended), 1) if $self->pure_string($kid);
4039     return ($self->deparse($kid, $cx), 0);
4040 }
4041
4042 sub pp_regcomp {
4043     my ($self, $op, $cx) = @_;
4044     return (($self->regcomp($op, $cx, 0))[0]);
4045 }
4046
4047 # osmic acid -- see osmium tetroxide
4048
4049 my %matchwords;
4050 map($matchwords{join "", sort split //, $_} = $_, 'cig', 'cog', 'cos', 'cogs',
4051     'cox', 'go', 'is', 'ism', 'iso', 'mig', 'mix', 'osmic', 'ox', 'sic',
4052     'sig', 'six', 'smog', 'so', 'soc', 'sog', 'xi');
4053
4054 sub matchop {
4055     my $self = shift;
4056     my($op, $cx, $name, $delim) = @_;
4057     my $kid = $op->first;
4058     my ($binop, $var, $re) = ("", "", "");
4059     if ($op->flags & OPf_STACKED) {
4060         $binop = 1;
4061         $var = $self->deparse($kid, 20);
4062         $kid = $kid->sibling;
4063     }
4064     my $quote = 1;
4065     my $extended = ($op->pmflags & PMf_EXTENDED);
4066     if (null $kid) {
4067         my $unbacked = re_unback($op->precomp);
4068         if ($extended) {
4069             $re = re_uninterp_extended(escape_extended_re($unbacked));
4070         } else {
4071             $re = re_uninterp(escape_str(re_unback($op->precomp)));
4072         }
4073     } elsif ($kid->name ne 'regcomp') {
4074         carp("found ".$kid->name." where regcomp expected");
4075     } else {
4076         ($re, $quote) = $self->regcomp($kid, 21, $extended);
4077     }
4078     my $flags = "";
4079     $flags .= "c" if $op->pmflags & PMf_CONTINUE;
4080     $flags .= "g" if $op->pmflags & PMf_GLOBAL;
4081     $flags .= "i" if $op->pmflags & PMf_FOLD;
4082     $flags .= "m" if $op->pmflags & PMf_MULTILINE;
4083     $flags .= "o" if $op->pmflags & PMf_KEEP;
4084     $flags .= "s" if $op->pmflags & PMf_SINGLELINE;
4085     $flags .= "x" if $op->pmflags & PMf_EXTENDED;
4086     $flags = $matchwords{$flags} if $matchwords{$flags};
4087     if ($op->pmflags & PMf_ONCE) { # only one kind of delimiter works here
4088         $re =~ s/\?/\\?/g;
4089         $re = "?$re?";
4090     } elsif ($quote) {
4091         $re = single_delim($name, $delim, $re);
4092     }
4093     $re = $re . $flags if $quote;
4094     if ($binop) {
4095         return $self->maybe_parens("$var =~ $re", $cx, 20);
4096     } else {
4097         return $re;
4098     }
4099 }
4100
4101 sub pp_match { matchop(@_, "m", "/") }
4102 sub pp_pushre { matchop(@_, "m", "/") }
4103 sub pp_qr { matchop(@_, "qr", "") }
4104
4105 sub pp_split {
4106     my $self = shift;
4107     my($op, $cx) = @_;
4108     my($kid, @exprs, $ary, $expr);
4109     $kid = $op->first;
4110
4111     # For our kid (an OP_PUSHRE), pmreplroot is never actually the
4112     # root of a replacement; it's either empty, or abused to point to
4113     # the GV for an array we split into (an optimization to save
4114     # assignment overhead). Depending on whether we're using ithreads,
4115     # this OP* holds either a GV* or a PADOFFSET. Luckily, B.xs
4116     # figures out for us which it is.
4117     my $replroot = $kid->pmreplroot;
4118     my $gv = 0;
4119     if (ref($replroot) eq "B::GV") {
4120         $gv = $replroot;
4121     } elsif (!ref($replroot) and $replroot > 0) {
4122         $gv = $self->padval($replroot);
4123     }
4124     $ary = $self->stash_variable('@', $self->gv_name($gv)) if $gv;
4125
4126     for (; !null($kid); $kid = $kid->sibling) {
4127         push @exprs, $self->deparse($kid, 6);
4128     }
4129
4130     # handle special case of split(), and split(' ') that compiles to /\s+/
4131     $kid = $op->first;
4132     if ($kid->flags & OPf_SPECIAL and $kid->pmflags & PMf_SKIPWHITE) {
4133         $exprs[0] = "' '";
4134     }
4135
4136     $expr = "split(" . join(", ", @exprs) . ")";
4137     if ($ary) {
4138         return $self->maybe_parens("$ary = $expr", $cx, 7);
4139     } else {
4140         return $expr;
4141     }
4142 }
4143
4144 # oxime -- any of various compounds obtained chiefly by the action of
4145 # hydroxylamine on aldehydes and ketones and characterized by the
4146 # bivalent grouping C=NOH [Webster's Tenth]
4147
4148 my %substwords;
4149 map($substwords{join "", sort split //, $_} = $_, 'ego', 'egoism', 'em',
4150     'es', 'ex', 'exes', 'gee', 'go', 'goes', 'ie', 'ism', 'iso', 'me',
4151     'meese', 'meso', 'mig', 'mix', 'os', 'ox', 'oxime', 'see', 'seem',
4152     'seg', 'sex', 'sig', 'six', 'smog', 'sog', 'some', 'xi');
4153
4154 sub pp_subst {
4155     my $self = shift;
4156     my($op, $cx) = @_;
4157     my $kid = $op->first;
4158     my($binop, $var, $re, $repl) = ("", "", "", "");
4159     if ($op->flags & OPf_STACKED) {
4160         $binop = 1;
4161         $var = $self->deparse($kid, 20);
4162         $kid = $kid->sibling;
4163     }
4164     my $flags = "";
4165     if (null($op->pmreplroot)) {
4166         $repl = $self->dq($kid);
4167         $kid = $kid->sibling;
4168     } else {
4169         $repl = $op->pmreplroot->first; # skip substcont
4170         while ($repl->name eq "entereval") {
4171             $repl = $repl->first;
4172             $flags .= "e";
4173         }
4174         if ($op->pmflags & PMf_EVAL) {
4175             $repl = $self->deparse($repl->first, 0);
4176         } else {
4177             $repl = $self->dq($repl);
4178         }
4179     }
4180     my $extended = ($op->pmflags & PMf_EXTENDED);
4181     if (null $kid) {
4182         my $unbacked = re_unback($op->precomp);
4183         if ($extended) {
4184             $re = re_uninterp_extended(escape_extended_re($unbacked));
4185         }
4186         else {
4187             $re = re_uninterp(escape_str($unbacked));
4188         }
4189     } else {
4190         ($re) = $self->regcomp($kid, 1, $extended);
4191     }
4192     $flags .= "e" if $op->pmflags & PMf_EVAL;
4193     $flags .= "g" if $op->pmflags & PMf_GLOBAL;
4194     $flags .= "i" if $op->pmflags & PMf_FOLD;
4195     $flags .= "m" if $op->pmflags & PMf_MULTILINE;
4196     $flags .= "o" if $op->pmflags & PMf_KEEP;
4197     $flags .= "s" if $op->pmflags & PMf_SINGLELINE;
4198     $flags .= "x" if $extended;
4199     $flags = $substwords{$flags} if $substwords{$flags};
4200     if ($binop) {
4201         return $self->maybe_parens("$var =~ s"
4202                                    . double_delim($re, $repl) . $flags,
4203                                    $cx, 20);
4204     } else {
4205         return "s". double_delim($re, $repl) . $flags;
4206     }
4207 }
4208
4209 1;
4210 __END__
4211
4212 =head1 NAME
4213
4214 B::Deparse - Perl compiler backend to produce perl code
4215
4216 =head1 SYNOPSIS
4217
4218 B<perl> B<-MO=Deparse>[B<,-d>][B<,-f>I<FILE>][B<,-p>][B<,-q>][B<,-l>]
4219         [B<,-s>I<LETTERS>][B<,-x>I<LEVEL>] I<prog.pl>
4220
4221 =head1 DESCRIPTION
4222
4223 B::Deparse is a backend module for the Perl compiler that generates
4224 perl source code, based on the internal compiled structure that perl
4225 itself creates after parsing a program. The output of B::Deparse won't
4226 be exactly the same as the original source, since perl doesn't keep
4227 track of comments or whitespace, and there isn't a one-to-one
4228 correspondence between perl's syntactical constructions and their
4229 compiled form, but it will often be close. When you use the B<-p>
4230 option, the output also includes parentheses even when they are not
4231 required by precedence, which can make it easy to see if perl is
4232 parsing your expressions the way you intended.
4233
4234 While B::Deparse goes to some lengths to try to figure out what your
4235 original program was doing, some parts of the language can still trip
4236 it up; it still fails even on some parts of Perl's own test suite. If
4237 you encounter a failure other than the most common ones described in
4238 the BUGS section below, you can help contribute to B::Deparse's
4239 ongoing development by submitting a bug report with a small
4240 example.
4241
4242 =head1 OPTIONS
4243
4244 As with all compiler backend options, these must follow directly after
4245 the '-MO=Deparse', separated by a comma but not any white space.
4246
4247 =over 4
4248
4249 =item B<-d>
4250
4251 Output data values (when they appear as constants) using Data::Dumper.
4252 Without this option, B::Deparse will use some simple routines of its
4253 own for the same purpose. Currently, Data::Dumper is better for some
4254 kinds of data (such as complex structures with sharing and
4255 self-reference) while the built-in routines are better for others
4256 (such as odd floating-point values).
4257
4258 =item B<-f>I<FILE>
4259
4260 Normally, B::Deparse deparses the main code of a program, and all the subs
4261 defined in the same file. To include subs defined in other files, pass the
4262 B<-f> option with the filename. You can pass the B<-f> option several times, to
4263 include more than one secondary file.  (Most of the time you don't want to
4264 use it at all.)  You can also use this option to include subs which are
4265 defined in the scope of a B<#line> directive with two parameters.
4266
4267 =item B<-l>
4268
4269 Add '#line' declarations to the output based on the line and file
4270 locations of the original code.
4271
4272 =item B<-p>
4273
4274 Print extra parentheses. Without this option, B::Deparse includes
4275 parentheses in its output only when they are needed, based on the
4276 structure of your program. With B<-p>, it uses parentheses (almost)
4277 whenever they would be legal. This can be useful if you are used to
4278 LISP, or if you want to see how perl parses your input. If you say
4279
4280     if ($var & 0x7f == 65) {print "Gimme an A!"}
4281     print ($which ? $a : $b), "\n";
4282     $name = $ENV{USER} or "Bob";
4283
4284 C<B::Deparse,-p> will print
4285
4286     if (($var & 0)) {
4287         print('Gimme an A!')
4288     };
4289     (print(($which ? $a : $b)), '???');
4290     (($name = $ENV{'USER'}) or '???')
4291
4292 which probably isn't what you intended (the C<'???'> is a sign that
4293 perl optimized away a constant value).
4294
4295 =item B<-P>
4296
4297 Disable prototype checking. With this option, all function calls are
4298 deparsed as if no prototype was defined for them. In other words,
4299
4300     perl -MO=Deparse,-P -e 'sub foo (\@) { 1 } foo @x'
4301
4302 will print
4303
4304     sub foo (\@) {
4305         1;
4306     }
4307     &foo(\@x);
4308
4309 making clear how the parameters are actually passed to C<foo>.
4310
4311 =item B<-q>
4312
4313 Expand double-quoted strings into the corresponding combinations of
4314 concatenation, uc, ucfirst, lc, lcfirst, quotemeta, and join. For
4315 instance, print
4316
4317     print "Hello, $world, @ladies, \u$gentlemen\E, \u\L$me!";
4318
4319 as
4320
4321     print 'Hello, ' . $world . ', ' . join($", @ladies) . ', '
4322           . ucfirst($gentlemen) . ', ' . ucfirst(lc $me . '!');
4323
4324 Note that the expanded form represents the way perl handles such
4325 constructions internally -- this option actually turns off the reverse
4326 translation that B::Deparse usually does. On the other hand, note that
4327 C<$x = "$y"> is not the same as C<$x = $y>: the former makes the value
4328 of $y into a string before doing the assignment.
4329
4330 =item B<-s>I<LETTERS>
4331
4332 Tweak the style of B::Deparse's output. The letters should follow
4333 directly after the 's', with no space or punctuation. The following
4334 options are available:
4335
4336 =over 4
4337
4338 =item B<C>
4339
4340 Cuddle C<elsif>, C<else>, and C<continue> blocks. For example, print
4341
4342     if (...) {
4343          ...
4344     } else {
4345          ...
4346     }
4347
4348 instead of
4349
4350     if (...) {
4351          ...
4352     }
4353     else {
4354          ...
4355     }
4356
4357 The default is not to cuddle.
4358
4359 =item B<i>I<NUMBER>
4360
4361 Indent lines by multiples of I<NUMBER> columns. The default is 4 columns.
4362
4363 =item B<T>
4364
4365 Use tabs for each 8 columns of indent. The default is to use only spaces.
4366 For instance, if the style options are B<-si4T>, a line that's indented
4367 3 times will be preceded by one tab and four spaces; if the options were
4368 B<-si8T>, the same line would be preceded by three tabs.
4369
4370 =item B<v>I<STRING>B<.>
4371
4372 Print I<STRING> for the value of a constant that can't be determined
4373 because it was optimized away (mnemonic: this happens when a constant
4374 is used in B<v>oid context). The end of the string is marked by a period.
4375 The string should be a valid perl expression, generally a constant.
4376 Note that unless it's a number, it probably needs to be quoted, and on
4377 a command line quotes need to be protected from the shell. Some
4378 conventional values include 0, 1, 42, '', 'foo', and
4379 'Useless use of constant omitted' (which may need to be
4380 B<-sv"'Useless use of constant omitted'.">
4381 or something similar depending on your shell). The default is '???'.
4382 If you're using B::Deparse on a module or other file that's require'd,
4383 you shouldn't use a value that evaluates to false, since the customary
4384 true constant at the end of a module will be in void context when the
4385 file is compiled as a main program.
4386
4387 =back
4388
4389 =item B<-x>I<LEVEL>
4390
4391 Expand conventional syntax constructions into equivalent ones that expose
4392 their internal operation. I<LEVEL> should be a digit, with higher values
4393 meaning more expansion. As with B<-q>, this actually involves turning off
4394 special cases in B::Deparse's normal operations.
4395
4396 If I<LEVEL> is at least 3, C<for> loops will be translated into equivalent
4397 while loops with continue blocks; for instance
4398
4399     for ($i = 0; $i < 10; ++$i) {
4400         print $i;
4401     }
4402
4403 turns into
4404
4405     $i = 0;
4406     while ($i < 10) {
4407         print $i;
4408     } continue {
4409         ++$i
4410     }
4411
4412 Note that in a few cases this translation can't be perfectly carried back
4413 into the source code -- if the loop's initializer declares a my variable,
4414 for instance, it won't have the correct scope outside of the loop.
4415
4416 If I<LEVEL> is at least 5, C<use> declarations will be translated into
4417 C<BEGIN> blocks containing calls to C<require> and C<import>; for
4418 instance,
4419
4420     use strict 'refs';
4421
4422 turns into
4423
4424     sub BEGIN {
4425         require strict;
4426         do {
4427             'strict'->import('refs')
4428         };
4429     }
4430
4431 If I<LEVEL> is at least 7, C<if> statements will be translated into
4432 equivalent expressions using C<&&>, C<?:> and C<do {}>; for instance
4433
4434     print 'hi' if $nice;
4435     if ($nice) {
4436         print 'hi';
4437     }
4438     if ($nice) {
4439         print 'hi';
4440     } else {
4441         print 'bye';
4442     }
4443
4444 turns into
4445
4446     $nice and print 'hi';
4447     $nice and do { print 'hi' };
4448     $nice ? do { print 'hi' } : do { print 'bye' };
4449
4450 Long sequences of elsifs will turn into nested ternary operators, which
4451 B::Deparse doesn't know how to indent nicely.
4452
4453 =back
4454
4455 =head1 USING B::Deparse AS A MODULE
4456
4457 =head2 Synopsis
4458
4459     use B::Deparse;
4460     $deparse = B::Deparse->new("-p", "-sC");
4461     $body = $deparse->coderef2text(\&func);
4462     eval "sub func $body"; # the inverse operation
4463
4464 =head2 Description
4465
4466 B::Deparse can also be used on a sub-by-sub basis from other perl
4467 programs.
4468
4469 =head2 new
4470
4471     $deparse = B::Deparse->new(OPTIONS)
4472
4473 Create an object to store the state of a deparsing operation and any
4474 options. The options are the same as those that can be given on the
4475 command line (see L</OPTIONS>); options that are separated by commas
4476 after B<-MO=Deparse> should be given as separate strings. Some
4477 options, like B<-u>, don't make sense for a single subroutine, so
4478 don't pass them.
4479
4480 =head2 ambient_pragmas
4481
4482     $deparse->ambient_pragmas(strict => 'all', '$[' => $[);
4483
4484 The compilation of a subroutine can be affected by a few compiler
4485 directives, B<pragmas>. These are:
4486
4487 =over 4
4488
4489 =item *
4490
4491 use strict;
4492
4493 =item *
4494
4495 use warnings;
4496
4497 =item *
4498
4499 Assigning to the special variable $[
4500
4501 =item *
4502
4503 use integer;
4504
4505 =item *
4506
4507 use bytes;
4508
4509 =item *
4510
4511 use utf8;
4512
4513 =item *
4514
4515 use re;
4516
4517 =back
4518
4519 Ordinarily, if you use B::Deparse on a subroutine which has
4520 been compiled in the presence of one or more of these pragmas,
4521 the output will include statements to turn on the appropriate
4522 directives. So if you then compile the code returned by coderef2text,
4523 it will behave the same way as the subroutine which you deparsed.
4524
4525 However, you may know that you intend to use the results in a
4526 particular context, where some pragmas are already in scope. In
4527 this case, you use the B<ambient_pragmas> method to describe the
4528 assumptions you wish to make.
4529
4530 Not all of the options currently have any useful effect. See
4531 L</BUGS> for more details.
4532
4533 The parameters it accepts are:
4534
4535 =over 4
4536
4537 =item strict
4538
4539 Takes a string, possibly containing several values separated
4540 by whitespace. The special values "all" and "none" mean what you'd
4541 expect.
4542
4543     $deparse->ambient_pragmas(strict => 'subs refs');
4544
4545 =item $[
4546
4547 Takes a number, the value of the array base $[.
4548
4549 =item bytes
4550
4551 =item utf8
4552
4553 =item integer
4554
4555 If the value is true, then the appropriate pragma is assumed to
4556 be in the ambient scope, otherwise not.
4557
4558 =item re
4559
4560 Takes a string, possibly containing a whitespace-separated list of
4561 values. The values "all" and "none" are special. It's also permissible
4562 to pass an array reference here.
4563
4564     $deparser->ambient_pragmas(re => 'eval');
4565
4566
4567 =item warnings
4568
4569 Takes a string, possibly containing a whitespace-separated list of
4570 values. The values "all" and "none" are special, again. It's also
4571 permissible to pass an array reference here.
4572
4573     $deparser->ambient_pragmas(warnings => [qw[void io]]);
4574
4575 If one of the values is the string "FATAL", then all the warnings
4576 in that list will be considered fatal, just as with the B<warnings>
4577 pragma itself. Should you need to specify that some warnings are
4578 fatal, and others are merely enabled, you can pass the B<warnings>
4579 parameter twice:
4580
4581     $deparser->ambient_pragmas(
4582         warnings => 'all',
4583         warnings => [FATAL => qw/void io/],
4584     );
4585
4586 See L<perllexwarn> for more information about lexical warnings.
4587
4588 =item hint_bits
4589
4590 =item warning_bits
4591
4592 These two parameters are used to specify the ambient pragmas in
4593 the format used by the special variables $^H and ${^WARNING_BITS}.
4594
4595 They exist principally so that you can write code like:
4596
4597     { my ($hint_bits, $warning_bits);
4598     BEGIN {($hint_bits, $warning_bits) = ($^H, ${^WARNING_BITS})}
4599     $deparser->ambient_pragmas (
4600         hint_bits    => $hint_bits,
4601         warning_bits => $warning_bits,
4602         '$['         => 0 + $[
4603     ); }
4604
4605 which specifies that the ambient pragmas are exactly those which
4606 are in scope at the point of calling.
4607
4608 =back
4609
4610 =head2 coderef2text
4611
4612     $body = $deparse->coderef2text(\&func)
4613     $body = $deparse->coderef2text(sub ($$) { ... })
4614
4615 Return source code for the body of a subroutine (a block, optionally
4616 preceded by a prototype in parens), given a reference to the
4617 sub. Because a subroutine can have no names, or more than one name,
4618 this method doesn't return a complete subroutine definition -- if you
4619 want to eval the result, you should prepend "sub subname ", or "sub "
4620 for an anonymous function constructor. Unless the sub was defined in
4621 the main:: package, the code will include a package declaration.
4622
4623 =head1 BUGS
4624
4625 =over 4
4626
4627 =item *
4628
4629 The only pragmas to be completely supported are: C<use warnings>,
4630 C<use strict 'refs'>, C<use bytes>, and C<use integer>. (C<$[>, which
4631 behaves like a pragma, is also supported.)
4632
4633 Excepting those listed above, we're currently unable to guarantee that
4634 B::Deparse will produce a pragma at the correct point in the program.
4635 (Specifically, pragmas at the beginning of a block often appear right
4636 before the start of the block instead.)
4637 Since the effects of pragmas are often lexically scoped, this can mean
4638 that the pragma holds sway over a different portion of the program
4639 than in the input file.
4640
4641 =item *
4642
4643 In fact, the above is a specific instance of a more general problem:
4644 we can't guarantee to produce BEGIN blocks or C<use> declarations in
4645 exactly the right place. So if you use a module which affects compilation
4646 (such as by over-riding keywords, overloading constants or whatever)
4647 then the output code might not work as intended.
4648
4649 This is the most serious outstanding problem, and will require some help
4650 from the Perl core to fix.
4651
4652 =item *
4653
4654 If a keyword is over-ridden, and your program explicitly calls
4655 the built-in version by using CORE::keyword, the output of B::Deparse
4656 will not reflect this. If you run the resulting code, it will call
4657 the over-ridden version rather than the built-in one. (Maybe there
4658 should be an option to B<always> print keyword calls as C<CORE::name>.)
4659
4660 =item *
4661
4662 Some constants don't print correctly either with or without B<-d>.
4663 For instance, neither B::Deparse nor Data::Dumper know how to print
4664 dual-valued scalars correctly, as in:
4665
4666     use constant E2BIG => ($!=7); $y = E2BIG; print $y, 0+$y;
4667
4668 =item *
4669
4670 An input file that uses source filtering probably won't be deparsed into
4671 runnable code, because it will still include the B<use> declaration
4672 for the source filtering module, even though the code that is
4673 produced is already ordinary Perl which shouldn't be filtered again.
4674
4675 =item *
4676
4677 Optimised away statements are rendered as '???'. This includes statements that
4678 have a compile-time side-effect, such as the obscure
4679
4680     my $x if 0;
4681
4682 which is not, consequently, deparsed correctly.
4683
4684 =item *
4685
4686 There are probably many more bugs on non-ASCII platforms (EBCDIC).
4687
4688 =back
4689
4690 =head1 AUTHOR
4691
4692 Stephen McCamant <smcc@CSUA.Berkeley.EDU>, based on an earlier version
4693 by Malcolm Beattie <mbeattie@sable.ox.ac.uk>, with contributions from
4694 Gisle Aas, James Duncan, Albert Dvornik, Robin Houston, Dave Mitchell,
4695 Hugo van der Sanden, Gurusamy Sarathy, Nick Ing-Simmons, and Rafael
4696 Garcia-Suarez.
4697
4698 =cut