1/* $OpenBSD: glob.h,v 1.14 2019/02/04 16:45:40 millert Exp $ */
2/* $NetBSD: glob.h,v 1.5 1994/10/26 00:55:56 cgd Exp $ */
3
4/*
5 * Copyright (c) 1989, 1993
6 * The Regents of the University of California. All rights reserved.
7 *
8 * This code is derived from software contributed to Berkeley by
9 * Guido van Rossum.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
34 *
35 * @(#)glob.h 8.1 (Berkeley) 6/2/93
36 */
37
38#ifndef _GLOB_H_
39#define _GLOB_H_
40
41#include <sys/stat.h>
42#include <machine/_types.h>
43
44#ifndef _SIZE_T_DEFINED_
45#define _SIZE_T_DEFINED_
46typedef __size_t size_t;
47#endif
48
49struct stat;
50typedef struct {
51 size_t gl_pathc; /* Count of total paths so far. */
52 size_t gl_matchc; /* Count of paths matching pattern. */
53 size_t gl_offs; /* Reserved at beginning of gl_pathv. */
54 int gl_flags; /* Copy of flags parameter to glob. */
55 char **gl_pathv; /* List of paths matching pattern. */
56 struct stat **gl_statv; /* Stat entries corresponding to gl_pathv */
57 /* Copy of errfunc parameter to glob. */
58 int (*gl_errfunc)(const char *, int);
59
60 /*
61 * Alternate filesystem access methods for glob; replacement
62 * versions of closedir(3), readdir(3), opendir(3), stat(2)
63 * and lstat(2).
64 */
65 void (*gl_closedir)(void *);
66 struct dirent *(*gl_readdir)(void *);
67 void *(*gl_opendir)(const char *);
68 int (*gl_lstat)(const char *, struct stat *);
69 int (*gl_stat)(const char *, struct stat *);
70} glob_t;
71
72#define GLOB_APPEND 0x0001 /* Append to output from previous call. */
73#define GLOB_DOOFFS 0x0002 /* Use gl_offs. */
74#define GLOB_ERR 0x0004 /* Return on error. */
75#define GLOB_MARK 0x0008 /* Append / to matching directories. */
76#define GLOB_NOCHECK 0x0010 /* Return pattern itself if nothing matches. */
77#define GLOB_NOSORT 0x0020 /* Don't sort. */
78#define GLOB_NOESCAPE 0x1000 /* Disable backslash escaping. */
79
80#define GLOB_NOSPACE (-1) /* Malloc call failed. */
81#define GLOB_ABORTED (-2) /* Unignored error. */
82#define GLOB_NOMATCH (-3) /* No match and GLOB_NOCHECK not set. */
83#define GLOB_NOSYS (-4) /* Function not supported. */
84
85#if __BSD_VISIBLE
86#define GLOB_ALTDIRFUNC 0x0040 /* Use alternately specified directory funcs. */
87#define GLOB_BRACE 0x0080 /* Expand braces ala csh. */
88#define GLOB_MAGCHAR 0x0100 /* Pattern had globbing characters. */
89#define GLOB_NOMAGIC 0x0200 /* GLOB_NOCHECK without magic chars (csh). */
90#define GLOB_QUOTE 0x0400 /* Quote special chars with \. */
91#define GLOB_TILDE 0x0800 /* Expand tilde names from the passwd file. */
92#define GLOB_LIMIT 0x2000 /* Limit pattern match output to ARG_MAX */
93#define GLOB_KEEPSTAT 0x4000 /* Retain stat data for paths in gl_statv. */
94#define GLOB_ABEND GLOB_ABORTED /* backward compatibility */
95#endif
96
97__BEGIN_DECLS
98int glob(const char *__restrict, int, int (*)(const char *, int),
99 glob_t *__restrict);
100void globfree(glob_t *);
101__END_DECLS
102
103#endif /* !_GLOB_H_ */