2009-12-04 Rafael Avila de Espindola <espindola@google.com>
[binutils.git] / libiberty / fnmatch.txh
blob92e11bcb388ddf47838a025b652a55aaaf92a995
1 @deftypefn Replacement int fnmatch (const char *@var{pattern}, const char *@var{string}, int @var{flags})
3 Matches @var{string} against @var{pattern}, returning zero if it
4 matches, @code{FNM_NOMATCH} if not.  @var{pattern} may contain the
5 wildcards @code{?} to match any one character, @code{*} to match any
6 zero or more characters, or a set of alternate characters in square
7 brackets, like @samp{[a-gt8]}, which match one character (@code{a}
8 through @code{g}, or @code{t}, or @code{8}, in this example) if that one
9 character is in the set.  A set may be inverted (i.e., match anything
10 except what's in the set) by giving @code{^} or @code{!} as the first
11 character in the set.  To include those characters in the set, list them
12 as anything other than the first character of the set.  To include a
13 dash in the set, list it last in the set.  A backslash character makes
14 the following character not special, so for example you could match
15 against a literal asterisk with @samp{\*}.  To match a literal
16 backslash, use @samp{\\}.
18 @code{flags} controls various aspects of the matching process, and is a
19 boolean OR of zero or more of the following values (defined in
20 @code{<fnmatch.h>}):
22 @table @code
24 @item FNM_PATHNAME
25 @itemx FNM_FILE_NAME
26 @var{string} is assumed to be a path name.  No wildcard will ever match
27 @code{/}.
29 @item FNM_NOESCAPE
30 Do not interpret backslashes as quoting the following special character.
32 @item FNM_PERIOD
33 A leading period (at the beginning of @var{string}, or if
34 @code{FNM_PATHNAME} after a slash) is not matched by @code{*} or
35 @code{?} but must be matched explicitly.
37 @item FNM_LEADING_DIR
38 Means that @var{string} also matches @var{pattern} if some initial part
39 of @var{string} matches, and is followed by @code{/} and zero or more
40 characters.  For example, @samp{foo*} would match either @samp{foobar}
41 or @samp{foobar/grill}.
43 @item FNM_CASEFOLD
44 Ignores case when performing the comparison.
46 @end table
48 @end deftypefn