1 /**	$MirOS: src/include/dirent.h,v 1.5 2013/10/31 20:06:07 tg Exp $ */
2 /*	$OpenBSD: dirent.h,v 1.14 2005/06/18 18:09:42 millert Exp $	*/
3 /*	$NetBSD: dirent.h,v 1.9 1995/03/26 20:13:37 jtc Exp $	*/
4 
5 /*-
6  * Copyright © 2013
7  *	Thorsten “mirabilos” Glaser <tg@mirbsd.org>
8  * Copyright (c) 1989, 1993
9  *	The Regents of the University of California.  All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. 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 /*
42  * POSIX doesn't mandate this, but X/Open XPG 4.2 does.
43  */
44 #ifndef _POSIX_SOURCE
45 #include <sys/types.h>
46 #endif
47 
48 /*
49  * The kernel defines the format of directory entries returned by
50  * the getdirentries(2) system call.
51  */
52 #include <sys/dirent.h>
53 
54 #ifdef _POSIX_SOURCE
55 typedef void *	DIR;
56 #else
57 
58 #define	d_ino		d_fileno	/* backward compatibility */
59 
60 /* definitions for library routines operating on directories. */
61 #define	DIRBLKSIZ	1024
62 
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 } DIR;
74 
75 #define	dirfd(dirp)	((dirp)->dd_fd)
76 
77 /* flags for opendir2 */
78 #define DTF_NODUP	0x0002	/* don't return duplicate names */
79 #define __DTF_READALL	0x0008	/* everything has been read */
80 
81 #ifndef NULL
82 #ifdef 	__GNUG__
83 #define	NULL	__null
84 #elif defined(lint)
85 #define	NULL	0
86 #else
87 #define	NULL	((void *)((__PTRDIFF_TYPE__)0UL))
88 #endif
89 #endif
90 
91 #endif /* _POSIX_SOURCE */
92 
93 #ifndef _KERNEL
94 
95 #include <sys/cdefs.h>
96 
97 __BEGIN_DECLS
98 DIR *opendir(const char *);
99 struct dirent *readdir(DIR *);
100 void rewinddir(DIR *);
101 int closedir(DIR *);
102 #ifndef _POSIX_SOURCE
103 DIR *__opendir2(const char *, int);
104 long telldir(const DIR *);
105 void seekdir(DIR *, long);
106 int scandir(const char *, struct dirent ***,
107     int (*)(struct dirent *), int (*)(const void *, const void *));
108 int alphasort(const void *, const void *);
109 int getdirentries(int, char *, int, long *)
110 		__attribute__((__bounded__(__string__, 2, 3)));
111 #endif /* not POSIX */
112 int readdir_r(DIR *, struct dirent *, struct dirent **);
113 __END_DECLS
114 
115 #endif /* !_KERNEL */
116 
117 #endif /* !_DIRENT_H_ */
118