Home | History | Annotate | Line # | Download | only in include
dirent.h revision 1.20 
      1 /*	$NetBSD: dirent.h,v 1.20 2003/05/28 20:04:12 christos Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 1989, 1993
      5  *	The Regents of the University of California.  All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  * 3. All advertising materials mentioning features or use of this software
     16  *    must display the following acknowledgement:
     17  *	This product includes software developed by the University of
     18  *	California, Berkeley and its contributors.
     19  * 4. Neither the name of the University nor the names of its contributors
     20  *    may be used to endorse or promote products derived from this software
     21  *    without specific prior written permission.
     22  *
     23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     33  * SUCH DAMAGE.
     34  *
     35  *	@(#)dirent.h	8.2 (Berkeley) 7/28/94
     36  */
     37 
     38 #ifndef _DIRENT_H_
     39 #define _DIRENT_H_
     40 
     41 #include <sys/featuretest.h>
     42 #include <sys/types.h>
     43 
     44 /*
     45  * The kernel defines the format of directory entries returned by
     46  * the getdirentries(2) system call.
     47  */
     48 #include <sys/dirent.h>
     49 
     50 #if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE)
     51 #define	d_ino		d_fileno	/* backward compatibility */
     52 #endif
     53 
     54 typedef struct _dirdesc DIR;
     55 
     56 #if defined(_NETBSD_SOURCE)
     57 
     58 /* definitions for library routines operating on directories. */
     59 #define	DIRBLKSIZ	1024
     60 
     61 /* structure describing an open directory. */
     62 struct _dirdesc {
     63 	int	dd_fd;		/* file descriptor associated with directory */
     64 	long	dd_loc;		/* offset in current buffer */
     65 	long	dd_size;	/* amount of data returned by getdents */
     66 	char	*dd_buf;	/* data buffer */
     67 	int	dd_len;		/* size of data buffer */
     68 	off_t	dd_seek;	/* magic cookie returned by getdents */
     69 	long	dd_rewind;	/* magic cookie for rewinding */
     70 	int	dd_flags;	/* flags for readdir */
     71 	void	*dd_lock;	/* lock for concurrent access */
     72 };
     73 
     74 #define	dirfd(dirp)	((dirp)->dd_fd)
     75 
     76 /* flags for __opendir2() */
     77 #define DTF_HIDEW	0x0001	/* hide whiteout entries */
     78 #define DTF_NODUP	0x0002	/* don't return duplicate names */
     79 #define DTF_REWIND	0x0004	/* rewind after reading union stack */
     80 #define __DTF_READALL	0x0008	/* everything has been read */
     81 
     82 #include <sys/null.h>
     83 
     84 #endif
     85 
     86 #ifndef _KERNEL
     87 
     88 #include <sys/cdefs.h>
     89 
     90 __BEGIN_DECLS
     91 int closedir __P((DIR *));
     92 DIR *opendir __P((const char *));
     93 struct dirent *readdir __P((DIR *));
     94 int readdir_r __P((DIR *, struct dirent * __restrict,
     95     struct dirent ** __restrict));
     96 void rewinddir __P((DIR *));
     97 #if defined(_XOPEN_SOURCE) || defined(_NETBSD_SOURCE)
     98 void seekdir __P((DIR *, long));
     99 long telldir __P((const DIR *));
    100 #endif /* defined(_NETBSD_SOURCE) || defined(_XOPEN_SOURCE) */
    101 #if defined(_NETBSD_SOURCE)
    102 DIR *__opendir2 __P((const char *, int));
    103 void __seekdir __P((DIR *, long));
    104 int scandir __P((const char *, struct dirent ***,
    105     int (*)(const struct dirent *), int (*)(const void *, const void *)));
    106 int alphasort __P((const void *, const void *));
    107 int getdirentries __P((int, char *, int, long *));
    108 int getdents __P((int, char *, size_t));
    109 #endif /* defined(_NETBSD_SOURCE) */
    110 __END_DECLS
    111 
    112 #endif /* !_KERNEL */
    113 
    114 #endif /* !_DIRENT_H_ */
    115