This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
add perldelta entry for context stack work
[perl5.git] / regen_perly.pl
CommitLineData
0de566d7
DM
1#!/usr/bin/perl
2#
3# regen_perly.pl, DAPM 12-Feb-04
4#
2eee27d7 5# Copyright (c) 2004, 2005, 2006, 2009, 2010, 2011 Larry Wall
0de566d7
DM
6#
7# Given an input file perly.y, run bison on it and produce
8# the following output files:
9#
10# perly.h standard bison header file with minor doctoring of
11# #line directives plus adding a #ifdef PERL_CORE
12#
13# perly.tab the parser table C definitions extracted from the bison output
0539ab63 14# plus an extra table generated by this script.
0de566d7
DM
15#
16# perly.act the action case statements extracted from the bison output
17#
18# Note that perly.c is *not* regenerated - this is now a static file which
19# is not dependent on perly.y any more.
20#
21# If a filename of the form foo.y is given on the command line, then
22# this is used instead as the basename for all the files mentioned
23# above.
24#
25# Note that temporary files of the form perlytmp.h and perlytmp.c are
26# created and then deleted during this process
27#
28# Note also that this script is intended to be run on a UNIX system;
29# it may work elsewhere but no specific attempt has been made to make it
30# portable.
31
e8fb9efb 32use 5.006;
0de566d7
DM
33sub usage { die "usage: $0 [ -b bison_executable ] [ file.y ]\n" }
34
35use warnings;
36use strict;
37
2bd4012d 38BEGIN { require 'regen/regen_lib.pl'; }
a9718e07 39
0de566d7
DM
40my $bison = 'bison';
41
42if (@ARGV >= 2 and $ARGV[0] eq '-b') {
43 shift;
44 $bison = shift;
45}
46
47my $y_file = shift || 'perly.y';
48
49usage unless @ARGV==0 && $y_file =~ /\.y$/;
50
51(my $h_file = $y_file) =~ s/\.y$/.h/;
52(my $act_file = $y_file) =~ s/\.y$/.act/;
53(my $tab_file = $y_file) =~ s/\.y$/.tab/;
54(my $tmpc_file = $y_file) =~ s/\.y$/tmp.c/;
55(my $tmph_file = $y_file) =~ s/\.y$/tmp.h/;
56
57# the yytranslate[] table generated by bison is ASCII/EBCDIC sensitive
58
59die "$0: must be run on an ASCII system\n" unless ord 'A' == 65;
60
61# check for correct version number. The constraints are:
62# * must be >= 1.24 to avoid licensing issues.
63# * it must generate the yystos[] table. Version 1.28 doesn't generate
64# this; 1.35+ does
65# * Must produce output which is extractable by the regexes below
66# * Must produce the right values.
8abc1060 67# These last two constraints may well be met by earlier versions, but
0de566d7
DM
68# I simply haven't tested them yet. If it works for you, then modify
69# the test below to allow that version too. DAPM Feb 04.
70
71my $version = `$bison -V`;
7b931d50
LB
72unless ($version) { die <<EOF; }
73Could not find a version of bison in your path. Please install bison.
74EOF
75
9c221ee4
NC
76# Don't change this to add new bison versions without testing that the generated
77# files actually work :-) Win32 in particular may not like them. :-(
f5cf236d 78unless ($version =~ /\b(1\.875[a-z]?|2\.[0134567])\b/) { die <<EOF; }
0de566d7 79
2080282f 80You have the wrong version of bison in your path; currently 1.875
9c221ee4
NC
812.0, 2.1, 2.3, 2.4, 2.5, 2.6 or 2.7 is required. Try installing
82 http://ftp.gnu.org/gnu/bison/bison-2.5.1.tar.gz
0de566d7
DM
83or similar. Your bison identifies itself as:
84
85$version
86EOF
87
9c221ee4
NC
88# bison's version number, not the entire string, is most useful later on.
89$version = $1;
90
0de566d7
DM
91# creates $tmpc_file and $tmph_file
92my_system("$bison -d -o $tmpc_file $y_file");
93
e8fb9efb 94open my $ctmp_fh, '<', $tmpc_file or die "Can't open $tmpc_file: $!\n";
0de566d7 95my $clines;
e8fb9efb 96{ local $/; $clines = <$ctmp_fh>; }
0de566d7
DM
97die "failed to read $tmpc_file: length mismatch\n"
98 unless length $clines == -s $tmpc_file;
e8fb9efb 99close $ctmp_fh;
0de566d7
DM
100
101my ($actlines, $tablines) = extract($clines);
102
6c7ae946 103our %tokens;
d5c6462e 104$tablines .= make_type_tab($y_file, $tablines);
0539ab63 105
cc49830d
NC
106my ($act_fh, $tab_fh, $h_fh) = map {
107 open_new($_, '>', { by => $0, from => $y_file });
108} $act_file, $tab_file, $h_file;
0de566d7 109
cc49830d 110print $act_fh $actlines;
e8fb9efb 111
cc49830d 112print $tab_fh $tablines;
0de566d7
DM
113
114unlink $tmpc_file;
115
116# Wrap PERL_CORE round the symbol definitions. Also, the
96f4e226
SH
117# C<#line 30 "perly.y"> confuses the Win32 resource compiler and the
118# C<#line 188 "perlytmp.h"> gets picked up by make depend, so remove them.
0de566d7 119
e8fb9efb 120open my $tmph_fh, '<', $tmph_file or die "Can't open $tmph_file: $!\n";
e8fb9efb 121
0de566d7 122my $endcore_done = 0;
2434f628 123# Token macros need to be generated manually from bison 2.4 on
9c221ee4 124my $gather_tokens = $version >= 2.4 ? undef : 0;
ce1534ab 125my $tokens;
e8fb9efb 126while (<$tmph_fh>) {
04ff073f
JL
127 # bison 2.6 adds header guards, which break things because of where we
128 # insert #ifdef PERL_CORE, so strip them because they aren't important
129 next if /YY_PERLYTMP_H/;
130
e8fb9efb 131 print $h_fh "#ifdef PERL_CORE\n" if $. == 1;
0de566d7 132 if (!$endcore_done and /YYSTYPE_IS_DECLARED/) {
6c7ae946
FC
133 print $h_fh <<h;
134#ifdef PERL_IN_TOKE_C
135static bool
136S_is_opval_token(int type) {
137 switch (type) {
138h
139 print $h_fh <<i for sort grep $tokens{$_} eq 'opval', keys %tokens;
140 case $_:
141i
142 print $h_fh <<j;
143 return 1;
144 }
145 return 0;
146}
147#endif /* PERL_IN_TOKE_C */
148#endif /* PERL_CORE */
149j
0de566d7
DM
150 $endcore_done = 1;
151 }
96f4e226 152 next if /^#line \d+ ".*"/;
ce1534ab
VP
153 if (not defined $gather_tokens) {
154 $gather_tokens = 1 if /^\s* enum \s* yytokentype \s* \{/x;
155 }
156 elsif ($gather_tokens) {
157 if (/^\# \s* endif/x) { # The #endif just after the end of the token enum
158 $gather_tokens = 0;
159 $_ .= "\n/* Tokens. */\n$tokens";
160 }
161 else {
162 my ($tok, $val) = /(\w+) \s* = \s* (\d+)/x;
163 $tokens .= "#define $tok $val\n" if $tok;
164 }
165 }
e8fb9efb 166 print $h_fh $_;
0de566d7 167}
e8fb9efb 168close $tmph_fh;
0de566d7
DM
169unlink $tmph_file;
170
c24c946d
NC
171foreach ($act_fh, $tab_fh, $h_fh) {
172 read_only_bottom_close_and_rename($_, ['regen_perly.pl', $y_file]);
173}
0de566d7
DM
174
175exit 0;
176
177
178sub extract {
179 my $clines = shift;
180 my $tablines;
181 my $actlines;
182
183 $clines =~ m@
184 (?:
185 ^/* YYFINAL[^\n]+\n #optional comment
186 )?
187 \# \s* define \s* YYFINAL # first #define
188 .*? # other defines + most tables
189 yystos\[\]\s*= # start of last table
190 .*?
191 }\s*; # end of last table
192 @xms
193 or die "Can't extract tables from $tmpc_file\n";
194 $tablines = $&;
195
196
197 $clines =~ m@
198 switch \s* \( \s* \w+ \s* \) \s* { \s*
199 (
ce1534ab
VP
200 case \s* \d+ \s* :
201 \s*
202 (?: \s* /\* .*? \*/ \s* )* # optional C-comments
203 \s*
2ade6388 204 \#line [^\n]+"\Q$y_file\E"
0de566d7
DM
205 .*?
206 )
207 }
208 \s*
ce1534ab 209 (?: \s* /\* .*? \*/ \s* )* # optional C-comments
0de566d7
DM
210 \s*
211 (
212 \#line[^\n]+\.c"
213 |
214 \#line[^\n]+\.simple"
3797f23d
DM
215 |
216 YY_SYMBOL_PRINT
0de566d7
DM
217 )
218 @xms
219 or die "Can't extract actions from $tmpc_file\n";
220 $actlines = $1;
221
ce1534ab
VP
222 # Remove extraneous comments from bison 2.4
223 $actlines =~ s!\s* /\* \s* Line \s* \d+ \s* of \s* yacc\.c \s* \*/!!gx;
224
0d6f9730
DM
225 # C<#line 188 "perlytmp.c"> gets picked up by make depend, so remove them.
226 $actlines =~ s/^#line \d+ "\Q$tmpc_file\E".*$//gm;
227
1654d593
DM
228 # convert yyvsp[nnn] into ps[nnn].val
229
230 $actlines =~ s/yyvsp\[(.*?)\]/ps[$1].val/g
231 or die "Can't convert value stack name\n";
232
0de566d7
DM
233 return $actlines. "\n", $tablines. "\n";
234}
235
d5c6462e
DM
236# Generate a table, yy_type_tab[], that specifies for each token, what
237# type of value it holds.
0539ab63 238#
d5c6462e
DM
239# Read the .y file and extract a list of all the token names and
240# non-terminal names; then scan the string $tablines for the table yytname,
241# which gives the token index of each token/non-terminal; then use this to
242# create yy_type_tab.
0539ab63 243#
d5c6462e
DM
244# ie given (in perly.y),
245#
246# %token <opval> A
247# %token <ival> B
248# %type <pval> C
249# %type <opval> D
250#
251# and (in $tablines),
252#
253# yytname[] = { "A" "B", "C", "D", "E" };
0539ab63
DM
254#
255# then return
d5c6462e
DM
256#
257# typedef enum { toketype_ival, toketype_opval, toketype_pval } toketypes;
258#
259# static const toketypes yy_type_tab[]
260# = { toketype_opval, toketype_ival, toketype_pval,
261# toketype_opval, toketype_ival }
262#
263# where "E" has the default type. The default type is determined
264# by the __DEFAULT__ comment next to the appropriate union member in
265# perly.y
0539ab63 266
d5c6462e 267sub make_type_tab {
0539ab63 268 my ($y_file, $tablines) = @_;
6c7ae946 269 my %just_tokens;
0539ab63 270 my %tokens;
d5c6462e
DM
271 my %types;
272 my $default_token;
0539ab63
DM
273 open my $fh, '<', $y_file or die "Can't open $y_file: $!\n";
274 while (<$fh>) {
b5bbe64a 275 if (/(\$\d+)\s*=[^=]/) {
29522234
DM
276 warn "$y_file:$.: dangerous assignment to $1: $_";
277 }
278
d5c6462e
DM
279 if (/__DEFAULT__/) {
280 m{(\w+) \s* ; \s* /\* \s* __DEFAULT__}x
281 or die "$y_file: can't parse __DEFAULT__ line: $_";
282 die "$y_file: duplicate __DEFAULT__ line: $_"
283 if defined $default_token;
284 $default_token = $1;
285 next;
286 }
287
288 next unless /^%(token|type)/;
6c7ae946 289 s/^%((token)|type)\s+<(\w+)>\s+//
d5c6462e 290 or die "$y_file: unparseable token/type line: $_";
6c7ae946
FC
291 for (split ' ', $_) {
292 $tokens{$_} = $3;
293 if ($2) {
294 $just_tokens{$_} = $3;
295 }
296 }
297 $types{$3} = 1;
0539ab63 298 }
6c7ae946 299 *tokens = \%just_tokens; # perly.h needs this
d5c6462e
DM
300 die "$y_file: no __DEFAULT__ token defined\n" unless $default_token;
301 $types{$default_token} = 1;
0539ab63
DM
302
303 $tablines =~ /^\Qstatic const char *const yytname[] =\E\n
efcfdf1f 304 \{\n
0539ab63
DM
305 (.*?)
306 ^};
307 /xsm
308 or die "Can't extract yytname[] from table string\n";
309 my $fields = $1;
d5c6462e
DM
310 $fields =~ s{"([^"]+)"}
311 { "toketype_" .
312 (defined $tokens{$1} ? $tokens{$1} : $default_token)
313 }ge;
04ff073f 314 $fields =~ s/, \s* (?:0|YY_NULL) \s* $//x
d5c6462e
DM
315 or die "make_type_tab: couldn't delete trailing ',0'\n";
316
0539ab63 317 return
d5c6462e
DM
318 "\ntypedef enum {\n\t"
319 . join(", ", map "toketype_$_", sort keys %types)
320 . "\n} toketypes;\n\n"
321 . "/* type of each token/terminal */\n"
d5c6462e
DM
322 . "static const toketypes yy_type_tab[] =\n{\n"
323 . $fields
324 . "\n};\n";
0539ab63
DM
325}
326
327
0de566d7
DM
328sub my_system {
329 system(@_);
330 if ($? == -1) {
d5c6462e 331 die "failed to execute command '@_': $!\n";
0de566d7
DM
332 }
333 elsif ($? & 127) {
334 die sprintf "command '@_' died with signal %d\n",
335 ($? & 127);
336 }
337 elsif ($? >> 8) {
338 die sprintf "command '@_' exited with value %d\n", $? >> 8;
339 }
340}