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