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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
|
// Copyright © Tavian Barnes <tavianator@tavianator.com>
// SPDX-License-Identifier: 0BSD
/**
* A dynamic string library.
*/
#ifndef BFS_DSTRING_H
#define BFS_DSTRING_H
#include "prelude.h"
#include "bfstd.h"
#include <stdarg.h>
#include <stddef.h>
/** Marker type for dynamic strings. */
#if BFS_LINT && __clang__
// Abuse __attribute__(aligned) to make a type that allows
//
// dchar * -> char *
//
// conversions, but warns (with Clang's -Walign-mismatch) on
//
// char * -> dchar *
typedef __attribute__((aligned(alignof(size_t)))) char dchar;
#else
typedef char dchar;
#endif
/**
* Free a dynamic string.
*
* @param dstr
* The string to free.
*/
void dstrfree(dchar *dstr);
/**
* Allocate a dynamic string.
*
* @param cap
* The initial capacity of the string.
*/
attr(malloc(dstrfree, 1))
dchar *dstralloc(size_t cap);
/**
* Create a dynamic copy of a string.
*
* @param str
* The NUL-terminated string to copy.
*/
attr(malloc(dstrfree, 1))
dchar *dstrdup(const char *str);
/**
* Create a length-limited dynamic copy of a string.
*
* @param str
* The string to copy.
* @param n
* The maximum number of characters to copy from str.
*/
attr(malloc(dstrfree, 1))
dchar *dstrndup(const char *str, size_t n);
/**
* Create a dynamic copy of a dynamic string.
*
* @param dstr
* The dynamic string to copy.
*/
attr(malloc(dstrfree, 1))
dchar *dstrddup(const dchar *dstr);
/**
* Create an exact-sized dynamic copy of a string.
*
* @param str
* The string to copy.
* @param len
* The length of the string, which may include internal NUL bytes.
*/
attr(malloc(dstrfree, 1))
dchar *dstrxdup(const char *str, size_t len);
/**
* Get a dynamic string's length.
*
* @param dstr
* The string to measure.
* @return
* The length of dstr.
*/
size_t dstrlen(const dchar *dstr);
/**
* Reserve some capacity in a dynamic string.
*
* @param dstr
* The dynamic string to preallocate.
* @param cap
* The new capacity for the string.
* @return
* 0 on success, -1 on failure.
*/
int dstreserve(dchar **dstr, size_t cap);
/**
* Resize a dynamic string.
*
* @param dstr
* The dynamic string to resize.
* @param len
* The new length for the dynamic string.
* @return
* 0 on success, -1 on failure.
*/
int dstresize(dchar **dstr, size_t len);
/**
* Append to a dynamic string.
*
* @param dest
* The destination dynamic string.
* @param src
* The string to append.
* @return 0 on success, -1 on failure.
*/
int dstrcat(dchar **dest, const char *src);
/**
* Append to a dynamic string.
*
* @param dest
* The destination dynamic string.
* @param src
* The string to append.
* @param n
* The maximum number of characters to take from src.
* @return
* 0 on success, -1 on failure.
*/
int dstrncat(dchar **dest, const char *src, size_t n);
/**
* Append a dynamic string to another dynamic string.
*
* @param dest
* The destination dynamic string.
* @param src
* The dynamic string to append.
* @return
* 0 on success, -1 on failure.
*/
int dstrdcat(dchar **dest, const dchar *src);
/**
* Append to a dynamic string.
*
* @param dest
* The destination dynamic string.
* @param src
* The string to append.
* @param len
* The exact number of characters to take from src.
* @return
* 0 on success, -1 on failure.
*/
int dstrxcat(dchar **dest, const char *src, size_t len);
/**
* Append a single character to a dynamic string.
*
* @param str
* The string to append to.
* @param c
* The character to append.
* @return
* 0 on success, -1 on failure.
*/
int dstrapp(dchar **str, char c);
/**
* Copy a string into a dynamic string.
*
* @param dest
* The destination dynamic string.
* @param src
* The string to copy.
* @returns
* 0 on success, -1 on failure.
*/
int dstrcpy(dchar **dest, const char *str);
/**
* Copy a dynamic string into another one.
*
* @param dest
* The destination dynamic string.
* @param src
* The dynamic string to copy.
* @returns
* 0 on success, -1 on failure.
*/
int dstrdcpy(dchar **dest, const dchar *str);
/**
* Copy a string into a dynamic string.
*
* @param dest
* The destination dynamic string.
* @param src
* The dynamic string to copy.
* @param n
* The maximum number of characters to take from src.
* @returns
* 0 on success, -1 on failure.
*/
int dstrncpy(dchar **dest, const char *str, size_t n);
/**
* Copy a string into a dynamic string.
*
* @param dest
* The destination dynamic string.
* @param src
* The dynamic string to copy.
* @param len
* The exact number of characters to take from src.
* @returns
* 0 on success, -1 on failure.
*/
int dstrxcpy(dchar **dest, const char *str, size_t len);
/**
* Create a dynamic string from a format string.
*
* @param format
* The format string to fill in.
* @param ...
* Any arguments for the format string.
* @return
* The created string, or NULL on failure.
*/
attr(printf(1, 2))
char *dstrprintf(const char *format, ...);
/**
* Create a dynamic string from a format string and a va_list.
*
* @param format
* The format string to fill in.
* @param args
* The arguments for the format string.
* @return
* The created string, or NULL on failure.
*/
attr(printf(1, 0))
char *dstrvprintf(const char *format, va_list args);
/**
* Format some text onto the end of a dynamic string.
*
* @param str
* The destination dynamic string.
* @param format
* The format string to fill in.
* @param ...
* Any arguments for the format string.
* @return
* 0 on success, -1 on failure.
*/
attr(printf(2, 3))
int dstrcatf(dchar **str, const char *format, ...);
/**
* Format some text from a va_list onto the end of a dynamic string.
*
* @param str
* The destination dynamic string.
* @param format
* The format string to fill in.
* @param args
* The arguments for the format string.
* @return
* 0 on success, -1 on failure.
*/
attr(printf(2, 0))
int dstrvcatf(dchar **str, const char *format, va_list args);
/**
* Concatenate while shell-escaping.
*
* @param dest
* The destination dynamic string.
* @param str
* The string to escape.
* @param flags
* Flags for wordesc().
* @return
* 0 on success, -1 on failure.
*/
int dstrescat(dchar **dest, const char *str, enum wesc_flags flags);
/**
* Concatenate while shell-escaping.
*
* @param dest
* The destination dynamic string.
* @param str
* The string to escape.
* @param n
* The maximum length of the string.
* @param flags
* Flags for wordesc().
* @return
* 0 on success, -1 on failure.
*/
int dstrnescat(dchar **dest, const char *str, size_t n, enum wesc_flags flags);
#endif // BFS_DSTRING_H
|
