xref: /freebsd/include/glob.h (revision a8445737e740901f5f2c8d24c12ef7fc8b00134e)
1 /*
2  * Copyright (c) 1989, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Guido van Rossum.
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.
35  *
36  *	@(#)glob.h	8.1 (Berkeley) 6/2/93
37  */
38 
39 #ifndef _GLOB_H_
40 #define	_GLOB_H_
41 
42 #include <sys/cdefs.h>
43 
44 struct stat;
45 typedef struct {
46 	int gl_pathc;		/* Count of total paths so far. */
47 	int gl_matchc;		/* Count of paths matching pattern. */
48 	int gl_offs;		/* Reserved at beginning of gl_pathv. */
49 	int gl_flags;		/* Copy of flags parameter to glob. */
50 	char **gl_pathv;	/* List of paths matching pattern. */
51 				/* Copy of errfunc parameter to glob. */
52 	int (*gl_errfunc) __P((const char *, int));
53 
54 	/*
55 	 * Alternate filesystem access methods for glob; replacement
56 	 * versions of closedir(3), readdir(3), opendir(3), stat(2)
57 	 * and lstat(2).
58 	 */
59 	void (*gl_closedir) __P((void *));
60 	struct dirent *(*gl_readdir) __P((void *));
61 	void *(*gl_opendir) __P((const char *));
62 	int (*gl_lstat) __P((const char *, struct stat *));
63 	int (*gl_stat) __P((const char *, struct stat *));
64 } glob_t;
65 
66 #define	GLOB_APPEND	0x0001	/* Append to output from previous call. */
67 #define	GLOB_DOOFFS	0x0002	/* Use gl_offs. */
68 #define	GLOB_ERR	0x0004	/* Return on error. */
69 #define	GLOB_MARK	0x0008	/* Append / to matching directories. */
70 #define	GLOB_NOCHECK	0x0010	/* Return pattern itself if nothing matches. */
71 #define	GLOB_NOSORT	0x0020	/* Don't sort. */
72 
73 #define	GLOB_ALTDIRFUNC	0x0040	/* Use alternately specified directory funcs. */
74 #define	GLOB_BRACE	0x0080	/* Expand braces ala csh. */
75 #define	GLOB_MAGCHAR	0x0100	/* Pattern had globbing characters. */
76 #define	GLOB_NOMAGIC	0x0200	/* GLOB_NOCHECK without magic chars (csh). */
77 #define	GLOB_QUOTE	0x0400	/* Quote special chars with \. */
78 #define	GLOB_TILDE	0x0800	/* Expand tilde names from the passwd file. */
79 
80 #define	GLOB_NOSPACE	(-1)	/* Malloc call failed. */
81 #define	GLOB_ABEND	(-2)	/* Unignored error. */
82 
83 __BEGIN_DECLS
84 int	glob __P((const char *, int, int (*)(const char *, int), glob_t *));
85 void	globfree __P((glob_t *));
86 __END_DECLS
87 
88 #endif /* !_GLOB_H_ */
89