This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Re├źnable qr caching for (??{}) retval where possible
[perl5.git] / regen / mg_vtable.pl
index 6322b8b..0bbfbfd 100644 (file)
@@ -2,9 +2,14 @@
 #
 # Regenerate (overwriting only if changed):
 #
 #
 # Regenerate (overwriting only if changed):
 #
+#    mg_names.c
+#    mg_raw.h
 #    mg_vtable.h
 #    mg_vtable.h
+#    pod/perlguts.pod
 #
 #
-# from information stored in this file.
+# from information stored in this file.  pod/perlguts.pod is not completely
+# regenerated.  Only the magic table is replaced; the other parts remain
+# untouched.
 #
 # Accepts the standard regen_lib -q and -v args.
 #
 #
 # Accepts the standard regen_lib -q and -v args.
 #
@@ -18,10 +23,97 @@ BEGIN {
     require 'regen/regen_lib.pl';
 }
 
     require 'regen/regen_lib.pl';
 }
 
+my %mg =
+    (
+     sv => { char => '\0', vtable => 'sv', readonly_acceptable => 1,
+            desc => 'Special scalar variable' },
+     # overload, or type "A" magic, used to be here.  Hence overloaded is
+     # often called AMAGIC internally, even though it does not use "A"
+     # magic any more.
+     overload_table => { char => 'c', vtable => 'ovrld',
+                        desc => 'Holds overload table (AMT) on stash' },
+     bm => { char => 'B', vtable => 'regexp', value_magic => 1,
+            readonly_acceptable => 1,
+            desc => 'Boyer-Moore (fast string search)' },
+     regdata => { char => 'D', vtable => 'regdata',
+                 desc => "Regex match position data\n(\@+ and \@- vars)" },
+     regdatum => { char => 'd', vtable => 'regdatum',
+                  desc => 'Regex match position data element' },
+     env => { char => 'E', vtable => 'env', desc => '%ENV hash' },
+     envelem => { char => 'e', vtable => 'envelem',
+                 desc => '%ENV hash element' },
+     fm => { char => 'f', vtable => 'regexp', value_magic => 1,
+            readonly_acceptable => 1, desc => "Formline ('compiled' format)" },
+     regex_global => { char => 'g', vtable => 'mglob', value_magic => 1,
+                      readonly_acceptable => 1, desc => 'm//g target' },
+     hints => { char => 'H', vtable => 'hints', desc => '%^H hash' },
+     hintselem => { char => 'h', vtable => 'hintselem',
+                   desc => '%^H hash element' },
+     isa => { char => 'I', vtable => 'isa', desc => '@ISA array' },
+     isaelem => { char => 'i', vtable => 'isaelem',
+                 desc => '@ISA array element' },
+     nkeys => { char => 'k', vtable => 'nkeys', value_magic => 1,
+               desc => 'scalar(keys()) lvalue' },
+     dbfile => { char => 'L',
+                desc => 'Debugger %_<filename' },
+     dbline => { char => 'l', vtable => 'dbline',
+                desc => 'Debugger %_<filename element' },
+     shared => { char => 'N', desc => 'Shared between threads',
+                unknown_to_sv_magic => 1 },
+     shared_scalar => { char => 'n', desc => 'Shared between threads',
+                       unknown_to_sv_magic => 1 },
+     collxfrm => { char => 'o', vtable => 'collxfrm', value_magic => 1,
+                  desc => 'Locale transformation' },
+     tied => { char => 'P', vtable => 'pack',
+              value_magic => 1, # treat as value, so 'local @tied' isn't tied
+              desc => 'Tied array or hash' },
+     tiedelem => { char => 'p', vtable => 'packelem',
+                  desc => 'Tied array or hash element' },
+     tiedscalar => { char => 'q', vtable => 'packelem',
+                    desc => 'Tied scalar or handle' },
+     qr => { char => 'r', vtable => 'regexp', value_magic => 1, 
+            readonly_acceptable => 1, desc => 'precompiled qr// regex' },
+     sig => { char => 'S', desc => '%SIG hash' },
+     sigelem => { char => 's', vtable => 'sigelem',
+                 desc => '%SIG hash element' },
+     taint => { char => 't', vtable => 'taint', value_magic => 1,
+               desc => 'Taintedness' },
+     uvar => { char => 'U', vtable => 'uvar',
+              desc => 'Available for use by extensions' },
+     uvar_elem => { char => 'u', desc => 'Reserved for use by extensions',
+                   unknown_to_sv_magic => 1 },
+     vec => { char => 'v', vtable => 'vec', value_magic => 1,
+             desc => 'vec() lvalue' },
+     vstring => { char => 'V', value_magic => 1,
+                 desc => 'SV was vstring literal' },
+     utf8 => { char => 'w', vtable => 'utf8', value_magic => 1,
+              desc => 'Cached UTF-8 information' },
+     substr => { char => 'x', vtable => 'substr',  value_magic => 1,
+                desc => 'substr() lvalue' },
+     defelem => { char => 'y', vtable => 'defelem', value_magic => 1,
+                 desc => "Shadow \"foreach\" iterator variable /\nsmart parameter vivification" },
+     arylen => { char => '#', vtable => 'arylen', value_magic => 1,
+                desc => 'Array length ($#ary)' },
+     proto => { char => '&', desc => 'my sub prototype CV' },
+     pos => { char => '.', vtable => 'pos', value_magic => 1,
+             desc => 'pos() lvalue' },
+     backref => { char => '<', vtable => 'backref', value_magic => 1,
+                 readonly_acceptable => 1, desc => 'for weak ref data' },
+     symtab => { char => ':', value_magic => 1,
+                desc => 'extra data for symbol tables' },
+     rhash => { char => '%', value_magic => 1,
+               desc => 'extra data for restricted hashes' },
+     arylen_p => { char => '@', value_magic => 1,
+                  desc => 'to move arylen out of XPVAV' },
+     ext => { char => '~', desc => 'Available for use by extensions' },
+     checkcall => { char => ']', value_magic => 1, vtable => 'checkcall',
+                   desc => 'inlining/mutation of call to this CV'},
+);
+
 # These have a subtly different "namespace" from the magic types.
 # These have a subtly different "namespace" from the magic types.
-my @sig =
+my %sig =
     (
     (
-     'sv' => {get => 'get', set => 'set', len => 'len'},
+     'sv' => {get => 'get', set => 'set'},
      'env' => {set => 'set_all_env', clear => 'clear_all_env'},
      'envelem' => {set => 'setenv', clear => 'clearenv'},
      'sigelem' => {get => 'getsig', set => 'setsig', clear => 'clearsig',
      'env' => {set => 'set_all_env', clear => 'clear_all_env'},
      'envelem' => {set => 'setenv', clear => 'clearenv'},
      'sigelem' => {get => 'getsig', set => 'setsig', clear => 'clearsig',
@@ -32,22 +124,18 @@ my @sig =
      'isa' => {set => 'setisa', clear => 'clearisa'},
      'isaelem' => {set => 'setisa'},
      'arylen' => {get => 'getarylen', set => 'setarylen', const => 1},
      'isa' => {set => 'setisa', clear => 'clearisa'},
      'isaelem' => {set => 'setisa'},
      'arylen' => {get => 'getarylen', set => 'setarylen', const => 1},
-     'arylen_p' => {free => 'freearylen_p'},
+     'arylen_p' => {clear => 'cleararylen_p', free => 'freearylen_p'},
      'mglob' => {set => 'setmglob'},
      'nkeys' => {get => 'getnkeys', set => 'setnkeys'},
      'taint' => {get => 'gettaint', set => 'settaint'},
      'substr' => {get => 'getsubstr', set => 'setsubstr'},
      'vec' => {get => 'getvec', set => 'setvec'},
      'pos' => {get => 'getpos', set => 'setpos'},
      'mglob' => {set => 'setmglob'},
      'nkeys' => {get => 'getnkeys', set => 'setnkeys'},
      'taint' => {get => 'gettaint', set => 'settaint'},
      'substr' => {get => 'getsubstr', set => 'setsubstr'},
      'vec' => {get => 'getvec', set => 'setvec'},
      'pos' => {get => 'getpos', set => 'setpos'},
-     'bm' => {set => 'setregexp'},
-     'fm' => {set => 'setregexp'},
      'uvar' => {get => 'getuvar', set => 'setuvar'},
      'defelem' => {get => 'getdefelem', set => 'setdefelem'},
      'uvar' => {get => 'getuvar', set => 'setuvar'},
      'defelem' => {get => 'getdefelem', set => 'setdefelem'},
-     'regexp' => {set => 'setregexp'},
+     'regexp' => {set => 'setregexp', alias => [qw(bm fm)]},
      'regdata' => {len => 'regdata_cnt'},
      'regdatum' => {get => 'regdatum_get', set => 'regdatum_set'},
      'regdata' => {len => 'regdata_cnt'},
      'regdatum' => {get => 'regdatum_get', set => 'regdatum_set'},
-     'amagic' => {set => 'setamagic', free => 'setamagic'},
-     'amagicelem' => {set => 'setamagic', free => 'setamagic'},
      'backref' => {free => 'killbackrefs'},
      'ovrld' => {free => 'freeovrld'},
      'utf8' => {set => 'setutf8'},
      'backref' => {free => 'killbackrefs'},
      'ovrld' => {free => 'freeovrld'},
      'utf8' => {set => 'setutf8'},
@@ -55,21 +143,159 @@ my @sig =
                    cond => '#ifdef USE_LOCALE_COLLATE'},
      'hintselem' => {set => 'sethint', clear => 'clearhint'},
      'hints' => {clear => 'clearhints'},
                    cond => '#ifdef USE_LOCALE_COLLATE'},
      'hintselem' => {set => 'sethint', clear => 'clearhint'},
      'hints' => {clear => 'clearhints'},
+     'checkcall' => {copy => 'copycallchecker'},
 );
 
 );
 
-my $h = open_new('mg_vtable.h', '>',
-                { by => 'regen/mg_vtable.pl', file => 'mg_vtable.h',
-                  style => '*' });
+my ($vt, $raw, $names) = map {
+    open_new($_, '>',
+            { by => 'regen/mg_vtable.pl', file => $_, style => '*' });
+} 'mg_vtable.h', 'mg_raw.h', 'mg_names.c';
+my $guts = open_new("pod/perlguts.pod", ">");
+
+print $vt <<'EOH';
+/* These constants should be used in preference to raw characters
+ * when using magic. Note that some perl guts still assume
+ * certain character properties of these constants, namely that
+ * isUPPER() and toLOWER() may do useful mappings.
+ */
+
+EOH
+
+# Of course, it would be *much* easier if we could output this table directly
+# here and now. However, for our sins, we try to support EBCDIC, which wouldn't
+# be *so* bad, except that there are (at least) 3 EBCDIC charset variants, and
+# they don't agree on the code point for '~'. Which we use. Great.
+# So we have to get the local build runtime to sort our table in character order
+# (And of course, just to be helpful, in POSIX BC '~' is \xFF, so we can't even
+# simplify the C code by assuming that the last element of the array is
+# predictable)
+
+{
+    my $longest = 0;
+    foreach (keys %mg) {
+       $longest = length $_ if length $_ > $longest;
+    }
+
+    my $longest_p1 = $longest + 1;
+
+    my %mg_order;
+    while (my ($name, $data) = each %mg) {
+       my $byte = eval qq{"$data->{char}"};
+       $data->{byte} = $byte;
+       $mg_order{(uc $byte) . $byte} = $name;
+    }
+    my @rows;
+    foreach (sort keys %mg_order) {
+       my $name = $mg_order{$_};
+       my $data = $mg{$name};
+       my $i = ord $data->{byte};
+       unless ($data->{unknown_to_sv_magic}) {
+           my $value = $data->{vtable}
+               ? "want_vtbl_$data->{vtable}" : 'magic_vtable_max';
+           $value .= ' | PERL_MAGIC_READONLY_ACCEPTABLE'
+               if $data->{readonly_acceptable};
+           $value .= ' | PERL_MAGIC_VALUE_MAGIC' if $data->{value_magic};
+           my $comment = "/* $name '$data->{char}' $data->{desc} */";
+           $comment =~ s/([\\"])/\\$1/g;
+           $comment =~ tr/\n/ /;
+           print $raw qq{    { '$data->{char}', "$value",\n      "$comment" },\n};
+       }
+
+       my $comment = $data->{desc};
+       my $leader = ' ' x ($longest + 27);
+       $comment =~ s/\n/\n$leader/s;
+       printf $vt "#define PERL_MAGIC_%-${longest}s '%s' /* %s */\n",
+           $name, $data->{char}, $comment;
+
+       my $char = $data->{char};
+       $char =~ s/([\\"])/\\$1/g;
+       printf $names qq[\t{ PERL_MAGIC_%-${longest_p1}s "%s(%s)" },\n],
+           "$name,", $name, $char;
+
+       push @rows, [(sprintf "%-2s PERL_MAGIC_%s", $data->{char}, $name),
+                    $data->{vtable} ? "vtbl_$data->{vtable}" : '(none)',
+                    $data->{desc}];
+    }
+    select +(select($guts), do {
+       my @header = ('(old-style char and macro)', 'MGVTBL', 'Type of magic');
+       my @widths = (0, 0);
+       foreach my $row (@rows) {
+           for (0, 1) {
+               $widths[$_] = length $row->[$_]
+                   if length $row->[$_] > $widths[$_];
+           }
+       }
+       my $indent = ' ';
+       my $format
+           = sprintf "$indent%%-%ds%%-%ds%%s\n", $widths[0] + 1, $widths[1] + 1;
+       my $desc_wrap =
+           79 - 7 - (length $indent) - $widths[0] - $widths[1] - 2;
+
+       open my $oldguts, "<", "pod/perlguts.pod"
+          or die "$0 cannot open pod/perlguts.pod for reading: $!";
+       while (<$oldguts>) {
+           print;
+           last if /^=for mg_vtable.pl begin/
+       }
+
+       print "\n", $indent . "mg_type\n";
+       printf $format, @header;
+       printf $format, map {'-' x length $_} @header;
+       foreach (@rows) {
+           my ($type, $vtbl, $desc) = @$_;
+           $desc =~ tr/\n/ /;
+           my @cont;
+           if (length $desc > $desc_wrap) {
+               # If it's too long, first split on '(', if there.
+               # [Which, if there, is always short enough, currently.
+               # Make this more robust if that changes]
+               ($desc, @cont) = split /(?=\()/, $desc;
+               if (!@cont) {
+                   ($desc, @cont) = $desc =~ /(.{1,$desc_wrap})(?: |\z)/g
+               }
+           }
+           printf $format, $type, $vtbl, $desc;
+           printf $format, '', '', $_ foreach @cont;
+       }
+       print "\n";
+
+       while (<$oldguts>) {
+           last if /^=for mg_vtable.pl end/;
+       }
+       do { print } while <$oldguts>;
+    })[0];
+}
 
 
-print $h <<'EOH';
+my @names = sort keys %sig;
+{
+    my $want = join ",\n    ", (map {"want_vtbl_$_"} @names), 'magic_vtable_max';
+    my $names = join qq{",\n    "}, @names;
+
+    print $vt <<"EOH";
+
+enum {         /* pass one of these to get_vtbl */
+    $want
+};
+
+#ifdef DOINIT
+EXTCONST char * const PL_magic_vtable_names[magic_vtable_max] = {
+    "$names"
+};
+#else
+EXTCONST char * const PL_magic_vtable_names[magic_vtable_max];
+#endif
+
+EOH
+}
+
+print $vt <<'EOH';
 /* These all need to be 0, not NULL, as NULL can be (void*)0, which is a
  * pointer to data, whereas we're assigning pointers to functions, which are
  * not the same beast. ANSI doesn't allow the assignment from one to the other.
  * (although most, but not all, compilers are prepared to do it)
  */
 
 /* These all need to be 0, not NULL, as NULL can be (void*)0, which is a
  * pointer to data, whereas we're assigning pointers to functions, which are
  * not the same beast. ANSI doesn't allow the assignment from one to the other.
  * (although most, but not all, compilers are prepared to do it)
  */
 
-/* args are:
-    vtable
+/* order is:
     get
     set
     len
     get
     set
     len
@@ -80,25 +306,54 @@ print $h <<'EOH';
     local
 */
 
     local
 */
 
+#ifdef DOINIT
+EXT_MGVTBL PL_magic_vtables[magic_vtable_max] = {
 EOH
 
 EOH
 
-while (my ($name, $data) = splice @sig, 0, 2) {
+my @vtable_names;
+my @aliases;
+
+while (my $name = shift @names) {
+    my $data = $sig{$name};
+    push @vtable_names, $name;
     my @funcs = map {
        $data->{$_} ? "Perl_magic_$data->{$_}" : 0;
     } qw(get set len clear free copy dup local);
 
     $funcs[0] = "(int (*)(pTHX_ SV *, MAGIC *))" . $funcs[0] if $data->{const};
     my @funcs = map {
        $data->{$_} ? "Perl_magic_$data->{$_}" : 0;
     } qw(get set len clear free copy dup local);
 
     $funcs[0] = "(int (*)(pTHX_ SV *, MAGIC *))" . $funcs[0] if $data->{const};
-    my $funcs = join ",\n    ", @funcs;
+    my $funcs = join ", ", @funcs;
 
 
-    print $h "$data->{cond}\n" if $data->{cond};
-    print $h <<"EOT";
-MGVTBL_SET(
-    PL_vtbl_$name,
-    $funcs
-);
-EOT
-    print $h "#endif\n" if $data->{cond};
-    print $h "\n";
+    # Because we can't have a , after the last {...}
+    my $comma = @names ? ',' : '';
+
+    print $vt "$data->{cond}\n" if $data->{cond};
+    print $vt "  { $funcs }$comma\n";
+    print $vt <<"EOH" if $data->{cond};
+#else
+  { 0, 0, 0, 0, 0, 0, 0, 0 }$comma
+#endif
+EOH
+    foreach(@{$data->{alias}}) {
+       push @aliases, "#define want_vtbl_$_ want_vtbl_$name\n";
+       push @vtable_names, $_;
+    }
 }
 
 }
 
-read_only_bottom_close_and_rename($h);
+print $vt <<'EOH';
+};
+#else
+EXT_MGVTBL PL_magic_vtables[magic_vtable_max];
+#endif
+
+EOH
+
+print $vt (sort @aliases), "\n";
+
+print $vt "#define PL_vtbl_$_ PL_magic_vtables[want_vtbl_$_]\n"
+    foreach sort @vtable_names;
+
+# 63, not 64, As we rely on the last possible value to mean "NULL vtable"
+die "Too many vtable names" if @vtable_names > 63;
+
+read_only_bottom_close_and_rename($_) foreach $vt, $raw, $names;
+                close_and_rename($guts);