3 # subdirmk - &-filter (makefile generation program)
4 # Copyright 2019 Ian Jackson
5 # SPDX-License-Identifier: LGPL-2.0-or-later
7 # $(srcdir)/subdirmk/generate [--srcdir=SRCDIR] [--] SUBDIR...
9 # generates in each subdirectory
18 print "$0 @ARGV\n" or die $!;
22 # error handling methods:
24 # Error in input file, while $err_file and $. set, eg in most of
28 # Other input or usage errors:
29 # die "subdirmk: $file:$lno: problem\n";
30 # die "subdirmk: some problem not locatable in that way\n";
33 # die "subdirmk $0: explanation of problem\n";
35 # System call error (not ENOENT) accessing input/output files:
36 # die "description of problem eg maybe erbing noun: $!\n";
38 # Bug detedcted in `generate':
39 # die "internal error (some information)?"; # or similar
41 while (@ARGV && $ARGV[0] =~ m/^-/) {
47 die "subdirmk $0: unknown option \`$_'\n";
52 s{/+$}{} foreach @subdirs;
54 our $root = [ '.', [ ], 1 ];
55 # each node is [ 'relative subdir name', \@children, $mentioned ]
58 foreach my $subdir (@subdirs) {
59 my @path = $subdir eq '.' ? () : split m{/+}, $subdir;
61 foreach my $d (@path) {
62 my ($c,) = grep { $_->[0] eq $d } @{ $node->[1] };
65 push @{ $node->[1] }, $c;
73 sub target_varname ($$) {
74 my ($var_prefix, $target) = @_;
75 return $var_prefix.'TARGETS'.($target eq 'all' ? '' : "_$target");
79 our $buffering_output;
82 our @output_makefiles;
84 sub close_any_output_file() {
85 return unless defined $writing_output;
86 O->error and die "error writing $writing_output.tmp: $! (?)\n";
87 close O or die "error closing $writing_output.tmp: $!\n";
88 $writing_output = undef;
92 die 'internal error' unless defined $writing_output;
93 print O @_ or die "error writing $writing_output.tmp: $!\n";
97 if (defined $buffering_output) {
98 $buffering_output .= $_ foreach @_;
106 sub od { # maybe $-doubled
118 sub start_output_file ($) {
119 close_any_output_file();
120 ($writing_output) = @_;
121 die "internal error ($writing_output?)"
122 if $output_files{$writing_output}++;
123 my $tmp = "$writing_output.tmp";
124 open O, ">", $tmp or die "create $tmp: $!\n";
125 oraw "# autogenerated - do not edit\n";
128 sub install_output_files () {
129 close_any_output_file();
130 foreach my $f (sort keys %output_files) {
131 rename "$f.tmp", $f or die "install new $f: $!\n";
135 sub write_makefile ($$) {
136 my ($dir_prefix,$depth) = @_;
137 #print STDERR "write_makefile @_\n";
138 start_output_file("${dir_prefix}Makefile");
139 my $cd = $depth ? join('/', ('..',) x $depth) : '.';
140 my $suppress_templates=
141 '$(if $(filter-out clean real-clean, $(subdirmk_targets)),,'.
142 ' MAKEFILE_TEMPLATES=)';
145 \$(filter-out all,\$(MAKECMDGOALS)) all: run-main.mk
147 subdirmk_targets:=\$(or \$(MAKECMDGOALS),all)
148 Makefile run-main.mk:
149 \$(MAKE) -C $cd -f main.mk \$(addprefix ${dir_prefix},\$(subdirmk_targets))$suppress_templates
157 our ($dir_prefix, $dir_suffix, $dir_name,
158 $var_prefix, $var_prefix_name);
162 join '', map { "$_/" } @$path;
165 sub set_dir_vars ($) {
167 $dir_prefix = dir_prefix($path);
168 $dir_suffix = join '', map { "/$_" } @$path;
169 $dir_name = join '/', @$path ? @$path : '.';
170 $var_prefix_name = join '_', @$path ? @$path : qw(TOP);
171 $var_prefix = "${var_prefix_name}_";
178 die "subdirmk: ${err_file}:$.: $m\n";
183 print STDERR "subdirmk: warning: ${err_file}:$.: $m\n";
189 err "escape &$e is valid only during \$-doubling";
192 sub process_input_mk ($$$$);
193 sub process_input_mk ($$$$) {
194 my ($targets, $f, $esclitr, $enoent_ok) = @_;
196 my $caps_re = qr{[A-Z]};
197 my $lc_re = qr{[a-z]};
206 my $input = new IO::File $f, '<';
208 err "open $f: $!" unless $!==ENOENT && $enoent_ok;
216 '^' => "\$(top_srcdir)${dir_suffix}",
217 '~' => "\$(top_srcdir)",
222 $pfxmap{$_} = $srcdirmap{$_}.'/' foreach keys %srcdirmap;
226 my $evalcall_brackets;
228 my $push_nest = sub {
229 my ($nk, $nndbl, $what) = @_;
230 unshift @nest, [ $nk, $ddbl, $what, $. ];
235 err "unexpectedly closed $nk in middle of $nest[0][0] ($nest[0][2])"
236 unless $nest[0][0] eq $nk;
237 $ddbl = (shift @nest)[1];
240 # Our detection of variable settings does not have to be completely
241 # accurate, since it is only going to be used for advice to the user.
242 my $note_varref = sub {
244 $varref{$vn}{$amp}{"$f:$."} = 1;
248 if (m#^\s*($esc)?(\w+)\s*(?:=|\+=|\?=|:=)# ||
249 m#^\s*(?:$esc\:macro|define)\s+($esc)?(\S+)\s#) {
250 $note_varref->($2,!!$1);
252 if (s#^\s*$esc\:changequote\s+(\S+)\s+$##) {
256 } elsif (s#^\s*$esc\:endm\s+$##) {
257 $pop_nest->('macro');
260 } elsif (s#^\s*$esc\:(?=(-?)include|macro)##) {
261 $buffering_output='';
262 } elsif (m#^\s*$esc\:([a-z][-0-9a-z_]*)#) {
263 err "unknown directive &:$1 or bad argumnt syntax";
264 } elsif (s{^\s*${esc}TARGETS(?:_([0-9a-zA-Z_]+))?(?=\W)}{}) {
266 my $vn = target_varname($var_prefix, $t);
267 $note_varref->($vn,1);
269 $targets->{$t} //= [ ];
272 err 'cannot $-double &-processed RHS of directive'
273 if $ddbl && defined $buffering_output;
274 unless ($nest[0][0] eq 'eval'
275 ? s{^(.*?)($esc|\$|[{}])}{}
276 : s{^(.*?)($esc|\$)}{}) { od $_; last; }
280 $evalcall_brackets++;
282 } elsif ($2 eq '}') {
284 next if --$evalcall_brackets;
288 } elsif ($2 eq '$') {
290 if (s{^\$}{}) { od $&; }
291 elsif (m{^[a-zA-Z]\w}) {
293 'possibly confusing unbracketed single-char $-expansion';
295 elsif (m{^\(($esc)?([^()\$]+)\)} ||
296 m{^\{($esc)?([^{}\$]+)\}}) {
297 $note_varref->($2,!!$1);
301 if (s{^\\$esc}{}) { od "$$esclitr" }
302 elsif (s{^\\\$}{}) { oud '$' }
303 elsif (s{^\\\s+$}{}) { }
304 elsif (s{^$esc}{}) { od "$$esclitr$$esclitr" }
305 elsif (m{^(?=$caps_re)}) { od $var_prefix }
306 elsif (s{^\$([A-Za-z]\w+)}{}) {
307 $note_varref->($1,1);
308 od "\$(${var_prefix}$1)";
310 elsif (s{^([~^]?)(?=$lc_re)}{}) { od $pfxmap{$1} }
311 elsif (s{^_}{}) { od $var_prefix }
312 elsif (s{^=}{}) { od $var_prefix_name }
313 elsif (s{^([~^]?)/}{}) { od $pfxmap{$1} }
314 elsif (s{^\.}{}) { od $dir_name }
315 elsif (s{^([~^])\.}{}) { od $srcdirmap{$1} }
316 elsif (s{^\$\-}{}) { $ddbl=undef; }
317 elsif (s{^\$\+}{}) { $ddbl=1; }
319 ddbl_only($&); oud "\$(";
320 $note_varref->($2,!!$1) if m{^($esc)?([^()\$]+\))};
322 elsif (s{^\$(\d+)}{}) { ddbl_only($&); oud "\$($1)"; }
324 err 'macro invocation cannot be re-$-doubled' if $ddbl;
326 $evalcall_brackets = 1;
327 $push_nest->('eval',1, '&${...}');
328 $note_varref->($2,!!$1) if m{^\s*($esc)?([^,{}\$]+)};
329 } elsif (s{^([~^]?)(?=[ \t])}{}) {
330 my $prefix = $pfxmap{$1} // die "internal error ($1?)";
332 if (m{([ \t])$esc}) { ($_,$after) = ($`, $1.$'); }
333 s{(?<=[ \t])(?=\S)(?!\\\s*$)}{$prefix}g;
338 } elsif (s{^![ \t]+}{}) {
343 err "bad &-escape \`$$esclitr$&'";
346 if (defined $buffering_output) {
347 $_=$buffering_output;
348 $buffering_output=undef;
349 if (m#^(-?)include\s+(\S+)\s+$#) {
350 my $subf = "$srcdir/$2";
351 process_input_mk($targets, $subf, $esclitr, $1);
353 } elsif (m#^macro\s+(\S+)\s+$#) {
355 $push_nest->('macro', 1, '&:macro');
357 err "bad directive argument syntax";
361 die "subdirmk: $f:$nest[0][3]: unclosed $nest[0][0] ($nest[0][2])\n"
363 $input->error and die "read $f: $!\n";
364 close $input or die "close $f: $!\n";
367 sub filter_subdir_mk ($) {
371 #print STDERR "filter @_\n";
376 my ($f, $enoentok) = @_;
377 process_input_mk($targets, "${srcdir}/$f", \$esclit, $enoentok);
379 $pi->("Prefix.sd.mk", 1);
380 $pi->("${dir_prefix}Dir.sd.mk", 0);
381 $pi->("Suffix.sd.mk", 1);
384 sub process_subtree ($$);
385 sub process_subtree ($$) {
386 # => list of targets (in form SUBDIR/)
387 # recursive, children first
388 my ($node, $path) = @_;
391 #print STDERR Dumper(\@_);
393 my $dir_prefix = dir_prefix($path);
394 # ^ this is the only var which we need before we come back from
397 push @output_makefiles, "${dir_prefix}Dir.mk";
398 write_makefile($dir_prefix, scalar @$path);
400 my %targets = (all => []);
401 foreach my $child (@{ $node->[1] }) {
402 my @childpath = (@$path, $child->[0]);
403 my $child_subdir = join '/', @childpath;
404 mkdir $child_subdir or $!==EEXIST or die "mkdir $child_subdir: $!\n";
405 push @{ $targets{$_} }, $child_subdir foreach
406 process_subtree($child, \@childpath);
410 start_output_file("${dir_prefix}Dir.mk.tmp");
413 filter_subdir_mk(\%targets);
415 my $sdmk = "${dir_prefix}Dir.sd.mk";
418 "subdirmk: $sdmk unexpectedly exists (${dir_prefix} not mentioned on subdirmk/generate command line, maybe directory is missing from SUBDIRMK_SUBDIRS)";
419 } elsif ($!==ENOENT) {
421 die "stat $sdmk: $!\n";
427 my @targets = sort keys %targets;
428 foreach my $target (@targets) {
429 my $target_varname = target_varname($var_prefix, $target);
430 oraw "${dir_prefix}${target}:: \$($target_varname)";
431 foreach my $child_subdir (@{ $targets{$target} }) {
432 oraw " $child_subdir/$target";
438 oraw " ${dir_prefix}${_}" foreach @targets;
445 sub process_final ($) {
448 push @output_makefiles, "Final.mk";
449 start_output_file("Final.mk.tmp");
452 process_input_mk(\%ntargets, "${srcdir}/Final.sd.mk", \$esclit, 1);
453 delete $ntargets{$_} foreach @$otargets;
454 my @ntargets = sort keys %ntargets;
455 die "subdirmk: Final.sd.mk may not introduce new top-level targets".
456 " (@ntargets)\n" if @ntargets;
460 my @targets = process_subtree($root, [ ]);
461 process_final(\@targets);
462 start_output_file("main.mk.tmp");
463 foreach my $v (qw(top_srcdir abs_top_srcdir)) {
466 oraw "SUBDIRMK_MAKEFILES :=\n";
467 oraw "MAKEFILE_TEMPLATES :=\n";
468 foreach my $mf (@output_makefiles) {
469 oraw "SUBDIRMK_MAKEFILES += $mf\n";
471 foreach my $input (sort keys %input_files) {
472 oraw "MAKEFILE_TEMPLATES += $input\n";
474 oraw "include \$(SUBDIRMK_MAKEFILES)\n";
477 sub print_varref_warnings () {
478 foreach my $vn (sort keys %varref) {
479 my $vv = $varref{$vn};
480 next unless $vv->{''} && $vv->{1};
481 print STDERR "subdirmk: warning: saw both $vn and &$vn\n";
482 foreach my $amp ('', 1) {
483 printf STDERR " saw %s%s at %s\n",
484 ($amp ? '&' : ''), $vn, $_
485 foreach sort keys %{ $vv->{$amp} };
492 print_varref_warnings();
493 install_output_files();