fts.h revision 175688
11539Srgrimes/* 21539Srgrimes * Copyright (c) 1989, 1993 31539Srgrimes * The Regents of the University of California. All rights reserved. 41539Srgrimes * 51539Srgrimes * Redistribution and use in source and binary forms, with or without 61539Srgrimes * modification, are permitted provided that the following conditions 71539Srgrimes * are met: 81539Srgrimes * 1. Redistributions of source code must retain the above copyright 91539Srgrimes * notice, this list of conditions and the following disclaimer. 101539Srgrimes * 2. Redistributions in binary form must reproduce the above copyright 111539Srgrimes * notice, this list of conditions and the following disclaimer in the 121539Srgrimes * documentation and/or other materials provided with the distribution. 131539Srgrimes * 3. All advertising materials mentioning features or use of this software 141539Srgrimes * must display the following acknowledgement: 151539Srgrimes * This product includes software developed by the University of 161539Srgrimes * California, Berkeley and its contributors. 171539Srgrimes * 4. Neither the name of the University nor the names of its contributors 181539Srgrimes * may be used to endorse or promote products derived from this software 191539Srgrimes * without specific prior written permission. 201539Srgrimes * 211539Srgrimes * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 221539Srgrimes * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 231539Srgrimes * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 241539Srgrimes * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 251539Srgrimes * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 261539Srgrimes * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 271539Srgrimes * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 281539Srgrimes * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 291539Srgrimes * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 301539Srgrimes * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 311539Srgrimes * SUCH DAMAGE. 321539Srgrimes * 3323650Speter * @(#)fts.h 8.3 (Berkeley) 8/14/94 3478169Sru * $FreeBSD: head/include/fts.h 175688 2008-01-26 17:09:40Z yar $ 351539Srgrimes */ 361539Srgrimes 371539Srgrimes#ifndef _FTS_H_ 381539Srgrimes#define _FTS_H_ 391539Srgrimes 401539Srgrimestypedef struct { 411539Srgrimes struct _ftsent *fts_cur; /* current node */ 421539Srgrimes struct _ftsent *fts_child; /* linked list of children */ 431539Srgrimes struct _ftsent **fts_array; /* sort array */ 441539Srgrimes dev_t fts_dev; /* starting device # */ 451539Srgrimes char *fts_path; /* path for this descent */ 461539Srgrimes int fts_rfd; /* fd for root */ 47175688Syar size_t fts_pathlen; /* sizeof(path) */ 48175688Syar size_t fts_nitems; /* elements in the sort array */ 4978169Sru int (*fts_compar) /* compare function */ 50103726Swollman (const struct _ftsent * const *, const struct _ftsent * const *); 511539Srgrimes 521539Srgrimes#define FTS_COMFOLLOW 0x001 /* follow command line symlinks */ 531539Srgrimes#define FTS_LOGICAL 0x002 /* logical walk */ 541539Srgrimes#define FTS_NOCHDIR 0x004 /* don't change directories */ 551539Srgrimes#define FTS_NOSTAT 0x008 /* don't get stat info */ 561539Srgrimes#define FTS_PHYSICAL 0x010 /* physical walk */ 571539Srgrimes#define FTS_SEEDOT 0x020 /* return dot and dot-dot */ 581539Srgrimes#define FTS_XDEV 0x040 /* don't cross devices */ 5923650Speter#define FTS_WHITEOUT 0x080 /* return whiteout information */ 6023650Speter#define FTS_OPTIONMASK 0x0ff /* valid user option mask */ 611539Srgrimes 6223650Speter#define FTS_NAMEONLY 0x100 /* (private) child names only */ 6323650Speter#define FTS_STOP 0x200 /* (private) unrecoverable error */ 641539Srgrimes int fts_options; /* fts_open options, global flags */ 65103726Swollman void *fts_clientptr; /* thunk for sort function */ 661539Srgrimes} FTS; 671539Srgrimes 681539Srgrimestypedef struct _ftsent { 691539Srgrimes struct _ftsent *fts_cycle; /* cycle node */ 701539Srgrimes struct _ftsent *fts_parent; /* parent directory */ 711539Srgrimes struct _ftsent *fts_link; /* next file in directory */ 72175688Syar long long fts_number; /* local numeric value */ 73175688Syar#define fts_bignum fts_number /* XXX non-std, should go away */ 74175688Syar void *fts_pointer; /* local address value */ 751539Srgrimes char *fts_accpath; /* access path */ 761539Srgrimes char *fts_path; /* root path */ 771539Srgrimes int fts_errno; /* errno for this node */ 781539Srgrimes int fts_symfd; /* fd for symlink */ 79175688Syar size_t fts_pathlen; /* strlen(fts_path) */ 80175688Syar size_t fts_namelen; /* strlen(fts_name) */ 811539Srgrimes 821539Srgrimes ino_t fts_ino; /* inode */ 831539Srgrimes dev_t fts_dev; /* device */ 841539Srgrimes nlink_t fts_nlink; /* link count */ 851539Srgrimes 861539Srgrimes#define FTS_ROOTPARENTLEVEL -1 871539Srgrimes#define FTS_ROOTLEVEL 0 88175688Syar long fts_level; /* depth (-1 to N) */ 891539Srgrimes 901539Srgrimes#define FTS_D 1 /* preorder directory */ 911539Srgrimes#define FTS_DC 2 /* directory that causes cycles */ 921539Srgrimes#define FTS_DEFAULT 3 /* none of the above */ 931539Srgrimes#define FTS_DNR 4 /* unreadable directory */ 941539Srgrimes#define FTS_DOT 5 /* dot or dot-dot */ 951539Srgrimes#define FTS_DP 6 /* postorder directory */ 961539Srgrimes#define FTS_ERR 7 /* error; errno is set */ 971539Srgrimes#define FTS_F 8 /* regular file */ 981539Srgrimes#define FTS_INIT 9 /* initialized only */ 991539Srgrimes#define FTS_NS 10 /* stat(2) failed */ 1001539Srgrimes#define FTS_NSOK 11 /* no stat(2) requested */ 1011539Srgrimes#define FTS_SL 12 /* symbolic link */ 1021539Srgrimes#define FTS_SLNONE 13 /* symbolic link without target */ 10323650Speter#define FTS_W 14 /* whiteout object */ 104175688Syar int fts_info; /* user status for FTSENT structure */ 1051539Srgrimes 1061539Srgrimes#define FTS_DONTCHDIR 0x01 /* don't chdir .. to the parent */ 1071539Srgrimes#define FTS_SYMFOLLOW 0x02 /* followed a symlink to get here */ 10823650Speter#define FTS_ISW 0x04 /* this is a whiteout object */ 109175688Syar unsigned fts_flags; /* private flags for FTSENT structure */ 1101539Srgrimes 1111539Srgrimes#define FTS_AGAIN 1 /* read node again */ 1121539Srgrimes#define FTS_FOLLOW 2 /* follow symbolic link */ 1131539Srgrimes#define FTS_NOINSTR 3 /* no instructions */ 1141539Srgrimes#define FTS_SKIP 4 /* discard node */ 115175688Syar int fts_instr; /* fts_set() instructions */ 1161539Srgrimes 1171539Srgrimes struct stat *fts_statp; /* stat(2) information */ 118103726Swollman char *fts_name; /* file name */ 119103726Swollman FTS *fts_fts; /* back pointer to main FTS */ 1201539Srgrimes} FTSENT; 1211539Srgrimes 1221539Srgrimes#include <sys/cdefs.h> 1231539Srgrimes 1241539Srgrimes__BEGIN_DECLS 12593032SimpFTSENT *fts_children(FTS *, int); 12693032Simpint fts_close(FTS *); 127103726Swollmanvoid *fts_get_clientptr(FTS *); 128103726Swollman#define fts_get_clientptr(fts) ((fts)->fts_clientptr) 129103726SwollmanFTS *fts_get_stream(FTSENT *); 130103726Swollman#define fts_get_stream(ftsent) ((ftsent)->fts_fts) 13193032SimpFTS *fts_open(char * const *, int, 132103726Swollman int (*)(const FTSENT * const *, const FTSENT * const *)); 13393032SimpFTSENT *fts_read(FTS *); 13493032Simpint fts_set(FTS *, FTSENT *, int); 135103726Swollmanvoid fts_set_clientptr(FTS *, void *); 1361539Srgrimes__END_DECLS 1371539Srgrimes 1381539Srgrimes#endif /* !_FTS_H_ */ 139