xref: /openbsd/include/dirent.h (revision 404b540a)
1 /*	$OpenBSD: dirent.h,v 1.18 2007/06/05 18:11:48 kurt Exp $	*/
2 /*	$NetBSD: dirent.h,v 1.9 1995/03/26 20:13:37 jtc Exp $	*/
3 
4 /*-
5  * Copyright (c) 1989, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *	@(#)dirent.h	8.2 (Berkeley) 7/28/94
33  */
34 
35 #ifndef _DIRENT_H_
36 #define _DIRENT_H_
37 
38 #include <sys/cdefs.h>
39 
40 /*
41  * POSIX doesn't mandate this, but X/Open XPG 4.2 does.
42  */
43 #if __BSD_VISIBLE || __XPG_VISIBLE >= 420
44 #include <sys/types.h>
45 #endif
46 
47 /*
48  * The kernel defines the format of directory entries returned by
49  * the getdirentries(2) system call.
50  */
51 #include <sys/dirent.h>
52 
53 #if __BSD_VISIBLE || __XPG_VISIBLE
54 #define	d_ino		d_fileno	/* backward compatibility */
55 #endif
56 
57 #if __BSD_VISIBLE
58 
59 /* definitions for library routines operating on directories. */
60 #define	DIRBLKSIZ	1024
61 
62 struct _telldir;
63 /* structure describing an open directory. */
64 typedef struct _dirdesc {
65 	int	dd_fd;		/* file descriptor associated with directory */
66 	long	dd_loc;		/* offset in current buffer */
67 	long	dd_size;	/* amount of data returned by getdirentries */
68 	char	*dd_buf;	/* data buffer */
69 	int	dd_len;		/* size of data buffer */
70 	long	dd_seek;	/* magic cookie returned by getdirentries */
71 	long	dd_rewind;	/* magic cookie for rewinding */
72 	int	dd_flags;	/* flags for readdir */
73 	struct _telldir *dd_td; /* telldir position recording */
74 	void	*dd_lock;	/* mutex to protect struct */
75 } DIR;
76 
77 #define	dirfd(dirp)	((dirp)->dd_fd)
78 
79 /* flags for opendir2 */
80 #define DTF_NODUP	0x0002	/* don't return duplicate names */
81 
82 #ifndef NULL
83 #ifdef 	__GNUG__
84 #define	NULL	__null
85 #else
86 #define	NULL	0L
87 #endif /* __GNUG__ */
88 #endif /* !NULL */
89 
90 #else /* !__BSD_VISIBLE */
91 
92 typedef void *	DIR;
93 
94 #endif /* !__BSD_VISIBLE */
95 
96 #ifndef _KERNEL
97 __BEGIN_DECLS
98 DIR *opendir(const char *);
99 struct dirent *readdir(DIR *);
100 void rewinddir(DIR *);
101 int closedir(DIR *);
102 #if __BSD_VISIBLE
103 DIR *__opendir2(const char *, int);
104 int scandir(const char *, struct dirent ***,
105     int (*)(struct dirent *), int (*)(const void *, const void *));
106 int alphasort(const void *, const void *);
107 int getdirentries(int, char *, int, long *)
108 		__attribute__ ((__bounded__(__string__,2,3)));
109 #endif /* __BSD_VISIBLE */
110 #if __XPG_VISIBLE
111 long telldir(DIR *);
112 void seekdir(DIR *, long);
113 #endif
114 #if __POSIX_VISIBLE >= 199506 || __XPG_VISIBLE >= 500
115 int readdir_r(DIR *, struct dirent *, struct dirent **);
116 #endif
117 __END_DECLS
118 
119 #endif /* !_KERNEL */
120 
121 #endif /* !_DIRENT_H_ */
122