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
  98 #endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
  99
 100 #ifndef KERNEL
 101
 102 __BEGIN_DECLS
 103
 104 //Begin-Libc
 105 #ifndef LIBC_ALIAS_CLOSEDIR
 106 //End-Libc
 107 int closedir(DIR *) __DARWIN_ALIAS(closedir);
 108 //Begin-Libc
 109 #else /* LIBC_ALIAS_CLOSEDIR */
 110 int closedir(DIR *) LIBC_ALIAS(closedir);
 111 #endif /* !LIBC_ALIAS_CLOSEDIR */
 112 //End-Libc
 113
 114 //Begin-Libc
 115 #ifndef LIBC_ALIAS_OPENDIR
 116 //End-Libc
 117 DIR *opendir(const char *) __DARWIN_ALIAS_I(opendir);
 118 //Begin-Libc
 119 #else /* LIBC_ALIAS_OPENDIR */
 120 DIR *opendir(const char *) LIBC_ALIAS_I(opendir);
 121 #endif /* !LIBC_ALIAS_OPENDIR */
 122 //End-Libc
 123
 124 struct dirent *readdir(DIR *) __DARWIN_INODE64(readdir);
 125 int readdir_r(DIR *, struct dirent *, struct dirent **) __DARWIN_INODE64(readdir_r);
 126
 127 //Begin-Libc
 128 #ifndef LIBC_ALIAS_REWINDDIR
 129 //End-Libc
 130 void rewinddir(DIR *) __DARWIN_ALIAS_I(rewinddir);
 131 //Begin-Libc
 132 #else /* LIBC_ALIAS_REWINDDIR */
 133 void rewinddir(DIR *) LIBC_ALIAS_I(rewinddir);
 134 #endif /* !LIBC_ALIAS_REWINDDIR */
 135 //End-Libc
 136
 137 //Begin-Libc
 138 #ifndef LIBC_ALIAS_SEEKDIR
 139 //End-Libc
 140 void seekdir(DIR *, long) __DARWIN_ALIAS_I(seekdir);
 141 //Begin-Libc
 142 #else /* LIBC_ALIAS_SEEKDIR */
 143 void seekdir(DIR *, long) LIBC_ALIAS_I(seekdir);
 144 #endif /* !LIBC_ALIAS_SEEKDIR */
 145 //End-Libc
 146
 147 //Begin-Libc
 148 #ifndef LIBC_ALIAS_TELLDIR
 149 //End-Libc
 150 long telldir(DIR *) __DARWIN_ALIAS_I(telldir);
 151 //Begin-Libc
 152 #else /* LIBC_ALIAS_TELLDIR */
 153 long telldir(DIR *) LIBC_ALIAS_I(telldir);
 154 #endif /* !LIBC_ALIAS_TELLDIR */
 155 //End-Libc
 156
 157 __END_DECLS
 158
 159
 160 /* Additional functionality provided by:
 161  * POSIX.1-2008
 162  */
 163
 164 #if __DARWIN_C_LEVEL >= 200809L
 165 __BEGIN_DECLS
 166
 167 //Begin-Libc
 168 #ifndef LIBC_ALIAS_OPENDIR
 169 //End-Libc
 170 __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0)
 171 DIR *fdopendir(int) __DARWIN_ALIAS_I(fdopendir);
 172 //Begin-Libc
 173 #else /* LIBC_ALIAS_OPENDIR */
 174 DIR *fdopendir(int) LIBC_ALIAS_I(fdopendir);
 175 #endif /* !LIBC_ALIAS_OPENDIR */
 176 //End-Libc
 177
 178 int alphasort(const struct dirent **, const struct dirent **) __DARWIN_INODE64(alphasort);
 179
 180 #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)
 181 #include <errno.h>
 182 #include <stdlib.h>
 183 #define dirfd(dirp) ({                         \
 184     DIR *_dirp = (dirp);                       \
 185     int ret = -1;                              \
 186     if (_dirp == NULL || _dirp->__dd_fd < 0)   \
 187         errno = EINVAL;                        \
 188     else                                       \
 189        ret = _dirp->__dd_fd;                   \
 190     ret;                                       \
 191 })
 192 #else
 193 int dirfd(DIR *dirp) __OSX_AVAILABLE_STARTING(__MAC_10_8, __IPHONE_6_0);
 194 #endif
 195
 196 int scandir(const char *, struct dirent ***,
 197     int (*)(const struct dirent *), int (*)(const struct dirent **, const struct dirent **)) __DARWIN_INODE64(scandir);
 198 #ifdef __BLOCKS__
 199 int scandir_b(const char *, struct dirent ***,
 200     int (^)(const struct dirent *), int (^)(const struct dirent **, const struct dirent **)) __DARWIN_INODE64(scandir_b) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
 201 #endif /* __BLOCKS__ */
 202
 203 __END_DECLS
 204 #endif /* __DARWIN_C_LEVEL >= 200809L */
 205
 206
 207 #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
 208 __BEGIN_DECLS
 209
 210 int getdirentries(int, char *, int, long *)
 211
 212 //Begin-Libc
 213 #ifndef __LIBC__
 214 //End-Libc
 215 #if __DARWIN_64_BIT_INO_T
 216 /*
 217  * getdirentries() doesn't work when 64-bit inodes is in effect, so we
 218  * generate a link error.
 219  */
 220                                                 __asm("_getdirentries_is_not_available_when_64_bit_inodes_are_in_effect")
 221 #else /* !__DARWIN_64_BIT_INO_T */
 222                                                 __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0,__MAC_10_6, __IPHONE_2_0,__IPHONE_2_0)
 223 #endif /* __DARWIN_64_BIT_INO_T */
 224 //Begin-Libc
 225 #endif /* !__LIBC__ */
 226 //End-Libc
 227 ;
 228
 229 //Begin-Libc
 230 #ifndef LIBC_ALIAS___OPENDIR2
 231 //End-Libc
 232 DIR *__opendir2(const char *, int) __DARWIN_ALIAS_I(__opendir2);
 233 //Begin-Libc
 234 #else /* LIBC_ALIAS___OPENDIR2 */
 235 DIR *__opendir2(const char *, int) LIBC_ALIAS_I(__opendir2);
 236 #endif /* !LIBC_ALIAS___OPENDIR2 */
 237 //End-Libc
 238
 239 __END_DECLS
 240 #endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
 241
 242 #endif /* !KERNEL */
 243
 244 #endif /* !_DIRENT_H_ */