bsd/include/fts.h

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