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