include/fts.h

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