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 * @(#)fts.h 8.3 (Berkeley) 8/14/94
35 #include <rpm/rpmutil.h>
37 #if defined(__GLIBC__)
43 #if !defined(_LARGEFILE64_SOURCE)
44 # define _LARGEFILE64_SOURCE
47 #if !defined(_D_EXACT_NAMLEN)
48 # define _D_EXACT_NAMLEN(d) (strlen((d)->d_name))
52 # if !defined(_INCLUDE_POSIX_SOURCE)
53 # define _INCLUDE_POSIX_SOURCE
59 #include <sys/types.h>
65 struct _ftsent *fts_cur; /*!< current node */
66 struct _ftsent *fts_child; /*!< linked list of children */
67 struct _ftsent **fts_array; /*!< sort array */
68 dev_t fts_dev; /*!< starting device # */
69 char *fts_path; /*!< path for this descent */
70 int fts_rfd; /*!< fd for root */
71 int fts_pathlen; /*!< sizeof(path) */
72 int fts_nitems; /*!< elements in the sort array */
73 int (*fts_compar) (const void *, const void *); /*!< compare fn */
75 DIR * (*fts_opendir) (const char * path);
76 struct dirent * (*fts_readdir) (DIR * dir);
77 int (*fts_closedir) (DIR * dir);
78 int (*fts_stat) (const char * path, struct stat * st);
79 int (*fts_lstat) (const char * path, struct stat * st);
81 #define FTS_COMFOLLOW 0x0001 /* follow command line symlinks */
82 #define FTS_LOGICAL 0x0002 /* logical walk */
83 #define FTS_NOCHDIR 0x0004 /* don't change directories */
84 #define FTS_NOSTAT 0x0008 /* don't get stat info */
85 #define FTS_PHYSICAL 0x0010 /* physical walk */
86 #define FTS_SEEDOT 0x0020 /* return dot and dot-dot */
87 #define FTS_XDEV 0x0040 /* don't cross devices */
88 #define FTS_WHITEOUT 0x0080 /* return whiteout information */
89 #define FTS_OPTIONMASK 0x00ff /* valid user option mask */
91 #define FTS_NAMEONLY 0x0100 /* (private) child names only */
92 #define FTS_STOP 0x0200 /* (private) unrecoverable error */
93 int fts_options; /*!< fts_open options, global flags */
96 typedef struct _ftsent {
97 struct _ftsent *fts_cycle; /*!< cycle node */
98 struct _ftsent *fts_parent; /*!< parent directory */
99 struct _ftsent *fts_link; /*!< next file in directory */
100 long fts_number; /*!< local numeric value */
101 void *fts_pointer; /*!< local address value */
102 char *fts_accpath; /*!< access path */
103 char *fts_path; /*!< root path */
104 int fts_errno; /*!< errno for this node */
105 int fts_symfd; /*!< fd for symlink */
106 uint16_t fts_pathlen; /*!< strlen(fts_path) */
107 uint16_t fts_namelen; /*!< strlen(fts_name) */
109 ino_t fts_ino; /*!< inode */
110 dev_t fts_dev; /*!< device */
111 nlink_t fts_nlink; /*!< link count */
113 #define FTS_ROOTPARENTLEVEL -1
114 #define FTS_ROOTLEVEL 0
115 short fts_level; /*!< depth (-1 to N) */
117 #define FTS_D 1 /* preorder directory */
118 #define FTS_DC 2 /* directory that causes cycles */
119 #define FTS_DEFAULT 3 /* none of the above */
120 #define FTS_DNR 4 /* unreadable directory */
121 #define FTS_DOT 5 /* dot or dot-dot */
122 #define FTS_DP 6 /* postorder directory */
123 #define FTS_ERR 7 /* error; errno is set */
124 #define FTS_F 8 /* regular file */
125 #define FTS_INIT 9 /* initialized only */
126 #define FTS_NS 10 /* stat(2) failed */
127 #define FTS_NSOK 11 /* no stat(2) requested */
128 #define FTS_SL 12 /* symbolic link */
129 #define FTS_SLNONE 13 /* symbolic link without target */
130 #define FTS_W 14 /* whiteout object */
131 uint16_t fts_info; /*!< user flags for FTSENT structure */
133 #define FTS_DONTCHDIR 0x01 /* don't chdir .. to the parent */
134 #define FTS_SYMFOLLOW 0x02 /* followed a symlink to get here */
135 uint16_t fts_flags; /*!< private flags for FTSENT structure */
137 #define FTS_AGAIN 1 /* read node again */
138 #define FTS_FOLLOW 2 /* follow symbolic link */
139 #define FTS_NOINSTR 3 /* no instructions */
140 #define FTS_SKIP 4 /* discard node */
141 uint16_t fts_instr; /*!< fts_set() instructions */
143 struct stat *fts_statp; /*!< stat(2) information */
144 char fts_name[1]; /*!< file name */
152 * Return list of children of the current node.
153 * @param sp file hierarchy state
155 * @return file set member
158 FTSENT *Fts_children (FTS * sp, int instr) __THROW
162 * Destroy a file hierarchy traversal handle.
163 * @param sp file hierarchy state
164 * @return 0 on success, -1 on error
167 int Fts_close (FTS * sp) __THROW
171 * Create a handle for file hierarchy traversal.
172 * @param argv paths that compose a logical file hierarchy
173 * @param options traversal options
174 * @param compar traversal ordering (or NULL)
175 * @return file hierarchy state (or NULL on error)
178 FTS *Fts_open (char * const * argv, int options,
179 int (*compar) (const FTSENT **, const FTSENT **)) __THROW
183 * Return next node in the file hierarchy traversal.
184 * @param sp file hierarchy state
185 * @return file set member
188 FTSENT *Fts_read (FTS * sp) __THROW
192 * Modify the traversal for a file set member.
193 * @param sp file hierarchy state
194 * @param p file set member
195 * @param instr new disposition for file set member
196 * @return 0 on success, -1 on error
199 int Fts_set (FTS * sp, FTSENT * p, int instr) __THROW