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 !@HAVE_FDOPENDIR@
  59 /* Open a directory stream visiting the given directory file
  60    descriptor.  Return NULL and set errno if fd is not visiting a
  61    directory.  On success, this function consumes fd (it will be
  62    implicitly closed either by this function or by a subsequent
  63    closedir).  */
  64 extern DIR *fdopendir (int fd);
  65 # endif
  66 #elif defined GNULIB_POSIXCHECK
  67 # undef fdopendir
  68 # define fdopendir(f) \
  69     (GL_LINK_WARNING ("fdopendir is unportable - " \
  70                       "use gnulib module fdopendir for portability"), \
  71      fdopendir (f))
  72 #endif
  73
  74 #if @REPLACE_OPENDIR@
  75 # define opendir rpl_opendir
  76 extern DIR * opendir (const char *);
  77 #endif
  78
  79 #if @GNULIB_SCANDIR@
  80 /* Scan the directory DIR, calling FILTER on each directory entry.
  81    Entries for which FILTER returns nonzero are individually malloc'd,
  82    sorted using qsort with CMP, and collected in a malloc'd array in
  83    *NAMELIST.  Returns the number of entries selected, or -1 on error.  */
  84 # if !@HAVE_SCANDIR@
  85 extern int scandir (const char *dir, struct dirent ***namelist,
  86                     int (*filter) (const struct dirent *),
  87                     int (*cmp) (const struct dirent **, const struct dirent **));
  88 # endif
  89 #elif defined GNULIB_POSIXCHECK
  90 # undef scandir
  91 # define scandir(d,n,f,c) \
  92     (GL_LINK_WARNING ("scandir is unportable - " \
  93                       "use gnulib module scandir for portability"), \
  94      scandir (d, n, f, c))
  95 #endif
  96
  97 #if @GNULIB_ALPHASORT@
  98 /* Compare two 'struct dirent' entries alphabetically.  */
  99 # if !@HAVE_ALPHASORT@
 100 extern int alphasort (const struct dirent **, const struct dirent **);
 101 # endif
 102 #elif defined GNULIB_POSIXCHECK
 103 # undef alphasort
 104 # define alphasort(a,b) \
 105     (GL_LINK_WARNING ("alphasort is unportable - " \
 106                       "use gnulib module alphasort for portability"), \
 107      alphasort (a, b))
 108 #endif
 109
 110 #ifdef __cplusplus
 111 }
 112 #endif
 113
 114
 115 #endif /* _GL_DIRENT_H */
 116 #endif /* _GL_DIRENT_H */