dirent/dirent.h

   1 /* Copyright (C) 1991,92,93,94,95,96,97,98 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3
   4    The GNU C Library is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Library General Public License as
   6    published by the Free Software Foundation; either version 2 of the
   7    License, or (at your option) any later version.
   8
   9    The GNU C Library 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 GNU
  12    Library General Public License for more details.
  13
  14    You should have received a copy of the GNU Library General Public
  15    License along with the GNU C Library; see the file COPYING.LIB.  If not,
  16    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17    Boston, MA 02111-1307, USA.  */
  18
  19 /*
  20  *      POSIX Standard: 5.1.2 Directory Operations      <dirent.h>
  21  */
  22
  23 #ifndef _DIRENT_H
  24
  25 #define _DIRENT_H       1
  26 #include <features.h>
  27
  28 __BEGIN_DECLS
  29
  30 #include <gnu/types.h>
  31
  32 /* This file defines `struct dirent'.
  33
  34    It defines the macro `_DIRENT_HAVE_D_NAMLEN' iff there is a `d_namlen'
  35    member that gives the length of `d_name'.
  36
  37    It defines the macro `_DIRENT_HAVE_D_RECLEN' iff there is a `d_reclen'
  38    member that gives the size of the entire directory entry.
  39
  40    It defines the macro `_DIRENT_HAVE_D_OFF' iff there is a `d_off'
  41    member that gives the file offset of the next directory entry.
  42
  43    It defines the macro `_DIRENT_HAVE_D_TYPE' iff there is a `d_type'
  44    member that gives the type of the file.
  45  */
  46
  47 #include <direntry.h>
  48
  49 #if (defined __USE_BSD || defined __USE_MISC) && !defined d_fileno
  50 # define d_ino  d_fileno                 /* Backward compatibility.  */
  51 #endif
  52
  53 /* These macros extract size information from a `struct dirent *'.
  54    They may evaluate their argument multiple times, so it must not
  55    have side effects.  Each of these may involve a relatively costly
  56    call to `strlen' on some systems, so these values should be cached.
  57
  58    _D_EXACT_NAMLEN (DP) returns the length of DP->d_name, not including
  59    its terminating null character.
  60
  61    _D_ALLOC_NAMLEN (DP) returns a size at least (_D_EXACT_NAMLEN (DP) + 1);
  62    that is, the allocation size needed to hold the DP->d_name string.
  63    Use this macro when you don't need the exact length, just an upper bound.
  64    This macro is less likely to require calling `strlen' than _D_EXACT_NAMLEN.
  65    */
  66
  67 #ifdef _DIRENT_HAVE_D_NAMLEN
  68 # define _D_EXACT_NAMLEN(d) ((d)->d_namlen)
  69 # define _D_ALLOC_NAMLEN(d) (_D_EXACT_NAMLEN (d) + 1)
  70 #else
  71 # define _D_EXACT_NAMLEN(d) (strlen ((d)->d_name))
  72 # ifdef _DIRENT_HAVE_D_RECLEN
  73 #  define _D_ALLOC_NAMLEN(d) (((char *) (d) + (d)->d_reclen) - &(d)->d_name[0])
  74 # else
  75 #  define _D_ALLOC_NAMLEN(d) (sizeof (d)->d_name > 1 ? sizeof (d)->d_name : \
  76                               _D_EXACT_NAMLEN (d) + 1)
  77 # endif
  78 #endif
  79
  80
  81 #ifdef __USE_BSD
  82 /* File types for `d_type'.  */
  83 enum
  84   {
  85     DT_UNKNOWN = 0,
  86 #define DT_UNKNOWN      DT_UNKNOWN
  87     DT_FIFO = 1,
  88 #define DT_FIFO         DT_FIFO
  89     DT_CHR = 2,
  90 #define DT_CHR          DT_CHR
  91     DT_DIR = 4,
  92 #define DT_DIR          DT_DIR
  93     DT_BLK = 6,
  94 #define DT_BLK          DT_BLK
  95     DT_REG = 8,
  96 #define DT_REG          DT_REG
  97     DT_LNK = 10,
  98 #define DT_LNK          DT_LNK
  99     DT_SOCK = 12
 100 #define DT_SOCK         DT_SOCK
 101   };
 102
 103 /* Convert between stat structure types and directory types.  */
 104 # define IFTODT(mode)   (((mode) & 0170000) >> 12)
 105 # define DTTOIF(dirtype)        ((dirtype) << 12)
 106 #endif
 107
 108
 109 /* This is the data type of directory stream objects.
 110    The actual structure is opaque to users.  */
 111 typedef struct __dirstream DIR;
 112
 113 /* Open a directory stream on NAME.
 114    Return a DIR stream on the directory, or NULL if it could not be opened.  */
 115 extern DIR *__opendir __P ((__const char *__name));
 116 extern DIR *opendir __P ((__const char *__name));
 117
 118 /* Close the directory stream DIRP.
 119    Return 0 if successful, -1 if not.  */
 120 extern int __closedir __P ((DIR *__dirp));
 121 extern int closedir __P ((DIR *__dirp));
 122
 123 /* Read a directory entry from DIRP.
 124    Return a pointer to a `struct dirent' describing the entry,
 125    or NULL for EOF or error.  The storage returned may be overwritten
 126    by a later readdir call on the same DIR stream.  */
 127 extern struct dirent *__readdir __P ((DIR *__dirp));
 128 extern struct dirent *readdir __P ((DIR *__dirp));
 129
 130 #if defined __USE_POSIX || defined __USE_MISC
 131 /* Reentrant version of `readdir'.  Return in RESULT a pointer to the
 132    next entry.  */
 133 extern int __readdir_r __P ((DIR *__dirp, struct dirent *__entry,
 134                              struct dirent **__result));
 135 extern int readdir_r __P ((DIR *__dirp, struct dirent *__entry,
 136                            struct dirent **__result));
 137 #endif  /* POSIX or misc */
 138
 139 /* Rewind DIRP to the beginning of the directory.  */
 140 extern void rewinddir __P ((DIR *__dirp));
 141
 142 #if defined __USE_BSD || defined __USE_MISC
 143
 144 /* Return the file descriptor used by DIRP.  */
 145 extern int dirfd __P ((DIR *__dirp));
 146
 147 # if defined __OPTIMIZE__ && defined _DIR_dirfd
 148 #  define dirfd(dirp)   _DIR_dirfd (dirp)
 149 # endif
 150
 151 # ifndef MAXNAMLEN
 152 /* Get the definitions of the POSIX.1 limits.  */
 153 #  include <posix1_lim.h>
 154
 155 /* `MAXNAMLEN' is the BSD name for what POSIX calls `NAME_MAX'.  */
 156 #  ifdef NAME_MAX
 157 #   define MAXNAMLEN    NAME_MAX
 158 #  else
 159 #   define MAXNAMLEN    255
 160 #  endif
 161 # endif
 162
 163 # include <gnu/types.h>
 164 # define __need_size_t
 165 # include <stddef.h>
 166
 167 /* Seek to position POS on DIRP.  */
 168 extern void seekdir __P ((DIR *__dirp, __off_t __pos));
 169
 170 /* Return the current position of DIRP.  */
 171 extern __off_t telldir __P ((DIR *__dirp));
 172
 173 /* Scan the directory DIR, calling SELECTOR on each directory entry.
 174    Entries for which SELECT returns nonzero are individually malloc'd,
 175    sorted using qsort with CMP, and collected in a malloc'd array in
 176    *NAMELIST.  Returns the number of entries selected, or -1 on error.  */
 177 extern int scandir __P ((__const char *__dir,
 178                          struct dirent ***__namelist,
 179                          int (*__selector) __P ((struct dirent *)),
 180                          int (*__cmp) __P ((__const __ptr_t,
 181                                             __const __ptr_t))));
 182
 183 /* Function to compare two `struct dirent's alphabetically.  */
 184 extern int alphasort __P ((__const __ptr_t, __const __ptr_t));
 185
 186
 187 /* Read directory entries from FD into BUF, reading at most NBYTES.
 188    Reading starts at offset *BASEP, and *BASEP is updated with the new
 189    position after reading.  Returns the number of bytes read; zero when at
 190    end of directory; or -1 for errors.  */
 191 extern __ssize_t __getdirentries __P ((int __fd, char *__buf,
 192                                        size_t __nbytes, __off_t *__basep));
 193 extern __ssize_t getdirentries __P ((int __fd, char *__buf,
 194                                      size_t __nbytes, __off_t *__basep));
 195
 196
 197 #endif /* Use BSD or misc.  */
 198
 199 __END_DECLS
 200
 201 #endif /* dirent.h  */