xref: /386bsd/usr/include/fts.h (revision a2142627)
1 /*
2  * Copyright (c) 1989, 1993
3  *	The Regents of the University of California.  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	8.1 (Berkeley) 6/2/93
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_array;	/* sort array */
43 	dev_t fts_dev;			/* starting device # */
44 	char *fts_path;			/* path for this descent */
45 	int fts_rfd;			/* fd for root */
46 	int fts_pathlen;		/* sizeof(path) */
47 	int fts_nitems;			/* elements in the sort array */
48 	int (*fts_compar)();		/* compare function */
49 
50 #define	FTS_COMFOLLOW	0x001		/* follow command line symlinks */
51 #define	FTS_LOGICAL	0x002		/* logical walk */
52 #define	FTS_NOCHDIR	0x004		/* don't change directories */
53 #define	FTS_NOSTAT	0x008		/* don't get stat info */
54 #define	FTS_PHYSICAL	0x010		/* physical walk */
55 #define	FTS_SEEDOT	0x020		/* return dot and dot-dot */
56 #define	FTS_XDEV	0x040		/* don't cross devices */
57 #define	FTS_OPTIONMASK	0x07f		/* valid user option mask */
58 
59 #define	FTS_NAMEONLY	0x080		/* (private) child names only */
60 #define	FTS_STOP	0x100		/* (private) unrecoverable error */
61 	int fts_options;		/* fts_open options, global flags */
62 } FTS;
63 
64 typedef struct _ftsent {
65 	struct _ftsent *fts_cycle;	/* cycle node */
66 	struct _ftsent *fts_parent;	/* parent directory */
67 	struct _ftsent *fts_link;	/* next file in directory */
68 	long fts_number;	        /* local numeric value */
69 	void *fts_pointer;	        /* local address value */
70 	char *fts_accpath;		/* access path */
71 	char *fts_path;			/* root path */
72 	int fts_errno;			/* errno for this node */
73 	int fts_symfd;			/* fd for symlink */
74 	u_short fts_pathlen;		/* strlen(fts_path) */
75 	u_short fts_namelen;		/* strlen(fts_name) */
76 
77 	ino_t fts_ino;			/* inode */
78 	dev_t fts_dev;			/* device */
79 	nlink_t fts_nlink;		/* link count */
80 
81 #define	FTS_ROOTPARENTLEVEL	-1
82 #define	FTS_ROOTLEVEL		 0
83 	short fts_level;		/* depth (-1 to N) */
84 
85 #define	FTS_D		 1		/* preorder directory */
86 #define	FTS_DC		 2		/* directory that causes cycles */
87 #define	FTS_DEFAULT	 3		/* none of the above */
88 #define	FTS_DNR		 4		/* unreadable directory */
89 #define	FTS_DOT		 5		/* dot or dot-dot */
90 #define	FTS_DP		 6		/* postorder directory */
91 #define	FTS_ERR		 7		/* error; errno is set */
92 #define	FTS_F		 8		/* regular file */
93 #define	FTS_INIT	 9		/* initialized only */
94 #define	FTS_NS		10		/* stat(2) failed */
95 #define	FTS_NSOK	11		/* no stat(2) requested */
96 #define	FTS_SL		12		/* symbolic link */
97 #define	FTS_SLNONE	13		/* symbolic link without target */
98 	u_short fts_info;		/* user flags for FTSENT structure */
99 
100 #define	FTS_DONTCHDIR	 0x01		/* don't chdir .. to the parent */
101 #define	FTS_SYMFOLLOW	 0x02		/* followed a symlink to get here */
102 	u_short fts_flags;		/* private flags for FTSENT structure */
103 
104 #define	FTS_AGAIN	 1		/* read node again */
105 #define	FTS_FOLLOW	 2		/* follow symbolic link */
106 #define	FTS_NOINSTR	 3		/* no instructions */
107 #define	FTS_SKIP	 4		/* discard node */
108 	u_short fts_instr;		/* fts_set() instructions */
109 
110 	struct stat *fts_statp;		/* stat(2) information */
111 	char fts_name[1];		/* file name */
112 } FTSENT;
113 
114 #include <sys/cdefs.h>
115 
116 __BEGIN_DECLS
117 FTSENT	*fts_children __P((FTS *, int));
118 int	 fts_close __P((FTS *));
119 FTS	*fts_open __P((char * const *, int,
120 	    int (*)(const FTSENT **, const FTSENT **)));
121 FTSENT	*fts_read __P((FTS *));
122 int	 fts_set __P((FTS *, FTSENT *, int));
123 __END_DECLS
124 
125 #endif /* !_FTS_H_ */
126