gnulib: check-module annotate

annotate check-module @ 9309:bbbbbf4cd1c5

Change copyright notice from GPLv2+ to GPLv3+.

author	Bruno Haible <bruno@clisp.org>
date	Sun, 07 Oct 2007 19:14:58 +0200
parents	5e12596c4187
children	84ae262254ad

rev	line source
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	1 #!/usr/bin/perl -w
7134 0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	2 # Check a gnulib module.
0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	3
9111 5e12596c4187 * check-module: Diagnose a self-dependency. Jim Meyering <jim@meyering.net> parents: 7668 diff changeset	4 # Copyright (C) 2005, 2006, 2007 Free Software Foundation, Inc.
7134 0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	5
9309 bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+. Bruno Haible <bruno@clisp.org> parents: 9111 diff changeset	6 # This file is free software: you can redistribute it and/or modify it
7134 0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	7 # under the terms of the GNU General Public License as published by
9309 bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+. Bruno Haible <bruno@clisp.org> parents: 9111 diff changeset	8 # the Free Software Foundation; either version 3 of the License, or
7134 0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	9 # (at your option) any later version.
0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	10 #
9309 bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+. Bruno Haible <bruno@clisp.org> parents: 9111 diff changeset	11 # This program is distributed in the hope that it will be useful,
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+. Bruno Haible <bruno@clisp.org> parents: 9111 diff changeset	12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+. Bruno Haible <bruno@clisp.org> parents: 9111 diff changeset	13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+. Bruno Haible <bruno@clisp.org> parents: 9111 diff changeset	14 # GNU General Public License for more details.
7134 0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	15 #
0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	16 # You should have received a copy of the GNU General Public License
9309 bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+. Bruno Haible <bruno@clisp.org> parents: 9111 diff changeset	17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
7134 0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	18
0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	19
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	20 # Read a module description file and derive the set of files
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	21 # included directly by any .c or .h file listed in the `Files:' section.
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	22 # Take the union of all such sets for any dependent modules.
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	23 # Then, compare that set with the set derived from the names
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	24 # listed in the various Files: sections.
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	25
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	26 # This script makes no attempt to diagnose invalid or empty
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	27 # module-description files.
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	28
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	29 # Written by Jim Meyering
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	30
6168 c7048f559336 Add a FIXME comment. Jim Meyering <jim@meyering.net> parents: 6157 diff changeset	31 # FIXME:
c7048f559336 Add a FIXME comment. Jim Meyering <jim@meyering.net> parents: 6157 diff changeset	32 # for each .m4 file listed in the Files: section(s)
c7048f559336 Add a FIXME comment. Jim Meyering <jim@meyering.net> parents: 6157 diff changeset	33 # parse it for AC_LIBSOURCES directives, and accumulate the set
c7048f559336 Add a FIXME comment. Jim Meyering <jim@meyering.net> parents: 6157 diff changeset	34 # of files `required' via all AC_LIBSOURCES.
c7048f559336 Add a FIXME comment. Jim Meyering <jim@meyering.net> parents: 6157 diff changeset	35 # If this set is not empty, ensure that it contains
c7048f559336 Add a FIXME comment. Jim Meyering <jim@meyering.net> parents: 6157 diff changeset	36 # the same (.c and .h only?) files as are listed in the Files: sections.
c7048f559336 Add a FIXME comment. Jim Meyering <jim@meyering.net> parents: 6157 diff changeset	37
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	38 use strict;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	39 use Getopt::Long;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	40 #use Coda;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	41
7134 0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	42 my $COPYRIGHT_NOTICE = "Copyright (C) 2006 Free Software Foundation, Inc.\n".
0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	43 "This is free software. You may redistribute copies of it under the terms of\n".
0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	44 "the GNU General Public License <http://www.gnu.org/licenses/gpl.html>.\n".
0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	45 "There is NO WARRANTY, to the extent permitted by law.\n";
0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	46
9111 5e12596c4187 * check-module: Diagnose a self-dependency. Jim Meyering <jim@meyering.net> parents: 7668 diff changeset	47 (my $VERSION = '$Revision: 1.8 $ ') =~ tr/[0-9].//cd;
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	48 (my $ME = $0) =~ s\|.*/\|\|;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	49
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	50 use constant ST_INIT => 1;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	51 use constant ST_FILES => 2;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	52 use constant ST_DEPENDENTS => 3;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	53
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	54 # Parse a module file (returning list of Files: names and
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	55 # list of dependent-modules.
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	56 # my ($file, $dep) = parse_module_file $module_file;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	57 sub parse_module_file ($)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	58 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	59 my ($module_file) = @_;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	60
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	61 open FH, '<', $module_file
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	62 or die "$ME: can't open `$module_file' for reading: $!\n";
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	63
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	64 my %file_set;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	65 my %dep_set;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	66
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	67 my $state = ST_INIT;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	68 while (defined (my $line = <FH>))
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	69 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	70 if ($state eq ST_INIT)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	71 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	72 if ($line =~ /^Files:$/)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	73 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	74 $state = ST_FILES;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	75 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	76 elsif ($line =~ /^Depends-on:$/)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	77 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	78 $state = ST_DEPENDENTS;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	79 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	80 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	81 else
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	82 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	83 chomp $line;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	84 $line =~ s/^\s+//;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	85 $line =~ s/\s+$//;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	86 if ( ! $line)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	87 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	88 $state = ST_INIT;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	89 next;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	90 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	91
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	92 if ($state eq ST_FILES)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	93 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	94 $file_set{$line} = 1;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	95 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	96 elsif ($state eq ST_DEPENDENTS)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	97 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	98 $dep_set{$line} = 1;
9111 5e12596c4187 * check-module: Diagnose a self-dependency. Jim Meyering <jim@meyering.net> parents: 7668 diff changeset	99 (my $base = $module_file) =~ s,.*/,,;
5e12596c4187 * check-module: Diagnose a self-dependency. Jim Meyering <jim@meyering.net> parents: 7668 diff changeset	100 $line eq $base
5e12596c4187 * check-module: Diagnose a self-dependency. Jim Meyering <jim@meyering.net> parents: 7668 diff changeset	101 and die "$ME: module $module_file depends on itself\n";
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	102 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	103 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	104 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	105 close FH;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	106
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	107 # my @t = sort keys %file_set;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	108 # print "files: @t\n";
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	109 # my @u = sort keys %dep_set;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	110 # print "dependents: @u\n";
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	111
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	112 return (\%file_set, \%dep_set);
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	113 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	114
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	115 # Extract the set of files required for this module, including
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	116 # those required via dependent modules.
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	117
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	118 # Files:
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	119 # lib/stat.c
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	120 # m4/stat.m4
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	121 # lib/foo.h
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	122 #
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	123 # Depends-on:
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	124 # some-other-module
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	125
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	126 sub usage ($)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	127 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	128 my ($exit_code) = @_;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	129 my $STREAM = ($exit_code == 0 ? STDOUT : STDERR);
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	130 if ($exit_code != 0)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	131 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	132 print $STREAM "Try `$ME --help' for more information.\n";
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	133 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	134 else
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	135 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	136 print $STREAM <<EOF;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	137 Usage: $ME [OPTIONS] FILE...
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	138
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	139 Read a module description file and derive the set of files
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	140 included directly by any .c or .h file listed in the `Files:' section.
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	141 Take the union of all such sets for any dependent modules.
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	142 Then, compare that set with the set derived from the names
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	143 listed in the various Files: sections.
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	144
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	145 OPTIONS:
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	146
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	147 --help display this help and exit
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	148 --version output version information and exit
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	149
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	150 EOF
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	151 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	152 exit $exit_code;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	153 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	154
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	155 sub find_included_lib_files ($)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	156 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	157 my ($file) = @_;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	158
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	159 # Special cases...
7165 117d96f809c4 * check-module (find_included_lib_files): Add at-func.c to the Jim Meyering <jim@meyering.net> parents: 7134 diff changeset	160 my %special_non_dup = ( 'fnmatch_loop.c' => 1,
117d96f809c4 * check-module (find_included_lib_files): Add at-func.c to the Jim Meyering <jim@meyering.net> parents: 7134 diff changeset	161 'regex.c' => 1, 'at-func.c' => 1 );
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	162
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	163 my %inc;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	164 open FH, '<', $file
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	165 or die "$ME: can't open `$file' for reading: $!\n";
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	166
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	167 while (defined (my $line = <FH>))
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	168 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	169 # Ignore test-driver code at end of file.
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	170 $line =~ m!^\#if(def)? TEST_!
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	171 and last;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	172
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	173 $line =~ m!^\s\#\sinclude\s+"!
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	174 or next;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	175 $line =~ s///;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	176 chomp $line;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	177 $line =~ s/".*//;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	178 exists $inc{$line} && ! exists $special_non_dup{$line}
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	179 and warn "$ME: $file: duplicate inclusion of $line\n";
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	180
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	181 $inc{$line} = 1;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	182 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	183 close FH;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	184
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	185 return \%inc;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	186 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	187
6157 915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	188 my %exempt_header =
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	189 (
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	190 # Exempt headers like unlocked-io.h that are `#include'd
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	191 # but not necessarily used.
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	192 'unlocked-io.h' => 1,
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	193
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	194 # Give gettext.h a free pass only when included from lib/error.c,
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	195 # since we've made that exception solely to make the error
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	196 # module easier to use -- at RMS's request.
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	197 'lib/error.c:gettext.h' => 1,
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	198
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	199 # The full-read module shares code with the full-write module.
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	200 'lib/full-write.c:full-read.h' => 1,
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	201
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	202 # The safe-write module shares code with the safe-read module.
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	203 'lib/safe-read.c:safe-write.h' => 1,
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	204
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	205 # The use of obstack.h in the hash module is conditional, off by default.
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	206 'lib/hash.c:obstack.h' => 1,
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	207
7668 502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	208 # C files in the gc module have conditional includes.
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	209 'lib/gc-gnulib.c:des.h' => 1,
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	210 'lib/gc-gnulib.c:arcfour.h' => 1,
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	211 'lib/gc-gnulib.c:arctwo.h' => 1,
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	212 'lib/gc-gnulib.c:md2.h' => 1,
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	213 'lib/gc-gnulib.c:md4.h' => 1,
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	214 'lib/gc-gnulib.c:md5.h' => 1,
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	215 'lib/gc-gnulib.c:rijndael.h' => 1,
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	216 'lib/gc-gnulib.c:sha1.h' => 1,
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	217 'lib/gc-gnulib.c:rijndael-api-fst.h' => 1,
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	218 'lib/gc-gnulib.c:hmac.h' => 1,
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	219 'lib/gc-libgcrypt.c:md2.h' => 1,
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	220
6157 915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	221 # The fts-lgpl module doesn't actually use fts-cycle.c and unistd-safer.h.
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	222 'lib/fts.c:fts-cycle.c' => 1,
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	223 'lib/fts.c:unistd-safer.h' => 1,
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	224 );
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	225
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	226 sub check_module ($)
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	227 {
6157 915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	228 my @m = @_;
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	229
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	230 my %file;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	231 my %module_all_files;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	232 my %dep;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	233 my %seen_module;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	234
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	235 while (@m)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	236 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	237 my $m = pop @m;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	238 # warn "M: $m\n";
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	239 exists $seen_module{$m}
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	240 and next;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	241 $seen_module{$m} = 1;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	242 my ($file, $dep) = parse_module_file $m;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	243 push @m, keys %$dep;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	244 foreach my $f (keys %$file)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	245 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	246 $module_all_files{$f} = 1;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	247 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	248 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	249
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	250 my @t = sort keys %module_all_files;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	251 # warn "ALL files: @t\n";
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	252
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	253 # Derive from %module_all_files (by parsing the .c and .h files therein),
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	254 # the list of all #include'd files that reside in lib/.
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	255 foreach my $f (keys %module_all_files)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	256 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	257 $f =~ /\.[ch]$/
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	258 or next;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	259 # FIXME: this is too naive
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	260 my $inc = find_included_lib_files "../$f";
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	261 foreach my $i (sort keys %$inc)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	262 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	263 my $lib_file = "lib/$i";
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	264 exists $exempt_header{"$f:$i"}
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	265 \|\| exists $exempt_header{$i}
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	266 and next;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	267 !exists $module_all_files{$lib_file} && -f "../lib/$i"
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	268 and warn "$f: $i is `#include'd, but not "
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	269 . "listed in module's Files: section\n";
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	270 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	271 #my @t = sort keys %$inc;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	272 #print "** $f: @t\n";
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	273 }
6157 915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	274 }
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	275
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	276 {
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	277 GetOptions
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	278 (
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	279 help => sub { usage 0 },
7134 0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	280 version => sub { print "$ME version $VERSION\n$COPYRIGHT_NOTICE"; exit },
6157 915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	281 ) or usage 1;
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	282
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	283 @ARGV < 1
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	284 and (warn "$ME: missing FILE argument\n"), usage 1;
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	285
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	286 foreach my $module (@ARGV)
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	287 {
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	288 check_module $module;
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	289 }
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	290
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	291 exit 0;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	292 }

Mercurial > gnulib

annotate check-module @ 9309:bbbbbf4cd1c5