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