error_routine: use parent's stderr if exec fails
[git/mjg.git] / strbuf.h
blob9e6d9fa53fc04156452bf850af1a9b2d3ba830f2
1 #ifndef STRBUF_H
2 #define STRBUF_H
4 /* See Documentation/technical/api-strbuf.txt */
6 extern char strbuf_slopbuf[];
7 struct strbuf {
8 size_t alloc;
9 size_t len;
10 char *buf;
13 #define STRBUF_INIT { 0, 0, strbuf_slopbuf }
15 /*----- strbuf life cycle -----*/
16 extern void strbuf_init(struct strbuf *, size_t);
17 extern void strbuf_release(struct strbuf *);
18 extern char *strbuf_detach(struct strbuf *, size_t *);
19 extern void strbuf_attach(struct strbuf *, void *, size_t, size_t);
20 static inline void strbuf_swap(struct strbuf *a, struct strbuf *b) {
21 struct strbuf tmp = *a;
22 *a = *b;
23 *b = tmp;
26 /*----- strbuf size related -----*/
27 static inline size_t strbuf_avail(const struct strbuf *sb) {
28 return sb->alloc ? sb->alloc - sb->len - 1 : 0;
31 extern void strbuf_grow(struct strbuf *, size_t);
33 static inline void strbuf_setlen(struct strbuf *sb, size_t len) {
34 if (len > (sb->alloc ? sb->alloc - 1 : 0))
35 die("BUG: strbuf_setlen() beyond buffer");
36 sb->len = len;
37 sb->buf[len] = '\0';
39 #define strbuf_reset(sb) strbuf_setlen(sb, 0)
41 /*----- content related -----*/
42 extern void strbuf_trim(struct strbuf *);
43 extern void strbuf_rtrim(struct strbuf *);
44 extern void strbuf_ltrim(struct strbuf *);
45 extern int strbuf_cmp(const struct strbuf *, const struct strbuf *);
47 extern struct strbuf **strbuf_split(const struct strbuf *, int delim);
48 extern void strbuf_list_free(struct strbuf **);
50 /*----- add data in your buffer -----*/
51 static inline void strbuf_addch(struct strbuf *sb, int c) {
52 strbuf_grow(sb, 1);
53 sb->buf[sb->len++] = c;
54 sb->buf[sb->len] = '\0';
57 extern void strbuf_insert(struct strbuf *, size_t pos, const void *, size_t);
58 extern void strbuf_remove(struct strbuf *, size_t pos, size_t len);
60 /* splice pos..pos+len with given data */
61 extern void strbuf_splice(struct strbuf *, size_t pos, size_t len,
62 const void *, size_t);
64 extern void strbuf_add(struct strbuf *, const void *, size_t);
65 static inline void strbuf_addstr(struct strbuf *sb, const char *s) {
66 strbuf_add(sb, s, strlen(s));
68 static inline void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2) {
69 strbuf_grow(sb, sb2->len);
70 strbuf_add(sb, sb2->buf, sb2->len);
72 extern void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len);
74 typedef size_t (*expand_fn_t) (struct strbuf *sb, const char *placeholder, void *context);
75 extern void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn, void *context);
76 struct strbuf_expand_dict_entry {
77 const char *placeholder;
78 const char *value;
80 extern size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder, void *context);
81 extern void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src);
83 __attribute__((format (printf,2,3)))
84 extern void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
85 __attribute__((format (printf,2,0)))
86 extern void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap);
88 extern size_t strbuf_fread(struct strbuf *, size_t, FILE *);
89 /* XXX: if read fails, any partial read is undone */
90 extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
91 extern int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
92 extern int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint);
94 extern int strbuf_getwholeline(struct strbuf *, FILE *, int);
95 extern int strbuf_getline(struct strbuf *, FILE *, int);
97 extern void stripspace(struct strbuf *buf, int skip_comments);
98 extern int launch_editor(const char *path, struct strbuf *buffer, const char *const *env);
100 extern int strbuf_branchname(struct strbuf *sb, const char *name);
101 extern int strbuf_check_branch_ref(struct strbuf *sb, const char *name);
103 #endif /* STRBUF_H */