Annotation of src/include/dirent.h, Revision 1.30
1.30 ! deraadt 1: /* $OpenBSD: dirent.h,v 1.29 2012/11/29 02:15:44 guenther Exp $ */
1.1 deraadt 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.
1.10 millert 16: * 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 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:
1.15 millert 38: #include <sys/cdefs.h>
39:
1.1 deraadt 40: /*
1.2 deraadt 41: * POSIX doesn't mandate this, but X/Open XPG 4.2 does.
42: */
1.15 millert 43: #if __BSD_VISIBLE || __XPG_VISIBLE >= 420
1.2 deraadt 44: #include <sys/types.h>
45: #endif
46:
47: /*
1.1 deraadt 48: * The kernel defines the format of directory entries returned by
49: * the getdirentries(2) system call.
50: */
51: #include <sys/dirent.h>
52:
1.15 millert 53: #if __BSD_VISIBLE || __XPG_VISIBLE
54: #define d_ino d_fileno /* backward compatibility */
55: #endif
1.1 deraadt 56:
1.27 matthew 57: typedef struct _dirdesc DIR;
1.20 guenther 58:
1.15 millert 59: #if __BSD_VISIBLE
1.1 deraadt 60:
61: /* definitions for library routines operating on directories. */
62: #define DIRBLKSIZ 1024
63:
64: #ifndef NULL
1.5 espie 65: #ifdef __GNUG__
1.6 espie 66: #define NULL __null
1.22 jsg 67: #elif defined(__cplusplus)
68: #define NULL 0L
1.5 espie 69: #else
1.21 miod 70: #define NULL ((void *)0)
1.15 millert 71: #endif /* __GNUG__ */
72: #endif /* !NULL */
1.1 deraadt 73:
1.27 matthew 74: #endif /* __BSD_VISIBLE */
1.1 deraadt 75:
76: __BEGIN_DECLS
1.7 millert 77: DIR *opendir(const char *);
1.24 matthew 78: #if __POSIX_VISIBLE >= 200809
79: DIR *fdopendir(int);
80: #endif
1.7 millert 81: struct dirent *readdir(DIR *);
82: void rewinddir(DIR *);
83: int closedir(DIR *);
1.15 millert 84: #if __BSD_VISIBLE
1.19 millert 85: int getdirentries(int, char *, int, off_t *)
1.13 avsm 86: __attribute__ ((__bounded__(__string__,2,3)));
1.15 millert 87: #endif /* __BSD_VISIBLE */
88: #if __XPG_VISIBLE
1.16 otto 89: long telldir(DIR *);
1.15 millert 90: void seekdir(DIR *, long);
91: #endif
92: #if __POSIX_VISIBLE >= 199506 || __XPG_VISIBLE >= 500
1.26 guenther 93: int readdir_r(DIR *__restrict, struct dirent *__restrict,
94: struct dirent **__restrict);
1.20 guenther 95: #endif
1.26 guenther 96: #if __POSIX_VISIBLE >= 200809
1.29 guenther 97: int scandir(const char *, struct dirent ***, int (*)(const struct dirent *),
1.26 guenther 98: int (*)(const struct dirent **, const struct dirent **));
99: int alphasort(const struct dirent **, const struct dirent **);
1.28 guenther 100: #elif __BSD_VISIBLE
101: int scandir(const char *, struct dirent ***, int (*)(struct dirent *),
102: int (*)(const void *, const void *));
103: int alphasort(const void *, const void *);
1.25 matthew 104: #endif
105: #if __POSIX_VISIBLE >= 200809 || __XPG_VISIBLE > 600
1.27 matthew 106: int dirfd(DIR *);
1.15 millert 107: #endif
1.1 deraadt 108: __END_DECLS
109:
110: #endif /* !_DIRENT_H_ */