dirent.h revision 1.4 
1/*-
2 * Copyright (c) 1989 The Regents of the University of California.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *	This product includes software developed by the University of
16 *	California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 *    may be used to endorse or promote products derived from this software
19 *    without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 *	from: @(#)dirent.h	5.18 (Berkeley) 2/23/91
34 *	$Id: dirent.h,v 1.4 1993/12/10 19:16:09 jtc Exp $
35 */
36
37#ifndef _DIRENT_H_
38#define _DIRENT_H_
39
40/*
41 * A directory entry has a struct dirent at the front of it, containing its
42 * inode number, the length of the entry, and the length of the name
43 * contained in the entry.  These are followed by the name padded to a 4
44 * byte boundary with null bytes.  All names are guaranteed null terminated.
45 * The maximum length of a name in a directory is MAXNAMLEN.
46 */
47
48struct dirent {
49	unsigned long	d_fileno;	/* file number of entry */
50	unsigned short	d_reclen;	/* length of this record */
51	unsigned short	d_namlen;	/* length of string in d_name */
52#ifdef _POSIX_SOURCE
53	char	d_name[255 + 1];	/* name must be no longer than this */
54#else
55#define	MAXNAMLEN	255
56	char	d_name[MAXNAMLEN + 1];	/* name must be no longer than this */
57#endif
58};
59
60/* structure describing an open directory. */
61typedef struct {
62	int	dd_fd;		/* file descriptor associated with directory */
63	long	dd_loc;		/* offset in current buffer */
64	long	dd_size;	/* amount of data returned by getdirentries */
65	char	*dd_buf;	/* data buffer */
66	int	dd_len;		/* size of data buffer */
67	long	dd_seek;	/* magic cookie returned by getdirentries */
68	void	*dd_ddloc;	/* Linked list of ddloc structs for telldir/seekdir */
69} DIR;
70
71
72#ifndef _POSIX_SOURCE
73#define	d_ino		d_fileno	/* backward compatibility */
74
75/* definitions for library routines operating on directories. */
76#define	DIRBLKSIZ	1024
77
78#define	dirfd(dirp)	((dirp)->dd_fd)
79
80#ifndef NULL
81#define	NULL	0
82#endif
83#endif /* _POSIX_SOURCE */
84
85
86#ifndef KERNEL
87#include <sys/cdefs.h>
88
89__BEGIN_DECLS
90DIR *opendir __P((const char *));
91struct dirent *readdir __P((DIR *));
92void rewinddir __P((DIR *));
93int closedir __P((DIR *));
94#ifndef _POSIX_SOURCE
95long telldir __P((const DIR *));
96void seekdir __P((DIR *, long));
97int scandir __P((const char *, struct dirent ***,
98    int (*)(struct dirent *), int (*)(const void *, const void *)));
99int alphasort __P((const void *, const void *));
100int getdirentries __P((int, char *, int, long *));
101#endif /* not POSIX */
102__END_DECLS
103
104#endif /* !KERNEL */
105
106#endif /* !_DIRENT_H_ */
107