dirent.h
上传用户:szlgq88
上传日期:2009-04-28
资源大小:48287k
文件大小:10k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  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. /* Close the directory stream DIRP.
  110.    Return 0 if successful, -1 if not.
  111.    This function is a possible cancellation point and therefore not
  112.    marked with __THROW.  */
  113. extern int closedir (DIR *__dirp) __nonnull ((1));
  114. /* Read a directory entry from DIRP.  Return a pointer to a `struct
  115.    dirent' describing the entry, or NULL for EOF or error.  The
  116.    storage returned may be overwritten by a later readdir call on the
  117.    same DIR stream.
  118.    If the Large File Support API is selected we have to use the
  119.    appropriate interface.
  120.    This function is a possible cancellation point and therefore not
  121.    marked with __THROW.  */
  122. #ifndef __USE_FILE_OFFSET64
  123. extern struct dirent *readdir (DIR *__dirp) __nonnull ((1));
  124. #else
  125. # ifdef __REDIRECT
  126. extern struct dirent *__REDIRECT (readdir, (DIR *__dirp), readdir64)
  127.      __nonnull ((1));
  128. # else
  129. #  define readdir readdir64
  130. # endif
  131. #endif
  132. #ifdef __USE_LARGEFILE64
  133. extern struct dirent64 *readdir64 (DIR *__dirp) __nonnull ((1));
  134. #endif
  135. #if defined __USE_POSIX || defined __USE_MISC
  136. /* Reentrant version of `readdir'.  Return in RESULT a pointer to the
  137.    next entry.
  138.    This function is a possible cancellation point and therefore not
  139.    marked with __THROW.  */
  140. # ifndef __USE_FILE_OFFSET64
  141. extern int readdir_r (DIR *__restrict __dirp,
  142.       struct dirent *__restrict __entry,
  143.       struct dirent **__restrict __result)
  144.      __nonnull ((1, 2, 3));
  145. # else
  146. #  ifdef __REDIRECT
  147. extern int __REDIRECT (readdir_r,
  148.        (DIR *__restrict __dirp,
  149. struct dirent *__restrict __entry,
  150. struct dirent **__restrict __result),
  151.        readdir64_r) __nonnull ((1, 2, 3));
  152. #  else
  153. #   define readdir_r readdir64_r
  154. #  endif
  155. # endif
  156. # ifdef __USE_LARGEFILE64
  157. extern int readdir64_r (DIR *__restrict __dirp,
  158. struct dirent64 *__restrict __entry,
  159. struct dirent64 **__restrict __result)
  160.      __nonnull ((1, 2, 3));
  161. # endif
  162. #endif /* POSIX or misc */
  163. /* Rewind DIRP to the beginning of the directory.  */
  164. extern void rewinddir (DIR *__dirp) __THROW __nonnull ((1));
  165. #if defined __USE_BSD || defined __USE_MISC || defined __USE_XOPEN
  166. # include <bits/types.h>
  167. /* Seek to position POS on DIRP.  */
  168. extern void seekdir (DIR *__dirp, long int __pos) __THROW __nonnull ((1));
  169. /* Return the current position of DIRP.  */
  170. extern long int telldir (DIR *__dirp) __THROW __nonnull ((1));
  171. #endif
  172. #if defined __USE_BSD || defined __USE_MISC
  173. /* Return the file descriptor used by DIRP.  */
  174. extern int dirfd (DIR *__dirp) __THROW __nonnull ((1));
  175. # if defined __OPTIMIZE__ && defined _DIR_dirfd
  176. #  define dirfd(dirp) _DIR_dirfd (dirp)
  177. # endif
  178. # ifndef MAXNAMLEN
  179. /* Get the definitions of the POSIX.1 limits.  */
  180. #  include <bits/posix1_lim.h>
  181. /* `MAXNAMLEN' is the BSD name for what POSIX calls `NAME_MAX'.  */
  182. #  ifdef NAME_MAX
  183. #   define MAXNAMLEN NAME_MAX
  184. #  else
  185. #   define MAXNAMLEN 255
  186. #  endif
  187. # endif
  188. # define __need_size_t
  189. # include <stddef.h>
  190. /* Scan the directory DIR, calling SELECTOR on each directory entry.
  191.    Entries for which SELECT returns nonzero are individually malloc'd,
  192.    sorted using qsort with CMP, and collected in a malloc'd array in
  193.    *NAMELIST.  Returns the number of entries selected, or -1 on error.  */
  194. # ifndef __USE_FILE_OFFSET64
  195. extern int scandir (__const char *__restrict __dir,
  196.     struct dirent ***__restrict __namelist,
  197.     int (*__selector) (__const struct dirent *),
  198.     int (*__cmp) (__const void *, __const void *))
  199.      __nonnull ((1, 2));
  200. # else
  201. #  ifdef __REDIRECT
  202. extern int __REDIRECT (scandir,
  203.        (__const char *__restrict __dir,
  204. struct dirent ***__restrict __namelist,
  205. int (*__selector) (__const struct dirent *),
  206. int (*__cmp) (__const void *, __const void *)),
  207.        scandir64) __nonnull ((1, 2));
  208. #  else
  209. #   define scandir scandir64
  210. #  endif
  211. # endif
  212. # if defined __USE_GNU && defined __USE_LARGEFILE64
  213. /* This function is like `scandir' but it uses the 64bit dirent structure.
  214.    Please note that the CMP function must now work with struct dirent64 **.  */
  215. extern int scandir64 (__const char *__restrict __dir,
  216.       struct dirent64 ***__restrict __namelist,
  217.       int (*__selector) (__const struct dirent64 *),
  218.       int (*__cmp) (__const void *, __const void *))
  219.      __nonnull ((1, 2));
  220. # endif
  221. /* Function to compare two `struct dirent's alphabetically.  */
  222. # ifndef __USE_FILE_OFFSET64
  223. extern int alphasort (__const void *__e1, __const void *__e2)
  224.      __THROW __attribute_pure__ __nonnull ((1, 2));
  225. # else
  226. #  ifdef __REDIRECT
  227. extern int __REDIRECT_NTH (alphasort,
  228.    (__const void *__e1, __const void *__e2),
  229.    alphasort64) __attribute_pure__ __nonnull ((1, 2));
  230. #  else
  231. #   define alphasort alphasort64
  232. #  endif
  233. # endif
  234. # if defined __USE_GNU && defined __USE_LARGEFILE64
  235. extern int alphasort64 (__const void *__e1, __const void *__e2)
  236.      __THROW __attribute_pure__ __nonnull ((1, 2));
  237. # endif
  238. # ifdef __USE_GNU
  239. /* Function to compare two `struct dirent's by name & version.  */
  240. #  ifndef __USE_FILE_OFFSET64
  241. extern int versionsort (__const void *__e1, __const void *__e2)
  242.      __THROW __attribute_pure__ __nonnull ((1, 2));
  243. #  else
  244. #   ifdef __REDIRECT
  245. extern int __REDIRECT_NTH (versionsort,
  246.    (__const void *__e1, __const void *__e2),
  247.    versionsort64)
  248.      __attribute_pure__ __nonnull ((1, 2));
  249. #   else
  250. #    define versionsort versionsort64
  251. #   endif
  252. #  endif
  253. #  ifdef __USE_LARGEFILE64
  254. extern int versionsort64 (__const void *__e1, __const void *__e2)
  255.      __THROW __attribute_pure__ __nonnull ((1, 2));
  256. #  endif
  257. # endif
  258. /* Read directory entries from FD into BUF, reading at most NBYTES.
  259.    Reading starts at offset *BASEP, and *BASEP is updated with the new
  260.    position after reading.  Returns the number of bytes read; zero when at
  261.    end of directory; or -1 for errors.  */
  262. # ifndef __USE_FILE_OFFSET64
  263. extern __ssize_t getdirentries (int __fd, char *__restrict __buf,
  264. size_t __nbytes,
  265. __off_t *__restrict __basep)
  266.      __THROW __nonnull ((2, 4));
  267. # else
  268. #  ifdef __REDIRECT
  269. extern __ssize_t __REDIRECT_NTH (getdirentries,
  270.  (int __fd, char *__restrict __buf,
  271.   size_t __nbytes,
  272.   __off64_t *__restrict __basep),
  273.  getdirentries64) __nonnull ((2, 4));
  274. #  else
  275. #   define getdirentries getdirentries64
  276. #  endif
  277. # endif
  278. # ifdef __USE_LARGEFILE64
  279. extern __ssize_t getdirentries64 (int __fd, char *__restrict __buf,
  280.   size_t __nbytes,
  281.   __off64_t *__restrict __basep)
  282.      __THROW __nonnull ((2, 4));
  283. # endif
  284. #endif /* Use BSD or misc.  */
  285. __END_DECLS
  286. #endif /* dirent.h  */