Fix typo in remote set-head usage
[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
2f1d9e2b 47extern struct strbuf **strbuf_split_buf(const char *, size_t,
28fc3a68 48 int delim, int max);
2f1d9e2b
JK
49static inline struct strbuf **strbuf_split_str(const char *str,
50 int delim, int max)
51{
52 return strbuf_split_buf(str, strlen(str), delim, max);
53}
54static inline struct strbuf **strbuf_split_max(const struct strbuf *sb,
55 int delim, int max)
56{
57 return strbuf_split_buf(sb->buf, sb->len, delim, max);
58}
28fc3a68
JK
59static inline struct strbuf **strbuf_split(const struct strbuf *sb, int delim)
60{
61 return strbuf_split_max(sb, delim, 0);
62}
eacd6dc5 63extern void strbuf_list_free(struct strbuf **);
f1696ee3 64
b449f4cf
PH
65/*----- add data in your buffer -----*/
66static inline void strbuf_addch(struct strbuf *sb, int c) {
67 strbuf_grow(sb, 1);
68 sb->buf[sb->len++] = c;
69 sb->buf[sb->len] = '\0';
70}
71
f1696ee3 72extern void strbuf_insert(struct strbuf *, size_t pos, const void *, size_t);
c76689df 73extern void strbuf_remove(struct strbuf *, size_t pos, size_t len);
f1696ee3 74
917c9a71
PH
75/* splice pos..pos+len with given data */
76extern void strbuf_splice(struct strbuf *, size_t pos, size_t len,
c76689df 77 const void *, size_t);
917c9a71 78
b449f4cf
PH
79extern void strbuf_add(struct strbuf *, const void *, size_t);
80static inline void strbuf_addstr(struct strbuf *sb, const char *s) {
81 strbuf_add(sb, s, strlen(s));
82}
9b200fd6 83static inline void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2) {
81d2caef 84 strbuf_grow(sb, sb2->len);
b449f4cf
PH
85 strbuf_add(sb, sb2->buf, sb2->len);
86}
91db267e 87extern void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len);
b449f4cf 88
c3a670de
MC
89typedef size_t (*expand_fn_t) (struct strbuf *sb, const char *placeholder, void *context);
90extern void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn, void *context);
9b864e73
RS
91struct strbuf_expand_dict_entry {
92 const char *placeholder;
93 const char *value;
94};
95extern size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder, void *context);
361df5df 96extern void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src);
cde75e59 97
28bea9e5 98__attribute__((format (printf,2,3)))
b449f4cf 99extern void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
ebeb6090
JK
100__attribute__((format (printf,2,0)))
101extern void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap);
b449f4cf 102
895680f0
JH
103extern void strbuf_add_lines(struct strbuf *sb, const char *prefix, const char *buf, size_t size);
104
105static inline void strbuf_complete_line(struct strbuf *sb)
106{
107 if (sb->len && sb->buf[sb->len - 1] != '\n')
108 strbuf_addch(sb, '\n');
109}
110
b449f4cf
PH
111extern size_t strbuf_fread(struct strbuf *, size_t, FILE *);
112/* XXX: if read fails, any partial read is undone */
f1696ee3 113extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
387e7e19 114extern int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
b11b7e13 115extern int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint);
b449f4cf 116
c7e4f0d7 117extern int strbuf_getwholeline(struct strbuf *, FILE *, int);
e6c019d0 118extern int strbuf_getline(struct strbuf *, FILE *, int);
5e8617f5 119extern int strbuf_getwholeline_fd(struct strbuf *, int, int);
d1df5743 120
6d69b6f6 121extern void stripspace(struct strbuf *buf, int skip_comments);
7198203a 122extern int launch_editor(const char *path, struct strbuf *buffer, const char *const *env);
6d69b6f6 123
a552de75 124extern int strbuf_branchname(struct strbuf *sb, const char *name);
a2fab531 125extern int strbuf_check_branch_ref(struct strbuf *sb, const char *name);
a552de75 126
c505116b
JK
127extern void strbuf_addstr_urlencode(struct strbuf *, const char *,
128 int reserved);
129
9a0a30aa
NTND
130__attribute__((format (printf,1,2)))
131extern int printf_ln(const char *fmt, ...);
132__attribute__((format (printf,2,3)))
133extern int fprintf_ln(FILE *fp, const char *fmt, ...);
134
d1df5743 135#endif /* STRBUF_H */