Annotation of mandoc/compat_fts.h, Revision 1.5
1.1 schwarze 1: /* $OpenBSD: fts.h,v 1.14 2012/12/05 23:19:57 deraadt Exp $ */
2: /* $NetBSD: fts.h,v 1.7 2012/03/01 16:18:51 hans 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. Neither the name of the University nor the names of its contributors
17: * may be used to endorse or promote products derived from this software
18: * without specific prior written permission.
19: *
20: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23: * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30: * SUCH DAMAGE.
31: *
32: * @(#)fts.h 8.3 (Berkeley) 8/14/94
33: */
34:
35: #ifndef _FTS_H_
36: #define _FTS_H_
37:
38: typedef struct {
39: struct _ftsent *fts_cur; /* current node */
40: struct _ftsent *fts_child; /* linked list of children */
1.4 schwarze 41: struct _ftsent **fts_array; /* sort array */
1.1 schwarze 42: dev_t fts_dev; /* starting device # */
43: char *fts_path; /* path for this descent */
44: size_t fts_pathlen; /* sizeof(path) */
1.4 schwarze 45: int fts_nitems; /* elements in the sort array */
1.5 ! schwarze 46: int (*fts_compar)(const struct _ftsent **, const struct _ftsent **);
! 47: /* compare function */
1.1 schwarze 48:
49: #define FTS_NOCHDIR 0x0004 /* don't change directories */
50: #define FTS_PHYSICAL 0x0010 /* physical walk */
51: #define FTS_XDEV 0x0040 /* don't cross devices */
1.2 schwarze 52: #define FTS_OPTIONMASK 0x0054 /* valid user option mask */
1.1 schwarze 53:
54: #define FTS_STOP 0x2000 /* (private) unrecoverable error */
55: int fts_options; /* fts_open options, global flags */
56: } FTS;
57:
58: typedef struct _ftsent {
59: struct _ftsent *fts_cycle; /* cycle node */
60: struct _ftsent *fts_parent; /* parent directory */
61: struct _ftsent *fts_link; /* next file in directory */
62: char *fts_accpath; /* access path */
63: char *fts_path; /* root path */
64: int fts_errno; /* errno for this node */
65: size_t fts_pathlen; /* strlen(fts_path) */
66: size_t fts_namelen; /* strlen(fts_name) */
67:
68: ino_t fts_ino; /* inode */
69: dev_t fts_dev; /* device */
70: nlink_t fts_nlink; /* link count */
71:
72: #define FTS_ROOTPARENTLEVEL -1
73: #define FTS_ROOTLEVEL 0
74: #define FTS_MAXLEVEL 0x7fffffff
75: int fts_level; /* depth (-1 to N) */
76:
77: #define FTS_D 1 /* preorder directory */
78: #define FTS_DC 2 /* directory that causes cycles */
79: #define FTS_DEFAULT 3 /* none of the above */
80: #define FTS_DNR 4 /* unreadable directory */
81: #define FTS_DOT 5 /* dot or dot-dot */
82: #define FTS_DP 6 /* postorder directory */
83: #define FTS_ERR 7 /* error; errno is set */
84: #define FTS_F 8 /* regular file */
85: #define FTS_INIT 9 /* initialized only */
86: #define FTS_NS 10 /* stat(2) failed */
87: #define FTS_NSOK 11 /* no stat(2) requested */
88: #define FTS_SL 12 /* symbolic link */
89: unsigned short fts_info; /* user flags for FTSENT structure */
90:
91: #define FTS_NOINSTR 3 /* no instructions */
92: #define FTS_SKIP 4 /* discard node */
93: unsigned short fts_instr; /* fts_set() instructions */
94:
95: struct stat *fts_statp; /* stat(2) information */
96: char fts_name[1]; /* file name */
97: } FTSENT;
98:
1.3 schwarze 99:
1.1 schwarze 100: int fts_close(FTS *);
1.4 schwarze 101: FTS *fts_open(char * const *, int,
102: int (*)(const FTSENT **, const FTSENT **));
1.1 schwarze 103: FTSENT *fts_read(FTS *);
104: int fts_set(FTS *, FTSENT *, int);
105:
106: #endif /* !_FTS_H_ */
CVSweb