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 /* The definition of GL_LINK_WARNING is copied here.  */
  30
  31 /* The definition of _GL_ARG_NONNULL is copied here.  */
  32
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 /* Declare overridden functions.  */
  39
  40 #if @REPLACE_CLOSEDIR@
  41 # define closedir rpl_closedir
  42 extern int closedir (DIR *) _GL_ARG_NONNULL ((1));
  43 #endif
  44
  45 #if @GNULIB_DIRFD@
  46 # if !@HAVE_DECL_DIRFD@ && !defined dirfd
  47 /* Return the file descriptor associated with the given directory stream,
  48    or -1 if none exists.  */
  49 extern int dirfd (DIR *dir) _GL_ARG_NONNULL ((1));
  50 # endif
  51 #elif defined GNULIB_POSIXCHECK
  52 # undef dirfd
  53 # define dirfd(d) \
  54     (GL_LINK_WARNING ("dirfd is unportable - " \
  55                       "use gnulib module dirfd for portability"), \
  56      dirfd (d))
  57 #endif
  58
  59 #if @GNULIB_FDOPENDIR@
  60 # if @REPLACE_FDOPENDIR@
  61 #  undef fdopendir
  62 #  define fdopendir rpl_fdopendir
  63 # endif
  64 # if !@HAVE_FDOPENDIR@ || @REPLACE_FDOPENDIR@
  65 /* Open a directory stream visiting the given directory file
  66    descriptor.  Return NULL and set errno if fd is not visiting a
  67    directory.  On success, this function consumes fd (it will be
  68    implicitly closed either by this function or by a subsequent
  69    closedir).  */
  70 extern DIR *fdopendir (int fd);
  71 # endif
  72 #elif defined GNULIB_POSIXCHECK
  73 # undef fdopendir
  74 # define fdopendir(f) \
  75     (GL_LINK_WARNING ("fdopendir is unportable - " \
  76                       "use gnulib module fdopendir for portability"), \
  77      fdopendir (f))
  78 #endif
  79
  80 #if @REPLACE_OPENDIR@
  81 # define opendir rpl_opendir
  82 extern DIR * opendir (const char *) _GL_ARG_NONNULL ((1));
  83 #endif
  84
  85 #if @GNULIB_SCANDIR@
  86 /* Scan the directory DIR, calling FILTER on each directory entry.
  87    Entries for which FILTER returns nonzero are individually malloc'd,
  88    sorted using qsort with CMP, and collected in a malloc'd array in
  89    *NAMELIST.  Returns the number of entries selected, or -1 on error.  */
  90 # if !@HAVE_SCANDIR@
  91 extern int scandir (const char *dir, struct dirent ***namelist,
  92                     int (*filter) (const struct dirent *),
  93                     int (*cmp) (const struct dirent **, const struct dirent **))
  94      _GL_ARG_NONNULL ((1, 2, 4));
  95 # endif
  96 #elif defined GNULIB_POSIXCHECK
  97 # undef scandir
  98 # define scandir(d,n,f,c) \
  99     (GL_LINK_WARNING ("scandir is unportable - " \
 100                       "use gnulib module scandir for portability"), \
 101      scandir (d, n, f, c))
 102 #endif
 103
 104 #if @GNULIB_ALPHASORT@
 105 /* Compare two 'struct dirent' entries alphabetically.  */
 106 # if !@HAVE_ALPHASORT@
 107 extern int alphasort (const struct dirent **, const struct dirent **)
 108      _GL_ARG_NONNULL ((1, 2));
 109 # endif
 110 #elif defined GNULIB_POSIXCHECK
 111 # undef alphasort
 112 # define alphasort(a,b) \
 113     (GL_LINK_WARNING ("alphasort is unportable - " \
 114                       "use gnulib module alphasort for portability"), \
 115      alphasort (a, b))
 116 #endif
 117
 118 #ifdef __cplusplus
 119 }
 120 #endif
 121
 122
 123 #endif /* _GL_DIRENT_H */
 124 #endif /* _GL_DIRENT_H */