]> git.saurik.com Git - apple/libc.git/blame - include/fts.h
Libc-1353.100.2.tar.gz
[apple/libc.git] / include / fts.h
CommitLineData
5b2abdfb 1/*
6465356a 2 * Copyright (c) 2000, 2003-2006, 2008, 2012 Apple Inc. All rights reserved.
5b2abdfb
A
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
734aad71
A
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
5b2abdfb
A
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
734aad71
A
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.
5b2abdfb
A
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
224c7076 61#include <sys/_types.h>
6465356a
A
62#include <sys/_types/_dev_t.h>
63#include <sys/_types/_ino_t.h>
64#include <sys/_types/_nlink_t.h>
224c7076 65
5f125488
A
66#include <Availability.h>
67
70ad1dc8
A
68#pragma clang diagnostic push
69#pragma clang diagnostic ignored "-Wstrict-prototypes"
70
5b2abdfb
A
71typedef struct {
72 struct _ftsent *fts_cur; /* current node */
73 struct _ftsent *fts_child; /* linked list of children */
74 struct _ftsent **fts_array; /* sort array */
75 dev_t fts_dev; /* starting device # */
76 char *fts_path; /* path for this descent */
77 int fts_rfd; /* fd for root */
78 int fts_pathlen; /* sizeof(path) */
79 int fts_nitems; /* elements in the sort array */
34e8f829
A
80#ifdef __BLOCKS__
81 union {
82#endif /* __BLOCKS__ */
83 int (*fts_compar)(); /* compare function */
84#ifdef __BLOCKS__
85 int (^fts_compar_b)(); /* compare block */
86 };
87#endif /* __BLOCKS__ */
5b2abdfb
A
88
89#define FTS_COMFOLLOW 0x001 /* follow command line symlinks */
90#define FTS_LOGICAL 0x002 /* logical walk */
91#define FTS_NOCHDIR 0x004 /* don't change directories */
92#define FTS_NOSTAT 0x008 /* don't get stat info */
93#define FTS_PHYSICAL 0x010 /* physical walk */
94#define FTS_SEEDOT 0x020 /* return dot and dot-dot */
95#define FTS_XDEV 0x040 /* don't cross devices */
974e3884 96#define FTS_WHITEOUT 0x080 /* (no longer supported) return whiteout information */
224c7076 97#define FTS_COMFOLLOWDIR 0x400 /* (non-std) follow command line symlinks for directories only */
5f125488
A
98#if (defined(__MAC_OS_X_VERSION_MIN_REQUIRED) && __MAC_OS_X_VERSION_MIN_REQUIRED < 1090) || (defined(__IPHONE_OS_VERSION_MIN_REQUIRED) && __IPHONE_OS_VERSION_MIN_REQUIRED < 70000)
99#define FTS_OPTIONMASK 0x4ff /* valid user option mask */
100#else
6465356a
A
101#define FTS_NOSTAT_TYPE 0x800 /* (non-std) no stat, but use d_type in struct dirent when available */
102#define FTS_OPTIONMASK 0xcff /* valid user option mask */
6465356a 103#endif
5b2abdfb
A
104
105#define FTS_NAMEONLY 0x100 /* (private) child names only */
106#define FTS_STOP 0x200 /* (private) unrecoverable error */
34e8f829
A
107#ifdef __BLOCKS__
108#define FTS_BLOCK_COMPAR 0x80000000 /* fts_compar is a block */
109#endif /* __BLOCKS__ */
5b2abdfb
A
110 int fts_options; /* fts_open options, global flags */
111} FTS;
112
113typedef struct _ftsent {
114 struct _ftsent *fts_cycle; /* cycle node */
115 struct _ftsent *fts_parent; /* parent directory */
116 struct _ftsent *fts_link; /* next file in directory */
117 long fts_number; /* local numeric value */
118 void *fts_pointer; /* local address value */
119 char *fts_accpath; /* access path */
120 char *fts_path; /* root path */
121 int fts_errno; /* errno for this node */
122 int fts_symfd; /* fd for symlink */
3d9156a7
A
123 unsigned short fts_pathlen; /* strlen(fts_path) */
124 unsigned short fts_namelen; /* strlen(fts_name) */
5b2abdfb
A
125
126 ino_t fts_ino; /* inode */
127 dev_t fts_dev; /* device */
128 nlink_t fts_nlink; /* link count */
129
130#define FTS_ROOTPARENTLEVEL -1
131#define FTS_ROOTLEVEL 0
974e3884 132#define FTS_MAXLEVEL 0x7fffffff
5b2abdfb
A
133 short fts_level; /* depth (-1 to N) */
134
135#define FTS_D 1 /* preorder directory */
136#define FTS_DC 2 /* directory that causes cycles */
137#define FTS_DEFAULT 3 /* none of the above */
138#define FTS_DNR 4 /* unreadable directory */
139#define FTS_DOT 5 /* dot or dot-dot */
140#define FTS_DP 6 /* postorder directory */
141#define FTS_ERR 7 /* error; errno is set */
142#define FTS_F 8 /* regular file */
143#define FTS_INIT 9 /* initialized only */
144#define FTS_NS 10 /* stat(2) failed */
145#define FTS_NSOK 11 /* no stat(2) requested */
146#define FTS_SL 12 /* symbolic link */
147#define FTS_SLNONE 13 /* symbolic link without target */
148#define FTS_W 14 /* whiteout object */
3d9156a7 149 unsigned short fts_info; /* user flags for FTSENT structure */
5b2abdfb
A
150
151#define FTS_DONTCHDIR 0x01 /* don't chdir .. to the parent */
152#define FTS_SYMFOLLOW 0x02 /* followed a symlink to get here */
153#define FTS_ISW 0x04 /* this is a whiteout object */
3d9156a7 154 unsigned short fts_flags; /* private flags for FTSENT structure */
5b2abdfb
A
155
156#define FTS_AGAIN 1 /* read node again */
157#define FTS_FOLLOW 2 /* follow symbolic link */
158#define FTS_NOINSTR 3 /* no instructions */
159#define FTS_SKIP 4 /* discard node */
3d9156a7 160 unsigned short fts_instr; /* fts_set() instructions */
5b2abdfb
A
161
162 struct stat *fts_statp; /* stat(2) information */
163 char fts_name[1]; /* file name */
164} FTSENT;
165
166#include <sys/cdefs.h>
1f2f436a 167#include <Availability.h>
5b2abdfb
A
168
169__BEGIN_DECLS
224c7076
A
170//Begin-Libc
171#ifndef LIBC_ALIAS_FTS_CHILDREN
172//End-Libc
173FTSENT *fts_children(FTS *, int) __DARWIN_INODE64(fts_children);
174//Begin-Libc
175#else /* LIBC_ALIAS_FTS_CHILDREN */
176FTSENT *fts_children(FTS *, int) LIBC_INODE64(fts_children);
177#endif /* !LIBC_ALIAS_FTS_CHILDREN */
178//End-Libc
179//Begin-Libc
180#ifndef LIBC_ALIAS_FTS_CLOSE
181//End-Libc
182int fts_close(FTS *) __DARWIN_INODE64(fts_close);
183//Begin-Libc
184#else /* LIBC_ALIAS_FTS_CLOSE */
185int fts_close(FTS *) LIBC_INODE64(fts_close);
186#endif /* !LIBC_ALIAS_FTS_CLOSE */
187//End-Libc
188//Begin-Libc
189#ifndef LIBC_ALIAS_FTS_OPEN
190//End-Libc
191FTS *fts_open(char * const *, int,
192 int (*)(const FTSENT **, const FTSENT **)) __DARWIN_INODE64(fts_open);
193//Begin-Libc
194#else /* LIBC_ALIAS_FTS_OPEN */
9385eb3d 195FTS *fts_open(char * const *, int,
224c7076
A
196 int (*)(const FTSENT **, const FTSENT **)) LIBC_INODE64(fts_open);
197#endif /* !LIBC_ALIAS_FTS_OPEN */
198//End-Libc
34e8f829 199#ifdef __BLOCKS__
507116e3
A
200#if __has_attribute(noescape)
201#define __fts_noescape __attribute__((__noescape__))
202#else
203#define __fts_noescape
204#endif
34e8f829
A
205//Begin-Libc
206#ifndef LIBC_ALIAS_FTS_OPEN_B
207//End-Libc
208FTS *fts_open_b(char * const *, int,
507116e3
A
209 int (^)(const FTSENT **, const FTSENT **) __fts_noescape)
210 __DARWIN_INODE64(fts_open_b) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
34e8f829
A
211//Begin-Libc
212#else /* LIBC_ALIAS_FTS_OPEN */
213FTS *fts_open_b(char * const *, int,
507116e3
A
214 int (^)(const FTSENT **, const FTSENT **) __fts_noescape)
215 LIBC_INODE64(fts_open_b);
34e8f829
A
216#endif /* !LIBC_ALIAS_FTS_OPEN */
217//End-Libc
218#endif /* __BLOCKS__ */
224c7076
A
219//Begin-Libc
220#ifndef LIBC_ALIAS_FTS_READ
221//End-Libc
222FTSENT *fts_read(FTS *) __DARWIN_INODE64(fts_read);
223//Begin-Libc
224#else /* LIBC_ALIAS_FTS_READ */
225FTSENT *fts_read(FTS *) LIBC_INODE64(fts_read);
226#endif /* !LIBC_ALIAS_FTS_READ */
227//End-Libc
228//Begin-Libc
229#ifndef LIBC_ALIAS_FTS_SET
230//End-Libc
231int fts_set(FTS *, FTSENT *, int) __DARWIN_INODE64(fts_set);
232//Begin-Libc
233#else /* LIBC_ALIAS_FTS_SET */
234int fts_set(FTS *, FTSENT *, int) LIBC_INODE64(fts_set);
235#endif /* !LIBC_ALIAS_FTS_SET */
236//End-Libc
5b2abdfb
A
237__END_DECLS
238
70ad1dc8 239#pragma clang diagnostic pop
5b2abdfb 240#endif /* !_FTS_H_ */
70ad1dc8 241