e0735e1594d6c82917039cc9870292b88935b8da
[gnulib.git] / lib / exclude.h
1 /* exclude.h -- declarations for excluding file names
2
3    Copyright (C) 1992, 1993, 1994, 1997, 1999, 2001, 2002, 2003, 2005,
4    2006, 2009 Free 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 3 of the License, or
9    (at your option) 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.  If not, see <http://www.gnu.org/licenses/>.  */
18
19 /* Written by Paul Eggert <eggert@twinsun.com>
20    and Sergey Poznyakoff <gray@gnu.org> */
21
22 /* Exclude options, which can be ORed with fnmatch options.  */
23
24 /* Patterns must match the start of file names, instead of matching
25    anywhere after a '/'.  */
26 #define EXCLUDE_ANCHORED (1 << 30)
27
28 /* Include instead of exclude.  */
29 #define EXCLUDE_INCLUDE (1 << 29)
30
31 /* '?', '*', '[', and '\\' are special in patterns.  Without this
32    option, these characters are ordinary and fnmatch is not used.  */
33 #define EXCLUDE_WILDCARDS (1 << 28)
34
35 struct exclude;
36
37 bool fnmatch_pattern_has_wildcards (const char *, int);
38
39 struct exclude *new_exclude (void);
40 void free_exclude (struct exclude *);
41 void add_exclude (struct exclude *, char const *, int);
42 int add_exclude_file (void (*) (struct exclude *, char const *, int),
43                       struct exclude *, char const *, int, char);
44 bool excluded_file_name (struct exclude const *, char const *);
45 bool exclude_fnmatch (char const *pattern, char const *f, int options);