xref: /freebsd/include/glob.h (revision cc16dea626cf2fc80cde667ac4798065108e596c)
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. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *	@(#)glob.h	8.1 (Berkeley) 6/2/93
33  * $FreeBSD$
34  */
35 
36 #ifndef _GLOB_H_
37 #define	_GLOB_H_
38 
39 #include <sys/cdefs.h>
40 #include <sys/_types.h>
41 
42 #ifndef	_SIZE_T_DECLARED
43 typedef	__size_t	size_t;
44 #define	_SIZE_T_DECLARED
45 #endif
46 
47 struct stat;
48 typedef struct {
49 	size_t gl_pathc;	/* Count of total paths so far. */
50 	size_t gl_matchc;	/* Count of paths matching pattern. */
51 	size_t gl_offs;		/* Reserved at beginning of gl_pathv. */
52 	int gl_flags;		/* Copy of flags parameter to glob. */
53 	char **gl_pathv;	/* List of paths matching pattern. */
54 				/* Copy of errfunc parameter to glob. */
55 	int (*gl_errfunc)(const char *, int);
56 
57 	/*
58 	 * Alternate filesystem access methods for glob; replacement
59 	 * versions of closedir(3), readdir(3), opendir(3), stat(2)
60 	 * and lstat(2).
61 	 */
62 	void (*gl_closedir)(void *);
63 	struct dirent *(*gl_readdir)(void *);
64 	void *(*gl_opendir)(const char *);
65 	int (*gl_lstat)(const char *, struct stat *);
66 	int (*gl_stat)(const char *, struct stat *);
67 } glob_t;
68 
69 #if __POSIX_VISIBLE >= 199209
70 /* Believed to have been introduced in 1003.2-1992 */
71 #define	GLOB_APPEND	0x0001	/* Append to output from previous call. */
72 #define	GLOB_DOOFFS	0x0002	/* Use gl_offs. */
73 #define	GLOB_ERR	0x0004	/* Return on error. */
74 #define	GLOB_MARK	0x0008	/* Append / to matching directories. */
75 #define	GLOB_NOCHECK	0x0010	/* Return pattern itself if nothing matches. */
76 #define	GLOB_NOSORT	0x0020	/* Don't sort. */
77 #define	GLOB_NOESCAPE	0x2000	/* Disable backslash escaping. */
78 
79 /* Error values returned by glob(3) */
80 #define	GLOB_NOSPACE	(-1)	/* Malloc call failed. */
81 #define	GLOB_ABORTED	(-2)	/* Unignored error. */
82 #define	GLOB_NOMATCH	(-3)	/* No match and GLOB_NOCHECK was not set. */
83 #define	GLOB_NOSYS	(-4)	/* Obsolete: source comptability only. */
84 #endif /* __POSIX_VISIBLE >= 199209 */
85 
86 #if __BSD_VISIBLE
87 #define	GLOB_ALTDIRFUNC	0x0040	/* Use alternately specified directory funcs. */
88 #define	GLOB_BRACE	0x0080	/* Expand braces ala csh. */
89 #define	GLOB_MAGCHAR	0x0100	/* Pattern had globbing characters. */
90 #define	GLOB_NOMAGIC	0x0200	/* GLOB_NOCHECK without magic chars (csh). */
91 #define	GLOB_QUOTE	0x0400	/* Quote special chars with \. */
92 #define	GLOB_TILDE	0x0800	/* Expand tilde names from the passwd file. */
93 #define	GLOB_LIMIT	0x1000	/* limit number of returned paths */
94 
95 /* source compatibility, these are the old names */
96 #define GLOB_MAXPATH	GLOB_LIMIT
97 #define	GLOB_ABEND	GLOB_ABORTED
98 #endif /* __BSD_VISIBLE */
99 
100 __BEGIN_DECLS
101 int	glob(const char * __restrict, int,
102 	int (*)(const char *, int), glob_t * __restrict);
103 void	globfree(glob_t *);
104 __END_DECLS
105 
106 #endif /* !_GLOB_H_ */
107