This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Prevent double frees/crashes with format syntax errs
[perl5.git] / regen_perly.pl
index eaa4785..124b031 100644 (file)
@@ -2,7 +2,7 @@
 #
 # regen_perly.pl, DAPM 12-Feb-04
 #
-# Copyright (c) 2004 Larry Wall
+# Copyright (c) 2004, 2005, 2006, 2009, 2010, 2011 Larry Wall
 #
 # Given an input file perly.y, run bison on it and produce
 # the following output files:
@@ -11,6 +11,7 @@
 #              #line directives plus adding a #ifdef PERL_CORE
 #
 # perly.tab    the parser table C definitions extracted from the bison output
+#              plus an extra table generated by this script.
 #
 # perly.act    the action case statements extracted from the bison output
 #
 # it may work elsewhere but no specific attempt has been made to make it
 # portable.
 
+use 5.006;
 sub usage { die "usage: $0 [ -b bison_executable ] [ file.y ]\n" }
 
 use warnings;
 use strict;
 
+BEGIN { require 'regen/regen_lib.pl'; }
+
 my $bison = 'bison';
 
 if (@ARGV >= 2 and $ARGV[0] eq '-b') {
@@ -60,18 +64,20 @@ die "$0: must be run on an ASCII system\n" unless ord 'A' == 65;
 #    this; 1.35+ does
 #  * Must produce output which is extractable by the regexes below
 #  * Must produce the right values.
-# These last two contstraints  may well be met by earlier versions, but
+# These last two constraints  may well be met by earlier versions, but
 # I simply haven't tested them yet. If it works for you, then modify
 # the test below to allow that version too. DAPM Feb 04.
 
 my $version = `$bison -V`;
-unless ($version =~ /\b(1\.875|2\.0)\b/) { die <<EOF; }
+unless ($version) { die <<EOF; }
+Could not find a version of bison in your path. Please install bison.
+EOF
+
+unless ($version =~ /\b(1\.875[a-z]?|2\.[01345])\b/) { die <<EOF; }
 
 You have the wrong version of bison in your path; currently 1.875
-or 2.0 is required.  Try installing
-    http://ftp.gnu.org/gnu/bison/bison-2.0.tar.gz
-or
-    http://ftp.gnu.org/gnu/bison/bison-1.875.tar.bz2
+2.0, 2.1, 2.3, 2.4 or 2.5 is required.  Try installing
+    http://ftp.gnu.org/gnu/bison/bison-2.5.1.tar.gz
 or similar.  Your bison identifies itself as:
 
 $version
@@ -80,51 +86,82 @@ EOF
 # creates $tmpc_file and $tmph_file
 my_system("$bison -d -o $tmpc_file $y_file");
 
-open CTMPFILE, $tmpc_file or die "Can't open $tmpc_file: $!\n";
+open my $ctmp_fh, '<', $tmpc_file or die "Can't open $tmpc_file: $!\n";
 my $clines;
-{ local $/; $clines = <CTMPFILE>; }
+{ local $/; $clines = <$ctmp_fh>; }
 die "failed to read $tmpc_file: length mismatch\n"
     unless length $clines == -s $tmpc_file;
-close CTMPFILE;
+close $ctmp_fh;
 
 my ($actlines, $tablines) = extract($clines);
 
-chmod 0644, $act_file;
-open ACTFILE, ">$act_file" or die "can't open $act_file: $!\n";
-print ACTFILE $actlines;
-close ACTFILE;
-chmod 0444, $act_file;
+our %tokens;
+$tablines .= make_type_tab($y_file, $tablines);
+
+my ($act_fh, $tab_fh, $h_fh) = map {
+    open_new($_, '>', { by => $0, from => $y_file });
+} $act_file, $tab_file, $h_file;
+
+print $act_fh $actlines;
 
-chmod 0644, $tab_file;
-open TABFILE, ">$tab_file" or die "can't open $tab_file: $!\n";
-print TABFILE $tablines;
-close TABFILE;
-chmod 0444, $tab_file;
+print $tab_fh $tablines;
 
 unlink $tmpc_file;
 
 # Wrap PERL_CORE round the symbol definitions. Also,  the
-# C<#line 123 "perlytmp.h"> gets picked up by make depend, so change it.
+# C<#line 30 "perly.y"> confuses the Win32 resource compiler and the
+# C<#line 188 "perlytmp.h"> gets picked up by make depend, so remove them.
+
+open my $tmph_fh, '<', $tmph_file or die "Can't open $tmph_file: $!\n";
 
-open TMPH_FILE, $tmph_file or die "Can't open $tmph_file: $!\n";
-chmod 0644, $h_file;
-open H_FILE, ">$h_file" or die "Can't open $h_file: $!\n";
 my $endcore_done = 0;
-while (<TMPH_FILE>) {
-    print H_FILE "#ifdef PERL_CORE\n" if $. == 1;
+# Token macros need to be generated manually from bison 2.4 on
+my $gather_tokens = ($version =~ /\b2\.[45]\b/ ? undef : 0);
+my $tokens;
+while (<$tmph_fh>) {
+    print $h_fh "#ifdef PERL_CORE\n" if $. == 1;
     if (!$endcore_done and /YYSTYPE_IS_DECLARED/) {
-       print H_FILE "#endif /* PERL_CORE */\n";
+       print $h_fh <<h;
+#ifdef PERL_IN_TOKE_C
+static bool
+S_is_opval_token(int type) {
+    switch (type) {
+h
+       print $h_fh <<i for sort grep $tokens{$_} eq 'opval', keys %tokens;
+    case $_:
+i
+       print $h_fh <<j;
+       return 1;
+    }
+    return 0;
+}
+#endif /* PERL_IN_TOKE_C */
+#endif /* PERL_CORE */
+j
        $endcore_done = 1;
     }
-    s/"perlytmp.h"/"perly.h"/;
-    print H_FILE $_;
+    next if /^#line \d+ ".*"/;
+    if (not defined $gather_tokens) {
+       $gather_tokens = 1 if /^\s* enum \s* yytokentype \s* \{/x;
+    }
+    elsif ($gather_tokens) {
+       if (/^\# \s* endif/x) { # The #endif just after the end of the token enum
+           $gather_tokens = 0;
+           $_ .= "\n/* Tokens.  */\n$tokens";
+       }
+       else {
+           my ($tok, $val) = /(\w+) \s* = \s* (\d+)/x;
+           $tokens .= "#define $tok $val\n" if $tok;
+       }
+    }
+    print $h_fh $_;
 }
-close TMPH_FILE;
-close H_FILE;
-chmod 0444, $h_file;
+close $tmph_fh;
 unlink $tmph_file;
 
-print "rebuilt:  $h_file $tab_file $act_file\n";
+foreach ($act_fh, $tab_fh, $h_fh) {
+    read_only_bottom_close_and_rename($_, ['regen_perly.pl', $y_file]);
+}
 
 exit 0;
 
@@ -151,34 +188,138 @@ sub extract {
     $clines =~ m@
        switch \s* \( \s* \w+ \s* \) \s* { \s*
        (
-           case \s* \d+ \s* : \s*
-           \#line [^\n]+"perly\.y"
+           case \s* \d+ \s* :
+           \s*
+           (?: \s* /\* .*? \*/ \s* )*  # optional C-comments
+           \s*
+           \#line [^\n]+"\Q$y_file\E"
            .*?
        )
        }
        \s*
-       ( \s* /\* .*? \*/ \s* )*        # optional C-comments
+       (?: \s* /\* .*? \*/ \s* )*      # optional C-comments
        \s*
        (
            \#line[^\n]+\.c"
        |
            \#line[^\n]+\.simple"
+       |
+           YY_SYMBOL_PRINT
        )
     @xms
        or die "Can't extract actions from $tmpc_file\n";
     $actlines = $1;
 
+    # Remove extraneous comments from bison 2.4
+    $actlines =~ s!\s* /\* \s* Line \s* \d+ \s* of \s* yacc\.c \s* \*/!!gx;
+
+    # C<#line 188 "perlytmp.c"> gets picked up by make depend, so remove them.
+    $actlines =~ s/^#line \d+ "\Q$tmpc_file\E".*$//gm;
+
+    # convert yyvsp[nnn] into ps[nnn].val
+
+    $actlines =~ s/yyvsp\[(.*?)\]/ps[$1].val/g
+       or die "Can't convert value stack name\n";
+
     return $actlines. "\n", $tablines. "\n";
 }
 
-       
-           
+# Generate a table, yy_type_tab[], that specifies for each token, what
+# type of value it holds.
+#
+# Read the .y file and extract a list of all the token names and
+# non-terminal names; then scan the string $tablines for the table yytname,
+# which gives the token index of each token/non-terminal; then use this to
+# create yy_type_tab.
+#
+# ie given (in perly.y),
+#
+#   %token <opval> A
+#   %token <ival>  B
+#   %type  <pval>  C
+#   %type  <opval> D
+#
+# and (in $tablines),
+#
+#   yytname[] = { "A" "B", "C", "D", "E" };
+#
+# then return
+#
+#    typedef enum { toketype_ival, toketype_opval, toketype_pval } toketypes;
+#
+#    static const toketypes yy_type_tab[]
+#          = { toketype_opval, toketype_ival, toketype_pval,
+#                toketype_opval, toketype_ival }
+#
+# where "E" has the default type. The default type is determined
+# by the __DEFAULT__ comment  next to the appropriate union member in
+# perly.y
+
+sub make_type_tab {
+    my ($y_file, $tablines) = @_;
+    my %just_tokens;
+    my %tokens;
+    my %types;
+    my $default_token;
+    open my $fh, '<', $y_file or die "Can't open $y_file: $!\n";
+    while (<$fh>) {
+       if (/(\$\d+)\s*=/) {
+           warn "$y_file:$.: dangerous assignment to $1: $_";
+       }
+
+       if (/__DEFAULT__/) {
+           m{(\w+) \s* ; \s* /\* \s* __DEFAULT__}x
+               or die "$y_file: can't parse __DEFAULT__ line: $_";
+           die "$y_file: duplicate __DEFAULT__ line: $_"
+                   if defined $default_token;
+           $default_token = $1;
+           next;
+       }
+
+       next unless /^%(token|type)/;
+       s/^%((token)|type)\s+<(\w+)>\s+//
+           or die "$y_file: unparseable token/type line: $_";
+       for (split ' ', $_) {
+           $tokens{$_} = $3;
+           if ($2) {
+               $just_tokens{$_} = $3;
+           }
+       }
+       $types{$3} = 1;
+    }
+    *tokens = \%just_tokens; # perly.h needs this
+    die "$y_file: no __DEFAULT__ token defined\n" unless $default_token;
+    $types{$default_token} = 1;
+
+    $tablines =~ /^\Qstatic const char *const yytname[] =\E\n
+           \{\n
+           (.*?)
+           ^};
+           /xsm
+       or die "Can't extract yytname[] from table string\n";
+    my $fields = $1;
+    $fields =~ s{"([^"]+)"}
+               { "toketype_" .
+                   (defined $tokens{$1} ? $tokens{$1} : $default_token)
+               }ge;
+    $fields =~ s/, \s* 0 \s* $//x
+       or die "make_type_tab: couldn't delete trailing ',0'\n";
+
+    return 
+         "\ntypedef enum {\n\t"
+       . join(", ", map "toketype_$_", sort keys %types)
+       . "\n} toketypes;\n\n"
+       . "/* type of each token/terminal */\n"
+       . "static const toketypes yy_type_tab[] =\n{\n"
+       . $fields
+       . "\n};\n";
+}
 
 
 sub my_system {
     system(@_);
     if ($? == -1) {
-       die "failed to execute comamnd '@_': $!\n";
+       die "failed to execute command '@_': $!\n";
     }
     elsif ($? & 127) {
        die sprintf "command '@_' died with signal %d\n",