Annotation of src/include/dirent.h, Revision 1.16
1.16 ! otto 1: /* $OpenBSD: dirent.h,v 1.15 2005/12/13 00:35:22 millert 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.15 millert 57: #if __BSD_VISIBLE
1.1 deraadt 58:
59: /* definitions for library routines operating on directories. */
60: #define DIRBLKSIZ 1024
61:
1.16 ! otto 62: struct _telldir;
1.1 deraadt 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 */
1.16 ! otto 73: struct _telldir *dd_td; /* telldir position recording */
1.1 deraadt 74: } DIR;
75:
76: #define dirfd(dirp) ((dirp)->dd_fd)
77:
78: /* flags for opendir2 */
79: #define DTF_NODUP 0x0002 /* don't return duplicate names */
80: #define __DTF_READALL 0x0008 /* everything has been read */
81:
82: #ifndef NULL
1.5 espie 83: #ifdef __GNUG__
1.6 espie 84: #define NULL __null
1.5 espie 85: #else
1.9 millert 86: #define NULL 0L
1.15 millert 87: #endif /* __GNUG__ */
88: #endif /* !NULL */
1.1 deraadt 89:
1.15 millert 90: #else /* !__BSD_VISIBLE */
1.1 deraadt 91:
1.15 millert 92: typedef void * DIR;
1.1 deraadt 93:
1.15 millert 94: #endif /* !__BSD_VISIBLE */
1.1 deraadt 95:
1.15 millert 96: #ifndef _KERNEL
1.1 deraadt 97: __BEGIN_DECLS
1.7 millert 98: DIR *opendir(const char *);
99: struct dirent *readdir(DIR *);
100: void rewinddir(DIR *);
101: int closedir(DIR *);
1.15 millert 102: #if __BSD_VISIBLE
1.7 millert 103: DIR *__opendir2(const char *, int);
1.8 millert 104: int scandir(const char *, struct dirent ***,
105: int (*)(struct dirent *), int (*)(const void *, const void *));
1.7 millert 106: int alphasort(const void *, const void *);
1.13 avsm 107: int getdirentries(int, char *, int, long *)
108: __attribute__ ((__bounded__(__string__,2,3)));
1.15 millert 109: #endif /* __BSD_VISIBLE */
110: #if __XPG_VISIBLE
1.16 ! otto 111: long telldir(DIR *);
1.15 millert 112: void seekdir(DIR *, long);
113: #endif
114: #if __POSIX_VISIBLE >= 199506 || __XPG_VISIBLE >= 500
1.7 millert 115: int readdir_r(DIR *, struct dirent *, struct dirent **);
1.15 millert 116: #endif
1.1 deraadt 117: __END_DECLS
118:
119: #endif /* !_KERNEL */
120:
121: #endif /* !_DIRENT_H_ */