strbuf.h

   1 #ifndef STRBUF_H
   2 #define STRBUF_H
   3
   4 /* See Documentation/technical/api-strbuf.txt */
   5
   6 #include <assert.h>
   7
   8 extern char strbuf_slopbuf[];
   9 struct 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 -----*/
  18 extern void strbuf_init(struct strbuf *, size_t);
  19 extern void strbuf_release(struct strbuf *);
  20 extern char *strbuf_detach(struct strbuf *, size_t *);
  21 extern void strbuf_attach(struct strbuf *, void *, size_t, size_t);
  22 static 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 -----*/
  29 static inline size_t strbuf_avail(const struct strbuf *sb) {
  30         return sb->alloc ? sb->alloc - sb->len - 1 : 0;
  31 }
  32
  33 extern void strbuf_grow(struct strbuf *, size_t);
  34
  35 static 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 -----*/
  45 extern void strbuf_trim(struct strbuf *);
  46 extern void strbuf_rtrim(struct strbuf *);
  47 extern void strbuf_ltrim(struct strbuf *);
  48 extern int strbuf_cmp(const struct strbuf *, const struct strbuf *);
  49
  50 extern struct strbuf **strbuf_split(const struct strbuf *, int delim);
  51 extern void strbuf_list_free(struct strbuf **);
  52
  53 /*----- add data in your buffer -----*/
  54 static inline void strbuf_addch(struct strbuf *sb, int c) {
  55         strbuf_grow(sb, 1);
  56         sb->buf[sb->len++] = c;
  57         sb->buf[sb->len] = '\0';
  58 }
  59
  60 extern void strbuf_insert(struct strbuf *, size_t pos, const void *, size_t);
  61 extern void strbuf_remove(struct strbuf *, size_t pos, size_t len);
  62
  63 /* splice pos..pos+len with given data */
  64 extern void strbuf_splice(struct strbuf *, size_t pos, size_t len,
  65                           const void *, size_t);
  66
  67 extern void strbuf_add(struct strbuf *, const void *, size_t);
  68 static inline void strbuf_addstr(struct strbuf *sb, const char *s) {
  69         strbuf_add(sb, s, strlen(s));
  70 }
  71 static inline void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2) {
  72         strbuf_grow(sb, sb2->len);
  73         strbuf_add(sb, sb2->buf, sb2->len);
  74 }
  75 extern void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len);
  76
  77 typedef size_t (*expand_fn_t) (struct strbuf *sb, const char *placeholder, void *context);
  78 extern void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn, void *context);
  79 struct strbuf_expand_dict_entry {
  80         const char *placeholder;
  81         const char *value;
  82 };
  83 extern size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder, void *context);
  84 extern void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src);
  85
  86 __attribute__((format (printf,2,3)))
  87 extern void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
  88 __attribute__((format (printf,2,0)))
  89 extern void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap);
  90
  91 extern size_t strbuf_fread(struct strbuf *, size_t, FILE *);
  92 /* XXX: if read fails, any partial read is undone */
  93 extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
  94 extern int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
  95 extern int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint);
  96
  97 extern int strbuf_getwholeline(struct strbuf *, FILE *, int);
  98 extern int strbuf_getline(struct strbuf *, FILE *, int);
  99
 100 extern void stripspace(struct strbuf *buf, int skip_comments);
 101 extern int launch_editor(const char *path, struct strbuf *buffer, const char *const *env);
 102
 103 extern int strbuf_branchname(struct strbuf *sb, const char *name);
 104 extern int strbuf_check_branch_ref(struct strbuf *sb, const char *name);
 105
 106 #endif /* STRBUF_H */