2005-04-26 01:26:45 +00:00
|
|
|
#ifndef STRBUF_H
|
|
|
|
#define STRBUF_H
|
2007-09-06 11:20:05 +00:00
|
|
|
|
2011-02-15 23:12:04 +00:00
|
|
|
/* See Documentation/technical/api-strbuf.txt */
|
2007-09-06 11:20:05 +00:00
|
|
|
|
2007-09-27 10:58:23 +00:00
|
|
|
extern char strbuf_slopbuf[];
|
2005-04-26 01:26:45 +00:00
|
|
|
struct strbuf {
|
2007-09-06 11:20:05 +00:00
|
|
|
size_t alloc;
|
|
|
|
size_t len;
|
2005-05-18 12:14:09 +00:00
|
|
|
char *buf;
|
2005-04-26 01:26:45 +00:00
|
|
|
};
|
|
|
|
|
2007-09-27 10:58:23 +00:00
|
|
|
#define STRBUF_INIT { 0, 0, strbuf_slopbuf }
|
2007-09-06 11:20:05 +00:00
|
|
|
|
|
|
|
/*----- strbuf life cycle -----*/
|
2007-09-10 10:35:04 +00:00
|
|
|
extern void strbuf_init(struct strbuf *, size_t);
|
2007-09-06 11:20:05 +00:00
|
|
|
extern void strbuf_release(struct strbuf *);
|
2007-09-27 10:58:23 +00:00
|
|
|
extern char *strbuf_detach(struct strbuf *, size_t *);
|
2007-09-15 13:56:50 +00:00
|
|
|
extern void strbuf_attach(struct strbuf *, void *, size_t, size_t);
|
2014-03-01 02:50:55 +00:00
|
|
|
static inline void strbuf_swap(struct strbuf *a, struct strbuf *b)
|
|
|
|
{
|
2007-09-19 22:42:12 +00:00
|
|
|
struct strbuf tmp = *a;
|
|
|
|
*a = *b;
|
|
|
|
*b = tmp;
|
|
|
|
}
|
2007-09-06 11:20:05 +00:00
|
|
|
|
|
|
|
/*----- strbuf size related -----*/
|
2014-03-01 02:50:55 +00:00
|
|
|
static inline size_t strbuf_avail(const struct strbuf *sb)
|
|
|
|
{
|
2007-09-19 22:42:12 +00:00
|
|
|
return sb->alloc ? sb->alloc - sb->len - 1 : 0;
|
2007-09-06 11:20:05 +00:00
|
|
|
}
|
2007-09-26 09:26:06 +00:00
|
|
|
|
|
|
|
extern void strbuf_grow(struct strbuf *, size_t);
|
|
|
|
|
2014-03-01 02:50:55 +00:00
|
|
|
static inline void strbuf_setlen(struct strbuf *sb, size_t len)
|
|
|
|
{
|
2011-04-27 17:24:50 +00:00
|
|
|
if (len > (sb->alloc ? sb->alloc - 1 : 0))
|
|
|
|
die("BUG: strbuf_setlen() beyond buffer");
|
2007-09-19 22:42:12 +00:00
|
|
|
sb->len = len;
|
|
|
|
sb->buf[len] = '\0';
|
2007-09-06 11:20:05 +00:00
|
|
|
}
|
2007-09-27 10:58:23 +00:00
|
|
|
#define strbuf_reset(sb) strbuf_setlen(sb, 0)
|
2007-09-06 11:20:05 +00:00
|
|
|
|
2007-09-10 10:35:04 +00:00
|
|
|
/*----- content related -----*/
|
2008-07-13 18:29:18 +00:00
|
|
|
extern void strbuf_trim(struct strbuf *);
|
2007-09-10 10:35:04 +00:00
|
|
|
extern void strbuf_rtrim(struct strbuf *);
|
2008-07-13 18:29:18 +00:00
|
|
|
extern void strbuf_ltrim(struct strbuf *);
|
2014-05-22 09:30:14 +00:00
|
|
|
extern int strbuf_reencode(struct strbuf *sb, const char *from, const char *to);
|
2014-05-23 20:03:47 +00:00
|
|
|
extern void strbuf_tolower(struct strbuf *sb);
|
2008-07-13 18:28:24 +00:00
|
|
|
extern int strbuf_cmp(const struct strbuf *, const struct strbuf *);
|
2008-07-13 18:29:18 +00:00
|
|
|
|
2014-06-30 17:01:51 +00:00
|
|
|
static inline int strbuf_strip_suffix(struct strbuf *sb, const char *suffix)
|
|
|
|
{
|
|
|
|
if (strip_suffix_mem(sb->buf, &sb->len, suffix)) {
|
|
|
|
strbuf_setlen(sb, sb->len);
|
|
|
|
return 1;
|
|
|
|
} else
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2012-11-04 06:46:54 +00:00
|
|
|
/*
|
|
|
|
* Split str (of length slen) at the specified terminator character.
|
|
|
|
* Return a null-terminated array of pointers to strbuf objects
|
|
|
|
* holding the substrings. The substrings include the terminator,
|
|
|
|
* except for the last substring, which might be unterminated if the
|
|
|
|
* original string did not end with a terminator. If max is positive,
|
|
|
|
* then split the string into at most max substrings (with the last
|
|
|
|
* substring containing everything following the (max-1)th terminator
|
|
|
|
* character).
|
|
|
|
*
|
|
|
|
* For lighter-weight alternatives, see string_list_split() and
|
|
|
|
* string_list_split_in_place().
|
|
|
|
*/
|
2011-06-09 15:54:58 +00:00
|
|
|
extern struct strbuf **strbuf_split_buf(const char *, size_t,
|
2012-11-04 06:46:53 +00:00
|
|
|
int terminator, int max);
|
2012-11-04 06:46:54 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Split a NUL-terminated string at the specified terminator
|
|
|
|
* character. See strbuf_split_buf() for more information.
|
|
|
|
*/
|
2011-06-09 15:54:58 +00:00
|
|
|
static inline struct strbuf **strbuf_split_str(const char *str,
|
2012-11-04 06:46:53 +00:00
|
|
|
int terminator, int max)
|
2011-06-09 15:54:58 +00:00
|
|
|
{
|
2012-11-04 06:46:53 +00:00
|
|
|
return strbuf_split_buf(str, strlen(str), terminator, max);
|
2011-06-09 15:54:58 +00:00
|
|
|
}
|
2012-11-04 06:46:54 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Split a strbuf at the specified terminator character. See
|
|
|
|
* strbuf_split_buf() for more information.
|
|
|
|
*/
|
2011-06-09 15:54:58 +00:00
|
|
|
static inline struct strbuf **strbuf_split_max(const struct strbuf *sb,
|
2012-11-04 06:46:53 +00:00
|
|
|
int terminator, int max)
|
2011-06-09 15:54:58 +00:00
|
|
|
{
|
2012-11-04 06:46:53 +00:00
|
|
|
return strbuf_split_buf(sb->buf, sb->len, terminator, max);
|
2011-06-09 15:54:58 +00:00
|
|
|
}
|
2012-11-04 06:46:54 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Split a strbuf at the specified terminator character. See
|
|
|
|
* strbuf_split_buf() for more information.
|
|
|
|
*/
|
2012-11-04 06:46:53 +00:00
|
|
|
static inline struct strbuf **strbuf_split(const struct strbuf *sb,
|
|
|
|
int terminator)
|
2011-06-09 15:51:22 +00:00
|
|
|
{
|
2012-11-04 06:46:53 +00:00
|
|
|
return strbuf_split_max(sb, terminator, 0);
|
2011-06-09 15:51:22 +00:00
|
|
|
}
|
2012-11-04 06:46:54 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Free a NULL-terminated list of strbufs (for example, the return
|
|
|
|
* values of the strbuf_split*() functions).
|
|
|
|
*/
|
2008-07-13 18:29:18 +00:00
|
|
|
extern void strbuf_list_free(struct strbuf **);
|
2007-09-10 10:35:04 +00:00
|
|
|
|
2007-09-06 11:20:05 +00:00
|
|
|
/*----- add data in your buffer -----*/
|
2014-03-01 02:50:55 +00:00
|
|
|
static inline void strbuf_addch(struct strbuf *sb, int c)
|
|
|
|
{
|
2007-09-06 11:20:05 +00:00
|
|
|
strbuf_grow(sb, 1);
|
|
|
|
sb->buf[sb->len++] = c;
|
|
|
|
sb->buf[sb->len] = '\0';
|
|
|
|
}
|
|
|
|
|
2007-09-10 10:35:04 +00:00
|
|
|
extern void strbuf_insert(struct strbuf *, size_t pos, const void *, size_t);
|
2007-09-19 22:42:12 +00:00
|
|
|
extern void strbuf_remove(struct strbuf *, size_t pos, size_t len);
|
2007-09-10 10:35:04 +00:00
|
|
|
|
2007-09-15 13:56:50 +00:00
|
|
|
/* splice pos..pos+len with given data */
|
|
|
|
extern void strbuf_splice(struct strbuf *, size_t pos, size_t len,
|
2007-09-19 22:42:12 +00:00
|
|
|
const void *, size_t);
|
2007-09-15 13:56:50 +00:00
|
|
|
|
2013-01-16 19:18:48 +00:00
|
|
|
extern void strbuf_add_commented_lines(struct strbuf *out, const char *buf, size_t size);
|
|
|
|
|
2007-09-06 11:20:05 +00:00
|
|
|
extern void strbuf_add(struct strbuf *, const void *, size_t);
|
2014-03-01 02:50:55 +00:00
|
|
|
static inline void strbuf_addstr(struct strbuf *sb, const char *s)
|
|
|
|
{
|
2007-09-06 11:20:05 +00:00
|
|
|
strbuf_add(sb, s, strlen(s));
|
|
|
|
}
|
2014-03-01 02:50:55 +00:00
|
|
|
static inline void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2)
|
|
|
|
{
|
2010-01-12 20:09:54 +00:00
|
|
|
strbuf_grow(sb, sb2->len);
|
2007-09-06 11:20:05 +00:00
|
|
|
strbuf_add(sb, sb2->buf, sb2->len);
|
|
|
|
}
|
2007-11-10 11:16:05 +00:00
|
|
|
extern void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len);
|
2007-09-06 11:20:05 +00:00
|
|
|
|
2008-02-09 14:40:19 +00:00
|
|
|
typedef size_t (*expand_fn_t) (struct strbuf *sb, const char *placeholder, void *context);
|
|
|
|
extern void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn, void *context);
|
2008-11-22 23:09:30 +00:00
|
|
|
struct strbuf_expand_dict_entry {
|
|
|
|
const char *placeholder;
|
|
|
|
const char *value;
|
|
|
|
};
|
|
|
|
extern size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder, void *context);
|
2010-01-13 17:36:42 +00:00
|
|
|
extern void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src);
|
2007-11-09 00:49:42 +00:00
|
|
|
|
2009-11-14 21:33:13 +00:00
|
|
|
__attribute__((format (printf,2,3)))
|
2007-09-06 11:20:05 +00:00
|
|
|
extern void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
|
2013-01-16 19:18:48 +00:00
|
|
|
__attribute__((format (printf, 2, 3)))
|
|
|
|
extern void strbuf_commented_addf(struct strbuf *sb, const char *fmt, ...);
|
2011-02-26 05:08:53 +00:00
|
|
|
__attribute__((format (printf,2,0)))
|
|
|
|
extern void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap);
|
2007-09-06 11:20:05 +00:00
|
|
|
|
2011-11-05 04:06:30 +00:00
|
|
|
extern void strbuf_add_lines(struct strbuf *sb, const char *prefix, const char *buf, size_t size);
|
|
|
|
|
2012-11-25 11:08:34 +00:00
|
|
|
/*
|
|
|
|
* Append s to sb, with the characters '<', '>', '&' and '"' converted
|
|
|
|
* into XML entities.
|
|
|
|
*/
|
|
|
|
extern void strbuf_addstr_xml_quoted(struct strbuf *sb, const char *s);
|
|
|
|
|
2011-11-05 04:06:30 +00:00
|
|
|
static inline void strbuf_complete_line(struct strbuf *sb)
|
|
|
|
{
|
|
|
|
if (sb->len && sb->buf[sb->len - 1] != '\n')
|
|
|
|
strbuf_addch(sb, '\n');
|
|
|
|
}
|
|
|
|
|
2007-09-06 11:20:05 +00:00
|
|
|
extern size_t strbuf_fread(struct strbuf *, size_t, FILE *);
|
|
|
|
/* XXX: if read fails, any partial read is undone */
|
2007-09-10 10:35:04 +00:00
|
|
|
extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
|
2007-09-27 13:25:55 +00:00
|
|
|
extern int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
|
2008-12-17 17:36:40 +00:00
|
|
|
extern int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint);
|
2007-09-06 11:20:05 +00:00
|
|
|
|
2009-08-05 03:31:56 +00:00
|
|
|
extern int strbuf_getwholeline(struct strbuf *, FILE *, int);
|
2007-09-17 09:19:04 +00:00
|
|
|
extern int strbuf_getline(struct strbuf *, FILE *, int);
|
2012-02-22 19:34:22 +00:00
|
|
|
extern int strbuf_getwholeline_fd(struct strbuf *, int, int);
|
2005-04-26 01:26:45 +00:00
|
|
|
|
2007-09-18 00:06:45 +00:00
|
|
|
extern void stripspace(struct strbuf *buf, int skip_comments);
|
2008-07-25 16:28:42 +00:00
|
|
|
extern int launch_editor(const char *path, struct strbuf *buffer, const char *const *env);
|
2007-09-18 00:06:45 +00:00
|
|
|
|
2009-03-21 20:17:30 +00:00
|
|
|
extern int strbuf_branchname(struct strbuf *sb, const char *name);
|
2009-03-21 21:35:51 +00:00
|
|
|
extern int strbuf_check_branch_ref(struct strbuf *sb, const char *name);
|
2009-03-21 20:17:30 +00:00
|
|
|
|
2011-12-10 10:34:20 +00:00
|
|
|
extern void strbuf_addstr_urlencode(struct strbuf *, const char *,
|
|
|
|
int reserved);
|
2013-04-10 19:03:23 +00:00
|
|
|
extern void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes);
|
2011-12-10 10:34:20 +00:00
|
|
|
|
2012-04-23 12:30:22 +00:00
|
|
|
__attribute__((format (printf,1,2)))
|
|
|
|
extern int printf_ln(const char *fmt, ...);
|
|
|
|
__attribute__((format (printf,2,3)))
|
|
|
|
extern int fprintf_ln(FILE *fp, const char *fmt, ...);
|
|
|
|
|
2014-05-22 09:44:09 +00:00
|
|
|
char *xstrdup_tolower(const char *);
|
|
|
|
|
strbuf: add xstrfmt helper
You can use a strbuf to build up a string from parts, and
then detach it. In the general case, you might use multiple
strbuf_add* functions to do the building. However, in many
cases, a single strbuf_addf is sufficient, and we end up
with:
struct strbuf buf = STRBUF_INIT;
...
strbuf_addf(&buf, fmt, some, args);
str = strbuf_detach(&buf, NULL);
We can make this much more readable (and avoid introducing
an extra variable, which can clutter the code) by
introducing a convenience function:
str = xstrfmt(fmt, some, args);
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2014-06-18 20:01:34 +00:00
|
|
|
/*
|
|
|
|
* Create a newly allocated string using printf format. You can do this easily
|
|
|
|
* with a strbuf, but this provides a shortcut to save a few lines.
|
|
|
|
*/
|
|
|
|
__attribute__((format (printf, 1, 0)))
|
|
|
|
char *xstrvfmt(const char *fmt, va_list ap);
|
|
|
|
__attribute__((format (printf, 1, 2)))
|
|
|
|
char *xstrfmt(const char *fmt, ...);
|
|
|
|
|
2005-04-26 01:26:45 +00:00
|
|
|
#endif /* STRBUF_H */
|