1 /*
2  * Copyright (C) 2008 The Android Open Source Project
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *  * Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *  * Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in
12  *    the documentation and/or other materials provided with the
13  *    distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #pragma once
30 
31 /**
32  * @file fnmatch.h
33  * @brief Filename matching.
34  */
35 
36 #include <sys/cdefs.h>
37 
38 __BEGIN_DECLS
39 
40 /** Returned by fnmatch() if matching failed. */
41 #define FNM_NOMATCH 1
42 
43 /** Returned by fnmatch() if the function is not supported. This is never returned on Android. */
44 #define FNM_NOSYS 2
45 
46 /** fnmatch() flag to disable backslash escaping. */
47 #define FNM_NOESCAPE     0x01
48 /** fnmatch() flag to ensure that slashes must be matched by slashes. */
49 #define FNM_PATHNAME     0x02
50 /** fnmatch() flag to ensure that periods must be matched by periods. */
51 #define FNM_PERIOD       0x04
52 /** fnmatch() flag to ignore /... after a match. */
53 #define FNM_LEADING_DIR  0x08
54 /** fnmatch() flag for a case-insensitive search. */
55 #define FNM_CASEFOLD     0x10
56 
57 /** Synonym for `FNM_CASEFOLD`: case-insensitive search. */
58 #define FNM_IGNORECASE   FNM_CASEFOLD
59 /** Synonym for `FNM_PATHNAME`: slashes must be matched by slashes. */
60 #define FNM_FILE_NAME    FNM_PATHNAME
61 
62 /**
63  * [fnmatch(3)](http://man7.org/linux/man-pages/man3/fnmatch.3.html) matches `__string` against
64  * the shell wildcard `__pattern`.
65  *
66  * Returns 0 on success, and returns `FNM_NOMATCH` on failure.
67  */
68 int fnmatch(const char* _Nonnull __pattern, const char* _Nonnull __string, int __flags);
69 
70 __END_DECLS
71