]> git.draconx.ca Git - cdecl99.git/blobdiff - fix-gnulib.pl
Better document fix-gnulib.
[cdecl99.git] / fix-gnulib.pl
index 6663e6e4b49c333eb95b53fcb10b0657f6d7417c..85ae6321980e743632f2e3c911e3b2314f460139 100755 (executable)
@@ -1,8 +1,40 @@
 #!/usr/bin/env perl
 #
-# Copyright © 2011 Nick Bowler
+# Copyright © 2011-2012 Nick Bowler
 #
 # Prepare the Gnulib tree for inclusion into a non-recursive automake build.
+# While the output of gnulib-tool is "include"-able if the --makefile-name
+# option is used, it is still not suitable for non-recursive use for a couple
+# reasons; chief among them is that filenames are not relative to the top
+# source directory.
+#
+# This script postprocesses the gnulib-tool output to produce something that
+# is intended to be suitable for inclusion into such non-recursive build
+# environments.  Since the integration involves both configure.ac and
+# Makefile.am, the output must be included into _both_.  Supposing the output
+# is written to lib/gnulib.mk, you would add:
+#
+#   m4_include([lib/gnulib.mk]) # to configure.ac, after any call to gl_INIT
+#   include $(top_srcdir)/lib/gnulib.mk # to Makefile.am
+#
+# You must also arrange for the Gnulib-generated header files to be built
+# before the object files which depend on them; the most robust way to do this
+# is by explicit prerequisites, for example:
+#
+#   bin_PROGRAMS = foo
+#   $(foo_OBJECTS): $(gnulib_headers)
+#
+# The $(gnulib_headers) variable will expand to GNU-make order-only
+# prerequisites when available, avoiding spurious incremental rebuilds when
+# unused headers are changed.  If this feature is not available, it will
+# expand to ordinary prerequisites.  It is therefore only appropriate for use
+# in target prerequisites; the $(gnulib_raw_headers) variable may be used in
+# other contexts when only the list of header files is required.
+#
+# This script also provides machinery for Gnulib symbol renaming via the
+# glconfig.mk Makefile.am snippet; use of this feature is optional.
+#
+# Most of the specific transformations are documented below.
 #
 # License WTFPL2: Do What The Fuck You Want To Public License, version 2.
 # This is free software: you are free to do what the fuck you want to.
@@ -14,15 +46,13 @@ use Getopt::Long;
 
 my $output   = undef;
 my $input    = undef;
-my $m4output = undef;
-my $m4macro  = "DX_FIX_GNULIB";
+
+my $line     = 0;
 
 Getopt::Long::Configure("gnu_getopt", "no_auto_abbrev");
 GetOptions(
        "o|output=s"   => \$output,
        "i|input=s"    => \$input,
-       "m|m4output=s" => \$m4output,
-       "M|m4macro=s"  => \$m4macro,
 );
 
 open STDOUT, ">", $output or die "$output: $!\n" if (defined $output);
@@ -30,6 +60,7 @@ open STDIN,  "<", $input  or die "$input: $!\n"  if (defined $input);
 
 my $printed_header = 0;
 my (%allvars, %sourcevars);
+my @cleanfiles;
 
 sub drop {
        undef $_;
@@ -55,7 +86,7 @@ sub mangle_file {
                # Fix up things that look like filenames.
                $word = "lib/$word";
        } else {
-               print STDERR "$0: warning: unrecognized source file: $word\n";
+               print STDERR "$0:$line: warning: unrecognized source file: $word\n";
        }
 
        return "$word";
@@ -64,7 +95,7 @@ sub mangle_file {
 sub mangle_variable {
        my $raw = shift;
 
-       $raw =~ /([^=]+=)[[:space:]]*(.*)/;
+       $raw =~ /([^=]+=)[[:space:]]*(.*)/s;
        my ($left, @right) = ($1, split(/[[:space:]]+/, $2));
 
        return join(" ", ($left, map(mangle_file($_), @right))) . "\n";
@@ -73,7 +104,7 @@ sub mangle_variable {
 sub mangle_target {
        my $raw = shift;
 
-       $raw =~ /([^:]+):[[:space:]]*(.*)/;
+       $raw =~ /([^:]+):[[:space:]]*(.*)/s;
        my @left  = split(/[[:space:]]+/, $1);
        my @right = split(/[[:space:]]+/, $2);
 
@@ -84,10 +115,31 @@ sub mangle_target {
 }
 
 while (<STDIN>) {
+       $line++;
+
+       # Combine line splices.
+       while (s/\\$//) {
+               $line++;
+               $_ = $_ . <STDIN>
+       }
+
        next if (/^#/);
 
        if (!$printed_header) {
-               print "# Postprocessed by ", basename($0), "\n";
+               print "# Postprocessed by ", basename($0), "\n\n";
+               print <<'EOF';
+# BEGIN AUTOMAKE/M4 POLYGLOT \
+m4_unquote(m4_argn([2], [
+.PHONY: # Automake code follows
+
+# This trick should define gnulib_orderonly to | iff we're using GNU make.
+gnulib_have_orderonly = $(findstring order-only,$(.FEATURES))
+gnulib_orderonly = $(gnulib_have_orderonly:order-only=|)
+gnulib_core_headers =
+gnulib_raw_headers = $(gnulib_core_headers)
+gnulib_headers = $(gnulib_orderonly) $(gnulib_raw_headers)
+EOF
+
                $printed_header = 1;
                drop;
        }
@@ -101,6 +153,14 @@ while (<STDIN>) {
        # useful for non-recursive builds.  Strip them out.
        drop if (/^(AM_CPPFLAGS|AM_CFLAGS)/);
 
+       # Library dependencies are added automatically to libgnu.la by
+       # gnulib-tool.  Unfortunately, this means that everything linking
+       # against libgnu.la is forced to pull in the same deps, even if they're
+       # unneeded.  Furthermore, a libtool linker flag reordering bug prevents
+       # --as-needed from stripping out the useless deps, so it's better to
+       # handle them all manually.
+       drop if (/LDFLAGS/);
+
        # Rewrite automake hook targets to be more generic.
        if (s/^(.*)-local:/\1-gnulib:/) {
                print ".PHONY: $1-gnulib\n";
@@ -122,33 +182,70 @@ while (<STDIN>) {
                }
        }
 
+       # BUILT_SOURCES has similar problems to recursive make: inadequate
+       # dependencies lead to incorrect builds.  Collect them into an
+       # ordinary variable so we can deal with them later.
+       s/BUILT_SOURCES/gnulib_core_headers/;
+
        # Targets are similar to variables: the target and its dependencies
        # need to be mangled.
-       if (/:/) {
+       if (/^[^\t].*:/) {
                $_ = mangle_target($_);
        }
 
+       # When using conditional-dependencies, *CLEANFILES can end up
+       # depending on the configuration.  This means that "make distclean"
+       # may not actually delete everything if the configuration changes
+       # after building the package.  Stash all the variables for later so
+       # they can be moved outside of any conditional.
+       if (/CLEANFILES/) {
+               push(@cleanfiles, $_);
+               drop;
+       }
+
        # Finally, references to $(srcdir) and $(builddir) need to be fixed up.
        s:\$\(srcdir\):\$\(top_srcdir\)/lib:g;
        s:\$\(builddir\):\$\(top_builddir\)/lib:g;
-} continue { print };
+} continue { s/(\n.)/\\\1/g; print; };
+
+print <<'EOF';
+gnulib_lt_objects = $(libgnu_la_OBJECTS) $(gl_LTLIBOBJS)
+$(gnulib_lt_objects): $(gnulib_headers)
+EOF
+print @cleanfiles;
 
 # Some filenames are AC_SUBSTed by the Gnulib macros, and thus we need to
 # prepend lib/ if and only if they're not empty.  Unfortunately, make is not
 # powerful to do this, so we need to put this transformation into configure
 # itself by defining a new autoconf macro.
-if (defined $m4output) {
-       my $lc = List::Compare->new('-u', '-a', \%sourcevars, \%allvars);
-       my @vars = $lc->get_unique;
 
-       open(M4OUT, '>', $m4output) or die "$m4output: $!\n";
+my $lc = List::Compare->new('-u', '-a', \%sourcevars, \%allvars);
+my @vars = $lc->get_unique;
 
-       print M4OUT "dnl This file was generated by fix-gnulib.pl\n";
-       print M4OUT "AC_DEFUN([$m4macro], [dnl\n";
-       foreach (@vars) {
-               print M4OUT "$_=\${$_:+lib/\$$_}\n";
-       }
-       print M4OUT "])\n";
+print <<'EOF';
+if FALSE
+], [dnl M4 code follows
+
+AC_SUBST([GLSRC], [lib])
+AC_DEFUN_ONCE([DX_GLSYM_PREFIX], [AC_SUBST([GLSYM_PREFIX], [$1])])
+AC_CONFIG_COMMANDS_PRE([DX_GLSYM_PREFIX([${PACKAGE}__])])
 
-       close M4OUT;
+m4_foreach([gl_objvar], [[gl_LIBOBJS], [gl_LTLIBOBJS]], [dnl
+set x $gl_objvar; shift
+gl_objvar=
+while test ${#} -gt 0; do
+       gl_objvar="$gl_objvar lib/${1}"; shift
+done
+])
+EOF
+
+foreach (@vars) {
+       print "$_=\${$_:+lib/\$$_}\n";
 }
+
+print <<'EOF';
+], [
+endif
+# ]))dnl
+# END AUTOMAKE/M4 POLYGLOT
+EOF