usr/src/tools/mandoc/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
  30 /*
  31  * This file provides required compatibility definitions and prototypes to build
  32  * tools version of mandoc on older systems.
  33  */
  34
  35 #ifndef _COMPAT_H
  36 #define _COMPAT_H
  37
  38 #include <sys/types.h>
  39
  40 extern void *reallocarray(void *, size_t, size_t);
  41 extern void *recallocarray(void *, size_t, size_t, size_t);
  42 extern long long strtonum(const char *, long long, long long, const char **);
  43
  44 #define be32toh ntohl
  45 #define htobe32 htonl
  46
  47 #endif  /* !_COMPAT_H */
  48
  49 /*
  50  * Below is the copy of fts.h.
  51  */
  52
  53 #ifndef _FTS_H
  54 #define _FTS_H
  55
  56 #include <sys/types.h>
  57
  58 typedef struct {
  59         struct _ftsent *fts_cur;        /* current node */
  60         struct _ftsent *fts_child;      /* linked list of children */
  61         struct _ftsent **fts_array;     /* sort array */
  62         dev_t fts_dev;                  /* starting device # */
  63         char *fts_path;                 /* path for this descent */
  64         int fts_rfd;                    /* fd for root */
  65         size_t fts_pathlen;             /* sizeof(path) */
  66         int fts_nitems;                 /* elements in the sort array */
  67         int (*fts_compar)();            /* compare function */
  68
  69 #define FTS_COMFOLLOW   0x0001          /* follow command line symlinks */
  70 #define FTS_LOGICAL     0x0002          /* logical walk */
  71 #define FTS_NOCHDIR     0x0004          /* don't change directories */
  72 #define FTS_NOSTAT      0x0008          /* don't get stat info */
  73 #define FTS_PHYSICAL    0x0010          /* physical walk */
  74 #define FTS_SEEDOT      0x0020          /* return dot and dot-dot */
  75 #define FTS_XDEV        0x0040          /* don't cross devices */
  76 #define FTS_OPTIONMASK  0x00ff          /* valid user option mask */
  77
  78 #define FTS_NAMEONLY    0x1000          /* (private) child names only */
  79 #define FTS_STOP        0x2000          /* (private) unrecoverable error */
  80         int fts_options;                /* fts_open options, global flags */
  81 } FTS;
  82
  83 typedef struct _ftsent {
  84         struct _ftsent *fts_cycle;      /* cycle node */
  85         struct _ftsent *fts_parent;     /* parent directory */
  86         struct _ftsent *fts_link;       /* next file in directory */
  87         long fts_number;                /* local numeric value */
  88         void *fts_pointer;              /* local address value */
  89         char *fts_accpath;              /* access path */
  90         char *fts_path;                 /* root path */
  91         int fts_errno;                  /* errno for this node */
  92         int fts_symfd;                  /* fd for symlink */
  93         size_t fts_pathlen;             /* strlen(fts_path) */
  94         size_t fts_namelen;             /* strlen(fts_name) */
  95
  96         ino_t fts_ino;                  /* inode */
  97         dev_t fts_dev;                  /* device */
  98         nlink_t fts_nlink;              /* link count */
  99
 100 #define FTS_ROOTPARENTLEVEL     -1
 101 #define FTS_ROOTLEVEL            0
 102 #define FTS_MAXLEVEL             0x7fffffff
 103         int fts_level;          /* depth (-1 to N) */
 104
 105 #define FTS_D            1              /* preorder directory */
 106 #define FTS_DC           2              /* directory that causes cycles */
 107 #define FTS_DEFAULT      3              /* none of the above */
 108 #define FTS_DNR          4              /* unreadable directory */
 109 #define FTS_DOT          5              /* dot or dot-dot */
 110 #define FTS_DP           6              /* postorder directory */
 111 #define FTS_ERR          7              /* error; errno is set */
 112 #define FTS_F            8              /* regular file */
 113 #define FTS_INIT         9              /* initialized only */
 114 #define FTS_NS          10              /* stat(2) failed */
 115 #define FTS_NSOK        11              /* no stat(2) requested */
 116 #define FTS_SL          12              /* symbolic link */
 117 #define FTS_SLNONE      13              /* symbolic link without target */
 118         unsigned short fts_info;        /* user flags for FTSENT structure */
 119
 120 #define FTS_DONTCHDIR    0x01           /* don't chdir .. to the parent */
 121 #define FTS_SYMFOLLOW    0x02           /* followed a symlink to get here */
 122         unsigned short fts_flags;       /* private flags for FTSENT structure */
 123
 124 #define FTS_AGAIN        1              /* read node again */
 125 #define FTS_FOLLOW       2              /* follow symbolic link */
 126 #define FTS_NOINSTR      3              /* no instructions */
 127 #define FTS_SKIP         4              /* discard node */
 128         unsigned short fts_instr;       /* fts_set() instructions */
 129
 130         unsigned short fts_spare;       /* unused */
 131
 132         struct stat *fts_statp;         /* stat(2) information */
 133         char fts_name[1];               /* file name */
 134 } FTSENT;
 135
 136 FTSENT  *fts_children(FTS *, int);
 137 int      fts_close(FTS *);
 138 FTS     *fts_open(char * const *, int,
 139             int (*)(const FTSENT **, const FTSENT **));
 140 FTSENT  *fts_read(FTS *);
 141 int      fts_set(FTS *, FTSENT *, int);
 142
 143 #endif /* !_FTS_H */