gettimeofday: port recent C++ fix to Emacs
[gnulib.git] / check-module
index 026e41e..c5e5e1c 100755 (executable)
@@ -1,6 +1,24 @@
 #!/usr/bin/perl -w
+# Check a gnulib module.
+
+# Copyright (C) 2005-2007, 2009-2013 Free Software Foundation, Inc.
+
+# This file is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
 # Read a module description file and derive the set of files
-# included directly by any .c or .h file listed in the `Files:' section.
+# included directly by any .c or .h file listed in the 'Files:' section.
 # Take the union of all such sets for any dependent modules.
 # Then, compare that set with the set derived from the names
 # listed in the various Files: sections.
 # FIXME:
 # for each .m4 file listed in the Files: section(s)
 # parse it for AC_LIBSOURCES directives, and accumulate the set
-# of files `required' via all AC_LIBSOURCES.
+# of files "required" via all AC_LIBSOURCES.
 # If this set is not empty, ensure that it contains
 # the same (.c and .h only?) files as are listed in the Files: sections.
 
 use strict;
 use Getopt::Long;
+use File::Basename;
 #use Coda;
 
-(my $VERSION = '$Revision: 1.4 $ ') =~ tr/[0-9].//cd;
+my $COPYRIGHT_NOTICE = "Copyright (C) 2006 Free Software Foundation, Inc.\n".
+"This is free software.  You may redistribute copies of it under the terms of\n".
+"the GNU General Public License <http://www.gnu.org/licenses/gpl.html>.\n".
+"There is NO WARRANTY, to the extent permitted by law.\n";
+
+(my $VERSION = '$Revision: 1.8 $ ') =~ tr/[0-9].//cd;
 (my $ME = $0) =~ s|.*/||;
 
 use constant ST_INIT => 1;
@@ -36,7 +60,7 @@ sub parse_module_file ($)
   my ($module_file) = @_;
 
   open FH, '<', $module_file
-    or die "$ME: can't open `$module_file' for reading: $!\n";
+    or die "$ME: can't open '$module_file' for reading: $!\n";
 
   my %file_set;
   my %dep_set;
@@ -73,6 +97,9 @@ sub parse_module_file ($)
          elsif ($state eq ST_DEPENDENTS)
            {
              $dep_set{$line} = 1;
+             (my $base = $module_file) =~ s,.*/,,;
+             $line eq $base
+               and die "$ME: module $module_file depends on itself\n";
            }
        }
     }
@@ -103,7 +130,7 @@ sub usage ($)
   my $STREAM = ($exit_code == 0 ? *STDOUT : *STDERR);
   if ($exit_code != 0)
     {
-      print $STREAM "Try `$ME --help' for more information.\n";
+      print $STREAM "Try '$ME --help' for more information.\n";
     }
   else
     {
@@ -111,7 +138,7 @@ sub usage ($)
 Usage: $ME [OPTIONS] FILE...
 
 Read a module description file and derive the set of files
-included directly by any .c or .h file listed in the `Files:' section.
+included directly by any .c or .h file listed in the 'Files:' section.
 Take the union of all such sets for any dependent modules.
 Then, compare that set with the set derived from the names
 listed in the various Files: sections.
@@ -131,11 +158,21 @@ sub find_included_lib_files ($)
   my ($file) = @_;
 
   # Special cases...
-  my %special_non_dup = ( 'fnmatch_loop.c' => 1, 'regex.c' => 1 );
+  my %special_non_dup = ( 'fnmatch_loop.c' => 1,
+                         'regex.c' => 1, 'at-func.c' => 1,
+                         'vasnprintf.c' => 1
+                       );
+  my %dup_include_ok;
+  $dup_include_ok{'vasnprintf.c'}{'isnand-nolibm.h'} = 1;
+  $dup_include_ok{'vasnprintf.c'}{'isnanl-nolibm.h'} = 1;
+  $dup_include_ok{'vasnprintf.c'}{'fpucw.h'} = 1;
+  $dup_include_ok{'gen-uni-tables.c'}{'3level.h'} = 1;
+  $dup_include_ok{'csharpexec.c'}{'classpath.c'} = 1;
+  $dup_include_ok{'csharpexec.c'}{'classpath.h'} = 1;
 
   my %inc;
   open FH, '<', $file
-    or die "$ME: can't open `$file' for reading: $!\n";
+    or die "$ME: can't open '$file' for reading: $!\n";
 
   while (defined (my $line = <FH>))
     {
@@ -149,6 +186,7 @@ sub find_included_lib_files ($)
       chomp $line;
       $line =~ s/".*//;
       exists $inc{$line} && ! exists $special_non_dup{$line}
+         && ! exists $dup_include_ok{basename $file}{$line}
        and warn "$ME: $file: duplicate inclusion of $line\n";
 
       $inc{$line} = 1;
@@ -160,7 +198,7 @@ sub find_included_lib_files ($)
 
 my %exempt_header =
   (
-   # Exempt headers like unlocked-io.h that are `#include'd
+   # Exempt headers like unlocked-io.h that are '#include'd
    # but not necessarily used.
    'unlocked-io.h' => 1,
 
@@ -178,9 +216,18 @@ my %exempt_header =
    # The use of obstack.h in the hash module is conditional, off by default.
    'lib/hash.c:obstack.h' => 1,
 
-   # The fts-lgpl module doesn't actually use fts-cycle.c and unistd-safer.h.
-   'lib/fts.c:fts-cycle.c' => 1,
-   'lib/fts.c:unistd-safer.h' => 1,
+   # C files in the gc module have conditional includes.
+   'lib/gc-gnulib.c:des.h' => 1,
+   'lib/gc-gnulib.c:arcfour.h' => 1,
+   'lib/gc-gnulib.c:arctwo.h' => 1,
+   'lib/gc-gnulib.c:md2.h' => 1,
+   'lib/gc-gnulib.c:md4.h' => 1,
+   'lib/gc-gnulib.c:md5.h' => 1,
+   'lib/gc-gnulib.c:rijndael.h' => 1,
+   'lib/gc-gnulib.c:sha1.h' => 1,
+   'lib/gc-gnulib.c:rijndael-api-fst.h' => 1,
+   'lib/gc-gnulib.c:hmac.h' => 1,
+   'lib/gc-libgcrypt.c:md2.h' => 1,
   );
 
 sub check_module ($)
@@ -225,7 +272,7 @@ sub check_module ($)
            || exists $exempt_header{$i}
              and next;
          !exists $module_all_files{$lib_file} && -f "../lib/$i"
-           and warn "$f: $i is `#include'd, but not "
+           and warn "$f: $i is '#include'd, but not "
              . "listed in module's Files: section\n";
        }
       #my @t = sort keys %$inc;
@@ -237,7 +284,7 @@ sub check_module ($)
   GetOptions
     (
      help => sub { usage 0 },
-     version => sub { print "$ME version $VERSION\n"; exit },
+     version => sub { print "$ME version $VERSION\n$COPYRIGHT_NOTICE"; exit },
     ) or usage 1;
 
   @ARGV < 1