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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
/*********************************************************************
* bfs *
* Copyright (C) 2015 Tavian Barnes <tavianator@tavianator.com> *
* *
* This program is free software. It comes without any warranty, to *
* the extent permitted by applicable law. You can redistribute it *
* and/or modify it under the terms of the Do What The Fuck You Want *
* To Public License, Version 2, as published by Sam Hocevar. See *
* the COPYING file or http://www.wtfpl.net/ for more details. *
*********************************************************************/
#ifndef BFS_BFTW_H
#define BFS_BFTW_H
#include <stddef.h>
#include <sys/stat.h>
/**
* Possible file types.
*/
typedef enum {
/** Unknown type. */
BFTW_UNKNOWN,
/** Block device. */
BFTW_BLK,
/** Character device. */
BFTW_CHR,
/** Directory. */
BFTW_DIR,
/** Pipe. */
BFTW_FIFO,
/** Symbolic link. */
BFTW_LNK,
/** Regular file. */
BFTW_REG,
/** Socket. */
BFTW_SOCK,
/** An error occurred for this file. */
BFTW_ERROR,
} bftw_typeflag;
/**
* Data about the current file for the bftw() callback.
*/
struct BFTW {
/** The path to the file. */
const char *path;
/** The string offset of the filename. */
size_t nameoff;
/** The depth of this file in the traversal. */
size_t depth;
/** The file type. */
bftw_typeflag typeflag;
/** The errno that occurred, if typeflag == BFTW_ERROR. */
int error;
/** A stat() buffer; may be NULL if no stat() call was needed. */
const struct stat *statbuf;
/** A parent file descriptor for the *at() family of calls. */
int at_fd;
/** The path relative to atfd for the *at() family of calls. */
const char *at_path;
};
typedef enum {
/** Keep walking. */
BFTW_CONTINUE,
/** Skip this path's siblings. */
BFTW_SKIP_SIBLINGS,
/** Skip this path's children. */
BFTW_SKIP_SUBTREE,
/** Stop walking. */
BFTW_STOP,
} bftw_action;
/**
* Callback function type for bftw().
*
* @param ftwbuf
* Data about the current file.
* @param ptr
* The pointer passed to bftw().
* @return
* An action value.
*/
typedef bftw_action bftw_fn(const struct BFTW *ftwbuf, void *ptr);
typedef enum {
/** stat() each encountered file. */
BFTW_STAT = 1 << 0,
/** Attempt to recover from encountered errors. */
BFTW_RECOVER = 1 << 1,
/** Visit all of a directory's descendants before the directory itself. */
BFTW_DEPTH = 1 << 2,
} bftw_flags;
/**
* Breadth First Tree Walk (or Better File Tree Walk).
*
* Like ftw(3) and nftw(3), this function walks a directory tree recursively,
* and invokes a callback for each path it encounters. However, bftw() operates
* breadth-first.
*
* @param path
* The starting path.
* @param fn
* The callback to invoke.
* @param nopenfd
* The maximum number of file descriptors to keep open.
* @param flags
* Flags that control bftw() behavior.
* @param ptr
* A generic pointer which is passed to fn().
* @return
* 0 on success, or -1 on failure.
*/
int bftw(const char *path, bftw_fn *fn, int nopenfd, bftw_flags flags, void *ptr);
#endif // BFS_BFTW_H
|
