Annotation of src/include/glob.h, Revision 1.12
1.12 ! guenther 1: /* $OpenBSD: glob.h,v 1.11 2010/09/24 13:32:55 djm Exp $ */
1.1 deraadt 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.
1.8 millert 19: * 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 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/cdefs.h>
1.11 djm 42: #include <sys/stat.h>
1.1 deraadt 43:
44: struct stat;
45: typedef struct {
46: int gl_pathc; /* Count of total paths so far. */
47: int gl_matchc; /* Count of paths matching pattern. */
48: int gl_offs; /* Reserved at beginning of gl_pathv. */
49: int gl_flags; /* Copy of flags parameter to glob. */
50: char **gl_pathv; /* List of paths matching pattern. */
1.11 djm 51: struct stat **gl_statv; /* Stat entries corresponding to gl_pathv */
1.1 deraadt 52: /* Copy of errfunc parameter to glob. */
1.6 millert 53: int (*gl_errfunc)(const char *, int);
1.1 deraadt 54:
55: /*
56: * Alternate filesystem access methods for glob; replacement
57: * versions of closedir(3), readdir(3), opendir(3), stat(2)
58: * and lstat(2).
59: */
1.6 millert 60: void (*gl_closedir)(void *);
61: struct dirent *(*gl_readdir)(void *);
62: void *(*gl_opendir)(const char *);
63: int (*gl_lstat)(const char *, struct stat *);
64: int (*gl_stat)(const char *, struct stat *);
1.1 deraadt 65: } glob_t;
66:
67: #define GLOB_APPEND 0x0001 /* Append to output from previous call. */
68: #define GLOB_DOOFFS 0x0002 /* Use gl_offs. */
69: #define GLOB_ERR 0x0004 /* Return on error. */
70: #define GLOB_MARK 0x0008 /* Append / to matching directories. */
71: #define GLOB_NOCHECK 0x0010 /* Return pattern itself if nothing matches. */
72: #define GLOB_NOSORT 0x0020 /* Don't sort. */
1.9 millert 73: #define GLOB_NOESCAPE 0x1000 /* Disable backslash escaping. */
1.1 deraadt 74:
1.10 millert 75: #define GLOB_NOSPACE (-1) /* Malloc call failed. */
76: #define GLOB_ABORTED (-2) /* Unignored error. */
77: #define GLOB_NOMATCH (-3) /* No match and GLOB_NOCHECK not set. */
78: #define GLOB_NOSYS (-4) /* Function not supported. */
79:
80: #if __BSD_VISIBLE
1.1 deraadt 81: #define GLOB_ALTDIRFUNC 0x0040 /* Use alternately specified directory funcs. */
82: #define GLOB_BRACE 0x0080 /* Expand braces ala csh. */
83: #define GLOB_MAGCHAR 0x0100 /* Pattern had globbing characters. */
84: #define GLOB_NOMAGIC 0x0200 /* GLOB_NOCHECK without magic chars (csh). */
85: #define GLOB_QUOTE 0x0400 /* Quote special chars with \. */
86: #define GLOB_TILDE 0x0800 /* Expand tilde names from the passwd file. */
1.5 deraadt 87: #define GLOB_LIMIT 0x2000 /* Limit pattern match output to ARG_MAX */
1.11 djm 88: #define GLOB_KEEPSTAT 0x4000 /* Retain stat data for paths in gl_statv. */
1.10 millert 89: #define GLOB_ABEND GLOB_ABORTED /* backward compatibility */
1.1 deraadt 90: #endif
91:
92: __BEGIN_DECLS
1.12 ! guenther 93: int glob(const char *__restrict, int, int (*)(const char *, int),
! 94: glob_t *__restrict);
1.6 millert 95: void globfree(glob_t *);
1.1 deraadt 96: __END_DECLS
97:
98: #endif /* !_GLOB_H_ */