lib/dirent.in.h

   1 /* A GNU-like <dirent.h>.
   2    Copyright (C) 2006-2010 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program 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
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  16
  17 #ifndef _GL_DIRENT_H
  18
  19 #if __GNUC__ >= 3
  20 @PRAGMA_SYSTEM_HEADER@
  21 #endif
  22
  23 /* The include_next requires a split double-inclusion guard.  */
  24 #@INCLUDE_NEXT@ @NEXT_DIRENT_H@
  25
  26 #ifndef _GL_DIRENT_H
  27 #define _GL_DIRENT_H
  28
  29 /* Get ino_t.  Needed on some systems, including glibc 2.8.  */
  30 #include <sys/types.h>
  31
  32 /* The definition of _GL_ARG_NONNULL is copied here.  */
  33
  34 /* The definition of _GL_WARN_ON_USE is copied here.  */
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 /* Declare overridden functions.  */
  41
  42 #if @REPLACE_CLOSEDIR@
  43 # define closedir rpl_closedir
  44 extern int closedir (DIR *) _GL_ARG_NONNULL ((1));
  45 #endif
  46
  47 #if @GNULIB_DIRFD@
  48 # if !@HAVE_DECL_DIRFD@ && !defined dirfd
  49 /* Return the file descriptor associated with the given directory stream,
  50    or -1 if none exists.  */
  51 extern int dirfd (DIR *dir) _GL_ARG_NONNULL ((1));
  52 # endif
  53 #elif defined GNULIB_POSIXCHECK
  54 # undef dirfd
  55 # if HAVE_RAW_DECL_DIRFD
  56 _GL_WARN_ON_USE (dirfd, "dirfd is unportable - "
  57                  "use gnulib module dirfd for portability");
  58 # endif
  59 #endif
  60
  61 #if @GNULIB_FDOPENDIR@
  62 # if @REPLACE_FDOPENDIR@
  63 #  undef fdopendir
  64 #  define fdopendir rpl_fdopendir
  65 # endif
  66 # if !@HAVE_FDOPENDIR@ || @REPLACE_FDOPENDIR@
  67 /* Open a directory stream visiting the given directory file
  68    descriptor.  Return NULL and set errno if fd is not visiting a
  69    directory.  On success, this function consumes fd (it will be
  70    implicitly closed either by this function or by a subsequent
  71    closedir).  */
  72 extern DIR *fdopendir (int fd);
  73 # endif
  74 #elif defined GNULIB_POSIXCHECK
  75 # undef fdopendir
  76 # if HAVE_RAW_DECL_FDOPENDIR
  77 _GL_WARN_ON_USE (fdopendir, "fdopendir is unportable - "
  78                  "use gnulib module fdopendir for portability");
  79 # endif
  80 #endif
  81
  82 #if @REPLACE_OPENDIR@
  83 # define opendir rpl_opendir
  84 extern DIR * opendir (const char *) _GL_ARG_NONNULL ((1));
  85 #endif
  86
  87 #if @GNULIB_SCANDIR@
  88 /* Scan the directory DIR, calling FILTER on each directory entry.
  89    Entries for which FILTER returns nonzero are individually malloc'd,
  90    sorted using qsort with CMP, and collected in a malloc'd array in
  91    *NAMELIST.  Returns the number of entries selected, or -1 on error.  */
  92 # if !@HAVE_SCANDIR@
  93 extern int scandir (const char *dir, struct dirent ***namelist,
  94                     int (*filter) (const struct dirent *),
  95                     int (*cmp) (const struct dirent **, const struct dirent **))
  96      _GL_ARG_NONNULL ((1, 2, 4));
  97 # endif
  98 #elif defined GNULIB_POSIXCHECK
  99 # undef scandir
 100 # if HAVE_RAW_DECL_SCANDIR
 101 _GL_WARN_ON_USE (scandir, "scandir is unportable - "
 102                  "use gnulib module scandir for portability");
 103 # endif
 104 #endif
 105
 106 #if @GNULIB_ALPHASORT@
 107 /* Compare two 'struct dirent' entries alphabetically.  */
 108 # if !@HAVE_ALPHASORT@
 109 extern int alphasort (const struct dirent **, const struct dirent **)
 110      _GL_ARG_NONNULL ((1, 2));
 111 # endif
 112 #elif defined GNULIB_POSIXCHECK
 113 # undef alphasort
 114 # if HAVE_RAW_DECL_ALPHASORT
 115 _GL_WARN_ON_USE (alphasort, "alphasort is unportable - "
 116                  "use gnulib module alphasort for portability");
 117 # endif
 118 #endif
 119
 120 #ifdef __cplusplus
 121 }
 122 #endif
 123
 124
 125 #endif /* _GL_DIRENT_H */
 126 #endif /* _GL_DIRENT_H */