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