2 * Copyright (c) 1989, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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 * 4. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * * Portions Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
30 * @(#)fts.h 8.3 (Berkeley) 8/14/94
31 * $FreeBSD: src/include/fts.h,v 1.11 2005/01/07 00:06:20 pjd Exp $
38 struct _ftsent *fts_cur; /* current node */
39 struct _ftsent *fts_child; /* linked list of children */
40 struct _ftsent **fts_array; /* sort array */
41 dev_t fts_dev; /* starting device # */
42 char *fts_path; /* path for this descent */
43 int fts_rfd; /* fd for root */
44 int fts_pathlen; /* sizeof(path) */
45 int fts_nitems; /* elements in the sort array */
46 int (*fts_compar) /* compare function */
47 (const struct _ftsent * const *, const struct _ftsent * const *);
49 #define FTS_COMFOLLOW 0x001 /* follow command line symlinks */
50 #define FTS_LOGICAL 0x002 /* logical walk */
51 #define FTS_NOCHDIR 0x004 /* don't change directories */
52 #define FTS_NOSTAT 0x008 /* don't get stat info */
53 #define FTS_PHYSICAL 0x010 /* physical walk */
54 #define FTS_SEEDOT 0x020 /* return dot and dot-dot */
55 #define FTS_XDEV 0x040 /* don't cross devices */
57 #define FTS_WHITEOUT 0x080 /* return whiteout information */
59 #define FTS_OPTIONMASK 0x0ff /* valid user option mask */
61 #define FTS_NAMEONLY 0x100 /* (private) child names only */
62 #define FTS_STOP 0x200 /* (private) unrecoverable error */
63 int fts_options; /* fts_open options, global flags */
64 void *fts_clientptr; /* thunk for sort function */
67 typedef struct _ftsent {
68 struct _ftsent *fts_cycle; /* cycle node */
69 struct _ftsent *fts_parent; /* parent directory */
70 struct _ftsent *fts_link; /* next file in directory */
73 long __fts_number; /* local numeric value */
74 void *__fts_pointer; /* local address value */
78 #define fts_number __union_ftsent.__struct_ftsent.__fts_number
79 #define fts_pointer __union_ftsent.__struct_ftsent.__fts_pointer
80 #define fts_bignum __union_ftsent.__fts_bignum
81 char *fts_accpath; /* access path */
82 char *fts_path; /* root path */
83 int fts_errno; /* errno for this node */
84 int fts_symfd; /* fd for symlink */
85 u_short fts_pathlen; /* strlen(fts_path) */
86 u_short fts_namelen; /* strlen(fts_name) */
88 ino_t fts_ino; /* inode */
89 dev_t fts_dev; /* device */
90 nlink_t fts_nlink; /* link count */
92 #define FTS_ROOTPARENTLEVEL -1
93 #define FTS_ROOTLEVEL 0
94 short fts_level; /* depth (-1 to N) */
96 #define FTS_D 1 /* preorder directory */
97 #define FTS_DC 2 /* directory that causes cycles */
98 #define FTS_DEFAULT 3 /* none of the above */
99 #define FTS_DNR 4 /* unreadable directory */
100 #define FTS_DOT 5 /* dot or dot-dot */
101 #define FTS_DP 6 /* postorder directory */
102 #define FTS_ERR 7 /* error; errno is set */
103 #define FTS_F 8 /* regular file */
104 #define FTS_INIT 9 /* initialized only */
105 #define FTS_NS 10 /* stat(2) failed */
106 #define FTS_NSOK 11 /* no stat(2) requested */
107 #define FTS_SL 12 /* symbolic link */
108 #define FTS_SLNONE 13 /* symbolic link without target */
109 #define FTS_W 14 /* whiteout object */
110 u_short fts_info; /* user flags for FTSENT structure */
112 #define FTS_DONTCHDIR 0x01 /* don't chdir .. to the parent */
113 #define FTS_SYMFOLLOW 0x02 /* followed a symlink to get here */
114 #define FTS_ISW 0x04 /* this is a whiteout object */
115 u_short fts_flags; /* private flags for FTSENT structure */
117 #define FTS_AGAIN 1 /* read node again */
118 #define FTS_FOLLOW 2 /* follow symbolic link */
119 #define FTS_NOINSTR 3 /* no instructions */
120 #define FTS_SKIP 4 /* discard node */
121 u_short fts_instr; /* fts_set() instructions */
123 struct stat *fts_statp; /* stat(2) information */
124 char *fts_name; /* file name */
125 FTS *fts_fts; /* back pointer to main FTS */
128 #include <sys/cdefs.h>
131 FTSENT *fts_children(FTS *, int);
132 int fts_close(FTS *);
133 void *fts_get_clientptr(FTS *);
134 #define fts_get_clientptr(fts) ((fts)->fts_clientptr)
135 FTS *fts_get_stream(FTSENT *);
136 #define fts_get_stream(ftsent) ((ftsent)->fts_fts)
137 FTS *fts_open(char * const *, int,
138 int (*)(const FTSENT * const *, const FTSENT * const *));
139 FTSENT *fts_read(FTS *);
140 int fts_set(FTS *, FTSENT *, int);
141 void fts_set_clientptr(FTS *, void *);
144 #endif /* !_FTS_H_ */