[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_

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_OPTIONMASK	0x0ff		/* 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
FTSENT	*fts_children(FTS *, int);
int	 fts_close(FTS *);
FTS	*fts_open(char * const *, int,
	    int (*)(const FTSENT **, const FTSENT **));
FTSENT	*fts_read(FTS *);
int	 fts_set(FTS *, FTSENT *, int);
__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
	61	typedef struct {
	62	struct _ftsent fts_cur; / current node */
	63	struct _ftsent fts_child; / linked list of children */
	64	struct _ftsent *fts_array; / sort array */
	65	dev_t fts_dev; /* starting device # */
	66	char fts_path; / path for this descent */
	67	int fts_rfd; /* fd for root */
	68	int fts_pathlen; /* sizeof(path) */
	69	int fts_nitems; /* elements in the sort array */
	70	int (fts_compar)(); / compare function */
	71
	72	#define FTS_COMFOLLOW 0x001 /* follow command line symlinks */
	73	#define FTS_LOGICAL 0x002 /* logical walk */
	74	#define FTS_NOCHDIR 0x004 /* don't change directories */
	75	#define FTS_NOSTAT 0x008 /* don't get stat info */
	76	#define FTS_PHYSICAL 0x010 /* physical walk */
	77	#define FTS_SEEDOT 0x020 /* return dot and dot-dot */
	78	#define FTS_XDEV 0x040 /* don't cross devices */
	79	#define FTS_WHITEOUT 0x080 /* return whiteout information */
	80	#define FTS_OPTIONMASK 0x0ff /* valid user option mask */
	81
	82	#define FTS_NAMEONLY 0x100 /* (private) child names only */
	83	#define FTS_STOP 0x200 /* (private) unrecoverable error */
84	int fts_options; /* fts_open options, global flags */
85	} FTS;
86
87	typedef struct _ftsent {
88	struct _ftsent fts_cycle; / cycle node */
89	struct _ftsent fts_parent; / parent directory */
90	struct _ftsent fts_link; / next file in directory */
91	long fts_number; /* local numeric value */
92	void fts_pointer; / local address value */
93	char fts_accpath; / access path */
94	char fts_path; / root path */
95	int fts_errno; /* errno for this node */
96	int fts_symfd; /* fd for symlink */
3d9156a7 A	97	unsigned short fts_pathlen; /* strlen(fts_path) */
3d9156a7 A	98	unsigned short fts_namelen; /* strlen(fts_name) */
5b2abdfb A	99
	100	ino_t fts_ino; /* inode */
	101	dev_t fts_dev; /* device */
	102	nlink_t fts_nlink; /* link count */
	103
	104	#define FTS_ROOTPARENTLEVEL -1
	105	#define FTS_ROOTLEVEL 0
	106	short fts_level; /* depth (-1 to N) */
	107
	108	#define FTS_D 1 /* preorder directory */
	109	#define FTS_DC 2 /* directory that causes cycles */
	110	#define FTS_DEFAULT 3 /* none of the above */
	111	#define FTS_DNR 4 /* unreadable directory */
	112	#define FTS_DOT 5 /* dot or dot-dot */
	113	#define FTS_DP 6 /* postorder directory */
	114	#define FTS_ERR 7 /* error; errno is set */
	115	#define FTS_F 8 /* regular file */
	116	#define FTS_INIT 9 /* initialized only */
	117	#define FTS_NS 10 /* stat(2) failed */
	118	#define FTS_NSOK 11 /* no stat(2) requested */
	119	#define FTS_SL 12 /* symbolic link */
	120	#define FTS_SLNONE 13 /* symbolic link without target */
	121	#define FTS_W 14 /* whiteout object */
3d9156a7	122	unsigned short fts_info; /* user flags for FTSENT structure */
5b2abdfb A	123
	124	#define FTS_DONTCHDIR 0x01 /* don't chdir .. to the parent */
	125	#define FTS_SYMFOLLOW 0x02 /* followed a symlink to get here */
	126	#define FTS_ISW 0x04 /* this is a whiteout object */
3d9156a7	127	unsigned short fts_flags; /* private flags for FTSENT structure */
5b2abdfb A	128
	129	#define FTS_AGAIN 1 /* read node again */
	130	#define FTS_FOLLOW 2 /* follow symbolic link */
	131	#define FTS_NOINSTR 3 /* no instructions */
	132	#define FTS_SKIP 4 /* discard node */
3d9156a7	133	unsigned short fts_instr; /* fts_set() instructions */
5b2abdfb A	134
	135	struct stat fts_statp; / stat(2) information */
	136	char fts_name[1]; /* file name */
	137	} FTSENT;
	138
	139	#include <sys/cdefs.h>
	140
	141	__BEGIN_DECLS
9385eb3d A	142	FTSENT fts_children(FTS , int);
	143	int fts_close(FTS *);
	144	FTS fts_open(char const *, int,
	145	int ()(const FTSENT , const FTSENT *));
	146	FTSENT fts_read(FTS );
	147	int fts_set(FTS , FTSENT , int);
5b2abdfb A	148	__END_DECLS
	149
	150	#endif /* !_FTS_H_ */