Andrew's git - gitweb.git/blob

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