Andrew's git - gitweb.git/blob

   1#ifndef STRBUF_H
   2#define STRBUF_H
   3
   4/* See Documentation/technical/api-strbuf.txt */
   5
   6extern char strbuf_slopbuf[];
   7struct 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 -----*/
  16extern void strbuf_init(struct strbuf *, size_t);
  17extern void strbuf_release(struct strbuf *);
  18extern char *strbuf_detach(struct strbuf *, size_t *);
  19extern void strbuf_attach(struct strbuf *, void *, size_t, size_t);
  20static 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 -----*/
  28static inline size_t strbuf_avail(const struct strbuf *sb)
  29{
  30        return sb->alloc ? sb->alloc - sb->len - 1 : 0;
  31}
  32
  33extern void strbuf_grow(struct strbuf *, size_t);
  34
  35static 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 -----*/
  45extern void strbuf_trim(struct strbuf *);
  46extern void strbuf_rtrim(struct strbuf *);
  47extern void strbuf_ltrim(struct strbuf *);
  48extern int strbuf_reencode(struct strbuf *sb, const char *from, const char *to);
  49extern void strbuf_tolower(struct strbuf *sb);
  50extern int strbuf_cmp(const struct strbuf *, const struct strbuf *);
  51
  52static inline int strbuf_strip_suffix(struct strbuf *sb, const char *suffix)
  53{
  54        if (strip_suffix_mem(sb->buf, &sb->len, suffix)) {
  55                strbuf_setlen(sb, sb->len);
  56                return 1;
  57        } else
  58                return 0;
  59}
  60
  61/*
  62 * Split str (of length slen) at the specified terminator character.
  63 * Return a null-terminated array of pointers to strbuf objects
  64 * holding the substrings.  The substrings include the terminator,
  65 * except for the last substring, which might be unterminated if the
  66 * original string did not end with a terminator.  If max is positive,
  67 * then split the string into at most max substrings (with the last
  68 * substring containing everything following the (max-1)th terminator
  69 * character).
  70 *
  71 * For lighter-weight alternatives, see string_list_split() and
  72 * string_list_split_in_place().
  73 */
  74extern struct strbuf **strbuf_split_buf(const char *, size_t,
  75                                        int terminator, int max);
  76
  77/*
  78 * Split a NUL-terminated string at the specified terminator
  79 * character.  See strbuf_split_buf() for more information.
  80 */
  81static inline struct strbuf **strbuf_split_str(const char *str,
  82                                               int terminator, int max)
  83{
  84        return strbuf_split_buf(str, strlen(str), terminator, max);
  85}
  86
  87/*
  88 * Split a strbuf at the specified terminator character.  See
  89 * strbuf_split_buf() for more information.
  90 */
  91static inline struct strbuf **strbuf_split_max(const struct strbuf *sb,
  92                                                int terminator, int max)
  93{
  94        return strbuf_split_buf(sb->buf, sb->len, terminator, max);
  95}
  96
  97/*
  98 * Split a strbuf at the specified terminator character.  See
  99 * strbuf_split_buf() for more information.
 100 */
 101static inline struct strbuf **strbuf_split(const struct strbuf *sb,
 102                                           int terminator)
 103{
 104        return strbuf_split_max(sb, terminator, 0);
 105}
 106
 107/*
 108 * Free a NULL-terminated list of strbufs (for example, the return
 109 * values of the strbuf_split*() functions).
 110 */
 111extern void strbuf_list_free(struct strbuf **);
 112
 113/*----- add data in your buffer -----*/
 114static inline void strbuf_addch(struct strbuf *sb, int c)
 115{
 116        strbuf_grow(sb, 1);
 117        sb->buf[sb->len++] = c;
 118        sb->buf[sb->len] = '\0';
 119}
 120
 121extern void strbuf_insert(struct strbuf *, size_t pos, const void *, size_t);
 122extern void strbuf_remove(struct strbuf *, size_t pos, size_t len);
 123
 124/* splice pos..pos+len with given data */
 125extern void strbuf_splice(struct strbuf *, size_t pos, size_t len,
 126                          const void *, size_t);
 127
 128extern void strbuf_add_commented_lines(struct strbuf *out, const char *buf, size_t size);
 129
 130extern void strbuf_add(struct strbuf *, const void *, size_t);
 131static inline void strbuf_addstr(struct strbuf *sb, const char *s)
 132{
 133        strbuf_add(sb, s, strlen(s));
 134}
 135static inline void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2)
 136{
 137        strbuf_grow(sb, sb2->len);
 138        strbuf_add(sb, sb2->buf, sb2->len);
 139}
 140extern void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len);
 141
 142typedef size_t (*expand_fn_t) (struct strbuf *sb, const char *placeholder, void *context);
 143extern void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn, void *context);
 144struct strbuf_expand_dict_entry {
 145        const char *placeholder;
 146        const char *value;
 147};
 148extern size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder, void *context);
 149extern void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src);
 150
 151__attribute__((format (printf,2,3)))
 152extern void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
 153__attribute__((format (printf, 2, 3)))
 154extern void strbuf_commented_addf(struct strbuf *sb, const char *fmt, ...);
 155__attribute__((format (printf,2,0)))
 156extern void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap);
 157
 158extern void strbuf_add_lines(struct strbuf *sb, const char *prefix, const char *buf, size_t size);
 159
 160/*
 161 * Append s to sb, with the characters '<', '>', '&' and '"' converted
 162 * into XML entities.
 163 */
 164extern void strbuf_addstr_xml_quoted(struct strbuf *sb, const char *s);
 165
 166static inline void strbuf_complete_line(struct strbuf *sb)
 167{
 168        if (sb->len && sb->buf[sb->len - 1] != '\n')
 169                strbuf_addch(sb, '\n');
 170}
 171
 172extern size_t strbuf_fread(struct strbuf *, size_t, FILE *);
 173/* XXX: if read fails, any partial read is undone */
 174extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
 175extern int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
 176extern int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint);
 177
 178extern int strbuf_getwholeline(struct strbuf *, FILE *, int);
 179extern int strbuf_getline(struct strbuf *, FILE *, int);
 180extern int strbuf_getwholeline_fd(struct strbuf *, int, int);
 181
 182extern void stripspace(struct strbuf *buf, int skip_comments);
 183extern int launch_editor(const char *path, struct strbuf *buffer, const char *const *env);
 184
 185extern int strbuf_branchname(struct strbuf *sb, const char *name);
 186extern int strbuf_check_branch_ref(struct strbuf *sb, const char *name);
 187
 188extern void strbuf_addstr_urlencode(struct strbuf *, const char *,
 189                                    int reserved);
 190extern void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes);
 191
 192__attribute__((format (printf,1,2)))
 193extern int printf_ln(const char *fmt, ...);
 194__attribute__((format (printf,2,3)))
 195extern int fprintf_ln(FILE *fp, const char *fmt, ...);
 196
 197char *xstrdup_tolower(const char *);
 198
 199/*
 200 * Create a newly allocated string using printf format. You can do this easily
 201 * with a strbuf, but this provides a shortcut to save a few lines.
 202 */
 203__attribute__((format (printf, 1, 0)))
 204char *xstrvfmt(const char *fmt, va_list ap);
 205__attribute__((format (printf, 1, 2)))
 206char *xstrfmt(const char *fmt, ...);
 207
 208#endif /* STRBUF_H */