bsd/include/dirent.h

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