dirent/dirent.h

   1 /* Copyright (C) 1991, 92, 93, 94, 95, 96 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
  44 #include <direntry.h>
  45
  46 #if (defined(__USE_BSD) || defined(__USE_MISC)) && !defined(d_fileno)
  47 #define d_ino           d_fileno                 /* Backward compatibility.  */
  48 #endif
  49
  50 /* These macros extract size information from a `struct dirent *'.
  51    They may evaluate their argument multiple times, so it must not
  52    have side effects.  Each of these may involve a relatively costly
  53    call to `strlen' on some systems, so these values should be cached.
  54
  55    _D_EXACT_NAMLEN (DP) returns the length of DP->d_name, not including
  56    its terminating null character.
  57
  58    _D_ALLOC_NAMLEN (DP) returns a size at least (_D_EXACT_NAMLEN (DP) + 1);
  59    that is, the allocation size needed to hold the DP->d_name string.
  60    Use this macro when you don't need the exact length, just an upper bound.
  61    This macro is less likely to require calling `strlen' than _D_EXACT_NAMLEN.
  62    */
  63
  64 #ifdef _DIRENT_HAVE_D_NAMLEN
  65 #define _D_EXACT_NAMLEN(d) ((d)->d_namlen)
  66 #define _D_ALLOC_NAMLEN(d) (_D_EXACT_NAMLEN (d) + 1)
  67 #else
  68 #define _D_EXACT_NAMLEN(d) (strlen ((d)->d_name))
  69 #ifdef _DIRENT_HAVE_D_RECLEN
  70 #define _D_ALLOC_NAMLEN(d) (((char *) (d) + (d)->d_reclen) - &(d)->d_name[0])
  71 #else
  72 #define _D_ALLOC_NAMLEN(d) (sizeof (d)->d_name > 1 ? sizeof (d)->d_name : \
  73                             _D_EXACT_NAMLEN (d) + 1)
  74 #endif
  75 #endif
  76
  77
  78 #ifdef __USE_BSD
  79 /* File types for `d_type'.  */
  80 enum
  81   {
  82     DT_UNKNOWN = 0,
  83     DT_FIFO = 1,
  84     DT_CHR = 2,
  85     DT_DIR = 4,
  86     DT_BLK = 6,
  87     DT_REG = 8,
  88     DT_LNK = 10,
  89     DT_SOCK = 12
  90   };
  91
  92 /* Convert between stat structure types and directory types.  */
  93 #define IFTODT(mode)    (((mode) & 0170000) >> 12)
  94 #define DTTOIF(dirtype) ((dirtype) << 12)
  95 #endif
  96
  97
  98 /* This is the data type of directory stream objects.
  99    The actual structure is opaque to users.  */
 100 typedef struct __dirstream DIR;
 101
 102 /* Open a directory stream on NAME.
 103    Return a DIR stream on the directory, or NULL if it could not be opened.  */
 104 extern DIR *__opendir __P ((__const char *__name));
 105 extern DIR *opendir __P ((__const char *__name));
 106
 107 /* Close the directory stream DIRP.
 108    Return 0 if successful, -1 if not.  */
 109 extern int __closedir __P ((DIR *__dirp));
 110 extern int closedir __P ((DIR *__dirp));
 111
 112 /* Read a directory entry from DIRP.
 113    Return a pointer to a `struct dirent' describing the entry,
 114    or NULL for EOF or error.  The storage returned may be overwritten
 115    by a later readdir call on the same DIR stream.  */
 116 extern struct dirent *__readdir __P ((DIR *__dirp));
 117 extern struct dirent *readdir __P ((DIR *__dirp));
 118
 119 #ifdef __USE_REENTRANT
 120 /* Reentrant versio of `readdir'.  Return in RESULT a pointer to the
 121    next entry.  */
 122 extern int readdir_r __P ((DIR *__dirp, struct dirent *entry,
 123                            struct dirent **result));
 124 #endif
 125
 126 /* Rewind DIRP to the beginning of the directory.  */
 127 extern void rewinddir __P ((DIR *__dirp));
 128
 129 #if defined(__USE_BSD) || defined(__USE_MISC)
 130
 131 /* Return the file descriptor used by DIRP.  */
 132 extern int dirfd __P ((DIR *__dirp));
 133
 134 #if defined (__OPTIMIZE__) && defined (_DIR_dirfd)
 135 #define dirfd(dirp)     _DIR_dirfd (dirp)
 136 #endif
 137
 138 #ifndef MAXNAMLEN
 139 /* Get the definitions of the POSIX.1 limits.  */
 140 #include <posix1_lim.h>
 141
 142 /* `MAXNAMLEN' is the BSD name for what POSIX calls `NAME_MAX'.  */
 143 #ifdef  NAME_MAX
 144 #define MAXNAMLEN       NAME_MAX
 145 #else
 146 #define MAXNAMLEN       255
 147 #endif
 148 #endif
 149
 150 #include <gnu/types.h>
 151 #define __need_size_t
 152 #include <stddef.h>
 153
 154 /* Seek to position POS on DIRP.  */
 155 extern void seekdir __P ((DIR *__dirp, __off_t __pos));
 156
 157 /* Return the current position of DIRP.  */
 158 extern __off_t telldir __P ((DIR *__dirp));
 159
 160 /* Scan the directory DIR, calling SELECTOR on each directory entry.
 161    Entries for which SELECT returns nonzero are individually malloc'd,
 162    sorted using qsort with CMP, and collected in a malloc'd array in
 163    *NAMELIST.  Returns the number of entries selected, or -1 on error.  */
 164 extern int scandir __P ((__const char *__dir,
 165                          struct dirent ***__namelist,
 166                          int (*__selector) __P ((struct dirent *)),
 167                          int (*__cmp) __P ((__const __ptr_t,
 168                                             __const __ptr_t))));
 169
 170 /* Function to compare two `struct dirent's alphabetically.  */
 171 extern int alphasort __P ((__const __ptr_t, __const __ptr_t));
 172
 173
 174 /* Read directory entries from FD into BUF, reading at most NBYTES.
 175    Reading starts at offset *BASEP, and *BASEP is updated with the new
 176    position after reading.  Returns the number of bytes read; zero when at
 177    end of directory; or -1 for errors.  */
 178 extern __ssize_t __getdirentries __P ((int __fd, char *__buf,
 179                                        size_t __nbytes, __off_t *__basep));
 180 extern __ssize_t getdirentries __P ((int __fd, char *__buf,
 181                                      size_t __nbytes, __off_t *__basep));
 182
 183
 184 #endif /* Use BSD or misc.  */
 185
 186 __END_DECLS
 187
 188 #endif /* dirent.h  */