include/fts.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /*
  26  * Copyright (c) 1989, 1993
  27  *      The Regents of the University of California.  All rights reserved.
  28  *
  29  * Redistribution and use in source and binary forms, with or without
  30  * modification, are permitted provided that the following conditions
  31  * are met:
  32  * 1. Redistributions of source code must retain the above copyright
  33  *    notice, this list of conditions and the following disclaimer.
  34  * 2. Redistributions in binary form must reproduce the above copyright
  35  *    notice, this list of conditions and the following disclaimer in the
  36  *    documentation and/or other materials provided with the distribution.
  37  * 3. All advertising materials mentioning features or use of this software
  38  *    must display the following acknowledgement:
  39  *      This product includes software developed by the University of
  40  *      California, Berkeley and its contributors.
  41  * 4. Neither the name of the University nor the names of its contributors
  42  *    may be used to endorse or promote products derived from this software
  43  *    without specific prior written permission.
  44  *
  45  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  46  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  47  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  48  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  49  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  50  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  51  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  52  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  53  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  54  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  55  * SUCH DAMAGE.
  56  *
  57  *      @(#)fts.h       8.3 (Berkeley) 8/14/94
  58  */
  59
  60 #ifndef _FTS_H_
  61 #define _FTS_H_
  62
  63 typedef struct {
  64         struct _ftsent *fts_cur;        /* current node */
  65         struct _ftsent *fts_child;      /* linked list of children */
  66         struct _ftsent **fts_array;     /* sort array */
  67         dev_t fts_dev;                  /* starting device # */
  68         char *fts_path;                 /* path for this descent */
  69         int fts_rfd;                    /* fd for root */
  70         int fts_pathlen;                /* sizeof(path) */
  71         int fts_nitems;                 /* elements in the sort array */
  72         int (*fts_compar)();            /* compare function */
  73
  74 #define FTS_COMFOLLOW   0x001           /* follow command line symlinks */
  75 #define FTS_LOGICAL     0x002           /* logical walk */
  76 #define FTS_NOCHDIR     0x004           /* don't change directories */
  77 #define FTS_NOSTAT      0x008           /* don't get stat info */
  78 #define FTS_PHYSICAL    0x010           /* physical walk */
  79 #define FTS_SEEDOT      0x020           /* return dot and dot-dot */
  80 #define FTS_XDEV        0x040           /* don't cross devices */
  81 #define FTS_WHITEOUT    0x080           /* return whiteout information */
  82 #define FTS_OPTIONMASK  0x0ff           /* valid user option mask */
  83
  84 #define FTS_NAMEONLY    0x100           /* (private) child names only */
  85 #define FTS_STOP        0x200           /* (private) unrecoverable error */
  86         int fts_options;                /* fts_open options, global flags */
  87 } FTS;
  88
  89 typedef struct _ftsent {
  90         struct _ftsent *fts_cycle;      /* cycle node */
  91         struct _ftsent *fts_parent;     /* parent directory */
  92         struct _ftsent *fts_link;       /* next file in directory */
  93         long fts_number;                /* local numeric value */
  94         void *fts_pointer;              /* local address value */
  95         char *fts_accpath;              /* access path */
  96         char *fts_path;                 /* root path */
  97         int fts_errno;                  /* errno for this node */
  98         int fts_symfd;                  /* fd for symlink */
  99         u_short fts_pathlen;            /* strlen(fts_path) */
 100         u_short fts_namelen;            /* strlen(fts_name) */
 101
 102         ino_t fts_ino;                  /* inode */
 103         dev_t fts_dev;                  /* device */
 104         nlink_t fts_nlink;              /* link count */
 105
 106 #define FTS_ROOTPARENTLEVEL     -1
 107 #define FTS_ROOTLEVEL            0
 108         short fts_level;                /* depth (-1 to N) */
 109
 110 #define FTS_D            1              /* preorder directory */
 111 #define FTS_DC           2              /* directory that causes cycles */
 112 #define FTS_DEFAULT      3              /* none of the above */
 113 #define FTS_DNR          4              /* unreadable directory */
 114 #define FTS_DOT          5              /* dot or dot-dot */
 115 #define FTS_DP           6              /* postorder directory */
 116 #define FTS_ERR          7              /* error; errno is set */
 117 #define FTS_F            8              /* regular file */
 118 #define FTS_INIT         9              /* initialized only */
 119 #define FTS_NS          10              /* stat(2) failed */
 120 #define FTS_NSOK        11              /* no stat(2) requested */
 121 #define FTS_SL          12              /* symbolic link */
 122 #define FTS_SLNONE      13              /* symbolic link without target */
 123 #define FTS_W           14              /* whiteout object */
 124         u_short fts_info;               /* user flags for FTSENT structure */
 125
 126 #define FTS_DONTCHDIR    0x01           /* don't chdir .. to the parent */
 127 #define FTS_SYMFOLLOW    0x02           /* followed a symlink to get here */
 128 #define FTS_ISW          0x04           /* this is a whiteout object */
 129         u_short fts_flags;              /* private flags for FTSENT structure */
 130
 131 #define FTS_AGAIN        1              /* read node again */
 132 #define FTS_FOLLOW       2              /* follow symbolic link */
 133 #define FTS_NOINSTR      3              /* no instructions */
 134 #define FTS_SKIP         4              /* discard node */
 135         u_short fts_instr;              /* fts_set() instructions */
 136
 137         struct stat *fts_statp;         /* stat(2) information */
 138         char fts_name[1];               /* file name */
 139 } FTSENT;
 140
 141 #include <sys/cdefs.h>
 142
 143 __BEGIN_DECLS
 144 FTSENT  *fts_children __P((FTS *, int));
 145 int      fts_close __P((FTS *));
 146 FTS     *fts_open __P((char * const *, int,
 147             int (*)(const FTSENT **, const FTSENT **)));
 148 FTSENT  *fts_read __P((FTS *));
 149 int      fts_set __P((FTS *, FTSENT *, int));
 150 __END_DECLS
 151
 152 #endif /* !_FTS_H_ */