1 /* Copyright (C) 1991,92,95-98,2000,2001,2004 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
4 The GNU C Library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Lesser General Public
6 License as published by the Free Software Foundation; either
7 version 2.1 of the License, or (at your option) any later version.
9 The GNU C Library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 Lesser General Public License for more details.
14 You should have received a copy of the GNU Lesser General Public
15 License along with the GNU C Library; if not, write to the Free
16 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
22 /* Note the reversal of the common HAVE_SYS_CDEFS_H idiom below. In this
23 way, #ifndef _SYS_CDEFS_H may be used to include <sys/cdefs.h> both when
24 it has been checked for via the GNULIB configure test and found and when
25 it has not been checked for, which we can presume means that the <glob.h>
26 GNULIB shares with GLIBC is being included as a system header and not as
27 part of GNULIB, in which case <sys/cdefs.h> may be assumed. */
29 # include <sys/cdefs.h>
32 # define __BEGIN_DECLS
41 /* We need `size_t' for the following definitions. */
44 # if defined __GNUC__ && __GNUC__ >= 2
45 typedef __SIZE_TYPE__ __size_t;
47 typedef __SIZE_TYPE__ size_t;
52 # define __size_t size_t
56 /* The GNU CC stddef.h version defines __size_t as empty. We need a real
59 # define __size_t size_t
61 #else /* GLOB_PREFIX */
64 # define __size_t size_t
65 #endif /* !GLOB_PREFIX */
69 # include <sys/stat.h>
71 /* The following are necessary with MSVC and who knows where else. */
73 # define __const const
76 # define __restrict restrict
81 #endif /* GLOB_PREFIX */
83 /* Bits set in the FLAGS argument to `glob'. */
84 #define GLOB_ERR (1 << 0)/* Return on read errors. */
85 #define GLOB_MARK (1 << 1)/* Append a slash to each name. */
86 #define GLOB_NOSORT (1 << 2)/* Don't sort the names. */
87 #define GLOB_DOOFFS (1 << 3)/* Insert PGLOB->gl_offs NULLs. */
88 #define GLOB_NOCHECK (1 << 4)/* If nothing matches, return the pattern. */
89 #define GLOB_APPEND (1 << 5)/* Append to results of a previous call. */
90 #define GLOB_NOESCAPE (1 << 6)/* Backslashes don't quote metacharacters. */
91 #define GLOB_PERIOD (1 << 7)/* Leading `.' can be matched by metachars. */
93 #if !defined __USE_POSIX2 || defined __USE_BSD || defined __USE_GNU
94 # define GLOB_MAGCHAR (1 << 8)/* Set in gl_flags if any metachars seen. */
95 # define GLOB_ALTDIRFUNC (1 << 9)/* Use gl_opendir et al functions. */
96 # define GLOB_BRACE (1 << 10)/* Expand "{a,b}" to "a" "b". */
97 # define GLOB_NOMAGIC (1 << 11)/* If no magic chars, return the pattern. */
98 # define GLOB_TILDE (1 << 12)/* Expand ~user and ~ to home directories. */
99 # define GLOB_ONLYDIR (1 << 13)/* Match only directories. */
100 # define GLOB_TILDE_CHECK (1 << 14)/* Like GLOB_TILDE but return an error
101 if the user name is not available. */
102 # define __GLOB_FLAGS (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
103 GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND| \
104 GLOB_PERIOD|GLOB_ALTDIRFUNC|GLOB_BRACE| \
105 GLOB_NOMAGIC|GLOB_TILDE|GLOB_ONLYDIR|GLOB_TILDE_CHECK)
107 # define __GLOB_FLAGS (GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
108 GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND| \
112 /* Error returns from `glob'. */
113 #define GLOB_NOSPACE 1 /* Ran out of memory. */
114 #define GLOB_ABORTED 2 /* Read error. */
115 #define GLOB_NOMATCH 3 /* No matches found. */
116 #define GLOB_NOSYS 4 /* Not implemented. */
118 /* Previous versions of this file defined GLOB_ABEND instead of
119 GLOB_ABORTED. Provide a compatibility definition here. */
120 # define GLOB_ABEND GLOB_ABORTED
123 /* Structure describing a globbing run. */
129 __size_t gl_pathc; /* Count of paths matched by the pattern. */
130 char **gl_pathv; /* List of matched pathnames. */
131 __size_t gl_offs; /* Slots to reserve in `gl_pathv'. */
132 int gl_flags; /* Set to FLAGS, maybe | GLOB_MAGCHAR. */
134 /* If the GLOB_ALTDIRFUNC flag is set, the following functions
135 are used instead of the normal file access functions. */
136 void (*gl_closedir) (void *);
138 # if defined HAVE_DIRENT_H || defined __GNU_LIBRARY__
139 struct dirent *(*gl_readdir) (void *);
141 struct direct *(*gl_readdir) (void *);
144 void *(*gl_readdir) (void *);
146 void *(*gl_opendir) (__const char *);
148 int (*gl_lstat) (__const char *__restrict, struct stat *__restrict);
149 int (*gl_stat) (__const char *__restrict, struct stat *__restrict);
151 int (*gl_lstat) (__const char *__restrict, void *__restrict);
152 int (*gl_stat) (__const char *__restrict, void *__restrict);
156 #if !defined GLOB_PREFIX && defined __USE_LARGEFILE64
167 /* If the GLOB_ALTDIRFUNC flag is set, the following functions
168 are used instead of the normal file access functions. */
169 void (*gl_closedir) (void *);
171 struct dirent64 *(*gl_readdir) (void *);
173 void *(*gl_readdir) (void *);
175 void *(*gl_opendir) (__const char *);
177 int (*gl_lstat) (__const char *__restrict, struct stat64 *__restrict);
178 int (*gl_stat) (__const char *__restrict, struct stat64 *__restrict);
180 int (*gl_lstat) (__const char *__restrict, void *__restrict);
181 int (*gl_stat) (__const char *__restrict, void *__restrict);
187 # define __GLOB_CONCAT(x, y) x ## y
188 # define __GLOB_XCONCAT(x, y) __GLOB_CONCAT (x, y)
189 # define __GLOB_ID(y) __GLOB_XCONCAT (GLOB_PREFIX, y)
190 # define glob __GLOB_ID (glob)
191 # define globfree __GLOB_ID (globfree)
192 # define glob_pattern_p __GLOB_ID (glob_pattern_p)
194 # if __USE_FILE_OFFSET64 && __GNUC__ < 2
196 # define globfree globfree64
200 /* Do glob searching for PATTERN, placing results in PGLOB.
201 The bits defined above may be set in FLAGS.
202 If a directory cannot be opened or read and ERRFUNC is not nil,
203 it is called with the pathname that caused the error, and the
204 `errno' value from the failing call; if it returns non-zero
205 `glob' returns GLOB_ABEND; if it returns zero, the error is ignored.
206 If memory cannot be allocated for PGLOB, GLOB_NOSPACE is returned.
207 Otherwise, `glob' returns zero. */
208 #if !defined __USE_FILE_OFFSET64 || __GNUC__ < 2 || defined GLOB_PREFIX
209 extern int glob (__const char *__restrict __pattern, int __flags,
210 int (*__errfunc) (__const char *, int),
211 glob_t *__restrict __pglob) __THROW;
213 /* Free storage allocated in PGLOB by a previous `glob' call. */
214 extern void globfree (glob_t *__pglob) __THROW;
216 extern int __REDIRECT_NTH (glob, (__const char *__restrict __pattern,
218 int (*__errfunc) (__const char *, int),
219 glob_t *__restrict __pglob), glob64);
221 extern void __REDIRECT_NTH (globfree, (glob_t *__pglob), globfree64);
224 #if !defined GLOB_PREFIX && defined __USE_LARGEFILE64
225 extern int glob64 (__const char *__restrict __pattern, int __flags,
226 int (*__errfunc) (__const char *, int),
227 glob64_t *__restrict __pglob) __THROW;
229 extern void globfree64 (glob64_t *__pglob) __THROW;
234 /* Return nonzero if PATTERN contains any metacharacters.
235 Metacharacters can be quoted with backslashes if QUOTE is nonzero.
237 This function is not part of the interface specified by POSIX.2
238 but several programs want to use it. */
239 extern int glob_pattern_p (__const char *__pattern, int __quote) __THROW;