xref: /freebsd/include/dirent.h (revision 952d112864d8008aa87278a30a539d888a8493cd)
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  */
35 
36 #ifndef _DIRENT_H_
37 #define _DIRENT_H_
38 
39 /*
40  * The kernel defines the format of directory entries returned by
41  * the getdirentries(2) system call.
42  */
43 #include <sys/dirent.h>
44 
45 #ifdef _POSIX_SOURCE
46 typedef void *	DIR;
47 #else
48 
49 #define	d_ino		d_fileno	/* backward compatibility */
50 
51 /* definitions for library routines operating on directories. */
52 #define	DIRBLKSIZ	1024
53 
54 /* structure describing an open directory. */
55 typedef struct _dirdesc {
56 	int	dd_fd;		/* file descriptor associated with directory */
57 	long	dd_loc;		/* offset in current buffer */
58 	long	dd_size;	/* amount of data returned by getdirentries */
59 	char	*dd_buf;	/* data buffer */
60 	int	dd_len;		/* size of data buffer */
61 	long	dd_seek;	/* magic cookie returned by getdirentries */
62 	long	dd_rewind;	/* magic cookie for rewinding */
63 	int	dd_flags;	/* flags for readdir */
64 } DIR;
65 
66 #define	dirfd(dirp)	((dirp)->dd_fd)
67 
68 /* flags for opendir2 */
69 #define DTF_HIDEW	0x0001	/* hide whiteout entries */
70 #define DTF_NODUP	0x0002	/* don't return duplicate names */
71 #define DTF_REWIND	0x0004	/* rewind after reading union stack */
72 #define __DTF_READALL	0x0008	/* everything has been read */
73 
74 #ifndef NULL
75 #define	NULL	0
76 #endif
77 
78 #endif /* _POSIX_SOURCE */
79 
80 #ifndef KERNEL
81 
82 #include <sys/cdefs.h>
83 
84 __BEGIN_DECLS
85 DIR *opendir __P((const char *));
86 struct dirent *readdir __P((DIR *));
87 void rewinddir __P((DIR *));
88 int closedir __P((DIR *));
89 #ifndef _POSIX_SOURCE
90 DIR *__opendir2 __P((const char *, int));
91 long telldir __P((const DIR *));
92 void seekdir __P((DIR *, long));
93 int scandir __P((const char *, struct dirent ***,
94     int (*)(struct dirent *), int (*)(const void *, const void *)));
95 int alphasort __P((const void *, const void *));
96 int getdirentries __P((int, char *, int, long *));
97 #endif /* not POSIX */
98 __END_DECLS
99 
100 #endif /* !KERNEL */
101 
102 #endif /* !_DIRENT_H_ */
103