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