Annotation of src/include/fts.h, Revision 1.8
1.8 ! millert 1: /* $OpenBSD: fts.h,v 1.7 2002/02/16 21:27:17 millert Exp $ */
1.1 deraadt 2: /* $NetBSD: fts.h,v 1.5 1994/12/28 01:41:50 mycroft Exp $ */
3:
4: /*
5: * Copyright (c) 1989, 1993
6: * The Regents of the University of California. All rights reserved.
7: *
8: * Redistribution and use in source and binary forms, with or without
9: * modification, are permitted provided that the following conditions
10: * are met:
11: * 1. Redistributions of source code must retain the above copyright
12: * notice, this list of conditions and the following disclaimer.
13: * 2. Redistributions in binary form must reproduce the above copyright
14: * notice, this list of conditions and the following disclaimer in the
15: * documentation and/or other materials provided with the distribution.
16: * 3. All advertising materials mentioning features or use of this software
17: * must display the following acknowledgement:
18: * This product includes software developed by the University of
19: * California, Berkeley and its contributors.
20: * 4. Neither the name of the University nor the names of its contributors
21: * may be used to endorse or promote products derived from this software
22: * without specific prior written permission.
23: *
24: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27: * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34: * SUCH DAMAGE.
35: *
36: * @(#)fts.h 8.3 (Berkeley) 8/14/94
37: */
38:
39: #ifndef _FTS_H_
40: #define _FTS_H_
41:
42: typedef struct {
43: struct _ftsent *fts_cur; /* current node */
44: struct _ftsent *fts_child; /* linked list of children */
45: struct _ftsent **fts_array; /* sort array */
46: dev_t fts_dev; /* starting device # */
47: char *fts_path; /* path for this descent */
48: int fts_rfd; /* fd for root */
1.6 millert 49: size_t fts_pathlen; /* sizeof(path) */
1.1 deraadt 50: int fts_nitems; /* elements in the sort array */
51: int (*fts_compar)(); /* compare function */
52:
1.2 millert 53: #define FTS_COMFOLLOW 0x0001 /* follow command line symlinks */
54: #define FTS_LOGICAL 0x0002 /* logical walk */
55: #define FTS_NOCHDIR 0x0004 /* don't change directories */
56: #define FTS_NOSTAT 0x0008 /* don't get stat info */
57: #define FTS_PHYSICAL 0x0010 /* physical walk */
58: #define FTS_SEEDOT 0x0020 /* return dot and dot-dot */
59: #define FTS_XDEV 0x0040 /* don't cross devices */
60: #define FTS_WHITEOUT 0x0080 /* return whiteout information */
1.6 millert 61: #define FTS_OPTIONMASK 0x00ff /* valid user option mask */
1.1 deraadt 62:
1.2 millert 63: #define FTS_NAMEONLY 0x1000 /* (private) child names only */
64: #define FTS_STOP 0x2000 /* (private) unrecoverable error */
1.1 deraadt 65: int fts_options; /* fts_open options, global flags */
66: } FTS;
67:
68: typedef struct _ftsent {
69: struct _ftsent *fts_cycle; /* cycle node */
70: struct _ftsent *fts_parent; /* parent directory */
71: struct _ftsent *fts_link; /* next file in directory */
72: long fts_number; /* local numeric value */
73: void *fts_pointer; /* local address value */
74: char *fts_accpath; /* access path */
75: char *fts_path; /* root path */
76: int fts_errno; /* errno for this node */
77: int fts_symfd; /* fd for symlink */
1.6 millert 78: size_t fts_pathlen; /* strlen(fts_path) */
79: size_t fts_namelen; /* strlen(fts_name) */
1.1 deraadt 80:
81: ino_t fts_ino; /* inode */
82: dev_t fts_dev; /* device */
83: nlink_t fts_nlink; /* link count */
84:
85: #define FTS_ROOTPARENTLEVEL -1
86: #define FTS_ROOTLEVEL 0
87: short fts_level; /* depth (-1 to N) */
88:
89: #define FTS_D 1 /* preorder directory */
90: #define FTS_DC 2 /* directory that causes cycles */
91: #define FTS_DEFAULT 3 /* none of the above */
92: #define FTS_DNR 4 /* unreadable directory */
93: #define FTS_DOT 5 /* dot or dot-dot */
94: #define FTS_DP 6 /* postorder directory */
95: #define FTS_ERR 7 /* error; errno is set */
96: #define FTS_F 8 /* regular file */
97: #define FTS_INIT 9 /* initialized only */
98: #define FTS_NS 10 /* stat(2) failed */
99: #define FTS_NSOK 11 /* no stat(2) requested */
100: #define FTS_SL 12 /* symbolic link */
101: #define FTS_SLNONE 13 /* symbolic link without target */
102: #define FTS_W 14 /* whiteout object */
103: u_short fts_info; /* user flags for FTSENT structure */
104:
105: #define FTS_DONTCHDIR 0x01 /* don't chdir .. to the parent */
106: #define FTS_SYMFOLLOW 0x02 /* followed a symlink to get here */
107: #define FTS_ISW 0x04 /* this is a whiteout object */
108: u_short fts_flags; /* private flags for FTSENT structure */
109:
110: #define FTS_AGAIN 1 /* read node again */
111: #define FTS_FOLLOW 2 /* follow symbolic link */
112: #define FTS_NOINSTR 3 /* no instructions */
113: #define FTS_SKIP 4 /* discard node */
114: u_short fts_instr; /* fts_set() instructions */
115:
116: struct stat *fts_statp; /* stat(2) information */
117: char fts_name[1]; /* file name */
118: } FTSENT;
119:
120: #include <sys/cdefs.h>
121:
122: __BEGIN_DECLS
1.7 millert 123: FTSENT *fts_children(FTS *, int);
124: int fts_close(FTS *);
1.8 ! millert 125: FTS *fts_open(char * const *, int,
! 126: int (*)(const FTSENT **, const FTSENT **));
1.7 millert 127: FTSENT *fts_read(FTS *);
128: int fts_set(FTS *, FTSENT *, int);
1.1 deraadt 129: __END_DECLS
130:
131: #endif /* !_FTS_H_ */