include/dirent.h

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