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

/*
 * Copyright (c) 1989, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Guido van Rossum.
 *
 * 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.
 *
 *	@(#)glob.h	8.1 (Berkeley) 6/2/93
 * $FreeBSD: /repoman/r/ncvs/src/include/glob.h,v 1.7 2002/07/17 04:58:09 mikeh Exp $
 */

#ifndef _GLOB_H_
#define	_GLOB_H_

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

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

#ifndef _POSIX_C_SOURCE
struct dirent;
struct stat;
#endif /* _POSIX_C_SOURCE */
typedef struct {
	size_t gl_pathc;	/* Count of total paths so far. */
	int gl_matchc;		/* Count of paths matching pattern. */
	size_t gl_offs;		/* Reserved at beginning of gl_pathv. */
	int gl_flags;		/* Copy of flags parameter to glob. */
	char **gl_pathv;	/* List of paths matching pattern. */
				/* Copy of errfunc parameter to glob. */
	int (*gl_errfunc)(const char *, int);

#ifndef _POSIX_C_SOURCE
	/*
	 * Alternate filesystem access methods for glob; replacement
	 * versions of closedir(3), readdir(3), opendir(3), stat(2)
	 * and lstat(2).
	 */
	void (*gl_closedir)(void *);
	struct dirent *(*gl_readdir)(void *);
	void *(*gl_opendir)(const char *);
	int (*gl_lstat)(const char *, struct stat *);
	int (*gl_stat)(const char *, struct stat *);
#else /* _POSIX_C_SOURCE */
	void *_gl_reserved[5];
#endif /* _POSIX_C_SOURCE */
} glob_t;

/* Believed to have been introduced in 1003.2-1992 */
#define	GLOB_APPEND	0x0001	/* Append to output from previous call. */
#define	GLOB_DOOFFS	0x0002	/* Use gl_offs. */
#define	GLOB_ERR	0x0004	/* Return on error. */
#define	GLOB_MARK	0x0008	/* Append / to matching directories. */
#define	GLOB_NOCHECK	0x0010	/* Return pattern itself if nothing matches. */
#define	GLOB_NOSORT	0x0020	/* Don't sort. */
#define	GLOB_NOESCAPE	0x2000	/* Disable backslash escaping. */

/* Error values returned by glob(3) */
#define	GLOB_NOSPACE	(-1)	/* Malloc call failed. */
#define	GLOB_ABORTED	(-2)	/* Unignored error. */
#define	GLOB_NOMATCH	(-3)	/* No match and GLOB_NOCHECK was not set. */
#define	GLOB_NOSYS	(-4)	/* Obsolete: source comptability only. */

#define	GLOB_ALTDIRFUNC	0x0040	/* Use alternately specified directory funcs. */
#define	GLOB_BRACE	0x0080	/* Expand braces ala csh. */
#define	GLOB_MAGCHAR	0x0100	/* Pattern had globbing characters. */
#define	GLOB_NOMAGIC	0x0200	/* GLOB_NOCHECK without magic chars (csh). */
#define	GLOB_QUOTE	0x0400	/* Quote special chars with \. */
#define	GLOB_TILDE	0x0800	/* Expand tilde names from the passwd file. */
#define	GLOB_LIMIT	0x1000	/* limit number of returned paths */

/* source compatibility, these are the old names */
#define GLOB_MAXPATH	GLOB_LIMIT
#define	GLOB_ABEND	GLOB_ABORTED

__BEGIN_DECLS
int	glob(const char * __restrict, int, int (*)(const char *, int), 
	     glob_t * __restrict);
void	globfree(glob_t *);
__END_DECLS

#endif /* !_GLOB_H_ */
Commit	Line	Data
e9ce8d39	1	/*
5b2abdfb	2	* Copyright (c) 1989, 1993
e9ce8d39 A	3	* The Regents of the University of California. All rights reserved.
	4	*
	5	* This code is derived from software contributed to Berkeley by
5b2abdfb	6	* Guido van Rossum.
e9ce8d39 A	7	*
	8	* Redistribution and use in source and binary forms, with or without
	9	* modification, are permitted provided that the following conditions
	10	* are met:
	11	* 1. Redistributions of source code must retain the above copyright
	12	* notice, this list of conditions and the following disclaimer.
	13	* 2. Redistributions in binary form must reproduce the above copyright
	14	* notice, this list of conditions and the following disclaimer in the
	15	* documentation and/or other materials provided with the distribution.
	16	* 3. All advertising materials mentioning features or use of this software
	17	* must display the following acknowledgement:
	18	* This product includes software developed by the University of
	19	* California, Berkeley and its contributors.
	20	* 4. Neither the name of the University nor the names of its contributors
	21	* may be used to endorse or promote products derived from this software
	22	* without specific prior written permission.
	23	*
	24	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	25	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	26	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	27	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	28	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	29	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	30	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	31	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	32	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	33	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	34	* SUCH DAMAGE.
5b2abdfb A	35	*
5b2abdfb A	36	* @(#)glob.h 8.1 (Berkeley) 6/2/93
59e0d9fe	37	* $FreeBSD: /repoman/r/ncvs/src/include/glob.h,v 1.7 2002/07/17 04:58:09 mikeh Exp $
e9ce8d39 A	38	*/
e9ce8d39 A	39
5b2abdfb A	40	#ifndef _GLOB_H_
5b2abdfb A	41	#define _GLOB_H_
e9ce8d39	42
5b2abdfb	43	#include <sys/cdefs.h>
59e0d9fe A	44	#include <_types.h>
59e0d9fe A	45
3d9156a7 A	46	#ifndef _SIZE_T
	47	#define _SIZE_T
	48	typedef __darwin_size_t size_t;
59e0d9fe	49	#endif
e9ce8d39	50
3d9156a7 A	51	#ifndef _POSIX_C_SOURCE
3d9156a7 A	52	struct dirent;
5b2abdfb	53	struct stat;
3d9156a7	54	#endif /* _POSIX_C_SOURCE */
5b2abdfb	55	typedef struct {
59e0d9fe	56	size_t gl_pathc; /* Count of total paths so far. */
5b2abdfb	57	int gl_matchc; /* Count of paths matching pattern. */
59e0d9fe	58	size_t gl_offs; /* Reserved at beginning of gl_pathv. */
5b2abdfb A	59	int gl_flags; /* Copy of flags parameter to glob. */
	60	char *gl_pathv; / List of paths matching pattern. */
	61	/* Copy of errfunc parameter to glob. */
9385eb3d	62	int (gl_errfunc)(const char , int);
5b2abdfb	63
3d9156a7	64	#ifndef _POSIX_C_SOURCE
5b2abdfb A	65	/*
	66	* Alternate filesystem access methods for glob; replacement
	67	* versions of closedir(3), readdir(3), opendir(3), stat(2)
	68	* and lstat(2).
	69	*/
9385eb3d	70	void (gl_closedir)(void );
59e0d9fe	71	struct dirent (gl_readdir)(void *);
9385eb3d A	72	void (gl_opendir)(const char *);
	73	int (gl_lstat)(const char , struct stat *);
	74	int (gl_stat)(const char , struct stat *);
3d9156a7 A	75	#else /* _POSIX_C_SOURCE */
	76	void *_gl_reserved[5];
	77	#endif /* _POSIX_C_SOURCE */
5b2abdfb A	78	} glob_t;
5b2abdfb A	79
59e0d9fe	80	/* Believed to have been introduced in 1003.2-1992 */
5b2abdfb A	81	#define GLOB_APPEND 0x0001 /* Append to output from previous call. */
	82	#define GLOB_DOOFFS 0x0002 /* Use gl_offs. */
	83	#define GLOB_ERR 0x0004 /* Return on error. */
	84	#define GLOB_MARK 0x0008 /* Append / to matching directories. */
	85	#define GLOB_NOCHECK 0x0010 /* Return pattern itself if nothing matches. */
	86	#define GLOB_NOSORT 0x0020 /* Don't sort. */
59e0d9fe A	87	#define GLOB_NOESCAPE 0x2000 /* Disable backslash escaping. */
	88
	89	/* Error values returned by glob(3) */
	90	#define GLOB_NOSPACE (-1) /* Malloc call failed. */
	91	#define GLOB_ABORTED (-2) /* Unignored error. */
	92	#define GLOB_NOMATCH (-3) /* No match and GLOB_NOCHECK was not set. */
	93	#define GLOB_NOSYS (-4) /* Obsolete: source comptability only. */
5b2abdfb	94
5b2abdfb A	95	#define GLOB_ALTDIRFUNC 0x0040 /* Use alternately specified directory funcs. */
	96	#define GLOB_BRACE 0x0080 /* Expand braces ala csh. */
	97	#define GLOB_MAGCHAR 0x0100 /* Pattern had globbing characters. */
	98	#define GLOB_NOMAGIC 0x0200 /* GLOB_NOCHECK without magic chars (csh). */
	99	#define GLOB_QUOTE 0x0400 /* Quote special chars with \. */
	100	#define GLOB_TILDE 0x0800 /* Expand tilde names from the passwd file. */
59e0d9fe	101	#define GLOB_LIMIT 0x1000 /* limit number of returned paths */
5b2abdfb	102
59e0d9fe A	103	/* source compatibility, these are the old names */
	104	#define GLOB_MAXPATH GLOB_LIMIT
	105	#define GLOB_ABEND GLOB_ABORTED
5b2abdfb A	106
5b2abdfb A	107	__BEGIN_DECLS
3d9156a7 A	108	int glob(const char * __restrict, int, int ()(const char , int),
3d9156a7 A	109	glob_t * __restrict);
9385eb3d	110	void globfree(glob_t *);
5b2abdfb	111	__END_DECLS
e9ce8d39	112
5b2abdfb	113	#endif /* !_GLOB_H_ */