[unix-history] / usr / src / include / fts.h

/*
 * Copyright (c) 1989 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	5.14 (Berkeley) 4/3/91
 */

#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_savelink;	/* saved link if node had a cycle */
	struct _ftsent **fts_array;	/* sort array */
	dev_t rdev;			/* starting device # */
	char *fts_path;			/* path for this descent */
	int fts_dfd;			/* fd for directories */
	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_LOGICAL	0x001		/* logical walk */
#define	FTS_NOCHDIR	0x002		/* don't change directories */
#define	FTS_NOSTAT	0x004		/* don't get stat info */
#define	FTS_PHYSICAL	0x008		/* physical walk */
#define	FTS_SEEDOT	0x010		/* return dot and dot-dot */
#define	FTS_STOP	0x020		/* (private) unrecoverable error */
#define	FTS_XDEV	0x040		/* don't cross devices */
	int fts_options;		/* openfts() options */
} FTS;

typedef struct _ftsent {
	struct _ftsent *fts_parent;	/* parent directory */
	struct _ftsent *fts_link;	/* cycle or next file structure */
	union {
		long number;		/* local numeric value */
		void *pointer;		/* local address value */
	} fts_local;
#define	fts_number	fts_local.number
#define	fts_pointer	fts_local.pointer
	char *fts_accpath;		/* access path */
	char *fts_path;			/* root path */
	int fts_cderr;			/* chdir failed -- errno */
	short fts_pathlen;		/* strlen(fts_path) */
	short fts_namelen;		/* strlen(fts_name) */

#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_DP		 5		/* postorder directory */
#define	FTS_ERR		 6		/* error; errno is set */
#define	FTS_F		 7		/* regular file */
#define	FTS_NS		 8		/* stat(2) failed */
#define	FTS_NSOK	 9		/* no stat(2) requested */
#define	FTS_SL		10		/* symbolic link */
#define	FTS_SLNONE	11		/* symbolic link without target */
	u_short fts_info;		/* user 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 */
	u_short fts_instr;		/* fts_set() instructions */

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

#include <sys/cdefs.h>

__BEGIN_DECLS
FTSENT	*fts_children __P((FTS *));
int	 fts_close __P((FTS *));
FTS	*fts_open
	    __P((char * const *, int, int (*)(const FTSENT *, const FTSENT *)));
FTSENT	*fts_read __P((FTS *));
int	 fts_set __P((FTS *, FTSENT *, int));
__END_DECLS

#endif /* !_FTS_H_ */
Commit	Line	Data
6ec98a96 WJ	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	* @(#)fts.h 5.14 (Berkeley) 4/3/91
	34	*/
	35
	36	#ifndef _FTS_H_
	37	#define _FTS_H_
	38
	39	typedef struct {
	40	struct _ftsent fts_cur; / current node */
	41	struct _ftsent fts_child; / linked list of children */
	42	struct _ftsent fts_savelink; / saved link if node had a cycle */
	43	struct _ftsent *fts_array; / sort array */
	44	dev_t rdev; /* starting device # */
	45	char fts_path; / path for this descent */
	46	int fts_dfd; /* fd for directories */
	47	int fts_rfd; /* fd for root */
	48	int fts_pathlen; /* sizeof(path) */
	49	int fts_nitems; /* elements in the sort array */
	50	int (fts_compar)(); / compare function */
	51
	52	#define FTS_LOGICAL 0x001 /* logical walk */
	53	#define FTS_NOCHDIR 0x002 /* don't change directories */
	54	#define FTS_NOSTAT 0x004 /* don't get stat info */
	55	#define FTS_PHYSICAL 0x008 /* physical walk */
	56	#define FTS_SEEDOT 0x010 /* return dot and dot-dot */
	57	#define FTS_STOP 0x020 /* (private) unrecoverable error */
	58	#define FTS_XDEV 0x040 /* don't cross devices */
	59	int fts_options; /* openfts() options */
	60	} FTS;
	61
	62	typedef struct _ftsent {
	63	struct _ftsent fts_parent; / parent directory */
	64	struct _ftsent fts_link; / cycle or next file structure */
65	union {
66	long number; /* local numeric value */
67	void pointer; / local address value */
68	} fts_local;
69	#define fts_number fts_local.number
70	#define fts_pointer fts_local.pointer
71	char fts_accpath; / access path */
72	char fts_path; / root path */
73	int fts_cderr; /* chdir failed -- errno */
74	short fts_pathlen; /* strlen(fts_path) */
75	short fts_namelen; /* strlen(fts_name) */
76
77	#define FTS_ROOTPARENTLEVEL -1
78	#define FTS_ROOTLEVEL 0
79	short fts_level; /* depth (-1 to N) */
80
81	#define FTS_D 1 /* preorder directory */
82	#define FTS_DC 2 /* directory that causes cycles */
83	#define FTS_DEFAULT 3 /* none of the above */
84	#define FTS_DNR 4 /* unreadable directory */
85	#define FTS_DP 5 /* postorder directory */
86	#define FTS_ERR 6 /* error; errno is set */
87	#define FTS_F 7 /* regular file */
88	#define FTS_NS 8 /* stat(2) failed */
89	#define FTS_NSOK 9 /* no stat(2) requested */
90	#define FTS_SL 10 /* symbolic link */
91	#define FTS_SLNONE 11 /* symbolic link without target */
92	u_short fts_info; /* user flags for FTSENT structure */
93
94	#define FTS_AGAIN 1 /* read node again */
95	#define FTS_FOLLOW 2 /* follow symbolic link */
96	#define FTS_NOINSTR 3 /* no instructions */
97	#define FTS_SKIP 4 /* discard node */
98	u_short fts_instr; /* fts_set() instructions */
99
100	struct stat fts_statb; /* stat(2) information */
101	char fts_name[1]; /* file name */
102	} FTSENT;
103
104	#include <sys/cdefs.h>
105
106	__BEGIN_DECLS
107	FTSENT fts_children __P((FTS ));
108	int fts_close __P((FTS *));
109	FTS *fts_open
110	__P((char * const , int, int ()(const FTSENT , const FTSENT )));
111	FTSENT fts_read __P((FTS ));
112	int fts_set __P((FTS , FTSENT , int));
113	__END_DECLS
114
115	#endif /* !_FTS_H_ */