williamr@2: // glob.h
williamr@2: //
williamr@2: // © Portions copyright (c) 2006 Symbian Software Ltd. All rights reserved.
williamr@2: //
williamr@2: 
williamr@2: /*
williamr@2:  * Copyright (c) 1989, 1993
williamr@2:  *	The Regents of the University of California.  All rights reserved.
williamr@2:  *
williamr@2:  * This code is derived from software contributed to Berkeley by
williamr@2:  * Guido van Rossum.
williamr@2:  *
williamr@2:  * Redistribution and use in source and binary forms, with or without
williamr@2:  * modification, are permitted provided that the following conditions
williamr@2:  * are met:
williamr@2:  * 1. Redistributions of source code must retain the above copyright
williamr@2:  *    notice, this list of conditions and the following disclaimer.
williamr@2:  * 2. Redistributions in binary form must reproduce the above copyright
williamr@2:  *    notice, this list of conditions and the following disclaimer in the
williamr@2:  *    documentation and/or other materials provided with the distribution.
williamr@2:  * 4. Neither the name of the University nor the names of its contributors
williamr@2:  *    may be used to endorse or promote products derived from this software
williamr@2:  *    without specific prior written permission.
williamr@2:  *
williamr@2:  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
williamr@2:  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
williamr@2:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
williamr@2:  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
williamr@2:  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
williamr@2:  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
williamr@2:  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
williamr@2:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
williamr@2:  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
williamr@2:  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
williamr@2:  * SUCH DAMAGE.
williamr@2:  *
williamr@2:  *	@(#)glob.h	8.1 (Berkeley) 6/2/93
williamr@2:  * $FreeBSD: src/include/glob.h,v 1.7 2002/07/17 04:58:09 mikeh Exp $
williamr@2:  */
williamr@2: 
williamr@2: #ifndef _GLOB_H_
williamr@2: #define	_GLOB_H_
williamr@2: 
williamr@2: #include <sys/cdefs.h>
williamr@2: 
williamr@2: struct stat;
williamr@2: typedef struct {
williamr@2: 	int gl_pathc;		/* Count of total paths so far. */
williamr@2: 	int gl_matchc;		/* Count of paths matching pattern. */
williamr@2: 	int gl_offs;		/* Reserved at beginning of gl_pathv. */
williamr@2: 	int gl_flags;		/* Copy of flags parameter to glob. */
williamr@2: 	char **gl_pathv;	/* List of paths matching pattern. */
williamr@2: 				/* Copy of errfunc parameter to glob. */
williamr@2: 	int (*gl_errfunc)(const char *, int);
williamr@2: 
williamr@2: 	/*
williamr@2: 	 * Alternate filesystem access methods for glob; replacement
williamr@2: 	 * versions of closedir(3), readdir(3), opendir(3), stat(2)
williamr@2: 	 * and lstat(2).
williamr@2: 	 */
williamr@2: 	void (*gl_closedir)(void *);
williamr@2: 	struct dirent *(*gl_readdir)(void *);
williamr@2: 	void *(*gl_opendir)(const char *);
williamr@2: 	int (*gl_lstat)(const char *, struct stat *);
williamr@2: 	int (*gl_stat)(const char *, struct stat *);
williamr@2: } glob_t;
williamr@2: 
williamr@2: #if __POSIX_VISIBLE >= 199209
williamr@2: /* Believed to have been introduced in 1003.2-1992 */
williamr@2: #define	GLOB_APPEND	0x0001	/* Append to output from previous call. */
williamr@2: #define	GLOB_DOOFFS	0x0002	/* Use gl_offs. */
williamr@2: #define	GLOB_ERR	0x0004	/* Return on error. */
williamr@2: #define	GLOB_MARK	0x0008	/* Append / to matching directories. */
williamr@2: #define	GLOB_NOCHECK	0x0010	/* Return pattern itself if nothing matches. */
williamr@2: #define	GLOB_NOSORT	0x0020	/* Don't sort. */
williamr@2: #define	GLOB_NOESCAPE	0x2000	/* Disable backslash escaping. */
williamr@2: 
williamr@2: /* Error values returned by glob(3) */
williamr@2: #define	GLOB_NOSPACE	(-1)	/* Malloc call failed. */
williamr@2: #define	GLOB_ABORTED	(-2)	/* Unignored error. */
williamr@2: #define	GLOB_NOMATCH	(-3)	/* No match and GLOB_NOCHECK was not set. */
williamr@2: #define	GLOB_NOSYS	(-4)	/* Obsolete: source comptability only. */
williamr@2: #endif /* __POSIX_VISIBLE >= 199209 */
williamr@2: 
williamr@2: #if __BSD_VISIBLE
williamr@2: #define	GLOB_ALTDIRFUNC	0x0040	/* Use alternately specified directory funcs. */
williamr@2: #define	GLOB_BRACE	0x0080	/* Expand braces ala csh. */
williamr@2: #define	GLOB_MAGCHAR	0x0100	/* Pattern had globbing characters. */
williamr@2: #define	GLOB_NOMAGIC	0x0200	/* GLOB_NOCHECK without magic chars (csh). */
williamr@2: #define	GLOB_QUOTE	0x0400	/* Quote special chars with \. */
williamr@2: #define	GLOB_TILDE	0x0800	/* Expand tilde names from the passwd file. */
williamr@2: #define	GLOB_LIMIT	0x1000	/* limit number of returned paths */
williamr@2: 
williamr@2: /* source compatibility, these are the old names */
williamr@2: #define GLOB_MAXPATH	GLOB_LIMIT
williamr@2: #define	GLOB_ABEND	GLOB_ABORTED
williamr@2: #endif /* __BSD_VISIBLE */
williamr@2: 
williamr@2: __BEGIN_DECLS
williamr@2: 
williamr@2: IMPORT_C int	glob(const char *, int, int (*)(const char *, int), glob_t *);
williamr@2: IMPORT_C void	globfree(glob_t *);
williamr@2: 
williamr@2: __END_DECLS
williamr@2: 
williamr@2: #endif /* !_GLOB_H_ */