dirent.h 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327
  1. /* Copyright (C) 1991-1999, 2000 Free Software Foundation, Inc.
  2. This file is part of the GNU C Library.
  3. The GNU C Library is free software; you can redistribute it and/or
  4. modify it under the terms of the GNU Lesser General Public
  5. License as published by the Free Software Foundation; either
  6. version 2.1 of the License, or (at your option) any later version.
  7. The GNU C Library is distributed in the hope that it will be useful,
  8. but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  10. Lesser General Public License for more details.
  11. You should have received a copy of the GNU Lesser General Public
  12. License along with the GNU C Library; if not, write to the Free
  13. Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  14. 02111-1307 USA. */
  15. /*
  16. * POSIX Standard: 5.1.2 Directory Operations <dirent.h>
  17. */
  18. #ifndef _DIRENT_H
  19. #define _DIRENT_H 1
  20. #include <features.h>
  21. __BEGIN_DECLS
  22. #include <bits/types.h>
  23. #ifdef __USE_XOPEN
  24. # ifndef __ino_t_defined
  25. # ifndef __USE_FILE_OFFSET64
  26. typedef __ino_t ino_t;
  27. # else
  28. typedef __ino64_t ino_t;
  29. # endif
  30. # define __ino_t_defined
  31. # endif
  32. # if defined __USE_LARGEFILE64 && !defined __ino64_t_defined
  33. typedef __ino64_t ino64_t;
  34. # define __ino64_t_defined
  35. # endif
  36. #endif
  37. /* This file defines `struct dirent'.
  38. It defines the macro `_DIRENT_HAVE_D_NAMLEN' iff there is a `d_namlen'
  39. member that gives the length of `d_name'.
  40. It defines the macro `_DIRENT_HAVE_D_RECLEN' iff there is a `d_reclen'
  41. member that gives the size of the entire directory entry.
  42. It defines the macro `_DIRENT_HAVE_D_OFF' iff there is a `d_off'
  43. member that gives the file offset of the next directory entry.
  44. It defines the macro `_DIRENT_HAVE_D_TYPE' iff there is a `d_type'
  45. member that gives the type of the file.
  46. */
  47. #include <bits/dirent.h>
  48. #if (defined __USE_BSD || defined __USE_MISC) && !defined d_fileno
  49. # define d_ino d_fileno /* Backward compatibility. */
  50. #endif
  51. /* These macros extract size information from a `struct dirent *'.
  52. They may evaluate their argument multiple times, so it must not
  53. have side effects. Each of these may involve a relatively costly
  54. call to `strlen' on some systems, so these values should be cached.
  55. _D_EXACT_NAMLEN (DP) returns the length of DP->d_name, not including
  56. its terminating null character.
  57. _D_ALLOC_NAMLEN (DP) returns a size at least (_D_EXACT_NAMLEN (DP) + 1);
  58. that is, the allocation size needed to hold the DP->d_name string.
  59. Use this macro when you don't need the exact length, just an upper bound.
  60. This macro is less likely to require calling `strlen' than _D_EXACT_NAMLEN.
  61. */
  62. #ifdef _DIRENT_HAVE_D_NAMLEN
  63. # define _D_EXACT_NAMLEN(d) ((d)->d_namlen)
  64. # define _D_ALLOC_NAMLEN(d) (_D_EXACT_NAMLEN (d) + 1)
  65. #else
  66. # define _D_EXACT_NAMLEN(d) (strlen ((d)->d_name))
  67. # ifdef _DIRENT_HAVE_D_RECLEN
  68. # define _D_ALLOC_NAMLEN(d) (((char *) (d) + (d)->d_reclen) - &(d)->d_name[0])
  69. # else
  70. # define _D_ALLOC_NAMLEN(d) (sizeof (d)->d_name > 1 ? sizeof (d)->d_name : \
  71. _D_EXACT_NAMLEN (d) + 1)
  72. # endif
  73. #endif
  74. #ifdef __USE_BSD
  75. /* File types for `d_type'. */
  76. enum
  77. {
  78. DT_UNKNOWN = 0,
  79. # define DT_UNKNOWN DT_UNKNOWN
  80. DT_FIFO = 1,
  81. # define DT_FIFO DT_FIFO
  82. DT_CHR = 2,
  83. # define DT_CHR DT_CHR
  84. DT_DIR = 4,
  85. # define DT_DIR DT_DIR
  86. DT_BLK = 6,
  87. # define DT_BLK DT_BLK
  88. DT_REG = 8,
  89. # define DT_REG DT_REG
  90. DT_LNK = 10,
  91. # define DT_LNK DT_LNK
  92. DT_SOCK = 12,
  93. # define DT_SOCK DT_SOCK
  94. DT_WHT = 14
  95. # define DT_WHT DT_WHT
  96. };
  97. #ifdef _DIRENT_HAVE_D_TYPE
  98. /* Convert between stat structure types and directory types. */
  99. # define IFTODT(mode) (((mode) & 0170000) >> 12)
  100. # define DTTOIF(dirtype) ((dirtype) << 12)
  101. #endif
  102. #endif
  103. /* This is the data type of directory stream objects.
  104. The actual structure is opaque to users. */
  105. typedef struct __dirstream DIR;
  106. /* Open a directory stream on NAME.
  107. Return a DIR stream on the directory, or NULL if it could not be opened. */
  108. extern DIR *opendir (__const char *__name) __THROW;
  109. /* Close the directory stream DIRP.
  110. Return 0 if successful, -1 if not. */
  111. extern int closedir (DIR *__dirp) __THROW;
  112. /* Read a directory entry from DIRP. Return a pointer to a `struct
  113. dirent' describing the entry, or NULL for EOF or error. The
  114. storage returned may be overwritten by a later readdir call on the
  115. same DIR stream.
  116. If the Large File Support API is selected we have to use the
  117. appropriate interface. */
  118. #ifndef __USE_FILE_OFFSET64
  119. extern struct dirent *readdir (DIR *__dirp) __THROW;
  120. #else
  121. # ifdef __REDIRECT
  122. extern struct dirent *__REDIRECT (readdir, (DIR *__dirp) __THROW, readdir64);
  123. # else
  124. # define readdir readdir64
  125. # endif
  126. #endif
  127. #ifdef __USE_LARGEFILE64
  128. extern struct dirent64 *readdir64 (DIR *__dirp) __THROW;
  129. #endif
  130. #if defined __USE_POSIX || defined __USE_MISC
  131. /* Reentrant version of `readdir'. Return in RESULT a pointer to the
  132. next entry. */
  133. # ifndef __USE_FILE_OFFSET64
  134. extern int readdir_r (DIR *__restrict __dirp,
  135. struct dirent *__restrict __entry,
  136. struct dirent **__restrict __result) __THROW;
  137. # else
  138. # ifdef __REDIRECT
  139. extern int __REDIRECT (readdir_r,
  140. (DIR *__restrict __dirp,
  141. struct dirent *__restrict __entry,
  142. struct dirent **__restrict __result) __THROW,
  143. readdir64_r);
  144. # else
  145. # define readdir_r readdir64_r
  146. # endif
  147. # endif
  148. # ifdef __USE_LARGEFILE64
  149. extern int readdir64_r (DIR *__restrict __dirp,
  150. struct dirent64 *__restrict __entry,
  151. struct dirent64 **__restrict __result) __THROW;
  152. # endif
  153. #endif /* POSIX or misc */
  154. /* Rewind DIRP to the beginning of the directory. */
  155. extern void rewinddir (DIR *__dirp) __THROW;
  156. #if defined __USE_BSD || defined __USE_MISC || defined __USE_XOPEN
  157. # include <bits/types.h>
  158. /* Seek to position POS on DIRP. */
  159. extern void seekdir (DIR *__dirp, long int __pos) __THROW;
  160. /* Return the current position of DIRP. */
  161. extern long int telldir (DIR *__dirp) __THROW;
  162. #endif
  163. #if defined __USE_BSD || defined __USE_MISC
  164. /* Return the file descriptor used by DIRP. */
  165. extern int dirfd (DIR *__dirp) __THROW;
  166. # if defined __OPTIMIZE__ && defined _DIR_dirfd
  167. # define dirfd(dirp) _DIR_dirfd (dirp)
  168. # endif
  169. # ifndef MAXNAMLEN
  170. /* Get the definitions of the POSIX.1 limits. */
  171. # include <bits/posix1_lim.h>
  172. /* `MAXNAMLEN' is the BSD name for what POSIX calls `NAME_MAX'. */
  173. # ifdef NAME_MAX
  174. # define MAXNAMLEN NAME_MAX
  175. # else
  176. # define MAXNAMLEN 255
  177. # endif
  178. # endif
  179. # define __need_size_t
  180. # include <stddef.h>
  181. /* Scan the directory DIR, calling SELECTOR on each directory entry.
  182. Entries for which SELECT returns nonzero are individually malloc'd,
  183. sorted using qsort with CMP, and collected in a malloc'd array in
  184. *NAMELIST. Returns the number of entries selected, or -1 on error. */
  185. # ifndef __USE_FILE_OFFSET64
  186. extern int scandir (__const char *__restrict __dir,
  187. struct dirent ***__restrict __namelist,
  188. int (*__selector) (__const struct dirent *),
  189. int (*__cmp) (__const void *, __const void *)) __THROW;
  190. # else
  191. # ifdef __REDIRECT
  192. extern int __REDIRECT (scandir,
  193. (__const char *__restrict __dir,
  194. struct dirent ***__restrict __namelist,
  195. int (*__selector) (__const struct dirent *),
  196. int (*__cmp) (__const void *, __const void *)) __THROW,
  197. scandir64);
  198. # else
  199. # define scandir scandir64
  200. # endif
  201. # endif
  202. # if defined __USE_GNU && defined __USE_LARGEFILE64
  203. /* This function is like `scandir' but it uses the 64bit dirent structure.
  204. Please note that the CMP function must now work with struct dirent64 **. */
  205. extern int scandir64 (__const char *__restrict __dir,
  206. struct dirent64 ***__restrict __namelist,
  207. int (*__selector) (__const struct dirent64 *),
  208. int (*__cmp) (__const void *, __const void *)) __THROW;
  209. # endif
  210. /* Function to compare two `struct dirent's alphabetically. */
  211. # ifndef __USE_FILE_OFFSET64
  212. extern int alphasort (__const void *__e1, __const void *__e2)
  213. __THROW __attribute_pure__;
  214. # else
  215. # ifdef __REDIRECT
  216. extern int __REDIRECT (alphasort,
  217. (__const void *__e1, __const void *__e2)
  218. __THROW,
  219. alphasort64) __attribute_pure__;
  220. # else
  221. # define alphasort alphasort64
  222. # endif
  223. # endif
  224. # if defined __USE_GNU && defined __USE_LARGEFILE64
  225. extern int alphasort64 (__const void *__e1, __const void *__e2)
  226. __THROW __attribute_pure__;
  227. # endif
  228. # ifdef __USE_GNU
  229. /* Function to compare two `struct dirent's by name & version. */
  230. # ifndef __USE_FILE_OFFSET64
  231. extern int versionsort (__const void *__e1, __const void *__e2)
  232. __THROW __attribute_pure__;
  233. # else
  234. # ifdef __REDIRECT
  235. extern int __REDIRECT (versionsort,
  236. (__const void *__e1, __const void *__e2)
  237. __THROW,
  238. versionsort64) __attribute_pure__;
  239. # else
  240. # define versionsort versionsort64
  241. # endif
  242. # endif
  243. # ifdef __USE_LARGEFILE64
  244. extern int versionsort64 (__const void *__e1, __const void *__e2)
  245. __THROW __attribute_pure__;
  246. # endif
  247. # endif
  248. /* Read directory entries from FD into BUF, reading at most NBYTES.
  249. Reading starts at offset *BASEP, and *BASEP is updated with the new
  250. position after reading. Returns the number of bytes read; zero when at
  251. end of directory; or -1 for errors. */
  252. # ifndef __USE_FILE_OFFSET64
  253. extern __ssize_t getdirentries (int __fd, char *__restrict __buf,
  254. size_t __nbytes,
  255. __off_t *__restrict __basep) __THROW;
  256. # else
  257. # ifdef __REDIRECT
  258. extern __ssize_t __REDIRECT (getdirentries,
  259. (int __fd, char *__restrict __buf,
  260. size_t __nbytes,
  261. __off64_t *__restrict __basep) __THROW,
  262. getdirentries64);
  263. # else
  264. # define getdirentries getdirentries64
  265. # endif
  266. # endif
  267. # ifdef __USE_LARGEFILE64
  268. extern __ssize_t getdirentries64 (int __fd, char *__restrict __buf,
  269. size_t __nbytes,
  270. __off64_t *__restrict __basep) __THROW;
  271. # endif
  272. #endif /* Use BSD or misc. */
  273. __END_DECLS
  274. #endif /* dirent.h */