.h files should stand alone, but we shouldn't include <sys/types.h>
[pspp] / lib / exclude.c
1 /* exclude.c -- exclude file names
2
3    Copyright (C) 1992, 1993, 1994, 1997, 1999, 2000, 2001, 2002, 2003 Free
4    Software Foundation, Inc.
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2, or (at your option)
9    any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program; see the file COPYING.
18    If not, write to the Free Software Foundation,
19    59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
20
21 /* Written by Paul Eggert <eggert@twinsun.com>  */
22
23 #if HAVE_CONFIG_H
24 # include <config.h>
25 #endif
26
27 #include <stdbool.h>
28
29 #include <errno.h>
30 #ifndef errno
31 extern int errno;
32 #endif
33 #include <stddef.h>
34 #include <stdio.h>
35 #if HAVE_STDLIB_H
36 # include <stdlib.h>
37 #endif
38 #if HAVE_STRING_H
39 # include <string.h>
40 #endif
41 #if HAVE_STRINGS_H
42 # include <strings.h>
43 #endif
44 #if HAVE_INTTYPES_H
45 # include <inttypes.h>
46 #else
47 # if HAVE_STDINT_H
48 #  include <stdint.h>
49 # endif
50 #endif
51
52 #include "exclude.h"
53 #include "fnmatch.h"
54 #include "unlocked-io.h"
55 #include "xalloc.h"
56
57 #ifndef SIZE_MAX
58 # define SIZE_MAX ((size_t) -1)
59 #endif
60
61 /* Verify a requirement at compile-time (unlike assert, which is runtime).  */
62 #define verify(name, assertion) struct name { char a[(assertion) ? 1 : -1]; }
63
64 /* Non-GNU systems lack these options, so we don't need to check them.  */
65 #ifndef FNM_CASEFOLD
66 # define FNM_CASEFOLD 0
67 #endif
68 #ifndef FNM_LEADING_DIR
69 # define FNM_LEADING_DIR 0
70 #endif
71
72 verify (EXCLUDE_macros_do_not_collide_with_FNM_macros,
73         (((EXCLUDE_ANCHORED | EXCLUDE_INCLUDE | EXCLUDE_WILDCARDS)
74           & (FNM_PATHNAME | FNM_NOESCAPE | FNM_PERIOD | FNM_LEADING_DIR
75              | FNM_CASEFOLD))
76          == 0));
77
78 /* An exclude pattern-options pair.  The options are fnmatch options
79    ORed with EXCLUDE_* options.  */
80
81 struct patopts
82   {
83     char const *pattern;
84     int options;
85   };
86
87 /* An exclude list, of pattern-options pairs.  */
88
89 struct exclude
90   {
91     struct patopts *exclude;
92     size_t exclude_alloc;
93     size_t exclude_count;
94   };
95
96 /* Return a newly allocated and empty exclude list.  */
97
98 struct exclude *
99 new_exclude (void)
100 {
101   struct exclude *ex = (struct exclude *) xmalloc (sizeof *ex);
102   ex->exclude_count = 0;
103   ex->exclude_alloc = (1 << 6); /* This must be a power of 2.  */
104   ex->exclude = (struct patopts *) xmalloc (ex->exclude_alloc
105                                             * sizeof ex->exclude[0]);
106   return ex;
107 }
108
109 /* Free the storage associated with an exclude list.  */
110
111 void
112 free_exclude (struct exclude *ex)
113 {
114   free (ex->exclude);
115   free (ex);
116 }
117
118 /* Return zero if PATTERN matches F, obeying OPTIONS, except that
119    (unlike fnmatch) wildcards are disabled in PATTERN.  */
120
121 static int
122 fnmatch_no_wildcards (char const *pattern, char const *f, int options)
123 {
124   if (! (options & FNM_LEADING_DIR))
125     return ((options & FNM_CASEFOLD)
126             ? strcasecmp (pattern, f)
127             : strcmp (pattern, f));
128   else
129     {
130       size_t patlen = strlen (pattern);
131       int r = ((options & FNM_CASEFOLD)
132                 ? strncasecmp (pattern, f, patlen)
133                 : strncmp (pattern, f, patlen));
134       if (! r)
135         {
136           r = f[patlen];
137           if (r == '/')
138             r = 0;
139         }
140       return r;
141     }
142 }
143
144 /* Return true if EX excludes F.  */
145
146 bool
147 excluded_filename (struct exclude const *ex, char const *f)
148 {
149   size_t exclude_count = ex->exclude_count;
150
151   /* If no options are given, the default is to include.  */
152   if (exclude_count == 0)
153     return false;
154   else
155     {
156       struct patopts const *exclude = ex->exclude;
157       size_t i;
158
159       /* Otherwise, the default is the opposite of the first option.  */
160       bool excluded = !! (exclude[0].options & EXCLUDE_INCLUDE);
161
162       /* Scan through the options, seeing whether they change F from
163          excluded to included or vice versa.  */
164       for (i = 0;  i < exclude_count;  i++)
165         {
166           char const *pattern = exclude[i].pattern;
167           int options = exclude[i].options;
168           if (excluded == !! (options & EXCLUDE_INCLUDE))
169             {
170               int (*matcher) (char const *, char const *, int) =
171                 (options & EXCLUDE_WILDCARDS
172                  ? fnmatch
173                  : fnmatch_no_wildcards);
174               bool matched = ((*matcher) (pattern, f, options) == 0);
175               char const *p;
176
177               if (! (options & EXCLUDE_ANCHORED))
178                 for (p = f; *p && ! matched; p++)
179                   if (*p == '/' && p[1] != '/')
180                     matched = ((*matcher) (pattern, p + 1, options) == 0);
181
182               excluded ^= matched;
183             }
184         }
185
186       return excluded;
187     }
188 }
189
190 /* Append to EX the exclusion PATTERN with OPTIONS.  */
191
192 void
193 add_exclude (struct exclude *ex, char const *pattern, int options)
194 {
195   struct patopts *patopts;
196
197   if (ex->exclude_alloc <= ex->exclude_count)
198     {
199       size_t s = 2 * ex->exclude_alloc;
200       if (! (0 < s && s <= SIZE_MAX / sizeof ex->exclude[0]))
201         xalloc_die ();
202       ex->exclude_alloc = s;
203       ex->exclude = (struct patopts *) xrealloc (ex->exclude,
204                                                  s * sizeof ex->exclude[0]);
205     }
206
207   patopts = &ex->exclude[ex->exclude_count++];
208   patopts->pattern = pattern;
209   patopts->options = options;
210 }
211
212 /* Use ADD_FUNC to append to EX the patterns in FILENAME, each with
213    OPTIONS.  LINE_END terminates each pattern in the file.  Return -1
214    on failure, 0 on success.  */
215
216 int
217 add_exclude_file (void (*add_func) (struct exclude *, char const *, int),
218                   struct exclude *ex, char const *filename, int options,
219                   char line_end)
220 {
221   bool use_stdin = filename[0] == '-' && !filename[1];
222   FILE *in;
223   char *buf;
224   char *p;
225   char const *pattern;
226   char const *lim;
227   size_t buf_alloc = (1 << 10);  /* This must be a power of two.  */
228   size_t buf_count = 0;
229   int c;
230   int e = 0;
231
232   if (use_stdin)
233     in = stdin;
234   else if (! (in = fopen (filename, "r")))
235     return -1;
236
237   buf = xmalloc (buf_alloc);
238
239   while ((c = getc (in)) != EOF)
240     {
241       buf[buf_count++] = c;
242       if (buf_count == buf_alloc)
243         {
244           buf_alloc *= 2;
245           if (! buf_alloc)
246             xalloc_die ();
247           buf = xrealloc (buf, buf_alloc);
248         }
249     }
250
251   if (ferror (in))
252     e = errno;
253
254   if (!use_stdin && fclose (in) != 0)
255     e = errno;
256
257   buf = xrealloc (buf, buf_count + 1);
258
259   for (pattern = p = buf, lim = buf + buf_count;  p <= lim;  p++)
260     if (p < lim ? *p == line_end : buf < p && p[-1])
261       {
262         *p = '\0';
263         (*add_func) (ex, pattern, options);
264         pattern = p + 1;
265       }
266
267   errno = e;
268   return e ? -1 : 0;
269 }