include/dirent.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /*-
  26  * Copyright (c) 1989, 1993
  27  *      The Regents of the University of California.  All rights reserved.
  28  *
  29  * Redistribution and use in source and binary forms, with or without
  30  * modification, are permitted provided that the following conditions
  31  * are met:
  32  * 1. Redistributions of source code must retain the above copyright
  33  *    notice, this list of conditions and the following disclaimer.
  34  * 2. Redistributions in binary form must reproduce the above copyright
  35  *    notice, this list of conditions and the following disclaimer in the
  36  *    documentation and/or other materials provided with the distribution.
  37  * 3. All advertising materials mentioning features or use of this software
  38  *    must display the following acknowledgement:
  39  *      This product includes software developed by the University of
  40  *      California, Berkeley and its contributors.
  41  * 4. Neither the name of the University nor the names of its contributors
  42  *    may be used to endorse or promote products derived from this software
  43  *    without specific prior written permission.
  44  *
  45  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  46  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  47  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  48  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  49  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  50  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  51  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  52  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  53  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  54  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  55  * SUCH DAMAGE.
  56  *
  57  *      @(#)dirent.h    8.2 (Berkeley) 7/28/94
  58  */
  59
  60 #ifndef _DIRENT_H_
  61 #define _DIRENT_H_
  62
  63 /*
  64  * The kernel defines the format of directory entries returned by
  65  * the getdirentries(2) system call.
  66  */
  67 #include <_types.h>
  68 #include <sys/dirent.h>
  69
  70 #ifdef _POSIX_SOURCE
  71 typedef void *  DIR;
  72 #else
  73 #include <sys/types.h>
  74
  75 /* definitions for library routines operating on directories. */
  76 #define DIRBLKSIZ       1024
  77
  78 struct _telldir;                /* see telldir.h */
  79
  80 /* structure describing an open directory. */
  81 typedef struct _dirdesc {
  82         int     dd_fd;          /* file descriptor associated with directory */
  83         long    dd_loc;         /* offset in current buffer */
  84         long    dd_size;        /* amount of data returned by getdirentries */
  85         char    *dd_buf;        /* data buffer */
  86         int     dd_len;         /* size of data buffer */
  87         long    dd_seek;        /* magic cookie returned by getdirentries */
  88         long    dd_rewind;      /* magic cookie for rewinding */
  89         int     dd_flags;       /* flags for readdir */
  90         pthread_mutex_t dd_lock; /* for thread locking */
  91         struct _telldir *dd_td; /* telldir position recording */
  92 } DIR;
  93
  94 #define dirfd(dirp)     ((dirp)->dd_fd)
  95
  96 /* flags for opendir2 */
  97 #define DTF_HIDEW       0x0001  /* hide whiteout entries */
  98 #define DTF_NODUP       0x0002  /* don't return duplicate names */
  99 #define DTF_REWIND      0x0004  /* rewind after reading union stack */
 100 #define __DTF_READALL   0x0008  /* everything has been read */
 101
 102 #ifndef NULL
 103 #define NULL __OSX_NULL
 104 #endif /* ! NULL */
 105
 106 #endif /* ! _POSIX_SOURCE */
 107
 108 #ifndef KERNEL
 109
 110 #include <sys/cdefs.h>
 111
 112 __BEGIN_DECLS
 113 #ifndef _POSIX_SOURCE
 114 int alphasort(const void *, const void *);
 115 #endif /* not POSIX */
 116 int closedir(DIR *);
 117 #ifndef _POSIX_SOURCE
 118 int getdirentries(int, char *, int, long *);
 119 #endif /* not POSIX */
 120 DIR *opendir(const char *);
 121 #ifndef _POSIX_SOURCE
 122 DIR *__opendir2(const char *, int);
 123 #endif /* not POSIX */
 124 struct dirent *readdir(DIR *);
 125 int readdir_r(DIR *, struct dirent *, struct dirent **);
 126 void rewinddir(DIR *);
 127 #ifndef _POSIX_SOURCE
 128 int scandir(const char *, struct dirent ***,
 129     int (*)(struct dirent *), int (*)(const void *, const void *));
 130 #endif /* not POSIX */
 131 void seekdir(DIR *, long);
 132 long telldir(DIR *);
 133 __END_DECLS
 134
 135 #endif /* !KERNEL */
 136
 137 #endif /* !_DIRENT_H_ */