1 /* exclude.h -- declarations for excluding file names
2 
3    Copyright (C) 1992-1994, 1997, 1999, 2001-2003, 2005-2006, 2009-2021 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 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 <https://www.gnu.org/licenses/>.  */
18 
19 #ifndef _GL_EXCLUDE_H
20 #define _GL_EXCLUDE_H 1
21 
22 #include <stdbool.h>
23 #include <stdio.h>
24 
25 /* Written by Paul Eggert <eggert@twinsun.com>
26    and Sergey Poznyakoff <gray@gnu.org> */
27 
28 /* Exclude options, which can be ORed with fnmatch options.  */
29 
30 /* Patterns must match the start of file names, instead of matching
31    anywhere after a '/'.  */
32 #define EXCLUDE_ANCHORED (1 << 30)
33 
34 /* Include instead of exclude.  */
35 #define EXCLUDE_INCLUDE (1 << 29)
36 
37 /* '?', '*', '[', and '\\' are special in patterns.  Without this
38    option, these characters are ordinary and fnmatch is not used.  */
39 #define EXCLUDE_WILDCARDS (1 << 28)
40 
41 /* Patterns are POSIX extended regular expressions */
42 #define EXCLUDE_REGEX     (1 << 27)
43 
44 /* Allocate storage for the pattern */
45 #define EXCLUDE_ALLOC     (1 << 26)
46 
47 struct exclude;
48 
49 bool fnmatch_pattern_has_wildcards (const char *, int) _GL_ATTRIBUTE_PURE;
50 
51 struct exclude *new_exclude (void) _GL_ATTRIBUTE_MALLOC;
52 void free_exclude (struct exclude *);
53 void add_exclude (struct exclude *, char const *, int);
54 int add_exclude_file (void (*) (struct exclude *, char const *, int),
55                       struct exclude *, char const *, int, char);
56 int add_exclude_fp (void (*) (struct exclude *, char const *, int, void *),
57                     struct exclude *, FILE *, int, char, void *);
58 bool excluded_file_name (struct exclude const *, char const *);
59 void exclude_add_pattern_buffer (struct exclude *ex, char *buf);
60 bool exclude_fnmatch (char const *, char const *, int);
61 
62 #endif /* _GL_EXCLUDE_H */
63