1 /**	$MirOS: src/include/glob.h,v 1.4 2010/10/16 18:41:33 tg Exp $ */
2 /*	$OpenBSD: glob.h,v 1.11 2010/09/24 13:32:55 djm Exp $	*/
3 /*	$NetBSD: glob.h,v 1.5 1994/10/26 00:55:56 cgd Exp $	*/
4 
5 /*
6  * Copyright (c) 1989, 1993
7  *	The Regents of the University of California.  All rights reserved.
8  *
9  * This code is derived from software contributed to Berkeley by
10  * Guido van Rossum.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. 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  *	@(#)glob.h	8.1 (Berkeley) 6/2/93
37  */
38 
39 #ifndef _GLOB_H_
40 #define	_GLOB_H_
41 
42 #include <sys/cdefs.h>
43 #include <sys/stat.h>
44 
45 struct stat;
46 typedef struct {
47 	int gl_pathc;		/* Count of total paths so far. */
48 	int gl_matchc;		/* Count of paths matching pattern. */
49 	int gl_offs;		/* Reserved at beginning of gl_pathv. */
50 	int gl_flags;		/* Copy of flags parameter to glob. */
51 	char **gl_pathv;	/* List of paths matching pattern. */
52 	struct stat **gl_statv;	/* Stat entries corresponding to gl_pathv */
53 				/* Copy of errfunc parameter to glob. */
54 	int (*gl_errfunc)(const char *, int);
55 
56 	/*
57 	 * Alternate filesystem access methods for glob; replacement
58 	 * versions of closedir(3), readdir(3), opendir(3), stat(2)
59 	 * and lstat(2).
60 	 */
61 	void (*gl_closedir)(void *);
62 	struct dirent *(*gl_readdir)(void *);
63 	void *(*gl_opendir)(const char *);
64 	int (*gl_lstat)(const char *, struct stat *);
65 	int (*gl_stat)(const char *, struct stat *);
66 } glob_t;
67 
68 #define	GLOB_APPEND	0x0001	/* Append to output from previous call. */
69 #define	GLOB_DOOFFS	0x0002	/* Use gl_offs. */
70 #define	GLOB_ERR	0x0004	/* Return on error. */
71 #define	GLOB_MARK	0x0008	/* Append / to matching directories. */
72 #define	GLOB_NOCHECK	0x0010	/* Return pattern itself if nothing matches. */
73 #define	GLOB_NOSORT	0x0020	/* Don't sort. */
74 #define	GLOB_NOESCAPE	0x1000	/* Disable backslash escaping. */
75 
76 #define	GLOB_NOSPACE	(-1)	/* Malloc call failed. */
77 #define	GLOB_ABORTED	(-2)	/* Unignored error. */
78 #define	GLOB_NOMATCH	(-3)	/* No match and GLOB_NOCHECK not set. */
79 #define	GLOB_NOSYS	(-4)	/* Function not supported. */
80 
81 #if __BSD_VISIBLE
82 #define	GLOB_ALTDIRFUNC	0x0040	/* Use alternately specified directory funcs. */
83 #define	GLOB_BRACE	0x0080	/* Expand braces ala csh. */
84 #define	GLOB_MAGCHAR	0x0100	/* Pattern had globbing characters. */
85 #define	GLOB_NOMAGIC	0x0200	/* GLOB_NOCHECK without magic chars (csh). */
86 #define	GLOB_QUOTE	0x0400	/* Quote special chars with \. */
87 #define	GLOB_TILDE	0x0800	/* Expand tilde names from the passwd file. */
88 #define GLOB_LIMIT	0x2000	/* Limit pattern match output to ARG_MAX */
89 #define	GLOB_KEEPSTAT	0x4000	/* Retain stat data for paths in gl_statv. */
90 #define	GLOB_PERIOD	0x10000	/* Allow metachars to match leading periods. */
91 #define	GLOB_NO_DOTDIRS	0x20000	/* Make . and .. vanish from wildcards. */
92 #define GLOB_ABEND	GLOB_ABORTED /* backward compatibility */
93 #endif
94 
95 __BEGIN_DECLS
96 int	glob(const char *, int, int (*)(const char *, int), glob_t *);
97 void	globfree(glob_t *);
98 __END_DECLS
99 
100 #if __BSD_VISIBLE
101 __BEGIN_DECLS
102 int	glob_pattern_p(const char *, int);
103 __END_DECLS
104 #endif
105 
106 #endif /* !_GLOB_H_ */
107