1 /*	$OpenBSD: fts.h,v 1.12 2009/08/27 16:19:27 millert Exp $	*/
2 /*	$NetBSD: fts.h,v 1.5 1994/12/28 01:41:50 mycroft Exp $	*/
3 
4 /*
5  * Copyright (c) 1989, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *	@(#)fts.h	8.3 (Berkeley) 8/14/94
33  */
34 
35 #ifndef	_FTS_H_
36 #define	_FTS_H_
37 
38 #include <sys/cdefs.h>
39 #include <sys/types.h>
40 
41 typedef struct {
42 	struct _ftsent *fts_cur;	/* current node */
43 	struct _ftsent *fts_child;	/* linked list of children */
44 	struct _ftsent **fts_array;	/* sort array */
45 	dev_t fts_dev;			/* starting device # */
46 	char *fts_path;			/* path for this descent */
47 	int fts_rfd;			/* fd for root */
48 	size_t fts_pathlen;		/* sizeof(path) */
49 	int fts_nitems;			/* elements in the sort array */
50 	int (*fts_compar)();		/* compare function */
51 
52 #define	FTS_COMFOLLOW	0x0001		/* follow command line symlinks */
53 #define	FTS_LOGICAL	0x0002		/* logical walk */
54 #define	FTS_NOCHDIR	0x0004		/* don't change directories */
55 #define	FTS_NOSTAT	0x0008		/* don't get stat info */
56 #define	FTS_PHYSICAL	0x0010		/* physical walk */
57 #define	FTS_SEEDOT	0x0020		/* return dot and dot-dot */
58 #define	FTS_XDEV	0x0040		/* don't cross devices */
59 #define	FTS_OPTIONMASK	0x00ff		/* valid user option mask */
60 
61 #define	FTS_NAMEONLY	0x1000		/* (private) child names only */
62 #define	FTS_STOP	0x2000		/* (private) unrecoverable error */
63 	int fts_options;		/* fts_open options, global flags */
64 } FTS;
65 
66 typedef struct _ftsent {
67 	struct _ftsent *fts_cycle;	/* cycle node */
68 	struct _ftsent *fts_parent;	/* parent directory */
69 	struct _ftsent *fts_link;	/* next file in directory */
70 	long fts_number;	        /* local numeric value */
71 	void *fts_pointer;	        /* local address value */
72 	char *fts_accpath;		/* access path */
73 	char *fts_path;			/* root path */
74 	int fts_errno;			/* errno for this node */
75 	int fts_symfd;			/* fd for symlink */
76 	size_t fts_pathlen;		/* strlen(fts_path) */
77 	size_t fts_namelen;		/* strlen(fts_name) */
78 
79 	ino_t fts_ino;			/* inode */
80 	dev_t fts_dev;			/* device */
81 	nlink_t fts_nlink;		/* link count */
82 
83 #define	FTS_ROOTPARENTLEVEL	-1
84 #define	FTS_ROOTLEVEL		 0
85 #define	FTS_MAXLEVEL		 0x7fff
86 	short fts_level;		/* depth (-1 to N) */
87 
88 #define	FTS_D		 1		/* preorder directory */
89 #define	FTS_DC		 2		/* directory that causes cycles */
90 #define	FTS_DEFAULT	 3		/* none of the above */
91 #define	FTS_DNR		 4		/* unreadable directory */
92 #define	FTS_DOT		 5		/* dot or dot-dot */
93 #define	FTS_DP		 6		/* postorder directory */
94 #define	FTS_ERR		 7		/* error; errno is set */
95 #define	FTS_F		 8		/* regular file */
96 #define	FTS_INIT	 9		/* initialized only */
97 #define	FTS_NS		10		/* stat(2) failed */
98 #define	FTS_NSOK	11		/* no stat(2) requested */
99 #define	FTS_SL		12		/* symbolic link */
100 #define	FTS_SLNONE	13		/* symbolic link without target */
101 	unsigned short fts_info;	/* user flags for FTSENT structure */
102 
103 #define	FTS_DONTCHDIR	 0x01		/* don't chdir .. to the parent */
104 #define	FTS_SYMFOLLOW	 0x02		/* followed a symlink to get here */
105 	unsigned short fts_flags;	/* private flags for FTSENT structure */
106 
107 #define	FTS_AGAIN	 1		/* read node again */
108 #define	FTS_FOLLOW	 2		/* follow symbolic link */
109 #define	FTS_NOINSTR	 3		/* no instructions */
110 #define	FTS_SKIP	 4		/* discard node */
111 	unsigned short fts_instr;	/* fts_set() instructions */
112 
113 	struct stat *fts_statp;		/* stat(2) information */
114 	char fts_name[1];		/* file name */
115 } FTSENT;
116 
117 __BEGIN_DECLS
118 FTSENT	*fts_children(FTS *, int);
119 int	 fts_close(FTS *);
120 FTS	*fts_open(char * const *, int,
121 	    int (*)(const FTSENT **, const FTSENT **));
122 FTSENT	*fts_read(FTS *);
123 int	 fts_set(FTS *, FTSENT *, int);
124 __END_DECLS
125 
126 #endif /* !_FTS_H_ */
127