Commit | Line | Data |
---|---|---|
e26b6bb0 | 1 | /* A GNU-like <dirent.h>. |
c0c3707f | 2 | Copyright (C) 2006-2019 Free Software Foundation, Inc. |
e26b6bb0 TT |
3 | |
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. | |
8 | ||
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. | |
13 | ||
14 | You should have received a copy of the GNU General Public License | |
c0c3707f | 15 | along with this program. If not, see <https://www.gnu.org/licenses/>. */ |
e26b6bb0 TT |
16 | |
17 | #ifndef _@GUARD_PREFIX@_DIRENT_H | |
18 | ||
19 | #if __GNUC__ >= 3 | |
20 | @PRAGMA_SYSTEM_HEADER@ | |
21 | #endif | |
22 | @PRAGMA_COLUMNS@ | |
23 | ||
24 | /* The include_next requires a split double-inclusion guard. */ | |
25 | #if @HAVE_DIRENT_H@ | |
26 | # @INCLUDE_NEXT@ @NEXT_DIRENT_H@ | |
27 | #endif | |
28 | ||
29 | #ifndef _@GUARD_PREFIX@_DIRENT_H | |
30 | #define _@GUARD_PREFIX@_DIRENT_H | |
31 | ||
32 | /* Get ino_t. Needed on some systems, including glibc 2.8. */ | |
33 | #include <sys/types.h> | |
34 | ||
35 | #if !@HAVE_DIRENT_H@ | |
36 | /* Define types DIR and 'struct dirent'. */ | |
37 | # if !GNULIB_defined_struct_dirent | |
38 | struct dirent | |
39 | { | |
40 | char d_type; | |
41 | char d_name[1]; | |
42 | }; | |
43 | /* Possible values for 'd_type'. */ | |
44 | # define DT_UNKNOWN 0 | |
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 | |
55 | # endif | |
56 | #endif | |
57 | ||
58 | /* The __attribute__ feature is available in gcc versions 2.5 and later. | |
59 | The attribute __pure__ was added in gcc 2.96. */ | |
60 | #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96) | |
61 | # define _GL_ATTRIBUTE_PURE __attribute__ ((__pure__)) | |
62 | #else | |
63 | # define _GL_ATTRIBUTE_PURE /* empty */ | |
64 | #endif | |
65 | ||
66 | /* The definitions of _GL_FUNCDECL_RPL etc. are copied here. */ | |
67 | ||
68 | /* The definition of _GL_ARG_NONNULL is copied here. */ | |
69 | ||
70 | /* The definition of _GL_WARN_ON_USE is copied here. */ | |
71 | ||
72 | ||
73 | /* Declare overridden functions. */ | |
74 | ||
75 | #if @GNULIB_OPENDIR@ | |
76 | # if @REPLACE_OPENDIR@ | |
77 | # if !(defined __cplusplus && defined GNULIB_NAMESPACE) | |
78 | # undef opendir | |
79 | # define opendir rpl_opendir | |
4a626d0a | 80 | # define GNULIB_defined_opendir 1 |
e26b6bb0 TT |
81 | # endif |
82 | _GL_FUNCDECL_RPL (opendir, DIR *, (const char *dir_name) _GL_ARG_NONNULL ((1))); | |
83 | _GL_CXXALIAS_RPL (opendir, DIR *, (const char *dir_name)); | |
84 | # else | |
85 | # if !@HAVE_OPENDIR@ | |
86 | _GL_FUNCDECL_SYS (opendir, DIR *, (const char *dir_name) _GL_ARG_NONNULL ((1))); | |
87 | # endif | |
88 | _GL_CXXALIAS_SYS (opendir, DIR *, (const char *dir_name)); | |
89 | # endif | |
90 | _GL_CXXALIASWARN (opendir); | |
91 | #elif defined GNULIB_POSIXCHECK | |
92 | # undef opendir | |
93 | # if HAVE_RAW_DECL_OPENDIR | |
94 | _GL_WARN_ON_USE (opendir, "opendir is not portable - " | |
95 | "use gnulib module opendir for portability"); | |
96 | # endif | |
97 | #endif | |
98 | ||
99 | #if @GNULIB_READDIR@ | |
100 | # if !@HAVE_READDIR@ | |
101 | _GL_FUNCDECL_SYS (readdir, struct dirent *, (DIR *dirp) _GL_ARG_NONNULL ((1))); | |
102 | # endif | |
103 | _GL_CXXALIAS_SYS (readdir, struct dirent *, (DIR *dirp)); | |
104 | _GL_CXXALIASWARN (readdir); | |
105 | #elif defined GNULIB_POSIXCHECK | |
106 | # undef readdir | |
107 | # if HAVE_RAW_DECL_READDIR | |
108 | _GL_WARN_ON_USE (readdir, "readdir is not portable - " | |
109 | "use gnulib module readdir for portability"); | |
110 | # endif | |
111 | #endif | |
112 | ||
113 | #if @GNULIB_REWINDDIR@ | |
114 | # if !@HAVE_REWINDDIR@ | |
115 | _GL_FUNCDECL_SYS (rewinddir, void, (DIR *dirp) _GL_ARG_NONNULL ((1))); | |
116 | # endif | |
117 | _GL_CXXALIAS_SYS (rewinddir, void, (DIR *dirp)); | |
118 | _GL_CXXALIASWARN (rewinddir); | |
119 | #elif defined GNULIB_POSIXCHECK | |
120 | # undef rewinddir | |
121 | # if HAVE_RAW_DECL_REWINDDIR | |
122 | _GL_WARN_ON_USE (rewinddir, "rewinddir is not portable - " | |
123 | "use gnulib module rewinddir for portability"); | |
124 | # endif | |
125 | #endif | |
126 | ||
127 | #if @GNULIB_CLOSEDIR@ | |
128 | # if @REPLACE_CLOSEDIR@ | |
129 | # if !(defined __cplusplus && defined GNULIB_NAMESPACE) | |
130 | # undef closedir | |
131 | # define closedir rpl_closedir | |
4a626d0a | 132 | # define GNULIB_defined_closedir 1 |
e26b6bb0 TT |
133 | # endif |
134 | _GL_FUNCDECL_RPL (closedir, int, (DIR *dirp) _GL_ARG_NONNULL ((1))); | |
135 | _GL_CXXALIAS_RPL (closedir, int, (DIR *dirp)); | |
136 | # else | |
137 | # if !@HAVE_CLOSEDIR@ | |
138 | _GL_FUNCDECL_SYS (closedir, int, (DIR *dirp) _GL_ARG_NONNULL ((1))); | |
139 | # endif | |
140 | _GL_CXXALIAS_SYS (closedir, int, (DIR *dirp)); | |
141 | # endif | |
142 | _GL_CXXALIASWARN (closedir); | |
143 | #elif defined GNULIB_POSIXCHECK | |
144 | # undef closedir | |
145 | # if HAVE_RAW_DECL_CLOSEDIR | |
146 | _GL_WARN_ON_USE (closedir, "closedir is not portable - " | |
147 | "use gnulib module closedir for portability"); | |
148 | # endif | |
149 | #endif | |
150 | ||
151 | #if @GNULIB_DIRFD@ | |
152 | /* Return the file descriptor associated with the given directory stream, | |
153 | or -1 if none exists. */ | |
154 | # if @REPLACE_DIRFD@ | |
155 | # if !(defined __cplusplus && defined GNULIB_NAMESPACE) | |
156 | # undef dirfd | |
157 | # define dirfd rpl_dirfd | |
158 | # endif | |
159 | _GL_FUNCDECL_RPL (dirfd, int, (DIR *) _GL_ARG_NONNULL ((1))); | |
160 | _GL_CXXALIAS_RPL (dirfd, int, (DIR *)); | |
49e4877c PA |
161 | |
162 | # ifdef __KLIBC__ | |
163 | /* Gnulib internal hooks needed to maintain the dirfd metadata. */ | |
164 | _GL_EXTERN_C int _gl_register_dirp_fd (int fd, DIR *dirp) | |
165 | _GL_ARG_NONNULL ((2)); | |
166 | _GL_EXTERN_C void _gl_unregister_dirp_fd (int fd); | |
167 | # endif | |
e26b6bb0 TT |
168 | # else |
169 | # if defined __cplusplus && defined GNULIB_NAMESPACE && defined dirfd | |
170 | /* dirfd is defined as a macro and not as a function. | |
171 | Turn it into a function and get rid of the macro. */ | |
172 | static inline int (dirfd) (DIR *dp) { return dirfd (dp); } | |
173 | # undef dirfd | |
174 | # endif | |
175 | # if !(@HAVE_DECL_DIRFD@ || defined dirfd) | |
176 | _GL_FUNCDECL_SYS (dirfd, int, (DIR *) _GL_ARG_NONNULL ((1))); | |
177 | # endif | |
178 | _GL_CXXALIAS_SYS (dirfd, int, (DIR *)); | |
179 | # endif | |
180 | _GL_CXXALIASWARN (dirfd); | |
181 | #elif defined GNULIB_POSIXCHECK | |
182 | # undef dirfd | |
183 | # if HAVE_RAW_DECL_DIRFD | |
184 | _GL_WARN_ON_USE (dirfd, "dirfd is unportable - " | |
185 | "use gnulib module dirfd for portability"); | |
186 | # endif | |
187 | #endif | |
188 | ||
189 | #if @GNULIB_FDOPENDIR@ | |
190 | /* Open a directory stream visiting the given directory file | |
191 | descriptor. Return NULL and set errno if fd is not visiting a | |
192 | directory. On success, this function consumes fd (it will be | |
193 | implicitly closed either by this function or by a subsequent | |
194 | closedir). */ | |
195 | # if @REPLACE_FDOPENDIR@ | |
196 | # if !(defined __cplusplus && defined GNULIB_NAMESPACE) | |
197 | # undef fdopendir | |
198 | # define fdopendir rpl_fdopendir | |
199 | # endif | |
200 | _GL_FUNCDECL_RPL (fdopendir, DIR *, (int fd)); | |
201 | _GL_CXXALIAS_RPL (fdopendir, DIR *, (int fd)); | |
202 | # else | |
203 | # if !@HAVE_FDOPENDIR@ || !@HAVE_DECL_FDOPENDIR@ | |
204 | _GL_FUNCDECL_SYS (fdopendir, DIR *, (int fd)); | |
205 | # endif | |
206 | _GL_CXXALIAS_SYS (fdopendir, DIR *, (int fd)); | |
207 | # endif | |
208 | _GL_CXXALIASWARN (fdopendir); | |
209 | #elif defined GNULIB_POSIXCHECK | |
210 | # undef fdopendir | |
211 | # if HAVE_RAW_DECL_FDOPENDIR | |
212 | _GL_WARN_ON_USE (fdopendir, "fdopendir is unportable - " | |
213 | "use gnulib module fdopendir for portability"); | |
214 | # endif | |
215 | #endif | |
216 | ||
217 | #if @GNULIB_SCANDIR@ | |
218 | /* Scan the directory DIR, calling FILTER on each directory entry. | |
219 | Entries for which FILTER returns nonzero are individually malloc'd, | |
220 | sorted using qsort with CMP, and collected in a malloc'd array in | |
221 | *NAMELIST. Returns the number of entries selected, or -1 on error. */ | |
222 | # if !@HAVE_SCANDIR@ | |
223 | _GL_FUNCDECL_SYS (scandir, int, | |
224 | (const char *dir, struct dirent ***namelist, | |
225 | int (*filter) (const struct dirent *), | |
226 | int (*cmp) (const struct dirent **, const struct dirent **)) | |
227 | _GL_ARG_NONNULL ((1, 2, 4))); | |
228 | # endif | |
229 | /* Need to cast, because on glibc systems, the fourth parameter is | |
230 | int (*cmp) (const void *, const void *). */ | |
231 | _GL_CXXALIAS_SYS_CAST (scandir, int, | |
232 | (const char *dir, struct dirent ***namelist, | |
233 | int (*filter) (const struct dirent *), | |
234 | int (*cmp) (const struct dirent **, const struct dirent **))); | |
235 | _GL_CXXALIASWARN (scandir); | |
236 | #elif defined GNULIB_POSIXCHECK | |
237 | # undef scandir | |
238 | # if HAVE_RAW_DECL_SCANDIR | |
239 | _GL_WARN_ON_USE (scandir, "scandir is unportable - " | |
240 | "use gnulib module scandir for portability"); | |
241 | # endif | |
242 | #endif | |
243 | ||
244 | #if @GNULIB_ALPHASORT@ | |
245 | /* Compare two 'struct dirent' entries alphabetically. */ | |
246 | # if !@HAVE_ALPHASORT@ | |
247 | _GL_FUNCDECL_SYS (alphasort, int, | |
248 | (const struct dirent **, const struct dirent **) | |
249 | _GL_ATTRIBUTE_PURE | |
250 | _GL_ARG_NONNULL ((1, 2))); | |
251 | # endif | |
252 | /* Need to cast, because on glibc systems, the parameters are | |
253 | (const void *, const void *). */ | |
254 | _GL_CXXALIAS_SYS_CAST (alphasort, int, | |
255 | (const struct dirent **, const struct dirent **)); | |
256 | _GL_CXXALIASWARN (alphasort); | |
257 | #elif defined GNULIB_POSIXCHECK | |
258 | # undef alphasort | |
259 | # if HAVE_RAW_DECL_ALPHASORT | |
260 | _GL_WARN_ON_USE (alphasort, "alphasort is unportable - " | |
261 | "use gnulib module alphasort for portability"); | |
262 | # endif | |
263 | #endif | |
264 | ||
265 | ||
266 | #endif /* _@GUARD_PREFIX@_DIRENT_H */ | |
267 | #endif /* _@GUARD_PREFIX@_DIRENT_H */ |