strbuf.h: remove a tad stale docs-in-comment and reference api-doc instead
[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
PH
5
6#include <assert.h>
7
b315c5c0 8extern char strbuf_slopbuf[];
d1df5743 9struct strbuf {
b449f4cf
PH
10 size_t alloc;
11 size_t len;
bf0f910d 12 char *buf;
d1df5743
JH
13};
14
b315c5c0 15#define STRBUF_INIT { 0, 0, strbuf_slopbuf }
b449f4cf
PH
16
17/*----- strbuf life cycle -----*/
f1696ee3 18extern void strbuf_init(struct strbuf *, size_t);
b449f4cf 19extern void strbuf_release(struct strbuf *);
b315c5c0 20extern char *strbuf_detach(struct strbuf *, size_t *);
917c9a71 21extern void strbuf_attach(struct strbuf *, void *, size_t, size_t);
c76689df
PH
22static inline void strbuf_swap(struct strbuf *a, struct strbuf *b) {
23 struct strbuf tmp = *a;
24 *a = *b;
25 *b = tmp;
26}
b449f4cf
PH
27
28/*----- strbuf size related -----*/
9b200fd6 29static inline size_t strbuf_avail(const struct strbuf *sb) {
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
b449f4cf 35static inline void strbuf_setlen(struct strbuf *sb, size_t len) {
a8f3e221
JH
36 if (!sb->alloc)
37 strbuf_grow(sb, 0);
38 assert(len < sb->alloc);
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 *);
9b200fd6 48extern int strbuf_cmp(const struct strbuf *, const struct strbuf *);
eacd6dc5
LS
49
50extern struct strbuf **strbuf_split(const struct strbuf *, int delim);
51extern void strbuf_list_free(struct strbuf **);
f1696ee3 52
b449f4cf
PH
53/*----- add data in your buffer -----*/
54static inline void strbuf_addch(struct strbuf *sb, int c) {
55 strbuf_grow(sb, 1);
56 sb->buf[sb->len++] = c;
57 sb->buf[sb->len] = '\0';
58}
59
f1696ee3 60extern void strbuf_insert(struct strbuf *, size_t pos, const void *, size_t);
c76689df 61extern void strbuf_remove(struct strbuf *, size_t pos, size_t len);
f1696ee3 62
917c9a71
PH
63/* splice pos..pos+len with given data */
64extern void strbuf_splice(struct strbuf *, size_t pos, size_t len,
c76689df 65 const void *, size_t);
917c9a71 66
b449f4cf
PH
67extern void strbuf_add(struct strbuf *, const void *, size_t);
68static inline void strbuf_addstr(struct strbuf *sb, const char *s) {
69 strbuf_add(sb, s, strlen(s));
70}
9b200fd6 71static inline void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2) {
81d2caef 72 strbuf_grow(sb, sb2->len);
b449f4cf
PH
73 strbuf_add(sb, sb2->buf, sb2->len);
74}
91db267e 75extern void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len);
b449f4cf 76
c3a670de
MC
77typedef size_t (*expand_fn_t) (struct strbuf *sb, const char *placeholder, void *context);
78extern void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn, void *context);
9b864e73
RS
79struct strbuf_expand_dict_entry {
80 const char *placeholder;
81 const char *value;
82};
83extern size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder, void *context);
361df5df 84extern void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src);
cde75e59 85
28bea9e5 86__attribute__((format (printf,2,3)))
b449f4cf
PH
87extern void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
88
89extern size_t strbuf_fread(struct strbuf *, size_t, FILE *);
90/* XXX: if read fails, any partial read is undone */
f1696ee3 91extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
387e7e19 92extern int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
b11b7e13 93extern int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint);
b449f4cf 94
c7e4f0d7 95extern int strbuf_getwholeline(struct strbuf *, FILE *, int);
e6c019d0 96extern int strbuf_getline(struct strbuf *, FILE *, int);
d1df5743 97
6d69b6f6 98extern void stripspace(struct strbuf *buf, int skip_comments);
7198203a 99extern int launch_editor(const char *path, struct strbuf *buffer, const char *const *env);
6d69b6f6 100
a552de75 101extern int strbuf_branchname(struct strbuf *sb, const char *name);
a2fab531 102extern int strbuf_check_branch_ref(struct strbuf *sb, const char *name);
a552de75 103
d1df5743 104#endif /* STRBUF_H */