1951a39d68df598db08dfced8b4707755864a0492Ying Wang/*	$OpenBSD: fts.h,v 1.12 2009/08/27 16:19:27 millert Exp $	*/
2951a39d68df598db08dfced8b4707755864a0492Ying Wang/*	$NetBSD: fts.h,v 1.5 1994/12/28 01:41:50 mycroft Exp $	*/
3951a39d68df598db08dfced8b4707755864a0492Ying Wang
4951a39d68df598db08dfced8b4707755864a0492Ying Wang/*
5951a39d68df598db08dfced8b4707755864a0492Ying Wang * Copyright (c) 1989, 1993
6951a39d68df598db08dfced8b4707755864a0492Ying Wang *	The Regents of the University of California.  All rights reserved.
7951a39d68df598db08dfced8b4707755864a0492Ying Wang *
8951a39d68df598db08dfced8b4707755864a0492Ying Wang * Redistribution and use in source and binary forms, with or without
9951a39d68df598db08dfced8b4707755864a0492Ying Wang * modification, are permitted provided that the following conditions
10951a39d68df598db08dfced8b4707755864a0492Ying Wang * are met:
11951a39d68df598db08dfced8b4707755864a0492Ying Wang * 1. Redistributions of source code must retain the above copyright
12951a39d68df598db08dfced8b4707755864a0492Ying Wang *    notice, this list of conditions and the following disclaimer.
13951a39d68df598db08dfced8b4707755864a0492Ying Wang * 2. Redistributions in binary form must reproduce the above copyright
14951a39d68df598db08dfced8b4707755864a0492Ying Wang *    notice, this list of conditions and the following disclaimer in the
15951a39d68df598db08dfced8b4707755864a0492Ying Wang *    documentation and/or other materials provided with the distribution.
16951a39d68df598db08dfced8b4707755864a0492Ying Wang * 3. Neither the name of the University nor the names of its contributors
17951a39d68df598db08dfced8b4707755864a0492Ying Wang *    may be used to endorse or promote products derived from this software
18951a39d68df598db08dfced8b4707755864a0492Ying Wang *    without specific prior written permission.
19951a39d68df598db08dfced8b4707755864a0492Ying Wang *
20951a39d68df598db08dfced8b4707755864a0492Ying Wang * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21951a39d68df598db08dfced8b4707755864a0492Ying Wang * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22951a39d68df598db08dfced8b4707755864a0492Ying Wang * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23951a39d68df598db08dfced8b4707755864a0492Ying Wang * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24951a39d68df598db08dfced8b4707755864a0492Ying Wang * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25951a39d68df598db08dfced8b4707755864a0492Ying Wang * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26951a39d68df598db08dfced8b4707755864a0492Ying Wang * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27951a39d68df598db08dfced8b4707755864a0492Ying Wang * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28951a39d68df598db08dfced8b4707755864a0492Ying Wang * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29951a39d68df598db08dfced8b4707755864a0492Ying Wang * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30951a39d68df598db08dfced8b4707755864a0492Ying Wang * SUCH DAMAGE.
31951a39d68df598db08dfced8b4707755864a0492Ying Wang *
32951a39d68df598db08dfced8b4707755864a0492Ying Wang *	@(#)fts.h	8.3 (Berkeley) 8/14/94
33951a39d68df598db08dfced8b4707755864a0492Ying Wang */
34951a39d68df598db08dfced8b4707755864a0492Ying Wang
35951a39d68df598db08dfced8b4707755864a0492Ying Wang#ifndef	_FTS_H_
36951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	_FTS_H_
37951a39d68df598db08dfced8b4707755864a0492Ying Wang
38951a39d68df598db08dfced8b4707755864a0492Ying Wangtypedef struct {
39951a39d68df598db08dfced8b4707755864a0492Ying Wang	struct _ftsent *fts_cur;	/* current node */
40951a39d68df598db08dfced8b4707755864a0492Ying Wang	struct _ftsent *fts_child;	/* linked list of children */
41951a39d68df598db08dfced8b4707755864a0492Ying Wang	struct _ftsent **fts_array;	/* sort array */
42951a39d68df598db08dfced8b4707755864a0492Ying Wang	dev_t fts_dev;			/* starting device # */
43951a39d68df598db08dfced8b4707755864a0492Ying Wang	char *fts_path;			/* path for this descent */
44951a39d68df598db08dfced8b4707755864a0492Ying Wang	int fts_rfd;			/* fd for root */
45951a39d68df598db08dfced8b4707755864a0492Ying Wang	size_t fts_pathlen;		/* sizeof(path) */
46951a39d68df598db08dfced8b4707755864a0492Ying Wang	int fts_nitems;			/* elements in the sort array */
47951a39d68df598db08dfced8b4707755864a0492Ying Wang	int (*fts_compar)();		/* compare function */
48951a39d68df598db08dfced8b4707755864a0492Ying Wang
49951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_COMFOLLOW	0x0001		/* follow command line symlinks */
50951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_LOGICAL	0x0002		/* logical walk */
51951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_NOCHDIR	0x0004		/* don't change directories */
52951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_NOSTAT	0x0008		/* don't get stat info */
53951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_PHYSICAL	0x0010		/* physical walk */
54951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_SEEDOT	0x0020		/* return dot and dot-dot */
55951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_XDEV	0x0040		/* don't cross devices */
56951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_OPTIONMASK	0x00ff		/* valid user option mask */
57951a39d68df598db08dfced8b4707755864a0492Ying Wang
58951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_NAMEONLY	0x1000		/* (private) child names only */
59951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_STOP	0x2000		/* (private) unrecoverable error */
60951a39d68df598db08dfced8b4707755864a0492Ying Wang	int fts_options;		/* fts_open options, global flags */
61951a39d68df598db08dfced8b4707755864a0492Ying Wang} FTS;
62951a39d68df598db08dfced8b4707755864a0492Ying Wang
63951a39d68df598db08dfced8b4707755864a0492Ying Wangtypedef struct _ftsent {
64951a39d68df598db08dfced8b4707755864a0492Ying Wang	struct _ftsent *fts_cycle;	/* cycle node */
65951a39d68df598db08dfced8b4707755864a0492Ying Wang	struct _ftsent *fts_parent;	/* parent directory */
66951a39d68df598db08dfced8b4707755864a0492Ying Wang	struct _ftsent *fts_link;	/* next file in directory */
67951a39d68df598db08dfced8b4707755864a0492Ying Wang	long fts_number;	        /* local numeric value */
68951a39d68df598db08dfced8b4707755864a0492Ying Wang	void *fts_pointer;	        /* local address value */
69951a39d68df598db08dfced8b4707755864a0492Ying Wang	char *fts_accpath;		/* access path */
70951a39d68df598db08dfced8b4707755864a0492Ying Wang	char *fts_path;			/* root path */
71951a39d68df598db08dfced8b4707755864a0492Ying Wang	int fts_errno;			/* errno for this node */
72951a39d68df598db08dfced8b4707755864a0492Ying Wang	int fts_symfd;			/* fd for symlink */
73951a39d68df598db08dfced8b4707755864a0492Ying Wang	size_t fts_pathlen;		/* strlen(fts_path) */
74951a39d68df598db08dfced8b4707755864a0492Ying Wang	size_t fts_namelen;		/* strlen(fts_name) */
75951a39d68df598db08dfced8b4707755864a0492Ying Wang
76951a39d68df598db08dfced8b4707755864a0492Ying Wang	ino_t fts_ino;			/* inode */
77951a39d68df598db08dfced8b4707755864a0492Ying Wang	dev_t fts_dev;			/* device */
78951a39d68df598db08dfced8b4707755864a0492Ying Wang	nlink_t fts_nlink;		/* link count */
79951a39d68df598db08dfced8b4707755864a0492Ying Wang
80951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_ROOTPARENTLEVEL	-1
81951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_ROOTLEVEL		 0
82951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_MAXLEVEL		 0x7fff
83951a39d68df598db08dfced8b4707755864a0492Ying Wang	short fts_level;		/* depth (-1 to N) */
84951a39d68df598db08dfced8b4707755864a0492Ying Wang
85951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_D		 1		/* preorder directory */
86951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_DC		 2		/* directory that causes cycles */
87951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_DEFAULT	 3		/* none of the above */
88951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_DNR		 4		/* unreadable directory */
89951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_DOT		 5		/* dot or dot-dot */
90951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_DP		 6		/* postorder directory */
91951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_ERR		 7		/* error; errno is set */
92951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_F		 8		/* regular file */
93951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_INIT	 9		/* initialized only */
94951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_NS		10		/* stat(2) failed */
95951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_NSOK	11		/* no stat(2) requested */
96951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_SL		12		/* symbolic link */
97951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_SLNONE	13		/* symbolic link without target */
98951a39d68df598db08dfced8b4707755864a0492Ying Wang	unsigned short fts_info;	/* user flags for FTSENT structure */
99951a39d68df598db08dfced8b4707755864a0492Ying Wang
100951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_DONTCHDIR	 0x01		/* don't chdir .. to the parent */
101951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_SYMFOLLOW	 0x02		/* followed a symlink to get here */
102951a39d68df598db08dfced8b4707755864a0492Ying Wang	unsigned short fts_flags;	/* private flags for FTSENT structure */
103951a39d68df598db08dfced8b4707755864a0492Ying Wang
104951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_AGAIN	 1		/* read node again */
105951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_FOLLOW	 2		/* follow symbolic link */
106951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_NOINSTR	 3		/* no instructions */
107951a39d68df598db08dfced8b4707755864a0492Ying Wang#define	FTS_SKIP	 4		/* discard node */
108951a39d68df598db08dfced8b4707755864a0492Ying Wang	unsigned short fts_instr;	/* fts_set() instructions */
109951a39d68df598db08dfced8b4707755864a0492Ying Wang
110951a39d68df598db08dfced8b4707755864a0492Ying Wang	struct stat *fts_statp;		/* stat(2) information */
111951a39d68df598db08dfced8b4707755864a0492Ying Wang	char fts_name[1];		/* file name */
112951a39d68df598db08dfced8b4707755864a0492Ying Wang} FTSENT;
113951a39d68df598db08dfced8b4707755864a0492Ying Wang
114951a39d68df598db08dfced8b4707755864a0492Ying Wang#include <sys/cdefs.h>
115951a39d68df598db08dfced8b4707755864a0492Ying Wang
116951a39d68df598db08dfced8b4707755864a0492Ying Wang__BEGIN_DECLS
117951a39d68df598db08dfced8b4707755864a0492Ying WangFTSENT	*fts_children(FTS *, int);
118951a39d68df598db08dfced8b4707755864a0492Ying Wangint	 fts_close(FTS *);
119951a39d68df598db08dfced8b4707755864a0492Ying WangFTS	*fts_open(char * const *, int,
120951a39d68df598db08dfced8b4707755864a0492Ying Wang	    int (*)(const FTSENT **, const FTSENT **));
121951a39d68df598db08dfced8b4707755864a0492Ying WangFTSENT	*fts_read(FTS *);
122951a39d68df598db08dfced8b4707755864a0492Ying Wangint	 fts_set(FTS *, FTSENT *, int);
123951a39d68df598db08dfced8b4707755864a0492Ying Wang__END_DECLS
124951a39d68df598db08dfced8b4707755864a0492Ying Wang
125951a39d68df598db08dfced8b4707755864a0492Ying Wang#endif /* !_FTS_H_ */
126