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: src/include/fts.h,v 1.12 2008/01/26 17:09:40 yar Exp $
  31  * $DragonFly: src/include/fts.h,v 1.3 2003/11/14 01:01:43 dillon Exp $
  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         size_t fts_pathlen;             /* sizeof(path) */
  45         size_t fts_nitems;              /* elements in the sort array */
  46         int (*fts_compar)               /* compare function */
  47             (const struct _ftsent * const *, const struct _ftsent * const *);
  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         void *fts_clientptr;            /* thunk for sort function */
  63 } FTS;
  64
  65 typedef struct _ftsent {
  66         struct _ftsent *fts_cycle;      /* cycle node */
  67         struct _ftsent *fts_parent;     /* parent directory */
  68         struct _ftsent *fts_link;       /* next file in directory */
  69         long long fts_number;           /* local numeric value */
  70 #define fts_bignum      fts_number      /* XXX non-std, should go away */
  71         void *fts_pointer;              /* local address value */
  72         char *fts_accpath;              /* access path */
  73         char *fts_path;                 /* root path */
  74         int fts_errno;                  /* errno for this node */
  75         int fts_symfd;                  /* fd for symlink */
  76         size_t fts_pathlen;             /* strlen(fts_path) */
  77         size_t fts_namelen;             /* strlen(fts_name) */
  78
  79         ino_t fts_ino;                  /* inode */
  80         dev_t fts_dev;                  /* device */
  81         nlink_t fts_nlink;              /* link count */
  82
  83 #define FTS_ROOTPARENTLEVEL     -1
  84 #define FTS_ROOTLEVEL            0
  85         long fts_level;                 /* depth (-1 to N) */
  86
  87 #define FTS_D            1              /* preorder directory */
  88 #define FTS_DC           2              /* directory that causes cycles */
  89 #define FTS_DEFAULT      3              /* none of the above */
  90 #define FTS_DNR          4              /* unreadable directory */
  91 #define FTS_DOT          5              /* dot or dot-dot */
  92 #define FTS_DP           6              /* postorder directory */
  93 #define FTS_ERR          7              /* error; errno is set */
  94 #define FTS_F            8              /* regular file */
  95 #define FTS_INIT         9              /* initialized only */
  96 #define FTS_NS          10              /* stat(2) failed */
  97 #define FTS_NSOK        11              /* no stat(2) requested */
  98 #define FTS_SL          12              /* symbolic link */
  99 #define FTS_SLNONE      13              /* symbolic link without target */
 100 #define FTS_W           14              /* whiteout object */
 101         int fts_info;                   /* user status for FTSENT structure */
 102
 103 #define FTS_DONTCHDIR    0x01           /* don't chdir .. to the parent */
 104 #define FTS_SYMFOLLOW    0x02           /* followed a symlink to get here */
 105 #define FTS_ISW          0x04           /* this is a whiteout object */
 106         unsigned fts_flags;             /* private flags for FTSENT structure */
 107
 108 #define FTS_AGAIN        1              /* read node again */
 109 #define FTS_FOLLOW       2              /* follow symbolic link */
 110 #define FTS_NOINSTR      3              /* no instructions */
 111 #define FTS_SKIP         4              /* discard node */
 112         int fts_instr;                  /* fts_set() instructions */
 113
 114         struct stat *fts_statp;         /* stat(2) information */
 115         char *fts_name;                 /* file name */
 116         FTS *fts_fts;                   /* back pointer to main FTS */
 117 } FTSENT;
 118
 119 #include <sys/cdefs.h>
 120
 121 __BEGIN_DECLS
 122 FTSENT  *fts_children(FTS *, int);
 123 int      fts_close(FTS *);
 124 void    *fts_get_clientptr(FTS *);
 125 #define  fts_get_clientptr(fts) ((fts)->fts_clientptr)
 126 FTS     *fts_get_stream(FTSENT *);
 127 #define  fts_get_stream(ftsent) ((ftsent)->fts_fts)
 128 FTS     *fts_open(char * const *, int,
 129                   int (*)(const FTSENT * const *, const FTSENT * const *));
 130 FTSENT  *fts_read(FTS *);
 131 int      fts_set(FTS *, FTSENT *, int);
 132 void     fts_set_clientptr(FTS *, void *);
 133 __END_DECLS
 134
 135 #endif /* !_FTS_H_ */