Mercurial > hg > octave-shane > gnulib-hg

annotate check-module @ 7612:414c02fd4a6a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
.
author Karl Berry <karl@freefriends.org>
date Tue, 07 Nov 2006 10:31:33 +0000
parents 117d96f809c4
children 502a0e8a8bfe
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
0ec466622052 * check-module: Add copyright notice.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6168
diff changeset
4 # Copyright (C) 2005, 2006 Free Software Foundation, Inc.
0ec466622052 * check-module: Add copyright notice.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6168
diff changeset
5
0ec466622052 * check-module: Add copyright notice.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6168
diff changeset
6 # This file is free software; you can redistribute it and/or modify it
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
0ec466622052 * check-module: Add copyright notice.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6168
diff changeset
8 # the Free Software Foundation; either version 2 of the License, or
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 #
0ec466622052 * check-module: Add copyright notice.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6168
diff changeset
11 # This program is distributed in the hope that it will be useful, but
0ec466622052 * check-module: Add copyright notice.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6168
diff changeset
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
0ec466622052 * check-module: Add copyright notice.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6168
diff changeset
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
0ec466622052 * check-module: Add copyright notice.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6168
diff changeset
14 # General Public License for more details.
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
0ec466622052 * check-module: Add copyright notice.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6168
diff changeset
17 # along with this program; if not, write to the Free Software
0ec466622052 * check-module: Add copyright notice.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6168
diff changeset
18 # Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA
0ec466622052 * check-module: Add copyright notice.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6168
diff changeset
19 # 02110-1301, USA.
0ec466622052 * check-module: Add copyright notice.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6168
diff changeset
20
0ec466622052 * check-module: Add copyright notice.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6168
diff changeset
21
5769
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
22 # 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
23 # 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
24 # 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
25 # 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
26 # listed in the various Files: sections.
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
27
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
28 # 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
29 # module-description files.
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
30
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
31 # Written by Jim Meyering
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
32
6168
c7048f559336 Add a FIXME comment.
Jim Meyering <jim@meyering.net>
parents: 6157
diff changeset
33 # FIXME:
c7048f559336 Add a FIXME comment.
Jim Meyering <jim@meyering.net>
parents: 6157
diff changeset
34 # for each .m4 file listed in the Files: section(s)
c7048f559336 Add a FIXME comment.
Jim Meyering <jim@meyering.net>
parents: 6157
diff changeset
35 # parse it for AC_LIBSOURCES directives, and accumulate the set
c7048f559336 Add a FIXME comment.
Jim Meyering <jim@meyering.net>
parents: 6157
diff changeset
36 # of files `required' via all AC_LIBSOURCES.
c7048f559336 Add a FIXME comment.
Jim Meyering <jim@meyering.net>
parents: 6157
diff changeset
37 # If this set is not empty, ensure that it contains
c7048f559336 Add a FIXME comment.
Jim Meyering <jim@meyering.net>
parents: 6157
diff changeset
38 # 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
39
5769
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
40 use strict;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
41 use Getopt::Long;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
42 #use Coda;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
43
7134
0ec466622052 * check-module: Add copyright notice.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6168
diff changeset
44 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
45 "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
46 "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
47 "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
48
7165
117d96f809c4 * check-module (find_included_lib_files): Add at-func.c to the
Jim Meyering <jim@meyering.net>
parents: 7134
diff changeset
49 (my $VERSION = '$Revision: 1.6 $ ') =~ tr/[0-9].//cd;
5769
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
50 (my $ME = $0) =~ s|.*/||;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
51
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
52 use constant ST_INIT => 1;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
53 use constant ST_FILES => 2;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
54 use constant ST_DEPENDENTS => 3;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
55
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
56 # 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
57 # list of dependent-modules.
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
58 # my ($file, $dep) = parse_module_file $module_file;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
59 sub parse_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 my ($module_file) = @_;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
62
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
63 open FH, '<', $module_file
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
64 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
65
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
66 my %file_set;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
67 my %dep_set;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
68
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
69 my $state = ST_INIT;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
70 while (defined (my $line = <FH>))
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 ($state eq ST_INIT)
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 if ($line =~ /^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 $state = ST_FILES;
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 elsif ($line =~ /^Depends-on:$/)
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 $state = ST_DEPENDENTS;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
81 }
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 else
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
84 {
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
85 chomp $line;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
86 $line =~ s/^\s+//;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
87 $line =~ s/\s+$//;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
88 if ( ! $line)
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
89 {
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
90 $state = ST_INIT;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
91 next;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
92 }
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 if ($state eq ST_FILES)
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 $file_set{$line} = 1;
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 elsif ($state eq ST_DEPENDENTS)
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
99 {
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
100 $dep_set{$line} = 1;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
101 }
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 close FH;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
105
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
106 # my @t = sort keys %file_set;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
107 # print "files: @t\n";
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
108 # my @u = sort keys %dep_set;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
109 # print "dependents: @u\n";
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
110
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
111 return (\%file_set, \%dep_set);
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
112 }
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 # 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
115 # those required via dependent modules.
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
116
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
117 # Files:
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
118 # lib/stat.c
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
119 # m4/stat.m4
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
120 # lib/foo.h
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
121 #
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
122 # Depends-on:
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
123 # some-other-module
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
124
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
125 sub usage ($)
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
126 {
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
127 my ($exit_code) = @_;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
128 my $STREAM = ($exit_code == 0 ? *STDOUT : *STDERR);
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
129 if ($exit_code != 0)
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
130 {
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
131 print $STREAM "Try `$ME --help' for more information.\n";
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
132 }
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
133 else
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
134 {
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
135 print $STREAM <<EOF;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
136 Usage: $ME [OPTIONS] FILE...
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
137
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
138 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
139 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
140 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
141 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
142 listed in the various Files: sections.
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
143
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
144 OPTIONS:
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
145
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
146 --help display this help and exit
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
147 --version output version information and exit
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
148
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
149 EOF
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
150 }
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
151 exit $exit_code;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
152 }
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 sub find_included_lib_files ($)
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
155 {
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
156 my ($file) = @_;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
157
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
158 # 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
159 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
160 'regex.c' => 1, 'at-func.c' => 1 );
5769
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
161
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
162 my %inc;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
163 open FH, '<', $file
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
164 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
165
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
166 while (defined (my $line = <FH>))
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
167 {
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
168 # Ignore test-driver code at end of file.
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
169 $line =~ m!^\#if(def)? TEST_!
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
170 and last;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
171
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
172 $line =~ m!^\s*\#\s*include\s+"!
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
173 or next;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
174 $line =~ s///;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
175 chomp $line;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
176 $line =~ s/".*//;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
177 exists $inc{$line} && ! exists $special_non_dup{$line}
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
178 and warn "$ME: $file: duplicate inclusion of $line\n";
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
179
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
180 $inc{$line} = 1;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
181 }
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
182 close FH;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
183
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
184 return \%inc;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
185 }
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
186
6157
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
187 my %exempt_header =
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
188 (
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
189 # 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
190 # but not necessarily used.
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
191 'unlocked-io.h' => 1,
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
192
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
193 # 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
194 # 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
195 # 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
196 '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
197
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
198 # 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
199 '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
200
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
201 # 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
202 '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
203
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
204 # 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
205 '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
206
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
207 # 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
208 '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
209 '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
210 );
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
211
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
212 sub check_module ($)
5769
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
213 {
6157
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
214 my @m = @_;
5769
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
215
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
216 my %file;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
217 my %module_all_files;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
218 my %dep;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
219 my %seen_module;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
220
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
221 while (@m)
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
222 {
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
223 my $m = pop @m;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
224 # warn "M: $m\n";
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
225 exists $seen_module{$m}
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
226 and next;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
227 $seen_module{$m} = 1;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
228 my ($file, $dep) = parse_module_file $m;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
229 push @m, keys %$dep;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
230 foreach my $f (keys %$file)
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
231 {
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
232 $module_all_files{$f} = 1;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
233 }
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
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
236 my @t = sort keys %module_all_files;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
237 # warn "ALL files: @t\n";
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
238
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
239 # 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
240 # 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
241 foreach my $f (keys %module_all_files)
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
242 {
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
243 $f =~ /\.[ch]$/
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
244 or next;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
245 # FIXME: this is too naive
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
246 my $inc = find_included_lib_files "../$f";
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
247 foreach my $i (sort keys %$inc)
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 my $lib_file = "lib/$i";
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
250 exists $exempt_header{"$f:$i"}
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
251 || exists $exempt_header{$i}
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
252 and next;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
253 !exists $module_all_files{$lib_file} && -f "../lib/$i"
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
254 and warn "$f: $i is `#include'd, but not "
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
255 . "listed in module's Files: section\n";
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 #my @t = sort keys %$inc;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
258 #print "** $f: @t\n";
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
259 }
6157
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
260 }
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
261
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
262 {
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
263 GetOptions
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
264 (
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
265 help => sub { usage 0 },
7134
0ec466622052 * check-module: Add copyright notice.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6168
diff changeset
266 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
267 ) or usage 1;
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
268
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
269 @ARGV < 1
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
270 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
271
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
272 foreach my $module (@ARGV)
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
273 {
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
274 check_module $module;
915739deda90 If more parameters are given, check each of them
Jim Meyering <jim@meyering.net>
parents: 5944
diff changeset
275 }
5769
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
276
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
277 exit 0;
63c824dd2830 rename from modules/check-include-files
Jim Meyering <jim@meyering.net>
parents:
diff changeset
278 }