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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
/****************************************************************************
* bfs *
* Copyright (C) 2016-2022 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. *
****************************************************************************/
/**
* Standard library wrappers and polyfills.
*/
#ifndef BFS_BFSTD_H
#define BFS_BFSTD_H
#include <stdbool.h>
// #include <errno.h>
/**
* Return whether an error code is due to a path not existing.
*/
bool is_nonexistence_error(int error);
#include <fcntl.h>
#ifndef O_DIRECTORY
# define O_DIRECTORY 0
#endif
#include <fnmatch.h>
#if !defined(FNM_CASEFOLD) && defined(FNM_IGNORECASE)
# define FNM_CASEFOLD FNM_IGNORECASE
#endif
// #include <libgen.h>
/**
* basename() variant that doesn't modify the input.
*
* @param path
* The path in question.
* @return A pointer into path at the base name offset.
*/
const char *xbasename(const char *path);
#include <stdio.h>
/**
* close() variant that preserves errno.
*
* @param fd
* The file descriptor to close.
*/
void close_quietly(int fd);
/**
* close() wrapper that asserts the file descriptor is valid.
*
* @param fd
* The file descriptor to close.
* @return
* 0 on success, or -1 on error.
*/
int xclose(int fd);
/**
* fopen() variant that takes open() style flags.
*
* @param path
* The path to open.
* @param flags
* Flags to pass to open().
*/
FILE *xfopen(const char *path, int flags);
/**
* Convenience wrapper for getdelim().
*
* @param file
* The file to read.
* @param delim
* The delimiter character to split on.
* @return
* The read chunk (without the delimiter), allocated with malloc().
* NULL is returned on error (errno != 0) or end of file (errno == 0).
*/
char *xgetdelim(FILE *file, char delim);
/**
* A safe version of read() that handles interrupted system calls and partial
* reads.
*
* @return
* The number of bytes read. A value != nbytes indicates an error
* (errno != 0) or end of file (errno == 0).
*/
size_t xread(int fd, void *buf, size_t nbytes);
/**
* A safe version of write() that handles interrupted system calls and partial
* writes.
*
* @return
The number of bytes written. A value != nbytes indicates an error.
*/
size_t xwrite(int fd, const void *buf, size_t nbytes);
// #include <stdlib.h>
/**
* Process a yes/no prompt.
*
* @return 1 for yes, 0 for no, and -1 for unknown.
*/
int ynprompt(void);
// #include <string.h>
/**
* Format a mode like ls -l (e.g. -rw-r--r--).
*
* @param mode
* The mode to format.
* @param str
* The string to hold the formatted mode.
*/
void xstrmode(mode_t mode, char str[11]);
#include <sys/types.h>
/**
* Portable version of makedev().
*/
dev_t xmakedev(int ma, int mi);
/**
* Portable version of major().
*/
int xmajor(dev_t dev);
/**
* Portable version of minor().
*/
int xminor(dev_t dev);
#include <unistd.h>
/**
* Like dup(), but set the FD_CLOEXEC flag.
*
* @param fd
* The file descriptor to duplicate.
* @return
* A duplicated file descriptor, or -1 on failure.
*/
int dup_cloexec(int fd);
/**
* Like pipe(), but set the FD_CLOEXEC flag.
*
* @param pipefd
* The array to hold the two file descriptors.
* @return
* 0 on success, -1 on failure.
*/
int pipe_cloexec(int pipefd[2]);
/**
* Wrapper for confstr() that allocates with malloc().
*
* @param name
* The ID of the confstr to look up.
* @return
* The value of the confstr, or NULL on failure.
*/
char *xconfstr(int name);
/**
* Wrapper for faccessat() that handles some portability issues.
*/
int xfaccessat(int fd, const char *path, int amode);
/**
* readlinkat() wrapper that dynamically allocates the result.
*
* @param fd
* The base directory descriptor.
* @param path
* The path to the link, relative to fd.
* @param size
* An estimate for the size of the link name (pass 0 if unknown).
* @return
* The target of the link, allocated with malloc(), or NULL on failure.
*/
char *xreadlinkat(int fd, const char *path, size_t size);
/**
* Portability wrapper for strtofflags().
*
* @param str
* The string to parse. The pointee will be advanced to the first
* invalid position on error.
* @param set
* The flags that are set in the string.
* @param clear
* The flags that are cleared in the string.
* @return
* 0 on success, -1 on failure.
*/
int xstrtofflags(const char **str, unsigned long long *set, unsigned long long *clear);
// #include <wchar.h>
/**
* wcswidth() variant that works on narrow strings.
*
* @param str
* The string to measure.
* @return
* The likely width of that string in a terminal.
*/
size_t xstrwidth(const char *str);
#endif // BFS_BFSTD_H
|
