Apache Portable Runtime
apr_fnmatch.h
Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 1992, 1993
00003  *      The Regents of the University of California.  All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions
00007  * are met:
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 3. All advertising materials mentioning features or use of this software
00014  *    must display the following acknowledgement:
00015  *      This product includes software developed by the University of
00016  *      California, Berkeley and its contributors.
00017  * 4. Neither the name of the University nor the names of its contributors
00018  *    may be used to endorse or promote products derived from this software
00019  *    without specific prior written permission.
00020  *
00021  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
00022  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00023  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00024  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
00025  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00026  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00027  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00028  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00029  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00030  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00031  * SUCH DAMAGE.
00032  *
00033  *      @(#)fnmatch.h   8.1 (Berkeley) 6/2/93
00034  */
00035 
00036 /* This file has been modified by the Apache Software Foundation. */
00037 #ifndef _APR_FNMATCH_H_
00038 #define _APR_FNMATCH_H_
00039 
00040 /**
00041  * @file apr_fnmatch.h
00042  * @brief APR FNMatch Functions
00043  */
00044 
00045 #include "apr_errno.h"
00046 #include "apr_tables.h"
00047 
00048 #ifdef __cplusplus
00049 extern "C" {
00050 #endif
00051 
00052 /**
00053  * @defgroup apr_fnmatch Filename Matching Functions
00054  * @ingroup APR 
00055  * @{
00056  */
00057 
00058 #define APR_FNM_NOMATCH     1     /**< Match failed. */
00059  
00060 #define APR_FNM_NOESCAPE    0x01  /**< Disable backslash escaping. */
00061 #define APR_FNM_PATHNAME    0x02  /**< Slash must be matched by slash. */
00062 #define APR_FNM_PERIOD      0x04  /**< Period must be matched by period. */
00063 #define APR_FNM_CASE_BLIND  0x08  /**< Compare characters case-insensitively.
00064                                    * @remark This flag is an Apache addition 
00065                                    */
00066 
00067 /**
00068  * Try to match the string to the given pattern, return APR_SUCCESS if
00069  *    match, else return APR_FNM_NOMATCH.  Note that there is no such thing as
00070  *    an illegal pattern.
00071  *
00072  * With all flags unset, a pattern is interpreted as such:
00073  *
00074  * PATTERN: Backslash followed by any character, including another
00075  *          backslash.<br/>
00076  * MATCHES: That character exactly.
00077  * 
00078  * <p>
00079  * PATTERN: ?<br/>
00080  * MATCHES: Any single character.
00081  * </p>
00082  * 
00083  * <p>
00084  * PATTERN: *<br/>
00085  * MATCHES: Any sequence of zero or more characters. (Note that multiple
00086  *          *s in a row are equivalent to one.)
00087  * 
00088  * PATTERN: Any character other than \?*[ or a \ at the end of the pattern<br/>
00089  * MATCHES: That character exactly. (Case sensitive.)
00090  * 
00091  * PATTERN: [ followed by a class description followed by ]<br/>
00092  * MATCHES: A single character described by the class description.
00093  *          (Never matches, if the class description reaches until the
00094  *          end of the string without a ].) If the first character of
00095  *          the class description is ^ or !, the sense of the description
00096  *          is reversed.  The rest of the class description is a list of
00097  *          single characters or pairs of characters separated by -. Any
00098  *          of those characters can have a backslash in front of them,
00099  *          which is ignored; this lets you use the characters ] and -
00100  *          in the character class, as well as ^ and ! at the
00101  *          beginning.  The pattern matches a single character if it
00102  *          is one of the listed characters or falls into one of the
00103  *          listed ranges (inclusive, case sensitive).  Ranges with
00104  *          the first character larger than the second are legal but
00105  *          never match. Edge cases: [] never matches, and [^] and [!]
00106  *          always match without consuming a character.
00107  * 
00108  * Note that these patterns attempt to match the entire string, not
00109  * just find a substring matching the pattern.
00110  *
00111  * @param pattern The pattern to match to
00112  * @param strings The string we are trying to match
00113  * @param flags flags to use in the match.  Bitwise OR of:
00114  * <pre>
00115  *              APR_FNM_NOESCAPE       Disable backslash escaping
00116  *              APR_FNM_PATHNAME       Slash must be matched by slash
00117  *              APR_FNM_PERIOD         Period must be matched by period
00118  *              APR_FNM_CASE_BLIND     Compare characters case-insensitively.
00119  * </pre>
00120  */
00121 
00122 APR_DECLARE(apr_status_t) apr_fnmatch(const char *pattern, 
00123                                       const char *strings, int flags);
00124 
00125 /**
00126  * Determine if the given pattern is a regular expression.
00127  * @param pattern The pattern to search for glob characters.
00128  * @return non-zero if pattern has any glob characters in it
00129  */
00130 APR_DECLARE(int) apr_fnmatch_test(const char *pattern);
00131 
00132 /**
00133  * Find all files that match a specified pattern.
00134  * @param pattern The pattern to use for finding files.
00135  * @param result Array to use when storing the results
00136  * @param p The pool to use.
00137  * @return non-zero if pattern has any glob characters in it
00138  */
00139 APR_DECLARE(apr_status_t) apr_match_glob(const char *pattern, 
00140                                          apr_array_header_t **result,
00141                                          apr_pool_t *p);
00142 
00143 /** @} */
00144 
00145 #ifdef __cplusplus
00146 }
00147 #endif
00148 
00149 #endif /* !_APR_FNMATCH_H_ */
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines