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
37#ifndef _GLOB_H_
38#define	_GLOB_H_
39
40#include <sys/cdefs.h>
41#include <sys/types.h>
42
43struct stat;
44typedef struct {
45	size_t gl_pathc;	/* Count of total paths so far. */
46	size_t gl_matchc;	/* Count of paths matching pattern. */
47	size_t gl_offs;		/* Reserved at beginning of gl_pathv. */
48	int gl_flags;		/* Copy of flags parameter to glob. */
49	char **gl_pathv;	/* List of paths matching pattern. */
50						/* Copy of errfunc parameter to glob. */
51	int (*gl_errfunc)(const char *, int);
52
53	/*
54	 * Alternate filesystem access methods for glob; replacement
55	 * versions of closedir(3), readdir(3), opendir(3), stat(2)
56	 * and lstat(2).
57	 */
58	void (*gl_closedir)(void *);
59	struct dirent *(*gl_readdir)(void *);
60	void *(*gl_opendir)(const char *);
61	int (*gl_lstat)(const char *, struct stat *);
62	int (*gl_stat)(const char *, struct stat *);
63} glob_t;
64
65#define	GLOB_APPEND		0x0001	/* Append to output from previous call. */
66#define	GLOB_DOOFFS		0x0002	/* Use gl_offs. */
67#define	GLOB_ERR		0x0004	/* Return on error. */
68#define	GLOB_MARK		0x0008	/* Append / to matching directories. */
69#define	GLOB_NOCHECK	0x0010	/* Return pattern itself if nothing matches. */
70#define	GLOB_NOSORT		0x0020	/* Don't sort. */
71#define	GLOB_NOESCAPE	0x2000	/* Disable backslash escaping. */
72
73/* Error values returned by glob(3) */
74#define	GLOB_NOSPACE	(-1)	/* Malloc call failed. */
75#define	GLOB_ABORTED	(-2)	/* Unignored error. */
76#define	GLOB_NOMATCH	(-3)	/* No match and GLOB_NOCHECK was not set. */
77#define	GLOB_NOSYS		(-4)	/* Obsolete: source comptability only. */
78
79#define	GLOB_ALTDIRFUNC	0x0040	/* Use alternately specified directory funcs. */
80#define	GLOB_BRACE		0x0080	/* Expand braces ala csh. */
81#define	GLOB_MAGCHAR	0x0100	/* Pattern had globbing characters. */
82#define	GLOB_NOMAGIC	0x0200	/* GLOB_NOCHECK without magic chars (csh). */
83#define	GLOB_QUOTE		0x0400	/* Quote special chars with \. */
84#define	GLOB_TILDE		0x0800	/* Expand tilde names from the passwd file. */
85#define	GLOB_LIMIT		0x1000	/* limit number of returned paths */
86
87/* source compatibility, these are the old names */
88#define GLOB_MAXPATH	GLOB_LIMIT
89#define	GLOB_ABEND		GLOB_ABORTED
90
91__BEGIN_DECLS
92int	glob(const char *, int, int (*)(const char *, int), glob_t *);
93void	globfree(glob_t *);
94__END_DECLS
95
96#endif /* !_GLOB_H_ */
97