1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1989, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 */
31
32#ifndef _FTS_H_
33#define _FTS_H_
34
35#include <sys/_types.h>
36
37typedef struct _ftsent FTSENT;
38
39typedef struct {
40 FTSENT *fts_cur; /* current node */
41 FTSENT *fts_child; /* linked list of children */
42 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 __size_t fts_pathlen; /* sizeof(path) */
47 __size_t fts_nitems; /* elements in the sort array */
48 union {
49 int (*fts_compar) /* compare function */
50 (const FTSENT * const *, const FTSENT * const *);
51#ifdef __BLOCKS__
52 int (^fts_compar_b)
53 (const FTSENT * const *, const FTSENT * const *);
54#else
55 void *fts_compar_b;
56#endif /* __BLOCKS__ */
57 };
58
59/* valid for fts_open() */
60#define FTS_COMFOLLOW 0x000001 /* follow command line symlinks */
61#define FTS_LOGICAL 0x000002 /* logical walk */
62#define FTS_NOCHDIR 0x000004 /* don't change directories */
63#define FTS_NOSTAT 0x000008 /* don't get stat info */
64#define FTS_PHYSICAL 0x000010 /* physical walk */
65#define FTS_SEEDOT 0x000020 /* return dot and dot-dot */
66#define FTS_XDEV 0x000040 /* don't cross devices */
67#define FTS_WHITEOUT 0x000080 /* return whiteout information */
68 /* 0x0100 is FTS_NAMEONLY below */
69 /* 0x0200 was previously FTS_STOP */
70#define FTS_COMFOLLOWDIR 0x00400 /* like COMFOLLOW but directories only */
71#define FTS_NOSTAT_TYPE 0x000800 /* like NOSTAT but use d_type */
72#define FTS_OPTIONMASK 0x000cff /* valid user option mask */
73
74/* valid only for fts_children() */
75#define FTS_NAMEONLY 0x000100 /* child names only */
76
77/* internal use only */
78#define FTS_STOP 0x010000 /* unrecoverable error */
79#define FTS_COMPAR_B 0x020000 /* compare function is a block */
80 int fts_options; /* fts_open options, global flags */
81 void *fts_clientptr; /* thunk for sort function */
82} FTS;
83
84struct _ftsent {
85 struct _ftsent *fts_cycle; /* cycle node */
86 struct _ftsent *fts_parent; /* parent directory */
87 struct _ftsent *fts_link; /* next file in directory */
88 long long fts_number; /* local numeric value */
89#define fts_bignum fts_number /* XXX non-std, should go away */
90 void *fts_pointer; /* local address value */
91 char *fts_accpath; /* access path */
92 char *fts_path; /* root path */
93 int fts_errno; /* errno for this node */
94 int fts_symfd; /* fd for symlink */
95 __size_t fts_pathlen; /* strlen(fts_path) */
96 __size_t fts_namelen; /* strlen(fts_name) */
97
98 __ino_t fts_ino; /* inode */
99 __dev_t fts_dev; /* device */
100 __nlink_t fts_nlink; /* link count */
101
102#define FTS_ROOTPARENTLEVEL -1
103#define FTS_ROOTLEVEL 0
104 long fts_level; /* depth (-1 to N) */
105
106#define FTS_D 1 /* preorder directory */
107#define FTS_DC 2 /* directory that causes cycles */
108#define FTS_DEFAULT 3 /* none of the above */
109#define FTS_DNR 4 /* unreadable directory */
110#define FTS_DOT 5 /* dot or dot-dot */
111#define FTS_DP 6 /* postorder directory */
112#define FTS_ERR 7 /* error; errno is set */
113#define FTS_F 8 /* regular file */
114#define FTS_INIT 9 /* initialized only */
115#define FTS_NS 10 /* stat(2) failed */
116#define FTS_NSOK 11 /* no stat(2) requested */
117#define FTS_SL 12 /* symbolic link */
118#define FTS_SLNONE 13 /* symbolic link without target */
119#define FTS_W 14 /* whiteout object */
120 int fts_info; /* user status for FTSENT structure */
121
122#define FTS_DONTCHDIR 0x01 /* don't chdir .. to the parent */
123#define FTS_SYMFOLLOW 0x02 /* followed a symlink to get here */
124#define FTS_ISW 0x04 /* this is a whiteout object */
125 unsigned fts_flags; /* private flags for FTSENT structure */
126
127#define FTS_AGAIN 1 /* read node again */
128#define FTS_FOLLOW 2 /* follow symbolic link */
129#define FTS_NOINSTR 3 /* no instructions */
130#define FTS_SKIP 4 /* discard node */
131 int fts_instr; /* fts_set() instructions */
132
133 struct stat *fts_statp; /* stat(2) information */
134 char *fts_name; /* file name */
135 FTS *fts_fts; /* back pointer to main FTS */
136};
137
138#include <sys/cdefs.h>
139
140__BEGIN_DECLS
141FTSENT *fts_children(FTS *, int);
142int fts_close(FTS *);
143void *fts_get_clientptr(FTS *);
144#define fts_get_clientptr(fts) ((fts)->fts_clientptr)
145FTS *fts_get_stream(FTSENT *);
146#define fts_get_stream(ftsent) ((ftsent)->fts_fts)
147FTS *fts_open(char * const *, int,
148 int (*)(const FTSENT * const *, const FTSENT * const *));
149#ifdef __BLOCKS__
150FTS *fts_open_b(char * const *, int,
151 int (^)(const FTSENT * const *, const FTSENT * const *));
152#endif /* __BLOCKS__ */
153FTSENT *fts_read(FTS *);
154int fts_set(FTS *, FTSENT *, int);
155void fts_set_clientptr(FTS *, void *);
156__END_DECLS
157
158#endif /* !_FTS_H_ */