1 /* $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 38 #include <sys/cdefs.h> 39 #include <sys/types.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 size_t fts_pathlen; /* sizeof(path) */ 49 int fts_nitems; /* elements in the sort array */ 50 int (*fts_compar)(); /* compare function */ 51 52 #define FTS_COMFOLLOW 0x0001 /* follow command line symlinks */ 53 #define FTS_LOGICAL 0x0002 /* logical walk */ 54 #define FTS_NOCHDIR 0x0004 /* don't change directories */ 55 #define FTS_NOSTAT 0x0008 /* don't get stat info */ 56 #define FTS_PHYSICAL 0x0010 /* physical walk */ 57 #define FTS_SEEDOT 0x0020 /* return dot and dot-dot */ 58 #define FTS_XDEV 0x0040 /* don't cross devices */ 59 #define FTS_OPTIONMASK 0x00ff /* valid user option mask */ 60 61 #define FTS_NAMEONLY 0x1000 /* (private) child names only */ 62 #define FTS_STOP 0x2000 /* (private) unrecoverable error */ 63 #define FTS_FOR_FTW 0x4000 /* (private) fts is being called by ftw/nftw */ 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 size_t fts_pathlen; /* strlen(fts_path) */ 78 size_t 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 #define FTS_MAXLEVEL 0x7fff 87 short 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 unsigned 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 unsigned short fts_flags; /* private flags for FTSENT structure */ 107 108 #define FTS_AGAIN 1 /* read node again */ 109 #define FTS_FOLLOW 2 /* follow symbolic link */ 110 #define FTS_NOINSTR 3 /* no instructions */ 111 #define FTS_SKIP 4 /* discard node */ 112 unsigned short fts_instr; /* fts_set() instructions */ 113 114 struct stat *fts_statp; /* stat(2) information */ 115 char fts_name[1]; /* file name */ 116 } FTSENT; 117 118 __BEGIN_DECLS 119 120 /* 121 * Strictly these functions were available before Lollipop/21, but there was an accidental ABI 122 * breakage in 21 that means you can't write code that runs on current devices and pre-21 devices, 123 * so we break the tie in favor of current and future devices. 124 */ 125 FTSENT* fts_children(FTS* __fts, int __options) __INTRODUCED_IN(21); 126 int fts_close(FTS* __fts) __INTRODUCED_IN(21); 127 FTS* fts_open(char* const* __path, int __options, int (*__comparator)(const FTSENT** __lhs, const FTSENT** __rhs)) __INTRODUCED_IN(21); 128 FTSENT* fts_read(FTS* __fts) __INTRODUCED_IN(21); 129 int fts_set(FTS* __fts, FTSENT* __entry, int __options) __INTRODUCED_IN(21); 130 131 __END_DECLS 132 133 #endif /* !_FTS_H_ */ 134
