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