Tweak comments.
[gnulib.git] / lib / fnmatch_.h
1 /* Copyright (C) 1991, 1992, 1993, 1996, 1997, 1998, 1999, 2001, 2002, 2003
2    Free Software Foundation, Inc.
3
4    This program is free software; you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation; either version 2, or (at your option)
7    any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program; if not, write to the Free Software Foundation,
16    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
17
18 #ifndef _FNMATCH_H
19 # define _FNMATCH_H     1
20
21 # ifdef __cplusplus
22 extern "C" {
23 # endif
24
25 # if defined __cplusplus || (defined __STDC__ && __STDC__) || defined WINDOWS32
26 #  if !defined __GLIBC__ || !defined __P
27 #   undef       __P
28 #   define __P(protos)  protos
29 #  endif
30 # else /* Not C++ or ANSI C.  */
31 #  undef        __P
32 #  define __P(protos)   ()
33 /* We can get away without defining `const' here only because in this file
34    it is used only inside the prototype for `fnmatch', which is elided in
35    non-ANSI C where `const' is problematical.  */
36 # endif /* C++ or ANSI C.  */
37
38 /* We #undef these before defining them because some losing systems
39    (HP-UX A.08.07 for example) define these in <unistd.h>.  */
40 # undef FNM_PATHNAME
41 # undef FNM_NOESCAPE
42 # undef FNM_PERIOD
43
44 /* Bits set in the FLAGS argument to `fnmatch'.  */
45 # define FNM_PATHNAME   (1 << 0) /* No wildcard can ever match `/'.  */
46 # define FNM_NOESCAPE   (1 << 1) /* Backslashes don't quote special chars.  */
47 # define FNM_PERIOD     (1 << 2) /* Leading `.' is matched only explicitly.  */
48
49 # if !defined _POSIX_C_SOURCE || _POSIX_C_SOURCE < 2 || defined _GNU_SOURCE
50 #  define FNM_FILE_NAME  FNM_PATHNAME   /* Preferred GNU name.  */
51 #  define FNM_LEADING_DIR (1 << 3)      /* Ignore `/...' after a match.  */
52 #  define FNM_CASEFOLD   (1 << 4)       /* Compare without regard to case.  */
53 #  define FNM_EXTMATCH   (1 << 5)       /* Use ksh-like extended matching. */
54 # endif
55
56 /* Value returned by `fnmatch' if STRING does not match PATTERN.  */
57 # define FNM_NOMATCH    1
58
59 /* This value is returned if the implementation does not support
60    `fnmatch'.  Since this is not the case here it will never be
61    returned but the conformance test suites still require the symbol
62    to be defined.  */
63 # ifdef _XOPEN_SOURCE
64 #  define FNM_NOSYS     (-1)
65 # endif
66
67 /* Match NAME against the filename pattern PATTERN,
68    returning zero if it matches, FNM_NOMATCH if not.  */
69 extern int fnmatch __P ((const char *__pattern, const char *__name,
70                          int __flags));
71
72 # ifdef __cplusplus
73 }
74 # endif
75
76 #endif /* fnmatch.h */