summaryrefslogtreecommitdiff
path: root/libs/pbd3/pbd/ftw.h
blob: 9acf8a6967aa7d0d28bcb21ca6429d42b2358899 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
/*
   Copyright (c) 2003 by Joel Baker.
   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 Author nor the names of any contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.
			    
   THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
*/

#ifndef _FTW_H
#define _FTW_H

#include <sys/stat.h>

/* Enumerated values for 'flag' when calling [n]ftw */

enum {
    FTW_D,   /* Directories */
    FTW_DNR, /* Unreadable directory */
    FTW_F,   /* Regular files */
    FTW_SL,  /* Symbolic link */
    FTW_NS,  /* stat(2) failed */

#ifdef __USE_XOPEN_EXTENDED /* X/Open */

/* Flags for nftw only */

    FTW_DP, /* Directory, subdirs visited */
    FTW_SLN, /* Dangling symlink */

#endif /* __USE_XOPEN_EXTENDED */
};

#ifdef __USE_XOPEN_EXTENDED /* X/Open */

/* Enumerated values for 'flags' when calling nftw */

enum {
    FTW_CHDIR = 1, /* Do a chdir(2) when entering a directory */
    FTW_DEPTH = 2, /* Report files first (before directory) */
    FTW_MOUNT = 4, /* Single filesystem */
    FTW_PHYS  = 8  /* Physical walk; ignore symlinks */
};

#define FTW_PHYS FTW_PHYS
#define FTW_MOUNT FTW_MOUNT
#define FTW_CHDIR FTW_CHDIR
#define FTW_DEPTH FTW_DEPTH

/* FTW struct for callbacks from nftw */

struct FTW {
    int base;
    int level;
};

#endif /* __USE_XOPEN_EXTENDED */

/* Typecasts for callback functions */

typedef int (*__ftw_func_t) \
    (const char *file, const struct stat *status, int flag);

#ifdef __USE_XOPEN_EXTENDED /* X/Open */

typedef int (*__nftw_func_t) \
    (const char *file, const struct stat *status, int flag, struct FTW *detail);

#endif /* __USE_XOPEN_EXTENDED */

/* ftw: walk a directory tree, calling a function for each element */

extern int ftw (const char *dir, __ftw_func_t func, int descr);

#ifdef __USE_XOPEN_EXTENDED /* X/Open */

/* nftw: walk a directory tree, calling a function for each element; much
 * like ftw, but with behavior flags and minty freshness.
 */

extern int nftw (const char *dir, __nftw_func_t func, int descr, int flags);

#endif /* __USE_XOPEN_EXTENDED */

#endif /* _FTW_H */