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
|
/****************************************************************************
* bfs *
* Copyright (C) 2017-2020 Tavian Barnes <tavianator@tavianator.com> *
* *
* Permission to use, copy, modify, and/or distribute this software for any *
* purpose with or without fee is hereby granted. *
* *
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES *
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF *
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR *
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES *
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN *
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF *
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. *
****************************************************************************/
/**
* Implementation of -exec/-execdir/-ok/-okdir.
*/
#ifndef BFS_EXEC_H
#define BFS_EXEC_H
#include <stddef.h>
struct BFTW;
struct bfs_ctx;
/**
* Flags for the -exec actions.
*/
enum bfs_exec_flags {
/** Prompt the user before executing (-ok, -okdir). */
BFS_EXEC_CONFIRM = 1 << 0,
/** Run the command in the file's parent directory (-execdir, -okdir). */
BFS_EXEC_CHDIR = 1 << 1,
/** Pass multiple files at once to the command (-exec ... {} +). */
BFS_EXEC_MULTI = 1 << 2,
};
/**
* Buffer for a command line to be executed.
*/
struct bfs_exec {
/** Flags for this exec buffer. */
enum bfs_exec_flags flags;
/** The bfs context. */
const struct bfs_ctx *ctx;
/** Command line template. */
char **tmpl_argv;
/** Command line template size. */
size_t tmpl_argc;
/** The built command line. */
char **argv;
/** Number of command line arguments. */
size_t argc;
/** Capacity of argv. */
size_t argv_cap;
/** Current size of all arguments. */
size_t arg_size;
/** Maximum arg_size before E2BIG. */
size_t arg_max;
/** A file descriptor for the working directory, for BFS_EXEC_CHDIR. */
int wd_fd;
/** The path to the working directory, for BFS_EXEC_CHDIR. */
char *wd_path;
/** Length of the working directory path. */
size_t wd_len;
/** The ultimate return value for bfs_exec_finish(). */
int ret;
};
/**
* Parse an exec action.
*
* @param argv
* The (bfs) command line argument to parse.
* @param flags
* Any flags for this exec action.
* @param ctx
* The bfs context.
* @return
* The parsed exec action, or NULL on failure.
*/
struct bfs_exec *bfs_exec_parse(const struct bfs_ctx *ctx, char **argv, enum bfs_exec_flags flags);
/**
* Execute the command for a file.
*
* @param execbuf
* The parsed exec action.
* @param ftwbuf
* The bftw() data for the current file.
* @return 0 if the command succeeded, -1 if it failed. If the command could
* be executed, -1 is returned, and errno will be non-zero. For
* BFS_EXEC_MULTI, errors will not be reported until bfs_exec_finish().
*/
int bfs_exec(struct bfs_exec *execbuf, const struct BFTW *ftwbuf);
/**
* Finish executing any commands.
*
* @param execbuf
* The parsed exec action.
* @return 0 on success, -1 if any errors were encountered.
*/
int bfs_exec_finish(struct bfs_exec *execbuf);
/**
* Free a parsed exec action.
*/
void bfs_exec_free(struct bfs_exec *execbuf);
#endif // BFS_EXEC_H
|