This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add a few helpers to B for INVLIST
[perl5.git] / ext / B / B.pm
1 #      B.pm
2 #
3 #      Copyright (c) 1996, 1997, 1998 Malcolm Beattie
4 #
5 #      You may distribute under the terms of either the GNU General Public
6 #      License or the Artistic License, as specified in the README file.
7 #
8 package B;
9
10 @B::ISA = qw(Exporter);
11
12 # If B is loaded without imports, we do not want to unnecessarily pollute the stash with Exporter.
13 sub import {
14     return unless scalar @_ > 1; # Called as a method call.
15     require Exporter;
16     B->export_to_level(1, @_);
17 }
18
19 # walkoptree_slow comes from B.pm (you are there),
20 # walkoptree comes from B.xs
21
22 BEGIN {
23     $B::VERSION = '1.82';
24     @B::EXPORT_OK = ();
25
26     # Our BOOT code needs $VERSION set, and will append to @EXPORT_OK.
27     # Want our constants loaded before the compiler meets OPf_KIDS below, as
28     # the combination of having the constant stay a Proxy Constant Subroutine
29     # and its value being inlined saves a little over .5K
30
31     require XSLoader;
32     XSLoader::load();
33 }
34
35 push @B::EXPORT_OK, (qw(minus_c ppname save_BEGINs
36                         class peekop cast_I32 cstring cchar hash threadsv_names
37                         main_root main_start main_cv svref_2object opnumber
38                         sub_generation amagic_generation perlstring
39                         walkoptree_slow walkoptree walkoptree_exec walksymtable
40                         parents comppadlist sv_undef compile_stats timing_info
41                         begin_av init_av check_av end_av regex_padav dowarn
42                         defstash curstash warnhook diehook inc_gv @optype
43                         @specialsv_name unitcheck_av safename));
44
45 @B::SV::ISA = 'B::OBJECT';
46 @B::NULL::ISA = 'B::SV';
47 @B::PV::ISA = 'B::SV';
48 @B::IV::ISA = 'B::SV';
49 @B::NV::ISA = 'B::SV';
50 # RV is eliminated with 5.11.0, but effectively is a specialisation of IV now.
51 @B::RV::ISA = 'B::IV';
52 @B::PVIV::ISA = qw(B::PV B::IV);
53 @B::PVNV::ISA = qw(B::PVIV B::NV);
54 @B::PVMG::ISA = 'B::PVNV';
55 @B::REGEXP::ISA = 'B::PVMG';
56 @B::INVLIST::ISA = 'B::PV';
57 @B::PVLV::ISA = 'B::GV';
58 @B::BM::ISA = 'B::GV';
59 @B::AV::ISA = 'B::PVMG';
60 @B::GV::ISA = 'B::PVMG';
61 @B::HV::ISA = 'B::PVMG';
62 @B::CV::ISA = 'B::PVMG';
63 @B::IO::ISA = 'B::PVMG';
64 @B::FM::ISA = 'B::CV';
65
66 @B::OP::ISA = 'B::OBJECT';
67 @B::UNOP::ISA = 'B::OP';
68 @B::UNOP_AUX::ISA = 'B::UNOP';
69 @B::BINOP::ISA = 'B::UNOP';
70 @B::LOGOP::ISA = 'B::UNOP';
71 @B::LISTOP::ISA = 'B::BINOP';
72 @B::SVOP::ISA = 'B::OP';
73 @B::PADOP::ISA = 'B::OP';
74 @B::PVOP::ISA = 'B::OP';
75 @B::LOOP::ISA = 'B::LISTOP';
76 @B::PMOP::ISA = 'B::LISTOP';
77 @B::COP::ISA = 'B::OP';
78 @B::METHOP::ISA = 'B::OP';
79
80 @B::SPECIAL::ISA = 'B::OBJECT';
81
82 our @optype = qw(OP UNOP BINOP LOGOP LISTOP PMOP SVOP PADOP PVOP LOOP COP
83                 METHOP UNOP_AUX);
84 # bytecode.pl contained the following comment:
85 # Nullsv *must* come first in the following so that the condition
86 # ($$sv == 0) can continue to be used to test (sv == Nullsv).
87 our @specialsv_name = qw(Nullsv &PL_sv_undef &PL_sv_yes &PL_sv_no
88                         (SV*)pWARN_ALL (SV*)pWARN_NONE (SV*)pWARN_STD
89                         &PL_sv_zero);
90
91 {
92     # Stop "-w" from complaining about the lack of a real B::OBJECT class
93     package B::OBJECT;
94 }
95
96 sub B::GV::SAFENAME {
97   safename(shift()->NAME);
98 }
99
100 sub safename {
101   my $name = shift;
102
103   # The regex below corresponds to the isCONTROLVAR macro
104   # from toke.c
105
106   $name =~ s/^\c?/^?/
107     or $name =~ s/^([\cA-\cZ\c\\c[\c]\c_\c^])/
108                 "^" .  chr( utf8::unicode_to_native( 64 ^ ord($1) ))/e;
109
110   # When we say unicode_to_native we really mean ascii_to_native,
111   # which matters iff this is a non-ASCII platform (EBCDIC).  '\c?' would
112   # not have to be special cased, except for non-ASCII.
113
114   return $name;
115 }
116
117 sub B::IV::int_value {
118   my ($self) = @_;
119   return (($self->FLAGS() & SVf_IVisUV()) ? $self->UVX : $self->IV);
120 }
121
122 sub B::NULL::as_string() {""}
123 *B::IV::as_string = *B::IV::as_string = \*B::IV::int_value;
124 *B::PV::as_string = *B::PV::as_string = \*B::PV::PV;
125
126 #  The input typemap checking makes no distinction between different SV types,
127 #  so the XS body will generate the same C code, despite the different XS
128 #  "types". So there is no change in behaviour from doing "newXS" like this,
129 #  compared with the old approach of having a (near) duplicate XS body.
130 #  We should fix the typemap checking.
131
132 #  Since perl 5.12.0
133 *B::IV::RV = *B::IV::RV = \*B::PV::RV;
134
135 my $debug;
136 my $op_count = 0;
137 my @parents = ();
138
139 sub debug {
140     my ($class, $value) = @_;
141     $debug = $value;
142     walkoptree_debug($value);
143 }
144
145 sub class {
146     my $obj = shift;
147     my $name = ref $obj;
148     $name =~ s/^.*:://;
149     return $name;
150 }
151
152 sub parents { \@parents }
153
154 # For debugging
155 sub peekop {
156     my $op = shift;
157     return sprintf("%s (0x%x) %s", class($op), $$op, $op->name);
158 }
159
160 sub walkoptree_slow {
161     my($op, $method, $level) = @_;
162     $op_count++; # just for statistics
163     $level ||= 0;
164     warn(sprintf("walkoptree: %d. %s\n", $level, peekop($op))) if $debug;
165     $op->$method($level) if $op->can($method);
166     if ($$op && ($op->flags & OPf_KIDS)) {
167         my $kid;
168         unshift(@parents, $op);
169         for ($kid = $op->first; $$kid; $kid = $kid->sibling) {
170             walkoptree_slow($kid, $method, $level + 1);
171         }
172         shift @parents;
173     }
174     if (class($op) eq 'PMOP'
175         && ref($op->pmreplroot)
176         && ${$op->pmreplroot}
177         && $op->pmreplroot->isa( 'B::OP' ))
178     {
179         unshift(@parents, $op);
180         walkoptree_slow($op->pmreplroot, $method, $level + 1);
181         shift @parents;
182     }
183 }
184
185 sub compile_stats {
186     return "Total number of OPs processed: $op_count\n";
187 }
188
189 sub timing_info {
190     my ($sec, $min, $hr) = localtime;
191     my ($user, $sys) = times;
192     sprintf("%02d:%02d:%02d user=$user sys=$sys",
193             $hr, $min, $sec, $user, $sys);
194 }
195
196 my %symtable;
197
198 sub clearsym {
199     %symtable = ();
200 }
201
202 sub savesym {
203     my ($obj, $value) = @_;
204 #    warn(sprintf("savesym: sym_%x => %s\n", $$obj, $value)); # debug
205     $symtable{sprintf("sym_%x", $$obj)} = $value;
206 }
207
208 sub objsym {
209     my $obj = shift;
210     return $symtable{sprintf("sym_%x", $$obj)};
211 }
212
213 sub walkoptree_exec {
214     my ($op, $method, $level) = @_;
215     $level ||= 0;
216     my ($sym, $ppname);
217     my $prefix = "    " x $level;
218     for (; $$op; $op = $op->next) {
219         $sym = objsym($op);
220         if (defined($sym)) {
221             print $prefix, "goto $sym\n";
222             return;
223         }
224         savesym($op, sprintf("%s (0x%lx)", class($op), $$op));
225         $op->$method($level);
226         $ppname = $op->name;
227         if ($ppname =~
228             /^(d?or(assign)?|and(assign)?|mapwhile|grepwhile|entertry|range|cond_expr)$/)
229         {
230             print $prefix, uc($1), " => {\n";
231             walkoptree_exec($op->other, $method, $level + 1);
232             print $prefix, "}\n";
233         } elsif ($ppname eq "match" || $ppname eq "subst") {
234             my $pmreplstart = $op->pmreplstart;
235             if ($$pmreplstart) {
236                 print $prefix, "PMREPLSTART => {\n";
237                 walkoptree_exec($pmreplstart, $method, $level + 1);
238                 print $prefix, "}\n";
239             }
240         } elsif ($ppname eq "substcont") {
241             print $prefix, "SUBSTCONT => {\n";
242             walkoptree_exec($op->other->pmreplstart, $method, $level + 1);
243             print $prefix, "}\n";
244             $op = $op->other;
245         } elsif ($ppname eq "enterloop") {
246             print $prefix, "REDO => {\n";
247             walkoptree_exec($op->redoop, $method, $level + 1);
248             print $prefix, "}\n", $prefix, "NEXT => {\n";
249             walkoptree_exec($op->nextop, $method, $level + 1);
250             print $prefix, "}\n", $prefix, "LAST => {\n";
251             walkoptree_exec($op->lastop,  $method, $level + 1);
252             print $prefix, "}\n";
253         } elsif ($ppname eq "subst") {
254             my $replstart = $op->pmreplstart;
255             if ($$replstart) {
256                 print $prefix, "SUBST => {\n";
257                 walkoptree_exec($replstart, $method, $level + 1);
258                 print $prefix, "}\n";
259             }
260         }
261     }
262 }
263
264 sub walksymtable {
265     my ($symref, $method, $recurse, $prefix) = @_;
266     my $sym;
267     my $fullname;
268     no strict 'refs';
269     $prefix = '' unless defined $prefix;
270     foreach my $sym ( sort keys %$symref ) {
271         my $dummy = $symref->{$sym}; # Copying the glob and incrementing
272                                      # the GPs refcnt clears cached methods
273         $fullname = "*main::".$prefix.$sym;
274         if ($sym =~ /::$/) {
275             $sym = $prefix . $sym;
276             if (svref_2object(\*$sym)->NAME ne "main::" && $sym ne "<none>::" && &$recurse($sym)) {
277                walksymtable(\%$fullname, $method, $recurse, $sym);
278             }
279         } else {
280            svref_2object(\*$fullname)->$method();
281         }
282     }
283 }
284
285 1;
286
287 __END__
288
289 =head1 NAME
290
291 B - The Perl Compiler Backend
292
293 =head1 SYNOPSIS
294
295         use B;
296
297 =head1 DESCRIPTION
298
299 The C<B> module supplies classes which allow a Perl program to delve
300 into its own innards.  It is the module used to implement the
301 "backends" of the Perl compiler.  Usage of the compiler does not
302 require knowledge of this module: see the F<O> module for the
303 user-visible part.  The C<B> module is of use to those who want to
304 write new compiler backends.  This documentation assumes that the
305 reader knows a fair amount about perl's internals including such
306 things as SVs, OPs and the internal symbol table and syntax tree
307 of a program.
308
309 =head1 OVERVIEW
310
311 The C<B> module contains a set of utility functions for querying the
312 current state of the Perl interpreter; typically these functions
313 return objects from the B::SV and B::OP classes, or their derived
314 classes.  These classes in turn define methods for querying the
315 resulting objects about their own internal state.
316
317 =head1 Utility Functions
318
319 The C<B> module exports a variety of functions: some are simple
320 utility functions, others provide a Perl program with a way to
321 get an initial "handle" on an internal object.
322
323 =head2 Functions Returning C<B::SV>, C<B::AV>, C<B::HV>, and C<B::CV> objects
324
325 For descriptions of the class hierarchy of these objects and the
326 methods that can be called on them, see below, L<"OVERVIEW OF
327 CLASSES"> and L<"SV-RELATED CLASSES">.
328
329 =over 4
330
331 =item sv_undef
332
333 Returns the SV object corresponding to the C variable C<sv_undef>.
334
335 =item sv_yes
336
337 Returns the SV object corresponding to the C variable C<sv_yes>.
338
339 =item sv_no
340
341 Returns the SV object corresponding to the C variable C<sv_no>.
342
343 =item svref_2object(SVREF)
344
345 Takes a reference to any Perl value, and turns the referred-to value
346 into an object in the appropriate B::OP-derived or B::SV-derived
347 class.  Apart from functions such as C<main_root>, this is the primary
348 way to get an initial "handle" on an internal perl data structure
349 which can then be followed with the other access methods.
350
351 The returned object will only be valid as long as the underlying OPs
352 and SVs continue to exist.  Do not attempt to use the object after the
353 underlying structures are freed.
354
355 =item amagic_generation
356
357 Returns the SV object corresponding to the C variable C<amagic_generation>.
358 As of Perl 5.18, this is just an alias to C<PL_na>, so its value is
359 meaningless.
360
361 =item init_av
362
363 Returns the AV object (i.e. in class B::AV) representing INIT blocks.
364
365 =item check_av
366
367 Returns the AV object (i.e. in class B::AV) representing CHECK blocks.
368
369 =item unitcheck_av
370
371 Returns the AV object (i.e. in class B::AV) representing UNITCHECK blocks.
372
373 =item begin_av
374
375 Returns the AV object (i.e. in class B::AV) representing BEGIN blocks.
376
377 =item end_av
378
379 Returns the AV object (i.e. in class B::AV) representing END blocks.
380
381 =item comppadlist
382
383 Returns the PADLIST object (i.e. in class B::PADLIST) of the global
384 comppadlist.  In Perl 5.16 and earlier it returns an AV object (class
385 B::AV).
386
387 =item regex_padav
388
389 Only when perl was compiled with ithreads.
390
391 =item main_cv
392
393 Return the (faked) CV corresponding to the main part of the Perl
394 program.
395
396 =back
397
398 =head2 Functions for Examining the Symbol Table
399
400 =over 4
401
402 =item walksymtable(SYMREF, METHOD, RECURSE, PREFIX)
403
404 Walk the symbol table starting at SYMREF and call METHOD on each
405 symbol (a B::GV object) visited.  When the walk reaches package
406 symbols (such as "Foo::") it invokes RECURSE, passing in the symbol
407 name, and only recurses into the package if that sub returns true.
408
409 PREFIX is the name of the SYMREF you're walking.
410
411 For example:
412
413   # Walk CGI's symbol table calling print_subs on each symbol.
414   # Recurse only into CGI::Util::
415   walksymtable(\%CGI::, 'print_subs',
416                sub { $_[0] eq 'CGI::Util::' }, 'CGI::');
417
418 print_subs() is a B::GV method you have declared.  Also see L<"B::GV
419 Methods">, below.
420
421 =back
422
423 =head2 Functions Returning C<B::OP> objects or for walking op trees
424
425 For descriptions of the class hierarchy of these objects and the
426 methods that can be called on them, see below, L<"OVERVIEW OF
427 CLASSES"> and L<"OP-RELATED CLASSES">.
428
429 =over 4
430
431 =item main_root
432
433 Returns the root op (i.e. an object in the appropriate B::OP-derived
434 class) of the main part of the Perl program.
435
436 =item main_start
437
438 Returns the starting op of the main part of the Perl program.
439
440 =item walkoptree(OP, METHOD)
441
442 Does a tree-walk of the syntax tree based at OP and calls METHOD on
443 each op it visits.  Each node is visited before its children.  If
444 C<walkoptree_debug> (see below) has been called to turn debugging on then
445 the method C<walkoptree_debug> is called on each op before METHOD is
446 called.
447
448 =item walkoptree_debug(DEBUG)
449
450 Returns the current debugging flag for C<walkoptree>.  If the optional
451 DEBUG argument is non-zero, it sets the debugging flag to that.  See
452 the description of C<walkoptree> above for what the debugging flag
453 does.
454
455 =back
456
457 =head2 Miscellaneous Utility Functions
458
459 =over 4
460
461 =item ppname(OPNUM)
462
463 Return the PP function name (e.g. "pp_add") of op number OPNUM.
464
465 =item hash(STR)
466
467 Returns a string in the form "0x..." representing the value of the
468 internal hash function used by perl on string STR.
469
470 =item cast_I32(I)
471
472 Casts I to the internal I32 type used by that perl.
473
474 =item minus_c
475
476 Does the equivalent of the C<-c> command-line option.  Obviously, this
477 is only useful in a BEGIN block or else the flag is set too late.
478
479 =item cstring(STR)
480
481 Returns a double-quote-surrounded escaped version of STR which can
482 be used as a string in C source code.
483
484 =item perlstring(STR)
485
486 Returns a double-quote-surrounded escaped version of STR which can
487 be used as a string in Perl source code.
488
489 =item safename(STR)
490
491 This function returns the string with the first character modified if it
492 is a control character.  It converts it to ^X format first, so that "\cG"
493 becomes "^G".  This is used internally by L<B::GV::SAFENAME|/SAFENAME>, but
494 you can call it directly.
495
496 =item class(OBJ)
497
498 Returns the class of an object without the part of the classname
499 preceding the first C<"::">.  This is used to turn C<"B::UNOP"> into
500 C<"UNOP"> for example.
501
502 =item threadsv_names
503
504 This used to provide support for the old 5.005 threading module. It now
505 does nothing.
506
507 =back
508
509 =head2 Exported utility variables
510
511 =over 4
512
513 =item @optype
514
515   my $op_type = $optype[$op_type_num];
516
517 A simple mapping of the op type number to its type (like 'COP' or 'BINOP').
518
519 =item @specialsv_name
520
521   my $sv_name = $specialsv_name[$sv_index];
522
523 Certain SV types are considered 'special'.  They're represented by
524 B::SPECIAL and are referred to by a number from the specialsv_list.
525 This array maps that number back to the name of the SV (like 'Nullsv'
526 or '&PL_sv_undef').
527
528 =back
529
530
531 =head1 OVERVIEW OF CLASSES
532
533 The C structures used by Perl's internals to hold SV and OP
534 information (PVIV, AV, HV, ..., OP, SVOP, UNOP, ...) are modelled on a
535 class hierarchy and the C<B> module gives access to them via a true
536 object hierarchy.  Structure fields which point to other objects
537 (whether types of SV or types of OP) are represented by the C<B>
538 module as Perl objects of the appropriate class.
539
540 The bulk of the C<B> module is the methods for accessing fields of
541 these structures.
542
543 Note that all access is read-only.  You cannot modify the internals by
544 using this module.  Also, note that the B::OP and B::SV objects created
545 by this module are only valid for as long as the underlying objects
546 exist; their creation doesn't increase the reference counts of the
547 underlying objects.  Trying to access the fields of a freed object will
548 give incomprehensible results, or worse.
549
550 =head2 SV-RELATED CLASSES
551
552 B::IV, B::NV, B::PV, B::PVIV, B::PVNV, B::PVMG,
553 B::PVLV, B::AV, B::HV, B::CV, B::GV, B::FM, B::IO.  These classes
554 correspond in the obvious way to the underlying C structures of similar names.
555 The inheritance hierarchy mimics the underlying C "inheritance":
556
557                            B::SV
558                              |
559                 +------------+------------+
560                 |            |            |
561               B::PV        B::IV        B::NV
562                /  \         /           /
563               /    \       /           /
564         B::INVLIST  B::PVIV           /
565                          \           /
566                           \         /
567                            \       /
568                             B::PVNV
569                                |
570                                |
571                             B::PVMG
572                                |
573            +-------+-------+---+---+-------+-------+
574            |       |       |       |       |       |
575          B::AV   B::GV   B::HV   B::CV   B::IO B::REGEXP
576                    |               |
577                    |               |
578                 B::PVLV          B::FM
579
580
581 Access methods correspond to the underlying C macros for field access,
582 usually with the leading "class indication" prefix removed (Sv, Av,
583 Hv, ...).  The leading prefix is only left in cases where its removal
584 would cause a clash in method name.  For example, C<GvREFCNT> stays
585 as-is since its abbreviation would clash with the "superclass" method
586 C<REFCNT> (corresponding to the C function C<SvREFCNT>).
587
588 =head2 B::SV Methods
589
590 =over 4
591
592 =item REFCNT
593
594 =item FLAGS
595
596 =item object_2svref
597
598 Returns a reference to the regular scalar corresponding to this
599 B::SV object.  In other words, this method is the inverse operation
600 to the svref_2object() subroutine.  This scalar and other data it points
601 at should be considered read-only: modifying them is neither safe nor
602 guaranteed to have a sensible effect.
603
604 =back
605
606 =head2 B::IV Methods
607
608 =over 4
609
610 =item IV
611
612 Returns the value of the IV, I<interpreted as
613 a signed integer>.  This will be misleading
614 if C<FLAGS & SVf_IVisUV>.  Perhaps you want the
615 C<int_value> method instead?
616
617 =item IVX
618
619 =item UVX
620
621 =item int_value
622
623 This method returns the value of the IV as an integer.
624 It differs from C<IV> in that it returns the correct
625 value regardless of whether it's stored signed or
626 unsigned.
627
628 =item needs64bits
629
630 =item packiv
631
632 =back
633
634 =head2 B::NV Methods
635
636 =over 4
637
638 =item NV
639
640 =item NVX
641
642 =item COP_SEQ_RANGE_LOW
643
644 =item COP_SEQ_RANGE_HIGH
645
646 These last two are only valid for pad name SVs.  They only existed in the
647 B::NV class before Perl 5.22.  In 5.22 they were moved to the B::PADNAME
648 class.
649
650 =back
651
652 =head2 B::RV Methods
653
654 =over 4
655
656 =item RV
657
658 =back
659
660 =head2 B::PV Methods
661
662 =over 4
663
664 =item PV
665
666 This method is the one you usually want.  It constructs a
667 string using the length and offset information in the struct:
668 for ordinary scalars it will return the string that you'd see
669 from Perl, even if it contains null characters.
670
671 =item RV
672
673 Same as B::RV::RV, except that it will die() if the PV isn't
674 a reference.
675
676 =item PVX
677
678 This method is less often useful.  It assumes that the string
679 stored in the struct is null-terminated, and disregards the
680 length information.
681
682 It is the appropriate method to use if you need to get the name
683 of a lexical variable from a padname array.  Lexical variable names
684 are always stored with a null terminator, and the length field
685 (CUR) is overloaded for other purposes and can't be relied on here.
686
687 =item CUR
688
689 This method returns the internal length field, which consists of the number
690 of internal bytes, not necessarily the number of logical characters.
691
692 =item LEN
693
694 This method returns the number of bytes allocated (via malloc) for storing
695 the string.  This is 0 if the scalar does not "own" the string.
696
697 =back
698
699 =head2 B::PVMG Methods
700
701 =over 4
702
703 =item MAGIC
704
705 =item SvSTASH
706
707 =back
708
709 =head2 B::MAGIC Methods
710
711 =over 4
712
713 =item MOREMAGIC
714
715 =item precomp
716
717 Only valid on r-magic, returns the string that generated the regexp.
718
719 =item PRIVATE
720
721 =item TYPE
722
723 =item FLAGS
724
725 =item OBJ
726
727 Will die() if called on r-magic.
728
729 =item PTR
730
731 =item REGEX
732
733 Only valid on r-magic, returns the integer value of the REGEX stored
734 in the MAGIC.
735
736 =back
737
738 =head2 B::INVLIST Methods
739
740 =over 4
741
742 =item prev_index
743
744 Returns the cache result of previous invlist_search() (internal usage)
745
746 =item is_offset
747
748 Returns a boolean value (0 or 1) to know if the invlist is using an offset.
749 When false the list begins with the code point U+0000.
750 When true the list begins with the following elements.
751
752 =item array_len
753
754 Returns an integer with the size of the array used to define the invlist.
755
756 =item get_invlist_array
757
758 This method returns a list of integers representing the array used by the
759 invlist.
760 Note: this cannot be used while in middle of iterating on an invlist and croaks.
761
762 =back
763
764 =head2 B::PVLV Methods
765
766 =over 4
767
768 =item TARGOFF
769
770 =item TARGLEN
771
772 =item TYPE
773
774 =item TARG
775
776 =back
777
778 =head2 B::BM Methods
779
780 =over 4
781
782 =item USEFUL
783
784 =item PREVIOUS
785
786 =item RARE
787
788 =item TABLE
789
790 =back
791
792 =head2 B::REGEXP Methods
793
794 =over 4
795
796 =item REGEX
797
798 =item precomp
799
800 =item qr_anoncv
801
802 =item compflags
803
804 The last two were added in Perl 5.22.
805
806 =back
807
808 =head2 B::GV Methods
809
810 =over 4
811
812 =item is_empty
813
814 This method returns TRUE if the GP field of the GV is NULL.
815
816 =item NAME
817
818 =item SAFENAME
819
820 This method returns the name of the glob, but if the first
821 character of the name is a control character, then it converts
822 it to ^X first, so that *^G would return "^G" rather than "\cG".
823
824 It's useful if you want to print out the name of a variable.
825 If you restrict yourself to globs which exist at compile-time
826 then the result ought to be unambiguous, because code like
827 C<${"^G"} = 1> is compiled as two ops - a constant string and
828 a dereference (rv2gv) - so that the glob is created at runtime.
829
830 If you're working with globs at runtime, and need to disambiguate
831 *^G from *{"^G"}, then you should use the raw NAME method.
832
833 =item STASH
834
835 =item SV
836
837 =item IO
838
839 =item FORM
840
841 =item AV
842
843 =item HV
844
845 =item EGV
846
847 =item CV
848
849 =item CVGEN
850
851 =item LINE
852
853 =item FILE
854
855 =item FILEGV
856
857 =item GvREFCNT
858
859 =item FLAGS
860
861 =item GPFLAGS
862
863 This last one is present only in perl 5.22.0 and higher.
864
865 =back
866
867 =head2 B::IO Methods
868
869 B::IO objects derive from IO objects and you will get more information from
870 the IO object itself.
871
872 For example:
873
874   $gvio = B::svref_2object(\*main::stdin)->IO;
875   $IO = $gvio->object_2svref();
876   $fd = $IO->fileno();
877
878 =over 4
879
880 =item LINES
881
882 =item PAGE
883
884 =item PAGE_LEN
885
886 =item LINES_LEFT
887
888 =item TOP_NAME
889
890 =item TOP_GV
891
892 =item FMT_NAME
893
894 =item FMT_GV
895
896 =item BOTTOM_NAME
897
898 =item BOTTOM_GV
899
900 =item SUBPROCESS
901
902 =item IoTYPE
903
904 A character symbolizing the type of IO Handle.
905
906   -     STDIN/OUT
907   I     STDIN/OUT/ERR
908   <     read-only
909   >     write-only
910   a     append
911   +     read and write
912   s     socket
913   |     pipe
914   I     IMPLICIT
915   #     NUMERIC
916   space closed handle
917   \0    closed internal handle
918
919 =item IoFLAGS
920
921 =item IsSTD
922
923 Takes one argument ( 'stdin' | 'stdout' | 'stderr' ) and returns true
924 if the IoIFP of the object is equal to the handle whose name was
925 passed as argument; i.e., $io->IsSTD('stderr') is true if
926 IoIFP($io) == PerlIO_stderr().
927
928 =back
929
930 =head2 B::AV Methods
931
932 =over 4
933
934 =item FILL
935
936 =item MAX
937
938 =item ARRAY
939
940 =item ARRAYelt
941
942 Like C<ARRAY>, but takes an index as an argument to get only one element,
943 rather than a list of all of them.
944
945 =back
946
947 =head2 B::CV Methods
948
949 =over 4
950
951 =item STASH
952
953 =item START
954
955 =item ROOT
956
957 =item GV
958
959 =item FILE
960
961 =item DEPTH
962
963 =item PADLIST
964
965 Returns a B::PADLIST object.
966
967 =item OUTSIDE
968
969 =item OUTSIDE_SEQ
970
971 =item XSUB
972
973 =item XSUBANY
974
975 For constant subroutines, returns the constant SV returned by the subroutine.
976
977 =item CvFLAGS
978
979 =item const_sv
980
981 =item NAME_HEK
982
983 Returns the name of a lexical sub, otherwise C<undef>.
984
985 =back
986
987 =head2 B::HV Methods
988
989 =over 4
990
991 =item FILL
992
993 =item MAX
994
995 =item KEYS
996
997 =item RITER
998
999 =item NAME
1000
1001 =item ARRAY
1002
1003 =back
1004
1005 =head2 OP-RELATED CLASSES
1006
1007 C<B::OP>, C<B::UNOP>, C<B::UNOP_AUX>, C<B::BINOP>, C<B::LOGOP>,
1008 C<B::LISTOP>, C<B::PMOP>, C<B::SVOP>, C<B::PADOP>, C<B::PVOP>, C<B::LOOP>,
1009 C<B::COP>, C<B::METHOP>.
1010
1011 These classes correspond in the obvious way to the underlying C
1012 structures of similar names.  The inheritance hierarchy mimics the
1013 underlying C "inheritance":
1014
1015                                  B::OP
1016                                    |
1017                    +----------+---------+--------+-------+---------+
1018                    |          |         |        |       |         |
1019                 B::UNOP    B::SVOP  B::PADOP  B::COP  B::PVOP  B::METHOP
1020                    |
1021                +---+---+---------+
1022                |       |         |
1023            B::BINOP  B::LOGOP  B::UNOP_AUX
1024                |
1025                |
1026            B::LISTOP
1027                |
1028            +---+---+
1029            |       |
1030         B::LOOP   B::PMOP
1031
1032 Access methods correspond to the underlying C structure field names,
1033 with the leading "class indication" prefix (C<"op_">) removed.
1034
1035 =head2 B::OP Methods
1036
1037 These methods get the values of similarly named fields within the OP
1038 data structure.  See top of C<op.h> for more info.
1039
1040 =over 4
1041
1042 =item next
1043
1044 =item sibling
1045
1046 =item parent
1047
1048 Returns the OP's parent. If it has no parent, or if your perl wasn't built
1049 with C<-DPERL_OP_PARENT>, returns NULL.
1050
1051 Note that the global variable C<$B::OP::does_parent> is undefined on older
1052 perls that don't support the C<parent> method, is defined but false on
1053 perls that support the method but were built without  C<-DPERL_OP_PARENT>,
1054 and is true otherwise.
1055
1056 =item name
1057
1058 This returns the op name as a string (e.g. "add", "rv2av").
1059
1060 =item ppaddr
1061
1062 This returns the function name as a string (e.g. "PL_ppaddr[OP_ADD]",
1063 "PL_ppaddr[OP_RV2AV]").
1064
1065 =item desc
1066
1067 This returns the op description from the global C PL_op_desc array
1068 (e.g. "addition" "array deref").
1069
1070 =item targ
1071
1072 =item type
1073
1074 =item opt
1075
1076 =item flags
1077
1078 =item private
1079
1080 =item spare
1081
1082 =back
1083
1084 =head2 B::UNOP Method
1085
1086 =over 4
1087
1088 =item first
1089
1090 =back
1091
1092 =head2 B::UNOP_AUX Methods (since 5.22)
1093
1094 =over 4
1095
1096 =item aux_list(cv)
1097
1098 This returns a list of the elements of the op's aux data structure,
1099 or a null list if there is no aux. What will be returned depends on the
1100 object's type, but will typically be a collection of C<B::IV>, C<B::GV>,
1101 etc. objects. C<cv> is the C<B::CV> object representing the sub that the
1102 op is contained within.
1103
1104 =item string(cv)
1105
1106 This returns a textual representation of the object (likely to b useful
1107 for deparsing and debugging), or an empty string if the op type doesn't
1108 support this. C<cv> is the C<B::CV> object representing the sub that the
1109 op is contained within.
1110
1111 =back
1112
1113 =head2 B::BINOP Method
1114
1115 =over 4
1116
1117 =item last
1118
1119 =back
1120
1121 =head2 B::LOGOP Method
1122
1123 =over 4
1124
1125 =item other
1126
1127 =back
1128
1129 =head2 B::LISTOP Method
1130
1131 =over 4
1132
1133 =item children
1134
1135 =back
1136
1137 =head2 B::PMOP Methods
1138
1139 =over 4
1140
1141 =item pmreplroot
1142
1143 =item pmreplstart
1144
1145 =item pmflags
1146
1147 =item precomp
1148
1149 =item pmoffset
1150
1151 Only when perl was compiled with ithreads.
1152
1153 =item code_list
1154
1155 Since perl 5.17.1
1156
1157 =item pmregexp
1158
1159 Added in perl 5.22, this method returns the B::REGEXP associated with the
1160 op.  While PMOPs do not actually have C<pmregexp> fields under threaded
1161 builds, this method returns the regexp under threads nonetheless, for
1162 convenience.
1163
1164 =back
1165
1166 =head2 B::SVOP Methods
1167
1168 =over 4
1169
1170 =item sv
1171
1172 =item gv
1173
1174 =back
1175
1176 =head2 B::PADOP Method
1177
1178 =over 4
1179
1180 =item padix
1181
1182 =back
1183
1184 =head2 B::PVOP Method
1185
1186 =over 4
1187
1188 =item pv
1189
1190 =back
1191
1192 =head2 B::LOOP Methods
1193
1194 =over 4
1195
1196 =item redoop
1197
1198 =item nextop
1199
1200 =item lastop
1201
1202 =back
1203
1204 =head2 B::COP Methods
1205
1206 The C<B::COP> class is used for "nextstate" and "dbstate" ops.  As of Perl
1207 5.22, it is also used for "null" ops that started out as COPs.
1208
1209 =over 4
1210
1211 =item label
1212
1213 =item stash
1214
1215 =item stashpv
1216
1217 =item stashoff (threaded only)
1218
1219 =item file
1220
1221 =item cop_seq
1222
1223 =item line
1224
1225 =item warnings
1226
1227 =item io
1228
1229 =item hints
1230
1231 =item hints_hash
1232
1233 =back
1234
1235 =head2 B::METHOP Methods (Since Perl 5.22)
1236
1237 =over 4
1238
1239 =item first
1240
1241 =item meth_sv
1242
1243 =back
1244
1245 =head2 PAD-RELATED CLASSES
1246
1247 Perl 5.18 introduced a new class, B::PADLIST, returned by B::CV's
1248 C<PADLIST> method.
1249
1250 Perl 5.22 introduced the B::PADNAMELIST and B::PADNAME classes.
1251
1252 =head2 B::PADLIST Methods
1253
1254 =over 4
1255
1256 =item MAX
1257
1258 =item ARRAY
1259
1260 A list of pads.  The first one is a B::PADNAMELIST containing the names.
1261 The rest are currently B::AV objects, but that could
1262 change in future versions.
1263
1264 =item ARRAYelt
1265
1266 Like C<ARRAY>, but takes an index as an argument to get only one element,
1267 rather than a list of all of them.
1268
1269 =item NAMES
1270
1271 This method, introduced in 5.22, returns the B::PADNAMELIST.  It is
1272 equivalent to C<ARRAYelt> with a 0 argument.
1273
1274 =item REFCNT
1275
1276 =item id
1277
1278 This method, introduced in 5.22, returns an ID shared by clones of the same
1279 padlist.
1280
1281 =item outid
1282
1283 This method, also added in 5.22, returns the ID of the outer padlist.
1284
1285 =back
1286
1287 =head2 B::PADNAMELIST Methods
1288
1289 =over 4
1290
1291 =item MAX
1292
1293 =item ARRAY
1294
1295 =item ARRAYelt
1296
1297 These two methods return the pad names, using B::SPECIAL objects for null
1298 pointers and B::PADNAME objects otherwise.
1299
1300 =item REFCNT
1301
1302 =back
1303
1304 =head2 B::PADNAME Methods
1305
1306 =over 4
1307
1308 =item PV
1309
1310 =item PVX
1311
1312 =item LEN
1313
1314 =item REFCNT
1315
1316 =item FLAGS
1317
1318 For backward-compatibility, if the PADNAMEt_OUTER flag is set, the FLAGS
1319 method adds the SVf_FAKE flag, too.
1320
1321 =item TYPE
1322
1323 A B::HV object representing the stash for a typed lexical.
1324
1325 =item SvSTASH
1326
1327 A backward-compatibility alias for TYPE.
1328
1329 =item OURSTASH
1330
1331 A B::HV object representing the stash for 'our' variables.
1332
1333 =item PROTOCV
1334
1335 The prototype CV for a 'my' sub.
1336
1337 =item COP_SEQ_RANGE_LOW
1338
1339 =item COP_SEQ_RANGE_HIGH
1340
1341 Sequence numbers representing the scope within which a lexical is visible.
1342 Meaningless if PADNAMEt_OUTER is set.
1343
1344 =item PARENT_PAD_INDEX
1345
1346 Only meaningful if PADNAMEt_OUTER is set.
1347
1348 =item PARENT_FAKELEX_FLAGS
1349
1350 Only meaningful if PADNAMEt_OUTER is set.
1351
1352 =back
1353
1354 =head2 $B::overlay
1355
1356 Although the optree is read-only, there is an overlay facility that allows
1357 you to override what values the various B::*OP methods return for a
1358 particular op. C<$B::overlay> should be set to reference a two-deep hash:
1359 indexed by OP address, then method name. Whenever a an op method is
1360 called, the value in the hash is returned if it exists. This facility is
1361 used by B::Deparse to "undo" some optimisations. For example:
1362
1363
1364     local $B::overlay = {};
1365     ...
1366     if ($op->name eq "foo") {
1367         $B::overlay->{$$op} = {
1368                 name => 'bar',
1369                 next => $op->next->next,
1370         };
1371     }
1372     ...
1373     $op->name # returns "bar"
1374     $op->next # returns the next op but one
1375
1376
1377 =head1 AUTHOR
1378
1379 Malcolm Beattie, C<mbeattie@sable.ox.ac.uk>
1380
1381 =cut