chiark / gitweb /
Warnings: Infrastructure for tracking and warning about variables
[subdirmk.git] / generate
index 0f9dd2d75ba289af83b4072812c13d92c2185b2f..03aabb056787e4e98a1d6d6f6167ec32b24620ec 100755 (executable)
--- a/generate
+++ b/generate
@@ -7,7 +7,7 @@
 # $(srcdir)/subdirmk/generate [--srcdir=SRCDIR] [--] SUBDIR...
 #
 # generates in each subdirectory
-#     Subdir.mk.tmp
+#     Dir.mk.tmp
 #     Makefile
 # and in toplevel
 #     main.mk.tmp
@@ -19,13 +19,32 @@ 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 "subdirmk: $file:$lno: problem\n";
+#         die "subdirmk: some problem not locatable in that way\n";
+#
+# Usage error:
+#         die "subdirmk $0: explanation of problem\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 '--';
     if (s/^--srcdir=//) {
        $srcdir=$';
     } else {
-       die "$0: unknown option \`$_'\n";
+       die "subdirmk $0: unknown option \`$_'\n";
     }
 }
 our @subdirs = @ARGV;
@@ -69,26 +88,41 @@ sub close_any_output_file() {
     $writing_output = undef;
 }
 
-sub o {
+sub oraw {
+    die 'internal error' 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
-    o @_;
+    if (!$ddbl) {
+       oud @_;
+       return;
+    }
+    foreach (@_) {
+       my $e = $_;
+       $e =~ s{\$}{\$\$}g;
+       oud $e;
+    }
 }
 
 sub start_output_file ($) {
     close_any_output_file();
     ($writing_output) = @_;
-    die "$writing_output ?" if $output_files{$writing_output}++;
+    die "internal error ($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 () {
@@ -106,7 +140,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
        \@:
@@ -118,6 +152,8 @@ Makefile run-main.mk:
 END
 }
 
+our %varref;
+
 our ($dir_prefix, $dir_suffix, $dir_name,
      $var_prefix, $var_prefix_name);
 
@@ -135,6 +171,24 @@ sub set_dir_vars ($) {
     $var_prefix = "${var_prefix_name}_";
 }
 
+our $err_file;
+
+sub err ($) {
+    my ($m) = @_;
+    die "subdirmk: ${err_file}:$.: $m\n";
+}
+
+sub wrn ($) {
+    my ($m) = @_;
+    print STDERR "subdirmk: warning: ${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) = @_;
@@ -151,11 +205,13 @@ sub process_input_mk ($$$$) {
 
     my $input = new IO::File $f, '<';
     if (!$input) {
-       die "open $f: $!\n" unless $!==ENOENT && $enoent_ok;
+       err "open $f: $!" unless $!==ENOENT && $enoent_ok;
        return;
     }
     $input_files{$f}++;
 
+    local $err_file=$f;
+
     my %srcdirmap = (
                  '^' => "\$(top_srcdir)${dir_suffix}",
                  '~' => "\$(top_srcdir)",
@@ -165,25 +221,67 @@ sub process_input_mk ($$$$) {
                 );
     $pfxmap{$_} = $srcdirmap{$_}.'/' foreach keys %srcdirmap;
 
+    local $ddbl;
+    my @nest = (['']);
+    my $evalcall_brackets;
+
+    my $push_nest = sub {
+       my ($nk, $nndbl, $what) = @_;
+       unshift @nest, [ $nk, $ddbl, $what, $. ];
+       $ddbl = $nndbl;
+    };
+    my $pop_nest = sub {
+       my ($nk) = @_;
+       err "unexpectedly closed $nk in middle of $nest[0][0] ($nest[0][2])"
+           unless $nest[0][0] eq $nk;
+       $ddbl = (shift @nest)[1];
+    };
+
+    # Our detection of variable settings does not have to be completely
+    # accurate, since it is only going to be used for advice to the user.
+    my $note_varref = sub {
+       my ($vn,$amp) = @_;
+       $varref{$vn}{$amp}{"$f:$."} = 1;
+    };
+
     while (<$input>) {
        if (s#^\s*$esc\:changequote\s+(\S+)\s+$##) {
            $$esclitr = $1;
            $set_esc->();
            next;
-       } elsif (s#^\s*$esc\:(?=(-?)include)##) {
+       } 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";
+           err "unknown directive &:$1 or bad argumnt syntax";
        } 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}{}) { od $_; last; }
+           err 'cannot $-double &-processed RHS of directive'
+               if $ddbl && defined $buffering_output;
+           unless ($nest[0][0] eq 'eval'
+                   ? s{^(.*?)($esc|[{}])}{}
+                   : s{^(.*?)($esc)}{}) { od $_; last; }
            od $1;
+           if ($2 eq '{') {
+               od $2;
+               $evalcall_brackets++;
+               next;
+           } elsif ($2 eq '}') {
+               od $2;
+               next if --$evalcall_brackets;
+               $pop_nest->('eval');
+               od '}';
+               next;
+           }
            if (s{^\\$esc}{}) { od "$$esclitr" }
-           elsif (s{^\\\$}{}) { od '$' }
+           elsif (s{^\\\$}{}) { oud '$' }
            elsif (s{^\\\s+$}{}) { }
            elsif (s{^$esc}{}) { od "$$esclitr$$esclitr" }
            elsif (m{^(?=$caps_re)}) { od $var_prefix }
@@ -194,8 +292,17 @@ sub process_input_mk ($$$$) {
            elsif (s{^([~^]?)/}{}) { od $pfxmap{$1} }
            elsif (s{^\.}{}) { od $dir_name }
            elsif (s{^([~^])\.}{}) { od $srcdirmap{$1} }
-           elsif (s{^([~^]?)(?=[ \t])}{}) {
-               my $prefix = $pfxmap{$1} // die;
+           elsif (s{^\$\-}{}) { $ddbl=undef; }
+           elsif (s{^\$\+}{}) { $ddbl=1; }
+           elsif (s{^\$\(}{}) { ddbl_only($&); oud "\$("; }
+           elsif (s{^\$(\d+)}{}) { ddbl_only($&); oud "\$($1)"; }
+           elsif (s{^\$\{}{}) {
+               err 'macro invocation cannot be re-$-doubled' if $ddbl;
+               od '${eval ${call ';
+               $evalcall_brackets = 1;
+               $push_nest->('eval',1, '&${...}');
+           } elsif (s{^([~^]?)(?=[ \t])}{}) {
+               my $prefix = $pfxmap{$1} // die "internal error ($1?)";
                my $after='';
                if (m{([ \t])$esc}) { ($_,$after) = ($`, $1.$'); }
                s{(?<=[ \t])(?=\S)(?!\\\s*$)}{$prefix}g;
@@ -207,7 +314,8 @@ sub process_input_mk ($$$$) {
                od $_;
                $_ = '';
            } else {
-               die "bad escape $$esclitr$_ ";
+               m{^.{0,5}};
+               err "bad &-escape \`$$esclitr$&'";
            }
        }
        if (defined $buffering_output) {
@@ -217,11 +325,16 @@ sub process_input_mk ($$$$) {
                my $subf = "$srcdir/$2";
                process_input_mk($targets, $subf, $esclitr, $1);
                od "\n";
+           } elsif (m#^macro\s+(\S+)\s+$#) {
+               od "define $1\n";
+               $push_nest->('macro', 1, '&:macro');
            } else {
-               die "internal error buffering directive $_ ";
+               err "bad directive argument syntax";
            }
        }
     }
+    die "subdirmk: $f:$nest[0][3]: unclosed $nest[0][0] ($nest[0][2])\n"
+       if $nest[0][0];
     $input->error and die "read $f: $!\n";
     close $input or die "close $f: $!\n";
 }
@@ -238,9 +351,9 @@ sub filter_subdir_mk ($) {
        my ($f, $enoentok) = @_;
        process_input_mk($targets, "${srcdir}/$f", \$esclit, $enoentok);
     };
-    $pi->("Prefix.sd.mk",              1);
-    $pi->("${dir_prefix}Subdir.sd.mk", 0);
-    $pi->("Suffix.sd.mk",              1);
+    $pi->("Prefix.sd.mk",           1);
+    $pi->("${dir_prefix}Dir.sd.mk", 0);
+    $pi->("Suffix.sd.mk",           1);
 }
 
 sub process_subtree ($$);
@@ -256,48 +369,49 @@ sub process_subtree ($$) {
     # ^ this is the only var which we need before we come back from
     #   the recursion.
 
-    push @output_makefiles, "${dir_prefix}Subdir.mk";
+    push @output_makefiles, "${dir_prefix}Dir.mk";
     write_makefile($dir_prefix, scalar @$path);
 
     my %targets = (all => []);
     foreach my $child (@{ $node->[1] }) {
        my @childpath = (@$path, $child->[0]);
        my $child_subdir = join '/', @childpath;
-       mkdir $child_subdir or $!==EEXIST or die "mkdir $child_subdir: $!";
+       mkdir $child_subdir or $!==EEXIST or die "mkdir $child_subdir: $!\n";
        push @{ $targets{$_} }, $child_subdir foreach
            process_subtree($child, \@childpath);
     }
 
     set_dir_vars($path);
-    start_output_file("${dir_prefix}Subdir.mk.tmp");
+    start_output_file("${dir_prefix}Dir.mk.tmp");
 
     if ($node->[2]) {
        filter_subdir_mk(\%targets);
     } else {
-       my $sdmk = "${dir_prefix}Subdir.sd.mk";
+       my $sdmk = "${dir_prefix}Dir.sd.mk";
        if (stat $sdmk) {
-           die "$sdmk unexpectedly exists (${dir_prefix} not mentioned)";
+           die
+ "subdirmk: $sdmk unexpectedly exists (${dir_prefix} not mentioned on subdirmk/generate command line, maybe directory is missing from SUBDIRMK_SUBDIRS)";
        } elsif ($!==ENOENT) {
        } else {
-           die "stat $sdmk: $!";
+           die "stat $sdmk: $!\n";
        }
     }
 
-    o "\n";
+    oraw "\n";
 
     my @targets = sort keys %targets;
     foreach my $target (@targets) {
        my $target_varname = target_varname($var_prefix, $target);
-       print O "${dir_prefix}${target}:: \$($target_varname)";
+       oraw "${dir_prefix}${target}:: \$($target_varname)";
        foreach my $child_subdir (@{ $targets{$target} }) {
-           print O " $child_subdir/$target";
+           oraw " $child_subdir/$target";
        }
-       print O "\n";
+       oraw "\n";
     }
     if (@targets) {
-       print O ".PHONY:";
-       print O " ${dir_prefix}${_}" foreach @targets;
-       print O "\n";
+       oraw ".PHONY:";
+       oraw " ${dir_prefix}${_}" foreach @targets;
+       oraw "\n";
     }
 
     return @targets;
@@ -313,7 +427,8 @@ sub process_final ($) {
     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;
+    die "subdirmk: Final.sd.mk may not introduce new top-level targets".
+       " (@ntargets)\n" if @ntargets;
 }
 
 sub process_tree() {
@@ -321,19 +436,33 @@ sub process_tree() {
     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";
+    }
+    oraw "include \$(SUBDIRMK_MAKEFILES)\n";
+}
+
+sub print_varref_warnings () {
+    foreach my $vn (sort keys %varref) {
+       my $vv = $varref{$vn};
+       next unless $vv->{''} && $vv->{1};
+       print STDERR "subdirmk: warning: saw both $vn and &$vn\n";
+       foreach my $amp ('', 1) {
+           printf STDERR " saw %s%s at %s\n",
+               ($amp ? '&' : ''), $vn, $_
+               foreach sort keys %{ $vv->{$amp} };
+       }
     }
-    o "include \$(SUBDIRMK_MAKEFILES)\n";
 }
 
 build_tree();
 process_tree();
+print_varref_warnings();
 install_output_files();