This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Provide the names of the magic vtables in PL_magic_vtable_names[].
[perl5.git] / regen / mg_vtable.pl
1 #!/usr/bin/perl -w
2 #
3 # Regenerate (overwriting only if changed):
4 #
5 #    mg_vtable.h
6 #
7 # from information stored in this file.
8 #
9 # Accepts the standard regen_lib -q and -v args.
10 #
11 # This script is normally invoked from regen.pl.
12
13 use strict;
14 require 5.004;
15
16 BEGIN {
17     # Get function prototypes
18     require 'regen/regen_lib.pl';
19 }
20
21 # These have a subtly different "namespace" from the magic types.
22 my @sig =
23     (
24      'sv' => {get => 'get', set => 'set', len => 'len'},
25      'env' => {set => 'set_all_env', clear => 'clear_all_env'},
26      'envelem' => {set => 'setenv', clear => 'clearenv'},
27      'sigelem' => {get => 'getsig', set => 'setsig', clear => 'clearsig',
28                    cond => '#ifndef PERL_MICRO'},
29      'pack' => {len => 'sizepack', clear => 'wipepack'},
30      'packelem' => {get => 'getpack', set => 'setpack', clear => 'clearpack'},
31      'dbline' => {set => 'setdbline'},
32      'isa' => {set => 'setisa', clear => 'clearisa'},
33      'isaelem' => {set => 'setisa'},
34      'arylen' => {get => 'getarylen', set => 'setarylen', const => 1},
35      'arylen_p' => {free => 'freearylen_p'},
36      'mglob' => {set => 'setmglob'},
37      'nkeys' => {get => 'getnkeys', set => 'setnkeys'},
38      'taint' => {get => 'gettaint', set => 'settaint'},
39      'substr' => {get => 'getsubstr', set => 'setsubstr'},
40      'vec' => {get => 'getvec', set => 'setvec'},
41      'pos' => {get => 'getpos', set => 'setpos'},
42      'uvar' => {get => 'getuvar', set => 'setuvar'},
43      'defelem' => {get => 'getdefelem', set => 'setdefelem'},
44      'regexp' => {set => 'setregexp', alias => [qw(bm fm)]},
45      'regdata' => {len => 'regdata_cnt'},
46      'regdatum' => {get => 'regdatum_get', set => 'regdatum_set'},
47      'amagic' => {set => 'setamagic', free => 'setamagic'},
48      'amagicelem' => {set => 'setamagic', free => 'setamagic'},
49      'backref' => {free => 'killbackrefs'},
50      'ovrld' => {free => 'freeovrld'},
51      'utf8' => {set => 'setutf8'},
52      'collxfrm' => {set => 'setcollxfrm',
53                     cond => '#ifdef USE_LOCALE_COLLATE'},
54      'hintselem' => {set => 'sethint', clear => 'clearhint'},
55      'hints' => {clear => 'clearhints'},
56 );
57
58 my $h = open_new('mg_vtable.h', '>',
59                  { by => 'regen/mg_vtable.pl', file => 'mg_vtable.h',
60                    style => '*' });
61
62 {
63     my @names = grep {!ref $_} @sig;
64     my $want = join ",\n    ", (map {"want_vtbl_$_"} @names), 'magic_vtable_max';
65     my $names = join qq{",\n    "}, @names;
66
67     print $h <<"EOH";
68 enum {          /* pass one of these to get_vtbl */
69     $want
70 };
71
72 #ifdef DOINIT
73 EXTCONST char *PL_magic_vtable_names[magic_vtable_max] = {
74     "$names"
75 };
76 #else
77 EXTCONST char *PL_magic_vtable_names[magic_vtable_max];
78 #endif
79
80 EOH
81 }
82
83 print $h <<'EOH';
84 /* These all need to be 0, not NULL, as NULL can be (void*)0, which is a
85  * pointer to data, whereas we're assigning pointers to functions, which are
86  * not the same beast. ANSI doesn't allow the assignment from one to the other.
87  * (although most, but not all, compilers are prepared to do it)
88  */
89
90 /* order is:
91     get
92     set
93     len
94     clear
95     free
96     copy
97     dup
98     local
99 */
100
101 #ifdef DOINIT
102 EXT_MGVTBL PL_magic_vtables[magic_vtable_max] = {
103 EOH
104
105 my @vtable_names;
106 my @aliases;
107
108 while (my ($name, $data) = splice @sig, 0, 2) {
109     push @vtable_names, $name;
110     my @funcs = map {
111         $data->{$_} ? "Perl_magic_$data->{$_}" : 0;
112     } qw(get set len clear free copy dup local);
113
114     $funcs[0] = "(int (*)(pTHX_ SV *, MAGIC *))" . $funcs[0] if $data->{const};
115     my $funcs = join ", ", @funcs;
116
117     # Because we can't have a , after the last {...}
118     my $comma = @sig ? ',' : '';
119
120     print $h "$data->{cond}\n" if $data->{cond};
121     print $h "  { $funcs }$comma\n";
122     print $h <<"EOH" if $data->{cond};
123 #else
124   { 0, 0, 0, 0, 0, 0, 0, 0 }$comma
125 #endif
126 EOH
127     foreach(@{$data->{alias}}) {
128         push @aliases, "#define want_vtbl_$_ want_vtbl_$name\n";
129         push @vtable_names, $_;
130     }
131 }
132
133 print $h <<'EOH';
134 };
135 #else
136 EXT_MGVTBL PL_magic_vtables[magic_vtable_max];
137 #endif
138
139 EOH
140
141 print $h (sort @aliases), "\n";
142
143 print $h "#define PL_vtbl_$_ PL_magic_vtables[want_vtbl_$_]\n"
144     foreach sort @vtable_names;
145
146 read_only_bottom_close_and_rename($h);