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