xref: /haiku/headers/posix/glob.h (revision 68d37cfb3a755a7270d772b505ee15c8b18aa5e0)
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. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 #ifndef _GLOB_H_
34 #define	_GLOB_H_
35 
36 #include <sys/cdefs.h>
37 #include <sys/types.h>
38 
39 struct stat;
40 typedef struct {
41 	size_t gl_pathc;	/* Count of total paths so far. */
42 	size_t gl_matchc;	/* Count of paths matching pattern. */
43 	size_t gl_offs;		/* Reserved at beginning of gl_pathv. */
44 	int gl_flags;		/* Copy of flags parameter to glob. */
45 	char **gl_pathv;	/* List of paths matching pattern. */
46 						/* Copy of errfunc parameter to glob. */
47 	int (*gl_errfunc)(const char *, int);
48 
49 	/*
50 	 * Alternate filesystem access methods for glob; replacement
51 	 * versions of closedir(3), readdir(3), opendir(3), stat(2)
52 	 * and lstat(2).
53 	 */
54 	void (*gl_closedir)(void *);
55 	struct dirent *(*gl_readdir)(void *);
56 	void *(*gl_opendir)(const char *);
57 	int (*gl_lstat)(const char *, struct stat *);
58 	int (*gl_stat)(const char *, struct stat *);
59 } glob_t;
60 
61 #define	GLOB_APPEND		0x0001	/* Append to output from previous call. */
62 #define	GLOB_DOOFFS		0x0002	/* Use gl_offs. */
63 #define	GLOB_ERR		0x0004	/* Return on error. */
64 #define	GLOB_MARK		0x0008	/* Append / to matching directories. */
65 #define	GLOB_NOCHECK	0x0010	/* Return pattern itself if nothing matches. */
66 #define	GLOB_NOSORT		0x0020	/* Don't sort. */
67 #define	GLOB_NOESCAPE	0x2000	/* Disable backslash escaping. */
68 
69 /* Error values returned by glob(3) */
70 #define	GLOB_NOSPACE	(-1)	/* Malloc call failed. */
71 #define	GLOB_ABORTED	(-2)	/* Unignored error. */
72 #define	GLOB_NOMATCH	(-3)	/* No match and GLOB_NOCHECK was not set. */
73 #define	GLOB_NOSYS		(-4)	/* Obsolete: source comptability only. */
74 
75 #define	GLOB_ALTDIRFUNC	0x0040	/* Use alternately specified directory funcs. */
76 #define	GLOB_BRACE		0x0080	/* Expand braces ala csh. */
77 #define	GLOB_MAGCHAR	0x0100	/* Pattern had globbing characters. */
78 #define	GLOB_NOMAGIC	0x0200	/* GLOB_NOCHECK without magic chars (csh). */
79 #define	GLOB_QUOTE		0x0400	/* Quote special chars with \. */
80 #define	GLOB_TILDE		0x0800	/* Expand tilde names from the passwd file. */
81 #define	GLOB_LIMIT		0x1000	/* limit number of returned paths */
82 
83 /* source compatibility, these are the old names */
84 #define GLOB_MAXPATH	GLOB_LIMIT
85 #define	GLOB_ABEND		GLOB_ABORTED
86 
87 __BEGIN_DECLS
88 int	glob(const char *, int, int (*)(const char *, int), glob_t *);
89 void	globfree(glob_t *);
90 __END_DECLS
91 
92 #endif /* !_GLOB_H_ */
93