[apple/libc.git] / include / regex.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*-
 * Copyright (c) 1992 Henry Spencer.
 * Copyright (c) 1992, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Henry Spencer of the University of Toronto.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University 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 REGENTS 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 REGENTS 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.
 *
 *	@(#)regex.h	8.2 (Berkeley) 1/3/94
 */

#ifndef _REGEX_H_
#define	_REGEX_H_

#include <sys/cdefs.h>
#include <_types.h>

/* types */
typedef __darwin_off_t regoff_t;

#ifndef _SIZE_T
#define _SIZE_T
typedef __darwin_size_t	size_t;
#endif

typedef struct {
	int re_magic;
	size_t re_nsub;		/* number of parenthesized subexpressions */
	const char *re_endp;	/* end pointer for REG_PEND */
	struct re_guts *re_g;	/* none of your business :-) */
} regex_t;

typedef struct {
	regoff_t rm_so;		/* start of match */
	regoff_t rm_eo;		/* end of match */
} regmatch_t;

/* regcomp() flags */
#ifndef _POSIX_C_SOURCE
#define	REG_BASIC	0000
#endif	/* !_POSIX_C_SOURCE */
#define	REG_EXTENDED	0001
#define	REG_ICASE	0002
#define	REG_NOSUB	0004
#define	REG_NEWLINE	0010
#ifndef _POSIX_C_SOURCE
#define	REG_NOSPEC	0020
#define	REG_PEND	0040
#define	REG_DUMP	0200
#endif	/* !_POSIX_C_SOURCE */

/* regerror() flags */
#define	REG_ENOSYS	 (-1)	/* Reserved */
#define	REG_NOMATCH	 1
#define	REG_BADPAT	 2
#define	REG_ECOLLATE	 3
#define	REG_ECTYPE	 4
#define	REG_EESCAPE	 5
#define	REG_ESUBREG	 6
#define	REG_EBRACK	 7
#define	REG_EPAREN	 8
#define	REG_EBRACE	 9
#define	REG_BADBR	10
#define	REG_ERANGE	11
#define	REG_ESPACE	12
#define	REG_BADRPT	13
#ifndef _POSIX_C_SOURCE
#define	REG_EMPTY	14
#define	REG_ASSERT	15
#define	REG_INVARG	16
#define	REG_ILLSEQ	17
#define	REG_ATOI	255	/* convert name to number (!) */
#define	REG_ITOA	0400	/* convert number to name (!) */
#endif	/* !_POSIX_C_SOURCE */

/* regexec() flags */
#define	REG_NOTBOL	00001
#define	REG_NOTEOL	00002
#ifndef _POSIX_C_SOURCE
#define	REG_STARTEND	00004
#define	REG_TRACE	00400	/* tracing of execution */
#define	REG_LARGE	01000	/* force large representation */
#define	REG_BACKR	02000	/* force use of backref code */
#endif	/* !_POSIX_C_SOURCE */

__BEGIN_DECLS
int	regcomp(regex_t * __restrict, const char * __restrict, int) __DARWIN_ALIAS(regcomp);
size_t	regerror(int, const regex_t * __restrict, char * __restrict, size_t);
/* For meeting c99 stds, pass regmatch_t*, rather than the array */
int	regexec(const regex_t * __restrict,
	    const char * __restrict, size_t, regmatch_t * __restrict, int);
void	regfree(regex_t *);
__END_DECLS

#endif /* !_REGEX_H_ */
Commit	Line	Data
e9ce8d39	1	/*
5b2abdfb	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
e9ce8d39 A	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
734aad71 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. Please obtain a copy of the License at
	10	* http://www.opensource.apple.com/apsl/ and read it before using this
	11	* file.
	12	*
	13	* The Original Code and all software distributed under the License are
	14	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
e9ce8d39 A	15	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
e9ce8d39 A	16	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
734aad71 A	17	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	18	* Please see the License for the specific language governing rights and
	19	* limitations under the License.
e9ce8d39 A	20	*
	21	* @APPLE_LICENSE_HEADER_END@
	22	*/
5b2abdfb A	23	/*-
	24	* Copyright (c) 1992 Henry Spencer.
	25	* Copyright (c) 1992, 1993
e9ce8d39 A	26	* The Regents of the University of California. All rights reserved.
	27	*
	28	* This code is derived from software contributed to Berkeley by
5b2abdfb	29	* Henry Spencer of the University of Toronto.
e9ce8d39 A	30	*
	31	* Redistribution and use in source and binary forms, with or without
	32	* modification, are permitted provided that the following conditions
	33	* are met:
	34	* 1. Redistributions of source code must retain the above copyright
	35	* notice, this list of conditions and the following disclaimer.
	36	* 2. Redistributions in binary form must reproduce the above copyright
	37	* notice, this list of conditions and the following disclaimer in the
	38	* documentation and/or other materials provided with the distribution.
	39	* 3. All advertising materials mentioning features or use of this software
	40	* must display the following acknowledgement:
	41	* This product includes software developed by the University of
	42	* California, Berkeley and its contributors.
	43	* 4. Neither the name of the University nor the names of its contributors
	44	* may be used to endorse or promote products derived from this software
	45	* without specific prior written permission.
	46	*
	47	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	48	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	49	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	50	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	51	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	52	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	53	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	54	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	55	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	56	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	57	* SUCH DAMAGE.
5b2abdfb A	58	*
5b2abdfb A	59	* @(#)regex.h 8.2 (Berkeley) 1/3/94
e9ce8d39 A	60	*/
e9ce8d39 A	61
5b2abdfb A	62	#ifndef _REGEX_H_
5b2abdfb A	63	#define _REGEX_H_
e9ce8d39	64
5b2abdfb	65	#include <sys/cdefs.h>
3d9156a7	66	#include <_types.h>
e9ce8d39	67
5b2abdfb	68	/* types */
3d9156a7	69	typedef __darwin_off_t regoff_t;
59e0d9fe	70
3d9156a7 A	71	#ifndef _SIZE_T
	72	#define _SIZE_T
	73	typedef __darwin_size_t size_t;
59e0d9fe	74	#endif
e9ce8d39	75
5b2abdfb A	76	typedef struct {
	77	int re_magic;
	78	size_t re_nsub; /* number of parenthesized subexpressions */
59e0d9fe	79	const char re_endp; / end pointer for REG_PEND */
5b2abdfb A	80	struct re_guts re_g; / none of your business :-) */
5b2abdfb A	81	} regex_t;
e9ce8d39	82
5b2abdfb A	83	typedef struct {
	84	regoff_t rm_so; /* start of match */
	85	regoff_t rm_eo; /* end of match */
	86	} regmatch_t;
e9ce8d39	87
5b2abdfb	88	/* regcomp() flags */
3d9156a7	89	#ifndef _POSIX_C_SOURCE
5b2abdfb	90	#define REG_BASIC 0000
3d9156a7	91	#endif /* !_POSIX_C_SOURCE */
5b2abdfb A	92	#define REG_EXTENDED 0001
	93	#define REG_ICASE 0002
	94	#define REG_NOSUB 0004
	95	#define REG_NEWLINE 0010
3d9156a7	96	#ifndef _POSIX_C_SOURCE
5b2abdfb A	97	#define REG_NOSPEC 0020
	98	#define REG_PEND 0040
	99	#define REG_DUMP 0200
3d9156a7	100	#endif /* !_POSIX_C_SOURCE */
5b2abdfb A	101
5b2abdfb A	102	/* regerror() flags */
59e0d9fe	103	#define REG_ENOSYS (-1) /* Reserved */
5b2abdfb A	104	#define REG_NOMATCH 1
	105	#define REG_BADPAT 2
	106	#define REG_ECOLLATE 3
	107	#define REG_ECTYPE 4
	108	#define REG_EESCAPE 5
	109	#define REG_ESUBREG 6
	110	#define REG_EBRACK 7
	111	#define REG_EPAREN 8
	112	#define REG_EBRACE 9
	113	#define REG_BADBR 10
	114	#define REG_ERANGE 11
	115	#define REG_ESPACE 12
	116	#define REG_BADRPT 13
3d9156a7	117	#ifndef _POSIX_C_SOURCE
5b2abdfb A	118	#define REG_EMPTY 14
	119	#define REG_ASSERT 15
	120	#define REG_INVARG 16
3d9156a7	121	#define REG_ILLSEQ 17
5b2abdfb A	122	#define REG_ATOI 255 /* convert name to number (!) */
5b2abdfb A	123	#define REG_ITOA 0400 /* convert number to name (!) */
3d9156a7	124	#endif /* !_POSIX_C_SOURCE */
5b2abdfb A	125
	126	/* regexec() flags */
	127	#define REG_NOTBOL 00001
	128	#define REG_NOTEOL 00002
3d9156a7	129	#ifndef _POSIX_C_SOURCE
5b2abdfb A	130	#define REG_STARTEND 00004
	131	#define REG_TRACE 00400 /* tracing of execution */
	132	#define REG_LARGE 01000 /* force large representation */
	133	#define REG_BACKR 02000 /* force use of backref code */
3d9156a7	134	#endif /* !_POSIX_C_SOURCE */
5b2abdfb A	135
5b2abdfb A	136	__BEGIN_DECLS
3d9156a7	137	int regcomp(regex_t * __restrict, const char * __restrict, int) __DARWIN_ALIAS(regcomp);
59e0d9fe	138	size_t regerror(int, const regex_t * __restrict, char * __restrict, size_t);
3d9156a7	139	/* For meeting c99 stds, pass regmatch_t, rather than the array /
59e0d9fe	140	int regexec(const regex_t * __restrict,
3d9156a7	141	const char * __restrict, size_t, regmatch_t * __restrict, int);
9385eb3d	142	void regfree(regex_t *);
5b2abdfb	143	__END_DECLS
e9ce8d39	144
5b2abdfb	145	#endif /* !_REGEX_H_ */