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