rpmio/fts.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 1989, 1993
00003  *      The Regents of the University of California.  All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions
00007  * are met:
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 4. Neither the name of the University nor the names of its contributors
00014  *    may be used to endorse or promote products derived from this software
00015  *    without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
00018  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00019  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00020  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
00021  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00022  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00023  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00024  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00025  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00026  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00027  * SUCH DAMAGE.
00028  *
00029  *      @(#)fts.h       8.3 (Berkeley) 8/14/94
00030  */
00031 
00032 #ifndef _FTS_H
00033 #define _FTS_H 1
00034 
00035 #if defined(__GLIBC__)
00036 #include <features.h>
00037 #else
00038 
00039 #   define __THROW
00040 #ifdef  __cplusplus
00041 # define __BEGIN_DECLS  extern "C" {
00042 # define __END_DECLS    }
00043 #else
00044 # define __BEGIN_DECLS
00045 # define __END_DECLS
00046 #endif
00047 
00048 #if defined(hpux)
00049 # define _D_EXACT_NAMLEN(d) ((d)->d_namlen)
00050 # define        _INCLUDE_POSIX_SOURCE
00051 # define        _LARGEFILE64_SOURCE
00052 #endif
00053 
00054 #if defined(sun)
00055 # define _D_EXACT_NAMLEN(d) ((d)->d_reclen)
00056 #endif
00057 
00058 #if defined(__APPLE__)
00059 # define _D_EXACT_NAMLEN(d) ((d)->d_reclen)
00060 #endif
00061 
00062 #endif
00063 
00064 #include <sys/types.h>
00065 #include <sys/stat.h>
00066 #include <dirent.h>
00067 
00068 typedef struct {
00069 /*@owned@*/ /*@relnull@*/
00070         struct _ftsent *fts_cur;        
00071 /*@owned@*/ /*@null@*/
00072         struct _ftsent *fts_child;      
00073 /*@owned@*/ /*@null@*/
00074         struct _ftsent **fts_array;     
00075         dev_t fts_dev;                  
00076 /*@owned@*/ /*@relnull@*/
00077         char *fts_path;                 
00078         int fts_rfd;                    
00079         int fts_pathlen;                
00080         int fts_nitems;                 
00081 /*@null@*/
00082         int (*fts_compar) (const void *, const void *)
00083                 /*@*/;                  
00085         DIR * (*fts_opendir) (const char * path)
00086                 /*@globals fileSystem @*/
00087                 /*@modifies fileSystem @*/;
00088         struct dirent * (*fts_readdir) (DIR * dir)
00089                 /*@globals fileSystem @*/
00090                 /*@modifies *dir, fileSystem @*/;
00091         int (*fts_closedir) (/*@only@*/ DIR * dir)
00092                 /*@globals fileSystem @*/
00093                 /*@modifies *dir, fileSystem @*/;
00094         int (*fts_stat) (const char * path, /*@out@*/ struct stat * st)
00095                 /*@globals fileSystem @*/
00096                 /*@modifies *st, fileSystem @*/;
00097         int (*fts_lstat) (const char * path, /*@out@*/ struct stat * st)
00098                 /*@globals fileSystem @*/
00099                 /*@modifies *st, fileSystem @*/;
00100 
00101 #define FTS_COMFOLLOW   0x0001          /* follow command line symlinks */
00102 #define FTS_LOGICAL     0x0002          /* logical walk */
00103 #define FTS_NOCHDIR     0x0004          /* don't change directories */
00104 #define FTS_NOSTAT      0x0008          /* don't get stat info */
00105 #define FTS_PHYSICAL    0x0010          /* physical walk */
00106 #define FTS_SEEDOT      0x0020          /* return dot and dot-dot */
00107 #define FTS_XDEV        0x0040          /* don't cross devices */
00108 #define FTS_WHITEOUT    0x0080          /* return whiteout information */
00109 #define FTS_OPTIONMASK  0x00ff          /* valid user option mask */
00110 
00111 #define FTS_NAMEONLY    0x0100          /* (private) child names only */
00112 #define FTS_STOP        0x0200          /* (private) unrecoverable error */
00113         int fts_options;                
00114 } FTS;
00115 
00116 typedef struct _ftsent {
00117 /*@dependent@*/
00118         struct _ftsent *fts_cycle;      
00119 /*@dependent@*/ /*@relnull@*/
00120         struct _ftsent *fts_parent;     
00121 /*@dependent@*/ /*@null@*/
00122         struct _ftsent *fts_link;       
00123         long fts_number;                
00124 /*@null@*/
00125         void *fts_pointer;              
00126 /*@dependent@*/
00127         char *fts_accpath;              
00128 /*@dependent@*/
00129         char *fts_path;                 
00130         int fts_errno;                  
00131         int fts_symfd;                  
00132         u_short fts_pathlen;            
00133         u_short fts_namelen;            
00135         ino_t fts_ino;                  
00136         dev_t fts_dev;                  
00137         nlink_t fts_nlink;              
00139 #define FTS_ROOTPARENTLEVEL     -1
00140 #define FTS_ROOTLEVEL            0
00141         short fts_level;                
00143 #define FTS_D            1              /* preorder directory */
00144 #define FTS_DC           2              /* directory that causes cycles */
00145 #define FTS_DEFAULT      3              /* none of the above */
00146 #define FTS_DNR          4              /* unreadable directory */
00147 #define FTS_DOT          5              /* dot or dot-dot */
00148 #define FTS_DP           6              /* postorder directory */
00149 #define FTS_ERR          7              /* error; errno is set */
00150 #define FTS_F            8              /* regular file */
00151 #define FTS_INIT         9              /* initialized only */
00152 #define FTS_NS          10              /* stat(2) failed */
00153 #define FTS_NSOK        11              /* no stat(2) requested */
00154 #define FTS_SL          12              /* symbolic link */
00155 #define FTS_SLNONE      13              /* symbolic link without target */
00156 #define FTS_W           14              /* whiteout object */
00157         u_short fts_info;               
00159 #define FTS_DONTCHDIR    0x01           /* don't chdir .. to the parent */
00160 #define FTS_SYMFOLLOW    0x02           /* followed a symlink to get here */
00161         u_short fts_flags;              
00163 #define FTS_AGAIN        1              /* read node again */
00164 #define FTS_FOLLOW       2              /* follow symbolic link */
00165 #define FTS_NOINSTR      3              /* no instructions */
00166 #define FTS_SKIP         4              /* discard node */
00167         u_short fts_instr;              
00169 /*@dependent@*/
00170         struct stat *fts_statp;         
00171         char fts_name[1];               
00172 } FTSENT;
00173 
00174 __BEGIN_DECLS
00175 
00182 /*@dependent@*/ /*@null@*/
00183 FTSENT  *Fts_children (FTS * sp, int instr) __THROW
00184         /*@globals fileSystem, internalState @*/
00185         /*@modifies *sp, fileSystem, internalState @*/;
00186 
00192 int      Fts_close (/*@only@*/ /*@null@*/ FTS * sp) __THROW
00193         /*@globals fileSystem, internalState @*/
00194         /*@modifies *sp, fileSystem, internalState @*/;
00195 
00203 /*@only@*/ /*@null@*/
00204 FTS     *Fts_open (char * const * argv, int options,
00205                    /*@null@*/
00206                    int (*compar) (const FTSENT **, const FTSENT **)) __THROW
00207         /*@*/;
00208 
00214 /*@null@*/
00215 FTSENT  *Fts_read (/*@null@*/ FTS * sp) __THROW
00216         /*@globals fileSystem, internalState @*/
00217         /*@modifies *sp, fileSystem, internalState @*/;
00218 
00226 int      Fts_set (FTS * sp, FTSENT * p, int instr) __THROW
00227         /*@modifies *p @*/;
00228 
00229 __END_DECLS
00230 
00231 #endif /* fts.h */

Generated on Fri Oct 12 08:44:54 2007 for rpm by  doxygen 1.5.2