Home | History | Annotate | Line # | Download | only in include
dirent.h revision 1.3 
      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.3 1993/08/01 18:44:56 mycroft 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 
     48 struct dirent {
     49 	u_long	d_fileno;		/* file number of entry */
     50 	u_short	d_reclen;		/* length of this record */
     51 	u_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 #ifdef _POSIX_SOURCE
     61 typedef void *	DIR;
     62 #else
     63 
     64 #define	d_ino		d_fileno	/* backward compatibility */
     65 
     66 /* definitions for library routines operating on directories. */
     67 #define	DIRBLKSIZ	1024
     68 
     69 /* structure describing an open directory. */
     70 typedef struct _dirdesc {
     71 	int	dd_fd;		/* file descriptor associated with directory */
     72 	long	dd_loc;		/* offset in current buffer */
     73 	long	dd_size;	/* amount of data returned by getdirentries */
     74 	char	*dd_buf;	/* data buffer */
     75 	int	dd_len;		/* size of data buffer */
     76 	long	dd_seek;	/* magic cookie returned by getdirentries */
     77 	void	*dd_ddloc;	/* Linked list of ddloc structs for telldir/seekdir */
     78 } DIR;
     79 
     80 #define	dirfd(dirp)	((dirp)->dd_fd)
     81 
     82 #ifndef NULL
     83 #define	NULL	0
     84 #endif
     85 
     86 #endif /* _POSIX_SOURCE */
     87 
     88 #ifndef KERNEL
     89 
     90 #include <sys/cdefs.h>
     91 
     92 __BEGIN_DECLS
     93 DIR *opendir __P((const char *));
     94 struct dirent *readdir __P((DIR *));
     95 void rewinddir __P((DIR *));
     96 int closedir __P((DIR *));
     97 #ifndef _POSIX_SOURCE
     98 long telldir __P((const DIR *));
     99 void seekdir __P((DIR *, long));
    100 int scandir __P((const char *, struct dirent ***,
    101     int (*)(struct dirent *), int (*)(const void *, const void *)));
    102 int alphasort __P((const void *, const void *));
    103 int getdirentries __P((int, char *, int, long *));
    104 #endif /* not POSIX */
    105 __END_DECLS
    106 
    107 #endif /* !KERNEL */
    108 
    109 #endif /* !_DIRENT_H_ */
    110