chiark / gitweb /
Error handling: Provide err and ddbl_only, and an internal spec
[subdirmk.git] / generate
index 351926b80751b7f78ba4d95e3dbc7839fa6913ed..84572edc2ef842e0ceffacd884aa306851518831 100755 (executable)
--- a/generate
+++ b/generate
@@ -6,11 +6,11 @@
 #
 # $(srcdir)/subdirmk/generate [--srcdir=SRCDIR] [--] SUBDIR...
 #
-# generates in each subdirectory       from in each subdirectory
-#     Subdir.mk.tmp                        Subdir.sd.mk
-#     Makefile                          and included files
-# and in toplevel                      and in toplevel
-#     main.mk.tmp                          Perdir.sd.mk
+# generates in each subdirectory
+#     Subdir.mk.tmp
+#     Makefile
+# and in toplevel
+#     main.mk.tmp
 
 use strict;
 use POSIX;
@@ -19,6 +19,22 @@ print "$0 @ARGV\n" or die $!;
 
 our $srcdir='.';
 
+# error handling methods:
+#
+# Error in input file, while $err_file and $. set, eg in most of
+# process_input_mk:
+#         err "message";
+#
+# Other input or usage errors:
+#         die "$0: $file:$lno: problem\n";
+#         die "$0: some problem not locatable in that way\n";
+#
+# System call error (not ENOENT) accessing input/output files:
+#         die "description of problem eg maybe erbing noun: $!\n";
+#
+# Bug detedcted in `generate':
+#         die "internal error (some information)?"; # or similar
+
 while (@ARGV && $ARGV[0] =~ m/^-/) {
     $_ = shift @ARGV;
     last if $_ eq '--';
@@ -69,13 +85,31 @@ sub close_any_output_file() {
     $writing_output = undef;
 }
 
-sub o {
+sub oraw {
+    die unless defined $writing_output;
+    print O @_ or die "error writing $writing_output.tmp: $!\n";
+}
+
+sub oud { # undoubled
     if (defined $buffering_output) {
        $buffering_output .= $_ foreach @_;
        return;
     }
-    die unless defined $writing_output;
-    print O @_ or die "error writing $writing_output.tmp: $!\n";
+    oraw @_;
+}
+
+our $ddbl;
+
+sub od { # maybe $-doubled
+    if (!$ddbl) {
+       oud @_;
+       return;
+    }
+    foreach (@_) {
+       my $e = $_;
+       $e =~ s{\$}{\$\$}g;
+       oud $e;
+    }
 }
 
 sub start_output_file ($) {
@@ -84,7 +118,7 @@ sub start_output_file ($) {
     die "$writing_output ?" if $output_files{$writing_output}++;
     my $tmp = "$writing_output.tmp";
     open O, ">", $tmp or die "create $tmp: $!\n";
-    o "# autogenerated - do not edit\n";
+    oraw "# autogenerated - do not edit\n";
 }
 
 sub install_output_files () {
@@ -102,7 +136,7 @@ sub write_makefile ($$) {
     my $suppress_templates=
        '$(if $(filter-out clean real-clean, $(subdirmk_targets)),,'.
        ' MAKEFILE_TEMPLATES=)';
-    o <<END;
+    oraw <<END;
 default: all
 \$(filter-out all,\$(MAKECMDGOALS)) all: run-main.mk
        \@:
@@ -114,11 +148,39 @@ Makefile run-main.mk:
 END
 }
 
-sub process_input_mk ($$$$$$$$);
-sub process_input_mk ($$$$$$$$) {
-    my ($dir_prefix, $dir_suffix, $dir_name,
-       $var_prefix, $targets,
-       $f, $esclitr, $enoent_ok) = @_;
+our ($dir_prefix, $dir_suffix, $dir_name,
+     $var_prefix, $var_prefix_name);
+
+sub dir_prefix ($) {
+    my ($path) = @_;
+    join '', map { "$_/" } @$path;
+}
+
+sub set_dir_vars ($) {
+    my ($path) = @_;
+    $dir_prefix = dir_prefix($path);
+    $dir_suffix = join '', map { "/$_" } @$path;
+    $dir_name = join '/', @$path ? @$path : '.';
+    $var_prefix_name = join '_', @$path ? @$path : qw(TOP);
+    $var_prefix = "${var_prefix_name}_";
+}
+
+our $err_file;
+
+sub err ($) {
+    my ($m) = @_;
+    die "$0: ${err_file}:$.: $m\n";
+}
+
+sub ddbl_only ($) {
+    my ($e) = @_;
+    return if $ddbl;
+    err "escape &$e is valid only during \$-doubling";
+}
+
+sub process_input_mk ($$$$);
+sub process_input_mk ($$$$) {
+    my ($targets, $f, $esclitr, $enoent_ok) = @_;
 
     my $caps_re = qr{[A-Z]};
     my $lc_re = qr{[a-z]};
@@ -137,44 +199,95 @@ sub process_input_mk ($$$$$$$$) {
     }
     $input_files{$f}++;
 
+    local $err_file=$f;
+
+    my %srcdirmap = (
+                 '^' => "\$(top_srcdir)${dir_suffix}",
+                 '~' => "\$(top_srcdir)",
+                   );
     my %pfxmap = (
                  ''  => $dir_prefix,
-                 '^' => "\$(top_srcdir)${dir_suffix}/",
-                 '~' => "\$(top_srcdir)/",
                 );
+    $pfxmap{$_} = $srcdirmap{$_}.'/' foreach keys %srcdirmap;
+
+    local $ddbl;
+    my @nest = (['']);
+
+    my $push_nest = sub {
+       my ($nk, $nndbl) = @_;
+       unshift @nest, [ $nk, $ddbl ];
+       $ddbl = $nndbl;
+    };
+    my $pop_nest = sub {
+       my ($nk) = @_;
+       die unless $nest[0][0] eq $nk;
+       $ddbl = (shift @nest)[1];
+    };
 
     while (<$input>) {
-       if (s#^\s*$esc\:##) {
+       if (s#^\s*$esc\:changequote\s+(\S+)\s+$##) {
+           $$esclitr = $1;
+           $set_esc->();
+           next;
+       } elsif (s#^\s*$esc\:endm\s+$##) {
+           $pop_nest->('Macro');
+           od "endef\n";
+           next;
+       } elsif (s#^\s*$esc\:(?=(-?)include|macro)##) {
            $buffering_output='';
+       } elsif (m#^\s*$esc\:([a-z][-0-9a-z_]*)#) {
+           die "unknown directive $1";
+       } elsif (s{^\s*${esc}TARGETS(?:_([0-9a-zA-Z_]+))?(?=\W)}{}) {
+           my $t = $1 // 'all';
+           od target_varname($var_prefix, $t);
+           $targets->{$t} //= [ ];
        }
        for (;;) {
-           unless (s{^(.*?)(\\)?(?=$esc)}{}) { o $_; last; }
-           o $1;
-           if ($2) { s#^$esc##; o $$esclitr; next; }
-           s{^$esc}{} or die "$_ ?";
-           if (s{^$esc}{}) { o "$$esclitr$$esclitr" }
-           elsif (s{^TARGETS(?:_([0-9a-zA-Z_]+))?(?=\W)}{}) {
-               my $t = $1 // 'all';
-               o target_varname($var_prefix, $t);
-               $targets->{$t} //= [ ];
+           die if $ddbl && defined $buffering_output;
+           unless ($nest[0][0] eq 'Eval'
+                   ? s{^(.*?)($esc|[{}])}{}
+                   : s{^(.*?)($esc)}{}) { od $_; last; }
+           od $1;
+           if ($2 eq '{') {
+               $ddbl++;
+               next;
+           } elsif ($2 eq '}') {
+               next if --$ddbl;
+               $pop_nest->('Eval');
+               od '}}';
+               next;
            }
-           elsif (m{^(?=$caps_re)}) { o $var_prefix }
-           elsif (s{^([~^]?)(?=$lc_re)}{}) { o $pfxmap{$1} }
-           elsif (s{^_}{}) { o $var_prefix }
-           elsif (s{^=_}{}) { o $var_prefix }
-           elsif (s{^([~^]?)/}{}) { o $pfxmap{$1} }
-           elsif (s{^=/}{}) { o $dir_name }
-           elsif (s{^([~^]?)(?=[ \t])}{}) {
+           if (s{^\\$esc}{}) { od "$$esclitr" }
+           elsif (s{^\\\$}{}) { oud '$' }
+           elsif (s{^\\\s+$}{}) { }
+           elsif (s{^$esc}{}) { od "$$esclitr$$esclitr" }
+           elsif (m{^(?=$caps_re)}) { od $var_prefix }
+           elsif (s{^\$([A-Za-z]\w+)}{}) { od "\$(${var_prefix}$1)" }
+           elsif (s{^([~^]?)(?=$lc_re)}{}) { od $pfxmap{$1} }
+           elsif (s{^_}{}) { od $var_prefix }
+           elsif (s{^=}{}) { od $var_prefix_name }
+           elsif (s{^([~^]?)/}{}) { od $pfxmap{$1} }
+           elsif (s{^\.}{}) { od $dir_name }
+           elsif (s{^([~^])\.}{}) { od $srcdirmap{$1} }
+           elsif (s{^\$\-}{}) { $ddbl=undef; }
+           elsif (s{^\$\+}{}) { $ddbl=1; }
+           elsif (s{^\$\(}{}) { die unless $ddbl; oud "\$("; }
+           elsif (s{^\$(\d+)}{}) { die unless $ddbl; oud "\$($1)"; }
+           elsif (s{^\$\{}{}) {
+               die if $ddbl;
+               od '${eval ${call ';
+               $push_nest->('Eval',1);
+           } elsif (s{^([~^]?)(?=[ \t])}{}) {
                my $prefix = $pfxmap{$1} // die;
                my $after='';
                if (m{([ \t])$esc}) { ($_,$after) = ($`, $1.$'); }
                s{(?<=[ \t])(?=\S)(?!\\\s*$)}{$prefix}g;
-               o $_;
+               od $_;
                $_ = $after;
            } elsif (s{^\#}{}) {
                $_ = '';
            } elsif (s{^![ \t]+}{}) {
-               o $_;
+               od $_;
                $_ = '';
            } else {
                die "bad escape $$esclitr$_ ";
@@ -185,25 +298,23 @@ sub process_input_mk ($$$$$$$$) {
            $buffering_output=undef;
            if (m#^(-?)include\s+(\S+)\s+$#) {
                my $subf = "$srcdir/$2";
-               process_input_mk($dir_prefix, $dir_suffix, $dir_name,
-                                $var_prefix, $targets,
-                                $subf, $esclitr, $1);
-               o "\n";
-           } elsif (m#^changequote\s+(\S+)\s+$#) {
-               $$esclitr = $1;
-               $set_esc->();
+               process_input_mk($targets, $subf, $esclitr, $1);
+               od "\n";
+           } elsif (m#^macro\s+(\S+)\s+$#) {
+               od "define $1\n";
+               $push_nest->('Macro', 1);
            } else {
-               die "unknown directive $_ ";
+               die "internal error buffering directive $_ ";
            }
        }
     }
+    die "unclosed $nest[0][0]" if $nest[0][0];
     $input->error and die "read $f: $!\n";
     close $input or die "close $f: $!\n";
 }
 
-sub filter_subdir_mk ($$$$$) {
-    my ($dir_prefix, $dir_suffix, $dir_name,
-       $var_prefix, $targets) = @_;
+sub filter_subdir_mk ($) {
+    my ($targets) = @_;
 
     #use Data::Dumper;
     #print STDERR "filter @_\n";
@@ -212,27 +323,25 @@ sub filter_subdir_mk ($$$$$) {
 
     my $pi = sub {
        my ($f, $enoentok) = @_;
-       process_input_mk($dir_prefix, $dir_suffix, $dir_name,
-                        $var_prefix, $targets,
-                        "${srcdir}/$f", \$esclit, $enoentok);
+       process_input_mk($targets, "${srcdir}/$f", \$esclit, $enoentok);
     };
+    $pi->("Prefix.sd.mk",              1);
     $pi->("${dir_prefix}Subdir.sd.mk", 0);
-    $pi->("Perdir.sd.mk",              1);
+    $pi->("Suffix.sd.mk",              1);
 }
 
 sub process_subtree ($$);
 sub process_subtree ($$) {
-    # => list of descendants (in form SUBDIR/)
+    # => list of targets (in form SUBDIR/)
     # recursive, children first
     my ($node, $path) = @_;
 
     #use Data::Dumper;
     #print STDERR Dumper(\@_);
 
-    my $dir_prefix = join '', map { "$_/" } @$path;
-    my $dir_suffix = join '', map { "/$_" } @$path;
-    my $dir_name = join '/', @$path ? @$path : '.';
-    my $var_prefix = join '', map { "${_}_" } @$path ? @$path : qw(TOP);
+    my $dir_prefix = dir_prefix($path);
+    # ^ this is the only var which we need before we come back from
+    #   the recursion.
 
     push @output_makefiles, "${dir_prefix}Subdir.mk";
     write_makefile($dir_prefix, scalar @$path);
@@ -245,11 +354,12 @@ sub process_subtree ($$) {
        push @{ $targets{$_} }, $child_subdir foreach
            process_subtree($child, \@childpath);
     }
+
+    set_dir_vars($path);
     start_output_file("${dir_prefix}Subdir.mk.tmp");
 
     if ($node->[2]) {
-       filter_subdir_mk($dir_prefix, $dir_suffix, $dir_name,
-                        $var_prefix, \%targets);
+       filter_subdir_mk(\%targets);
     } else {
        my $sdmk = "${dir_prefix}Subdir.sd.mk";
        if (stat $sdmk) {
@@ -260,7 +370,7 @@ sub process_subtree ($$) {
        }
     }
 
-    o "\n";
+    oraw "\n";
 
     my @targets = sort keys %targets;
     foreach my $target (@targets) {
@@ -280,21 +390,35 @@ sub process_subtree ($$) {
     return @targets;
 }
 
+sub process_final ($) {
+    my ($otargets) = @_;
+    set_dir_vars([]);
+    push @output_makefiles, "Final.mk";
+    start_output_file("Final.mk.tmp");
+    my %ntargets;
+    my $esclit='&';
+    process_input_mk(\%ntargets, "${srcdir}/Final.sd.mk", \$esclit, 1);
+    delete $ntargets{$_} foreach @$otargets;
+    my @ntargets = sort keys %ntargets;
+    die "late new targets @ntargets" if @ntargets;
+}
+
 sub process_tree() {
-    process_subtree($root, [ ]);
+    my @targets = process_subtree($root, [ ]);
+    process_final(\@targets);
     start_output_file("main.mk.tmp");
     foreach my $v (qw(top_srcdir abs_top_srcdir)) {
-       o "$v=\@$v@\n";
+       oraw "$v=\@$v@\n";
     }
-    o "SUBDIRMK_MAKEFILES :=\n";
-    o "MAKEFILE_TEMPLATES :=\n";
+    oraw "SUBDIRMK_MAKEFILES :=\n";
+    oraw "MAKEFILE_TEMPLATES :=\n";
     foreach my $mf (@output_makefiles) {
-       o "SUBDIRMK_MAKEFILES += $mf\n";
+       oraw "SUBDIRMK_MAKEFILES += $mf\n";
     }
     foreach my $input (sort keys %input_files) {
-       o "MAKEFILE_TEMPLATES += $input\n";
+       oraw "MAKEFILE_TEMPLATES += $input\n";
     }
-    o "include \$(SUBDIRMK_MAKEFILES)\n";
+    oraw "include \$(SUBDIRMK_MAKEFILES)\n";
 }
 
 build_tree();