include/fts.h

   1 /*      $NetBSD: fts.h,v 1.19 2009/08/16 19:33:38 christos Exp $        */
   2
   3 /*
   4  * Copyright (c) 1989, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)fts.h       8.3 (Berkeley) 8/14/94
  32  */
  33
  34 #ifndef _FTS_H_
  35 #define _FTS_H_
  36
  37 #ifndef __fts_stat_t
  38 #define __fts_stat_t    struct stat
  39 #endif
  40 #ifndef __fts_nlink_t
  41 #define __fts_nlink_t   nlink_t
  42 #endif
  43 #ifndef __fts_ino_t
  44 #define __fts_ino_t     ino_t
  45 #endif
  46 #ifndef __fts_length_t
  47 #define __fts_length_t  unsigned int
  48 #endif
  49 #ifndef __fts_number_t
  50 #define __fts_number_t  int64_t
  51 #endif
  52 #ifndef __fts_dev_t
  53 #define __fts_dev_t     dev_t
  54 #endif
  55 #ifndef __fts_level_t
  56 #define __fts_level_t   int
  57 #endif
  58
  59 typedef struct {
  60         struct _ftsent *fts_cur;        /* current node */
  61         struct _ftsent *fts_child;      /* linked list of children */
  62         struct _ftsent **fts_array;     /* sort array */
  63         dev_t fts_dev;                  /* starting device # */
  64         char *fts_path;                 /* path for this descent */
  65         int fts_rfd;                    /* fd for root */
  66         unsigned int fts_pathlen;       /* sizeof(path) */
  67         unsigned int fts_nitems;        /* elements in the sort array */
  68         int (*fts_compar)               /* compare function */
  69                 (const struct _ftsent **, const struct _ftsent **);
  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         __fts_number_t 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         __fts_length_t fts_pathlen;     /* strlen(fts_path) */
  97         __fts_length_t fts_namelen;     /* strlen(fts_name) */
  98
  99         __fts_ino_t fts_ino;            /* inode */
 100         __fts_dev_t fts_dev;            /* device */
 101         __fts_nlink_t fts_nlink;        /* link count */
 102
 103 #define FTS_ROOTPARENTLEVEL     -1
 104 #define FTS_ROOTLEVEL            0
 105         __fts_level_t 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         unsigned 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         unsigned 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         unsigned short fts_instr;       /* fts_set() instructions */
 133
 134         __fts_stat_t *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 #ifndef __LIBC12_SOURCE__
 142 FTSENT  *fts_children(FTS *, int)               __RENAME(__fts_children60);
 143 int      fts_close(FTS *)                       __RENAME(__fts_close60);
 144 FTS     *fts_open(char * const *, int,
 145     int (*)(const FTSENT **, const FTSENT **))  __RENAME(__fts_open60);
 146 FTSENT  *fts_read(FTS *)                        __RENAME(__fts_read60);
 147 int      fts_set(FTS *, FTSENT *, int)          __RENAME(__fts_set60);
 148 #endif
 149 __END_DECLS
 150
 151 #endif /* !_FTS_H_ */