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