include/dirent.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1989, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)dirent.h    8.2 (Berkeley) 7/28/94
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef _DIRENT_H_
  36 #define _DIRENT_H_
  37
  38 /*
  39  * The kernel defines the format of directory entries returned by
  40  * the getdirentries(2) system call.
  41  */
  42 #include <sys/cdefs.h>
  43 #include <sys/_types.h>
  44 #include <sys/dirent.h>
  45
  46 #if __XSI_VISIBLE
  47
  48 #ifndef _INO_T_DECLARED
  49 typedef __ino_t         ino_t;
  50 #define _INO_T_DECLARED
  51 #endif
  52
  53 /*
  54  * XXX this is probably illegal in the __XSI_VISIBLE case, but brings us closer
  55  * to the specification.
  56  */
  57 #define d_ino           d_fileno        /* backward and XSI compatibility */
  58
  59 #endif /* __XSI_VISIBLE */
  60
  61 #if __BSD_VISIBLE
  62
  63 #include <sys/_null.h>
  64
  65 /* definitions for library routines operating on directories. */
  66 #define DIRBLKSIZ       1024
  67
  68 struct _dirdesc;
  69 typedef struct _dirdesc DIR;
  70
  71 /* flags for opendir2 */
  72 #define DTF_HIDEW       0x0001  /* hide whiteout entries */
  73 #define DTF_NODUP       0x0002  /* don't return duplicate names */
  74 #define DTF_REWIND      0x0004  /* rewind after reading union stack */
  75 #define __DTF_READALL   0x0008  /* everything has been read */
  76 #define __DTF_SKIPREAD  0x0010  /* assume internal buffer is populated */
  77
  78 #else /* !__BSD_VISIBLE */
  79
  80 typedef void *  DIR;
  81
  82 #endif /* __BSD_VISIBLE */
  83
  84 #ifndef _KERNEL
  85
  86 __BEGIN_DECLS
  87 #if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE >= 700
  88 int      alphasort(const struct dirent **, const struct dirent **);
  89 int      dirfd(DIR *);
  90 #endif
  91 #if __BSD_VISIBLE
  92 DIR     *__opendir2(const char *, int);
  93 int      fdclosedir(DIR *);
  94 int      getdents(int, char *, int);
  95 int      getdirentries(int, char *, int, long *);
  96 #endif
  97 DIR     *opendir(const char *);
  98 DIR     *fdopendir(int);
  99 struct dirent *
 100          readdir(DIR *);
 101 #if __POSIX_VISIBLE >= 199506 || __XSI_VISIBLE >= 500
 102 int      readdir_r(DIR *, struct dirent *, struct dirent **);
 103 #endif
 104 void     rewinddir(DIR *);
 105 #if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE >= 700
 106 int      scandir(const char *, struct dirent ***,
 107             int (*)(const struct dirent *), int (*)(const struct dirent **,
 108             const struct dirent **));
 109 #ifdef __BLOCKS__
 110 int      scandir_b(const char *, struct dirent ***,
 111             int (^)(const struct dirent *),
 112             int (^)(const struct dirent **, const struct dirent **));
 113 #endif
 114 #endif
 115 #if __XSI_VISIBLE
 116 void     seekdir(DIR *, long);
 117 long     telldir(DIR *);
 118 #endif
 119 int      closedir(DIR *);
 120 __END_DECLS
 121
 122 #endif /* !_KERNEL */
 123
 124 #endif /* !_DIRENT_H_ */