fts.h (5587B) - Raw
1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 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. Neither the name of the University nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 * 31 * @(#)fts.h 8.3 (Berkeley) 8/14/94 32 */ 33 34 #ifndef _FTS_H_ 35 #define _FTS_H_ 36 37 #include <sys/_types.h> 38 39 typedef struct { 40 struct _ftsent *fts_cur; /* current node */ 41 struct _ftsent *fts_child; /* linked list of children */ 42 struct _ftsent **fts_array; /* sort array */ 43 __dev_t fts_dev; /* starting device # */ 44 char *fts_path; /* path for this descent */ 45 int fts_rfd; /* fd for root */ 46 __size_t fts_pathlen; /* sizeof(path) */ 47 __size_t fts_nitems; /* elements in the sort array */ 48 int (*fts_compar) /* compare function */ 49 (const struct _ftsent * const *, const struct _ftsent * const *); 50 51 #define FTS_COMFOLLOW 0x001 /* follow command line symlinks */ 52 #define FTS_LOGICAL 0x002 /* logical walk */ 53 #define FTS_NOCHDIR 0x004 /* don't change directories */ 54 #define FTS_NOSTAT 0x008 /* don't get stat info */ 55 #define FTS_PHYSICAL 0x010 /* physical walk */ 56 #define FTS_SEEDOT 0x020 /* return dot and dot-dot */ 57 #define FTS_XDEV 0x040 /* don't cross devices */ 58 #define FTS_WHITEOUT 0x080 /* return whiteout information */ 59 #define FTS_OPTIONMASK 0x0ff /* valid user option mask */ 60 61 #define FTS_NAMEONLY 0x100 /* (private) child names only */ 62 #define FTS_STOP 0x200 /* (private) unrecoverable error */ 63 int fts_options; /* fts_open options, global flags */ 64 void *fts_clientptr; /* thunk for sort function */ 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 long fts_number; /* local numeric value */ 72 #define fts_bignum fts_number /* XXX non-std, should go away */ 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 */ 78 __size_t fts_pathlen; /* strlen(fts_path) */ 79 __size_t fts_namelen; /* strlen(fts_name) */ 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 long 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 int fts_info; /* user status 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 unsigned 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 int fts_instr; /* fts_set() instructions */ 115 116 struct stat *fts_statp; /* stat(2) information */ 117 char *fts_name; /* file name */ 118 FTS *fts_fts; /* back pointer to main FTS */ 119 } FTSENT; 120 121 #include <sys/cdefs.h> 122 123 __BEGIN_DECLS 124 FTSENT *fts_children(FTS *, int); 125 int fts_close(FTS *); 126 void *fts_get_clientptr(FTS *); 127 #define fts_get_clientptr(fts) ((fts)->fts_clientptr) 128 FTS *fts_get_stream(FTSENT *); 129 #define fts_get_stream(ftsent) ((ftsent)->fts_fts) 130 FTS *fts_open(char * const *, int, 131 int (*)(const FTSENT * const *, const FTSENT * const *)); 132 FTSENT *fts_read(FTS *); 133 int fts_set(FTS *, FTSENT *, int); 134 void fts_set_clientptr(FTS *, void *); 135 __END_DECLS 136 137 #endif /* !_FTS_H_ */