1/*
2 * Copyright (c) 2000, 2003-2006, 2008, 2012 Apple Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
11 * file.
12 *
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
20 *
21 * @APPLE_LICENSE_HEADER_END@
22 */
23/*
24 * Copyright (c) 1989, 1993
25 *	The Regents of the University of California.  All rights reserved.
26 *
27 * Redistribution and use in source and binary forms, with or without
28 * modification, are permitted provided that the following conditions
29 * are met:
30 * 1. Redistributions of source code must retain the above copyright
31 *    notice, this list of conditions and the following disclaimer.
32 * 2. Redistributions in binary form must reproduce the above copyright
33 *    notice, this list of conditions and the following disclaimer in the
34 *    documentation and/or other materials provided with the distribution.
35 * 3. All advertising materials mentioning features or use of this software
36 *    must display the following acknowledgement:
37 *	This product includes software developed by the University of
38 *	California, Berkeley and its contributors.
39 * 4. Neither the name of the University nor the names of its contributors
40 *    may be used to endorse or promote products derived from this software
41 *    without specific prior written permission.
42 *
43 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
44 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
45 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
46 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
47 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
48 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
49 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
50 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
51 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
52 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * SUCH DAMAGE.
54 *
55 *	@(#)fts.h	8.3 (Berkeley) 8/14/94
56 */
57
58#ifndef	_FTS_H_
59#define	_FTS_H_
60
61#include <sys/_types.h>
62#include <sys/_types/_dev_t.h>
63#include <sys/_types/_ino_t.h>
64#include <sys/_types/_nlink_t.h>
65
66typedef struct {
67	struct _ftsent *fts_cur;	/* current node */
68	struct _ftsent *fts_child;	/* linked list of children */
69	struct _ftsent **fts_array;	/* sort array */
70	dev_t fts_dev;			/* starting device # */
71	char *fts_path;			/* path for this descent */
72	int fts_rfd;			/* fd for root */
73	int fts_pathlen;		/* sizeof(path) */
74	int fts_nitems;			/* elements in the sort array */
75#ifdef __BLOCKS__
76	union {
77#endif /* __BLOCKS__ */
78	    int (*fts_compar)();	/* compare function */
79#ifdef __BLOCKS__
80	    int (^fts_compar_b)();	/* compare block */
81	};
82#endif /* __BLOCKS__ */
83
84#define	FTS_COMFOLLOW	0x001		/* follow command line symlinks */
85#define	FTS_LOGICAL	0x002		/* logical walk */
86#define	FTS_NOCHDIR	0x004		/* don't change directories */
87#define	FTS_NOSTAT	0x008		/* don't get stat info */
88#define	FTS_PHYSICAL	0x010		/* physical walk */
89#define	FTS_SEEDOT	0x020		/* return dot and dot-dot */
90#define	FTS_XDEV	0x040		/* don't cross devices */
91#define	FTS_WHITEOUT	0x080		/* return whiteout information */
92#define	FTS_COMFOLLOWDIR 0x400		/* (non-std) follow command line symlinks for directories only */
93#if (defined(__ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__) && __ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__ >= 1090) || (defined(__ENVIRONMENT_IPHONE_OS_VERSION_MIN_REQUIRED__) && __ENVIRONMENT_IPHONE_OS_VERSION_MIN_REQUIRED__ >= 70000)
94#define	FTS_NOSTAT_TYPE	0x800		/* (non-std) no stat, but use d_type in struct dirent when available */
95#define	FTS_OPTIONMASK	0xcff		/* valid user option mask */
96#else
97#define	FTS_OPTIONMASK	0x4ff		/* valid user option mask */
98#endif
99
100#define	FTS_NAMEONLY	0x100		/* (private) child names only */
101#define	FTS_STOP	0x200		/* (private) unrecoverable error */
102#ifdef __BLOCKS__
103#define	FTS_BLOCK_COMPAR 0x80000000	/* fts_compar is a block */
104#endif /* __BLOCKS__ */
105	int fts_options;		/* fts_open options, global flags */
106} FTS;
107
108typedef struct _ftsent {
109	struct _ftsent *fts_cycle;	/* cycle node */
110	struct _ftsent *fts_parent;	/* parent directory */
111	struct _ftsent *fts_link;	/* next file in directory */
112	long fts_number;	        /* local numeric value */
113	void *fts_pointer;	        /* local address value */
114	char *fts_accpath;		/* access path */
115	char *fts_path;			/* root path */
116	int fts_errno;			/* errno for this node */
117	int fts_symfd;			/* fd for symlink */
118	unsigned short fts_pathlen;	/* strlen(fts_path) */
119	unsigned short fts_namelen;	/* strlen(fts_name) */
120
121	ino_t fts_ino;			/* inode */
122	dev_t fts_dev;			/* device */
123	nlink_t fts_nlink;		/* link count */
124
125#define	FTS_ROOTPARENTLEVEL	-1
126#define	FTS_ROOTLEVEL		 0
127	short fts_level;		/* depth (-1 to N) */
128
129#define	FTS_D		 1		/* preorder directory */
130#define	FTS_DC		 2		/* directory that causes cycles */
131#define	FTS_DEFAULT	 3		/* none of the above */
132#define	FTS_DNR		 4		/* unreadable directory */
133#define	FTS_DOT		 5		/* dot or dot-dot */
134#define	FTS_DP		 6		/* postorder directory */
135#define	FTS_ERR		 7		/* error; errno is set */
136#define	FTS_F		 8		/* regular file */
137#define	FTS_INIT	 9		/* initialized only */
138#define	FTS_NS		10		/* stat(2) failed */
139#define	FTS_NSOK	11		/* no stat(2) requested */
140#define	FTS_SL		12		/* symbolic link */
141#define	FTS_SLNONE	13		/* symbolic link without target */
142#define	FTS_W		14		/* whiteout object */
143	unsigned short fts_info;	/* user flags for FTSENT structure */
144
145#define	FTS_DONTCHDIR	 0x01		/* don't chdir .. to the parent */
146#define	FTS_SYMFOLLOW	 0x02		/* followed a symlink to get here */
147#define	FTS_ISW		 0x04		/* this is a whiteout object */
148	unsigned short fts_flags;	/* private flags for FTSENT structure */
149
150#define	FTS_AGAIN	 1		/* read node again */
151#define	FTS_FOLLOW	 2		/* follow symbolic link */
152#define	FTS_NOINSTR	 3		/* no instructions */
153#define	FTS_SKIP	 4		/* discard node */
154	unsigned short fts_instr;	/* fts_set() instructions */
155
156	struct stat *fts_statp;		/* stat(2) information */
157	char fts_name[1];		/* file name */
158} FTSENT;
159
160#include <sys/cdefs.h>
161#include <Availability.h>
162
163__BEGIN_DECLS
164//Begin-Libc
165#ifndef LIBC_ALIAS_FTS_CHILDREN
166//End-Libc
167FTSENT	*fts_children(FTS *, int) __DARWIN_INODE64(fts_children);
168//Begin-Libc
169#else /* LIBC_ALIAS_FTS_CHILDREN */
170FTSENT	*fts_children(FTS *, int) LIBC_INODE64(fts_children);
171#endif /* !LIBC_ALIAS_FTS_CHILDREN */
172//End-Libc
173//Begin-Libc
174#ifndef LIBC_ALIAS_FTS_CLOSE
175//End-Libc
176int	 fts_close(FTS *) __DARWIN_INODE64(fts_close);
177//Begin-Libc
178#else /* LIBC_ALIAS_FTS_CLOSE */
179int	 fts_close(FTS *) LIBC_INODE64(fts_close);
180#endif /* !LIBC_ALIAS_FTS_CLOSE */
181//End-Libc
182//Begin-Libc
183#ifndef LIBC_ALIAS_FTS_OPEN
184//End-Libc
185FTS	*fts_open(char * const *, int,
186	    int (*)(const FTSENT **, const FTSENT **)) __DARWIN_INODE64(fts_open);
187//Begin-Libc
188#else /* LIBC_ALIAS_FTS_OPEN */
189FTS	*fts_open(char * const *, int,
190	    int (*)(const FTSENT **, const FTSENT **)) LIBC_INODE64(fts_open);
191#endif /* !LIBC_ALIAS_FTS_OPEN */
192//End-Libc
193#ifdef __BLOCKS__
194//Begin-Libc
195#ifndef LIBC_ALIAS_FTS_OPEN_B
196//End-Libc
197FTS	*fts_open_b(char * const *, int,
198	    int (^)(const FTSENT **, const FTSENT **)) __DARWIN_INODE64(fts_open_b) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
199//Begin-Libc
200#else /* LIBC_ALIAS_FTS_OPEN */
201FTS	*fts_open_b(char * const *, int,
202	    int (^)(const FTSENT **, const FTSENT **)) LIBC_INODE64(fts_open_b);
203#endif /* !LIBC_ALIAS_FTS_OPEN */
204//End-Libc
205#endif /* __BLOCKS__ */
206//Begin-Libc
207#ifndef LIBC_ALIAS_FTS_READ
208//End-Libc
209FTSENT	*fts_read(FTS *) __DARWIN_INODE64(fts_read);
210//Begin-Libc
211#else /* LIBC_ALIAS_FTS_READ */
212FTSENT	*fts_read(FTS *) LIBC_INODE64(fts_read);
213#endif /* !LIBC_ALIAS_FTS_READ */
214//End-Libc
215//Begin-Libc
216#ifndef LIBC_ALIAS_FTS_SET
217//End-Libc
218int	 fts_set(FTS *, FTSENT *, int) __DARWIN_INODE64(fts_set);
219//Begin-Libc
220#else /* LIBC_ALIAS_FTS_SET */
221int	 fts_set(FTS *, FTSENT *, int) LIBC_INODE64(fts_set);
222#endif /* !LIBC_ALIAS_FTS_SET */
223//End-Libc
224__END_DECLS
225
226#endif /* !_FTS_H_ */
227