xref: /netbsd-src/include/dirent.h (revision c41a4eebefede43f6950f838a387dc18c6a431bf)
1 /*	$NetBSD: dirent.h,v 1.13 1997/10/10 13:18:37 fvdl Exp $	*/
2 
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. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by the University of
18  *	California, Berkeley and its contributors.
19  * 4. Neither the name of the University nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  *
35  *	@(#)dirent.h	8.2 (Berkeley) 7/28/94
36  */
37 
38 #ifndef _DIRENT_H_
39 #define _DIRENT_H_
40 
41 #include <sys/types.h>
42 
43 /*
44  * The kernel defines the format of directory entries returned by
45  * the getdirentries(2) system call.
46  */
47 #include <sys/dirent.h>
48 
49 #ifdef _POSIX_SOURCE
50 typedef void *	DIR;
51 #else
52 
53 #define	d_ino		d_fileno	/* backward compatibility */
54 
55 /* definitions for library routines operating on directories. */
56 #define	DIRBLKSIZ	1024
57 
58 /* structure describing an open directory. */
59 typedef struct _dirdesc {
60 	int	dd_fd;		/* file descriptor associated with directory */
61 	long	dd_loc;		/* offset in current buffer */
62 	long	dd_size;	/* amount of data returned by getdents */
63 	char	*dd_buf;	/* data buffer */
64 	int	dd_len;		/* size of data buffer */
65 	off_t	dd_seek;	/* magic cookie returned by getdents */
66 	long	dd_rewind;	/* magic cookie for rewinding */
67 	int	dd_flags;	/* flags for readdir */
68 } DIR;
69 
70 #define	dirfd(dirp)	((dirp)->dd_fd)
71 
72 /* flags for opendir2 */
73 #define DTF_HIDEW	0x0001	/* hide whiteout entries */
74 #define DTF_NODUP	0x0002	/* don't return duplicate names */
75 #define DTF_REWIND	0x0004	/* rewind after reading union stack */
76 #define __DTF_READALL	0x0008	/* everything has been read */
77 
78 #ifndef NULL
79 #define	NULL	0
80 #endif
81 
82 #endif /* _POSIX_SOURCE */
83 
84 #ifndef _KERNEL
85 
86 #include <sys/cdefs.h>
87 
88 __BEGIN_DECLS
89 DIR *opendir __P((const char *));
90 struct dirent *readdir __P((DIR *));
91 void rewinddir __P((DIR *));
92 int closedir __P((DIR *));
93 #ifndef _POSIX_SOURCE
94 DIR *__opendir2 __P((const char *, int));
95 long telldir __P((const DIR *));
96 void __seekdir __P((DIR *, long));
97 void seekdir __P((DIR *, long));
98 int scandir __P((const char *, struct dirent ***,
99     int (*)(struct dirent *), int (*)(const void *, const void *)));
100 int alphasort __P((const void *, const void *));
101 int getdirentries __P((int, char *, int, long *));
102 int getdents __P((int, char *, size_t));
103 #endif /* not POSIX */
104 __END_DECLS
105 
106 #endif /* !_KERNEL */
107 
108 #endif /* !_DIRENT_H_ */
109