strbuf.h

   1 #ifndef STRBUF_H
   2 #define STRBUF_H
   3
   4 /* See Documentation/technical/api-strbuf.txt */
   5
   6 extern char strbuf_slopbuf[];
   7 struct 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 -----*/
  16 extern void strbuf_init(struct strbuf *, size_t);
  17 extern void strbuf_release(struct strbuf *);
  18 extern char *strbuf_detach(struct strbuf *, size_t *);
  19 extern void strbuf_attach(struct strbuf *, void *, size_t, size_t);
  20 static 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 -----*/
  27 static inline size_t strbuf_avail(const struct strbuf *sb) {
  28         return sb->alloc ? sb->alloc - sb->len - 1 : 0;
  29 }
  30
  31 extern void strbuf_grow(struct strbuf *, size_t);
  32
  33 static 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 -----*/
  42 extern void strbuf_trim(struct strbuf *);
  43 extern void strbuf_rtrim(struct strbuf *);
  44 extern void strbuf_ltrim(struct strbuf *);
  45 extern int strbuf_cmp(const struct strbuf *, const struct strbuf *);
  46
  47 extern struct strbuf **strbuf_split_buf(const char *, size_t,
  48                                         int delim, int max);
  49 static 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 }
  54 static 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 }
  59 static inline struct strbuf **strbuf_split(const struct strbuf *sb, int delim)
  60 {
  61         return strbuf_split_max(sb, delim, 0);
  62 }
  63 extern void strbuf_list_free(struct strbuf **);
  64
  65 /*----- add data in your buffer -----*/
  66 static 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
  72 extern void strbuf_insert(struct strbuf *, size_t pos, const void *, size_t);
  73 extern void strbuf_remove(struct strbuf *, size_t pos, size_t len);
  74
  75 /* splice pos..pos+len with given data */
  76 extern void strbuf_splice(struct strbuf *, size_t pos, size_t len,
  77                           const void *, size_t);
  78
  79 extern void strbuf_add(struct strbuf *, const void *, size_t);
  80 static inline void strbuf_addstr(struct strbuf *sb, const char *s) {
  81         strbuf_add(sb, s, strlen(s));
  82 }
  83 static 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 }
  87 extern void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len);
  88
  89 typedef size_t (*expand_fn_t) (struct strbuf *sb, const char *placeholder, void *context);
  90 extern void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn, void *context);
  91 struct strbuf_expand_dict_entry {
  92         const char *placeholder;
  93         const char *value;
  94 };
  95 extern size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder, void *context);
  96 extern void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src);
  97
  98 __attribute__((format (printf,2,3)))
  99 extern void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
 100 __attribute__((format (printf,2,0)))
 101 extern void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap);
 102
 103 extern void strbuf_add_lines(struct strbuf *sb, const char *prefix, const char *buf, size_t size);
 104
 105 static 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
 111 extern size_t strbuf_fread(struct strbuf *, size_t, FILE *);
 112 /* XXX: if read fails, any partial read is undone */
 113 extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
 114 extern int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
 115 extern int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint);
 116
 117 extern int strbuf_getwholeline(struct strbuf *, FILE *, int);
 118 extern int strbuf_getline(struct strbuf *, FILE *, int);
 119
 120 extern void stripspace(struct strbuf *buf, int skip_comments);
 121 extern int launch_editor(const char *path, struct strbuf *buffer, const char *const *env);
 122
 123 extern int strbuf_branchname(struct strbuf *sb, const char *name);
 124 extern int strbuf_check_branch_ref(struct strbuf *sb, const char *name);
 125
 126 #endif /* STRBUF_H */