lib/dirent.in.h

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