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