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