include/dirent.h

   1 /*
   2  * Copyright (c) 2000, 2002-2008 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*-
  24  * Copyright (c) 1989, 1993
  25  *      The Regents of the University of California.  All rights reserved.
  26  *
  27  * Redistribution and use in source and binary forms, with or without
  28  * modification, are permitted provided that the following conditions
  29  * are met:
  30  * 1. Redistributions of source code must retain the above copyright
  31  *    notice, this list of conditions and the following disclaimer.
  32  * 2. Redistributions in binary form must reproduce the above copyright
  33  *    notice, this list of conditions and the following disclaimer in the
  34  *    documentation and/or other materials provided with the distribution.
  35  * 3. All advertising materials mentioning features or use of this software
  36  *    must display the following acknowledgement:
  37  *      This product includes software developed by the University of
  38  *      California, Berkeley and its contributors.
  39  * 4. Neither the name of the University nor the names of its contributors
  40  *    may be used to endorse or promote products derived from this software
  41  *    without specific prior written permission.
  42  *
  43  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  44  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  45  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  46  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  47  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  48  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  49  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  50  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  51  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  52  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  53  * SUCH DAMAGE.
  54  *
  55  *      @(#)dirent.h    8.2 (Berkeley) 7/28/94
  56  */
  57
  58 #ifndef _DIRENT_H_
  59 #define _DIRENT_H_
  60
  61 /*
  62  * The kernel defines the format of directory entries
  63  */
  64 #include <_types.h>
  65 #include <sys/dirent.h>
  66 #include <sys/cdefs.h>
  67 #include <Availability.h>
  68 #include <sys/_pthread/_pthread_types.h> /* __darwin_pthread_mutex_t */
  69
  70 struct _telldir;                /* forward reference */
  71
  72 /* structure describing an open directory. */
  73 typedef struct {
  74         int     __dd_fd;        /* file descriptor associated with directory */
  75         long    __dd_loc;       /* offset in current buffer */
  76         long    __dd_size;      /* amount of data returned */
  77         char    *__dd_buf;      /* data buffer */
  78         int     __dd_len;       /* size of data buffer */
  79         long    __dd_seek;      /* magic cookie returned */
  80         __unused long   __padding; /* (__dd_rewind space left for bincompat) */
  81         int     __dd_flags;     /* flags for readdir */
  82         __darwin_pthread_mutex_t __dd_lock; /* for thread locking */
  83         struct _telldir *__dd_td; /* telldir position recording */
  84 } DIR;
  85
  86 #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
  87
  88 /* definitions for library routines operating on directories. */
  89 #define DIRBLKSIZ       1024
  90
  91 /* flags for opendir2 */
  92 #define DTF_HIDEW       0x0001  /* hide whiteout entries */
  93 #define DTF_NODUP       0x0002  /* don't return duplicate names */
  94 #define DTF_REWIND      0x0004  /* rewind after reading union stack */
  95 #define __DTF_READALL   0x0008  /* everything has been read */
  96 #define __DTF_SKIPREAD  0x0010  /* assume internal buffer is populated */
  97 #define __DTF_ATEND     0x0020  /* there's nothing more to read in the kernel */
  98
  99 #endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
 100
 101 #ifndef KERNEL
 102
 103 __BEGIN_DECLS
 104
 105 //Begin-Libc
 106 #ifndef LIBC_ALIAS_CLOSEDIR
 107 //End-Libc
 108 int closedir(DIR *) __DARWIN_ALIAS(closedir);
 109 //Begin-Libc
 110 #else /* LIBC_ALIAS_CLOSEDIR */
 111 int closedir(DIR *) LIBC_ALIAS(closedir);
 112 #endif /* !LIBC_ALIAS_CLOSEDIR */
 113 //End-Libc
 114
 115 //Begin-Libc
 116 #ifndef LIBC_ALIAS_OPENDIR
 117 //End-Libc
 118 DIR *opendir(const char *) __DARWIN_ALIAS_I(opendir);
 119 //Begin-Libc
 120 #else /* LIBC_ALIAS_OPENDIR */
 121 DIR *opendir(const char *) LIBC_ALIAS_I(opendir);
 122 #endif /* !LIBC_ALIAS_OPENDIR */
 123 //End-Libc
 124
 125 struct dirent *readdir(DIR *) __DARWIN_INODE64(readdir);
 126 int readdir_r(DIR *, struct dirent *, struct dirent **) __DARWIN_INODE64(readdir_r);
 127
 128 //Begin-Libc
 129 #ifndef LIBC_ALIAS_REWINDDIR
 130 //End-Libc
 131 void rewinddir(DIR *) __DARWIN_ALIAS_I(rewinddir);
 132 //Begin-Libc
 133 #else /* LIBC_ALIAS_REWINDDIR */
 134 void rewinddir(DIR *) LIBC_ALIAS_I(rewinddir);
 135 #endif /* !LIBC_ALIAS_REWINDDIR */
 136 //End-Libc
 137
 138 //Begin-Libc
 139 #ifndef LIBC_ALIAS_SEEKDIR
 140 //End-Libc
 141 void seekdir(DIR *, long) __DARWIN_ALIAS_I(seekdir);
 142 //Begin-Libc
 143 #else /* LIBC_ALIAS_SEEKDIR */
 144 void seekdir(DIR *, long) LIBC_ALIAS_I(seekdir);
 145 #endif /* !LIBC_ALIAS_SEEKDIR */
 146 //End-Libc
 147
 148 //Begin-Libc
 149 #ifndef LIBC_ALIAS_TELLDIR
 150 //End-Libc
 151 long telldir(DIR *) __DARWIN_ALIAS_I(telldir);
 152 //Begin-Libc
 153 #else /* LIBC_ALIAS_TELLDIR */
 154 long telldir(DIR *) LIBC_ALIAS_I(telldir);
 155 #endif /* !LIBC_ALIAS_TELLDIR */
 156 //End-Libc
 157
 158 __END_DECLS
 159
 160
 161 /* Additional functionality provided by:
 162  * POSIX.1-2008
 163  */
 164
 165 #if __DARWIN_C_LEVEL >= 200809L
 166 __BEGIN_DECLS
 167
 168 //Begin-Libc
 169 #ifndef LIBC_ALIAS_OPENDIR
 170 //End-Libc
 171 __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0)
 172 DIR *fdopendir(int) __DARWIN_ALIAS_I(fdopendir);
 173 //Begin-Libc
 174 #else /* LIBC_ALIAS_OPENDIR */
 175 DIR *fdopendir(int) LIBC_ALIAS_I(fdopendir);
 176 #endif /* !LIBC_ALIAS_OPENDIR */
 177 //End-Libc
 178
 179 int alphasort(const struct dirent **, const struct dirent **) __DARWIN_INODE64(alphasort);
 180
 181 #if (defined(__MAC_OS_X_VERSION_MIN_REQUIRED) && __MAC_OS_X_VERSION_MIN_REQUIRED < __MAC_10_8) || (defined(__IPHONE_OS_VERSION_MIN_REQUIRED) && __IPHONE_OS_VERSION_MIN_REQUIRED < __IPHONE_6_0)
 182 #include <errno.h>
 183 #include <stdlib.h>
 184 #define dirfd(dirp) ({                         \
 185     DIR *_dirp = (dirp);                       \
 186     int ret = -1;                              \
 187     if (_dirp == NULL || _dirp->__dd_fd < 0)   \
 188         errno = EINVAL;                        \
 189     else                                       \
 190        ret = _dirp->__dd_fd;                   \
 191     ret;                                       \
 192 })
 193 #else
 194 int dirfd(DIR *dirp) __OSX_AVAILABLE_STARTING(__MAC_10_8, __IPHONE_6_0);
 195 #endif
 196
 197 int scandir(const char *, struct dirent ***,
 198     int (*)(const struct dirent *), int (*)(const struct dirent **, const struct dirent **)) __DARWIN_INODE64(scandir);
 199 #ifdef __BLOCKS__
 200 #if __has_attribute(noescape)
 201 #define __scandir_noescape __attribute__((__noescape__))
 202 #else
 203 #define __scandir_noescape
 204 #endif
 205
 206 int scandir_b(const char *, struct dirent ***,
 207     int (^)(const struct dirent *) __scandir_noescape,
 208     int (^)(const struct dirent **, const struct dirent **) __scandir_noescape)
 209     __DARWIN_INODE64(scandir_b) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
 210 #endif /* __BLOCKS__ */
 211
 212 __END_DECLS
 213 #endif /* __DARWIN_C_LEVEL >= 200809L */
 214
 215
 216 #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
 217 __BEGIN_DECLS
 218
 219 int getdirentries(int, char *, int, long *)
 220
 221 //Begin-Libc
 222 #ifndef __LIBC__
 223 //End-Libc
 224 #if __DARWIN_64_BIT_INO_T
 225 /*
 226  * getdirentries() doesn't work when 64-bit inodes is in effect, so we
 227  * generate a link error.
 228  */
 229                                                 __asm("_getdirentries_is_not_available_when_64_bit_inodes_are_in_effect")
 230 #else /* !__DARWIN_64_BIT_INO_T */
 231                                                 __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0,__MAC_10_6, __IPHONE_2_0,__IPHONE_2_0)
 232 #endif /* __DARWIN_64_BIT_INO_T */
 233 //Begin-Libc
 234 #endif /* !__LIBC__ */
 235 //End-Libc
 236 ;
 237
 238 //Begin-Libc
 239 #ifndef LIBC_ALIAS___OPENDIR2
 240 //End-Libc
 241 DIR *__opendir2(const char *, int) __DARWIN_ALIAS_I(__opendir2);
 242 //Begin-Libc
 243 #else /* LIBC_ALIAS___OPENDIR2 */
 244 DIR *__opendir2(const char *, int) LIBC_ALIAS_I(__opendir2);
 245 #endif /* !LIBC_ALIAS___OPENDIR2 */
 246 //End-Libc
 247
 248 __END_DECLS
 249 #endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
 250
 251 #endif /* !KERNEL */
 252
 253 #endif /* !_DIRENT_H_ */