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 {
  22         struct strbuf tmp = *a;
  23         *a = *b;
  24         *b = tmp;
  25 }
  26
  27 /*----- strbuf size related -----*/
  28 static inline size_t strbuf_avail(const struct strbuf *sb)
  29 {
  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 {
  37         if (len > (sb->alloc ? sb->alloc - 1 : 0))
  38                 die("BUG: strbuf_setlen() beyond buffer");
  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 static inline int strbuf_strip_suffix(struct strbuf *sb, const char *suffix)
  51 {
  52         if (strip_suffix_mem(sb->buf, &sb->len, suffix)) {
  53                 strbuf_setlen(sb, sb->len);
  54                 return 1;
  55         } else
  56                 return 0;
  57 }
  58
  59 /*
  60  * Split str (of length slen) at the specified terminator character.
  61  * Return a null-terminated array of pointers to strbuf objects
  62  * holding the substrings.  The substrings include the terminator,
  63  * except for the last substring, which might be unterminated if the
  64  * original string did not end with a terminator.  If max is positive,
  65  * then split the string into at most max substrings (with the last
  66  * substring containing everything following the (max-1)th terminator
  67  * character).
  68  *
  69  * For lighter-weight alternatives, see string_list_split() and
  70  * string_list_split_in_place().
  71  */
  72 extern struct strbuf **strbuf_split_buf(const char *, size_t,
  73                                         int terminator, int max);
  74
  75 /*
  76  * Split a NUL-terminated string at the specified terminator
  77  * character.  See strbuf_split_buf() for more information.
  78  */
  79 static inline struct strbuf **strbuf_split_str(const char *str,
  80                                                int terminator, int max)
  81 {
  82         return strbuf_split_buf(str, strlen(str), terminator, max);
  83 }
  84
  85 /*
  86  * Split a strbuf at the specified terminator character.  See
  87  * strbuf_split_buf() for more information.
  88  */
  89 static inline struct strbuf **strbuf_split_max(const struct strbuf *sb,
  90                                                 int terminator, int max)
  91 {
  92         return strbuf_split_buf(sb->buf, sb->len, terminator, max);
  93 }
  94
  95 /*
  96  * Split a strbuf at the specified terminator character.  See
  97  * strbuf_split_buf() for more information.
  98  */
  99 static inline struct strbuf **strbuf_split(const struct strbuf *sb,
 100                                            int terminator)
 101 {
 102         return strbuf_split_max(sb, terminator, 0);
 103 }
 104
 105 /*
 106  * Free a NULL-terminated list of strbufs (for example, the return
 107  * values of the strbuf_split*() functions).
 108  */
 109 extern void strbuf_list_free(struct strbuf **);
 110
 111 /*----- add data in your buffer -----*/
 112 static inline void strbuf_addch(struct strbuf *sb, int c)
 113 {
 114         strbuf_grow(sb, 1);
 115         sb->buf[sb->len++] = c;
 116         sb->buf[sb->len] = '\0';
 117 }
 118
 119 extern void strbuf_insert(struct strbuf *, size_t pos, const void *, size_t);
 120 extern void strbuf_remove(struct strbuf *, size_t pos, size_t len);
 121
 122 /* splice pos..pos+len with given data */
 123 extern void strbuf_splice(struct strbuf *, size_t pos, size_t len,
 124                           const void *, size_t);
 125
 126 extern void strbuf_add_commented_lines(struct strbuf *out, const char *buf, size_t size);
 127
 128 extern void strbuf_add(struct strbuf *, const void *, size_t);
 129 static inline void strbuf_addstr(struct strbuf *sb, const char *s)
 130 {
 131         strbuf_add(sb, s, strlen(s));
 132 }
 133 static inline void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2)
 134 {
 135         strbuf_grow(sb, sb2->len);
 136         strbuf_add(sb, sb2->buf, sb2->len);
 137 }
 138 extern void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len);
 139
 140 typedef size_t (*expand_fn_t) (struct strbuf *sb, const char *placeholder, void *context);
 141 extern void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn, void *context);
 142 struct strbuf_expand_dict_entry {
 143         const char *placeholder;
 144         const char *value;
 145 };
 146 extern size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder, void *context);
 147 extern void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src);
 148
 149 __attribute__((format (printf,2,3)))
 150 extern void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
 151 __attribute__((format (printf, 2, 3)))
 152 extern void strbuf_commented_addf(struct strbuf *sb, const char *fmt, ...);
 153 __attribute__((format (printf,2,0)))
 154 extern void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap);
 155
 156 extern void strbuf_add_lines(struct strbuf *sb, const char *prefix, const char *buf, size_t size);
 157
 158 /*
 159  * Append s to sb, with the characters '<', '>', '&' and '"' converted
 160  * into XML entities.
 161  */
 162 extern void strbuf_addstr_xml_quoted(struct strbuf *sb, const char *s);
 163
 164 static inline void strbuf_complete_line(struct strbuf *sb)
 165 {
 166         if (sb->len && sb->buf[sb->len - 1] != '\n')
 167                 strbuf_addch(sb, '\n');
 168 }
 169
 170 extern size_t strbuf_fread(struct strbuf *, size_t, FILE *);
 171 /* XXX: if read fails, any partial read is undone */
 172 extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
 173 extern int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
 174 extern int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint);
 175
 176 extern int strbuf_getwholeline(struct strbuf *, FILE *, int);
 177 extern int strbuf_getline(struct strbuf *, FILE *, int);
 178 extern int strbuf_getwholeline_fd(struct strbuf *, int, int);
 179
 180 extern void stripspace(struct strbuf *buf, int skip_comments);
 181 extern int launch_editor(const char *path, struct strbuf *buffer, const char *const *env);
 182
 183 extern int strbuf_branchname(struct strbuf *sb, const char *name);
 184 extern int strbuf_check_branch_ref(struct strbuf *sb, const char *name);
 185
 186 extern void strbuf_addstr_urlencode(struct strbuf *, const char *,
 187                                     int reserved);
 188 extern void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes);
 189
 190 __attribute__((format (printf,1,2)))
 191 extern int printf_ln(const char *fmt, ...);
 192 __attribute__((format (printf,2,3)))
 193 extern int fprintf_ln(FILE *fp, const char *fmt, ...);
 194
 195 #endif /* STRBUF_H */