Re: Réf. : Re: PATCH proposal for ext/Safe/safe2.t

[perl5.git] / bytecode.pl

diff --git a/bytecode.pl b/bytecode.pl
index 89536ae..9315739 100644 (file)
--- a/bytecode.pl
+++ b/bytecode.pl
@@ -44,6 +44,9 @@ unlink "ext/ByteLoader/byterun.c", "ext/ByteLoader/byterun.h", "ext/B/B/Asmdata.
 open(ASMDATA_PM, ">ext/B/B/Asmdata.pm") or die "ext/B/B/Asmdata.pm: $!";
 print ASMDATA_PM $perl_header, <<'EOT';
 package B::Asmdata;
+
+our $VERSION = '1.00';
+
 use Exporter;
 @ISA = qw(Exporter);
 @EXPORT_OK = qw(%insn_data @insn_name @optype @specialsv_name);
@@ -109,7 +112,7 @@ byterun(pTHX_ register struct byteloader_state *bstate)
 
 EOT
 
-for (my $i = 0; $i < @specialsv; $i++) {
+for my $i ( 0 .. $#specialsv ) {
     print BYTERUN_C "    specialsv_list[$i] = $specialsv[$i];\n";
 }
 
@@ -209,7 +212,7 @@ EOT
 
 my $add_enum_value = 0;
 my $max_insn;
-for ($i = 0; $i < @insn_name; $i++) {
+for $i ( 0 .. $#insn_name ) {
     $insn = uc($insn_name[$i]);
     if (defined($insn)) {
        $max_insn = $i;
@@ -254,11 +257,53 @@ B::Asmdata - Autogenerated data about Perl ops, used to generate bytecode
 
 =head1 SYNOPSIS
 
-       use Asmdata;
+       use B::Asmdata qw(%insn_data @insn_name @optype @specialsv_name);
 
 =head1 DESCRIPTION
 
-See F<ext/B/B/Asmdata.pm>.
+Provides information about Perl ops in order to generate bytecode via
+a bunch of exported variables.  Its mostly used by B::Assembler and
+B::Disassembler.
+
+=over 4
+
+=item %insn_data
+
+  my($bytecode_num, $put_sub, $get_meth) = @$insn_data{$op_name};
+
+For a given $op_name (for example, 'cop_label', 'sv_flags', etc...) 
+you get an array ref containing the bytecode number of the op, a
+reference to the subroutine used to 'PUT', and the name of the method
+used to 'GET'.
+
+=for _private
+Add more detail about what $put_sub and $get_meth are and how to use them.
+
+=item @insn_name
+
+  my $op_name = $insn_name[$bytecode_num];
+
+A simple mapping of the bytecode number to the name of the op.
+Suitable for using with %insn_data like so:
+
+  my $op_info = $insn_data{$insn_name[$bytecode_num]};
+
+=item @optype
+
+  my $op_type = $optype[$op_type_num];
+
+A simple mapping of the op type number to its type (like 'COP' or 'BINOP').
+
+=item @specialsv_name
+
+  my $sv_name = $specialsv_name[$sv_index];
+
+Certain SV types are considered 'special'.  They're represented by
+B::SPECIAL and are refered to by a number from the specialsv_list.
+This array maps that number back to the name of the SV (like 'Nullsv'
+or '&PL_sv_undef').
+
+=back
 
 =head1 AUTHOR
 
@@ -309,11 +354,11 @@ xlv_type  LvTYPE(bstate->bs_sv)                   char
 xbm_useful     BmUSEFUL(bstate->bs_sv)                 I32
 xbm_previous   BmPREVIOUS(bstate->bs_sv)               U16
 xbm_rare       BmRARE(bstate->bs_sv)                   U8
-xfm_lines      FmLINES(bstate->bs_sv)                  I32
-xio_lines      IoLINES(bstate->bs_sv)                  long
-xio_page       IoPAGE(bstate->bs_sv)                   long
-xio_page_len   IoPAGE_LEN(bstate->bs_sv)               long
-xio_lines_left IoLINES_LEFT(bstate->bs_sv)             long
+xfm_lines      FmLINES(bstate->bs_sv)                  IV
+xio_lines      IoLINES(bstate->bs_sv)                  IV
+xio_page       IoPAGE(bstate->bs_sv)                   IV
+xio_page_len   IoPAGE_LEN(bstate->bs_sv)               IV
+xio_lines_left IoLINES_LEFT(bstate->bs_sv)             IV
 xio_top_name   IoTOP_NAME(bstate->bs_sv)               pvcontents
 xio_top_gv     *(SV**)&IoTOP_GV(bstate->bs_sv)         svindex
 xio_fmt_name   IoFMT_NAME(bstate->bs_sv)               pvcontents