1 /* Copyright (C) 1991-1999, 2000 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 Library General Public License as
6 published by the Free Software Foundation; either version 2 of the
7 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 Library General Public License for more details.
14 You should have received a copy of the GNU Library General Public
15 License along with the GNU C Library; see the file COPYING.LIB. If not,
16 write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 Boston, MA 02111-1307, USA. */
20 * POSIX Standard: 5.1.2 Directory Operations <dirent.h>
30 #include <bits/types.h>
33 # ifndef __ino_t_defined
34 # ifndef __USE_FILE_OFFSET64
35 typedef __ino_t ino_t
;
37 typedef __ino64_t ino_t
;
39 # define __ino_t_defined
41 # if defined __USE_LARGEFILE64 && !defined __ino64_t_defined
42 typedef __ino64_t ino64_t
;
43 # define __ino64_t_defined
47 /* This file defines `struct dirent'.
49 It defines the macro `_DIRENT_HAVE_D_NAMLEN' iff there is a `d_namlen'
50 member that gives the length of `d_name'.
52 It defines the macro `_DIRENT_HAVE_D_RECLEN' iff there is a `d_reclen'
53 member that gives the size of the entire directory entry.
55 It defines the macro `_DIRENT_HAVE_D_OFF' iff there is a `d_off'
56 member that gives the file offset of the next directory entry.
58 It defines the macro `_DIRENT_HAVE_D_TYPE' iff there is a `d_type'
59 member that gives the type of the file.
62 #include <bits/dirent.h>
64 #if (defined __USE_BSD || defined __USE_MISC) && !defined d_fileno
65 # define d_ino d_fileno /* Backward compatibility. */
68 /* These macros extract size information from a `struct dirent *'.
69 They may evaluate their argument multiple times, so it must not
70 have side effects. Each of these may involve a relatively costly
71 call to `strlen' on some systems, so these values should be cached.
73 _D_EXACT_NAMLEN (DP) returns the length of DP->d_name, not including
74 its terminating null character.
76 _D_ALLOC_NAMLEN (DP) returns a size at least (_D_EXACT_NAMLEN (DP) + 1);
77 that is, the allocation size needed to hold the DP->d_name string.
78 Use this macro when you don't need the exact length, just an upper bound.
79 This macro is less likely to require calling `strlen' than _D_EXACT_NAMLEN.
82 #ifdef _DIRENT_HAVE_D_NAMLEN
83 # define _D_EXACT_NAMLEN(d) ((d)->d_namlen)
84 # define _D_ALLOC_NAMLEN(d) (_D_EXACT_NAMLEN (d) + 1)
86 # define _D_EXACT_NAMLEN(d) (strlen ((d)->d_name))
87 # ifdef _DIRENT_HAVE_D_RECLEN
88 # define _D_ALLOC_NAMLEN(d) (((char *) (d) + (d)->d_reclen) - &(d)->d_name[0])
90 # define _D_ALLOC_NAMLEN(d) (sizeof (d)->d_name > 1 ? sizeof (d)->d_name : \
91 _D_EXACT_NAMLEN (d) + 1)
97 /* File types for `d_type'. */
101 # define DT_UNKNOWN DT_UNKNOWN
103 # define DT_FIFO DT_FIFO
105 # define DT_CHR DT_CHR
107 # define DT_DIR DT_DIR
109 # define DT_BLK DT_BLK
111 # define DT_REG DT_REG
113 # define DT_LNK DT_LNK
115 # define DT_SOCK DT_SOCK
117 # define DT_WHT DT_WHT
120 /* Convert between stat structure types and directory types. */
121 # define IFTODT(mode) (((mode) & 0170000) >> 12)
122 # define DTTOIF(dirtype) ((dirtype) << 12)
126 /* This is the data type of directory stream objects.
127 The actual structure is opaque to users. */
128 typedef struct __dirstream
DIR;
130 /* Open a directory stream on NAME.
131 Return a DIR stream on the directory, or NULL if it could not be opened. */
132 extern DIR *opendir (__const
char *__name
) __THROW
;
134 /* Close the directory stream DIRP.
135 Return 0 if successful, -1 if not. */
136 extern int closedir (DIR *__dirp
) __THROW
;
138 /* Read a directory entry from DIRP. Return a pointer to a `struct
139 dirent' describing the entry, or NULL for EOF or error. The
140 storage returned may be overwritten by a later readdir call on the
143 If the Large File Support API is selected we have to use the
144 appropriate interface. */
145 #ifndef __USE_FILE_OFFSET64
146 extern struct dirent
*readdir (DIR *__dirp
) __THROW
;
149 extern struct dirent
*__REDIRECT (readdir
, (DIR *__dirp
) __THROW
, readdir64
);
151 # define readdir readdir64
155 #ifdef __USE_LARGEFILE64
156 extern struct dirent64
*readdir64 (DIR *__dirp
) __THROW
;
159 #if defined __USE_POSIX || defined __USE_MISC
160 /* Reentrant version of `readdir'. Return in RESULT a pointer to the
162 # ifndef __USE_FILE_OFFSET64
163 extern int readdir_r (DIR *__restrict __dirp
,
164 struct dirent
*__restrict __entry
,
165 struct dirent
**__restrict __result
) __THROW
;
168 extern int __REDIRECT (readdir_r
,
169 (DIR *__restrict __dirp
,
170 struct dirent
*__restrict __entry
,
171 struct dirent
**__restrict __result
) __THROW
,
174 # define readdir_r readdir64_r
178 # ifdef __USE_LARGEFILE64
179 extern int readdir64_r (DIR *__restrict __dirp
,
180 struct dirent64
*__restrict __entry
,
181 struct dirent64
**__restrict __result
) __THROW
;
183 #endif /* POSIX or misc */
185 /* Rewind DIRP to the beginning of the directory. */
186 extern void rewinddir (DIR *__dirp
) __THROW
;
188 #if defined __USE_BSD || defined __USE_MISC || defined __USE_XOPEN
189 # include <bits/types.h>
191 /* Seek to position POS on DIRP. */
192 extern void seekdir (DIR *__dirp
, long int __pos
) __THROW
;
194 /* Return the current position of DIRP. */
195 extern long int telldir (DIR *__dirp
) __THROW
;
198 #if defined __USE_BSD || defined __USE_MISC
200 /* Return the file descriptor used by DIRP. */
201 extern int dirfd (DIR *__dirp
) __THROW
;
203 # if defined __OPTIMIZE__ && defined _DIR_dirfd
204 # define dirfd(dirp) _DIR_dirfd (dirp)
208 /* Get the definitions of the POSIX.1 limits. */
209 # include <bits/posix1_lim.h>
211 /* `MAXNAMLEN' is the BSD name for what POSIX calls `NAME_MAX'. */
213 # define MAXNAMLEN NAME_MAX
215 # define MAXNAMLEN 255
219 # define __need_size_t
222 /* Scan the directory DIR, calling SELECTOR on each directory entry.
223 Entries for which SELECT returns nonzero are individually malloc'd,
224 sorted using qsort with CMP, and collected in a malloc'd array in
225 *NAMELIST. Returns the number of entries selected, or -1 on error. */
226 # ifndef __USE_FILE_OFFSET64
227 extern int scandir (__const
char *__restrict __dir
,
228 struct dirent
***__restrict __namelist
,
229 int (*__selector
) (__const
struct dirent
*),
230 int (*__cmp
) (__const
void *, __const
void *)) __THROW
;
233 extern int __REDIRECT (scandir
,
234 (__const
char *__restrict __dir
,
235 struct dirent
***__restrict __namelist
,
236 int (*__selector
) (__const
struct dirent
*),
237 int (*__cmp
) (__const
void *, __const
void *)) __THROW
,
240 # define scandir scandir64
244 # if defined __USE_GNU && defined __USE_LARGEFILE64
245 /* This function is like `scandir' but it uses the 64bit dirent structure.
246 Please note that the CMP function must now work with struct dirent64 **. */
247 extern int scandir64 (__const
char *__restrict __dir
,
248 struct dirent64
***__restrict __namelist
,
249 int (*__selector
) (__const
struct dirent64
*),
250 int (*__cmp
) (__const
void *, __const
void *)) __THROW
;
253 /* Function to compare two `struct dirent's alphabetically. */
254 # ifndef __USE_FILE_OFFSET64
255 extern int alphasort (__const
void *__e1
, __const
void *__e2
)
256 __THROW __attribute_pure__
;
259 extern int __REDIRECT (alphasort
,
260 (__const
void *__e1
, __const
void *__e2
)
262 alphasort64
) __attribute_pure__
;
264 # define alphasort alphasort64
268 # if defined __USE_GNU && defined __USE_LARGEFILE64
269 extern int alphasort64 (__const
void *__e1
, __const
void *__e2
)
270 __THROW __attribute_pure__
;
274 /* Function to compare two `struct dirent's by name & version. */
275 # ifndef __USE_FILE_OFFSET64
276 extern int versionsort (__const
void *__e1
, __const
void *__e2
)
277 __THROW __attribute_pure__
;
280 extern int __REDIRECT (versionsort
,
281 (__const
void *__e1
, __const
void *__e2
)
283 versionsort64
) __attribute_pure__
;
285 # define versionsort versionsort64
289 # ifdef __USE_LARGEFILE64
290 extern int versionsort64 (__const
void *__e1
, __const
void *__e2
)
291 __THROW __attribute_pure__
;
295 /* Read directory entries from FD into BUF, reading at most NBYTES.
296 Reading starts at offset *BASEP, and *BASEP is updated with the new
297 position after reading. Returns the number of bytes read; zero when at
298 end of directory; or -1 for errors. */
299 # ifndef __USE_FILE_OFFSET64
300 extern __ssize_t
getdirentries (int __fd
, char *__restrict __buf
,
302 __off_t
*__restrict __basep
) __THROW
;
305 extern __ssize_t
__REDIRECT (getdirentries
,
306 (int __fd
, char *__restrict __buf
,
308 __off64_t
*__restrict __basep
) __THROW
,
311 # define getdirentries getdirentries64
315 # ifdef __USE_LARGEFILE64
316 extern __ssize_t
getdirentries64 (int __fd
, char *__restrict __buf
,
318 __off64_t
*__restrict __basep
) __THROW
;
321 #endif /* Use BSD or misc. */
325 #endif /* dirent.h */