111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert/*	$OpenBSD: fts.h,v 1.12 2009/08/27 16:19:27 millert Exp $	*/
211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert/*	$NetBSD: fts.h,v 1.5 1994/12/28 01:41:50 mycroft Exp $	*/
311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert
411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert/*
511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert * Copyright (c) 1989, 1993
611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert *	The Regents of the University of California.  All rights reserved.
711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert *
811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert * Redistribution and use in source and binary forms, with or without
911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert * modification, are permitted provided that the following conditions
1011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert * are met:
1111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert * 1. Redistributions of source code must retain the above copyright
1211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert *    notice, this list of conditions and the following disclaimer.
1311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert * 2. Redistributions in binary form must reproduce the above copyright
1411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert *    notice, this list of conditions and the following disclaimer in the
1511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert *    documentation and/or other materials provided with the distribution.
1611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert * 3. Neither the name of the University nor the names of its contributors
1711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert *    may be used to endorse or promote products derived from this software
1811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert *    without specific prior written permission.
1911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert *
2011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
2111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
2411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
3011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert * SUCH DAMAGE.
3111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert *
3211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert *	@(#)fts.h	8.3 (Berkeley) 8/14/94
3311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert */
3411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert
3511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#ifndef	_FTS_H_
3611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	_FTS_H_
3711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert
3811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#include <sys/types.h>
3911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert
4011cd02dfb91661c65134cac258cf5924270e9d2Dan Alberttypedef struct {
4111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	struct _ftsent *fts_cur;	/* current node */
4211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	struct _ftsent *fts_child;	/* linked list of children */
4311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	struct _ftsent **fts_array;	/* sort array */
4411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	dev_t fts_dev;			/* starting device # */
4511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	char *fts_path;			/* path for this descent */
4611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	int fts_rfd;			/* fd for root */
4711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	size_t fts_pathlen;		/* sizeof(path) */
4811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	int fts_nitems;			/* elements in the sort array */
4911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	int (*fts_compar)();		/* compare function */
5011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert
5111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_COMFOLLOW	0x0001		/* follow command line symlinks */
5211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_LOGICAL	0x0002		/* logical walk */
5311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_NOCHDIR	0x0004		/* don't change directories */
5411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_NOSTAT	0x0008		/* don't get stat info */
5511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_PHYSICAL	0x0010		/* physical walk */
5611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_SEEDOT	0x0020		/* return dot and dot-dot */
5711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_XDEV	0x0040		/* don't cross devices */
5811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_OPTIONMASK	0x00ff		/* valid user option mask */
5911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert
6011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_NAMEONLY	0x1000		/* (private) child names only */
6111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_STOP	0x2000		/* (private) unrecoverable error */
6211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	int fts_options;		/* fts_open options, global flags */
6311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert} FTS;
6411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert
6511cd02dfb91661c65134cac258cf5924270e9d2Dan Alberttypedef struct _ftsent {
6611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	struct _ftsent *fts_cycle;	/* cycle node */
6711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	struct _ftsent *fts_parent;	/* parent directory */
6811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	struct _ftsent *fts_link;	/* next file in directory */
6911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	long fts_number;	        /* local numeric value */
7011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	void *fts_pointer;	        /* local address value */
7111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	char *fts_accpath;		/* access path */
7211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	char *fts_path;			/* root path */
7311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	int fts_errno;			/* errno for this node */
7411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	int fts_symfd;			/* fd for symlink */
7511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	size_t fts_pathlen;		/* strlen(fts_path) */
7611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	size_t fts_namelen;		/* strlen(fts_name) */
7711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert
7811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	ino_t fts_ino;			/* inode */
7911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	dev_t fts_dev;			/* device */
8011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	nlink_t fts_nlink;		/* link count */
8111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert
8211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_ROOTPARENTLEVEL	-1
8311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_ROOTLEVEL		 0
8411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_MAXLEVEL		 0x7fff
8511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	short fts_level;		/* depth (-1 to N) */
8611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert
8711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_D		 1		/* preorder directory */
8811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_DC		 2		/* directory that causes cycles */
8911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_DEFAULT	 3		/* none of the above */
9011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_DNR		 4		/* unreadable directory */
9111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_DOT		 5		/* dot or dot-dot */
9211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_DP		 6		/* postorder directory */
9311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_ERR		 7		/* error; errno is set */
9411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_F		 8		/* regular file */
9511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_INIT	 9		/* initialized only */
9611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_NS		10		/* stat(2) failed */
9711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_NSOK	11		/* no stat(2) requested */
9811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_SL		12		/* symbolic link */
9911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_SLNONE	13		/* symbolic link without target */
10011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	unsigned short fts_info;	/* user flags for FTSENT structure */
10111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert
10211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_DONTCHDIR	 0x01		/* don't chdir .. to the parent */
10311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_SYMFOLLOW	 0x02		/* followed a symlink to get here */
10411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	unsigned short fts_flags;	/* private flags for FTSENT structure */
10511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert
10611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_AGAIN	 1		/* read node again */
10711cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_FOLLOW	 2		/* follow symbolic link */
10811cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_NOINSTR	 3		/* no instructions */
10911cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#define	FTS_SKIP	 4		/* discard node */
11011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	unsigned short fts_instr;	/* fts_set() instructions */
11111cd02dfb91661c65134cac258cf5924270e9d2Dan Albert
11211cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	struct stat *fts_statp;		/* stat(2) information */
11311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	char fts_name[1];		/* file name */
11411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert} FTSENT;
11511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert
11611cd02dfb91661c65134cac258cf5924270e9d2Dan Albert__BEGIN_DECLS
11711cd02dfb91661c65134cac258cf5924270e9d2Dan AlbertFTSENT	*fts_children(FTS *, int);
11811cd02dfb91661c65134cac258cf5924270e9d2Dan Albertint	 fts_close(FTS *);
11911cd02dfb91661c65134cac258cf5924270e9d2Dan AlbertFTS	*fts_open(char * const *, int,
12011cd02dfb91661c65134cac258cf5924270e9d2Dan Albert	    int (*)(const FTSENT **, const FTSENT **));
12111cd02dfb91661c65134cac258cf5924270e9d2Dan AlbertFTSENT	*fts_read(FTS *);
12211cd02dfb91661c65134cac258cf5924270e9d2Dan Albertint	 fts_set(FTS *, FTSENT *, int);
12311cd02dfb91661c65134cac258cf5924270e9d2Dan Albert__END_DECLS
12411cd02dfb91661c65134cac258cf5924270e9d2Dan Albert
12511cd02dfb91661c65134cac258cf5924270e9d2Dan Albert#endif /* !_FTS_H_ */
126