source: rtems/cpukit/libmisc/shell/fts.h @ 2649eef

/*      $NetBSD: fts.h,v 1.14 2005/09/13 01:44:32 christos Exp $        */

/*
 * Copyright (c) 1989, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      @(#)fts.h       8.3 (Berkeley) 8/14/94
 */

#ifndef _FTS_H_
#define _FTS_H_

#ifndef __fts_stat_t
#define __fts_stat_t    struct stat
#endif
#ifndef __fts_nlink_t
#define __fts_nlink_t   nlink_t
#endif
#ifndef __fts_ino_t
#define __fts_ino_t     ino_t
#endif

typedef struct {
        struct _ftsent *fts_cur;        /* current node */
        struct _ftsent *fts_child;      /* linked list of children */
        struct _ftsent **fts_array;     /* sort array */
        dev_t fts_dev;                  /* starting device # */
        char *fts_path;                 /* path for this descent */
        int fts_rfd;                    /* fd for root */
        u_int fts_pathlen;              /* sizeof(path) */
        u_int fts_nitems;               /* elements in the sort array */
        int (*fts_compar)               /* compare function */
                (const struct _ftsent **, const struct _ftsent **);

#define FTS_COMFOLLOW   0x001           /* follow command line symlinks */
#define FTS_LOGICAL     0x002           /* logical walk */
#define FTS_NOCHDIR     0x004           /* don't change directories */
#define FTS_NOSTAT      0x008           /* don't get stat info */
#define FTS_PHYSICAL    0x010           /* physical walk */
#define FTS_SEEDOT      0x020           /* return dot and dot-dot */
#define FTS_XDEV        0x040           /* don't cross devices */
#define FTS_WHITEOUT    0x080           /* return whiteout information */
#define FTS_OPTIONMASK  0x0ff           /* valid user option mask */

#define FTS_NAMEONLY    0x100           /* (private) child names only */
#define FTS_STOP        0x200           /* (private) unrecoverable error */
        int fts_options;                /* fts_open options, global flags */
} FTS;

typedef struct _ftsent {
        struct _ftsent *fts_cycle;      /* cycle node */
        struct _ftsent *fts_parent;     /* parent directory */
        struct _ftsent *fts_link;       /* next file in directory */
        long fts_number;                /* local numeric value */
        void *fts_pointer;              /* local address value */
        char *fts_accpath;              /* access path */
        char *fts_path;                 /* root path */
        int fts_errno;                  /* errno for this node */
        int fts_symfd;                  /* fd for symlink */
        u_short fts_pathlen;            /* strlen(fts_path) */
        u_short fts_namelen;            /* strlen(fts_name) */

        __fts_ino_t fts_ino;            /* inode */
        dev_t fts_dev;                  /* device */
        __fts_nlink_t fts_nlink;        /* link count */

#define FTS_ROOTPARENTLEVEL     -1
#define FTS_ROOTLEVEL            0
        short fts_level;                /* depth (-1 to N) */

#define FTS_D            1              /* preorder directory */
#define FTS_DC           2              /* directory that causes cycles */
#define FTS_DEFAULT      3              /* none of the above */
#define FTS_DNR          4              /* unreadable directory */
#define FTS_DOT          5              /* dot or dot-dot */
#define FTS_DP           6              /* postorder directory */
#define FTS_ERR          7              /* error; errno is set */
#define FTS_F            8              /* regular file */
#define FTS_INIT         9              /* initialized only */
#define FTS_NS          10              /* stat(2) failed */
#define FTS_NSOK        11              /* no stat(2) requested */
#define FTS_SL          12              /* symbolic link */
#define FTS_SLNONE      13              /* symbolic link without target */
#define FTS_W           14              /* whiteout object */
        u_short fts_info;               /* user flags for FTSENT structure */

#define FTS_DONTCHDIR    0x01           /* don't chdir .. to the parent */
#define FTS_SYMFOLLOW    0x02           /* followed a symlink to get here */
#define FTS_ISW          0x04           /* this is a whiteout object */
        u_short fts_flags;              /* private flags for FTSENT structure */

#define FTS_AGAIN        1              /* read node again */
#define FTS_FOLLOW       2              /* follow symbolic link */
#define FTS_NOINSTR      3              /* no instructions */
#define FTS_SKIP         4              /* discard node */
        u_short fts_instr;              /* fts_set() instructions */

        __fts_stat_t *fts_statp;        /* stat(2) information */
        char fts_name[1];               /* file name */
} FTSENT;

#include <sys/cdefs.h>

#define __RENAME(n)
#define fts_children rtems_shell_fts_children
#define fts_close    rtems_shell_fts_close
#define fts_open     rtems_shell_fts_open
#define fts_read     rtems_shell_fts_read
#define fts_set      rtems_shell_fts_set

__BEGIN_DECLS
#ifndef __LIBC12_SOURCE__
FTSENT  *fts_children(FTS *, int)               __RENAME(__fts_children30);
int      fts_close(FTS *)                       __RENAME(__fts_close30);
FTS     *fts_open(char * const *, int,
    int (*)(const FTSENT **, const FTSENT **))  __RENAME(__fts_open30);
FTSENT  *fts_read(FTS *)                        __RENAME(__fts_read30);
int      fts_set(FTS *, FTSENT *, int)          __RENAME(__fts_set30);
#endif
__END_DECLS

#endif /* !_FTS_H_ */