Update.
[kopensolaris-gnu/glibc.git] / dirent / dirent.h
1 /* Copyright (C) 1991-1999, 2000 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3
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.
8
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.
13
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.  */
18
19 /*
20  *      POSIX Standard: 5.1.2 Directory Operations      <dirent.h>
21  */
22
23 #ifndef _DIRENT_H
24 #define _DIRENT_H       1
25
26 #include <features.h>
27
28 __BEGIN_DECLS
29
30 #include <bits/types.h>
31
32 #ifdef __USE_XOPEN
33 # ifndef __ino_t_defined
34 #  ifndef __USE_FILE_OFFSET64
35 typedef __ino_t ino_t;
36 #  else
37 typedef __ino64_t ino_t;
38 #  endif
39 #  define __ino_t_defined
40 # endif
41 # if defined __USE_LARGEFILE64 && !defined __ino64_t_defined
42 typedef __ino64_t ino64_t;
43 #  define __ino64_t_defined
44 # endif
45 #endif
46
47 /* This file defines `struct dirent'.
48
49    It defines the macro `_DIRENT_HAVE_D_NAMLEN' iff there is a `d_namlen'
50    member that gives the length of `d_name'.
51
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.
54
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.
57
58    It defines the macro `_DIRENT_HAVE_D_TYPE' iff there is a `d_type'
59    member that gives the type of the file.
60  */
61
62 #include <bits/dirent.h>
63
64 #if (defined __USE_BSD || defined __USE_MISC) && !defined d_fileno
65 # define d_ino  d_fileno                 /* Backward compatibility.  */
66 #endif
67
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.
72
73    _D_EXACT_NAMLEN (DP) returns the length of DP->d_name, not including
74    its terminating null character.
75
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.
80    */
81
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)
85 #else
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])
89 # else
90 #  define _D_ALLOC_NAMLEN(d) (sizeof (d)->d_name > 1 ? sizeof (d)->d_name : \
91                               _D_EXACT_NAMLEN (d) + 1)
92 # endif
93 #endif
94
95
96 #ifdef __USE_BSD
97 /* File types for `d_type'.  */
98 enum
99   {
100     DT_UNKNOWN = 0,
101 # define DT_UNKNOWN     DT_UNKNOWN
102     DT_FIFO = 1,
103 # define DT_FIFO        DT_FIFO
104     DT_CHR = 2,
105 # define DT_CHR         DT_CHR
106     DT_DIR = 4,
107 # define DT_DIR         DT_DIR
108     DT_BLK = 6,
109 # define DT_BLK         DT_BLK
110     DT_REG = 8,
111 # define DT_REG         DT_REG
112     DT_LNK = 10,
113 # define DT_LNK         DT_LNK
114     DT_SOCK = 12
115 # define DT_SOCK        DT_SOCK
116   };
117
118 /* Convert between stat structure types and directory types.  */
119 # define IFTODT(mode)   (((mode) & 0170000) >> 12)
120 # define DTTOIF(dirtype)        ((dirtype) << 12)
121 #endif
122
123
124 /* This is the data type of directory stream objects.
125    The actual structure is opaque to users.  */
126 typedef struct __dirstream DIR;
127
128 /* Open a directory stream on NAME.
129    Return a DIR stream on the directory, or NULL if it could not be opened.  */
130 extern DIR *opendir (__const char *__name) __THROW;
131
132 /* Close the directory stream DIRP.
133    Return 0 if successful, -1 if not.  */
134 extern int closedir (DIR *__dirp) __THROW;
135
136 /* Read a directory entry from DIRP.  Return a pointer to a `struct
137    dirent' describing the entry, or NULL for EOF or error.  The
138    storage returned may be overwritten by a later readdir call on the
139    same DIR stream.
140
141    If the Large File Support API is selected we have to use the
142    appropriate interface.  */
143 #ifndef __USE_FILE_OFFSET64
144 extern struct dirent *readdir (DIR *__dirp) __THROW;
145 #else
146 # ifdef __REDIRECT
147 extern struct dirent *__REDIRECT (readdir, (DIR *__dirp) __THROW, readdir64);
148 # else
149 #  define readdir readdir64
150 # endif
151 #endif
152
153 #ifdef __USE_LARGEFILE64
154 extern struct dirent64 *readdir64 (DIR *__dirp) __THROW;
155 #endif
156
157 #if defined __USE_POSIX || defined __USE_MISC
158 /* Reentrant version of `readdir'.  Return in RESULT a pointer to the
159    next entry.  */
160 # ifndef __USE_FILE_OFFSET64
161 extern int readdir_r (DIR *__restrict __dirp,
162                       struct dirent *__restrict __entry,
163                       struct dirent **__restrict __result) __THROW;
164 # else
165 #  ifdef __REDIRECT
166 extern int __REDIRECT (readdir_r,
167                        (DIR *__restrict __dirp,
168                         struct dirent *__restrict __entry,
169                         struct dirent **__restrict __result) __THROW,
170                        readdir64_r);
171 #  else
172 #   define readdir_r readdir64_r
173 #  endif
174 # endif
175
176 # ifdef __USE_LARGEFILE64
177 extern int readdir64_r (DIR *__restrict __dirp,
178                         struct dirent64 *__restrict __entry,
179                         struct dirent64 **__restrict __result) __THROW;
180 # endif
181 #endif  /* POSIX or misc */
182
183 /* Rewind DIRP to the beginning of the directory.  */
184 extern void rewinddir (DIR *__dirp) __THROW;
185
186 #if defined __USE_BSD || defined __USE_MISC || defined __USE_XOPEN
187 # include <bits/types.h>
188
189 /* Seek to position POS on DIRP.  */
190 extern void seekdir (DIR *__dirp, long int __pos) __THROW;
191
192 /* Return the current position of DIRP.  */
193 extern long int telldir (DIR *__dirp) __THROW;
194 #endif
195
196 #if defined __USE_BSD || defined __USE_MISC
197
198 /* Return the file descriptor used by DIRP.  */
199 extern int dirfd (DIR *__dirp) __THROW;
200
201 # if defined __OPTIMIZE__ && defined _DIR_dirfd
202 #  define dirfd(dirp)   _DIR_dirfd (dirp)
203 # endif
204
205 # ifndef MAXNAMLEN
206 /* Get the definitions of the POSIX.1 limits.  */
207 #  include <bits/posix1_lim.h>
208
209 /* `MAXNAMLEN' is the BSD name for what POSIX calls `NAME_MAX'.  */
210 #  ifdef NAME_MAX
211 #   define MAXNAMLEN    NAME_MAX
212 #  else
213 #   define MAXNAMLEN    255
214 #  endif
215 # endif
216
217 # define __need_size_t
218 # include <stddef.h>
219
220 /* Scan the directory DIR, calling SELECTOR on each directory entry.
221    Entries for which SELECT returns nonzero are individually malloc'd,
222    sorted using qsort with CMP, and collected in a malloc'd array in
223    *NAMELIST.  Returns the number of entries selected, or -1 on error.  */
224 # ifndef __USE_FILE_OFFSET64
225 extern int scandir (__const char *__restrict __dir,
226                     struct dirent ***__restrict __namelist,
227                     int (*__selector) (__const struct dirent *),
228                     int (*__cmp) (__const void *, __const void *)) __THROW;
229 # else
230 #  ifdef __REDIRECT
231 extern int __REDIRECT (scandir,
232                        (__const char *__restrict __dir,
233                         struct dirent ***__restrict __namelist,
234                         int (*__selector) (__const struct dirent *),
235                         int (*__cmp) (__const void *, __const void *)) __THROW,
236                        scandir64);
237 #  else
238 #   define scandir scandir64
239 #  endif
240 # endif
241
242 # if defined __USE_GNU && defined __USE_LARGEFILE64
243 /* This function is like `scandir' but it uses the 64bit dirent structure.
244    Please note that the CMP function must now work with struct dirent64 **.  */
245 extern int scandir64 (__const char *__restrict __dir,
246                       struct dirent64 ***__restrict __namelist,
247                       int (*__selector) (__const struct dirent64 *),
248                       int (*__cmp) (__const void *, __const void *)) __THROW;
249 # endif
250
251 /* Function to compare two `struct dirent's alphabetically.  */
252 # ifndef __USE_FILE_OFFSET64
253 extern int alphasort (__const void *__e1, __const void *__e2) __THROW;
254 # else
255 #  ifdef __REDIRECT
256 extern int __REDIRECT (alphasort,
257                        (__const void *__e1, __const void *__e2) __THROW,
258                        alphasort64);
259 #  else
260 #   define alphasort alphasort64
261 #  endif
262 # endif
263
264 # if defined __USE_GNU && defined __USE_LARGEFILE64
265 extern int alphasort64 (__const void *__e1, __const void *__e2) __THROW;
266 # endif
267
268 # ifdef __USE_GNU
269 /* Function to compare two `struct dirent's by name & version.  */
270 #  ifndef __USE_FILE_OFFSET64
271 extern int versionsort (__const void *__e1, __const void *__e2) __THROW;
272 #  else
273 #   ifdef __REDIRECT
274 extern int __REDIRECT (versionsort,
275                        (__const void *__e1, __const void *__e2) __THROW,
276                        versionsort64);
277 #   else
278 #    define versionsort versionsort64
279 #   endif
280 #  endif
281
282 #  ifdef __USE_LARGEFILE64
283 extern int versionsort64 (__const void *__e1, __const void *__e2) __THROW;
284 #  endif
285 # endif
286
287 /* Read directory entries from FD into BUF, reading at most NBYTES.
288    Reading starts at offset *BASEP, and *BASEP is updated with the new
289    position after reading.  Returns the number of bytes read; zero when at
290    end of directory; or -1 for errors.  */
291 # ifndef __USE_FILE_OFFSET64
292 extern __ssize_t getdirentries (int __fd, char *__restrict __buf,
293                                 size_t __nbytes,
294                                 __off_t *__restrict __basep) __THROW;
295 # else
296 #  ifdef __REDIRECT
297 extern __ssize_t __REDIRECT (getdirentries,
298                              (int __fd, char *__restrict __buf,
299                               size_t __nbytes,
300                               __off64_t *__restrict __basep) __THROW,
301                              getdirentries64);
302 #  else
303 #   define getdirentries getdirentries64
304 #  endif
305 # endif
306
307 # ifdef __USE_LARGEFILE64
308 extern __ssize_t getdirentries64 (int __fd, char *__restrict __buf,
309                                   size_t __nbytes,
310                                   __off64_t *__restrict __basep) __THROW;
311 # endif
312
313 #endif /* Use BSD or misc.  */
314
315 __END_DECLS
316
317 #endif /* dirent.h  */