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