ext/B/B/Concise.pm

   1 package B::Concise;
   2 # Copyright (C) 2000-2003 Stephen McCamant. All rights reserved.
   3 # This program is free software; you can redistribute and/or modify it
   4 # under the same terms as Perl itself.
   5
   6 # Note: we need to keep track of how many use declarations/BEGIN
   7 # blocks this module uses, so we can avoid printing them when user
   8 # asks for the BEGIN blocks in her program. Update the comments and
   9 # the count in concise_specials if you add or delete one. The
  10 # -MO=Concise counts as use #1.
  11
  12 use strict; # use #2
  13 use warnings; # uses #3 and #4, since warnings uses Carp
  14
  15 use Exporter (); # use #5
  16
  17 our $VERSION   = "0.67";
  18 our @ISA       = qw(Exporter);
  19 our @EXPORT_OK = qw( set_style set_style_standard add_callback
  20                      concise_subref concise_cv concise_main
  21                      add_style walk_output compile reset_sequence );
  22 our %EXPORT_TAGS =
  23     ( io        => [qw( walk_output compile reset_sequence )],
  24       style     => [qw( add_style set_style_standard )],
  25       cb        => [qw( add_callback )],
  26       mech      => [qw( concise_subref concise_cv concise_main )],  );
  27
  28 # use #6
  29 use B qw(class ppname main_start main_root main_cv cstring svref_2object
  30          SVf_IOK SVf_NOK SVf_POK SVf_IVisUV SVf_FAKE OPf_KIDS OPf_SPECIAL
  31          CVf_ANON);
  32
  33 my %style =
  34   ("terse" =>
  35    ["(?(#label =>\n)?)(*(    )*)#class (#addr) #name (?([#targ])?) "
  36     . "#svclass~(?((#svaddr))?)~#svval~(?(label \"#coplabel\")?)\n",
  37     "(*(    )*)goto #class (#addr)\n",
  38     "#class pp_#name"],
  39    "concise" =>
  40    ["#hyphseq2 (*(   (x( ;)x))*)<#classsym> "
  41     . "#exname#arg(?([#targarglife])?)~#flags(?(/#private)?)(x(;~->#next)x)\n"
  42     , "  (*(    )*)     goto #seq\n",
  43     "(?(<#seq>)?)#exname#arg(?([#targarglife])?)"],
  44    "linenoise" =>
  45    ["(x(;(*( )*))x)#noise#arg(?([#targarg])?)(x( ;\n)x)",
  46     "gt_#seq ",
  47     "(?(#seq)?)#noise#arg(?([#targarg])?)"],
  48    "debug" =>
  49    ["#class (#addr)\n\top_next\t\t#nextaddr\n\top_sibling\t#sibaddr\n\t"
  50     . "op_ppaddr\tPL_ppaddr[OP_#NAME]\n\top_type\t\t#typenum\n" .
  51     ($] > 5.009 ? '' : "\top_seq\t\t#seqnum\n")
  52     . "\top_flags\t#flagval\n\top_private\t#privval\n"
  53     . "(?(\top_first\t#firstaddr\n)?)(?(\top_last\t\t#lastaddr\n)?)"
  54     . "(?(\top_sv\t\t#svaddr\n)?)",
  55     "    GOTO #addr\n",
  56     "#addr"],
  57    "env" => [$ENV{B_CONCISE_FORMAT}, $ENV{B_CONCISE_GOTO_FORMAT},
  58              $ENV{B_CONCISE_TREE_FORMAT}],
  59   );
  60
  61 # Renderings, ie how Concise prints, is controlled by these vars
  62 # primary:
  63 our $stylename;         # selects current style from %style
  64 my $order = "basic";    # how optree is walked & printed: basic, exec, tree
  65
  66 # rendering mechanics:
  67 # these 'formats' are the line-rendering templates
  68 # they're updated from %style when $stylename changes
  69 my ($format, $gotofmt, $treefmt);
  70
  71 # lesser players:
  72 my $base = 36;          # how <sequence#> is displayed
  73 my $big_endian = 1;     # more <sequence#> display
  74 my $tree_style = 0;     # tree-order details
  75 my $banner = 1;         # print banner before optree is traversed
  76 my $do_main = 0;        # force printing of main routine
  77
  78 # another factor: can affect all styles!
  79 our @callbacks;         # allow external management
  80
  81 set_style_standard("concise");
  82
  83 my $curcv;
  84 my $cop_seq_base;
  85
  86 sub set_style {
  87     ($format, $gotofmt, $treefmt) = @_;
  88     #warn "set_style: deprecated, use set_style_standard instead\n"; # someday
  89     die "expecting 3 style-format args\n" unless @_ == 3;
  90 }
  91
  92 sub add_style {
  93     my ($newstyle,@args) = @_;
  94     die "style '$newstyle' already exists, choose a new name\n"
  95         if exists $style{$newstyle};
  96     die "expecting 3 style-format args\n" unless @args == 3;
  97     $style{$newstyle} = [@args];
  98     $stylename = $newstyle; # update rendering state
  99 }
 100
 101 sub set_style_standard {
 102     ($stylename) = @_; # update rendering state
 103     die "err: style '$stylename' unknown\n" unless exists $style{$stylename};
 104     set_style(@{$style{$stylename}});
 105 }
 106
 107 sub add_callback {
 108     push @callbacks, @_;
 109 }
 110
 111 # output handle, used with all Concise-output printing
 112 our $walkHandle;        # public for your convenience
 113 BEGIN { $walkHandle = \*STDOUT }
 114
 115 sub walk_output { # updates $walkHandle
 116     my $handle = shift;
 117     return $walkHandle unless $handle; # allow use as accessor
 118
 119     if (ref $handle eq 'SCALAR') {
 120         require Config;
 121         die "no perlio in this build, can't call walk_output (\\\$scalar)\n"
 122             unless $Config::Config{useperlio};
 123         # in 5.8+, open(FILEHANDLE,MODE,REFERENCE) writes to string
 124         open my $tmp, '>', $handle;     # but cant re-set existing STDOUT
 125         $walkHandle = $tmp;             # so use my $tmp as intermediate var
 126         return $walkHandle;
 127     }
 128     my $iotype = ref $handle;
 129     die "expecting argument/object that can print\n"
 130         unless $iotype eq 'GLOB' or $iotype and $handle->can('print');
 131     $walkHandle = $handle;
 132 }
 133
 134 sub concise_subref {
 135     my($order, $coderef, $name) = @_;
 136     my $codeobj = svref_2object($coderef);
 137
 138     return concise_stashref(@_)
 139         unless ref $codeobj eq 'B::CV';
 140     concise_cv_obj($order, $codeobj, $name);
 141 }
 142
 143 sub concise_stashref {
 144     my($order, $h) = @_;
 145     foreach my $k (sort keys %$h) {
 146         local *s = $h->{$k};
 147         my $coderef = *s{CODE} or next;
 148         reset_sequence();
 149         print "FUNC: ", *s, "\n";
 150         my $codeobj = svref_2object($coderef);
 151         next unless ref $codeobj eq 'B::CV';
 152         eval { concise_cv_obj($order, $codeobj) }
 153         or warn "err $@ on $codeobj";
 154     }
 155 }
 156
 157 # This should have been called concise_subref, but it was exported
 158 # under this name in versions before 0.56
 159 *concise_cv = \&concise_subref;
 160
 161 sub concise_cv_obj {
 162     my ($order, $cv, $name) = @_;
 163     # name is either a string, or a CODE ref (copy of $cv arg??)
 164
 165     $curcv = $cv;
 166
 167     if (ref($cv->XSUBANY) =~ /B::(\w+)/) {
 168         print $walkHandle "$name is a constant sub, optimized to a $1\n";
 169         return;
 170     }
 171     if ($cv->XSUB) {
 172         print $walkHandle "$name is XS code\n";
 173         return;
 174     }
 175     if (class($cv->START) eq "NULL") {
 176         no strict 'refs';
 177         if (ref $name eq 'CODE') {
 178             print $walkHandle "coderef $name has no START\n";
 179         }
 180         elsif (exists &$name) {
 181             print $walkHandle "$name exists in stash, but has no START\n";
 182         }
 183         else {
 184             print $walkHandle "$name not in symbol table\n";
 185         }
 186         return;
 187     }
 188     sequence($cv->START);
 189     if ($order eq "exec") {
 190         walk_exec($cv->START);
 191     }
 192     elsif ($order eq "basic") {
 193         # walk_topdown($cv->ROOT, sub { $_[0]->concise($_[1]) }, 0);
 194         my $root = $cv->ROOT;
 195         unless (ref $root eq 'B::NULL') {
 196             walk_topdown($root, sub { $_[0]->concise($_[1]) }, 0);
 197         } else {
 198             print $walkHandle "B::NULL encountered doing ROOT on $cv. avoiding disaster\n";
 199         }
 200     } else {
 201         print $walkHandle tree($cv->ROOT, 0);
 202     }
 203 }
 204
 205 sub concise_main {
 206     my($order) = @_;
 207     sequence(main_start);
 208     $curcv = main_cv;
 209     if ($order eq "exec") {
 210         return if class(main_start) eq "NULL";
 211         walk_exec(main_start);
 212     } elsif ($order eq "tree") {
 213         return if class(main_root) eq "NULL";
 214         print $walkHandle tree(main_root, 0);
 215     } elsif ($order eq "basic") {
 216         return if class(main_root) eq "NULL";
 217         walk_topdown(main_root,
 218                      sub { $_[0]->concise($_[1]) }, 0);
 219     }
 220 }
 221
 222 sub concise_specials {
 223     my($name, $order, @cv_s) = @_;
 224     my $i = 1;
 225     if ($name eq "BEGIN") {
 226         splice(@cv_s, 0, 8); # skip 7 BEGIN blocks in this file. NOW 8 ??
 227     } elsif ($name eq "CHECK") {
 228         pop @cv_s; # skip the CHECK block that calls us
 229     }
 230     for my $cv (@cv_s) {
 231         print $walkHandle "$name $i:\n";
 232         $i++;
 233         concise_cv_obj($order, $cv, $name);
 234     }
 235 }
 236
 237 my $start_sym = "\e(0"; # "\cN" sometimes also works
 238 my $end_sym   = "\e(B"; # "\cO" respectively
 239
 240 my @tree_decorations =
 241   (["  ", "--", "+-", "|-", "| ", "`-", "-", 1],
 242    [" ", "-", "+", "+", "|", "`", "", 0],
 243    ["  ", map("$start_sym$_$end_sym", "qq", "wq", "tq", "x ", "mq", "q"), 1],
 244    [" ", map("$start_sym$_$end_sym", "q", "w", "t", "x", "m"), "", 0],
 245   );
 246
 247
 248 sub compileOpts {
 249     # set rendering state from options and args
 250     my (@options,@args);
 251     if (@_) {
 252         @options = grep(/^-/, @_);
 253         @args = grep(!/^-/, @_);
 254     }
 255     for my $o (@options) {
 256         # mode/order
 257         if ($o eq "-basic") {
 258             $order = "basic";
 259         } elsif ($o eq "-exec") {
 260             $order = "exec";
 261         } elsif ($o eq "-tree") {
 262             $order = "tree";
 263         }
 264         # tree-specific
 265         elsif ($o eq "-compact") {
 266             $tree_style |= 1;
 267         } elsif ($o eq "-loose") {
 268             $tree_style &= ~1;
 269         } elsif ($o eq "-vt") {
 270             $tree_style |= 2;
 271         } elsif ($o eq "-ascii") {
 272             $tree_style &= ~2;
 273         }
 274         # sequence numbering
 275         elsif ($o =~ /^-base(\d+)$/) {
 276             $base = $1;
 277         } elsif ($o eq "-bigendian") {
 278             $big_endian = 1;
 279         } elsif ($o eq "-littleendian") {
 280             $big_endian = 0;
 281         }
 282         elsif ($o eq "-nobanner") {
 283             $banner = 0;
 284         } elsif ($o eq "-banner") {
 285             $banner = 1;
 286         }
 287         elsif ($o eq "-main") {
 288             $do_main = 1;
 289         } elsif ($o eq "-nomain") {
 290             $do_main = 0;
 291         }
 292         # line-style options
 293         elsif (exists $style{substr($o, 1)}) {
 294             $stylename = substr($o, 1);
 295             set_style_standard($stylename);
 296         } else {
 297             warn "Option $o unrecognized";
 298         }
 299     }
 300     return (@args);
 301 }
 302
 303 sub compile {
 304     my (@args) = compileOpts(@_);
 305     return sub {
 306         my @newargs = compileOpts(@_); # accept new rendering options
 307         warn "disregarding non-options: @newargs\n" if @newargs;
 308
 309         for my $objname (@args) {
 310             next unless $objname; # skip null args to avoid noisy responses
 311
 312             if ($objname eq "BEGIN") {
 313                 concise_specials("BEGIN", $order,
 314                                  B::begin_av->isa("B::AV") ?
 315                                  B::begin_av->ARRAY : ());
 316             } elsif ($objname eq "INIT") {
 317                 concise_specials("INIT", $order,
 318                                  B::init_av->isa("B::AV") ?
 319                                  B::init_av->ARRAY : ());
 320             } elsif ($objname eq "CHECK") {
 321                 concise_specials("CHECK", $order,
 322                                  B::check_av->isa("B::AV") ?
 323                                  B::check_av->ARRAY : ());
 324             } elsif ($objname eq "END") {
 325                 concise_specials("END", $order,
 326                                  B::end_av->isa("B::AV") ?
 327                                  B::end_av->ARRAY : ());
 328             }
 329             else {
 330                 # convert function names to subrefs
 331                 my $objref;
 332                 if (ref $objname) {
 333                     print $walkHandle "B::Concise::compile($objname)\n"
 334                         if $banner;
 335                     $objref = $objname;
 336                 } else {
 337                     $objname = "main::" . $objname unless $objname =~ /::/;
 338                     print $walkHandle "$objname:\n";
 339                     no strict 'refs';
 340                     unless (exists &$objname) {
 341                         print $walkHandle "err: unknown function ($objname)\n";
 342                         return;
 343                     }
 344                     $objref = \&$objname;
 345                 }
 346                 concise_subref($order, $objref, $objname);
 347             }
 348         }
 349         if (!@args or $do_main) {
 350             print $walkHandle "main program:\n" if $do_main;
 351             concise_main($order);
 352         }
 353         return @args;   # something
 354     }
 355 }
 356
 357 my %labels;
 358 my $lastnext;   # remembers op-chain, used to insert gotos
 359
 360 my %opclass = ('OP' => "0", 'UNOP' => "1", 'BINOP' => "2", 'LOGOP' => "|",
 361                'LISTOP' => "@", 'PMOP' => "/", 'SVOP' => "\$", 'GVOP' => "*",
 362                'PVOP' => '"', 'LOOP' => "{", 'COP' => ";", 'PADOP' => "#");
 363
 364 no warnings 'qw'; # "Possible attempt to put comments..."; use #7
 365 my @linenoise =
 366   qw'#  () sc (  @? 1  $* gv *{ m$ m@ m% m? p/ *$ $  $# & a& pt \\ s\\ rf bl
 367      `  *? <> ?? ?/ r/ c/ // qr s/ /c y/ =  @= C  sC Cp sp df un BM po +1 +I
 368      -1 -I 1+ I+ 1- I- ** *  i* /  i/ %$ i% x  +  i+ -  i- .  "  << >> <  i<
 369      >  i> <= i, >= i. == i= != i! <? i? s< s> s, s. s= s! s? b& b^ b| -0 -i
 370      !  ~  a2 si cs rd sr e^ lg sq in %x %o ab le ss ve ix ri sf FL od ch cy
 371      uf lf uc lc qm @  [f [  @[ eh vl ky dl ex %  ${ @{ uk pk st jn )  )[ a@
 372      a% sl +] -] [- [+ so rv GS GW MS MW .. f. .f && || ^^ ?: &= |= -> s{ s}
 373      v} ca wa di rs ;; ;  ;d }{ {  }  {} f{ it {l l} rt }l }n }r dm }g }e ^o
 374      ^c ^| ^# um bm t~ u~ ~d DB db ^s se ^g ^r {w }w pf pr ^O ^K ^R ^W ^d ^v
 375      ^e ^t ^k t. fc ic fl .s .p .b .c .l .a .h g1 s1 g2 s2 ?. l? -R -W -X -r
 376      -w -x -e -o -O -z -s -M -A -C -S -c -b -f -d -p -l -u -g -k -t -T -B cd
 377      co cr u. cm ut r. l@ s@ r@ mD uD oD rD tD sD wD cD f$ w$ p$ sh e$ k$ g3
 378      g4 s4 g5 s5 T@ C@ L@ G@ A@ S@ Hg Hc Hr Hw Mg Mc Ms Mr Sg Sc So rq do {e
 379      e} {t t} g6 G6 6e g7 G7 7e g8 G8 8e g9 G9 9e 6s 7s 8s 9s 6E 7E 8E 9E Pn
 380      Pu GP SP EP Gn Gg GG SG EG g0 c$ lk t$ ;s n> // /= CO';
 381
 382 my $chars = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
 383
 384 sub op_flags { # common flags (see BASOP.op_flags in op.h)
 385     my($x) = @_;
 386     my(@v);
 387     push @v, "v" if ($x & 3) == 1;
 388     push @v, "s" if ($x & 3) == 2;
 389     push @v, "l" if ($x & 3) == 3;
 390     push @v, "K" if $x & 4;
 391     push @v, "P" if $x & 8;
 392     push @v, "R" if $x & 16;
 393     push @v, "M" if $x & 32;
 394     push @v, "S" if $x & 64;
 395     push @v, "*" if $x & 128;
 396     return join("", @v);
 397 }
 398
 399 sub base_n {
 400     my $x = shift;
 401     return "-" . base_n(-$x) if $x < 0;
 402     my $str = "";
 403     do { $str .= substr($chars, $x % $base, 1) } while $x = int($x / $base);
 404     $str = reverse $str if $big_endian;
 405     return $str;
 406 }
 407
 408 my %sequence_num;
 409 my $seq_max = 1;
 410
 411 sub reset_sequence {
 412     # reset the sequence
 413     %sequence_num = ();
 414     $seq_max = 1;
 415     $lastnext = 0;
 416 }
 417
 418 sub seq {
 419     my($op) = @_;
 420     return "-" if not exists $sequence_num{$$op};
 421     return base_n($sequence_num{$$op});
 422 }
 423
 424 sub walk_topdown {
 425     my($op, $sub, $level) = @_;
 426     $sub->($op, $level);
 427     if ($op->flags & OPf_KIDS) {
 428         for (my $kid = $op->first; $$kid; $kid = $kid->sibling) {
 429             walk_topdown($kid, $sub, $level + 1);
 430         }
 431     }
 432     elsif (class($op) eq "PMOP") {
 433         my $maybe_root = $op->pmreplroot;
 434         if (ref($maybe_root) and $maybe_root->isa("B::OP")) {
 435             # It really is the root of the replacement, not something
 436             # else stored here for lack of space elsewhere
 437             walk_topdown($maybe_root, $sub, $level + 1);
 438         }
 439     }
 440 }
 441
 442 sub walklines {
 443     my($ar, $level) = @_;
 444     for my $l (@$ar) {
 445         if (ref($l) eq "ARRAY") {
 446             walklines($l, $level + 1);
 447         } else {
 448             $l->concise($level);
 449         }
 450     }
 451 }
 452
 453 sub walk_exec {
 454     my($top, $level) = @_;
 455     my %opsseen;
 456     my @lines;
 457     my @todo = ([$top, \@lines]);
 458     while (@todo and my($op, $targ) = @{shift @todo}) {
 459         for (; $$op; $op = $op->next) {
 460             last if $opsseen{$$op}++;
 461             push @$targ, $op;
 462             my $name = $op->name;
 463             if (class($op) eq "LOGOP") {
 464                 my $ar = [];
 465                 push @$targ, $ar;
 466                 push @todo, [$op->other, $ar];
 467             } elsif ($name eq "subst" and $ {$op->pmreplstart}) {
 468                 my $ar = [];
 469                 push @$targ, $ar;
 470                 push @todo, [$op->pmreplstart, $ar];
 471             } elsif ($name =~ /^enter(loop|iter)$/) {
 472                 if ($] > 5.009) {
 473                     $labels{${$op->nextop}} = "NEXT";
 474                     $labels{${$op->lastop}} = "LAST";
 475                     $labels{${$op->redoop}} = "REDO";
 476                 } else {
 477                     $labels{$op->nextop->seq} = "NEXT";
 478                     $labels{$op->lastop->seq} = "LAST";
 479                     $labels{$op->redoop->seq} = "REDO";
 480                 }
 481             }
 482         }
 483     }
 484     walklines(\@lines, 0);
 485 }
 486
 487 # The structure of this routine is purposely modeled after op.c's peep()
 488 sub sequence {
 489     my($op) = @_;
 490     my $oldop = 0;
 491     return if class($op) eq "NULL" or exists $sequence_num{$$op};
 492     for (; $$op; $op = $op->next) {
 493         last if exists $sequence_num{$$op};
 494         my $name = $op->name;
 495         if ($name =~ /^(null|scalar|lineseq|scope)$/) {
 496             next if $oldop and $ {$op->next};
 497         } else {
 498             $sequence_num{$$op} = $seq_max++;
 499             if (class($op) eq "LOGOP") {
 500                 my $other = $op->other;
 501                 $other = $other->next while $other->name eq "null";
 502                 sequence($other);
 503             } elsif (class($op) eq "LOOP") {
 504                 my $redoop = $op->redoop;
 505                 $redoop = $redoop->next while $redoop->name eq "null";
 506                 sequence($redoop);
 507                 my $nextop = $op->nextop;
 508                 $nextop = $nextop->next while $nextop->name eq "null";
 509                 sequence($nextop);
 510                 my $lastop = $op->lastop;
 511                 $lastop = $lastop->next while $lastop->name eq "null";
 512                 sequence($lastop);
 513             } elsif ($name eq "subst" and $ {$op->pmreplstart}) {
 514                 my $replstart = $op->pmreplstart;
 515                 $replstart = $replstart->next while $replstart->name eq "null";
 516                 sequence($replstart);
 517             }
 518         }
 519         $oldop = $op;
 520     }
 521 }
 522
 523 sub fmt_line {    # generate text-line for op.
 524     my($hr, $op, $text, $level) = @_;
 525
 526     $_->($hr, $op, \$text, \$level, $stylename) for @callbacks;
 527
 528     return '' if $hr->{SKIP};   # suppress line if a callback said so
 529     return '' if $hr->{goto} and $hr->{goto} eq '-';    # no goto nowhere
 530
 531     # spec: (?(text1#varText2)?)
 532     $text =~ s/\(\?\(([^\#]*?)\#(\w+)([^\#]*?)\)\?\)/
 533         $hr->{$2} ? $1.$hr->{$2}.$3 : ""/eg;
 534
 535     # spec: (x(exec_text;basic_text)x)
 536     $text =~ s/\(x\((.*?);(.*?)\)x\)/$order eq "exec" ? $1 : $2/egs;
 537
 538     # spec: (*(text)*)
 539     $text =~ s/\(\*\(([^;]*?)\)\*\)/$1 x $level/egs;
 540
 541     # spec: (*(text1;text2)*)
 542     $text =~ s/\(\*\((.*?);(.*?)\)\*\)/$1 x ($level - 1) . $2 x ($level>0)/egs;
 543
 544     # convert #Var to tag=>val form: Var\t#var
 545     $text =~ s/\#([A-Z][a-z]+)(\d+)?/\t\u$1\t\L#$1$2/gs;
 546
 547     # spec: #varN
 548     $text =~ s/\#([a-zA-Z]+)(\d+)/sprintf("%-$2s", $hr->{$1})/eg;
 549
 550     $text =~ s/\#([a-zA-Z]+)/$hr->{$1}/eg;      # populate #var's
 551     $text =~ s/[ \t]*~+[ \t]*/ /g;              # squeeze tildes
 552     chomp $text;
 553     return "$text\n" if $text ne "";
 554     return $text; # suppress empty lines
 555 }
 556
 557 our %priv; # used to display each opcode's BASEOP.op_private values
 558
 559 $priv{$_}{128} = "LVINTRO"
 560   for ("pos", "substr", "vec", "threadsv", "gvsv", "rv2sv", "rv2hv", "rv2gv",
 561        "rv2av", "rv2arylen", "aelem", "helem", "aslice", "hslice", "padsv",
 562        "padav", "padhv", "enteriter");
 563 $priv{$_}{64} = "REFC" for ("leave", "leavesub", "leavesublv", "leavewrite");
 564 $priv{"aassign"}{64} = "COMMON";
 565 $priv{"aassign"}{32} = "PHASH" if $] < 5.009;
 566 $priv{"sassign"}{64} = "BKWARD";
 567 $priv{$_}{64} = "RTIME" for ("match", "subst", "substcont", "qr");
 568 @{$priv{"trans"}}{1,2,4,8,16,64} = ("<UTF", ">UTF", "IDENT", "SQUASH", "DEL",
 569                                     "COMPL", "GROWS");
 570 $priv{"repeat"}{64} = "DOLIST";
 571 $priv{"leaveloop"}{64} = "CONT";
 572 @{$priv{$_}}{32,64,96} = ("DREFAV", "DREFHV", "DREFSV")
 573   for (qw(rv2gv rv2sv padsv aelem helem));
 574 @{$priv{"entersub"}}{16,32,64} = ("DBG","TARG","NOMOD");
 575 @{$priv{$_}}{4,8,128} = ("INARGS","AMPER","NO()") for ("entersub", "rv2cv");
 576 $priv{"gv"}{32} = "EARLYCV";
 577 $priv{"aelem"}{16} = $priv{"helem"}{16} = "LVDEFER";
 578 $priv{$_}{16} = "OURINTR" for ("gvsv", "rv2sv", "rv2av", "rv2hv", "r2gv",
 579         "enteriter");
 580 $priv{$_}{16} = "TARGMY"
 581   for (map(($_,"s$_"),"chop", "chomp"),
 582        map(($_,"i_$_"), "postinc", "postdec", "multiply", "divide", "modulo",
 583            "add", "subtract", "negate"), "pow", "concat", "stringify",
 584        "left_shift", "right_shift", "bit_and", "bit_xor", "bit_or",
 585        "complement", "atan2", "sin", "cos", "rand", "exp", "log", "sqrt",
 586        "int", "hex", "oct", "abs", "length", "index", "rindex", "sprintf",
 587        "ord", "chr", "crypt", "quotemeta", "join", "push", "unshift", "flock",
 588        "chdir", "chown", "chroot", "unlink", "chmod", "utime", "rename",
 589        "link", "symlink", "mkdir", "rmdir", "wait", "waitpid", "system",
 590        "exec", "kill", "getppid", "getpgrp", "setpgrp", "getpriority",
 591        "setpriority", "time", "sleep");
 592 $priv{$_}{4} = "REVERSED" for ("enteriter", "iter");
 593 @{$priv{"const"}}{4,8,16,32,64,128} = ("SHORT","STRICT","ENTERED",'$[',"BARE","WARN");
 594 $priv{"flip"}{64} = $priv{"flop"}{64} = "LINENUM";
 595 $priv{"list"}{64} = "GUESSED";
 596 $priv{"delete"}{64} = "SLICE";
 597 $priv{"exists"}{64} = "SUB";
 598 @{$priv{"sort"}}{1,2,4,8,16,32,64} = ("NUM", "INT", "REV", "INPLACE","DESC","QSORT","STABLE");
 599 $priv{"threadsv"}{64} = "SVREFd";
 600 @{$priv{$_}}{16,32,64,128} = ("INBIN","INCR","OUTBIN","OUTCR")
 601   for ("open", "backtick");
 602 $priv{"exit"}{128} = "VMS";
 603 $priv{$_}{2} = "FTACCESS"
 604   for ("ftrread", "ftrwrite", "ftrexec", "fteread", "ftewrite", "fteexec");
 605 $priv{"entereval"}{2} = "HAS_HH";
 606 if ($] >= 5.009) {
 607   # Stacked filetests are post 5.8.x
 608   $priv{$_}{4} = "FTSTACKED"
 609     for ("ftrread", "ftrwrite", "ftrexec", "fteread", "ftewrite", "fteexec",
 610          "ftis", "fteowned", "ftrowned", "ftzero", "ftsize", "ftmtime",
 611          "ftatime", "ftctime", "ftsock", "ftchr", "ftblk", "ftfile", "ftdir",
 612          "ftpipe", "ftlink", "ftsuid", "ftsgid", "ftsvtx", "fttty", "fttext",
 613          "ftbinary");
 614   # Lexical $_ is post 5.8.x
 615   $priv{$_}{2} = "GREPLEX"
 616     for ("mapwhile", "mapstart", "grepwhile", "grepstart");
 617 }
 618
 619 sub private_flags {
 620     my($name, $x) = @_;
 621     my @s;
 622     for my $flag (128, 96, 64, 32, 16, 8, 4, 2, 1) {
 623         if ($priv{$name}{$flag} and $x & $flag and $x >= $flag) {
 624             $x -= $flag;
 625             push @s, $priv{$name}{$flag};
 626         }
 627     }
 628     push @s, $x if $x;
 629     return join(",", @s);
 630 }
 631
 632 sub concise_sv {
 633     my($sv, $hr, $preferpv) = @_;
 634     $hr->{svclass} = class($sv);
 635     $hr->{svclass} = "UV"
 636       if $hr->{svclass} eq "IV" and $sv->FLAGS & SVf_IVisUV;
 637     Carp::cluck("bad concise_sv: $sv") unless $sv and $$sv;
 638     $hr->{svaddr} = sprintf("%#x", $$sv);
 639     if ($hr->{svclass} eq "GV") {
 640         my $gv = $sv;
 641         my $stash = $gv->STASH->NAME;
 642         if ($stash eq "main") {
 643             $stash = "";
 644         } else {
 645             $stash = $stash . "::";
 646         }
 647         $hr->{svval} = "*$stash" . $gv->SAFENAME;
 648         return "*$stash" . $gv->SAFENAME;
 649     } else {
 650         while (class($sv) eq "RV") {
 651             $hr->{svval} .= "\\";
 652             $sv = $sv->RV;
 653         }
 654         if (class($sv) eq "SPECIAL") {
 655             $hr->{svval} .= ["Null", "sv_undef", "sv_yes", "sv_no"]->[$$sv];
 656         } elsif ($preferpv && $sv->FLAGS & SVf_POK) {
 657             $hr->{svval} .= cstring($sv->PV);
 658         } elsif ($sv->FLAGS & SVf_NOK) {
 659             $hr->{svval} .= $sv->NV;
 660         } elsif ($sv->FLAGS & SVf_IOK) {
 661             $hr->{svval} .= $sv->int_value;
 662         } elsif ($sv->FLAGS & SVf_POK) {
 663             $hr->{svval} .= cstring($sv->PV);
 664         } elsif (class($sv) eq "HV") {
 665             $hr->{svval} .= 'HASH';
 666         }
 667
 668         $hr->{svval} = 'undef' unless defined $hr->{svval};
 669         my $out = $hr->{svclass};
 670         return $out .= " $hr->{svval}" ;
 671     }
 672 }
 673
 674 sub concise_op {
 675     my ($op, $level, $format) = @_;
 676     my %h;
 677     $h{exname} = $h{name} = $op->name;
 678     $h{NAME} = uc $h{name};
 679     $h{class} = class($op);
 680     $h{extarg} = $h{targ} = $op->targ;
 681     $h{extarg} = "" unless $h{extarg};
 682     if ($h{name} eq "null" and $h{targ}) {
 683         # targ holds the old type
 684         $h{exname} = "ex-" . substr(ppname($h{targ}), 3);
 685         $h{extarg} = "";
 686     } elsif ($op->name =~ /^leave(sub(lv)?|write)?$/) {
 687         # targ potentially holds a reference count
 688         if ($op->private & 64) {
 689             my $refs = "ref" . ($h{targ} != 1 ? "s" : "");
 690             $h{targarglife} = $h{targarg} = "$h{targ} $refs";
 691         }
 692     } elsif ($h{targ}) {
 693         my $padname = (($curcv->PADLIST->ARRAY)[0]->ARRAY)[$h{targ}];
 694         if (defined $padname and class($padname) ne "SPECIAL") {
 695             $h{targarg}  = $padname->PVX;
 696             if ($padname->FLAGS & SVf_FAKE) {
 697                 if ($] < 5.009) {
 698                     $h{targarglife} = "$h{targarg}:FAKE";
 699                 } else {
 700                     # These changes relate to the jumbo closure fix.
 701                     # See changes 19939 and 20005
 702                     my $fake = '';
 703                     $fake .= 'a' if $padname->IVX & 1; # PAD_FAKELEX_ANON
 704                     $fake .= 'm' if $padname->IVX & 2; # PAD_FAKELEX_MULTI
 705                     $fake .= ':' . $padname->NVX if $curcv->CvFLAGS & CVf_ANON;
 706                     $h{targarglife} = "$h{targarg}:FAKE:$fake";
 707                 }
 708             }
 709             else {
 710                 my $intro = $padname->NVX - $cop_seq_base;
 711                 my $finish = int($padname->IVX) - $cop_seq_base;
 712                 $finish = "end" if $finish == 999999999 - $cop_seq_base;
 713                 $h{targarglife} = "$h{targarg}:$intro,$finish";
 714             }
 715         } else {
 716             $h{targarglife} = $h{targarg} = "t" . $h{targ};
 717         }
 718     }
 719     $h{arg} = "";
 720     $h{svclass} = $h{svaddr} = $h{svval} = "";
 721     if ($h{class} eq "PMOP") {
 722         my $precomp = $op->precomp;
 723         if (defined $precomp) {
 724             $precomp = cstring($precomp); # Escape literal control sequences
 725             $precomp = "/$precomp/";
 726         } else {
 727             $precomp = "";
 728         }
 729         my $pmreplroot = $op->pmreplroot;
 730         my $pmreplstart;
 731         if (ref($pmreplroot) eq "B::GV") {
 732             # with C<@stash_array = split(/pat/, str);>,
 733             #  *stash_array is stored in /pat/'s pmreplroot.
 734             $h{arg} = "($precomp => \@" . $pmreplroot->NAME . ")";
 735         } elsif (!ref($pmreplroot) and $pmreplroot) {
 736             # same as the last case, except the value is actually a
 737             # pad offset for where the GV is kept (this happens under
 738             # ithreads)
 739             my $gv = (($curcv->PADLIST->ARRAY)[1]->ARRAY)[$pmreplroot];
 740             $h{arg} = "($precomp => \@" . $gv->NAME . ")";
 741         } elsif ($ {$op->pmreplstart}) {
 742             undef $lastnext;
 743             $pmreplstart = "replstart->" . seq($op->pmreplstart);
 744             $h{arg} = "(" . join(" ", $precomp, $pmreplstart) . ")";
 745         } else {
 746             $h{arg} = "($precomp)";
 747         }
 748     } elsif ($h{class} eq "PVOP" and $h{name} ne "trans") {
 749         $h{arg} = '("' . $op->pv . '")';
 750         $h{svval} = '"' . $op->pv . '"';
 751     } elsif ($h{class} eq "COP") {
 752         my $label = $op->label;
 753         $h{coplabel} = $label;
 754         $label = $label ? "$label: " : "";
 755         my $loc = $op->file;
 756         $loc =~ s[.*/][];
 757         $loc .= ":" . $op->line;
 758         my($stash, $cseq) = ($op->stash->NAME, $op->cop_seq - $cop_seq_base);
 759         my $arybase = $op->arybase;
 760         $arybase = $arybase ? ' $[=' . $arybase : "";
 761         $h{arg} = "($label$stash $cseq $loc$arybase)";
 762     } elsif ($h{class} eq "LOOP") {
 763         $h{arg} = "(next->" . seq($op->nextop) . " last->" . seq($op->lastop)
 764           . " redo->" . seq($op->redoop) . ")";
 765     } elsif ($h{class} eq "LOGOP") {
 766         undef $lastnext;
 767         $h{arg} = "(other->" . seq($op->other) . ")";
 768     }
 769     elsif ($h{class} eq "SVOP" or $h{class} eq "PADOP") {
 770         unless ($h{name} eq 'aelemfast' and $op->flags & OPf_SPECIAL) {
 771             my $idx = ($h{class} eq "SVOP") ? $op->targ : $op->padix;
 772             my $preferpv = $h{name} eq "method_named";
 773             if ($h{class} eq "PADOP" or !${$op->sv}) {
 774                 my $sv = (($curcv->PADLIST->ARRAY)[1]->ARRAY)[$idx];
 775                 $h{arg} = "[" . concise_sv($sv, \%h, $preferpv) . "]";
 776                 $h{targarglife} = $h{targarg} = "";
 777             } else {
 778                 $h{arg} = "(" . concise_sv($op->sv, \%h, $preferpv) . ")";
 779             }
 780         }
 781     }
 782     $h{seq} = $h{hyphseq} = seq($op);
 783     $h{seq} = "" if $h{seq} eq "-";
 784     if ($] > 5.009) {
 785         $h{opt} = $op->opt;
 786         $h{static} = $op->static;
 787         $h{label} = $labels{$$op};
 788     } else {
 789         $h{seqnum} = $op->seq;
 790         $h{label} = $labels{$op->seq};
 791     }
 792     $h{next} = $op->next;
 793     $h{next} = (class($h{next}) eq "NULL") ? "(end)" : seq($h{next});
 794     $h{nextaddr} = sprintf("%#x", $ {$op->next});
 795     $h{sibaddr} = sprintf("%#x", $ {$op->sibling});
 796     $h{firstaddr} = sprintf("%#x", $ {$op->first}) if $op->can("first");
 797     $h{lastaddr} = sprintf("%#x", $ {$op->last}) if $op->can("last");
 798
 799     $h{classsym} = $opclass{$h{class}};
 800     $h{flagval} = $op->flags;
 801     $h{flags} = op_flags($op->flags);
 802     $h{privval} = $op->private;
 803     $h{private} = private_flags($h{name}, $op->private);
 804     $h{addr} = sprintf("%#x", $$op);
 805     $h{typenum} = $op->type;
 806     $h{noise} = $linenoise[$op->type];
 807
 808     return fmt_line(\%h, $op, $format, $level);
 809 }
 810
 811 sub B::OP::concise {
 812     my($op, $level) = @_;
 813     if ($order eq "exec" and $lastnext and $$lastnext != $$op) {
 814         # insert a 'goto' line
 815         my $synth = {"seq" => seq($lastnext), "class" => class($lastnext),
 816                      "addr" => sprintf("%#x", $$lastnext),
 817                      "goto" => seq($lastnext), # simplify goto '-' removal
 818              };
 819         print $walkHandle fmt_line($synth, $op, $gotofmt, $level+1);
 820     }
 821     $lastnext = $op->next;
 822     print $walkHandle concise_op($op, $level, $format);
 823 }
 824
 825 # B::OP::terse (see Terse.pm) now just calls this
 826 sub b_terse {
 827     my($op, $level) = @_;
 828
 829     # This isn't necessarily right, but there's no easy way to get
 830     # from an OP to the right CV. This is a limitation of the
 831     # ->terse() interface style, and there isn't much to do about
 832     # it. In particular, we can die in concise_op if the main pad
 833     # isn't long enough, or has the wrong kind of entries, compared to
 834     # the pad a sub was compiled with. The fix for that would be to
 835     # make a backwards compatible "terse" format that never even
 836     # looked at the pad, just like the old B::Terse. I don't think
 837     # that's worth the effort, though.
 838     $curcv = main_cv unless $curcv;
 839
 840     if ($order eq "exec" and $lastnext and $$lastnext != $$op) {
 841         # insert a 'goto'
 842         my $h = {"seq" => seq($lastnext), "class" => class($lastnext),
 843                  "addr" => sprintf("%#x", $$lastnext)};
 844         print # $walkHandle
 845             fmt_line($h, $op, $style{"terse"}[1], $level+1);
 846     }
 847     $lastnext = $op->next;
 848     print # $walkHandle
 849         concise_op($op, $level, $style{"terse"}[0]);
 850 }
 851
 852 sub tree {
 853     my $op = shift;
 854     my $level = shift;
 855     my $style = $tree_decorations[$tree_style];
 856     my($space, $single, $kids, $kid, $nokid, $last, $lead, $size) = @$style;
 857     my $name = concise_op($op, $level, $treefmt);
 858     if (not $op->flags & OPf_KIDS) {
 859         return $name . "\n";
 860     }
 861     my @lines;
 862     for (my $kid = $op->first; $$kid; $kid = $kid->sibling) {
 863         push @lines, tree($kid, $level+1);
 864     }
 865     my $i;
 866     for ($i = $#lines; substr($lines[$i], 0, 1) eq " "; $i--) {
 867         $lines[$i] = $space . $lines[$i];
 868     }
 869     if ($i > 0) {
 870         $lines[$i] = $last . $lines[$i];
 871         while ($i-- > 1) {
 872             if (substr($lines[$i], 0, 1) eq " ") {
 873                 $lines[$i] = $nokid . $lines[$i];
 874             } else {
 875                 $lines[$i] = $kid . $lines[$i];
 876             }
 877         }
 878         $lines[$i] = $kids . $lines[$i];
 879     } else {
 880         $lines[0] = $single . $lines[0];
 881     }
 882     return("$name$lead" . shift @lines,
 883            map(" " x (length($name)+$size) . $_, @lines));
 884 }
 885
 886 # *** Warning: fragile kludge ahead ***
 887 # Because the B::* modules run in the same interpreter as the code
 888 # they're compiling, their presence tends to distort the view we have of
 889 # the code we're looking at. In particular, perl gives sequence numbers
 890 # to COPs. If the program we're looking at were run on its own, this
 891 # would start at 1. Because all of B::Concise and all the modules it
 892 # uses are compiled first, though, by the time we get to the user's
 893 # program the sequence number is already pretty high, which could be
 894 # distracting if you're trying to tell OPs apart. Therefore we'd like to
 895 # subtract an offset from all the sequence numbers we display, to
 896 # restore the simpler view of the world. The trick is to know what that
 897 # offset will be, when we're still compiling B::Concise!  If we
 898 # hardcoded a value, it would have to change every time B::Concise or
 899 # other modules we use do. To help a little, what we do here is compile
 900 # a little code at the end of the module, and compute the base sequence
 901 # number for the user's program as being a small offset later, so all we
 902 # have to worry about are changes in the offset.
 903
 904 # [For 5.8.x and earlier perl is generating sequence numbers for all ops,
 905 #  and using them to reference labels]
 906
 907
 908 # When you say "perl -MO=Concise -e '$a'", the output should look like:
 909
 910 # 4  <@> leave[t1] vKP/REFC ->(end)
 911 # 1     <0> enter ->2
 912  #^ smallest OP sequence number should be 1
 913 # 2     <;> nextstate(main 1 -e:1) v ->3
 914  #                         ^ smallest COP sequence number should be 1
 915 # -     <1> ex-rv2sv vK/1 ->4
 916 # 3        <$> gvsv(*a) s ->4
 917
 918 # If the second of the marked numbers there isn't 1, it means you need
 919 # to update the corresponding magic number in the next line.
 920 # Remember, this needs to stay the last things in the module.
 921
 922 # Why is this different for MacOS?  Does it matter?
 923 my $cop_seq_mnum = $^O eq 'MacOS' ? 12 : 11;
 924 $cop_seq_base = svref_2object(eval 'sub{0;}')->START->cop_seq + $cop_seq_mnum;
 925
 926 1;
 927
 928 __END__
 929
 930 =head1 NAME
 931
 932 B::Concise - Walk Perl syntax tree, printing concise info about ops
 933
 934 =head1 SYNOPSIS
 935
 936     perl -MO=Concise[,OPTIONS] foo.pl
 937
 938     use B::Concise qw(set_style add_callback);
 939
 940 =head1 DESCRIPTION
 941
 942 This compiler backend prints the internal OPs of a Perl program's syntax
 943 tree in one of several space-efficient text formats suitable for debugging
 944 the inner workings of perl or other compiler backends. It can print OPs in
 945 the order they appear in the OP tree, in the order they will execute, or
 946 in a text approximation to their tree structure, and the format of the
 947 information displayed is customizable. Its function is similar to that of
 948 perl's B<-Dx> debugging flag or the B<B::Terse> module, but it is more
 949 sophisticated and flexible.
 950
 951 =head1 EXAMPLE
 952
 953 Here's two outputs (or 'renderings'), using the -exec and -basic
 954 (i.e. default) formatting conventions on the same code snippet.
 955
 956     % perl -MO=Concise,-exec -e '$a = $b + 42'
 957     1  <0> enter
 958     2  <;> nextstate(main 1 -e:1) v
 959     3  <#> gvsv[*b] s
 960     4  <$> const[IV 42] s
 961  *  5  <2> add[t3] sK/2
 962     6  <#> gvsv[*a] s
 963     7  <2> sassign vKS/2
 964     8  <@> leave[1 ref] vKP/REFC
 965
 966 In this -exec rendering, each opcode is executed in the order shown.
 967 The add opcode, marked with '*', is discussed in more detail.
 968
 969 The 1st column is the op's sequence number, starting at 1, and is
 970 displayed in base 36 by default.  Here they're purely linear; the
 971 sequences are very helpful when looking at code with loops and
 972 branches.
 973
 974 The symbol between angle brackets indicates the op's type, for
 975 example; <2> is a BINOP, <@> a LISTOP, and <#> is a PADOP, which is
 976 used in threaded perls. (see L</"OP class abbreviations">).
 977
 978 The opname, as in B<'add[t1]'>, may be followed by op-specific
 979 information in parentheses or brackets (ex B<'[t1]'>).
 980
 981 The op-flags (ex B<'sK/2'>) are described in (L</"OP flags
 982 abbreviations">).
 983
 984     % perl -MO=Concise -e '$a = $b + 42'
 985     8  <@> leave[1 ref] vKP/REFC ->(end)
 986     1     <0> enter ->2
 987     2     <;> nextstate(main 1 -e:1) v ->3
 988     7     <2> sassign vKS/2 ->8
 989  *  5        <2> add[t1] sK/2 ->6
 990     -           <1> ex-rv2sv sK/1 ->4
 991     3              <$> gvsv(*b) s ->4
 992     4           <$> const(IV 42) s ->5
 993     -        <1> ex-rv2sv sKRM*/1 ->7
 994     6           <$> gvsv(*a) s ->7
 995
 996 The default rendering is top-down, so they're not in execution order.
 997 This form reflects the way the stack is used to parse and evaluate
 998 expressions; the add operates on the two terms below it in the tree.
 999
1000 Nullops appear as C<ex-opname>, where I<opname> is an op that has been
1001 optimized away by perl.  They're displayed with a sequence-number of
1002 '-', because they are not executed (they don't appear in previous
1003 example), they're printed here because they reflect the parse.
1004
1005 The arrow points to the sequence number of the next op; they're not
1006 displayed in -exec mode, for obvious reasons.
1007
1008 Note that because this rendering was done on a non-threaded perl, the
1009 PADOPs in the previous examples are now SVOPs, and some (but not all)
1010 of the square brackets have been replaced by round ones.  This is a
1011 subtle feature to provide some visual distinction between renderings
1012 on threaded and un-threaded perls.
1013
1014
1015 =head1 OPTIONS
1016
1017 Arguments that don't start with a hyphen are taken to be the names of
1018 subroutines to print the OPs of; if no such functions are specified,
1019 the main body of the program (outside any subroutines, and not
1020 including use'd or require'd files) is rendered.  Passing C<BEGIN>,
1021 C<CHECK>, C<INIT>, or C<END> will cause all of the corresponding
1022 special blocks to be printed.
1023
1024 Options affect how things are rendered (ie printed).  They're presented
1025 here by their visual effect, 1st being strongest.  They're grouped
1026 according to how they interrelate; within each group the options are
1027 mutually exclusive (unless otherwise stated).
1028
1029 =head2 Options for Opcode Ordering
1030
1031 These options control the 'vertical display' of opcodes.  The display
1032 'order' is also called 'mode' elsewhere in this document.
1033
1034 =over 4
1035
1036 =item B<-basic>
1037
1038 Print OPs in the order they appear in the OP tree (a preorder
1039 traversal, starting at the root). The indentation of each OP shows its
1040 level in the tree, and the '->' at the end of the line indicates the
1041 next opcode in execution order.  This mode is the default, so the flag
1042 is included simply for completeness.
1043
1044 =item B<-exec>
1045
1046 Print OPs in the order they would normally execute (for the majority
1047 of constructs this is a postorder traversal of the tree, ending at the
1048 root). In most cases the OP that usually follows a given OP will
1049 appear directly below it; alternate paths are shown by indentation. In
1050 cases like loops when control jumps out of a linear path, a 'goto'
1051 line is generated.
1052
1053 =item B<-tree>
1054
1055 Print OPs in a text approximation of a tree, with the root of the tree
1056 at the left and 'left-to-right' order of children transformed into
1057 'top-to-bottom'. Because this mode grows both to the right and down,
1058 it isn't suitable for large programs (unless you have a very wide
1059 terminal).
1060
1061 =back
1062
1063 =head2 Options for Line-Style
1064
1065 These options select the line-style (or just style) used to render
1066 each opcode, and dictates what info is actually printed into each line.
1067
1068 =over 4
1069
1070 =item B<-concise>
1071
1072 Use the author's favorite set of formatting conventions. This is the
1073 default, of course.
1074
1075 =item B<-terse>
1076
1077 Use formatting conventions that emulate the output of B<B::Terse>. The
1078 basic mode is almost indistinguishable from the real B<B::Terse>, and the
1079 exec mode looks very similar, but is in a more logical order and lacks
1080 curly brackets. B<B::Terse> doesn't have a tree mode, so the tree mode
1081 is only vaguely reminiscent of B<B::Terse>.
1082
1083 =item B<-linenoise>
1084
1085 Use formatting conventions in which the name of each OP, rather than being
1086 written out in full, is represented by a one- or two-character abbreviation.
1087 This is mainly a joke.
1088
1089 =item B<-debug>
1090
1091 Use formatting conventions reminiscent of B<B::Debug>; these aren't
1092 very concise at all.
1093
1094 =item B<-env>
1095
1096 Use formatting conventions read from the environment variables
1097 C<B_CONCISE_FORMAT>, C<B_CONCISE_GOTO_FORMAT>, and C<B_CONCISE_TREE_FORMAT>.
1098
1099 =back
1100
1101 =head2 Options for tree-specific formatting
1102
1103 =over 4
1104
1105 =item B<-compact>
1106
1107 Use a tree format in which the minimum amount of space is used for the
1108 lines connecting nodes (one character in most cases). This squeezes out
1109 a few precious columns of screen real estate.
1110
1111 =item B<-loose>
1112
1113 Use a tree format that uses longer edges to separate OP nodes. This format
1114 tends to look better than the compact one, especially in ASCII, and is
1115 the default.
1116
1117 =item B<-vt>
1118
1119 Use tree connecting characters drawn from the VT100 line-drawing set.
1120 This looks better if your terminal supports it.
1121
1122 =item B<-ascii>
1123
1124 Draw the tree with standard ASCII characters like C<+> and C<|>. These don't
1125 look as clean as the VT100 characters, but they'll work with almost any
1126 terminal (or the horizontal scrolling mode of less(1)) and are suitable
1127 for text documentation or email. This is the default.
1128
1129 =back
1130
1131 These are pairwise exclusive, i.e. compact or loose, vt or ascii.
1132
1133 =head2 Options controlling sequence numbering
1134
1135 =over 4
1136
1137 =item B<-base>I<n>
1138
1139 Print OP sequence numbers in base I<n>. If I<n> is greater than 10, the
1140 digit for 11 will be 'a', and so on. If I<n> is greater than 36, the digit
1141 for 37 will be 'A', and so on until 62. Values greater than 62 are not
1142 currently supported. The default is 36.
1143
1144 =item B<-bigendian>
1145
1146 Print sequence numbers with the most significant digit first. This is the
1147 usual convention for Arabic numerals, and the default.
1148
1149 =item B<-littleendian>
1150
1151 Print seqence numbers with the least significant digit first.  This is
1152 obviously mutually exclusive with bigendian.
1153
1154 =back
1155
1156 =head2 Other options
1157
1158 These are pairwise exclusive.
1159
1160 =over 4
1161
1162 =item B<-main>
1163
1164 Include the main program in the output, even if subroutines were also
1165 specified.  This rendering is normally suppressed when a subroutine
1166 name or reference is given.
1167
1168 =item B<-nomain>
1169
1170 This restores the default behavior after you've changed it with '-main'
1171 (it's not normally needed).  If no subroutine name/ref is given, main is
1172 rendered, regardless of this flag.
1173
1174 =item B<-nobanner>
1175
1176 Renderings usually include a banner line identifying the function name
1177 or stringified subref.  This suppresses the printing of the banner.
1178
1179 TBC: Remove the stringified coderef; while it provides a 'cookie' for
1180 each function rendered, the cookies used should be 1,2,3.. not a
1181 random hex-address.  It also complicates string comparison of two
1182 different trees.
1183
1184 =item B<-banner>
1185
1186 restores default banner behavior.
1187
1188 =item B<-banneris> => subref
1189
1190 TBC: a hookpoint (and an option to set it) for a user-supplied
1191 function to produce a banner appropriate for users needs.  It's not
1192 ideal, because the rendering-state variables, which are a natural
1193 candidate for use in concise.t, are unavailable to the user.
1194
1195 =back
1196
1197 =head2 Option Stickiness
1198
1199 If you invoke Concise more than once in a program, you should know that
1200 the options are 'sticky'.  This means that the options you provide in
1201 the first call will be remembered for the 2nd call, unless you
1202 re-specify or change them.
1203
1204 =head1 ABBREVIATIONS
1205
1206 The concise style uses symbols to convey maximum info with minimal
1207 clutter (like hex addresses).  With just a little practice, you can
1208 start to see the flowers, not just the branches, in the trees.
1209
1210 =head2 OP class abbreviations
1211
1212 These symbols appear before the op-name, and indicate the
1213 B:: namespace that represents the ops in your Perl code.
1214
1215     0      OP (aka BASEOP)  An OP with no children
1216     1      UNOP             An OP with one child
1217     2      BINOP            An OP with two children
1218     |      LOGOP            A control branch OP
1219     @      LISTOP           An OP that could have lots of children
1220     /      PMOP             An OP with a regular expression
1221     $      SVOP             An OP with an SV
1222     "      PVOP             An OP with a string
1223     {      LOOP             An OP that holds pointers for a loop
1224     ;      COP              An OP that marks the start of a statement
1225     #      PADOP            An OP with a GV on the pad
1226
1227 =head2 OP flags abbreviations
1228
1229 OP flags are either public or private.  The public flags alter the
1230 behavior of each opcode in consistent ways, and are represented by 0
1231 or more single characters.
1232
1233     v      OPf_WANT_VOID    Want nothing (void context)
1234     s      OPf_WANT_SCALAR  Want single value (scalar context)
1235     l      OPf_WANT_LIST    Want list of any length (list context)
1236                             Want is unknown
1237     K      OPf_KIDS         There is a firstborn child.
1238     P      OPf_PARENS       This operator was parenthesized.
1239                              (Or block needs explicit scope entry.)
1240     R      OPf_REF          Certified reference.
1241                              (Return container, not containee).
1242     M      OPf_MOD          Will modify (lvalue).
1243     S      OPf_STACKED      Some arg is arriving on the stack.
1244     *      OPf_SPECIAL      Do something weird for this op (see op.h)
1245
1246 Private flags, if any are set for an opcode, are displayed after a '/'
1247
1248     8  <@> leave[1 ref] vKP/REFC ->(end)
1249     7     <2> sassign vKS/2 ->8
1250
1251 They're opcode specific, and occur less often than the public ones, so
1252 they're represented by short mnemonics instead of single-chars; see
1253 F<op.h> for gory details, or try this quick 2-liner:
1254
1255   $> perl -MB::Concise -de 1
1256   DB<1> |x \%B::Concise::priv
1257
1258 =head1 FORMATTING SPECIFICATIONS
1259
1260 For each line-style ('concise', 'terse', 'linenoise', etc.) there are
1261 3 format-specs which control how OPs are rendered.
1262
1263 The first is the 'default' format, which is used in both basic and exec
1264 modes to print all opcodes.  The 2nd, goto-format, is used in exec
1265 mode when branches are encountered.  They're not real opcodes, and are
1266 inserted to look like a closing curly brace.  The tree-format is tree
1267 specific.
1268
1269 When a line is rendered, the correct format-spec is copied and scanned
1270 for the following items; data is substituted in, and other
1271 manipulations like basic indenting are done, for each opcode rendered.
1272
1273 There are 3 kinds of items that may be populated; special patterns,
1274 #vars, and literal text, which is copied verbatim.  (Yes, it's a set
1275 of s///g steps.)
1276
1277 =head2 Special Patterns
1278
1279 These items are the primitives used to perform indenting, and to
1280 select text from amongst alternatives.
1281
1282 =over 4
1283
1284 =item B<(x(>I<exec_text>B<;>I<basic_text>B<)x)>
1285
1286 Generates I<exec_text> in exec mode, or I<basic_text> in basic mode.
1287
1288 =item B<(*(>I<text>B<)*)>
1289
1290 Generates one copy of I<text> for each indentation level.
1291
1292 =item B<(*(>I<text1>B<;>I<text2>B<)*)>
1293
1294 Generates one fewer copies of I<text1> than the indentation level, followed
1295 by one copy of I<text2> if the indentation level is more than 0.
1296
1297 =item B<(?(>I<text1>B<#>I<var>I<Text2>B<)?)>
1298
1299 If the value of I<var> is true (not empty or zero), generates the
1300 value of I<var> surrounded by I<text1> and I<Text2>, otherwise
1301 nothing.
1302
1303 =item B<~>
1304
1305 Any number of tildes and surrounding whitespace will be collapsed to
1306 a single space.
1307
1308 =back
1309
1310 =head2 # Variables
1311
1312 These #vars represent opcode properties that you may want as part of
1313 your rendering.  The '#' is intended as a private sigil; a #var's
1314 value is interpolated into the style-line, much like "read $this".
1315
1316 These vars take 3 forms:
1317
1318 =over 4
1319
1320 =item B<#>I<var>
1321
1322 A property named 'var' is assumed to exist for the opcodes, and is
1323 interpolated into the rendering.
1324
1325 =item B<#>I<var>I<N>
1326
1327 Generates the value of I<var>, left justified to fill I<N> spaces.
1328 Note that this means while you can have properties 'foo' and 'foo2',
1329 you cannot render 'foo2', but you could with 'foo2a'.  You would be
1330 wise not to rely on this behavior going forward ;-)
1331
1332 =item B<#>I<Var>
1333
1334 This ucfirst form of #var generates a tag-value form of itself for
1335 display; it converts '#Var' into a 'Var => #var' style, which is then
1336 handled as described above.  (Imp-note: #Vars cannot be used for
1337 conditional-fills, because the => #var transform is done after the check
1338 for #Var's value).
1339
1340 =back
1341
1342 The following variables are 'defined' by B::Concise; when they are
1343 used in a style, their respective values are plugged into the
1344 rendering of each opcode.
1345
1346 Only some of these are used by the standard styles, the others are
1347 provided for you to delve into optree mechanics, should you wish to
1348 add a new style (see L</add_style> below) that uses them.  You can
1349 also add new ones using L</add_callback>.
1350
1351 =over 4
1352
1353 =item B<#addr>
1354
1355 The address of the OP, in hexadecimal.
1356
1357 =item B<#arg>
1358
1359 The OP-specific information of the OP (such as the SV for an SVOP, the
1360 non-local exit pointers for a LOOP, etc.) enclosed in parentheses.
1361
1362 =item B<#class>
1363
1364 The B-determined class of the OP, in all caps.
1365
1366 =item B<#classsym>
1367
1368 A single symbol abbreviating the class of the OP.
1369
1370 =item B<#coplabel>
1371
1372 The label of the statement or block the OP is the start of, if any.
1373
1374 =item B<#exname>
1375
1376 The name of the OP, or 'ex-foo' if the OP is a null that used to be a foo.
1377
1378 =item B<#extarg>
1379
1380 The target of the OP, or nothing for a nulled OP.
1381
1382 =item B<#firstaddr>
1383
1384 The address of the OP's first child, in hexadecimal.
1385
1386 =item B<#flags>
1387
1388 The OP's flags, abbreviated as a series of symbols.
1389
1390 =item B<#flagval>
1391
1392 The numeric value of the OP's flags.
1393
1394 =item B<#hyphseq>
1395
1396 The sequence number of the OP, or a hyphen if it doesn't have one.
1397
1398 =item B<#label>
1399
1400 'NEXT', 'LAST', or 'REDO' if the OP is a target of one of those in exec
1401 mode, or empty otherwise.
1402
1403 =item B<#lastaddr>
1404
1405 The address of the OP's last child, in hexadecimal.
1406
1407 =item B<#name>
1408
1409 The OP's name.
1410
1411 =item B<#NAME>
1412
1413 The OP's name, in all caps.
1414
1415 =item B<#next>
1416
1417 The sequence number of the OP's next OP.
1418
1419 =item B<#nextaddr>
1420
1421 The address of the OP's next OP, in hexadecimal.
1422
1423 =item B<#noise>
1424
1425 A one- or two-character abbreviation for the OP's name.
1426
1427 =item B<#private>
1428
1429 The OP's private flags, rendered with abbreviated names if possible.
1430
1431 =item B<#privval>
1432
1433 The numeric value of the OP's private flags.
1434
1435 =item B<#seq>
1436
1437 The sequence number of the OP. Note that this is a sequence number
1438 generated by B::Concise.
1439
1440 =item B<#seqnum>
1441
1442 5.8.x and earlier only. 5.9 and later do not provide this.
1443
1444 The real sequence number of the OP, as a regular number and not adjusted
1445 to be relative to the start of the real program. (This will generally be
1446 a fairly large number because all of B<B::Concise> is compiled before
1447 your program is).
1448
1449 =item B<#opt>
1450
1451 Whether or not the op has been optimised by the peephole optimiser.
1452
1453 Only available in 5.9 and later.
1454
1455 =item B<#static>
1456
1457 Whether or not the op is statically defined.  This flag is used by the
1458 B::C compiler backend and indicates that the op should not be freed.
1459
1460 Only available in 5.9 and later.
1461
1462 =item B<#sibaddr>
1463
1464 The address of the OP's next youngest sibling, in hexadecimal.
1465
1466 =item B<#svaddr>
1467
1468 The address of the OP's SV, if it has an SV, in hexadecimal.
1469
1470 =item B<#svclass>
1471
1472 The class of the OP's SV, if it has one, in all caps (e.g., 'IV').
1473
1474 =item B<#svval>
1475
1476 The value of the OP's SV, if it has one, in a short human-readable format.
1477
1478 =item B<#targ>
1479
1480 The numeric value of the OP's targ.
1481
1482 =item B<#targarg>
1483
1484 The name of the variable the OP's targ refers to, if any, otherwise the
1485 letter t followed by the OP's targ in decimal.
1486
1487 =item B<#targarglife>
1488
1489 Same as B<#targarg>, but followed by the COP sequence numbers that delimit
1490 the variable's lifetime (or 'end' for a variable in an open scope) for a
1491 variable.
1492
1493 =item B<#typenum>
1494
1495 The numeric value of the OP's type, in decimal.
1496
1497 =back
1498
1499 =head1 One-Liner Command tips
1500
1501 =over 4
1502
1503 =item perl -MO=Concise,bar foo.pl
1504
1505 Renders only bar() from foo.pl.  To see main, drop the ',bar'.  To see
1506 both, add ',-main'
1507
1508 =item perl -MDigest::MD5=md5 -MO=Concise,md5 -e1
1509
1510 Identifies md5 as an XS function.  The export is needed so that BC can
1511 find it in main.
1512
1513 =item perl -MPOSIX -MO=Concise,_POSIX_ARG_MAX -e1
1514
1515 Identifies _POSIX_ARG_MAX as a constant sub, optimized to an IV.
1516 Although POSIX isn't entirely consistent across platforms, this is
1517 likely to be present in virtually all of them.
1518
1519 =item perl -MPOSIX -MO=Concise,a -e 'print _POSIX_SAVED_IDS'
1520
1521 This renders a print statement, which includes a call to the function.
1522 It's identical to rendering a file with a use call and that single
1523 statement, except for the filename which appears in the nextstate ops.
1524
1525 =item perl -MPOSIX -MO=Concise,a -e 'sub a{_POSIX_SAVED_IDS}'
1526
1527 This is B<very> similar to previous, only the first two ops differ.  This
1528 subroutine rendering is more representative, insofar as a single main
1529 program will have many subs.
1530
1531
1532
1533 =head1 Using B::Concise outside of the O framework
1534
1535 The common (and original) usage of B::Concise was for command-line
1536 renderings of simple code, as given in EXAMPLE.  But you can also use
1537 B<B::Concise> from your code, and call compile() directly, and
1538 repeatedly.  By doing so, you can avoid the compile-time only
1539 operation of O.pm, and even use the debugger to step through
1540 B::Concise::compile() itself.
1541
1542 Once you're doing this, you may alter Concise output by adding new
1543 rendering styles, and by optionally adding callback routines which
1544 populate new variables, if such were referenced from those (just
1545 added) styles.
1546
1547 =head2 Example: Altering Concise Renderings
1548
1549     use B::Concise qw(set_style add_callback);
1550     add_style($yourStyleName => $defaultfmt, $gotofmt, $treefmt);
1551     add_callback
1552       ( sub {
1553             my ($h, $op, $format, $level, $stylename) = @_;
1554             $h->{variable} = some_func($op);
1555         });
1556     $walker = B::Concise::compile(@options,@subnames,@subrefs);
1557     $walker->();
1558
1559 =head2 set_style()
1560
1561 B<set_style> accepts 3 arguments, and updates the three format-specs
1562 comprising a line-style (basic-exec, goto, tree).  It has one minor
1563 drawback though; it doesn't register the style under a new name.  This
1564 can become an issue if you render more than once and switch styles.
1565 Thus you may prefer to use add_style() and/or set_style_standard()
1566 instead.
1567
1568 =head2 set_style_standard($name)
1569
1570 This restores one of the standard line-styles: C<terse>, C<concise>,
1571 C<linenoise>, C<debug>, C<env>, into effect.  It also accepts style
1572 names previously defined with add_style().
1573
1574 =head2 add_style()
1575
1576 This subroutine accepts a new style name and three style arguments as
1577 above, and creates, registers, and selects the newly named style.  It is
1578 an error to re-add a style; call set_style_standard() to switch between
1579 several styles.
1580
1581 =head2 add_callback()
1582
1583 If your newly minted styles refer to any new #variables, you'll need
1584 to define a callback subroutine that will populate (or modify) those
1585 variables.  They are then available for use in the style you've
1586 chosen.
1587
1588 The callbacks are called for each opcode visited by Concise, in the
1589 same order as they are added.  Each subroutine is passed five
1590 parameters.
1591
1592   1. A hashref, containing the variable names and values which are
1593      populated into the report-line for the op
1594   2. the op, as a B<B::OP> object
1595   3. a reference to the format string
1596   4. the formatting (indent) level
1597   5. the selected stylename
1598
1599 To define your own variables, simply add them to the hash, or change
1600 existing values if you need to.  The level and format are passed in as
1601 references to scalars, but it is unlikely that they will need to be
1602 changed or even used.
1603
1604 =head2 Running B::Concise::compile()
1605
1606 B<compile> accepts options as described above in L</OPTIONS>, and
1607 arguments, which are either coderefs, or subroutine names.
1608
1609 It constructs and returns a $treewalker coderef, which when invoked,
1610 traverses, or walks, and renders the optrees of the given arguments to
1611 STDOUT.  You can reuse this, and can change the rendering style used
1612 each time; thereafter the coderef renders in the new style.
1613
1614 B<walk_output> lets you change the print destination from STDOUT to
1615 another open filehandle, or into a string passed as a ref (unless
1616 you've built perl with -Uuseperlio).
1617
1618     my $walker = B::Concise::compile('-terse','aFuncName', \&aSubRef);  # 1
1619     walk_output(\my $buf);
1620     $walker->();                        # 1 renders -terse
1621     set_style_standard('concise');      # 2
1622     $walker->();                        # 2 renders -concise
1623     $walker->(@new);                    # 3 renders whatever
1624     print "3 different renderings: terse, concise, and @new: $buf\n";
1625
1626 When $walker is called, it traverses the subroutines supplied when it
1627 was created, and renders them using the current style.  You can change
1628 the style afterwards in several different ways:
1629
1630   1. call C<compile>, altering style or mode/order
1631   2. call C<set_style_standard>
1632   3. call $walker, passing @new options
1633
1634 Passing new options to the $walker is the easiest way to change
1635 amongst any pre-defined styles (the ones you add are automatically
1636 recognized as options), and is the only way to alter rendering order
1637 without calling compile again.  Note however that rendering state is
1638 still shared amongst multiple $walker objects, so they must still be
1639 used in a coordinated manner.
1640
1641 =head2 B::Concise::reset_sequence()
1642
1643 This function (not exported) lets you reset the sequence numbers (note
1644 that they're numbered arbitrarily, their goal being to be human
1645 readable).  Its purpose is mostly to support testing, i.e. to compare
1646 the concise output from two identical anonymous subroutines (but
1647 different instances).  Without the reset, B::Concise, seeing that
1648 they're separate optrees, generates different sequence numbers in
1649 the output.
1650
1651 =head2 Errors
1652
1653 Errors in rendering (non-existent function-name, non-existent coderef)
1654 are written to the STDOUT, or wherever you've set it via
1655 walk_output().
1656
1657 Errors using the various *style* calls, and bad args to walk_output(),
1658 result in die().  Use an eval if you wish to catch these errors and
1659 continue processing.
1660
1661 =head1 AUTHOR
1662
1663 Stephen McCamant, E<lt>smcc@CSUA.Berkeley.EDUE<gt>.
1664
1665 =cut