Andrew's git - gitweb.git/blob

   1#ifndef STRBUF_H
   2#define STRBUF_H
   3
   4/* See Documentation/technical/api-strbuf.txt */
   5
   6#include <assert.h>
   7
   8extern char strbuf_slopbuf[];
   9struct strbuf {
  10        size_t alloc;
  11        size_t len;
  12        char *buf;
  13};
  14
  15#define STRBUF_INIT  { 0, 0, strbuf_slopbuf }
  16
  17/*----- strbuf life cycle -----*/
  18extern void strbuf_init(struct strbuf *, size_t);
  19extern void strbuf_release(struct strbuf *);
  20extern char *strbuf_detach(struct strbuf *, size_t *);
  21extern void strbuf_attach(struct strbuf *, void *, size_t, size_t);
  22static inline void strbuf_swap(struct strbuf *a, struct strbuf *b) {
  23        struct strbuf tmp = *a;
  24        *a = *b;
  25        *b = tmp;
  26}
  27
  28/*----- strbuf size related -----*/
  29static inline size_t strbuf_avail(const struct strbuf *sb) {
  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        if (!sb->alloc)
  37                strbuf_grow(sb, 0);
  38        assert(len < sb->alloc);
  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
  50extern struct strbuf **strbuf_split_buf(const char *, size_t,
  51                                        int delim, int max);
  52static inline struct strbuf **strbuf_split_str(const char *str,
  53                                               int delim, int max)
  54{
  55        return strbuf_split_buf(str, strlen(str), delim, max);
  56}
  57static inline struct strbuf **strbuf_split_max(const struct strbuf *sb,
  58                                                int delim, int max)
  59{
  60        return strbuf_split_buf(sb->buf, sb->len, delim, max);
  61}
  62static inline struct strbuf **strbuf_split(const struct strbuf *sb, int delim)
  63{
  64        return strbuf_split_max(sb, delim, 0);
  65}
  66extern void strbuf_list_free(struct strbuf **);
  67
  68/*----- add data in your buffer -----*/
  69static inline void strbuf_addch(struct strbuf *sb, int c) {
  70        strbuf_grow(sb, 1);
  71        sb->buf[sb->len++] = c;
  72        sb->buf[sb->len] = '\0';
  73}
  74
  75extern void strbuf_insert(struct strbuf *, size_t pos, const void *, size_t);
  76extern void strbuf_remove(struct strbuf *, size_t pos, size_t len);
  77
  78/* splice pos..pos+len with given data */
  79extern void strbuf_splice(struct strbuf *, size_t pos, size_t len,
  80                          const void *, size_t);
  81
  82extern void strbuf_add(struct strbuf *, const void *, size_t);
  83static inline void strbuf_addstr(struct strbuf *sb, const char *s) {
  84        strbuf_add(sb, s, strlen(s));
  85}
  86static inline void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2) {
  87        strbuf_grow(sb, sb2->len);
  88        strbuf_add(sb, sb2->buf, sb2->len);
  89}
  90extern void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len);
  91
  92typedef size_t (*expand_fn_t) (struct strbuf *sb, const char *placeholder, void *context);
  93extern void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn, void *context);
  94struct strbuf_expand_dict_entry {
  95        const char *placeholder;
  96        const char *value;
  97};
  98extern size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder, void *context);
  99extern void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src);
 100
 101__attribute__((format (printf,2,3)))
 102extern void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
 103__attribute__((format (printf,2,0)))
 104extern void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap);
 105
 106extern size_t strbuf_fread(struct strbuf *, size_t, FILE *);
 107/* XXX: if read fails, any partial read is undone */
 108extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
 109extern int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
 110extern int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint);
 111
 112extern int strbuf_getwholeline(struct strbuf *, FILE *, int);
 113extern int strbuf_getline(struct strbuf *, FILE *, int);
 114
 115extern void stripspace(struct strbuf *buf, int skip_comments);
 116extern int launch_editor(const char *path, struct strbuf *buffer, const char *const *env);
 117
 118extern int strbuf_branchname(struct strbuf *sb, const char *name);
 119extern int strbuf_check_branch_ref(struct strbuf *sb, const char *name);
 120
 121#endif /* STRBUF_H */