blob: da26a8823ee0da2dbd07bbf78292095f3876bcc2 [file] [log] [blame]
Colin Cross64ceac32010-01-13 21:19:52 -08001/* $OpenBSD: fts.h,v 1.12 2009/08/27 16:19:27 millert Exp $ */
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. 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
38typedef struct {
39 struct _ftsent *fts_cur; /* current node */
40 struct _ftsent *fts_child; /* linked list of children */
41 struct _ftsent **fts_array; /* sort array */
42 dev_t fts_dev; /* starting device # */
43 char *fts_path; /* path for this descent */
44 int fts_rfd; /* fd for root */
45 size_t fts_pathlen; /* sizeof(path) */
46 int fts_nitems; /* elements in the sort array */
47 int (*fts_compar)(); /* compare function */
48
49#define FTS_COMFOLLOW 0x0001 /* follow command line symlinks */
50#define FTS_LOGICAL 0x0002 /* logical walk */
51#define FTS_NOCHDIR 0x0004 /* don't change directories */
52#define FTS_NOSTAT 0x0008 /* don't get stat info */
53#define FTS_PHYSICAL 0x0010 /* physical walk */
54#define FTS_SEEDOT 0x0020 /* return dot and dot-dot */
55#define FTS_XDEV 0x0040 /* don't cross devices */
56#define FTS_OPTIONMASK 0x00ff /* valid user option mask */
57
58#define FTS_NAMEONLY 0x1000 /* (private) child names only */
59#define FTS_STOP 0x2000 /* (private) unrecoverable error */
60 int fts_options; /* fts_open options, global flags */
61} FTS;
62
63typedef struct _ftsent {
64 struct _ftsent *fts_cycle; /* cycle node */
65 struct _ftsent *fts_parent; /* parent directory */
66 struct _ftsent *fts_link; /* next file in directory */
67 long fts_number; /* local numeric value */
68 void *fts_pointer; /* local address value */
69 char *fts_accpath; /* access path */
70 char *fts_path; /* root path */
71 int fts_errno; /* errno for this node */
72 int fts_symfd; /* fd for symlink */
73 size_t fts_pathlen; /* strlen(fts_path) */
74 size_t fts_namelen; /* strlen(fts_name) */
75
76 ino_t fts_ino; /* inode */
77 dev_t fts_dev; /* device */
78 nlink_t fts_nlink; /* link count */
79
80#define FTS_ROOTPARENTLEVEL -1
81#define FTS_ROOTLEVEL 0
82#define FTS_MAXLEVEL 0x7fff
83 short fts_level; /* depth (-1 to N) */
84
85#define FTS_D 1 /* preorder directory */
86#define FTS_DC 2 /* directory that causes cycles */
87#define FTS_DEFAULT 3 /* none of the above */
88#define FTS_DNR 4 /* unreadable directory */
89#define FTS_DOT 5 /* dot or dot-dot */
90#define FTS_DP 6 /* postorder directory */
91#define FTS_ERR 7 /* error; errno is set */
92#define FTS_F 8 /* regular file */
93#define FTS_INIT 9 /* initialized only */
94#define FTS_NS 10 /* stat(2) failed */
95#define FTS_NSOK 11 /* no stat(2) requested */
96#define FTS_SL 12 /* symbolic link */
97#define FTS_SLNONE 13 /* symbolic link without target */
98 unsigned short fts_info; /* user flags for FTSENT structure */
99
100#define FTS_DONTCHDIR 0x01 /* don't chdir .. to the parent */
101#define FTS_SYMFOLLOW 0x02 /* followed a symlink to get here */
102 unsigned short fts_flags; /* private flags for FTSENT structure */
103
104#define FTS_AGAIN 1 /* read node again */
105#define FTS_FOLLOW 2 /* follow symbolic link */
106#define FTS_NOINSTR 3 /* no instructions */
107#define FTS_SKIP 4 /* discard node */
108 unsigned short fts_instr; /* fts_set() instructions */
109
110 struct stat *fts_statp; /* stat(2) information */
111 char fts_name[1]; /* file name */
112} FTSENT;
113
114#include <sys/cdefs.h>
115
116__BEGIN_DECLS
117FTSENT *fts_children(FTS *, int);
118int fts_close(FTS *);
119FTS *fts_open(char * const *, int,
120 int (*)(const FTSENT **, const FTSENT **));
121FTSENT *fts_read(FTS *);
122int fts_set(FTS *, FTSENT *, int);
123__END_DECLS
124
125#endif /* !_FTS_H_ */