3 # regen_perly.pl, DAPM 12-Feb-04
5 # Copyright (c) 2004, 2005, 2006, 2009, 2010, 2011 Larry Wall
7 # Given an input file perly.y, run bison on it and produce
8 # the following output files:
10 # perly.h standard bison header file with minor doctoring of
11 # #line directives plus adding a #ifdef PERL_CORE
13 # perly.tab the parser table C definitions extracted from the bison output
14 # plus an extra table generated by this script.
16 # perly.act the action case statements extracted from the bison output
18 # Note that perly.c is *not* regenerated - this is now a static file which
19 # is not dependent on perly.y any more.
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
25 # Note that temporary files of the form perlytmp.h and perlytmp.c are
26 # created and then deleted during this process
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
33 sub usage { die "usage: $0 [ -b bison_executable ] [ file.y ]\n" }
38 BEGIN { require 'regen/regen_lib.pl'; }
42 if (@ARGV >= 2 and $ARGV[0] eq '-b') {
47 my $y_file = shift || 'perly.y';
49 usage unless @ARGV==0 && $y_file =~ /\.y$/;
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/;
57 # the yytranslate[] table generated by bison is ASCII/EBCDIC sensitive
59 die "$0: must be run on an ASCII system\n" unless ord 'A' == 65;
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
65 # * Must produce output which is extractable by the regexes below
66 # * Must produce the right values.
67 # These last two constraints may well be met by earlier versions, but
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.
71 my $version = `$bison -V`;
72 unless ($version) { die <<EOF; }
73 Could not find a version of bison in your path. Please install bison.
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. :-(
78 unless ($version =~ /\b(1\.875[a-z]?|2\.[0134567])\b/) { die <<EOF; }
80 You have the wrong version of bison in your path; currently 1.875
81 2.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
83 or similar. Your bison identifies itself as:
88 # bison's version number, not the entire string, is most useful later on.
91 # creates $tmpc_file and $tmph_file
92 my_system("$bison -d -o $tmpc_file $y_file");
94 open my $ctmp_fh, '<', $tmpc_file or die "Can't open $tmpc_file: $!\n";
96 { local $/; $clines = <$ctmp_fh>; }
97 die "failed to read $tmpc_file: length mismatch\n"
98 unless length $clines == -s $tmpc_file;
101 my ($actlines, $tablines) = extract($clines);
104 $tablines .= make_type_tab($y_file, $tablines);
106 my ($act_fh, $tab_fh, $h_fh) = map {
107 open_new($_, '>', { by => $0, from => $y_file });
108 } $act_file, $tab_file, $h_file;
110 print $act_fh $actlines;
112 print $tab_fh $tablines;
116 # Wrap PERL_CORE round the symbol definitions. Also, the
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.
120 open my $tmph_fh, '<', $tmph_file or die "Can't open $tmph_file: $!\n";
122 my $endcore_done = 0;
123 # Token macros need to be generated manually from bison 2.4 on
124 my $gather_tokens = $version >= 2.4 ? undef : 0;
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/;
131 print $h_fh "#ifdef PERL_CORE\n" if $. == 1;
132 if (!$endcore_done and /YYSTYPE_IS_DECLARED/) {
134 #ifdef PERL_IN_TOKE_C
136 S_is_opval_token(int type) {
139 print $h_fh <<i for sort grep $tokens{$_} eq 'opval', keys %tokens;
147 #endif /* PERL_IN_TOKE_C */
148 #endif /* PERL_CORE */
152 next if /^#line \d+ ".*"/;
153 if (not defined $gather_tokens) {
154 $gather_tokens = 1 if /^\s* enum \s* yytokentype \s* \{/x;
156 elsif ($gather_tokens) {
157 if (/^\# \s* endif/x) { # The #endif just after the end of the token enum
159 $_ .= "\n/* Tokens. */\n$tokens";
162 my ($tok, $val) = /(\w+) \s* = \s* (\d+)/x;
163 $tokens .= "#define $tok $val\n" if $tok;
171 foreach ($act_fh, $tab_fh, $h_fh) {
172 read_only_bottom_close_and_rename($_, ['regen_perly.pl', $y_file]);
185 ^/* YYFINAL[^\n]+\n #optional comment
187 \# \s* define \s* YYFINAL # first #define
188 .*? # other defines + most tables
189 yystos\[\]\s*= # start of last table
191 }\s*; # end of last table
193 or die "Can't extract tables from $tmpc_file\n";
198 switch \s* \( \s* \w+ \s* \) \s* { \s*
202 (?: \s* /\* .*? \*/ \s* )* # optional C-comments
204 \#line [^\n]+"\Q$y_file\E"
209 (?: \s* /\* .*? \*/ \s* )* # optional C-comments
214 \#line[^\n]+\.simple"
219 or die "Can't extract actions from $tmpc_file\n";
222 # Remove extraneous comments from bison 2.4
223 $actlines =~ s!\s* /\* \s* Line \s* \d+ \s* of \s* yacc\.c \s* \*/!!gx;
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;
228 # convert yyvsp[nnn] into ps[nnn].val
230 $actlines =~ s/yyvsp\[(.*?)\]/ps[$1].val/g
231 or die "Can't convert value stack name\n";
233 return $actlines. "\n", $tablines. "\n";
236 # Generate a table, yy_type_tab[], that specifies for each token, what
237 # type of value it holds.
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.
244 # ie given (in perly.y),
251 # and (in $tablines),
253 # yytname[] = { "A" "B", "C", "D", "E" };
257 # typedef enum { toketype_ival, toketype_opval, toketype_pval } toketypes;
259 # static const toketypes yy_type_tab[]
260 # = { toketype_opval, toketype_ival, toketype_pval,
261 # toketype_opval, toketype_ival }
263 # where "E" has the default type. The default type is determined
264 # by the __DEFAULT__ comment next to the appropriate union member in
268 my ($y_file, $tablines) = @_;
273 open my $fh, '<', $y_file or die "Can't open $y_file: $!\n";
276 warn "$y_file:$.: dangerous assignment to $1: $_";
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;
288 next unless /^%(token|type)/;
289 s/^%((token)|type)\s+<(\w+)>\s+//
290 or die "$y_file: unparseable token/type line: $_";
291 for (split ' ', $_) {
294 $just_tokens{$_} = $3;
299 *tokens = \%just_tokens; # perly.h needs this
300 die "$y_file: no __DEFAULT__ token defined\n" unless $default_token;
301 $types{$default_token} = 1;
303 $tablines =~ /^\Qstatic const char *const yytname[] =\E\n
308 or die "Can't extract yytname[] from table string\n";
310 $fields =~ s{"([^"]+)"}
312 (defined $tokens{$1} ? $tokens{$1} : $default_token)
314 $fields =~ s/, \s* (?:0|YY_NULL) \s* $//x
315 or die "make_type_tab: couldn't delete trailing ',0'\n";
318 "\ntypedef enum {\n\t"
319 . join(", ", map "toketype_$_", sort keys %types)
320 . "\n} toketypes;\n\n"
321 . "/* type of each token/terminal */\n"
322 . "static const toketypes yy_type_tab[] =\n{\n"
331 die "failed to execute command '@_': $!\n";
334 die sprintf "command '@_' died with signal %d\n",
338 die sprintf "command '@_' exited with value %d\n", $? >> 8;