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
|
/****************************************************************************
* bfs *
* Copyright (C) 2016-2019 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. *
****************************************************************************/
/**
* A dynamic string library.
*/
#ifndef BFS_DSTRING_H
#define BFS_DSTRING_H
#include "util.h"
#include <stddef.h>
/**
* Allocate a dynamic string.
*
* @param capacity
* The initial capacity of the string.
*/
char *dstralloc(size_t capacity);
/**
* Create a dynamic copy of a string.
*
* @param str
* The NUL-terminated string to copy.
*/
char *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.
*/
char *dstrndup(const char *str, size_t n);
/**
* Get a dynamic string's length.
*
* @param dstr
* The string to measure.
* @return The length of dstr.
*/
size_t dstrlen(const char *dstr);
/**
* Reserve some capacity in a dynamic string.
*
* @param dstr
* The dynamic string to preallocate.
* @param capacity
* The new capacity for the string.
* @return 0 on success, -1 on failure.
*/
int dstreserve(char **dstr, size_t capacity);
/**
* Resize a dynamic string.
*
* @param dstr
* The dynamic string to resize.
* @param length
* The new length for the dynamic string.
* @return 0 on success, -1 on failure.
*/
int dstresize(char **dstr, size_t length);
/**
* 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(char **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(char **dest, const char *src, size_t n);
/**
* 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(char **str, char c);
/**
* 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.
*/
BFS_FORMATTER(1, 2)
char *dstrprintf(const char *format, ...);
/**
* Free a dynamic string.
*
* @param dstr
* The string to free.
*/
void dstrfree(char *dstr);
#endif // BFS_DSTRING_H
|
