xref: /netbsd-src/include/glob.h (revision de1dfb1250df962f1ff3a011772cf58e605aed11)
1 /*	$NetBSD: glob.h,v 1.18 2004/06/20 22:20:14 jmc Exp $	*/
2 
3 /*
4  * Copyright (c) 1989, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Guido van Rossum.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	@(#)glob.h	8.1 (Berkeley) 6/2/93
35  */
36 
37 #ifndef _GLOB_H_
38 #define	_GLOB_H_
39 
40 #include <sys/cdefs.h>
41 #include <sys/featuretest.h>
42 #include <sys/types.h>
43 #include <sys/stat.h>
44 
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 #ifdef __LIBC12_SOURCE__
63 	int (*gl_lstat) __P((const char *, struct stat12 *));
64 	int (*gl_stat) __P((const char *, struct stat12 *));
65 #else
66 	int (*gl_lstat) __P((const char *, struct stat *));
67 	int (*gl_stat) __P((const char *, struct stat *));
68 #endif
69 } glob_t;
70 
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	0x1000	/* Disable backslash escaping. */
78 
79 #define	GLOB_NOSPACE	(-1)	/* Malloc call failed. */
80 #define	GLOB_ABORTED	(-2)	/* Unignored error. */
81 #define	GLOB_NOMATCH	(-3)	/* No match, and GLOB_NOCHECK was not set. */
82 #define	GLOB_NOSYS	(-4)	/* Implementation does not support function. */
83 
84 #if defined(_NETBSD_SOURCE) || defined(HAVE_NBTOOL_CONFIG_H)
85 #define	GLOB_ALTDIRFUNC	0x0040	/* Use alternately specified directory funcs. */
86 #define	GLOB_BRACE	0x0080	/* Expand braces ala csh. */
87 #define	GLOB_MAGCHAR	0x0100	/* Pattern had globbing characters. */
88 #define	GLOB_NOMAGIC	0x0200	/* GLOB_NOCHECK without magic chars (csh). */
89 #define GLOB_LIMIT	0x0400	/* Limit memory used by matches to ARG_MAX */
90 #define	GLOB_TILDE	0x0800	/* Expand tilde names from the passwd file. */
91 #define	GLOB_QUOTE	0		/* source compatibility */
92 
93 #define	GLOB_ABEND	GLOB_ABORTED	/* source compatibility */
94 #endif
95 
96 __BEGIN_DECLS
97 #ifdef __LIBC12_SOURCE__
98 int	glob __P((const char * __restrict, int,
99 	    int (*)(const char *, int), glob_t * __restrict));
100 void	globfree __P((glob_t *));
101 #else
102 int	glob __P((const char * __restrict, int,
103 	    int (*)(const char *, int), glob_t * __restrict))
104 	__RENAME(__glob13);
105 void	globfree __P((glob_t *)) __RENAME(__globfree13);
106 #endif
107 __END_DECLS
108 
109 #endif /* !_GLOB_H_ */
110