granicus.if.org Git - apache/blob - include/ap_regex.h

   1 /* Licensed to the Apache Software Foundation (ASF) under one or more
   2  * contributor license agreements.  See the NOTICE file distributed with
   3  * this work for additional information regarding copyright ownership.
   4  * The ASF licenses this file to You under the Apache License, Version 2.0
   5  * (the "License"); you may not use this file except in compliance with
   6  * the License.  You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /* Derived from PCRE's pcreposix.h.
  18
  19             Copyright (c) 1997-2004 University of Cambridge
  20
  21 -----------------------------------------------------------------------------
  22 Redistribution and use in source and binary forms, with or without
  23 modification, are permitted provided that the following conditions are met:
  24
  25     * Redistributions of source code must retain the above copyright notice,
  26       this list of conditions and the following disclaimer.
  27
  28     * Redistributions in binary form must reproduce the above copyright
  29       notice, this list of conditions and the following disclaimer in the
  30       documentation and/or other materials provided with the distribution.
  31
  32     * Neither the name of the University of Cambridge nor the names of its
  33       contributors may be used to endorse or promote products derived from
  34       this software without specific prior written permission.
  35
  36 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  37 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  38 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  39 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  40 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  41 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  42 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  43 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  44 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  45 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  46 POSSIBILITY OF SUCH DAMAGE.
  47 -----------------------------------------------------------------------------
  48 */
  49
  50 /**
  51  * @file ap_regex.h
  52  * @brief Apache Regex defines
  53  */
  54
  55 #ifndef AP_REGEX_H
  56 #define AP_REGEX_H
  57
  58 #include "apr.h"
  59
  60 /* Allow for C++ users */
  61
  62 #ifdef __cplusplus
  63 extern "C" {
  64 #endif
  65
  66 /* Options for ap_regcomp, ap_regexec, and ap_rxplus versions: */
  67
  68 #define AP_REG_ICASE    0x01 /**< use a case-insensitive match */
  69 #define AP_REG_NEWLINE  0x02 /**< don't match newlines against '.' etc */
  70 #define AP_REG_NOTBOL   0x04 /**< ^ will not match against start-of-string */
  71 #define AP_REG_NOTEOL   0x08 /**< $ will not match against end-of-string */
  72
  73 #define AP_REG_EXTENDED (0)  /**< unused */
  74 #define AP_REG_NOSUB    (0)  /**< unused */
  75
  76 #define AP_REG_MULTI    0x10 /**< perl's /g (needs fixing) */
  77 #define AP_REG_NOMEM    0x20 /**< nomem in our code */
  78 #define AP_REG_DOTALL   0x40 /**< perl's /s flag */
  79
  80 #define AP_REG_MATCH "MATCH_" /**< suggested prefix for ap_regname */
  81
  82 /* Arguments for ap_pcre_version_string */
  83 enum {
  84   AP_REG_PCRE_COMPILED = 0, /** PCRE version used during program compilation */
  85   AP_REG_PCRE_LOADED        /** PCRE version loaded at runtime */
  86 };
  87
  88 /* Error values: */
  89 enum {
  90   AP_REG_ASSERT = 1,  /** internal error ? */
  91   AP_REG_ESPACE,      /** failed to get memory */
  92   AP_REG_INVARG,      /** invalid argument */
  93   AP_REG_NOMATCH      /** match failed */
  94 };
  95
  96 /* The structure representing a compiled regular expression. */
  97 typedef struct {
  98     void *re_pcre;
  99     int re_nsub;
 100     apr_size_t re_erroffset;
 101 } ap_regex_t;
 102
 103 /* The structure in which a captured offset is returned. */
 104 typedef struct {
 105     int rm_so;
 106     int rm_eo;
 107 } ap_regmatch_t;
 108
 109 /* The functions */
 110
 111 /**
 112  * Return PCRE version string.
 113  * @param which Either AP_REG_PCRE_COMPILED (PCRE version used
 114  *              during program compilation) or AP_REG_PCRE_LOADED
 115  *              (PCRE version used at runtime)
 116  * @return The PCRE version string
 117  */
 118 AP_DECLARE(const char *) ap_pcre_version_string(int which);
 119
 120 /**
 121  * Compile a regular expression.
 122  * @param preg Returned compiled regex
 123  * @param regex The regular expression string
 124  * @param cflags Bitwise OR of AP_REG_* flags (ICASE and NEWLINE supported,
 125  *                                             other flags are ignored)
 126  * @return Zero on success or non-zero on error
 127  */
 128 AP_DECLARE(int) ap_regcomp(ap_regex_t *preg, const char *regex, int cflags);
 129
 130 /**
 131  * Match a NUL-terminated string against a pre-compiled regex.
 132  * @param preg The pre-compiled regex
 133  * @param string The string to match
 134  * @param nmatch Provide information regarding the location of any matches
 135  * @param pmatch Provide information regarding the location of any matches
 136  * @param eflags Bitwise OR of AP_REG_* flags (NOTBOL and NOTEOL supported,
 137  *                                             other flags are ignored)
 138  * @return 0 for successful match, \p AP_REG_NOMATCH otherwise
 139  */
 140 AP_DECLARE(int) ap_regexec(const ap_regex_t *preg, const char *string,
 141                            apr_size_t nmatch, ap_regmatch_t *pmatch, int eflags);
 142
 143 /**
 144  * Match a string with given length against a pre-compiled regex. The string
 145  * does not need to be NUL-terminated.
 146  * @param preg The pre-compiled regex
 147  * @param buff The string to match
 148  * @param len Length of the string to match
 149  * @param nmatch Provide information regarding the location of any matches
 150  * @param pmatch Provide information regarding the location of any matches
 151  * @param eflags Bitwise OR of AP_REG_* flags (NOTBOL and NOTEOL supported,
 152  *                                             other flags are ignored)
 153  * @return 0 for successful match, AP_REG_NOMATCH otherwise
 154  */
 155 AP_DECLARE(int) ap_regexec_len(const ap_regex_t *preg, const char *buff,
 156                                apr_size_t len, apr_size_t nmatch,
 157                                ap_regmatch_t *pmatch, int eflags);
 158
 159 /**
 160  * Return the error code returned by regcomp or regexec into error messages
 161  * @param errcode the error code returned by regexec or regcomp
 162  * @param preg The precompiled regex
 163  * @param errbuf A buffer to store the error in
 164  * @param errbuf_size The size of the buffer
 165  */
 166 AP_DECLARE(apr_size_t) ap_regerror(int errcode, const ap_regex_t *preg,
 167                                    char *errbuf, apr_size_t errbuf_size);
 168
 169 /**
 170  * Return an array of named regex backreferences
 171  * @param preg The precompiled regex
 172  * @param names The array to which the names will be added
 173  * @param prefix An optional prefix to add to the returned names.  AP_REG_MATCH
 174  * is the recommended prefix.
 175  * @param upper If non zero, uppercase the names
 176  */
 177 AP_DECLARE(int) ap_regname(const ap_regex_t *preg,
 178                            apr_array_header_t *names, const char *prefix,
 179                            int upper);
 180
 181 /** Destroy a pre-compiled regex.
 182  * @param preg The pre-compiled regex to free.
 183  */
 184 AP_DECLARE(void) ap_regfree(ap_regex_t *preg);
 185
 186 /* ap_rxplus: higher-level regexps */
 187
 188 typedef struct {
 189     ap_regex_t rx;
 190     apr_uint32_t flags;
 191     const char *subs;
 192     const char *match;
 193     apr_size_t nmatch;
 194     ap_regmatch_t *pmatch;
 195 } ap_rxplus_t;
 196
 197 /**
 198  * Compile a pattern into a regexp.
 199  * supports perl-like formats
 200  *    match-string
 201  *    /match-string/flags
 202  *    s/match-string/replacement-string/flags
 203  *    Intended to support more perl-like stuff as and when round tuits happen
 204  * match-string is anything supported by ap_regcomp
 205  * replacement-string is a substitution string as supported in ap_pregsub
 206  * flags should correspond with perl syntax: treat failure to do so as a bug
 207  *                                           (documentation TBD)
 208  * @param pool Pool to allocate from
 209  * @param pattern Pattern to compile
 210  * @return Compiled regexp, or NULL in case of compile/syntax error
 211  */
 212 AP_DECLARE(ap_rxplus_t*) ap_rxplus_compile(apr_pool_t *pool, const char *pattern);
 213 /**
 214  * Apply a regexp operation to a string.
 215  * @param pool Pool to allocate from
 216  * @param rx The regex match to apply
 217  * @param pattern The string to apply it to
 218  *                NOTE: This MUST be kept in scope to use regexp memory
 219  * @param newpattern The modified string (ignored if the operation doesn't
 220  *                                        modify the string)
 221  * @return Number of times a match happens.  Normally 0 (no match) or 1
 222  *         (match found), but may be greater if a transforming pattern
 223  *         is applied with the 'g' flag.
 224  */
 225 AP_DECLARE(int) ap_rxplus_exec(apr_pool_t *pool, ap_rxplus_t *rx,
 226                                const char *pattern, char **newpattern);
 227 #ifdef DOXYGEN
 228 /**
 229  * Number of matches in the regexp operation's memory
 230  * This may be 0 if no match is in memory, or up to nmatch from compilation
 231  * @param rx The regexp
 232  * @return Number of matches in memory
 233  */
 234 AP_DECLARE(int) ap_rxplus_nmatch(ap_rxplus_t *rx);
 235 #else
 236 #define ap_rxplus_nmatch(rx) (((rx)->match != NULL) ? (rx)->nmatch : 0)
 237 #endif
 238 /**
 239  * Get a pointer to a match from regex memory
 240  * NOTE: this relies on the match pattern from the last call to
 241  *       ap_rxplus_exec still being valid (i.e. not freed or out-of-scope)
 242  * @param rx The regexp
 243  * @param n The match number to retrieve (must be between 0 and nmatch)
 244  * @param len Returns the length of the match.
 245  * @param match Returns the match pattern
 246  */
 247 AP_DECLARE(void) ap_rxplus_match(ap_rxplus_t *rx, int n, int *len,
 248                                  const char **match);
 249 /**
 250  * Get a match from regex memory in a string copy
 251  * NOTE: this relies on the match pattern from the last call to
 252  *       ap_rxplus_exec still being valid (i.e. not freed or out-of-scope)
 253  * @param pool Pool to allocate from
 254  * @param rx The regexp
 255  * @param n The match number to retrieve (must be between 0 and nmatch)
 256  * @return The matched string
 257  */
 258 AP_DECLARE(char*) ap_rxplus_pmatch(apr_pool_t *pool, ap_rxplus_t *rx, int n);
 259
 260 #ifdef __cplusplus
 261 }   /* extern "C" */
 262 #endif
 263
 264 #endif /* AP_REGEX_H */