1 /* A GNU-like <dirent.h>.
2 Copyright (C) 2006-2012 Free Software Foundation, Inc.
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 3 of the License, or
7 (at your option) any later version.
9 This program 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
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
17 #ifndef _@GUARD_PREFIX@_DIRENT_H
20 @PRAGMA_SYSTEM_HEADER@
24 /* The include_next requires a split double-inclusion guard. */
26 # @INCLUDE_NEXT@ @NEXT_DIRENT_H@
29 #ifndef _@GUARD_PREFIX@_DIRENT_H
30 #define _@GUARD_PREFIX@_DIRENT_H
32 /* Get ino_t. Needed on some systems, including glibc 2.8. */
33 #include <sys/types.h>
36 /* Define types DIR and 'struct dirent'. */
37 # if !GNULIB_defined_struct_dirent
43 /* Possible values for 'd_type'. */
45 # define DT_FIFO 1 /* FIFO */
46 # define DT_CHR 2 /* character device */
47 # define DT_DIR 4 /* directory */
48 # define DT_BLK 6 /* block device */
49 # define DT_REG 8 /* regular file */
50 # define DT_LNK 10 /* symbolic link */
51 # define DT_SOCK 12 /* socket */
52 # define DT_WHT 14 /* whiteout */
53 typedef struct gl_directory
DIR;
54 # define GNULIB_defined_struct_dirent 1
58 /* The definitions of _GL_FUNCDECL_RPL etc. are copied here. */
60 /* The definition of _GL_ARG_NONNULL is copied here. */
62 /* The definition of _GL_WARN_ON_USE is copied here. */
65 /* Declare overridden functions. */
68 # if @REPLACE_OPENDIR@
69 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
71 # define opendir rpl_opendir
73 _GL_FUNCDECL_RPL (opendir
, DIR *, (const char *dir_name
) _GL_ARG_NONNULL ((1)));
74 _GL_CXXALIAS_RPL (opendir
, DIR *, (const char *dir_name
));
77 _GL_FUNCDECL_SYS (opendir
, DIR *, (const char *dir_name
) _GL_ARG_NONNULL ((1)));
79 _GL_CXXALIAS_SYS (opendir
, DIR *, (const char *dir_name
));
81 _GL_CXXALIASWARN (opendir
);
82 #elif defined GNULIB_POSIXCHECK
84 # if HAVE_RAW_DECL_OPENDIR
85 _GL_WARN_ON_USE (opendir
, "opendir is not portable - "
86 "use gnulib module opendir for portability");
92 _GL_FUNCDECL_SYS (readdir
, struct dirent
*, (DIR *dirp
) _GL_ARG_NONNULL ((1)));
94 _GL_CXXALIAS_SYS (readdir
, struct dirent
*, (DIR *dirp
));
95 _GL_CXXALIASWARN (readdir
);
96 #elif defined GNULIB_POSIXCHECK
98 # if HAVE_RAW_DECL_READDIR
99 _GL_WARN_ON_USE (readdir
, "readdir is not portable - "
100 "use gnulib module readdir for portability");
104 #if @GNULIB_REWINDDIR@
105 # if !@HAVE_REWINDDIR@
106 _GL_FUNCDECL_SYS (rewinddir
, void, (DIR *dirp
) _GL_ARG_NONNULL ((1)));
108 _GL_CXXALIAS_SYS (rewinddir
, void, (DIR *dirp
));
109 _GL_CXXALIASWARN (rewinddir
);
110 #elif defined GNULIB_POSIXCHECK
112 # if HAVE_RAW_DECL_REWINDDIR
113 _GL_WARN_ON_USE (rewinddir
, "rewinddir is not portable - "
114 "use gnulib module rewinddir for portability");
118 #if @GNULIB_CLOSEDIR@
119 # if @REPLACE_CLOSEDIR@
120 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
122 # define closedir rpl_closedir
124 _GL_FUNCDECL_RPL (closedir
, int, (DIR *dirp
) _GL_ARG_NONNULL ((1)));
125 _GL_CXXALIAS_RPL (closedir
, int, (DIR *dirp
));
127 # if !@HAVE_CLOSEDIR@
128 _GL_FUNCDECL_SYS (closedir
, int, (DIR *dirp
) _GL_ARG_NONNULL ((1)));
130 _GL_CXXALIAS_SYS (closedir
, int, (DIR *dirp
));
132 _GL_CXXALIASWARN (closedir
);
133 #elif defined GNULIB_POSIXCHECK
135 # if HAVE_RAW_DECL_CLOSEDIR
136 _GL_WARN_ON_USE (closedir
, "closedir is not portable - "
137 "use gnulib module closedir for portability");
142 /* Return the file descriptor associated with the given directory stream,
143 or -1 if none exists. */
145 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
147 # define dirfd rpl_dirfd
149 _GL_FUNCDECL_RPL (dirfd
, int, (DIR *) _GL_ARG_NONNULL ((1)));
150 _GL_CXXALIAS_RPL (dirfd
, int, (DIR *));
152 # if defined __cplusplus && defined GNULIB_NAMESPACE && defined dirfd
153 /* dirfd is defined as a macro and not as a function.
154 Turn it into a function and get rid of the macro. */
155 static inline int (dirfd
) (DIR *dp
) { return dirfd (dp
); }
158 # if !(@HAVE_DECL_DIRFD@ || defined dirfd)
159 _GL_FUNCDECL_SYS (dirfd
, int, (DIR *) _GL_ARG_NONNULL ((1)));
161 _GL_CXXALIAS_SYS (dirfd
, int, (DIR *));
163 _GL_CXXALIASWARN (dirfd
);
164 #elif defined GNULIB_POSIXCHECK
166 # if HAVE_RAW_DECL_DIRFD
167 _GL_WARN_ON_USE (dirfd
, "dirfd is unportable - "
168 "use gnulib module dirfd for portability");
172 #if @GNULIB_FDOPENDIR@
173 /* Open a directory stream visiting the given directory file
174 descriptor. Return NULL and set errno if fd is not visiting a
175 directory. On success, this function consumes fd (it will be
176 implicitly closed either by this function or by a subsequent
178 # if @REPLACE_FDOPENDIR@
179 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
181 # define fdopendir rpl_fdopendir
183 _GL_FUNCDECL_RPL (fdopendir
, DIR *, (int fd
));
184 _GL_CXXALIAS_RPL (fdopendir
, DIR *, (int fd
));
186 # if !@HAVE_FDOPENDIR@ || !@HAVE_DECL_FDOPENDIR@
187 _GL_FUNCDECL_SYS (fdopendir
, DIR *, (int fd
));
189 _GL_CXXALIAS_SYS (fdopendir
, DIR *, (int fd
));
191 _GL_CXXALIASWARN (fdopendir
);
192 #elif defined GNULIB_POSIXCHECK
194 # if HAVE_RAW_DECL_FDOPENDIR
195 _GL_WARN_ON_USE (fdopendir
, "fdopendir is unportable - "
196 "use gnulib module fdopendir for portability");
201 /* Scan the directory DIR, calling FILTER on each directory entry.
202 Entries for which FILTER returns nonzero are individually malloc'd,
203 sorted using qsort with CMP, and collected in a malloc'd array in
204 *NAMELIST. Returns the number of entries selected, or -1 on error. */
206 _GL_FUNCDECL_SYS (scandir
, int,
207 (const char *dir
, struct dirent
***namelist
,
208 int (*filter
) (const struct dirent
*),
209 int (*cmp
) (const struct dirent
**, const struct dirent
**))
210 _GL_ARG_NONNULL ((1, 2, 4)));
212 /* Need to cast, because on glibc systems, the fourth parameter is
213 int (*cmp) (const void *, const void *). */
214 _GL_CXXALIAS_SYS_CAST (scandir
, int,
215 (const char *dir
, struct dirent
***namelist
,
216 int (*filter
) (const struct dirent
*),
217 int (*cmp
) (const struct dirent
**, const struct dirent
**)));
218 _GL_CXXALIASWARN (scandir
);
219 #elif defined GNULIB_POSIXCHECK
221 # if HAVE_RAW_DECL_SCANDIR
222 _GL_WARN_ON_USE (scandir
, "scandir is unportable - "
223 "use gnulib module scandir for portability");
227 #if @GNULIB_ALPHASORT@
228 /* Compare two 'struct dirent' entries alphabetically. */
229 # if !@HAVE_ALPHASORT@
230 _GL_FUNCDECL_SYS (alphasort
, int,
231 (const struct dirent
**, const struct dirent
**)
232 _GL_ARG_NONNULL ((1, 2)));
234 /* Need to cast, because on glibc systems, the parameters are
235 (const void *, const void *). */
236 _GL_CXXALIAS_SYS_CAST (alphasort
, int,
237 (const struct dirent
**, const struct dirent
**));
238 _GL_CXXALIASWARN (alphasort
);
239 #elif defined GNULIB_POSIXCHECK
241 # if HAVE_RAW_DECL_ALPHASORT
242 _GL_WARN_ON_USE (alphasort
, "alphasort is unportable - "
243 "use gnulib module alphasort for portability");
248 #endif /* _@GUARD_PREFIX@_DIRENT_H */
249 #endif /* _@GUARD_PREFIX@_DIRENT_H */