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        struct strbuf tmp = *a;
  22        *a = *b;
  23        *b = tmp;
  24}
  25
  26/*----- strbuf size related -----*/
  27static inline size_t strbuf_avail(const struct strbuf *sb) {
  28        return sb->alloc ? sb->alloc - sb->len - 1 : 0;
  29}
  30
  31extern void strbuf_grow(struct strbuf *, size_t);
  32
  33static inline void strbuf_setlen(struct strbuf *sb, size_t len) {
  34        if (len > (sb->alloc ? sb->alloc - 1 : 0))
  35                die("BUG: strbuf_setlen() beyond buffer");
  36        sb->len = len;
  37        sb->buf[len] = '\0';
  38}
  39#define strbuf_reset(sb)  strbuf_setlen(sb, 0)
  40
  41/*----- content related -----*/
  42extern void strbuf_trim(struct strbuf *);
  43extern void strbuf_rtrim(struct strbuf *);
  44extern void strbuf_ltrim(struct strbuf *);
  45extern int strbuf_cmp(const struct strbuf *, const struct strbuf *);
  46
  47extern struct strbuf **strbuf_split_buf(const char *, size_t,
  48                                        int delim, int max);
  49static inline struct strbuf **strbuf_split_str(const char *str,
  50                                               int delim, int max)
  51{
  52        return strbuf_split_buf(str, strlen(str), delim, max);
  53}
  54static inline struct strbuf **strbuf_split_max(const struct strbuf *sb,
  55                                                int delim, int max)
  56{
  57        return strbuf_split_buf(sb->buf, sb->len, delim, max);
  58}
  59static inline struct strbuf **strbuf_split(const struct strbuf *sb, int delim)
  60{
  61        return strbuf_split_max(sb, delim, 0);
  62}
  63extern void strbuf_list_free(struct strbuf **);
  64
  65/*----- add data in your buffer -----*/
  66static inline void strbuf_addch(struct strbuf *sb, int c) {
  67        strbuf_grow(sb, 1);
  68        sb->buf[sb->len++] = c;
  69        sb->buf[sb->len] = '\0';
  70}
  71
  72extern void strbuf_insert(struct strbuf *, size_t pos, const void *, size_t);
  73extern void strbuf_remove(struct strbuf *, size_t pos, size_t len);
  74
  75/* splice pos..pos+len with given data */
  76extern void strbuf_splice(struct strbuf *, size_t pos, size_t len,
  77                          const void *, size_t);
  78
  79extern void strbuf_add(struct strbuf *, const void *, size_t);
  80static inline void strbuf_addstr(struct strbuf *sb, const char *s) {
  81        strbuf_add(sb, s, strlen(s));
  82}
  83static inline void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2) {
  84        strbuf_grow(sb, sb2->len);
  85        strbuf_add(sb, sb2->buf, sb2->len);
  86}
  87extern void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len);
  88
  89typedef size_t (*expand_fn_t) (struct strbuf *sb, const char *placeholder, void *context);
  90extern void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn, void *context);
  91struct strbuf_expand_dict_entry {
  92        const char *placeholder;
  93        const char *value;
  94};
  95extern size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder, void *context);
  96extern void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src);
  97
  98__attribute__((format (printf,2,3)))
  99extern void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
 100__attribute__((format (printf,2,0)))
 101extern void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap);
 102
 103extern void strbuf_add_lines(struct strbuf *sb, const char *prefix, const char *buf, size_t size);
 104
 105static inline void strbuf_complete_line(struct strbuf *sb)
 106{
 107        if (sb->len && sb->buf[sb->len - 1] != '\n')
 108                strbuf_addch(sb, '\n');
 109}
 110
 111extern size_t strbuf_fread(struct strbuf *, size_t, FILE *);
 112/* XXX: if read fails, any partial read is undone */
 113extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
 114extern int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
 115extern int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint);
 116
 117extern int strbuf_getwholeline(struct strbuf *, FILE *, int);
 118extern int strbuf_getline(struct strbuf *, FILE *, int);
 119extern int strbuf_getwholeline_fd(struct strbuf *, int, int);
 120
 121extern void stripspace(struct strbuf *buf, int skip_comments);
 122extern int launch_editor(const char *path, struct strbuf *buffer, const char *const *env);
 123
 124extern int strbuf_branchname(struct strbuf *sb, const char *name);
 125extern int strbuf_check_branch_ref(struct strbuf *sb, const char *name);
 126
 127extern void strbuf_add_urlencode(struct strbuf *, const char *, size_t,
 128                                 int reserved);
 129extern void strbuf_addstr_urlencode(struct strbuf *, const char *,
 130                                    int reserved);
 131
 132#endif /* STRBUF_H */