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