include/dirent.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, 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 returned by
  63  * the getdirentries(2) system call.
  64  */
  65 #include <_types.h>
  66 #include <sys/dirent.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 by getdirentries */
  75         char    *dd_buf;        /* data buffer */
  76         int     dd_len;         /* size of data buffer */
  77         long    dd_seek;        /* magic cookie returned by getdirentries */
  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 #ifndef _POSIX_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 */
  97
  98 #ifndef KERNEL
  99
 100 #include <sys/cdefs.h>
 101
 102 __BEGIN_DECLS
 103 #ifndef _POSIX_C_SOURCE
 104 int alphasort(const void *, const void *);
 105 #endif /* not POSIX */
 106 int closedir(DIR *) __DARWIN_ALIAS(closedir);
 107 #ifndef _POSIX_C_SOURCE
 108 int getdirentries(int, char *, int, long *);
 109 #endif /* not POSIX */
 110 DIR *opendir(const char *) __DARWIN_ALIAS(opendir);
 111 #ifndef _POSIX_C_SOURCE
 112 DIR *__opendir2(const char *, int) __DARWIN_ALIAS(__opendir2);
 113 #endif /* not POSIX */
 114 struct dirent *readdir(DIR *);
 115 int readdir_r(DIR *, struct dirent *, struct dirent **);
 116 void rewinddir(DIR *) __DARWIN_ALIAS(rewinddir);
 117 #ifndef _POSIX_C_SOURCE
 118 int scandir(const char *, struct dirent ***,
 119     int (*)(struct dirent *), int (*)(const void *, const void *));
 120 #endif /* not POSIX */
 121 void seekdir(DIR *, long) __DARWIN_ALIAS(seekdir);
 122 long telldir(DIR *) __DARWIN_ALIAS(telldir);
 123 __END_DECLS
 124
 125 #endif /* !KERNEL */
 126
 127 #endif /* !_DIRENT_H_ */