fts.h revision 203964
118334Speter/* 252284Sobrien * Copyright (c) 1989, 1993 318334Speter * The Regents of the University of California. All rights reserved. 418334Speter * 518334Speter * Redistribution and use in source and binary forms, with or without 618334Speter * modification, are permitted provided that the following conditions 718334Speter * are met: 818334Speter * 1. Redistributions of source code must retain the above copyright 918334Speter * notice, this list of conditions and the following disclaimer. 1018334Speter * 2. Redistributions in binary form must reproduce the above copyright 1118334Speter * notice, this list of conditions and the following disclaimer in the 1218334Speter * documentation and/or other materials provided with the distribution. 1318334Speter * 3. Neither the name of the University nor the names of its contributors 1418334Speter * may be used to endorse or promote products derived from this software 1518334Speter * without specific prior written permission. 1618334Speter * 1718334Speter * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 1818334Speter * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1918334Speter * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2018334Speter * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 2118334Speter * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2218334Speter * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2350397Sobrien * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2418334Speter * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2518334Speter * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2650397Sobrien * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2750397Sobrien * SUCH DAMAGE. 2850397Sobrien * 2918334Speter * @(#)fts.h 8.3 (Berkeley) 8/14/94 3050397Sobrien * $FreeBSD: head/include/fts.h 203964 2010-02-16 19:39:50Z imp $ 3150397Sobrien */ 3250397Sobrien 3350397Sobrien#ifndef _FTS_H_ 3418334Speter#define _FTS_H_ 3518334Speter 3618334Spetertypedef struct { 3718334Speter struct _ftsent *fts_cur; /* current node */ 3818334Speter struct _ftsent *fts_child; /* linked list of children */ 3918334Speter struct _ftsent **fts_array; /* sort array */ 4018334Speter dev_t fts_dev; /* starting device # */ 4118334Speter char *fts_path; /* path for this descent */ 4218334Speter int fts_rfd; /* fd for root */ 4318334Speter size_t fts_pathlen; /* sizeof(path) */ 4418334Speter size_t fts_nitems; /* elements in the sort array */ 4518334Speter int (*fts_compar) /* compare function */ 4618334Speter (const struct _ftsent * const *, const struct _ftsent * const *); 4718334Speter 4818334Speter#define FTS_COMFOLLOW 0x001 /* follow command line symlinks */ 4918334Speter#define FTS_LOGICAL 0x002 /* logical walk */ 5018334Speter#define FTS_NOCHDIR 0x004 /* don't change directories */ 5118334Speter#define FTS_NOSTAT 0x008 /* don't get stat info */ 5218334Speter#define FTS_PHYSICAL 0x010 /* physical walk */ 5318334Speter#define FTS_SEEDOT 0x020 /* return dot and dot-dot */ 5418334Speter#define FTS_XDEV 0x040 /* don't cross devices */ 5518334Speter#define FTS_WHITEOUT 0x080 /* return whiteout information */ 5618334Speter#define FTS_OPTIONMASK 0x0ff /* valid user option mask */ 5718334Speter 5818334Speter#define FTS_NAMEONLY 0x100 /* (private) child names only */ 5918334Speter#define FTS_STOP 0x200 /* (private) unrecoverable error */ 6018334Speter int fts_options; /* fts_open options, global flags */ 6118334Speter void *fts_clientptr; /* thunk for sort function */ 6218334Speter} FTS; 6318334Speter 6418334Spetertypedef struct _ftsent { 6518334Speter struct _ftsent *fts_cycle; /* cycle node */ 6618334Speter struct _ftsent *fts_parent; /* parent directory */ 6718334Speter struct _ftsent *fts_link; /* next file in directory */ 6818334Speter long long fts_number; /* local numeric value */ 6918334Speter#define fts_bignum fts_number /* XXX non-std, should go away */ 7018334Speter void *fts_pointer; /* local address value */ 7118334Speter char *fts_accpath; /* access path */ 7218334Speter char *fts_path; /* root path */ 7318334Speter int fts_errno; /* errno for this node */ 7418334Speter int fts_symfd; /* fd for symlink */ 7518334Speter size_t fts_pathlen; /* strlen(fts_path) */ 7618334Speter size_t fts_namelen; /* strlen(fts_name) */ 7718334Speter 7818334Speter ino_t fts_ino; /* inode */ 7918334Speter dev_t fts_dev; /* device */ 8018334Speter nlink_t fts_nlink; /* link count */ 8118334Speter 8218334Speter#define FTS_ROOTPARENTLEVEL -1 8318334Speter#define FTS_ROOTLEVEL 0 8418334Speter long fts_level; /* depth (-1 to N) */ 8518334Speter 8618334Speter#define FTS_D 1 /* preorder directory */ 8718334Speter#define FTS_DC 2 /* directory that causes cycles */ 8818334Speter#define FTS_DEFAULT 3 /* none of the above */ 8918334Speter#define FTS_DNR 4 /* unreadable directory */ 9018334Speter#define FTS_DOT 5 /* dot or dot-dot */ 9118334Speter#define FTS_DP 6 /* postorder directory */ 9218334Speter#define FTS_ERR 7 /* error; errno is set */ 9318334Speter#define FTS_F 8 /* regular file */ 9418334Speter#define FTS_INIT 9 /* initialized only */ 9518334Speter#define FTS_NS 10 /* stat(2) failed */ 9618334Speter#define FTS_NSOK 11 /* no stat(2) requested */ 9718334Speter#define FTS_SL 12 /* symbolic link */ 9818334Speter#define FTS_SLNONE 13 /* symbolic link without target */ 9918334Speter#define FTS_W 14 /* whiteout object */ 10018334Speter int fts_info; /* user status for FTSENT structure */ 10118334Speter 10218334Speter#define FTS_DONTCHDIR 0x01 /* don't chdir .. to the parent */ 10318334Speter#define FTS_SYMFOLLOW 0x02 /* followed a symlink to get here */ 10418334Speter#define FTS_ISW 0x04 /* this is a whiteout object */ 10518334Speter unsigned fts_flags; /* private flags for FTSENT structure */ 10618334Speter 10718334Speter#define FTS_AGAIN 1 /* read node again */ 10850397Sobrien#define FTS_FOLLOW 2 /* follow symbolic link */ 10918334Speter#define FTS_NOINSTR 3 /* no instructions */ 11018334Speter#define FTS_SKIP 4 /* discard node */ 11118334Speter int fts_instr; /* fts_set() instructions */ 11218334Speter 11318334Speter struct stat *fts_statp; /* stat(2) information */ 11450397Sobrien char *fts_name; /* file name */ 11550397Sobrien FTS *fts_fts; /* back pointer to main FTS */ 11650397Sobrien} FTSENT; 11718334Speter 11818334Speter#include <sys/cdefs.h> 11918334Speter 12018334Speter__BEGIN_DECLS 12118334SpeterFTSENT *fts_children(FTS *, int); 12218334Speterint fts_close(FTS *); 12318334Spetervoid *fts_get_clientptr(FTS *); 12418334Speter#define fts_get_clientptr(fts) ((fts)->fts_clientptr) 12518334SpeterFTS *fts_get_stream(FTSENT *); 12618334Speter#define fts_get_stream(ftsent) ((ftsent)->fts_fts) 12718334SpeterFTS *fts_open(char * const *, int, 12818334Speter int (*)(const FTSENT * const *, const FTSENT * const *)); 12950397SobrienFTSENT *fts_read(FTS *); 13018334Speterint fts_set(FTS *, FTSENT *, int); 13118334Spetervoid fts_set_clientptr(FTS *, void *); 13218334Speter__END_DECLS 13318334Speter 13418334Speter#endif /* !_FTS_H_ */ 13518334Speter