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 *	@(#)glob.h	8.1 (Berkeley) 6/2/93
 35 */
 36
 37#ifndef _GLOB_H_
 38#define	_GLOB_H_
 39
 40#include <sys/cdefs.h>
 41#include <sys/_types.h>
 42
 43#ifndef	_SIZE_T_DECLARED
 44typedef	__size_t	size_t;
 45#define	_SIZE_T_DECLARED
 46#endif
 47
 48struct stat;
 49typedef struct {
 50	size_t gl_pathc;	/* Count of total paths so far. */
 51	size_t gl_matchc;	/* Count of paths matching pattern. */
 52	size_t gl_offs;		/* Reserved at beginning of gl_pathv. */
 53	int gl_flags;		/* Copy of flags parameter to glob. */
 54	char **gl_pathv;	/* List of paths matching pattern. */
 55				/* Copy of errfunc parameter to glob. */
 56	int (*gl_errfunc)(const char *, int);
 57
 58	/*
 59	 * Alternate filesystem access methods for glob; replacement
 60	 * versions of closedir(3), readdir(3), opendir(3), stat(2)
 61	 * and lstat(2).
 62	 */
 63	void (*gl_closedir)(void *);
 64	struct dirent *(*gl_readdir)(void *);
 65	void *(*gl_opendir)(const char *);
 66	int (*gl_lstat)(const char *, struct stat *);
 67	int (*gl_stat)(const char *, struct stat *);
 68} glob_t;
 69
 70#if __POSIX_VISIBLE >= 199209
 71/* Believed to have been introduced in 1003.2-1992 */
 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	0x2000	/* Disable backslash escaping. */
 79
 80/* Error values returned by glob(3) */
 81#define	GLOB_NOSPACE	(-1)	/* Malloc call failed. */
 82#define	GLOB_ABORTED	(-2)	/* Unignored error. */
 83#define	GLOB_NOMATCH	(-3)	/* No match and GLOB_NOCHECK was not set. */
 84#define	GLOB_NOSYS	(-4)	/* Obsolete: source comptability only. */
 85#endif /* __POSIX_VISIBLE >= 199209 */
 86
 87#if __BSD_VISIBLE
 88#define	GLOB_ALTDIRFUNC	0x0040	/* Use alternately specified directory funcs. */
 89#define	GLOB_BRACE	0x0080	/* Expand braces ala csh. */
 90#define	GLOB_MAGCHAR	0x0100	/* Pattern had globbing characters. */
 91#define	GLOB_NOMAGIC	0x0200	/* GLOB_NOCHECK without magic chars (csh). */
 92#define	GLOB_QUOTE	0x0400	/* Quote special chars with \. */
 93#define	GLOB_TILDE	0x0800	/* Expand tilde names from the passwd file. */
 94#define	GLOB_LIMIT	0x1000	/* limit number of returned paths */
 95
 96/* source compatibility, these are the old names */
 97#define GLOB_MAXPATH	GLOB_LIMIT
 98#define	GLOB_ABEND	GLOB_ABORTED
 99#endif /* __BSD_VISIBLE */
100
101__BEGIN_DECLS
102int	glob(const char * __restrict, int,
103	int (*)(const char *, int), glob_t * __restrict);
104void	globfree(glob_t *);
105__END_DECLS
106
107#endif /* !_GLOB_H_ */