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 <Availability.h>
  67
  68 struct _telldir;                /* forward reference */
  69
  70 /* structure describing an open directory. */
  71 typedef struct {
  72         int     __dd_fd;        /* file descriptor associated with directory */
  73         long    __dd_loc;       /* offset in current buffer */
  74         long    __dd_size;      /* amount of data returned */
  75         char    *__dd_buf;      /* data buffer */
  76         int     __dd_len;       /* size of data buffer */
  77         long    __dd_seek;      /* magic cookie returned */
  78         long    __dd_rewind;    /* magic cookie for rewinding */
  79         int     __dd_flags;     /* flags for readdir */
  80         __darwin_pthread_mutex_t __dd_lock; /* for thread locking */
  81         struct _telldir *__dd_td; /* telldir position recording */
  82 } DIR;
  83
  84 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
  85 /* definitions for library routines operating on directories. */
  86 #define DIRBLKSIZ       1024
  87
  88 #define dirfd(dirp)     ((dirp)->__dd_fd)
  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 /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
  97
  98 #ifndef KERNEL
  99
 100 #include <sys/cdefs.h>
 101
 102 __BEGIN_DECLS
 103 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 104 int alphasort(const void *, const void *) __DARWIN_INODE64(alphasort);
 105 #endif /* not POSIX */
 106 //Begin-Libc
 107 #ifndef LIBC_ALIAS_CLOSEDIR
 108 //End-Libc
 109 int closedir(DIR *) __DARWIN_ALIAS(closedir);
 110 //Begin-Libc
 111 #else /* LIBC_ALIAS_CLOSEDIR */
 112 int closedir(DIR *) LIBC_ALIAS(closedir);
 113 #endif /* !LIBC_ALIAS_CLOSEDIR */
 114 //End-Libc
 115 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 116 int getdirentries(int, char *, int, long *)
 117 //Begin-Libc
 118 #ifndef __LIBC__
 119 //End-Libc
 120 #if __DARWIN_64_BIT_INO_T
 121 /*
 122  * getdirentries() doesn't work when 64-bit inodes is in effect, so we
 123  * generate a link error.
 124  */
 125                                                 __asm("_getdirentries_is_not_available_when_64_bit_inodes_are_in_effect")
 126 #else /* !__DARWIN_64_BIT_INO_T */
 127                                                 __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0,__MAC_10_6, __IPHONE_2_0,__IPHONE_2_0)
 128 #endif /* __DARWIN_64_BIT_INO_T */
 129 //Begin-Libc
 130 #endif /* !__LIBC__ */
 131 //End-Libc
 132 ;
 133 #endif /* not POSIX */
 134 //Begin-Libc
 135 #ifndef LIBC_ALIAS_OPENDIR
 136 //End-Libc
 137 DIR *opendir(const char *) __DARWIN_ALIAS_I(opendir);
 138 //Begin-Libc
 139 #else /* LIBC_ALIAS_OPENDIR */
 140 DIR *opendir(const char *) LIBC_ALIAS_I(opendir);
 141 #endif /* !LIBC_ALIAS_OPENDIR */
 142 //End-Libc
 143 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 144 //Begin-Libc
 145 #ifndef LIBC_ALIAS___OPENDIR2
 146 //End-Libc
 147 DIR *__opendir2(const char *, int) __DARWIN_ALIAS_I(__opendir2);
 148 //Begin-Libc
 149 #else /* LIBC_ALIAS___OPENDIR2 */
 150 DIR *__opendir2(const char *, int) LIBC_ALIAS_I(__opendir2);
 151 #endif /* !LIBC_ALIAS___OPENDIR2 */
 152 //End-Libc
 153 #endif /* not POSIX */
 154 struct dirent *readdir(DIR *) __DARWIN_INODE64(readdir);
 155 int readdir_r(DIR *, struct dirent *, struct dirent **) __DARWIN_INODE64(readdir_r);
 156 //Begin-Libc
 157 #ifndef LIBC_ALIAS_REWINDDIR
 158 //End-Libc
 159 void rewinddir(DIR *) __DARWIN_ALIAS_I(rewinddir);
 160 //Begin-Libc
 161 #else /* LIBC_ALIAS_REWINDDIR */
 162 void rewinddir(DIR *) LIBC_ALIAS_I(rewinddir);
 163 #endif /* !LIBC_ALIAS_REWINDDIR */
 164 //End-Libc
 165 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
 166 int scandir(const char *, struct dirent ***,
 167     int (*)(struct dirent *), int (*)(const void *, const void *)) __DARWIN_INODE64(scandir);
 168 #ifdef __BLOCKS__
 169 int scandir_b(const char *, struct dirent ***,
 170     int (^)(struct dirent *), int (^)(const void *, const void *)) __DARWIN_INODE64(scandir_b) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
 171 #endif /* __BLOCKS__ */
 172 #endif /* not POSIX */
 173 //Begin-Libc
 174 #ifndef LIBC_ALIAS_SEEKDIR
 175 //End-Libc
 176 void seekdir(DIR *, long) __DARWIN_ALIAS_I(seekdir);
 177 //Begin-Libc
 178 #else /* LIBC_ALIAS_SEEKDIR */
 179 void seekdir(DIR *, long) LIBC_ALIAS_I(seekdir);
 180 #endif /* !LIBC_ALIAS_SEEKDIR */
 181 //End-Libc
 182 //Begin-Libc
 183 #ifndef LIBC_ALIAS_TELLDIR
 184 //End-Libc
 185 long telldir(DIR *) __DARWIN_ALIAS_I(telldir);
 186 //Begin-Libc
 187 #else /* LIBC_ALIAS_TELLDIR */
 188 long telldir(DIR *) LIBC_ALIAS_I(telldir);
 189 #endif /* !LIBC_ALIAS_TELLDIR */
 190 //End-Libc
 191 __END_DECLS
 192
 193 #endif /* !KERNEL */
 194
 195 #endif /* !_DIRENT_H_ */