glob.h revision 1.3
1/*	$OpenBSD: glob.h,v 1.3 1997/09/01 18:44:23 millert Exp $	*/
2/*	$NetBSD: glob.h,v 1.5 1994/10/26 00:55:56 cgd Exp $	*/
3
4/*
5 * Copyright (c) 1989, 1993
6 *	The Regents of the University of California.  All rights reserved.
7 *
8 * This code is derived from software contributed to Berkeley by
9 * Guido van Rossum.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 *    notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 *    notice, this list of conditions and the following disclaimer in the
18 *    documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 *    must display the following acknowledgement:
21 *	This product includes software developed by the University of
22 *	California, Berkeley and its contributors.
23 * 4. Neither the name of the University nor the names of its contributors
24 *    may be used to endorse or promote products derived from this software
25 *    without specific prior written permission.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * SUCH DAMAGE.
38 *
39 *	@(#)glob.h	8.1 (Berkeley) 6/2/93
40 */
41
42#ifndef _GLOB_H_
43#define	_GLOB_H_
44
45#include <sys/cdefs.h>
46
47struct stat;
48typedef struct {
49	int gl_pathc;		/* Count of total paths so far. */
50	int gl_matchc;		/* Count of paths matching pattern. */
51	int 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) __P((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) __P((void *));
63	struct dirent *(*gl_readdir) __P((void *));
64	void *(*gl_opendir) __P((const char *));
65	int (*gl_lstat) __P((const char *, struct stat *));
66	int (*gl_stat) __P((const char *, struct stat *));
67} glob_t;
68
69/* Flags */
70#define	GLOB_APPEND	0x0001	/* Append to output from previous call. */
71#define	GLOB_DOOFFS	0x0002	/* Use gl_offs. */
72#define	GLOB_ERR	0x0004	/* Return on error. */
73#define	GLOB_MARK	0x0008	/* Append / to matching directories. */
74#define	GLOB_NOCHECK	0x0010	/* Return pattern itself if nothing matches. */
75#define	GLOB_NOSORT	0x0020	/* Don't sort. */
76
77#ifndef _POSIX_SOURCE
78#define	GLOB_ALTDIRFUNC	0x0040	/* Use alternately specified directory funcs. */
79#define	GLOB_BRACE	0x0080	/* Expand braces ala csh. */
80#define	GLOB_MAGCHAR	0x0100	/* Pattern had globbing characters. */
81#define	GLOB_NOMAGIC	0x0200	/* GLOB_NOCHECK without magic chars (csh). */
82#define	GLOB_QUOTE	0x0400	/* Quote special chars with \. */
83#define	GLOB_TILDE	0x0800	/* Expand tilde names from the passwd file. */
84#endif
85
86/* Error values returned by glob(3) */
87#define	GLOB_NOSPACE	(-1)	/* Malloc call failed. */
88#define	GLOB_ABORTED	(-2)	/* Unignored error. */
89#define	GLOB_NOMATCH	(-3)	/* No match and GLOB_NOCHECK not set. */
90#define	GLOB_NOSYS	(-4)	/* Function not supported. */
91#define GLOB_ABEND	GLOB_ABORTED
92
93__BEGIN_DECLS
94int	glob __P((const char *, int, int (*)(const char *, int), glob_t *));
95void	globfree __P((glob_t *));
96__END_DECLS
97
98#endif /* !_GLOB_H_ */
99