1 /* $NetBSD: fts.h,v 1.19 2009/08/16 19:33:38 christos Exp $ */
2
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 * @(#)fts.h 8.3 (Berkeley) 8/14/94
32 */
33
34 #ifndef _FTS_H_
35 #define _FTS_H_
36
37 #ifndef __THROW
38 # ifndef __GNUC_PREREQ
39 # define __GNUC_PREREQ(maj, min) (0)
40 # endif
41 # if defined __cplusplus && __GNUC_PREREQ (2,8)
42 # define __THROW throw ()
43 # else
44 # define __THROW
45 # endif
46 #endif
47
48 #ifdef __MVS__
49 #include <limits.h>
50 #define MAXPATHLEN FILENAME_MAX
51 #endif
52
53 typedef struct {
54 struct _ftsent *fts_cur; /* current node */
55 struct _ftsent *fts_child; /* linked list of children */
56 struct _ftsent **fts_array; /* sort array */
57 dev_t fts_dev; /* starting device # */
58 char *fts_path; /* path for this descent */
59 int fts_rfd; /* fd for root */
60 unsigned int fts_pathlen; /* sizeof(path) */
61 unsigned int fts_nitems; /* elements in the sort array */
62 int (*fts_compar) /* compare function */
63 (const struct _ftsent **, const struct _ftsent **);
64
65 #define FTS_COMFOLLOW 0x001 /* follow command line symlinks */
66 #define FTS_LOGICAL 0x002 /* logical walk */
67 #define FTS_NOCHDIR 0x004 /* don't change directories */
68 #define FTS_NOSTAT 0x008 /* don't get stat info */
69 #define FTS_PHYSICAL 0x010 /* physical walk */
70 #define FTS_SEEDOT 0x020 /* return dot and dot-dot */
71 #define FTS_XDEV 0x040 /* don't cross devices */
72 /* #define FTS_WHITEOUT 0x080 */ /* return whiteout information */
73 #define FTS_OPTIONMASK 0x0ff /* valid user option mask */
74
75 #define FTS_NAMEONLY 0x100 /* (private) child names only */
76 #define FTS_STOP 0x200 /* (private) unrecoverable error */
77 int fts_options; /* fts_open options, global flags */
78 } FTS;
79
80 typedef struct _ftsent {
81 struct _ftsent *fts_cycle; /* cycle node */
82 struct _ftsent *fts_parent; /* parent directory */
83 struct _ftsent *fts_link; /* next file in directory */
84 long long fts_number; /* local numeric value */
85 void *fts_pointer; /* local address value */
86 char *fts_accpath; /* access path */
87 char *fts_path; /* root path */
88 int fts_errno; /* errno for this node */
89 int fts_symfd; /* fd for symlink */
90 unsigned int fts_pathlen; /* strlen(fts_path) */
91 unsigned int fts_namelen; /* strlen(fts_name) */
92
93 ino_t fts_ino; /* inode */
94 dev_t fts_dev; /* device */
95 unsigned int fts_nlink; /* link count */
96
97 #define FTS_ROOTPARENTLEVEL -1
98 #define FTS_ROOTLEVEL 0
99 int fts_level; /* depth (-1 to N) */
100
101 #define FTS_D 1 /* preorder directory */
102 #define FTS_DC 2 /* directory that causes cycles */
103 #define FTS_DEFAULT 3 /* none of the above */
104 #define FTS_DNR 4 /* unreadable directory */
105 #define FTS_DOT 5 /* dot or dot-dot */
106 #define FTS_DP 6 /* postorder directory */
107 #define FTS_ERR 7 /* error; errno is set */
108 #define FTS_F 8 /* regular file */
109 #define FTS_INIT 9 /* initialized only */
110 #define FTS_NS 10 /* stat(2) failed */
111 #define FTS_NSOK 11 /* no stat(2) requested */
112 #define FTS_SL 12 /* symbolic link */
113 #define FTS_SLNONE 13 /* symbolic link without target */
114 #define FTS_W 14 /* whiteout object */
115 unsigned short fts_info; /* user flags for FTSENT structure */
116
117 #define FTS_DONTCHDIR 0x01 /* don't chdir .. to the parent */
118 #define FTS_SYMFOLLOW 0x02 /* followed a symlink to get here */
119 #define FTS_ISW 0x04 /* this is a whiteout object */
120 unsigned short fts_flags; /* private flags for FTSENT structure */
121
122 #define FTS_AGAIN 1 /* read node again */
123 #define FTS_FOLLOW 2 /* follow symbolic link */
124 #define FTS_NOINSTR 3 /* no instructions */
125 #define FTS_SKIP 4 /* discard node */
126 unsigned short fts_instr; /* fts_set() instructions */
127
128 struct stat *fts_statp; /* stat(2) information */
129 char fts_name[1]; /* file name */
130 } FTSENT;
131
132 /*
133 * Due to the wonders of modern linkers, shared libraries,
134 * compilers and other deep, dark, black magic voodoo, we
135 * redefined the identifiers so our code will use our version
136 * of these routines. See README.fts for a little bit more
137 * information and a lot more ranting.
138 */
139
140 #define fts_children gawk_fts_children
141 #define fts_close gawk_fts_close
142 #define fts_open gawk_fts_open
143 #define fts_read gawk_fts_read
144 #define fts_set gawk_fts_set
145
146 FTSENT *fts_children (FTS *, int);
147 int fts_close (FTS *);
148 FTS *fts_open (char * const *, int,
149 int (*)(const FTSENT **, const FTSENT **));
150 FTSENT *fts_read (FTS *);
151 int fts_set (FTS *, FTSENT *, int) __THROW;
152
153 #endif /* !_FTS_H_ */