Home | History | Annotate | Line # | Download | only in include
fts.h revision 1.11
      1 /*	$NetBSD: fts.h,v 1.11 2003/08/07 09:44:10 agc Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1989, 1993
      5  *	The Regents of the University of California.  All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  * 3. Neither the name of the University nor the names of its contributors
     16  *    may be used to endorse or promote products derived from this software
     17  *    without specific prior written permission.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     29  * SUCH DAMAGE.
     30  *
     31  *	@(#)fts.h	8.3 (Berkeley) 8/14/94
     32  */
     33 
     34 #ifndef	_FTS_H_
     35 #define	_FTS_H_
     36 
     37 typedef struct {
     38 	struct _ftsent *fts_cur;	/* current node */
     39 	struct _ftsent *fts_child;	/* linked list of children */
     40 	struct _ftsent **fts_array;	/* sort array */
     41 	dev_t fts_dev;			/* starting device # */
     42 	char *fts_path;			/* path for this descent */
     43 	int fts_rfd;			/* fd for root */
     44 	u_int fts_pathlen;		/* sizeof(path) */
     45 	u_int fts_nitems;		/* elements in the sort array */
     46 	int (*fts_compar)		/* compare function */
     47 	    __P((const struct _ftsent **, const struct _ftsent **));
     48 
     49 #define	FTS_COMFOLLOW	0x001		/* follow command line symlinks */
     50 #define	FTS_LOGICAL	0x002		/* logical walk */
     51 #define	FTS_NOCHDIR	0x004		/* don't change directories */
     52 #define	FTS_NOSTAT	0x008		/* don't get stat info */
     53 #define	FTS_PHYSICAL	0x010		/* physical walk */
     54 #define	FTS_SEEDOT	0x020		/* return dot and dot-dot */
     55 #define	FTS_XDEV	0x040		/* don't cross devices */
     56 #define	FTS_WHITEOUT	0x080		/* return whiteout information */
     57 #define	FTS_OPTIONMASK	0x0ff		/* valid user option mask */
     58 
     59 #define	FTS_NAMEONLY	0x100		/* (private) child names only */
     60 #define	FTS_STOP	0x200		/* (private) unrecoverable error */
     61 	int fts_options;		/* fts_open options, global flags */
     62 } FTS;
     63 
     64 typedef struct _ftsent {
     65 	struct _ftsent *fts_cycle;	/* cycle node */
     66 	struct _ftsent *fts_parent;	/* parent directory */
     67 	struct _ftsent *fts_link;	/* next file in directory */
     68 	long fts_number;	        /* local numeric value */
     69 	void *fts_pointer;	        /* local address value */
     70 	char *fts_accpath;		/* access path */
     71 	char *fts_path;			/* root path */
     72 	int fts_errno;			/* errno for this node */
     73 	int fts_symfd;			/* fd for symlink */
     74 	u_short fts_pathlen;		/* strlen(fts_path) */
     75 	u_short fts_namelen;		/* strlen(fts_name) */
     76 
     77 	ino_t fts_ino;			/* inode */
     78 	dev_t fts_dev;			/* device */
     79 #ifdef __LIBC12_SOURCE__
     80 	u_int16_t fts_nlink;		/* link count */
     81 #else
     82 	nlink_t fts_nlink;		/* link count */
     83 #endif
     84 
     85 #define	FTS_ROOTPARENTLEVEL	-1
     86 #define	FTS_ROOTLEVEL		 0
     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 #define	FTS_W		14		/* whiteout object */
    103 	u_short fts_info;		/* user flags for FTSENT structure */
    104 
    105 #define	FTS_DONTCHDIR	 0x01		/* don't chdir .. to the parent */
    106 #define	FTS_SYMFOLLOW	 0x02		/* followed a symlink to get here */
    107 #define	FTS_ISW		 0x04		/* this is a whiteout object */
    108 	u_short fts_flags;		/* private flags for FTSENT structure */
    109 
    110 #define	FTS_AGAIN	 1		/* read node again */
    111 #define	FTS_FOLLOW	 2		/* follow symbolic link */
    112 #define	FTS_NOINSTR	 3		/* no instructions */
    113 #define	FTS_SKIP	 4		/* discard node */
    114 	u_short fts_instr;		/* fts_set() instructions */
    115 
    116 #ifdef __LIBC12_SOURCE__
    117 	struct stat12 *fts_statp;	/* stat(2) information */
    118 #else
    119 	struct stat *fts_statp;		/* stat(2) information */
    120 #endif
    121 	char fts_name[1];		/* file name */
    122 } FTSENT;
    123 
    124 #include <sys/cdefs.h>
    125 
    126 __BEGIN_DECLS
    127 #ifdef __LIBC12_SOURCE__
    128 FTSENT	*fts_children __P((FTS *, int));
    129 int	 fts_close __P((FTS *));
    130 FTS	*fts_open __P((char * const *, int,
    131 	    int (*)(const FTSENT **, const FTSENT **)));
    132 FTSENT	*fts_read __P((FTS *));
    133 int	 fts_set __P((FTS *, FTSENT *, int));
    134 #else
    135 FTSENT	*fts_children __P((FTS *, int))		__RENAME(__fts_children13);
    136 int	 fts_close __P((FTS *))			__RENAME(__fts_close13);
    137 FTS	*fts_open __P((char * const *, int,
    138 	    int (*)(const FTSENT **, const FTSENT **)))
    139 						__RENAME(__fts_open13);
    140 FTSENT	*fts_read __P((FTS *))			__RENAME(__fts_read13);
    141 int	 fts_set __P((FTS *, FTSENT *, int))	__RENAME(__fts_set13);
    142 #endif
    143 __END_DECLS
    144 
    145 #endif /* !_FTS_H_ */
    146