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
  69 struct _telldir;                /* forward reference */
  70
  71 /* structure describing an open directory. */
  72 typedef struct {
  73         int     __dd_fd;        /* file descriptor associated with directory */
  74         long    __dd_loc;       /* offset in current buffer */
  75         long    __dd_size;      /* amount of data returned */
  76         char    *__dd_buf;      /* data buffer */
  77         int     __dd_len;       /* size of data buffer */
  78         long    __dd_seek;      /* magic cookie returned */
  79         long    __dd_rewind;    /* magic cookie for rewinding */
  80         int     __dd_flags;     /* flags for readdir */
  81         __darwin_pthread_mutex_t __dd_lock; /* for thread locking */
  82         struct _telldir *__dd_td; /* telldir position recording */
  83 } DIR;
  84
  85 #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
  86
  87 /* definitions for library routines operating on directories. */
  88 #define DIRBLKSIZ       1024
  89
  90 /* flags for opendir2 */
  91 #define DTF_HIDEW       0x0001  /* hide whiteout entries */
  92 #define DTF_NODUP       0x0002  /* don't return duplicate names */
  93 #define DTF_REWIND      0x0004  /* rewind after reading union stack */
  94 #define __DTF_READALL   0x0008  /* everything has been read */
  95
  96 #endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
  97
  98 #ifndef KERNEL
  99
 100 __BEGIN_DECLS
 101
 102 //Begin-Libc
 103 #ifndef LIBC_ALIAS_CLOSEDIR
 104 //End-Libc
 105 int closedir(DIR *) __DARWIN_ALIAS(closedir);
 106 //Begin-Libc
 107 #else /* LIBC_ALIAS_CLOSEDIR */
 108 int closedir(DIR *) LIBC_ALIAS(closedir);
 109 #endif /* !LIBC_ALIAS_CLOSEDIR */
 110 //End-Libc
 111
 112 //Begin-Libc
 113 #ifndef LIBC_ALIAS_OPENDIR
 114 //End-Libc
 115 DIR *opendir(const char *) __DARWIN_ALIAS_I(opendir);
 116 //Begin-Libc
 117 #else /* LIBC_ALIAS_OPENDIR */
 118 DIR *opendir(const char *) LIBC_ALIAS_I(opendir);
 119 #endif /* !LIBC_ALIAS_OPENDIR */
 120 //End-Libc
 121
 122 struct dirent *readdir(DIR *) __DARWIN_INODE64(readdir);
 123 int readdir_r(DIR *, struct dirent *, struct dirent **) __DARWIN_INODE64(readdir_r);
 124
 125 //Begin-Libc
 126 #ifndef LIBC_ALIAS_REWINDDIR
 127 //End-Libc
 128 void rewinddir(DIR *) __DARWIN_ALIAS_I(rewinddir);
 129 //Begin-Libc
 130 #else /* LIBC_ALIAS_REWINDDIR */
 131 void rewinddir(DIR *) LIBC_ALIAS_I(rewinddir);
 132 #endif /* !LIBC_ALIAS_REWINDDIR */
 133 //End-Libc
 134
 135 //Begin-Libc
 136 #ifndef LIBC_ALIAS_SEEKDIR
 137 //End-Libc
 138 void seekdir(DIR *, long) __DARWIN_ALIAS_I(seekdir);
 139 //Begin-Libc
 140 #else /* LIBC_ALIAS_SEEKDIR */
 141 void seekdir(DIR *, long) LIBC_ALIAS_I(seekdir);
 142 #endif /* !LIBC_ALIAS_SEEKDIR */
 143 //End-Libc
 144
 145 //Begin-Libc
 146 #ifndef LIBC_ALIAS_TELLDIR
 147 //End-Libc
 148 long telldir(DIR *) __DARWIN_ALIAS_I(telldir);
 149 //Begin-Libc
 150 #else /* LIBC_ALIAS_TELLDIR */
 151 long telldir(DIR *) LIBC_ALIAS_I(telldir);
 152 #endif /* !LIBC_ALIAS_TELLDIR */
 153 //End-Libc
 154
 155 __END_DECLS
 156
 157
 158 /* Additional functionality provided by:
 159  * POSIX.1-2008
 160  */
 161
 162 #if __DARWIN_C_LEVEL >= 200809L
 163 __BEGIN_DECLS
 164
 165 //Begin-Libc
 166 #ifndef LIBC_ALIAS_OPENDIR
 167 //End-Libc
 168 __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0)
 169 DIR *fdopendir(int) __DARWIN_ALIAS_I(fdopendir);
 170 //Begin-Libc
 171 #else /* LIBC_ALIAS_OPENDIR */
 172 DIR *fdopendir(int) LIBC_ALIAS_I(fdopendir);
 173 #endif /* !LIBC_ALIAS_OPENDIR */
 174 //End-Libc
 175
 176 int alphasort(const struct dirent **, const struct dirent **) __DARWIN_INODE64(alphasort);
 177
 178 #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)
 179 #include <errno.h>
 180 #include <stdlib.h>
 181 #define dirfd(dirp) ({                         \
 182     DIR *_dirp = (dirp);                       \
 183     int ret = -1;                              \
 184     if (_dirp == NULL || _dirp->__dd_fd < 0)   \
 185         errno = EINVAL;                        \
 186     else                                       \
 187        ret = _dirp->__dd_fd;                   \
 188     ret;                                       \
 189 })
 190 #else
 191 int dirfd(DIR *dirp) __OSX_AVAILABLE_STARTING(__MAC_10_8, __IPHONE_6_0);
 192 #endif
 193
 194 int scandir(const char *, struct dirent ***,
 195     int (*)(const struct dirent *), int (*)(const struct dirent **, const struct dirent **)) __DARWIN_INODE64(scandir);
 196 #ifdef __BLOCKS__
 197 int scandir_b(const char *, struct dirent ***,
 198     int (^)(const struct dirent *), int (^)(const struct dirent **, const struct dirent **)) __DARWIN_INODE64(scandir_b) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
 199 #endif /* __BLOCKS__ */
 200
 201 __END_DECLS
 202 #endif /* __DARWIN_C_LEVEL >= 200809L */
 203
 204
 205 #if __DARWIN_C_LEVEL >= __DARWIN_C_FULL
 206 __BEGIN_DECLS
 207
 208 int getdirentries(int, char *, int, long *)
 209
 210 //Begin-Libc
 211 #ifndef __LIBC__
 212 //End-Libc
 213 #if __DARWIN_64_BIT_INO_T
 214 /*
 215  * getdirentries() doesn't work when 64-bit inodes is in effect, so we
 216  * generate a link error.
 217  */
 218                                                 __asm("_getdirentries_is_not_available_when_64_bit_inodes_are_in_effect")
 219 #else /* !__DARWIN_64_BIT_INO_T */
 220                                                 __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0,__MAC_10_6, __IPHONE_2_0,__IPHONE_2_0)
 221 #endif /* __DARWIN_64_BIT_INO_T */
 222 //Begin-Libc
 223 #endif /* !__LIBC__ */
 224 //End-Libc
 225 ;
 226
 227 //Begin-Libc
 228 #ifndef LIBC_ALIAS___OPENDIR2
 229 //End-Libc
 230 DIR *__opendir2(const char *, int) __DARWIN_ALIAS_I(__opendir2);
 231 //Begin-Libc
 232 #else /* LIBC_ALIAS___OPENDIR2 */
 233 DIR *__opendir2(const char *, int) LIBC_ALIAS_I(__opendir2);
 234 #endif /* !LIBC_ALIAS___OPENDIR2 */
 235 //End-Libc
 236
 237 __END_DECLS
 238 #endif /* __DARWIN_C_LEVEL >= __DARWIN_C_FULL */
 239
 240 #endif /* !KERNEL */
 241
 242 #endif /* !_DIRENT_H_ */