Third batch for 2.1
[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
06379a65
MH
52/*
53 * Split str (of length slen) at the specified terminator character.
54 * Return a null-terminated array of pointers to strbuf objects
55 * holding the substrings. The substrings include the terminator,
56 * except for the last substring, which might be unterminated if the
57 * original string did not end with a terminator. If max is positive,
58 * then split the string into at most max substrings (with the last
59 * substring containing everything following the (max-1)th terminator
60 * character).
61 *
62 * For lighter-weight alternatives, see string_list_split() and
63 * string_list_split_in_place().
64 */
2f1d9e2b 65extern struct strbuf **strbuf_split_buf(const char *, size_t,
17b73dc6 66 int terminator, int max);
06379a65
MH
67
68/*
69 * Split a NUL-terminated string at the specified terminator
70 * character. See strbuf_split_buf() for more information.
71 */
2f1d9e2b 72static inline struct strbuf **strbuf_split_str(const char *str,
17b73dc6 73 int terminator, int max)
2f1d9e2b 74{
17b73dc6 75 return strbuf_split_buf(str, strlen(str), terminator, max);
2f1d9e2b 76}
06379a65
MH
77
78/*
79 * Split a strbuf at the specified terminator character. See
80 * strbuf_split_buf() for more information.
81 */
2f1d9e2b 82static inline struct strbuf **strbuf_split_max(const struct strbuf *sb,
17b73dc6 83 int terminator, int max)
2f1d9e2b 84{
17b73dc6 85 return strbuf_split_buf(sb->buf, sb->len, terminator, max);
2f1d9e2b 86}
06379a65
MH
87
88/*
89 * Split a strbuf at the specified terminator character. See
90 * strbuf_split_buf() for more information.
91 */
17b73dc6
MH
92static inline struct strbuf **strbuf_split(const struct strbuf *sb,
93 int terminator)
28fc3a68 94{
17b73dc6 95 return strbuf_split_max(sb, terminator, 0);
28fc3a68 96}
06379a65
MH
97
98/*
99 * Free a NULL-terminated list of strbufs (for example, the return
100 * values of the strbuf_split*() functions).
101 */
eacd6dc5 102extern void strbuf_list_free(struct strbuf **);
f1696ee3 103
b449f4cf 104/*----- add data in your buffer -----*/
187e290a
NTND
105static inline void strbuf_addch(struct strbuf *sb, int c)
106{
b449f4cf
PH
107 strbuf_grow(sb, 1);
108 sb->buf[sb->len++] = c;
109 sb->buf[sb->len] = '\0';
110}
111
f1696ee3 112extern void strbuf_insert(struct strbuf *, size_t pos, const void *, size_t);
c76689df 113extern void strbuf_remove(struct strbuf *, size_t pos, size_t len);
f1696ee3 114
917c9a71
PH
115/* splice pos..pos+len with given data */
116extern void strbuf_splice(struct strbuf *, size_t pos, size_t len,
c76689df 117 const void *, size_t);
917c9a71 118
eff80a9f
JH
119extern void strbuf_add_commented_lines(struct strbuf *out, const char *buf, size_t size);
120
b449f4cf 121extern void strbuf_add(struct strbuf *, const void *, size_t);
187e290a
NTND
122static inline void strbuf_addstr(struct strbuf *sb, const char *s)
123{
b449f4cf
PH
124 strbuf_add(sb, s, strlen(s));
125}
187e290a
NTND
126static inline void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2)
127{
81d2caef 128 strbuf_grow(sb, sb2->len);
b449f4cf
PH
129 strbuf_add(sb, sb2->buf, sb2->len);
130}
91db267e 131extern void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len);
b449f4cf 132
c3a670de
MC
133typedef size_t (*expand_fn_t) (struct strbuf *sb, const char *placeholder, void *context);
134extern void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn, void *context);
9b864e73
RS
135struct strbuf_expand_dict_entry {
136 const char *placeholder;
137 const char *value;
138};
139extern size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder, void *context);
361df5df 140extern void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src);
cde75e59 141
28bea9e5 142__attribute__((format (printf,2,3)))
b449f4cf 143extern void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
eff80a9f
JH
144__attribute__((format (printf, 2, 3)))
145extern void strbuf_commented_addf(struct strbuf *sb, const char *fmt, ...);
ebeb6090
JK
146__attribute__((format (printf,2,0)))
147extern void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap);
b449f4cf 148
895680f0
JH
149extern void strbuf_add_lines(struct strbuf *sb, const char *prefix, const char *buf, size_t size);
150
5963c036
MH
151/*
152 * Append s to sb, with the characters '<', '>', '&' and '"' converted
153 * into XML entities.
154 */
155extern void strbuf_addstr_xml_quoted(struct strbuf *sb, const char *s);
156
895680f0
JH
157static inline void strbuf_complete_line(struct strbuf *sb)
158{
159 if (sb->len && sb->buf[sb->len - 1] != '\n')
160 strbuf_addch(sb, '\n');
161}
162
b449f4cf
PH
163extern size_t strbuf_fread(struct strbuf *, size_t, FILE *);
164/* XXX: if read fails, any partial read is undone */
f1696ee3 165extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
387e7e19 166extern int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
b11b7e13 167extern int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint);
b449f4cf 168
c7e4f0d7 169extern int strbuf_getwholeline(struct strbuf *, FILE *, int);
e6c019d0 170extern int strbuf_getline(struct strbuf *, FILE *, int);
5e8617f5 171extern int strbuf_getwholeline_fd(struct strbuf *, int, int);
d1df5743 172
6d69b6f6 173extern void stripspace(struct strbuf *buf, int skip_comments);
7198203a 174extern int launch_editor(const char *path, struct strbuf *buffer, const char *const *env);
6d69b6f6 175
a552de75 176extern int strbuf_branchname(struct strbuf *sb, const char *name);
a2fab531 177extern int strbuf_check_branch_ref(struct strbuf *sb, const char *name);
a552de75 178
c505116b
JK
179extern void strbuf_addstr_urlencode(struct strbuf *, const char *,
180 int reserved);
079b546a 181extern void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes);
c505116b 182
9a0a30aa
NTND
183__attribute__((format (printf,1,2)))
184extern int printf_ln(const char *fmt, ...);
185__attribute__((format (printf,2,3)))
186extern int fprintf_ln(FILE *fp, const char *fmt, ...);
187
88d5a6f6
JK
188char *xstrdup_tolower(const char *);
189
d1df5743 190#endif /* STRBUF_H */