[apple/libc.git] / include / dirent.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*-
 * Copyright (c) 1989, 1993
 *	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	8.2 (Berkeley) 7/28/94
 */

#ifndef _DIRENT_H_
#define _DIRENT_H_

/*
 * The kernel defines the format of directory entries returned by 
 * the getdirentries(2) system call.
 */
#include <_types.h>
#include <sys/dirent.h>

struct _telldir;		/* forward reference */

/* structure describing an open directory. */
typedef struct {
	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 */
	long	dd_rewind;	/* magic cookie for rewinding */
	int	dd_flags;	/* flags for readdir */
	__darwin_pthread_mutex_t dd_lock; /* for thread locking */
	struct _telldir *dd_td;	/* telldir position recording */
} DIR;

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

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

/* flags for opendir2 */
#define DTF_HIDEW	0x0001	/* hide whiteout entries */
#define DTF_NODUP	0x0002	/* don't return duplicate names */
#define DTF_REWIND	0x0004	/* rewind after reading union stack */
#define __DTF_READALL	0x0008	/* everything has been read */

#endif /* ! _POSIX_C_SOURCE */

#ifndef KERNEL

#include <sys/cdefs.h>

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

#endif /* !KERNEL */

#endif /* !_DIRENT_H_ */
Commit	Line	Data
e9ce8d39	1	/*
5b2abdfb	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
e9ce8d39 A	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
734aad71 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. Please obtain a copy of the License at
	10	* http://www.opensource.apple.com/apsl/ and read it before using this
	11	* file.
	12	*
	13	* The Original Code and all software distributed under the License are
	14	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
e9ce8d39 A	15	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
e9ce8d39 A	16	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
734aad71 A	17	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	18	* Please see the License for the specific language governing rights and
	19	* limitations under the License.
e9ce8d39 A	20	*
	21	* @APPLE_LICENSE_HEADER_END@
	22	*/
5b2abdfb	23	/*-
e9ce8d39 A	24	* Copyright (c) 1989, 1993
	25	* The Regents of the University of California. All rights reserved.
	26	*
	27	* Redistribution and use in source and binary forms, with or without
	28	* modification, are permitted provided that the following conditions
	29	* are met:
	30	* 1. Redistributions of source code must retain the above copyright
	31	* notice, this list of conditions and the following disclaimer.
	32	* 2. Redistributions in binary form must reproduce the above copyright
	33	* notice, this list of conditions and the following disclaimer in the
	34	* documentation and/or other materials provided with the distribution.
	35	* 3. All advertising materials mentioning features or use of this software
	36	* must display the following acknowledgement:
	37	* This product includes software developed by the University of
	38	* California, Berkeley and its contributors.
	39	* 4. Neither the name of the University nor the names of its contributors
	40	* may be used to endorse or promote products derived from this software
	41	* without specific prior written permission.
	42	*
	43	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	44	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	45	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	46	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	47	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	48	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	49	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	50	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	51	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	52	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	53	* SUCH DAMAGE.
5b2abdfb A	54	*
	55	* @(#)dirent.h 8.2 (Berkeley) 7/28/94
	56	*/
	57
	58	#ifndef _DIRENT_H_
	59	#define _DIRENT_H_
	60
	61	/*
	62	* The kernel defines the format of directory entries returned by
	63	* the getdirentries(2) system call.
e9ce8d39	64	*/
59e0d9fe	65	#include <_types.h>
5b2abdfb A	66	#include <sys/dirent.h>
5b2abdfb A	67
3d9156a7	68	struct _telldir; /* forward reference */
9385eb3d	69
5b2abdfb	70	/* structure describing an open directory. */
3d9156a7	71	typedef struct {
5b2abdfb A	72	int dd_fd; /* file descriptor associated with directory */
	73	long dd_loc; /* offset in current buffer */
	74	long dd_size; /* amount of data returned by getdirentries */
	75	char dd_buf; / data buffer */
	76	int dd_len; /* size of data buffer */
	77	long dd_seek; /* magic cookie returned by getdirentries */
	78	long dd_rewind; /* magic cookie for rewinding */
	79	int dd_flags; /* flags for readdir */
3d9156a7	80	__darwin_pthread_mutex_t dd_lock; /* for thread locking */
9385eb3d	81	struct _telldir dd_td; / telldir position recording */
5b2abdfb A	82	} DIR;
5b2abdfb A	83
3d9156a7 A	84	#ifndef _POSIX_C_SOURCE
	85	/* definitions for library routines operating on directories. */
	86	#define DIRBLKSIZ 1024
	87
5b2abdfb A	88	#define dirfd(dirp) ((dirp)->dd_fd)
	89
	90	/* flags for opendir2 */
	91	#define DTF_HIDEW 0x0001 /* hide whiteout entries */
	92	#define DTF_NODUP 0x0002 /* don't return duplicate names */
	93	#define DTF_REWIND 0x0004 /* rewind after reading union stack */
	94	#define __DTF_READALL 0x0008 /* everything has been read */
	95
3d9156a7	96	#endif /* ! _POSIX_C_SOURCE */
5b2abdfb A	97
5b2abdfb A	98	#ifndef KERNEL
e9ce8d39 A	99
e9ce8d39 A	100	#include <sys/cdefs.h>
e9ce8d39	101
5b2abdfb	102	__BEGIN_DECLS
3d9156a7	103	#ifndef _POSIX_C_SOURCE
59e0d9fe A	104	int alphasort(const void , const void );
59e0d9fe A	105	#endif /* not POSIX */
3d9156a7 A	106	int closedir(DIR *) __DARWIN_ALIAS(closedir);
3d9156a7 A	107	#ifndef _POSIX_C_SOURCE
59e0d9fe A	108	int getdirentries(int, char , int, long );
59e0d9fe A	109	#endif /* not POSIX */
3d9156a7 A	110	DIR opendir(const char ) __DARWIN_ALIAS(opendir);
	111	#ifndef _POSIX_C_SOURCE
	112	DIR __opendir2(const char , int) __DARWIN_ALIAS(__opendir2);
59e0d9fe	113	#endif /* not POSIX */
9385eb3d	114	struct dirent readdir(DIR );
59e0d9fe	115	int readdir_r(DIR , struct dirent , struct dirent **);
3d9156a7 A	116	void rewinddir(DIR *) __DARWIN_ALIAS(rewinddir);
3d9156a7 A	117	#ifndef _POSIX_C_SOURCE
9385eb3d A	118	int scandir(const char , struct dirent **,
9385eb3d A	119	int ()(struct dirent ), int ()(const void , const void *));
5b2abdfb	120	#endif /* not POSIX */
3d9156a7 A	121	void seekdir(DIR *, long) __DARWIN_ALIAS(seekdir);
3d9156a7 A	122	long telldir(DIR *) __DARWIN_ALIAS(telldir);
5b2abdfb	123	__END_DECLS
e9ce8d39	124
5b2abdfb	125	#endif /* !KERNEL */
e9ce8d39	126
5b2abdfb	127	#endif /* !_DIRENT_H_ */