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  *	@(#)glob.h	8.1 (Berkeley) 6/2/93
33  * $FreeBSD$
34  */
35 
36 #ifndef _GLOB_H_
37 #define _GLOB_H_
38 
39 #include <sys/cdefs.h>
40 #include <sys/types.h>
41 
42 struct dirent;
43 struct stat;
44 
45 typedef struct {
46   size_t gl_pathc;	/* Count of total paths so far. */
47   size_t gl_matchc;	/* Count of paths matching pattern. */
48   size_t gl_offs;		/* Reserved at beginning of gl_pathv. */
49   int gl_flags;		/* Copy of flags parameter to glob. */
50   char** gl_pathv;	/* List of paths matching pattern. */
51 
52   /* Copy of `__error_callback` parameter to glob. */
53   int (*gl_errfunc)(const char* __failure_path, int __failure_errno);
54 
55   /*
56    * Alternate filesystem access methods for glob; replacement
57    * versions of closedir(3), readdir(3), opendir(3), stat(2)
58    * and lstat(2).
59    */
60   void (*gl_closedir)(void*);
61   struct dirent* (*gl_readdir)(void*);
62   void* (*gl_opendir)(const char*);
63   int (*gl_lstat)(const char*, struct stat*);
64   int (*gl_stat)(const char*, struct stat*);
65 } glob_t;
66 
67 /* Believed to have been introduced in 1003.2-1992 */
68 #define GLOB_APPEND	0x0001	/* Append to output from previous call. */
69 #define GLOB_DOOFFS	0x0002	/* Prepend `gl_offs` null pointers (leaving space for exec, say). */
70 #define GLOB_ERR	0x0004	/* Return on error. */
71 #define GLOB_MARK	0x0008	/* Append "/" to the names of returned directories. */
72 #define GLOB_NOCHECK	0x0010	/* Return pattern itself if nothing matches. */
73 #define GLOB_NOSORT	0x0020	/* Don't sort. */
74 #define GLOB_NOESCAPE	0x2000	/* Disable backslash escaping. */
75 
76 /* Error values returned by glob(3) */
77 #define GLOB_NOSPACE	(-1)	/* Malloc call failed. */
78 #define GLOB_ABORTED	(-2)	/* Unignored error. */
79 #define GLOB_NOMATCH	(-3)	/* No match and GLOB_NOCHECK was not set. */
80 
81 #if __USE_BSD
82 #define GLOB_ALTDIRFUNC	0x0040	/* Use alternately specified directory funcs. */
83 #define GLOB_BRACE	0x0080	/* Expand braces like csh. */
84 #define GLOB_MAGCHAR	0x0100	/* Set in `gl_flags` if the 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	0x1000	/* limit number of returned paths */
89 #endif
90 
91 __BEGIN_DECLS
92 
93 int glob(const char* __pattern, int __flags, int (*__error_callback)(const char* __failure_path, int __failure_errno), glob_t* __result_ptr) __INTRODUCED_IN(28);
94 void globfree(glob_t* __result_ptr) __INTRODUCED_IN(28);
95 
96 __END_DECLS
97 
98 #endif
99