Second batch for 2.3 cycle
[git/git.git] / strbuf.h
CommitLineData
d1df5743
JH
1#ifndef STRBUF_H
2#define STRBUF_H
b449f4cf 3
e0390119 4/* See Documentation/technical/api-strbuf.txt */
b449f4cf 5
b315c5c0 6extern char strbuf_slopbuf[];
d1df5743 7struct strbuf {
b449f4cf
PH
8 size_t alloc;
9 size_t len;
bf0f910d 10 char *buf;
d1df5743
JH
11};
12
b315c5c0 13#define STRBUF_INIT { 0, 0, strbuf_slopbuf }
b449f4cf
PH
14
15/*----- strbuf life cycle -----*/
f1696ee3 16extern void strbuf_init(struct strbuf *, size_t);
b449f4cf 17extern void strbuf_release(struct strbuf *);
b315c5c0 18extern char *strbuf_detach(struct strbuf *, size_t *);
917c9a71 19extern void strbuf_attach(struct strbuf *, void *, size_t, size_t);
187e290a
NTND
20static inline void strbuf_swap(struct strbuf *a, struct strbuf *b)
21{
c76689df
PH
22 struct strbuf tmp = *a;
23 *a = *b;
24 *b = tmp;
25}
b449f4cf
PH
26
27/*----- strbuf size related -----*/
187e290a
NTND
28static inline size_t strbuf_avail(const struct strbuf *sb)
29{
c76689df 30 return sb->alloc ? sb->alloc - sb->len - 1 : 0;
b449f4cf 31}
a8f3e221
JH
32
33extern void strbuf_grow(struct strbuf *, size_t);
34
187e290a
NTND
35static inline void strbuf_setlen(struct strbuf *sb, size_t len)
36{
7141efab
RS
37 if (len > (sb->alloc ? sb->alloc - 1 : 0))
38 die("BUG: strbuf_setlen() beyond buffer");
c76689df
PH
39 sb->len = len;
40 sb->buf[len] = '\0';
b449f4cf 41}
b315c5c0 42#define strbuf_reset(sb) strbuf_setlen(sb, 0)
b449f4cf 43
f1696ee3 44/*----- content related -----*/
eacd6dc5 45extern void strbuf_trim(struct strbuf *);
f1696ee3 46extern void strbuf_rtrim(struct strbuf *);
eacd6dc5 47extern void strbuf_ltrim(struct strbuf *);
d4241f52 48extern int strbuf_reencode(struct strbuf *sb, const char *from, const char *to);
ffb20ce1 49extern void strbuf_tolower(struct strbuf *sb);
9b200fd6 50extern int strbuf_cmp(const struct strbuf *, const struct strbuf *);
eacd6dc5 51
6dda4e60
JK
52static inline int strbuf_strip_suffix(struct strbuf *sb, const char *suffix)
53{
54 if (strip_suffix_mem(sb->buf, &sb->len, suffix)) {
55 strbuf_setlen(sb, sb->len);
56 return 1;
57 } else
58 return 0;
59}
60
06379a65
MH
61/*
62 * Split str (of length slen) at the specified terminator character.
63 * Return a null-terminated array of pointers to strbuf objects
64 * holding the substrings. The substrings include the terminator,
65 * except for the last substring, which might be unterminated if the
66 * original string did not end with a terminator. If max is positive,
67 * then split the string into at most max substrings (with the last
68 * substring containing everything following the (max-1)th terminator
69 * character).
70 *
71 * For lighter-weight alternatives, see string_list_split() and
72 * string_list_split_in_place().
73 */
2f1d9e2b 74extern struct strbuf **strbuf_split_buf(const char *, size_t,
17b73dc6 75 int terminator, int max);
06379a65
MH
76
77/*
78 * Split a NUL-terminated string at the specified terminator
79 * character. See strbuf_split_buf() for more information.
80 */
2f1d9e2b 81static inline struct strbuf **strbuf_split_str(const char *str,
17b73dc6 82 int terminator, int max)
2f1d9e2b 83{
17b73dc6 84 return strbuf_split_buf(str, strlen(str), terminator, max);
2f1d9e2b 85}
06379a65
MH
86
87/*
88 * Split a strbuf at the specified terminator character. See
89 * strbuf_split_buf() for more information.
90 */
2f1d9e2b 91static inline struct strbuf **strbuf_split_max(const struct strbuf *sb,
17b73dc6 92 int terminator, int max)
2f1d9e2b 93{
17b73dc6 94 return strbuf_split_buf(sb->buf, sb->len, terminator, max);
2f1d9e2b 95}
06379a65
MH
96
97/*
98 * Split a strbuf at the specified terminator character. See
99 * strbuf_split_buf() for more information.
100 */
17b73dc6
MH
101static inline struct strbuf **strbuf_split(const struct strbuf *sb,
102 int terminator)
28fc3a68 103{
17b73dc6 104 return strbuf_split_max(sb, terminator, 0);
28fc3a68 105}
06379a65
MH
106
107/*
108 * Free a NULL-terminated list of strbufs (for example, the return
109 * values of the strbuf_split*() functions).
110 */
eacd6dc5 111extern void strbuf_list_free(struct strbuf **);
f1696ee3 112
b449f4cf 113/*----- add data in your buffer -----*/
187e290a
NTND
114static inline void strbuf_addch(struct strbuf *sb, int c)
115{
b449f4cf
PH
116 strbuf_grow(sb, 1);
117 sb->buf[sb->len++] = c;
118 sb->buf[sb->len] = '\0';
119}
120
f1696ee3 121extern void strbuf_insert(struct strbuf *, size_t pos, const void *, size_t);
c76689df 122extern void strbuf_remove(struct strbuf *, size_t pos, size_t len);
f1696ee3 123
917c9a71
PH
124/* splice pos..pos+len with given data */
125extern void strbuf_splice(struct strbuf *, size_t pos, size_t len,
c76689df 126 const void *, size_t);
917c9a71 127
eff80a9f
JH
128extern void strbuf_add_commented_lines(struct strbuf *out, const char *buf, size_t size);
129
b449f4cf 130extern void strbuf_add(struct strbuf *, const void *, size_t);
187e290a
NTND
131static inline void strbuf_addstr(struct strbuf *sb, const char *s)
132{
b449f4cf
PH
133 strbuf_add(sb, s, strlen(s));
134}
187e290a
NTND
135static inline void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2)
136{
81d2caef 137 strbuf_grow(sb, sb2->len);
b449f4cf
PH
138 strbuf_add(sb, sb2->buf, sb2->len);
139}
91db267e 140extern void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len);
d07235a0 141extern void strbuf_addchars(struct strbuf *sb, int c, size_t n);
b449f4cf 142
c3a670de
MC
143typedef size_t (*expand_fn_t) (struct strbuf *sb, const char *placeholder, void *context);
144extern void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn, void *context);
9b864e73
RS
145struct strbuf_expand_dict_entry {
146 const char *placeholder;
147 const char *value;
148};
149extern size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder, void *context);
361df5df 150extern void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src);
cde75e59 151
28bea9e5 152__attribute__((format (printf,2,3)))
b449f4cf 153extern void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
eff80a9f
JH
154__attribute__((format (printf, 2, 3)))
155extern void strbuf_commented_addf(struct strbuf *sb, const char *fmt, ...);
ebeb6090
JK
156__attribute__((format (printf,2,0)))
157extern void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap);
b449f4cf 158
895680f0
JH
159extern void strbuf_add_lines(struct strbuf *sb, const char *prefix, const char *buf, size_t size);
160
5963c036
MH
161/*
162 * Append s to sb, with the characters '<', '>', '&' and '"' converted
163 * into XML entities.
164 */
165extern void strbuf_addstr_xml_quoted(struct strbuf *sb, const char *s);
166
895680f0
JH
167static inline void strbuf_complete_line(struct strbuf *sb)
168{
169 if (sb->len && sb->buf[sb->len - 1] != '\n')
170 strbuf_addch(sb, '\n');
171}
172
b449f4cf
PH
173extern size_t strbuf_fread(struct strbuf *, size_t, FILE *);
174/* XXX: if read fails, any partial read is undone */
f1696ee3 175extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
387e7e19 176extern int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
b11b7e13 177extern int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint);
f22a76e9 178extern int strbuf_getcwd(struct strbuf *sb);
b449f4cf 179
c7e4f0d7 180extern int strbuf_getwholeline(struct strbuf *, FILE *, int);
e6c019d0 181extern int strbuf_getline(struct strbuf *, FILE *, int);
5e8617f5 182extern int strbuf_getwholeline_fd(struct strbuf *, int, int);
d1df5743 183
6d69b6f6 184extern void stripspace(struct strbuf *buf, int skip_comments);
7198203a 185extern int launch_editor(const char *path, struct strbuf *buffer, const char *const *env);
6d69b6f6 186
a552de75 187extern int strbuf_branchname(struct strbuf *sb, const char *name);
a2fab531 188extern int strbuf_check_branch_ref(struct strbuf *sb, const char *name);
a552de75 189
c505116b
JK
190extern void strbuf_addstr_urlencode(struct strbuf *, const char *,
191 int reserved);
079b546a 192extern void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes);
c505116b 193
679eebe2
RS
194extern void strbuf_add_absolute_path(struct strbuf *sb, const char *path);
195
9a0a30aa
NTND
196__attribute__((format (printf,1,2)))
197extern int printf_ln(const char *fmt, ...);
198__attribute__((format (printf,2,3)))
199extern int fprintf_ln(FILE *fp, const char *fmt, ...);
200
88d5a6f6
JK
201char *xstrdup_tolower(const char *);
202
30a0ddb7
JK
203/*
204 * Create a newly allocated string using printf format. You can do this easily
205 * with a strbuf, but this provides a shortcut to save a few lines.
206 */
207__attribute__((format (printf, 1, 0)))
208char *xstrvfmt(const char *fmt, va_list ap);
209__attribute__((format (printf, 1, 2)))
210char *xstrfmt(const char *fmt, ...);
211
d1df5743 212#endif /* STRBUF_H */