regen/mg_vtable.pl

   1 #!/usr/bin/perl -w
   2 #
   3 # Regenerate (overwriting only if changed):
   4 #
   5 #    mg_vtable.h
   6 #    pod/perlguts.pod
   7 #
   8 # from information stored in this file.  pod/perlguts.pod is not completely
   9 # regenerated.  Only the magic table is replaced; the other parts remain
  10 # untouched.
  11 #
  12 # Accepts the standard regen_lib -q and -v args.
  13 #
  14 # This script is normally invoked from regen.pl.
  15
  16 use strict;
  17 require 5.004;
  18
  19 BEGIN {
  20     # Get function prototypes
  21     require 'regen/regen_lib.pl';
  22 }
  23
  24 my %mg =
  25     (
  26      sv => { char => '\0', vtable => 'sv', readonly_acceptable => 1,
  27              desc => 'Special scalar variable' },
  28      overload => { char => 'A', vtable => 'amagic', desc => '%OVERLOAD hash' },
  29      overload_elem => { char => 'a', vtable => 'amagicelem',
  30                         desc => '%OVERLOAD hash element' },
  31      overload_table => { char => 'c', vtable => 'ovrld',
  32                          desc => 'Holds overload table (AMT) on stash' },
  33      bm => { char => 'B', vtable => 'regexp', value_magic => 1,
  34              readonly_acceptable => 1,
  35              desc => 'Boyer-Moore (fast string search)' },
  36      regdata => { char => 'D', vtable => 'regdata',
  37                   desc => "Regex match position data\n(\@+ and \@- vars)" },
  38      regdatum => { char => 'd', vtable => 'regdatum',
  39                    desc => 'Regex match position data element' },
  40      env => { char => 'E', vtable => 'env', desc => '%ENV hash' },
  41      envelem => { char => 'e', vtable => 'envelem',
  42                   desc => '%ENV hash element' },
  43      fm => { char => 'f', vtable => 'regdata', value_magic => 1,
  44              readonly_acceptable => 1, desc => "Formline ('compiled' format)" },
  45      study => { char => 'G', vtable => 'regexp', value_magic => 1,
  46                 readonly_acceptable => 1, desc => 'study()ed string' },
  47      regex_global => { char => 'g', vtable => 'mglob', value_magic => 1,
  48                        readonly_acceptable => 1, desc => 'm//g target' },
  49      hints => { char => 'H', vtable => 'hints', desc => '%^H hash' },
  50      hintselem => { char => 'h', vtable => 'hintselem',
  51                     desc => '%^H hash element' },
  52      isa => { char => 'I', vtable => 'isa', desc => '@ISA array' },
  53      isaelem => { char => 'i', vtable => 'isaelem',
  54                   desc => '@ISA array element' },
  55      nkeys => { char => 'k', vtable => 'nkeys', value_magic => 1,
  56                 desc => 'scalar(keys()) lvalue' },
  57      dbfile => { char => 'L',
  58                  desc => 'Debugger %_<filename' },
  59      dbline => { char => 'l', vtable => 'dbline',
  60                  desc => 'Debugger %_<filename element' },
  61      shared => { char => 'N', desc => 'Shared between threads',
  62                  unknown_to_sv_magic => 1 },
  63      shared_scalar => { char => 'n', desc => 'Shared between threads',
  64                         unknown_to_sv_magic => 1 },
  65      collxfrm => { char => 'o', vtable => 'collxfrm', value_magic => 1,
  66                    desc => 'Locale transformation' },
  67      tied => { char => 'P', vtable => 'pack',
  68                value_magic => 1, # treat as value, so 'local @tied' isn't tied
  69                desc => 'Tied array or hash' },
  70      tiedelem => { char => 'p', vtable => 'packelem',
  71                    desc => 'Tied array or hash element' },
  72      tiedscalar => { char => 'q', vtable => 'packelem',
  73                      desc => 'Tied scalar or handle' },
  74      qr => { char => 'r', vtable => 'regexp', value_magic => 1,
  75              desc => 'precompiled qr// regex' },
  76      sig => { char => 'S', desc => '%SIG hash' },
  77      sigelem => { char => 's', vtable => 'sigelem',
  78                   desc => '%SIG hash element' },
  79      taint => { char => 't', vtable => 'taint', value_magic => 1,
  80                 desc => 'Taintedness' },
  81      uvar => { char => 'U', vtable => 'uvar',
  82                desc => 'Available for use by extensions' },
  83      uvar_elem => { char => 'u', desc => 'Reserved for use by extensions',
  84                     unknown_to_sv_magic => 1 },
  85      vec => { char => 'v', vtable => 'vec', value_magic => 1,
  86               desc => 'vec() lvalue' },
  87      vstring => { char => 'V', value_magic => 1, vtable => 'vstring',
  88                   desc => 'SV was vstring literal' },
  89      utf8 => { char => 'w', vtable => 'utf8', value_magic => 1,
  90                desc => 'Cached UTF-8 information' },
  91      substr => { char => 'x', vtable => 'substr',  value_magic => 1,
  92                  desc => 'substr() lvalue' },
  93      defelem => { char => 'y', vtable => 'defelem', value_magic => 1,
  94                   desc => "Shadow \"foreach\" iterator variable /\nsmart parameter vivification" },
  95      arylen => { char => '#', vtable => 'arylen', value_magic => 1,
  96                  desc => 'Array length ($#ary)' },
  97      pos => { char => '.', vtable => 'pos', value_magic => 1,
  98               desc => 'pos() lvalue' },
  99      backref => { char => '<', vtable => 'backref', value_magic => 1,
 100                   readonly_acceptable => 1, desc => 'for weak ref data' },
 101      symtab => { char => ':', value_magic => 1,
 102                  desc => 'extra data for symbol tables' },
 103      rhash => { char => '%', value_magic => 1,
 104                 desc => 'extra data for restricted hashes' },
 105      arylen_p => { char => '@', value_magic => 1,
 106                    desc => 'to move arylen out of XPVAV' },
 107      ext => { char => '~', desc => 'Available for use by extensions' },
 108      checkcall => { char => ']', value_magic => 1,
 109                     desc => 'inlining/mutation of call to this CV'},
 110 );
 111
 112 # These have a subtly different "namespace" from the magic types.
 113 my %sig =
 114     (
 115      'sv' => {get => 'get', set => 'set', len => 'len'},
 116      'env' => {set => 'set_all_env', clear => 'clear_all_env'},
 117      'envelem' => {set => 'setenv', clear => 'clearenv'},
 118      'sigelem' => {get => 'getsig', set => 'setsig', clear => 'clearsig',
 119                    cond => '#ifndef PERL_MICRO'},
 120      'pack' => {len => 'sizepack', clear => 'wipepack'},
 121      'packelem' => {get => 'getpack', set => 'setpack', clear => 'clearpack'},
 122      'dbline' => {set => 'setdbline'},
 123      'isa' => {set => 'setisa', clear => 'clearisa'},
 124      'isaelem' => {set => 'setisa'},
 125      'arylen' => {get => 'getarylen', set => 'setarylen', const => 1},
 126      'arylen_p' => {free => 'freearylen_p'},
 127      'mglob' => {set => 'setmglob'},
 128      'nkeys' => {get => 'getnkeys', set => 'setnkeys'},
 129      'taint' => {get => 'gettaint', set => 'settaint'},
 130      'substr' => {get => 'getsubstr', set => 'setsubstr'},
 131      'vec' => {get => 'getvec', set => 'setvec'},
 132      'pos' => {get => 'getpos', set => 'setpos'},
 133      'uvar' => {get => 'getuvar', set => 'setuvar'},
 134      'defelem' => {get => 'getdefelem', set => 'setdefelem'},
 135      'regexp' => {set => 'setregexp', alias => [qw(bm fm)]},
 136      'regdata' => {len => 'regdata_cnt'},
 137      'regdatum' => {get => 'regdatum_get', set => 'regdatum_set'},
 138      'amagic' => {set => 'setamagic', free => 'setamagic'},
 139      'amagicelem' => {set => 'setamagic', free => 'setamagic'},
 140      'backref' => {free => 'killbackrefs'},
 141      'ovrld' => {free => 'freeovrld'},
 142      'utf8' => {set => 'setutf8'},
 143      'collxfrm' => {set => 'setcollxfrm',
 144                     cond => '#ifdef USE_LOCALE_COLLATE'},
 145      'hintselem' => {set => 'sethint', clear => 'clearhint'},
 146      'hints' => {clear => 'clearhints'},
 147      'vstring' => {set => 'setvstring'},
 148 );
 149
 150 my ($vt, $raw, $names) = map {
 151     open_new($_, '>',
 152              { by => 'regen/mg_vtable.pl', file => $_, style => '*' });
 153 } 'mg_vtable.h', 'mg_raw.h', 'mg_names.c';
 154 my $guts = open_new("pod/perlguts.pod", ">");
 155
 156 print $vt <<'EOH';
 157 /* These constants should be used in preference to raw characters
 158  * when using magic. Note that some perl guts still assume
 159  * certain character properties of these constants, namely that
 160  * isUPPER() and toLOWER() may do useful mappings.
 161  */
 162
 163 EOH
 164
 165 # Of course, it would be *much* easier if we could output this table directly
 166 # here and now. However, for our sins, we try to support EBCDIC, which wouldn't
 167 # be *so* bad, except that there are (at least) 3 EBCDIC charset variants, and
 168 # they don't agree on the code point for '~'. Which we use. Great.
 169 # So we have to get the local build runtime to sort our table in character order
 170 # (And of course, just to be helpful, in POSIX BC '~' is \xFF, so we can't even
 171 # simplify the C code by assuming that the last element of the array is
 172 # predictable)
 173
 174 {
 175     my $longest = 0;
 176     foreach (keys %mg) {
 177         $longest = length $_ if length $_ > $longest;
 178     }
 179
 180     my $longest_p1 = $longest + 1;
 181
 182     my %mg_order;
 183     while (my ($name, $data) = each %mg) {
 184         my $byte = eval qq{"$data->{char}"};
 185         $data->{byte} = $byte;
 186         $mg_order{(uc $byte) . $byte} = $name;
 187     }
 188     my @rows;
 189     foreach (sort keys %mg_order) {
 190         my $name = $mg_order{$_};
 191         my $data = $mg{$name};
 192         my $i = ord $data->{byte};
 193         unless ($data->{unknown_to_sv_magic}) {
 194             my $value = $data->{vtable}
 195                 ? "want_vtbl_$data->{vtable}" : 'magic_vtable_max';
 196             $value .= ' | PERL_MAGIC_READONLY_ACCEPTABLE'
 197                 if $data->{readonly_acceptable};
 198             $value .= ' | PERL_MAGIC_VALUE_MAGIC' if $data->{value_magic};
 199             my $comment = "/* $name '$data->{char}' $data->{desc} */";
 200             $comment =~ s/([\\"])/\\$1/g;
 201             $comment =~ tr/\n/ /;
 202             print $raw qq{    { '$data->{char}', "$value",\n      "$comment" },\n};
 203         }
 204
 205         my $comment = $data->{desc};
 206         my $leader = ' ' x ($longest + 27);
 207         $comment =~ s/\n/\n$leader/s;
 208         printf $vt "#define PERL_MAGIC_%-${longest}s '%s' /* %s */\n",
 209             $name, $data->{char}, $comment;
 210
 211         my $char = $data->{char};
 212         $char =~ s/([\\"])/\\$1/g;
 213         printf $names qq[\t{ PERL_MAGIC_%-${longest_p1}s "%s(%s)" },\n],
 214             "$name,", $name, $char;
 215
 216         push @rows, [(sprintf "%-2s PERL_MAGIC_%s", $data->{char}, $name),
 217                      $data->{vtable} ? "vtbl_$data->{vtable}" : '(none)',
 218                      $data->{desc}];
 219     }
 220     select +(select($guts), do {
 221         my @header = ('(old-style char and macro)', 'MGVTBL', 'Type of magic');
 222         my @widths = (0, 0);
 223         foreach my $row (@rows) {
 224             for (0, 1) {
 225                 $widths[$_] = length $row->[$_]
 226                     if length $row->[$_] > $widths[$_];
 227             }
 228         }
 229         my $indent = ' ';
 230         my $format
 231             = sprintf "$indent%%-%ds%%-%ds%%s\n", $widths[0] + 1, $widths[1] + 1;
 232         my $desc_wrap =
 233             79 - 7 - (length $indent) - $widths[0] - $widths[1] - 2;
 234
 235         open my $oldguts, "<", "pod/perlguts.pod"
 236            or die "$0 cannot open pod/perlguts.pod for reading: $!";
 237         while (<$oldguts>) {
 238             print;
 239             last if /^=for mg_vtable.pl begin/
 240         }
 241
 242         print "\n", $indent . "mg_type\n";
 243         printf $format, @header;
 244         printf $format, map {'-' x length $_} @header;
 245         foreach (@rows) {
 246             my ($type, $vtbl, $desc) = @$_;
 247             $desc =~ tr/\n/ /;
 248             my @cont;
 249             if (length $desc > $desc_wrap) {
 250                 # If it's too long, first split on '(', if there.
 251                 # [Which, if there, is always short enough, currently.
 252                 # Make this more robust if that changes]
 253                 ($desc, @cont) = split /(?=\()/, $desc;
 254                 if (!@cont) {
 255                     ($desc, @cont) = $desc =~ /(.{1,$desc_wrap})(?: |\z)/g
 256                 }
 257             }
 258             printf $format, $type, $vtbl, $desc;
 259             printf $format, '', '', $_ foreach @cont;
 260         }
 261         print "\n";
 262
 263         while (<$oldguts>) {
 264             last if /^=for mg_vtable.pl end/;
 265         }
 266         do { print } while <$oldguts>;
 267     })[0];
 268 }
 269
 270 my @names = sort keys %sig;
 271 {
 272     my $want = join ",\n    ", (map {"want_vtbl_$_"} @names), 'magic_vtable_max';
 273     my $names = join qq{",\n    "}, @names;
 274
 275     print $vt <<"EOH";
 276
 277 enum {          /* pass one of these to get_vtbl */
 278     $want
 279 };
 280
 281 #ifdef DOINIT
 282 EXTCONST char *PL_magic_vtable_names[magic_vtable_max] = {
 283     "$names"
 284 };
 285 #else
 286 EXTCONST char *PL_magic_vtable_names[magic_vtable_max];
 287 #endif
 288
 289 EOH
 290 }
 291
 292 print $vt <<'EOH';
 293 /* These all need to be 0, not NULL, as NULL can be (void*)0, which is a
 294  * pointer to data, whereas we're assigning pointers to functions, which are
 295  * not the same beast. ANSI doesn't allow the assignment from one to the other.
 296  * (although most, but not all, compilers are prepared to do it)
 297  */
 298
 299 /* order is:
 300     get
 301     set
 302     len
 303     clear
 304     free
 305     copy
 306     dup
 307     local
 308 */
 309
 310 #ifdef DOINIT
 311 EXT_MGVTBL PL_magic_vtables[magic_vtable_max] = {
 312 EOH
 313
 314 my @vtable_names;
 315 my @aliases;
 316
 317 while (my $name = shift @names) {
 318     my $data = $sig{$name};
 319     push @vtable_names, $name;
 320     my @funcs = map {
 321         $data->{$_} ? "Perl_magic_$data->{$_}" : 0;
 322     } qw(get set len clear free copy dup local);
 323
 324     $funcs[0] = "(int (*)(pTHX_ SV *, MAGIC *))" . $funcs[0] if $data->{const};
 325     my $funcs = join ", ", @funcs;
 326
 327     # Because we can't have a , after the last {...}
 328     my $comma = @names ? ',' : '';
 329
 330     print $vt "$data->{cond}\n" if $data->{cond};
 331     print $vt "  { $funcs }$comma\n";
 332     print $vt <<"EOH" if $data->{cond};
 333 #else
 334   { 0, 0, 0, 0, 0, 0, 0, 0 }$comma
 335 #endif
 336 EOH
 337     foreach(@{$data->{alias}}) {
 338         push @aliases, "#define want_vtbl_$_ want_vtbl_$name\n";
 339         push @vtable_names, $_;
 340     }
 341 }
 342
 343 print $vt <<'EOH';
 344 };
 345 #else
 346 EXT_MGVTBL PL_magic_vtables[magic_vtable_max];
 347 #endif
 348
 349 EOH
 350
 351 print $vt (sort @aliases), "\n";
 352
 353 print $vt "#define PL_vtbl_$_ PL_magic_vtables[want_vtbl_$_]\n"
 354     foreach sort @vtable_names;
 355
 356 # 63, not 64, As we rely on the last possible value to mean "NULL vtable"
 357 die "Too many vtable names" if @vtable_names > 63;
 358
 359 read_only_bottom_close_and_rename($_) foreach $vt, $raw, $names;
 360                  close_and_rename($guts);