[apple/libc.git] / include / fts.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.
 *
 *	@(#)fts.h	8.3 (Berkeley) 8/14/94
 */

#ifndef	_FTS_H_
#define	_FTS_H_

#include <sys/_types.h>

#ifndef _DEV_T
typedef	__darwin_dev_t		dev_t;		/* device number */
#define _DEV_T
#endif

#ifndef	_INO_T
typedef	__darwin_ino_t	ino_t;		/* inode number */
#define _INO_T
#endif

#ifndef _NLINK_T
typedef	__uint16_t		nlink_t;	/* link count */
#define	_NLINK_T
#endif

typedef struct {
	struct _ftsent *fts_cur;	/* current node */
	struct _ftsent *fts_child;	/* linked list of children */
	struct _ftsent **fts_array;	/* sort array */
	dev_t fts_dev;			/* starting device # */
	char *fts_path;			/* path for this descent */
	int fts_rfd;			/* fd for root */
	int fts_pathlen;		/* sizeof(path) */
	int fts_nitems;			/* elements in the sort array */
	int (*fts_compar)();		/* compare function */

#define	FTS_COMFOLLOW	0x001		/* follow command line symlinks */
#define	FTS_LOGICAL	0x002		/* logical walk */
#define	FTS_NOCHDIR	0x004		/* don't change directories */
#define	FTS_NOSTAT	0x008		/* don't get stat info */
#define	FTS_PHYSICAL	0x010		/* physical walk */
#define	FTS_SEEDOT	0x020		/* return dot and dot-dot */
#define	FTS_XDEV	0x040		/* don't cross devices */
#define	FTS_WHITEOUT	0x080		/* return whiteout information */
#define	FTS_COMFOLLOWDIR 0x400		/* (non-std) follow command line symlinks for directories only */
#define	FTS_OPTIONMASK	0x4ff		/* valid user option mask */

#define	FTS_NAMEONLY	0x100		/* (private) child names only */
#define	FTS_STOP	0x200		/* (private) unrecoverable error */
	int fts_options;		/* fts_open options, global flags */
} FTS;

typedef struct _ftsent {
	struct _ftsent *fts_cycle;	/* cycle node */
	struct _ftsent *fts_parent;	/* parent directory */
	struct _ftsent *fts_link;	/* next file in directory */
	long fts_number;	        /* local numeric value */
	void *fts_pointer;	        /* local address value */
	char *fts_accpath;		/* access path */
	char *fts_path;			/* root path */
	int fts_errno;			/* errno for this node */
	int fts_symfd;			/* fd for symlink */
	unsigned short fts_pathlen;	/* strlen(fts_path) */
	unsigned short fts_namelen;	/* strlen(fts_name) */

	ino_t fts_ino;			/* inode */
	dev_t fts_dev;			/* device */
	nlink_t fts_nlink;		/* link count */

#define	FTS_ROOTPARENTLEVEL	-1
#define	FTS_ROOTLEVEL		 0
	short fts_level;		/* depth (-1 to N) */

#define	FTS_D		 1		/* preorder directory */
#define	FTS_DC		 2		/* directory that causes cycles */
#define	FTS_DEFAULT	 3		/* none of the above */
#define	FTS_DNR		 4		/* unreadable directory */
#define	FTS_DOT		 5		/* dot or dot-dot */
#define	FTS_DP		 6		/* postorder directory */
#define	FTS_ERR		 7		/* error; errno is set */
#define	FTS_F		 8		/* regular file */
#define	FTS_INIT	 9		/* initialized only */
#define	FTS_NS		10		/* stat(2) failed */
#define	FTS_NSOK	11		/* no stat(2) requested */
#define	FTS_SL		12		/* symbolic link */
#define	FTS_SLNONE	13		/* symbolic link without target */
#define	FTS_W		14		/* whiteout object */
	unsigned short fts_info;	/* user flags for FTSENT structure */

#define	FTS_DONTCHDIR	 0x01		/* don't chdir .. to the parent */
#define	FTS_SYMFOLLOW	 0x02		/* followed a symlink to get here */
#define	FTS_ISW		 0x04		/* this is a whiteout object */
	unsigned short fts_flags;	/* private flags for FTSENT structure */

#define	FTS_AGAIN	 1		/* read node again */
#define	FTS_FOLLOW	 2		/* follow symbolic link */
#define	FTS_NOINSTR	 3		/* no instructions */
#define	FTS_SKIP	 4		/* discard node */
	unsigned short fts_instr;	/* fts_set() instructions */

	struct stat *fts_statp;		/* stat(2) information */
	char fts_name[1];		/* file name */
} FTSENT;

#include <sys/cdefs.h>

__BEGIN_DECLS
//Begin-Libc
#ifndef LIBC_ALIAS_FTS_CHILDREN
//End-Libc
FTSENT	*fts_children(FTS *, int) __DARWIN_INODE64(fts_children);
//Begin-Libc
#else /* LIBC_ALIAS_FTS_CHILDREN */
FTSENT	*fts_children(FTS *, int) LIBC_INODE64(fts_children);
#endif /* !LIBC_ALIAS_FTS_CHILDREN */
//End-Libc
//Begin-Libc
#ifndef LIBC_ALIAS_FTS_CLOSE
//End-Libc
int	 fts_close(FTS *) __DARWIN_INODE64(fts_close);
//Begin-Libc
#else /* LIBC_ALIAS_FTS_CLOSE */
int	 fts_close(FTS *) LIBC_INODE64(fts_close);
#endif /* !LIBC_ALIAS_FTS_CLOSE */
//End-Libc
//Begin-Libc
#ifndef LIBC_ALIAS_FTS_OPEN
//End-Libc
FTS	*fts_open(char * const *, int,
	    int (*)(const FTSENT **, const FTSENT **)) __DARWIN_INODE64(fts_open);
//Begin-Libc
#else /* LIBC_ALIAS_FTS_OPEN */
FTS	*fts_open(char * const *, int,
	    int (*)(const FTSENT **, const FTSENT **)) LIBC_INODE64(fts_open);
#endif /* !LIBC_ALIAS_FTS_OPEN */
//End-Libc
//Begin-Libc
#ifndef LIBC_ALIAS_FTS_READ
//End-Libc
FTSENT	*fts_read(FTS *) __DARWIN_INODE64(fts_read);
//Begin-Libc
#else /* LIBC_ALIAS_FTS_READ */
FTSENT	*fts_read(FTS *) LIBC_INODE64(fts_read);
#endif /* !LIBC_ALIAS_FTS_READ */
//End-Libc
//Begin-Libc
#ifndef LIBC_ALIAS_FTS_SET
//End-Libc
int	 fts_set(FTS *, FTSENT *, int) __DARWIN_INODE64(fts_set);
//Begin-Libc
#else /* LIBC_ALIAS_FTS_SET */
int	 fts_set(FTS *, FTSENT *, int) LIBC_INODE64(fts_set);
#endif /* !LIBC_ALIAS_FTS_SET */
//End-Libc
__END_DECLS

#endif /* !_FTS_H_ */
Commit	Line	Data
5b2abdfb A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	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
5b2abdfb A	15	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
5b2abdfb 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.
5b2abdfb A	20	*
	21	* @APPLE_LICENSE_HEADER_END@
	22	*/
	23	/*
	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.
	54	*
	55	* @(#)fts.h 8.3 (Berkeley) 8/14/94
	56	*/
	57
	58	#ifndef _FTS_H_
	59	#define _FTS_H_
	60
224c7076 A	61	#include <sys/_types.h>
	62
	63	#ifndef _DEV_T
	64	typedef __darwin_dev_t dev_t; /* device number */
	65	#define _DEV_T
	66	#endif
	67
	68	#ifndef _INO_T
	69	typedef __darwin_ino_t ino_t; /* inode number */
	70	#define _INO_T
	71	#endif
	72
	73	#ifndef _NLINK_T
	74	typedef __uint16_t nlink_t; /* link count */
	75	#define _NLINK_T
	76	#endif
	77
5b2abdfb A	78	typedef struct {
	79	struct _ftsent fts_cur; / current node */
	80	struct _ftsent fts_child; / linked list of children */
	81	struct _ftsent *fts_array; / sort array */
	82	dev_t fts_dev; /* starting device # */
	83	char fts_path; / path for this descent */
	84	int fts_rfd; /* fd for root */
	85	int fts_pathlen; /* sizeof(path) */
	86	int fts_nitems; /* elements in the sort array */
	87	int (fts_compar)(); / compare function */
	88
	89	#define FTS_COMFOLLOW 0x001 /* follow command line symlinks */
	90	#define FTS_LOGICAL 0x002 /* logical walk */
	91	#define FTS_NOCHDIR 0x004 /* don't change directories */
	92	#define FTS_NOSTAT 0x008 /* don't get stat info */
	93	#define FTS_PHYSICAL 0x010 /* physical walk */
	94	#define FTS_SEEDOT 0x020 /* return dot and dot-dot */
	95	#define FTS_XDEV 0x040 /* don't cross devices */
	96	#define FTS_WHITEOUT 0x080 /* return whiteout information */
224c7076 A	97	#define FTS_COMFOLLOWDIR 0x400 /* (non-std) follow command line symlinks for directories only */
224c7076 A	98	#define FTS_OPTIONMASK 0x4ff /* valid user option mask */
5b2abdfb A	99
	100	#define FTS_NAMEONLY 0x100 /* (private) child names only */
	101	#define FTS_STOP 0x200 /* (private) unrecoverable error */
	102	int fts_options; /* fts_open options, global flags */
	103	} FTS;
	104
	105	typedef struct _ftsent {
	106	struct _ftsent fts_cycle; / cycle node */
	107	struct _ftsent fts_parent; / parent directory */
	108	struct _ftsent fts_link; / next file in directory */
	109	long fts_number; /* local numeric value */
	110	void fts_pointer; / local address value */
	111	char fts_accpath; / access path */
	112	char fts_path; / root path */
	113	int fts_errno; /* errno for this node */
	114	int fts_symfd; /* fd for symlink */
3d9156a7 A	115	unsigned short fts_pathlen; /* strlen(fts_path) */
3d9156a7 A	116	unsigned short fts_namelen; /* strlen(fts_name) */
5b2abdfb A	117
	118	ino_t fts_ino; /* inode */
	119	dev_t fts_dev; /* device */
	120	nlink_t fts_nlink; /* link count */
	121
	122	#define FTS_ROOTPARENTLEVEL -1
	123	#define FTS_ROOTLEVEL 0
	124	short fts_level; /* depth (-1 to N) */
	125
	126	#define FTS_D 1 /* preorder directory */
	127	#define FTS_DC 2 /* directory that causes cycles */
	128	#define FTS_DEFAULT 3 /* none of the above */
	129	#define FTS_DNR 4 /* unreadable directory */
	130	#define FTS_DOT 5 /* dot or dot-dot */
	131	#define FTS_DP 6 /* postorder directory */
	132	#define FTS_ERR 7 /* error; errno is set */
	133	#define FTS_F 8 /* regular file */
	134	#define FTS_INIT 9 /* initialized only */
	135	#define FTS_NS 10 /* stat(2) failed */
	136	#define FTS_NSOK 11 /* no stat(2) requested */
	137	#define FTS_SL 12 /* symbolic link */
	138	#define FTS_SLNONE 13 /* symbolic link without target */
	139	#define FTS_W 14 /* whiteout object */
3d9156a7	140	unsigned short fts_info; /* user flags for FTSENT structure */
5b2abdfb A	141
	142	#define FTS_DONTCHDIR 0x01 /* don't chdir .. to the parent */
	143	#define FTS_SYMFOLLOW 0x02 /* followed a symlink to get here */
	144	#define FTS_ISW 0x04 /* this is a whiteout object */
3d9156a7	145	unsigned short fts_flags; /* private flags for FTSENT structure */
5b2abdfb A	146
	147	#define FTS_AGAIN 1 /* read node again */
	148	#define FTS_FOLLOW 2 /* follow symbolic link */
	149	#define FTS_NOINSTR 3 /* no instructions */
	150	#define FTS_SKIP 4 /* discard node */
3d9156a7	151	unsigned short fts_instr; /* fts_set() instructions */
5b2abdfb A	152
	153	struct stat fts_statp; / stat(2) information */
	154	char fts_name[1]; /* file name */
	155	} FTSENT;
	156
	157	#include <sys/cdefs.h>
	158
	159	__BEGIN_DECLS
224c7076 A	160	//Begin-Libc
	161	#ifndef LIBC_ALIAS_FTS_CHILDREN
	162	//End-Libc
	163	FTSENT fts_children(FTS , int) __DARWIN_INODE64(fts_children);
	164	//Begin-Libc
	165	#else /* LIBC_ALIAS_FTS_CHILDREN */
	166	FTSENT fts_children(FTS , int) LIBC_INODE64(fts_children);
	167	#endif /* !LIBC_ALIAS_FTS_CHILDREN */
	168	//End-Libc
	169	//Begin-Libc
	170	#ifndef LIBC_ALIAS_FTS_CLOSE
	171	//End-Libc
	172	int fts_close(FTS *) __DARWIN_INODE64(fts_close);
	173	//Begin-Libc
	174	#else /* LIBC_ALIAS_FTS_CLOSE */
	175	int fts_close(FTS *) LIBC_INODE64(fts_close);
	176	#endif /* !LIBC_ALIAS_FTS_CLOSE */
	177	//End-Libc
	178	//Begin-Libc
	179	#ifndef LIBC_ALIAS_FTS_OPEN
	180	//End-Libc
	181	FTS fts_open(char const *, int,
	182	int ()(const FTSENT , const FTSENT *)) __DARWIN_INODE64(fts_open);
	183	//Begin-Libc
	184	#else /* LIBC_ALIAS_FTS_OPEN */
9385eb3d	185	FTS fts_open(char const *, int,
224c7076 A	186	int ()(const FTSENT , const FTSENT *)) LIBC_INODE64(fts_open);
	187	#endif /* !LIBC_ALIAS_FTS_OPEN */
	188	//End-Libc
	189	//Begin-Libc
	190	#ifndef LIBC_ALIAS_FTS_READ
	191	//End-Libc
	192	FTSENT fts_read(FTS ) __DARWIN_INODE64(fts_read);
	193	//Begin-Libc
	194	#else /* LIBC_ALIAS_FTS_READ */
	195	FTSENT fts_read(FTS ) LIBC_INODE64(fts_read);
	196	#endif /* !LIBC_ALIAS_FTS_READ */
	197	//End-Libc
	198	//Begin-Libc
	199	#ifndef LIBC_ALIAS_FTS_SET
	200	//End-Libc
	201	int fts_set(FTS , FTSENT , int) __DARWIN_INODE64(fts_set);
	202	//Begin-Libc
	203	#else /* LIBC_ALIAS_FTS_SET */
	204	int fts_set(FTS , FTSENT , int) LIBC_INODE64(fts_set);
	205	#endif /* !LIBC_ALIAS_FTS_SET */
	206	//End-Libc
5b2abdfb A	207	__END_DECLS
	208
	209	#endif /* !_FTS_H_ */