]> git.draconx.ca Git - cdecl99.git/blobdiff - fix-gnulib.pl
Better document fix-gnulib.
[cdecl99.git] / fix-gnulib.pl
index b8185fa642107538128023f844d76eb03191f286..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);
@@ -56,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";
@@ -65,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";
@@ -74,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);
 
@@ -85,17 +115,29 @@ sub mangle_target {
 }
 
 while (<STDIN>) {
+       $line++;
+
+       # Combine line splices.
+       while (s/\\$//) {
+               $line++;
+               $_ = $_ . <STDIN>
+       }
+
        next if (/^#/);
 
        if (!$printed_header) {
                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_orderonly)
-gnulib_src_headers = $(gnulib_core_headers)
-gnulib_headers = $(gnulib_src_headers)
+gnulib_core_headers =
+gnulib_raw_headers = $(gnulib_core_headers)
+gnulib_headers = $(gnulib_orderonly) $(gnulib_raw_headers)
 EOF
 
                $printed_header = 1;
@@ -111,6 +153,14 @@ EOF
        # 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";
@@ -139,7 +189,7 @@ EOF
 
        # Targets are similar to variables: the target and its dependencies
        # need to be mangled.
-       if (/:/) {
+       if (/^[^\t].*:/) {
                $_ = mangle_target($_);
        }
 
@@ -156,11 +206,11 @@ EOF
        # 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_src_headers)
+$(gnulib_lt_objects): $(gnulib_headers)
 EOF
 print @cleanfiles;
 
@@ -168,26 +218,17 @@ print @cleanfiles;
 # 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";
-
-       print M4OUT <<EOF;
-dnl This file was generated by fix-gnulib.pl
-dnl
-dnl Usage: DX_FIX_GNULIB([symbol-prefix])
-dnl   where symbol-prefix is the application-specific symbol prefix to apply
-dnl   to Gnulib's symbols.  Defaults to \${PACKAGE}__.
-dnl   top-level source directory; e.g. lib.
-AC_DEFUN([$m4macro], [dnl
-EOF
-       print M4OUT <<'EOF';
-GLSRC=lib
-GLSYM_PREFIX='ifelse([$1], [], [${PACKAGE}__], [$1])'
-AC_SUBST([GLSRC])
-AC_SUBST([GLSYM_PREFIX])
+
+my $lc = List::Compare->new('-u', '-a', \%sourcevars, \%allvars);
+my @vars = $lc->get_unique;
+
+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}__])])
 
 m4_foreach([gl_objvar], [[gl_LIBOBJS], [gl_LTLIBOBJS]], [dnl
 set x $gl_objvar; shift
@@ -197,10 +238,14 @@ while test ${#} -gt 0; do
 done
 ])
 EOF
-       foreach (@vars) {
-               print M4OUT "$_=\${$_:+lib/\$$_}\n";
-       }
-       print M4OUT "])\n";
 
-       close M4OUT;
+foreach (@vars) {
+       print "$_=\${$_:+lib/\$$_}\n";
 }
+
+print <<'EOF';
+], [
+endif
+# ]))dnl
+# END AUTOMAKE/M4 POLYGLOT
+EOF