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 #if __BSD_VISIBLE
  47
  48 /* definitions for library routines operating on directories. */
  49 #define DIRBLKSIZ       1024
  50
  51 struct _dirdesc;
  52 typedef struct _dirdesc DIR;
  53
  54 /* flags for opendir2 */
  55 #define DTF_HIDEW       0x0001  /* hide whiteout entries */
  56 #define DTF_NODUP       0x0002  /* don't return duplicate names */
  57 #define DTF_REWIND      0x0004  /* rewind after reading union stack */
  58 #define __DTF_READALL   0x0008  /* everything has been read */
  59 #define __DTF_SKIPME    0x0010  /* next entry to read not current entry */
  60
  61 #include <sys/_null.h>
  62
  63 #else /* !__BSD_VISIBLE */
  64
  65 typedef void *  DIR;
  66
  67 #endif /* __BSD_VISIBLE */
  68
  69 #ifndef _KERNEL
  70
  71 #include <sys/cdefs.h>
  72
  73 __BEGIN_DECLS
  74 DIR     *opendir(const char *);
  75 DIR     *fdopendir(int);
  76 struct dirent *
  77          readdir(DIR *);
  78 void     rewinddir(DIR *);
  79 int      closedir(DIR *);
  80 #if __POSIX_VISIBLE >= 199506 || __XSI_VISIBLE >= 500
  81 int      readdir_r(DIR *, struct dirent *, struct dirent **);
  82 #endif
  83 #if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE >= 700
  84 int      alphasort(const struct dirent **, const struct dirent **);
  85 int      dirfd(DIR *);
  86 int      scandir(const char *, struct dirent ***,
  87             int (*)(const struct dirent *),
  88             int (*)(const struct dirent **, const struct dirent **));
  89 #endif
  90 #if __XSI_VISIBLE
  91 void     seekdir(DIR *, long);
  92 long     telldir(DIR *);
  93 #endif
  94 #if __BSD_VISIBLE
  95 DIR     *__opendir2(const char *, int);
  96 DIR     *__fdopendir2(int, int);
  97 struct dirent *
  98          _readdir_unlocked(DIR *, int);
  99 void     _reclaim_telldir(DIR *);
 100 void     _seekdir(DIR *, long);
 101 int      getdents(int, char *, int);
 102 int      getdirentries(int, char *, int, long *);
 103 #endif /* __BSD_VISIBLE */
 104 __END_DECLS
 105
 106 #endif /* !_KERNEL */
 107
 108 #endif /* !_DIRENT_H_ */