glob.h revision 83098
1/*	$NetBSD: glob.h,v 1.13 2001/03/16 21:02:42 christos 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. All advertising materials mentioning features or use of this software
19 *    must display the following acknowledgement:
20 *	This product includes software developed by the University of
21 *	California, Berkeley and its contributors.
22 * 4. Neither the name of the University nor the names of its contributors
23 *    may be used to endorse or promote products derived from this software
24 *    without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * SUCH DAMAGE.
37 *
38 *	@(#)glob.h	8.1 (Berkeley) 6/2/93
39 */
40
41#ifndef _GLOB_H_
42#define	_GLOB_H_
43
44typedef struct {
45	int gl_pathc;		/* Count of total paths so far. */
46	int gl_matchc;		/* Count of paths matching pattern. */
47	int 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) __P((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) __P((void *));
59	struct dirent *(*gl_readdir) __P((void *));
60	void *(*gl_opendir) __P((const char *));
61	int (*gl_lstat) __P((const char *, struct stat *));
62	int (*gl_stat) __P((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	0x1000	/* Disable backslash escaping. */
72
73#define	GLOB_NOSPACE	(-1)	/* Malloc call failed. */
74#define	GLOB_ABORTED	(-2)	/* Unignored error. */
75#define	GLOB_NOMATCH	(-3)	/* No match, and GLOB_NOCHECK was not set. */
76#define	GLOB_NOSYS	(-4)	/* Implementation does not support function. */
77
78#if !defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE)
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_LIMIT	0x0400	/* Limit memory used by matches to ARG_MAX */
84#define	GLOB_TILDE	0x0800	/* Expand tilde names from the passwd file. */
85#define	GLOB_ALTNOT     0x1000	/* use alternate glob character [^ not !] */
86#define	GLOB_QUOTE	0x2000	/* XXX: source compatibility */
87
88#define	GLOB_ABEND	GLOB_ABORTED	/* source compatibility */
89#endif
90
91int	glob __P((const char *, int, int (*)(const char *, int), glob_t *));
92void	globfree __P((glob_t *));
93int	globcharcoll __P((int, int));
94
95#endif /* !_GLOB_H_ */
96