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. All advertising materials mentioning features or use of this software
17 *    must display the following acknowledgement:
18 *	This product includes software developed by the University of
19 *	California, Berkeley and its contributors.
20 * 4. 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 * $FreeBSD: /repoman/r/ncvs/src/include/glob.h,v 1.7 2002/07/17 04:58:09 mikeh Exp $
38 */
39
40#ifndef _GLOB_H_
41#define	_GLOB_H_
42
43#include <_types.h>
44#include <sys/cdefs.h>
45#include <Availability.h>
46#include <sys/_types/_size_t.h>
47
48#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
49struct dirent;
50struct stat;
51#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
52typedef struct {
53	size_t gl_pathc;	/* Count of total paths so far. */
54	int gl_matchc;		/* Count of paths matching pattern. */
55	size_t gl_offs;		/* Reserved at beginning of gl_pathv. */
56	int gl_flags;		/* Copy of flags parameter to glob. */
57	char **gl_pathv;	/* List of paths matching pattern. */
58				/* Copy of errfunc parameter to glob. */
59#ifdef __BLOCKS__
60	union {
61#endif /* __BLOCKS__ */
62		int (*gl_errfunc)(const char *, int);
63#ifdef __BLOCKS__
64		int (^gl_errblk)(const char *, int);
65	};
66#endif /* __BLOCKS__ */
67
68	/*
69	 * Alternate filesystem access methods for glob; replacement
70	 * versions of closedir(3), readdir(3), opendir(3), stat(2)
71	 * and lstat(2).
72	 */
73	void (*gl_closedir)(void *);
74#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
75	struct dirent *(*gl_readdir)(void *);
76#else /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
77	void *(*gl_readdir)(void *);
78#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
79	void *(*gl_opendir)(const char *);
80#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
81	int (*gl_lstat)(const char *, struct stat *);
82	int (*gl_stat)(const char *, struct stat *);
83#else /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
84	int (*gl_lstat)(const char *, void *);
85	int (*gl_stat)(const char *, void *);
86#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
87} glob_t;
88
89/* Believed to have been introduced in 1003.2-1992 */
90#define	GLOB_APPEND	0x0001	/* Append to output from previous call. */
91#define	GLOB_DOOFFS	0x0002	/* Use gl_offs. */
92#define	GLOB_ERR	0x0004	/* Return on error. */
93#define	GLOB_MARK	0x0008	/* Append / to matching directories. */
94#define	GLOB_NOCHECK	0x0010	/* Return pattern itself if nothing matches. */
95#define	GLOB_NOSORT	0x0020	/* Don't sort. */
96#define	GLOB_NOESCAPE	0x2000	/* Disable backslash escaping. */
97
98/* Error values returned by glob(3) */
99#define	GLOB_NOSPACE	(-1)	/* Malloc call failed. */
100#define	GLOB_ABORTED	(-2)	/* Unignored error. */
101#define	GLOB_NOMATCH	(-3)	/* No match and GLOB_NOCHECK was not set. */
102#define	GLOB_NOSYS	(-4)	/* Obsolete: source comptability only. */
103
104#define	GLOB_ALTDIRFUNC	0x0040	/* Use alternately specified directory funcs. */
105#define	GLOB_BRACE	0x0080	/* Expand braces ala csh. */
106#define	GLOB_MAGCHAR	0x0100	/* Pattern had globbing characters. */
107#define	GLOB_NOMAGIC	0x0200	/* GLOB_NOCHECK without magic chars (csh). */
108#define	GLOB_QUOTE	0x0400	/* Quote special chars with \. */
109#define	GLOB_TILDE	0x0800	/* Expand tilde names from the passwd file. */
110#define	GLOB_LIMIT	0x1000	/* limit number of returned paths */
111#ifdef __BLOCKS__
112#define	_GLOB_ERR_BLOCK	0x80000000 /* (internal) error callback is a block */
113#endif /* __BLOCKS__ */
114
115/* source compatibility, these are the old names */
116#define GLOB_MAXPATH	GLOB_LIMIT
117#define	GLOB_ABEND	GLOB_ABORTED
118
119__BEGIN_DECLS
120//Begin-Libc
121#ifndef LIBC_ALIAS_GLOB
122//End-Libc
123int	glob(const char * __restrict, int, int (*)(const char *, int),
124	     glob_t * __restrict) __DARWIN_INODE64(glob);
125//Begin-Libc
126#else /* LIBC_ALIAS_GLOB */
127int	glob(const char * __restrict, int, int (*)(const char *, int),
128	     glob_t * __restrict) LIBC_INODE64(glob);
129#endif /* !LIBC_ALIAS_GLOB */
130//End-Libc
131#ifdef __BLOCKS__
132//Begin-Libc
133#ifndef LIBC_ALIAS_GLOB_B
134//End-Libc
135int	glob_b(const char * __restrict, int, int (^)(const char *, int),
136	     glob_t * __restrict) __DARWIN_INODE64(glob_b) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
137//Begin-Libc
138#else /* LIBC_ALIAS_GLOB_B */
139int	glob_b(const char * __restrict, int, int (^)(const char *, int),
140	     glob_t * __restrict) LIBC_INODE64(glob_b);
141#endif /* !LIBC_ALIAS_GLOB_B */
142//End-Libc
143#endif /* __BLOCKS__ */
144void	globfree(glob_t *);
145__END_DECLS
146
147#endif /* !_GLOB_H_ */
148