]> git.draconx.ca Git - dxcommon.git/blobdiff - scripts/fix-gnulib.pl
Fix glconfig depfiles generation with non-GNU makes.
[dxcommon.git] / scripts / fix-gnulib.pl
index 85ae6321980e743632f2e3c911e3b2314f460139..16eac47a09bb585c763854a5c891faf9dbb9c874 100755 (executable)
@@ -1,6 +1,6 @@
 #!/usr/bin/env perl
 #
-# Copyright © 2011-2012 Nick Bowler
+# Copyright © 2011-2014, 2020-2021 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
@@ -8,18 +8,18 @@
 # 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:
+# 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:
+# 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)
@@ -27,9 +27,9 @@
 # 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.
+# 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.
 # There is NO WARRANTY, to the extent permitted by law.
 
 use strict;
-use List::Compare;
 use Getopt::Long;
 
 my $output   = undef;
 my $input    = undef;
 
+my $use_libtool = undef;
+my $for_library = undef;
+
 my $line     = 0;
 
 Getopt::Long::Configure("gnu_getopt", "no_auto_abbrev");
 GetOptions(
        "o|output=s"   => \$output,
        "i|input=s"    => \$input,
+       "library"      => sub { $for_library = 1; },
+       "program"      => sub { $for_library = 0; },
 );
 
 open STDOUT, ">", $output or die "$output: $!\n" if (defined $output);
 open STDIN,  "<", $input  or die "$input: $!\n"  if (defined $input);
 
 my $printed_header = 0;
-my (%allvars, %sourcevars);
 my @cleanfiles;
 
+# Hashes to record make variables used in the automake source.  The allvars
+# hash contains variables actually assigned in the Makefile, sourcevars
+# contains variables used as filenames.  Keys are the variable name, and
+# the value is always set to 1.
+my (%allvars, %sourcevars);
+
 sub drop {
        undef $_;
        next;
@@ -83,8 +92,10 @@ sub mangle_file {
                # Do nothing.  Generic transformation will take care of
                # $(srcdir) and $(builddir).
        } elsif ($word =~ /^[[:word:].+\/-]+$/) {
-               # Fix up things that look like filenames.
-               $word = "lib/$word";
+               # Mangle the filename.  Assume that all relevant files start
+               # with a non-dot (so we don't transform suffix rules) and
+               # contain at least one dot (so we don't transform phony rules).
+               $word = "lib/$word" if ($word =~ /^[^.]+\./);
        } else {
                print STDERR "$0:$line: warning: unrecognized source file: $word\n";
        }
@@ -133,17 +144,39 @@ 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_make_features = $(.FEATURES)
+gnulib_have_orderonly = $(findstring order-only,$(gnulib_make_features))
 gnulib_orderonly = $(gnulib_have_orderonly:order-only=|)
 gnulib_core_headers =
 gnulib_raw_headers = $(gnulib_core_headers)
 gnulib_headers = $(gnulib_orderonly) $(gnulib_raw_headers)
+
+# Oddly, gnulib tries to add to MOSTLYCLEANDIRS (which is *not* an automake
+# variable) without defining it.
+MOSTLYCLEANDIRS =
 EOF
 
                $printed_header = 1;
                drop;
        }
 
+       # Locate the libgnu definition to determine whether or not the user is
+       # using libtool mode in gnulib-tool.  Default to program mode if they
+       # are not, which will avoid pulling in the glsym dependencies.
+       #
+       # Convert noinst to EXTRA, that way libgnu will not be built unless
+       # something actually depends on it (which is typically the case).
+       if (/^noinst_LIBRARIES.*libgnu.a/) {
+               s/^noinst/EXTRA/;
+               $for_library //= 0;
+               $use_libtool = 0;
+       }
+       if (/^noinst_LTLIBRARIES.*libgnu.la/) {
+               s/^noinst/EXTRA/;
+               $for_library //= 1;
+               $use_libtool = 1;
+       }
+
        # For some reason, gnulib-tool adds core dumps to "make mostlyclean".
        # Since these files are (hopefully!) not created by make, they should
        # not be cleaned.
@@ -161,14 +194,15 @@ EOF
        # handle them all manually.
        drop if (/LDFLAGS/);
 
+       # Current uses of SUFFIXES in gnulib are pointless since Automake will
+       # figure it out all on its own.  Strip it out.
+       drop if (/SUFFIXES/);
+
        # Rewrite automake hook targets to be more generic.
        if (s/^(.*)-local:/\1-gnulib:/) {
                print ".PHONY: $1-gnulib\n";
                print "$1-local: $1-gnulib\n";
                s/$1-generic//;
-
-               # Don't let these targets get confused with filenames below.
-               next;
        }
 
        # We need to mangle filenames in make variables; prepending a lib/ on
@@ -193,43 +227,60 @@ EOF
                $_ = mangle_target($_);
        }
 
+       # MKDIR_P commands need to be fixed up; in principle Gnulib could also
+       # be patched here to use $(@D) instead (and thus automatically benefit
+       # from the target being fixed up), but this will do for now.
+       s/^(\t.*\$\(MKDIR_P\)) ([[:alnum:]]+)$/\1 lib\/\2/;
+
        # 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/) {
+       if (/(CLEANFILES|CLEANDIRS)[[:space:]]*\+=/) {
                push(@cleanfiles, $_);
                drop;
        }
 
+       # Change t-$@ to $@-t as the former will break if $@ has a directory
+       # component.
+       s/t-\$@/\$\@-t/g;
+
        # Finally, references to $(srcdir) and $(builddir) need to be fixed up.
        s:\$\(srcdir\):\$\(top_srcdir\)/lib:g;
        s:\$\(builddir\):\$\(top_builddir\)/lib:g;
 } continue { s/(\n.)/\\\1/g; print; };
 
-print <<'EOF';
+print <<'EOF' if ($use_libtool);
 gnulib_lt_objects = $(libgnu_la_OBJECTS) $(gl_LTLIBOBJS)
-$(gnulib_lt_objects): $(gnulib_headers)
+gnulib_objects = $(gnulib_lt_objects)
+$(gnulib_objects): $(gnulib_headers)
+EOF
+print <<'EOF' if (!$use_libtool);
+gnulib_objects = $(libgnu_a_OBJECTS) $(gl_LIBOBJS)
+$(gnulib_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.
 
-my $lc = List::Compare->new('-u', '-a', \%sourcevars, \%allvars);
-my @vars = $lc->get_unique;
+print @cleanfiles;
 
 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_LIBOBJ_DIR([lib])
+
+AC_DEFUN_ONCE([DX_GLSYM_PREFIX],
+[AC_REQUIRE([DX_AUTOMAKE_COMPAT])AC_REQUIRE([DX_EXPORTED_SH])
+AC_SUBST([GLSYM_PREFIX], [$1])
+])
+EOF
+
+print <<'EOF' if ($for_library);
 AC_CONFIG_COMMANDS_PRE([DX_GLSYM_PREFIX([${PACKAGE}__])])
+EOF
 
+print <<'EOF';
 m4_foreach([gl_objvar], [[gl_LIBOBJS], [gl_LTLIBOBJS]], [dnl
 set x $gl_objvar; shift
 gl_objvar=
@@ -239,8 +290,13 @@ done
 ])
 EOF
 
-foreach (@vars) {
-       print "$_=\${$_:+lib/\$$_}\n";
+# 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.
+
+foreach (keys %sourcevars) {
+       print "$_=\${$_:+lib/\$$_}\n" unless $allvars{$_};
 }
 
 print <<'EOF';