Third batch for 2.1
[git/git.git] / strbuf.h
1 #ifndef STRBUF_H
2 #define STRBUF_H
3
4 /* See Documentation/technical/api-strbuf.txt */
5
6 extern char strbuf_slopbuf[];
7 struct strbuf {
8 size_t alloc;
9 size_t len;
10 char *buf;
11 };
12
13 #define STRBUF_INIT { 0, 0, strbuf_slopbuf }
14
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 {
22 struct strbuf tmp = *a;
23 *a = *b;
24 *b = tmp;
25 }
26
27 /*----- strbuf size related -----*/
28 static inline size_t strbuf_avail(const struct strbuf *sb)
29 {
30 return sb->alloc ? sb->alloc - sb->len - 1 : 0;
31 }
32
33 extern void strbuf_grow(struct strbuf *, size_t);
34
35 static inline void strbuf_setlen(struct strbuf *sb, size_t len)
36 {
37 if (len > (sb->alloc ? sb->alloc - 1 : 0))
38 die("BUG: strbuf_setlen() beyond buffer");
39 sb->len = len;
40 sb->buf[len] = '\0';
41 }
42 #define strbuf_reset(sb) strbuf_setlen(sb, 0)
43
44 /*----- content related -----*/
45 extern void strbuf_trim(struct strbuf *);
46 extern void strbuf_rtrim(struct strbuf *);
47 extern void strbuf_ltrim(struct strbuf *);
48 extern int strbuf_reencode(struct strbuf *sb, const char *from, const char *to);
49 extern void strbuf_tolower(struct strbuf *sb);
50 extern int strbuf_cmp(const struct strbuf *, const struct strbuf *);
51
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 */
65 extern struct strbuf **strbuf_split_buf(const char *, size_t,
66 int terminator, int max);
67
68 /*
69 * Split a NUL-terminated string at the specified terminator
70 * character. See strbuf_split_buf() for more information.
71 */
72 static inline struct strbuf **strbuf_split_str(const char *str,
73 int terminator, int max)
74 {
75 return strbuf_split_buf(str, strlen(str), terminator, max);
76 }
77
78 /*
79 * Split a strbuf at the specified terminator character. See
80 * strbuf_split_buf() for more information.
81 */
82 static inline struct strbuf **strbuf_split_max(const struct strbuf *sb,
83 int terminator, int max)
84 {
85 return strbuf_split_buf(sb->buf, sb->len, terminator, max);
86 }
87
88 /*
89 * Split a strbuf at the specified terminator character. See
90 * strbuf_split_buf() for more information.
91 */
92 static inline struct strbuf **strbuf_split(const struct strbuf *sb,
93 int terminator)
94 {
95 return strbuf_split_max(sb, terminator, 0);
96 }
97
98 /*
99 * Free a NULL-terminated list of strbufs (for example, the return
100 * values of the strbuf_split*() functions).
101 */
102 extern void strbuf_list_free(struct strbuf **);
103
104 /*----- add data in your buffer -----*/
105 static inline void strbuf_addch(struct strbuf *sb, int c)
106 {
107 strbuf_grow(sb, 1);
108 sb->buf[sb->len++] = c;
109 sb->buf[sb->len] = '\0';
110 }
111
112 extern void strbuf_insert(struct strbuf *, size_t pos, const void *, size_t);
113 extern void strbuf_remove(struct strbuf *, size_t pos, size_t len);
114
115 /* splice pos..pos+len with given data */
116 extern void strbuf_splice(struct strbuf *, size_t pos, size_t len,
117 const void *, size_t);
118
119 extern void strbuf_add_commented_lines(struct strbuf *out, const char *buf, size_t size);
120
121 extern void strbuf_add(struct strbuf *, const void *, size_t);
122 static inline void strbuf_addstr(struct strbuf *sb, const char *s)
123 {
124 strbuf_add(sb, s, strlen(s));
125 }
126 static inline void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2)
127 {
128 strbuf_grow(sb, sb2->len);
129 strbuf_add(sb, sb2->buf, sb2->len);
130 }
131 extern void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len);
132
133 typedef size_t (*expand_fn_t) (struct strbuf *sb, const char *placeholder, void *context);
134 extern void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn, void *context);
135 struct strbuf_expand_dict_entry {
136 const char *placeholder;
137 const char *value;
138 };
139 extern size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder, void *context);
140 extern void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src);
141
142 __attribute__((format (printf,2,3)))
143 extern void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
144 __attribute__((format (printf, 2, 3)))
145 extern void strbuf_commented_addf(struct strbuf *sb, const char *fmt, ...);
146 __attribute__((format (printf,2,0)))
147 extern void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap);
148
149 extern void strbuf_add_lines(struct strbuf *sb, const char *prefix, const char *buf, size_t size);
150
151 /*
152 * Append s to sb, with the characters '<', '>', '&' and '"' converted
153 * into XML entities.
154 */
155 extern void strbuf_addstr_xml_quoted(struct strbuf *sb, const char *s);
156
157 static 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
163 extern size_t strbuf_fread(struct strbuf *, size_t, FILE *);
164 /* XXX: if read fails, any partial read is undone */
165 extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
166 extern int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
167 extern int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint);
168
169 extern int strbuf_getwholeline(struct strbuf *, FILE *, int);
170 extern int strbuf_getline(struct strbuf *, FILE *, int);
171 extern int strbuf_getwholeline_fd(struct strbuf *, int, int);
172
173 extern void stripspace(struct strbuf *buf, int skip_comments);
174 extern int launch_editor(const char *path, struct strbuf *buffer, const char *const *env);
175
176 extern int strbuf_branchname(struct strbuf *sb, const char *name);
177 extern int strbuf_check_branch_ref(struct strbuf *sb, const char *name);
178
179 extern void strbuf_addstr_urlencode(struct strbuf *, const char *,
180 int reserved);
181 extern void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes);
182
183 __attribute__((format (printf,1,2)))
184 extern int printf_ln(const char *fmt, ...);
185 __attribute__((format (printf,2,3)))
186 extern int fprintf_ln(FILE *fp, const char *fmt, ...);
187
188 char *xstrdup_tolower(const char *);
189
190 #endif /* STRBUF_H */