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 definitions of _GL_FUNCDECL_RPL etc. are copied here.  */
  33
  34 /* The definition of _GL_ARG_NONNULL is copied here.  */
  35
  36 /* The definition of _GL_WARN_ON_USE is copied here.  */
  37
  38
  39 /* Declare overridden functions.  */
  40
  41 #if @REPLACE_CLOSEDIR@
  42 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
  43 #  define closedir rpl_closedir
  44 # endif
  45 _GL_FUNCDECL_RPL (closedir, int, (DIR *) _GL_ARG_NONNULL ((1)));
  46 _GL_CXXALIAS_RPL (closedir, int, (DIR *));
  47 #else
  48 _GL_CXXALIAS_SYS (closedir, int, (DIR *));
  49 #endif
  50 _GL_CXXALIASWARN (closedir);
  51
  52 #if @GNULIB_DIRFD@
  53 /* Return the file descriptor associated with the given directory stream,
  54    or -1 if none exists.  */
  55 # if @REPLACE_DIRFD@
  56 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
  57 #   undef dirfd
  58 #   define dirfd rpl_dirfd
  59 #  endif
  60 _GL_FUNCDECL_RPL (dirfd, int, (DIR *) _GL_ARG_NONNULL ((1)));
  61 _GL_CXXALIAS_RPL (dirfd, int, (DIR *));
  62 # else
  63 #  if !(@HAVE_DECL_DIRFD@ || defined dirfd)
  64 _GL_FUNCDECL_SYS (dirfd, int, (DIR *) _GL_ARG_NONNULL ((1)));
  65 #  endif
  66 _GL_CXXALIAS_SYS (dirfd, int, (DIR *));
  67 # endif
  68 _GL_CXXALIASWARN (dirfd);
  69 #elif defined GNULIB_POSIXCHECK
  70 # undef dirfd
  71 # if HAVE_RAW_DECL_DIRFD
  72 _GL_WARN_ON_USE (dirfd, "dirfd is unportable - "
  73                  "use gnulib module dirfd for portability");
  74 # endif
  75 #endif
  76
  77 #if @GNULIB_FDOPENDIR@
  78 /* Open a directory stream visiting the given directory file
  79    descriptor.  Return NULL and set errno if fd is not visiting a
  80    directory.  On success, this function consumes fd (it will be
  81    implicitly closed either by this function or by a subsequent
  82    closedir).  */
  83 # if @REPLACE_FDOPENDIR@
  84 #  if !(defined __cplusplus && defined GNULIB_NAMESPACE)
  85 #   undef fdopendir
  86 #   define fdopendir rpl_fdopendir
  87 #  endif
  88 _GL_FUNCDECL_RPL (fdopendir, DIR *, (int fd));
  89 _GL_CXXALIAS_RPL (fdopendir, DIR *, (int fd));
  90 # else
  91 #  if !@HAVE_FDOPENDIR@ || !@HAVE_DECL_FDOPENDIR@
  92 _GL_FUNCDECL_SYS (fdopendir, DIR *, (int fd));
  93 #  endif
  94 _GL_CXXALIAS_SYS (fdopendir, DIR *, (int fd));
  95 # endif
  96 _GL_CXXALIASWARN (fdopendir);
  97 #elif defined GNULIB_POSIXCHECK
  98 # undef fdopendir
  99 # if HAVE_RAW_DECL_FDOPENDIR
 100 _GL_WARN_ON_USE (fdopendir, "fdopendir is unportable - "
 101                  "use gnulib module fdopendir for portability");
 102 # endif
 103 #endif
 104
 105 #if @REPLACE_OPENDIR@
 106 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
 107 #  define opendir rpl_opendir
 108 # endif
 109 _GL_FUNCDECL_RPL (opendir, DIR *, (const char *) _GL_ARG_NONNULL ((1)));
 110 _GL_CXXALIAS_RPL (opendir, DIR *, (const char *));
 111 #else
 112 _GL_CXXALIAS_SYS (opendir, DIR *, (const char *));
 113 #endif
 114 _GL_CXXALIASWARN (opendir);
 115
 116 #if @GNULIB_SCANDIR@
 117 /* Scan the directory DIR, calling FILTER on each directory entry.
 118    Entries for which FILTER returns nonzero are individually malloc'd,
 119    sorted using qsort with CMP, and collected in a malloc'd array in
 120    *NAMELIST.  Returns the number of entries selected, or -1 on error.  */
 121 # if !@HAVE_SCANDIR@
 122 _GL_FUNCDECL_SYS (scandir, int,
 123                   (const char *dir, struct dirent ***namelist,
 124                    int (*filter) (const struct dirent *),
 125                    int (*cmp) (const struct dirent **, const struct dirent **))
 126                   _GL_ARG_NONNULL ((1, 2, 4)));
 127 # endif
 128 /* Need to cast, because on glibc systems, the fourth parameter is
 129                         int (*cmp) (const void *, const void *).  */
 130 _GL_CXXALIAS_SYS_CAST (scandir, int,
 131                        (const char *dir, struct dirent ***namelist,
 132                         int (*filter) (const struct dirent *),
 133                         int (*cmp) (const struct dirent **, const struct dirent **)));
 134 _GL_CXXALIASWARN (scandir);
 135 #elif defined GNULIB_POSIXCHECK
 136 # undef scandir
 137 # if HAVE_RAW_DECL_SCANDIR
 138 _GL_WARN_ON_USE (scandir, "scandir is unportable - "
 139                  "use gnulib module scandir for portability");
 140 # endif
 141 #endif
 142
 143 #if @GNULIB_ALPHASORT@
 144 /* Compare two 'struct dirent' entries alphabetically.  */
 145 # if !@HAVE_ALPHASORT@
 146 _GL_FUNCDECL_SYS (alphasort, int,
 147                   (const struct dirent **, const struct dirent **)
 148                   _GL_ARG_NONNULL ((1, 2)));
 149 # endif
 150 /* Need to cast, because on glibc systems, the parameters are
 151                        (const void *, const void *).  */
 152 _GL_CXXALIAS_SYS_CAST (alphasort, int,
 153                        (const struct dirent **, const struct dirent **));
 154 _GL_CXXALIASWARN (alphasort);
 155 #elif defined GNULIB_POSIXCHECK
 156 # undef alphasort
 157 # if HAVE_RAW_DECL_ALPHASORT
 158 _GL_WARN_ON_USE (alphasort, "alphasort is unportable - "
 159                  "use gnulib module alphasort for portability");
 160 # endif
 161 #endif
 162
 163
 164 #endif /* _GL_DIRENT_H */
 165 #endif /* _GL_DIRENT_H */