lib/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  * 4. 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  */
  31
  32 #ifndef _FTS_H
  33 # define _FTS_H 1
  34
  35 # include <features.h>
  36 # include <sys/types.h>
  37
  38
  39 typedef struct {
  40         struct _ftsent *fts_cur;        /* current node */
  41         struct _ftsent *fts_child;      /* linked list of children */
  42         struct _ftsent **fts_array;     /* sort array */
  43         dev_t fts_dev;                  /* starting device # */
  44         char *fts_path;                 /* path for this descent */
  45         int fts_rfd;                    /* fd for root */
  46         int fts_pathlen;                /* sizeof(path) */
  47         int fts_nitems;                 /* elements in the sort array */
  48         int (*fts_compar) (const void *, const void *); /* compare fn */
  49
  50 # define FTS_COMFOLLOW  0x0001          /* follow command line symlinks */
  51 # define FTS_LOGICAL    0x0002          /* logical walk */
  52 # define FTS_NOCHDIR    0x0004          /* don't change directories */
  53 # define FTS_NOSTAT     0x0008          /* don't get stat info */
  54 # define FTS_PHYSICAL   0x0010          /* physical walk */
  55 # define FTS_SEEDOT     0x0020          /* return dot and dot-dot */
  56 # define FTS_XDEV       0x0040          /* don't cross devices */
  57 # define FTS_WHITEOUT   0x0080          /* return whiteout information */
  58 # define FTS_OPTIONMASK 0x00ff          /* valid user option mask */
  59
  60 # define FTS_NAMEONLY   0x0100          /* (private) child names only */
  61 # define FTS_STOP       0x0200          /* (private) unrecoverable error */
  62         int fts_options;                /* fts_open options, global flags */
  63         /* Data structure in which to store the fingerprint
  64            of each directory we've encountered.  */
  65         void *fts_dir_signatures;
  66 } FTS;
  67
  68 typedef struct _ftsent {
  69         struct _ftsent *fts_cycle;      /* cycle node */
  70         struct _ftsent *fts_parent;     /* parent directory */
  71         struct _ftsent *fts_link;       /* next file in directory */
  72         long fts_number;                /* local numeric value */
  73         void *fts_pointer;              /* local address value */
  74         char *fts_accpath;              /* access path */
  75         char *fts_path;                 /* root path */
  76         int fts_errno;                  /* errno for this node */
  77         int fts_symfd;                  /* fd for symlink */
  78         u_short fts_pathlen;            /* strlen(fts_path) */
  79         u_short fts_namelen;            /* strlen(fts_name) */
  80
  81         ino_t fts_ino;                  /* inode */
  82         dev_t fts_dev;                  /* device */
  83         nlink_t fts_nlink;              /* link count */
  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         u_short 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         u_short fts_instr;              /* fts_set() instructions */
 114
 115         struct stat *fts_statp;         /* stat(2) information */
 116         char fts_name[1];               /* file name */
 117 } FTSENT;
 118
 119 __BEGIN_DECLS
 120 FTSENT  *fts_children (FTS *, int) __THROW;
 121 int      fts_close (FTS *) __THROW;
 122 FTS     *fts_open (char * const *, int,
 123                    int (*)(const FTSENT **, const FTSENT **)) __THROW;
 124 FTSENT  *fts_read (FTS *) __THROW;
 125 int      fts_set (FTS *, FTSENT *, int) __THROW;
 126 __END_DECLS
 127
 128 #endif /* fts.h */