[unix-history] / include / dirent.h

/*-
 * Copyright (c) 1989 The Regents of the University of California.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)dirent.h	5.18 (Berkeley) 2/23/91
 */

#ifndef _DIRENT_H_
#define _DIRENT_H_

/*
 * A directory entry has a struct dirent at the front of it, containing its
 * inode number, the length of the entry, and the length of the name
 * contained in the entry.  These are followed by the name padded to a 4
 * byte boundary with null bytes.  All names are guaranteed null terminated.
 * The maximum length of a name in a directory is MAXNAMLEN.
 */

struct dirent {
	u_long	d_fileno;		/* file number of entry */
	u_short	d_reclen;		/* length of this record */
	u_short	d_namlen;		/* length of string in d_name */
#ifdef _POSIX_SOURCE
	char	d_name[255 + 1];	/* name must be no longer than this */
#else
#define	MAXNAMLEN	255
	char	d_name[MAXNAMLEN + 1];	/* name must be no longer than this */
#endif
};

#ifdef _POSIX_SOURCE
typedef void *	DIR;
#else

#define	d_ino		d_fileno	/* backward compatibility */

/* definitions for library routines operating on directories. */
#define	DIRBLKSIZ	1024

/* structure describing an open directory. */
typedef struct _dirdesc {
	int	dd_fd;		/* file descriptor associated with directory */
	long	dd_loc;		/* offset in current buffer */
	long	dd_size;	/* amount of data returned by getdirentries */
	char	*dd_buf;	/* data buffer */
	int	dd_len;		/* size of data buffer */
	long	dd_seek;	/* magic cookie returned by getdirentries */
	void	*dd_ddloc;	/* Linked list of ddloc structs for telldir/seekdir */
} DIR;

#define	dirfd(dirp)	((dirp)->dd_fd)

#ifndef NULL
#define	NULL	0
#endif

#endif /* _POSIX_SOURCE */

#ifndef KERNEL

#include <sys/cdefs.h>

__BEGIN_DECLS
DIR *opendir __P((const char *));
struct dirent *readdir __P((DIR *));
void rewinddir __P((DIR *));
int closedir __P((DIR *));
#ifndef _POSIX_SOURCE
long telldir __P((const DIR *));
void seekdir __P((DIR *, long));
int scandir __P((const char *, struct dirent ***,
    int (*)(struct dirent *), int (*)(const void *, const void *)));
int alphasort __P((const void *, const void *));
int getdirentries __P((int, char *, int, long *));
#endif /* not POSIX */
__END_DECLS

#endif /* !KERNEL */

#endif /* !_DIRENT_H_ */
Commit	Line	Data
15637ed4 RG	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	* @(#)dirent.h 5.18 (Berkeley) 2/23/91
	34	*/
	35
	36	#ifndef _DIRENT_H_
	37	#define _DIRENT_H_
	38
	39	/*
	40	* A directory entry has a struct dirent at the front of it, containing its
	41	* inode number, the length of the entry, and the length of the name
	42	* contained in the entry. These are followed by the name padded to a 4
	43	* byte boundary with null bytes. All names are guaranteed null terminated.
	44	* The maximum length of a name in a directory is MAXNAMLEN.
	45	*/
	46
	47	struct dirent {
	48	u_long d_fileno; /* file number of entry */
	49	u_short d_reclen; /* length of this record */
	50	u_short d_namlen; /* length of string in d_name */
	51	#ifdef _POSIX_SOURCE
	52	char d_name[255 + 1]; /* name must be no longer than this */
	53	#else
	54	#define MAXNAMLEN 255
	55	char d_name[MAXNAMLEN + 1]; /* name must be no longer than this */
	56	#endif
	57	};
	58
	59	#ifdef _POSIX_SOURCE
	60	typedef void * DIR;
	61	#else
	62
	63	#define d_ino d_fileno /* backward compatibility */
	64
65	/* definitions for library routines operating on directories. */
66	#define DIRBLKSIZ 1024
67
68	/* structure describing an open directory. */
69	typedef struct _dirdesc {
70	int dd_fd; /* file descriptor associated with directory */
71	long dd_loc; /* offset in current buffer */
72	long dd_size; /* amount of data returned by getdirentries */
73	char dd_buf; / data buffer */
74	int dd_len; /* size of data buffer */
75	long dd_seek; /* magic cookie returned by getdirentries */
78ed81a3	76	void dd_ddloc; / Linked list of ddloc structs for telldir/seekdir */
15637ed4 RG	77	} DIR;
	78
	79	#define dirfd(dirp) ((dirp)->dd_fd)
	80
	81	#ifndef NULL
	82	#define NULL 0
	83	#endif
	84
	85	#endif /* _POSIX_SOURCE */
	86
	87	#ifndef KERNEL
	88
	89	#include <sys/cdefs.h>
	90
	91	__BEGIN_DECLS
	92	DIR opendir __P((const char ));
	93	struct dirent readdir __P((DIR ));
	94	void rewinddir __P((DIR *));
	95	int closedir __P((DIR *));
	96	#ifndef _POSIX_SOURCE
	97	long telldir __P((const DIR *));
	98	void seekdir __P((DIR *, long));
	99	int scandir __P((const char , struct dirent **,
	100	int ()(struct dirent ), int ()(const void , const void *)));
	101	int alphasort __P((const void , const void ));
	102	int getdirentries __P((int, char , int, long ));
	103	#endif /* not POSIX */
	104	__END_DECLS
	105
	106	#endif /* !KERNEL */
	107
	108	#endif /* !_DIRENT_H_ */