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