flood/trunk/flood_pcre.h

/* Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/* Derived from PCRE's pcreposix.h.

            Copyright (c) 1997-2004 University of Cambridge

-----------------------------------------------------------------------------
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.

    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.

    * Neither the name of the University of Cambridge nor the names of its
      contributors may be used to endorse or promote products derived from
      this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
-----------------------------------------------------------------------------
*/

/**
 * @file flood_regex.h
 * @brief Apache Regex defines
 */

#ifndef FLOOD_REGEX_H
#define FLOOD_REGEX_H

#include "apr.h"

/* Allow for C++ users */

#ifdef __cplusplus
extern "C" {
#endif

/* Options for flood_regexec: */

#define FLOOD_REG_ICASE    0x01 /** use a case-insensitive match */
#define FLOOD_REG_NEWLINE  0x02 /** don't match newlines against '.' etc */
#define FLOOD_REG_NOTBOL   0x04 /** ^ will not match against start-of-string */
#define FLOOD_REG_NOTEOL   0x08 /** $ will not match against end-of-string */

#define FLOOD_REG_EXTENDED (0)  /** unused */
#define FLOOD_REG_NOSUB    (0)  /** unused */

/* Error values: */
enum {
  FLOOD_REG_ASSERT = 1,  /** internal error ? */
  FLOOD_REG_ESPACE,      /** failed to get memory */
  FLOOD_REG_INVARG,      /** invalid argument */
  FLOOD_REG_NOMATCH      /** match failed */
};

/* The structure representing a compiled regular expression. */
typedef struct {
    void *re_pcre;
    apr_size_t re_nsub;
    apr_size_t re_erroffset;
} flood_regex_t;

/* The structure in which a captured offset is returned. */
typedef struct {
    int rm_so;
    int rm_eo;
} flood_regmatch_t;

/* The functions */

/**
 * Compile a regular expression.
 * @param preg Returned compiled regex
 * @param regex The regular expression string
 * @param cflags Must be zero (currently).
 * @return Zero on success or non-zero on error
 */
int flood_regcomp(flood_regex_t *preg, const char *regex,
                  int cflags);

/**
 * Match a NUL-terminated string against a pre-compiled regex.
 * @param preg The pre-compiled regex
 * @param string The string to match
 * @param nmatch Provide information regarding the location of any matches
 * @param pmatch Provide information regarding the location of any matches
 * @param eflags Bitwise OR of any of FLOOD_REG_* flags 
 * @return 0 for successful match, #REG_NOMATCH otherwise
 */ 
int flood_regexec(const flood_regex_t *preg, const char *string,
                  apr_size_t nmatch, flood_regmatch_t *pmatch, int eflags);

/**
 * Return the error code returned by regcomp or regexec into error messages
 * @param errcode the error code returned by regexec or regcomp
 * @param preg The precompiled regex
 * @param errbuf A buffer to store the error in
 * @param errbuf_size The size of the buffer
 */
apr_size_t flood_regerror(int errcode, const flood_regex_t *preg, 
                          char *errbuf, apr_size_t errbuf_size);

/** Destroy a pre-compiled regex.
 * @param preg The pre-compiled regex to free.
 */
void flood_regfree(flood_regex_t *preg);

/* Expose our API as the POSIX compatibility layer */
#define regcomp flood_regcomp
#define regexec flood_regexec
#define regfree flood_regfree
#define regex_t flood_regex_t
#define regmatch_t flood_regmatch_t
#define REG_EXTENDED FLOOD_REG_EXTENDED

#ifdef __cplusplus
}   /* extern "C" */
#endif

#endif /* FLOOD_REGEX_T */

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 flood_regex.h
52	* @brief Apache Regex defines
53	*/
54
55	#ifndef FLOOD_REGEX_H
56	#define FLOOD_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 flood_regexec: */
67
68	#define FLOOD_REG_ICASE 0x01 /** use a case-insensitive match */
69	#define FLOOD_REG_NEWLINE 0x02 /** don't match newlines against '.' etc */
70	#define FLOOD_REG_NOTBOL 0x04 /** ^ will not match against start-of-string */
71	#define FLOOD_REG_NOTEOL 0x08 /** $ will not match against end-of-string */
72
73	#define FLOOD_REG_EXTENDED (0) /** unused */
74	#define FLOOD_REG_NOSUB (0) /** unused */
75
76	/* Error values: */
77	enum {
78	FLOOD_REG_ASSERT = 1, /** internal error ? */
79	FLOOD_REG_ESPACE, /** failed to get memory */
80	FLOOD_REG_INVARG, /** invalid argument */
81	FLOOD_REG_NOMATCH /** match failed */
82	};
83
84	/* The structure representing a compiled regular expression. */
85	typedef struct {
86	void *re_pcre;
87	apr_size_t re_nsub;
88	apr_size_t re_erroffset;
89	} flood_regex_t;
90
91	/* The structure in which a captured offset is returned. */
92	typedef struct {
93	int rm_so;
94	int rm_eo;
95	} flood_regmatch_t;
96
97	/* The functions */
98
99	/**
100	* Compile a regular expression.
101	* @param preg Returned compiled regex
102	* @param regex The regular expression string
103	* @param cflags Must be zero (currently).
104	* @return Zero on success or non-zero on error
105	*/
106	int flood_regcomp(flood_regex_t preg, const char regex,
107	int cflags);
108
109	/**
110	* Match a NUL-terminated string against a pre-compiled regex.
111	* @param preg The pre-compiled regex
112	* @param string The string to match
113	* @param nmatch Provide information regarding the location of any matches
114	* @param pmatch Provide information regarding the location of any matches
115	* @param eflags Bitwise OR of any of FLOOD_REG_* flags
116	* @return 0 for successful match, #REG_NOMATCH otherwise
117	*/
118	int flood_regexec(const flood_regex_t preg, const char string,
119	apr_size_t nmatch, flood_regmatch_t *pmatch, int eflags);
120
121	/**
122	* Return the error code returned by regcomp or regexec into error messages
123	* @param errcode the error code returned by regexec or regcomp
124	* @param preg The precompiled regex
125	* @param errbuf A buffer to store the error in
126	* @param errbuf_size The size of the buffer
127	*/
128	apr_size_t flood_regerror(int errcode, const flood_regex_t *preg,
129	char *errbuf, apr_size_t errbuf_size);
130
131	/** Destroy a pre-compiled regex.
132	* @param preg The pre-compiled regex to free.
133	*/
134	void flood_regfree(flood_regex_t *preg);
135
136	/* Expose our API as the POSIX compatibility layer */
137	#define regcomp flood_regcomp
138	#define regexec flood_regexec
139	#define regfree flood_regfree
140	#define regex_t flood_regex_t
141	#define regmatch_t flood_regmatch_t
142	#define REG_EXTENDED FLOOD_REG_EXTENDED
143
144	#ifdef __cplusplus
145	} /* extern "C" */
146	#endif
147
148	#endif /* FLOOD_REGEX_T */
149
infrastructure at apache.org	ViewVC Help
Powered by ViewVC 1.1.26