misc/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 <rpm/rpmutil.h>
  36
  37 #if defined(__GLIBC__)
  38 #include <features.h>
  39 #else
  40
  41 #   define __THROW
  42 #ifdef  __cplusplus
  43 # define __BEGIN_DECLS  extern "C" {
  44 # define __END_DECLS    }
  45 #else
  46 # define __BEGIN_DECLS
  47 # define __END_DECLS
  48 #endif
  49
  50 #if defined(hpux)
  51 # define _D_EXACT_NAMLEN(d) ((d)->d_namlen)
  52 # define        _INCLUDE_POSIX_SOURCE
  53 # define        _LARGEFILE64_SOURCE
  54 #endif
  55
  56 #if defined(sun)
  57 # define _D_EXACT_NAMLEN(d) ((d)->d_reclen)
  58 #endif
  59
  60 #if defined(__APPLE__)
  61 # define _D_EXACT_NAMLEN(d) (strlen((d)->d_name))
  62 #endif
  63
  64 #endif
  65
  66 #include <sys/types.h>
  67 #include <sys/stat.h>
  68 #include <stdint.h>
  69 #include <dirent.h>
  70
  71 typedef struct {
  72         struct _ftsent *fts_cur;        /*!< current node */
  73         struct _ftsent *fts_child;      /*!< linked list of children */
  74         struct _ftsent **fts_array;     /*!< sort array */
  75         dev_t fts_dev;                  /*!< starting device # */
  76         char *fts_path;                 /*!< path for this descent */
  77         int fts_rfd;                    /*!< fd for root */
  78         int fts_pathlen;                /*!< sizeof(path) */
  79         int fts_nitems;                 /*!< elements in the sort array */
  80         int (*fts_compar) (const void *, const void *);                 /*!< compare fn */
  81
  82         DIR * (*fts_opendir) (const char * path);
  83         struct dirent * (*fts_readdir) (DIR * dir);
  84         int (*fts_closedir) (DIR * dir);
  85         int (*fts_stat) (const char * path, struct stat * st);
  86         int (*fts_lstat) (const char * path, struct stat * st);
  87
  88 #define FTS_COMFOLLOW   0x0001          /* follow command line symlinks */
  89 #define FTS_LOGICAL     0x0002          /* logical walk */
  90 #define FTS_NOCHDIR     0x0004          /* don't change directories */
  91 #define FTS_NOSTAT      0x0008          /* don't get stat info */
  92 #define FTS_PHYSICAL    0x0010          /* physical walk */
  93 #define FTS_SEEDOT      0x0020          /* return dot and dot-dot */
  94 #define FTS_XDEV        0x0040          /* don't cross devices */
  95 #define FTS_WHITEOUT    0x0080          /* return whiteout information */
  96 #define FTS_OPTIONMASK  0x00ff          /* valid user option mask */
  97
  98 #define FTS_NAMEONLY    0x0100          /* (private) child names only */
  99 #define FTS_STOP        0x0200          /* (private) unrecoverable error */
 100         int fts_options;                /*!< fts_open options, global flags */
 101 } FTS;
 102
 103 typedef struct _ftsent {
 104         struct _ftsent *fts_cycle;      /*!< cycle node */
 105         struct _ftsent *fts_parent;     /*!< parent directory */
 106         struct _ftsent *fts_link;       /*!< next file in directory */
 107         long fts_number;                /*!< local numeric value */
 108         void *fts_pointer;              /*!< local address value */
 109         char *fts_accpath;              /*!< access path */
 110         char *fts_path;                 /*!< root path */
 111         int fts_errno;                  /*!< errno for this node */
 112         int fts_symfd;                  /*!< fd for symlink */
 113         uint16_t fts_pathlen;           /*!< strlen(fts_path) */
 114         uint16_t fts_namelen;           /*!< strlen(fts_name) */
 115
 116         ino_t fts_ino;                  /*!< inode */
 117         dev_t fts_dev;                  /*!< device */
 118         nlink_t fts_nlink;              /*!< link count */
 119
 120 #define FTS_ROOTPARENTLEVEL     -1
 121 #define FTS_ROOTLEVEL            0
 122         short fts_level;                /*!< depth (-1 to N) */
 123
 124 #define FTS_D            1              /* preorder directory */
 125 #define FTS_DC           2              /* directory that causes cycles */
 126 #define FTS_DEFAULT      3              /* none of the above */
 127 #define FTS_DNR          4              /* unreadable directory */
 128 #define FTS_DOT          5              /* dot or dot-dot */
 129 #define FTS_DP           6              /* postorder directory */
 130 #define FTS_ERR          7              /* error; errno is set */
 131 #define FTS_F            8              /* regular file */
 132 #define FTS_INIT         9              /* initialized only */
 133 #define FTS_NS          10              /* stat(2) failed */
 134 #define FTS_NSOK        11              /* no stat(2) requested */
 135 #define FTS_SL          12              /* symbolic link */
 136 #define FTS_SLNONE      13              /* symbolic link without target */
 137 #define FTS_W           14              /* whiteout object */
 138         uint16_t fts_info;              /*!< user flags for FTSENT structure */
 139
 140 #define FTS_DONTCHDIR    0x01           /* don't chdir .. to the parent */
 141 #define FTS_SYMFOLLOW    0x02           /* followed a symlink to get here */
 142         uint16_t fts_flags;             /*!< private flags for FTSENT structure */
 143
 144 #define FTS_AGAIN        1              /* read node again */
 145 #define FTS_FOLLOW       2              /* follow symbolic link */
 146 #define FTS_NOINSTR      3              /* no instructions */
 147 #define FTS_SKIP         4              /* discard node */
 148         uint16_t fts_instr;             /*!< fts_set() instructions */
 149
 150         struct stat *fts_statp;         /*!< stat(2) information */
 151         char fts_name[1];               /*!< file name */
 152 } FTSENT;
 153
 154 __BEGIN_DECLS
 155
 156 /**
 157  * Return list of children of the current node.
 158  * @param sp            file hierarchy state
 159  * @param instr
 160  * @return              file set member
 161  */
 162 RPM_GNUC_INTERNAL
 163 FTSENT  *Fts_children (FTS * sp, int instr) __THROW
 164 ;
 165
 166 /**
 167  * Destroy a file hierarchy traversal handle.
 168  * @param sp            file hierarchy state
 169  * @return              0 on sucess, -1 on error
 170  */
 171 RPM_GNUC_INTERNAL
 172 int      Fts_close (FTS * sp) __THROW
 173 ;
 174
 175 /**
 176  * Create a handle for file hierarchy traversal.
 177  * @param argv          paths that compose a logical file hierarchy
 178  * @param options       traversal options
 179  * @param compar        traversal ordering (or NULL)
 180  * @return              file hierarchy state (or NULL on error)
 181  */
 182 RPM_GNUC_INTERNAL
 183 FTS     *Fts_open (char * const * argv, int options,
 184                    int (*compar) (const FTSENT **, const FTSENT **)) __THROW
 185         ;
 186
 187 /**
 188  * Return next node in the file hierarchy traversal.
 189  * @param sp            file hierarchy state
 190  * @return              file set member
 191  */
 192 RPM_GNUC_INTERNAL
 193 FTSENT  *Fts_read (FTS * sp) __THROW
 194 ;
 195
 196 /**
 197  * Modify the traversal for a file set member.
 198  * @param sp            file hierarchy state
 199  * @param p             file set member
 200  * @param instr         new disposition for file set member
 201  * @return              0 on sucess, -1 on error
 202  */
 203 RPM_GNUC_INTERNAL
 204 int      Fts_set (FTS * sp, FTSENT * p, int instr) __THROW
 205 ;
 206
 207 __END_DECLS
 208
 209 #endif /* fts.h */