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 terminator, int max);
  49 static inline struct strbuf **strbuf_split_str(const char *str,
  50                                                int terminator, int max)
  51 {
  52         return strbuf_split_buf(str, strlen(str), terminator, max);
  53 }
  54 static inline struct strbuf **strbuf_split_max(const struct strbuf *sb,
  55                                                 int terminator, int max)
  56 {
  57         return strbuf_split_buf(sb->buf, sb->len, terminator, max);
  58 }
  59 static inline struct strbuf **strbuf_split(const struct strbuf *sb,
  60                                            int terminator)
  61 {
  62         return strbuf_split_max(sb, terminator, 0);
  63 }
  64 extern void strbuf_list_free(struct strbuf **);
  65
  66 /*----- add data in your buffer -----*/
  67 static inline void strbuf_addch(struct strbuf *sb, int c) {
  68         strbuf_grow(sb, 1);
  69         sb->buf[sb->len++] = c;
  70         sb->buf[sb->len] = '\0';
  71 }
  72
  73 extern void strbuf_insert(struct strbuf *, size_t pos, const void *, size_t);
  74 extern void strbuf_remove(struct strbuf *, size_t pos, size_t len);
  75
  76 /* splice pos..pos+len with given data */
  77 extern void strbuf_splice(struct strbuf *, size_t pos, size_t len,
  78                           const void *, size_t);
  79
  80 extern void strbuf_add(struct strbuf *, const void *, size_t);
  81 static inline void strbuf_addstr(struct strbuf *sb, const char *s) {
  82         strbuf_add(sb, s, strlen(s));
  83 }
  84 static inline void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2) {
  85         strbuf_grow(sb, sb2->len);
  86         strbuf_add(sb, sb2->buf, sb2->len);
  87 }
  88 extern void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len);
  89
  90 typedef size_t (*expand_fn_t) (struct strbuf *sb, const char *placeholder, void *context);
  91 extern void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn, void *context);
  92 struct strbuf_expand_dict_entry {
  93         const char *placeholder;
  94         const char *value;
  95 };
  96 extern size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder, void *context);
  97 extern void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src);
  98
  99 __attribute__((format (printf,2,3)))
 100 extern void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
 101 __attribute__((format (printf,2,0)))
 102 extern void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap);
 103
 104 extern void strbuf_add_lines(struct strbuf *sb, const char *prefix, const char *buf, size_t size);
 105
 106 static inline void strbuf_complete_line(struct strbuf *sb)
 107 {
 108         if (sb->len && sb->buf[sb->len - 1] != '\n')
 109                 strbuf_addch(sb, '\n');
 110 }
 111
 112 extern size_t strbuf_fread(struct strbuf *, size_t, FILE *);
 113 /* XXX: if read fails, any partial read is undone */
 114 extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
 115 extern int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
 116 extern int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint);
 117
 118 extern int strbuf_getwholeline(struct strbuf *, FILE *, int);
 119 extern int strbuf_getline(struct strbuf *, FILE *, int);
 120 extern int strbuf_getwholeline_fd(struct strbuf *, int, int);
 121
 122 extern void stripspace(struct strbuf *buf, int skip_comments);
 123 extern int launch_editor(const char *path, struct strbuf *buffer, const char *const *env);
 124
 125 extern int strbuf_branchname(struct strbuf *sb, const char *name);
 126 extern int strbuf_check_branch_ref(struct strbuf *sb, const char *name);
 127
 128 extern void strbuf_addstr_urlencode(struct strbuf *, const char *,
 129                                     int reserved);
 130
 131 __attribute__((format (printf,1,2)))
 132 extern int printf_ln(const char *fmt, ...);
 133 __attribute__((format (printf,2,3)))
 134 extern int fprintf_ln(FILE *fp, const char *fmt, ...);
 135
 136 #endif /* STRBUF_H */