dirent.h 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319
  1. /* Copyright (C) 1991-2000, 2003, 2004 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. /* Convert between stat structure types and directory types. */
  98. # define IFTODT(mode) (((mode) & 0170000) >> 12)
  99. # define DTTOIF(dirtype) ((dirtype) << 12)
  100. #endif
  101. /* This is the data type of directory stream objects.
  102. The actual structure is opaque to users. */
  103. typedef struct __dirstream DIR;
  104. /* Open a directory stream on NAME.
  105. Return a DIR stream on the directory, or NULL if it could not be opened.
  106. This function is a possible cancellation point and therefore not
  107. marked with __THROW. */
  108. extern DIR *opendir (__const char *__name) __nonnull ((1));
  109. libc_hidden_proto(opendir)
  110. /* Close the directory stream DIRP.
  111. Return 0 if successful, -1 if not.
  112. This function is a possible cancellation point and therefore not
  113. marked with __THROW. */
  114. extern int closedir (DIR *__dirp) __nonnull ((1));
  115. libc_hidden_proto(closedir)
  116. /* Read a directory entry from DIRP. Return a pointer to a `struct
  117. dirent' describing the entry, or NULL for EOF or error. The
  118. storage returned may be overwritten by a later readdir call on the
  119. same DIR stream.
  120. If the Large File Support API is selected we have to use the
  121. appropriate interface.
  122. This function is a possible cancellation point and therefore not
  123. marked with __THROW. */
  124. #ifndef __USE_FILE_OFFSET64
  125. extern struct dirent *readdir (DIR *__dirp) __nonnull ((1));
  126. libc_hidden_proto(readdir)
  127. #else
  128. # ifdef __REDIRECT
  129. extern struct dirent *__REDIRECT (readdir, (DIR *__dirp), readdir64)
  130. __nonnull ((1));
  131. # else
  132. # define readdir readdir64
  133. # endif
  134. #endif
  135. #ifdef __USE_LARGEFILE64
  136. extern struct dirent64 *readdir64 (DIR *__dirp) __nonnull ((1));
  137. libc_hidden_proto(readdir64)
  138. #endif
  139. #if defined __USE_POSIX || defined __USE_MISC
  140. /* Reentrant version of `readdir'. Return in RESULT a pointer to the
  141. next entry.
  142. This function is a possible cancellation point and therefore not
  143. marked with __THROW. */
  144. # ifndef __USE_FILE_OFFSET64
  145. extern int readdir_r (DIR *__restrict __dirp,
  146. struct dirent *__restrict __entry,
  147. struct dirent **__restrict __result)
  148. __nonnull ((1, 2, 3));
  149. libc_hidden_proto(readdir_r)
  150. # else
  151. # ifdef __REDIRECT
  152. extern int __REDIRECT (readdir_r,
  153. (DIR *__restrict __dirp,
  154. struct dirent *__restrict __entry,
  155. struct dirent **__restrict __result),
  156. readdir64_r) __nonnull ((1, 2, 3));
  157. # else
  158. # define readdir_r readdir64_r
  159. # endif
  160. # endif
  161. # ifdef __USE_LARGEFILE64
  162. extern int readdir64_r (DIR *__restrict __dirp,
  163. struct dirent64 *__restrict __entry,
  164. struct dirent64 **__restrict __result)
  165. __nonnull ((1, 2, 3));
  166. libc_hidden_proto(readdir64_r)
  167. # endif
  168. #endif /* POSIX or misc */
  169. /* Rewind DIRP to the beginning of the directory. */
  170. extern void rewinddir (DIR *__dirp) __THROW __nonnull ((1));
  171. #if defined __USE_BSD || defined __USE_MISC || defined __USE_XOPEN
  172. # include <bits/types.h>
  173. /* Seek to position POS on DIRP. */
  174. extern void seekdir (DIR *__dirp, long int __pos) __THROW __nonnull ((1));
  175. /* Return the current position of DIRP. */
  176. extern long int telldir (DIR *__dirp) __THROW __nonnull ((1));
  177. #endif
  178. #if defined __USE_BSD || defined __USE_MISC
  179. /* Return the file descriptor used by DIRP. */
  180. extern int dirfd (DIR *__dirp) __THROW __nonnull ((1));
  181. libc_hidden_proto(dirfd)
  182. # if 0 /* defined __OPTIMIZE__ && defined _DIR_dirfd */
  183. # define dirfd(dirp) _DIR_dirfd (dirp)
  184. # endif
  185. # ifndef MAXNAMLEN
  186. /* Get the definitions of the POSIX.1 limits. */
  187. # include <bits/posix1_lim.h>
  188. /* `MAXNAMLEN' is the BSD name for what POSIX calls `NAME_MAX'. */
  189. # ifdef NAME_MAX
  190. # define MAXNAMLEN NAME_MAX
  191. # else
  192. # define MAXNAMLEN 255
  193. # endif
  194. # endif
  195. # define __need_size_t
  196. # include <stddef.h>
  197. /* Scan the directory DIR, calling SELECTOR on each directory entry.
  198. Entries for which SELECT returns nonzero are individually malloc'd,
  199. sorted using qsort with CMP, and collected in a malloc'd array in
  200. *NAMELIST. Returns the number of entries selected, or -1 on error. */
  201. # ifndef __USE_FILE_OFFSET64
  202. extern int scandir (__const char *__restrict __dir,
  203. struct dirent ***__restrict __namelist,
  204. int (*__selector) (__const struct dirent *),
  205. int (*__cmp) (__const void *, __const void *))
  206. __nonnull ((1, 2));
  207. # else
  208. # ifdef __REDIRECT
  209. extern int __REDIRECT (scandir,
  210. (__const char *__restrict __dir,
  211. struct dirent ***__restrict __namelist,
  212. int (*__selector) (__const struct dirent *),
  213. int (*__cmp) (__const void *, __const void *)),
  214. scandir64) __nonnull ((1, 2));
  215. # else
  216. # define scandir scandir64
  217. # endif
  218. # endif
  219. # if defined __USE_GNU && defined __USE_LARGEFILE64
  220. /* This function is like `scandir' but it uses the 64bit dirent structure.
  221. Please note that the CMP function must now work with struct dirent64 **. */
  222. extern int scandir64 (__const char *__restrict __dir,
  223. struct dirent64 ***__restrict __namelist,
  224. int (*__selector) (__const struct dirent64 *),
  225. int (*__cmp) (__const void *, __const void *))
  226. __nonnull ((1, 2));
  227. # endif
  228. /* Function to compare two `struct dirent's alphabetically. */
  229. # ifndef __USE_FILE_OFFSET64
  230. extern int alphasort (__const void *__e1, __const void *__e2)
  231. __THROW __attribute_pure__ __nonnull ((1, 2));
  232. # else
  233. # ifdef __REDIRECT
  234. extern int __REDIRECT (alphasort,
  235. (__const void *__e1, __const void *__e2),
  236. alphasort64) __attribute_pure__ __nonnull ((1, 2));
  237. # else
  238. # define alphasort alphasort64
  239. # endif
  240. # endif
  241. # if defined __USE_GNU && defined __USE_LARGEFILE64
  242. extern int alphasort64 (__const void *__e1, __const void *__e2)
  243. __THROW __attribute_pure__ __nonnull ((1, 2));
  244. # endif
  245. /* Function to compare two `struct dirent's alphabetically. */
  246. # ifndef __USE_FILE_OFFSET64
  247. extern int versionsort (__const void *__e1, __const void *__e2)
  248. __THROW __attribute_pure__ __nonnull ((1, 2));
  249. # else
  250. # ifdef __REDIRECT
  251. extern int __REDIRECT (versionsort,
  252. (__const void *__e1, __const void *__e2),
  253. versionsort64) __attribute_pure__ __nonnull ((1, 2));
  254. # else
  255. # define versionsort versionsort64
  256. # endif
  257. # endif
  258. # if defined __USE_GNU && defined __USE_LARGEFILE64
  259. extern int versionsort64 (__const void *__e1, __const void *__e2)
  260. __THROW __attribute_pure__ __nonnull ((1, 2));
  261. # endif
  262. #endif /* Use BSD or misc. */
  263. __END_DECLS
  264. #endif /* dirent.h */