1 /* Copyright (C) 1991,92,95,96,97,98,2000,2001 Free Software Foundation, Inc.
2 
3    The GNU C Library is free software; you can redistribute it and/or
4    modify it under the terms of the GNU Library General Public License as
5    published by the Free Software Foundation; either version 2 of the
6    License, or (at your option) any later version.
7 
8    The GNU C Library is distributed in the hope that it will be useful,
9    but WITHOUT ANY WARRANTY; without even the implied warranty of
10    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11    Library General Public License for more details.
12 
13    You should have received a copy of the GNU Library General Public
14    License along with the GNU C Library; see the file COPYING.LIB.  If not,
15    write to the Free Software Foundation, Inc., 51 Franklin Street, Suite 500,
16    Boston, MA 02110-1335, USA.  */
17 
18 #ifndef	_GLOB_H
19 #define	_GLOB_H	1
20 
21 #ifdef	__cplusplus
22 extern "C" {
23 #endif
24 
25 #undef	__ptr_t
26 #if defined __cplusplus || (defined __STDC__ && __STDC__) || defined WINDOWS32
27 # if !defined __GLIBC__ || !defined __P
28 #  undef __P
29 #  undef __PMT
30 #  define __P(protos)	protos
31 #  define __PMT(protos)	protos
32 #  if !defined __GNUC__ || __GNUC__ < 2
33 #   undef __const
34 #   define __const const
35 #  endif
36 # endif
37 # define __ptr_t	void *
38 #else /* Not C++ or ANSI C.  */
39 # undef	__P
40 # undef __PMT
41 # define __P(protos)	()
42 # define __PMT(protos)	()
43 # undef	__const
44 # define __const
45 # define __ptr_t	char *
46 #endif /* C++ or ANSI C.  */
47 
48 #if ! defined(__PMT) && defined(__P)
49 # define __PMT(x) __P(x)
50 #endif
51 
52 /* Bits set in the FLAGS argument to `glob'.  */
53 #define	GLOB_ERR	(1 << 0)/* Return on read errors.  */
54 #define	GLOB_MARK	(1 << 1)/* Append a slash to each name.  */
55 #define	GLOB_NOSORT	(1 << 2)/* Don't sort the names.  */
56 #define	GLOB_DOOFFS	(1 << 3)/* Insert PGLOB->gl_offs NULLs.  */
57 #define	GLOB_NOCHECK	(1 << 4)/* If nothing matches, return the pattern.  */
58 #define	GLOB_APPEND	(1 << 5)/* Append to results of a previous call.  */
59 #define	GLOB_NOESCAPE	(1 << 6)/* Backslashes don't quote metacharacters.  */
60 #define	GLOB_PERIOD	(1 << 7)/* Leading `.' can be matched by metachars.  */
61 
62 #if (!defined _POSIX_C_SOURCE || _POSIX_C_SOURCE < 2 \
63      || _POSIX_C_SOURCE == 199506L || defined _BSD_SOURCE \
64      || defined _GNU_SOURCE)
65 # define GLOB_MAGCHAR	 (1 << 8)/* Set in gl_flags if any metachars seen.  */
66 # define GLOB_ALTDIRFUNC (1 << 9)/* Use gl_opendir et al functions.  */
67 # define GLOB_BRACE	 (1 << 10)/* Expand "{a,b}" to "a" "b".  */
68 # define GLOB_NOMAGIC	 (1 << 11)/* If no magic chars, return the pattern.  */
69 # define GLOB_TILDE	 (1 << 12)/* Expand ~user and ~ to home directories. */
70 # define GLOB_ONLYDIR	 (1 << 13)/* Match only directories.  */
71 # define GLOB_TILDE_CHECK (1 << 14)/* Like GLOB_TILDE but return an error
72 				      if the user name is not available.  */
73 # define __GLOB_FLAGS	(GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
74 			 GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND|     \
75 			 GLOB_PERIOD|GLOB_ALTDIRFUNC|GLOB_BRACE|     \
76 			 GLOB_NOMAGIC|GLOB_TILDE|GLOB_ONLYDIR|GLOB_TILDE_CHECK)
77 #else
78 # define __GLOB_FLAGS	(GLOB_ERR|GLOB_MARK|GLOB_NOSORT|GLOB_DOOFFS| \
79 			 GLOB_NOESCAPE|GLOB_NOCHECK|GLOB_APPEND|     \
80 			 GLOB_PERIOD)
81 #endif
82 
83 /* Error returns from `glob'.  */
84 #define	GLOB_NOSPACE	1	/* Ran out of memory.  */
85 #define	GLOB_ABORTED	2	/* Read error.  */
86 #define	GLOB_NOMATCH	3	/* No matches found.  */
87 #define GLOB_NOSYS	4	/* Not implemented.  */
88 #ifdef _GNU_SOURCE
89 /* Previous versions of this file defined GLOB_ABEND instead of
90    GLOB_ABORTED.  Provide a compatibility definition here.  */
91 # define GLOB_ABEND GLOB_ABORTED
92 #endif
93 
94 /* Structure describing a globbing run.  */
95 #if !defined _AMIGA && !defined VMS /* Buggy compiler.   */
96 # ifdef _GNU_SOURCE
97 struct stat;
98 # endif
99 #endif
100 typedef struct
101   {
102     size_t gl_pathc;		/* Count of paths matched by the pattern.  */
103     char **gl_pathv;		/* List of matched pathnames.  */
104     size_t gl_offs;		/* Slots to reserve in `gl_pathv'.  */
105     int gl_flags;		/* Set to FLAGS, maybe | GLOB_MAGCHAR.  */
106 
107     /* If the GLOB_ALTDIRFUNC flag is set, the following functions
108        are used instead of the normal file access functions.  */
109     void (*gl_closedir) __PMT ((void *));
110 #ifdef _GNU_SOURCE
111     struct dirent *(*gl_readdir) __PMT ((void *));
112 #else
113     void *(*gl_readdir) __PMT ((void *));
114 #endif
115     __ptr_t (*gl_opendir) __PMT ((__const char *));
116 #ifdef _GNU_SOURCE
117     int (*gl_lstat) __PMT ((__const char *,
118 			    struct stat *));
119     int (*gl_stat) __PMT ((__const char *, struct stat *));
120 #else
121     int (*gl_lstat) __PMT ((__const char *, void *));
122     int (*gl_stat) __PMT ((__const char *, void *));
123 #endif
124   } glob_t;
125 
126 #ifdef _LARGEFILE64_SOURCE
127 # ifdef _GNU_SOURCE
128 struct stat64;
129 # endif
130 typedef struct
131   {
132     size_t gl_pathc;
133     char **gl_pathv;
134     size_t gl_offs;
135     int gl_flags;
136 
137     /* If the GLOB_ALTDIRFUNC flag is set, the following functions
138        are used instead of the normal file access functions.  */
139     void (*gl_closedir) __PMT ((void *));
140 # ifdef _GNU_SOURCE
141     struct dirent64 *(*gl_readdir) __PMT ((void *));
142 # else
143     void *(*gl_readdir) __PMT ((void *));
144 # endif
145     __ptr_t (*gl_opendir) __PMT ((__const char *));
146 # ifdef _GNU_SOURCE
147     int (*gl_lstat) __PMT ((__const char *,
148 			    struct stat64 *));
149     int (*gl_stat) __PMT ((__const char *,
150 			   struct stat64 *));
151 # else
152     int (*gl_lstat) __PMT ((__const char *, void *));
153     int (*gl_stat) __PMT ((__const char *, void *));
154 # endif
155   } glob64_t;
156 #endif
157 
158 #if (defined(_FILE_OFFSET_BITS) && _FILE_OFFSET_BITS == 64) && \
159   (defined(__GNUC__) && __GNUC__ < 2)
160 # define glob glob64
161 # define globfree globfree64
162 #endif
163 
164 /* Do glob searching for PATTERN, placing results in PGLOB.
165    The bits defined above may be set in FLAGS.
166    If a directory cannot be opened or read and ERRFUNC is not nil,
167    it is called with the pathname that caused the error, and the
168    `errno' value from the failing call; if it returns non-zero
169    `glob' returns GLOB_ABEND; if it returns zero, the error is ignored.
170    If memory cannot be allocated for PGLOB, GLOB_NOSPACE is returned.
171    Otherwise, `glob' returns zero.  */
172 #if (defined(_FILE_OFFSET_BITS) && _FILE_OFFSET_BITS == 64) && \
173   (defined(__GNUC__) && __GNUC__ < 2)
174 extern int glob __P ((__const char *__pattern, int __flags,
175 		      int (*__errfunc) (__const char *, int),
176 		      glob_t *__pglob));
177 
178 /* Free storage allocated in PGLOB by a previous `glob' call.  */
179 extern void globfree __P ((glob_t *__pglob));
180 #else
181 extern int glob __P ((__const char *__pattern, int __flags,
182 		      int (*__errfunc) (__const char *, int),
183 		      glob_t *__pglob));
184 
185 extern void globfree __P ((glob_t *__pglob));
186 #endif
187 
188 #ifdef _LARGEFILE64_SOURCE
189 extern int glob64 __P ((__const char *__pattern, int __flags,
190 			int (*__errfunc) (__const char *, int),
191 			glob64_t *__pglob));
192 
193 extern void globfree64 __P ((glob64_t *__pglob));
194 #endif
195 
196 
197 #ifdef _GNU_SOURCE
198 /* Return nonzero if PATTERN contains any metacharacters.
199    Metacharacters can be quoted with backslashes if QUOTE is nonzero.
200 
201    This function is not part of the interface specified by POSIX.2
202    but several programs want to use it.  */
203 extern int glob_pattern_p __P ((__const char *__pattern, int __quote));
204 #endif
205 
206 #ifdef	__cplusplus
207 }
208 #endif
209 
210 #endif /* glob.h  */
211