🌐 AI搜索 & 代理 主页
Google Git
Sign in
chromium / external / github.com / git / git / refs/tags/v2.1.2 / . / strbuf.h
blob: a7c0192e9ee392bd232b325692a9111b3e160e84 [file] [log] [blame]
Junio C Hamanod1df5742005-04-26 01:26:45[diff] [blame]1#ifndef STRBUF_H
2#define STRBUF_H
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]3
Michael Wittene0390112011-02-15 23:12:04[diff] [blame]4/* See Documentation/technical/api-strbuf.txt */
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]5
Pierre Habouzitb315c5c2007-09-27 10:58:23[diff] [blame]6extern char strbuf_slopbuf[];
Junio C Hamanod1df5742005-04-26 01:26:45[diff] [blame]7struct strbuf {
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]8 size_t alloc;
9 size_t len;
Brian Gerstbf0f9102005-05-18 12:14:09[diff] [blame]10 char *buf;
Junio C Hamanod1df5742005-04-26 01:26:45[diff] [blame]11};
12
Pierre Habouzitb315c5c2007-09-27 10:58:23[diff] [blame]13#define STRBUF_INIT { 0, 0, strbuf_slopbuf }
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]14
15/*----- strbuf life cycle -----*/
Pierre Habouzitf1696ee2007-09-10 10:35:04[diff] [blame]16extern void strbuf_init(struct strbuf *, size_t);
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]17extern void strbuf_release(struct strbuf *);
Pierre Habouzitb315c5c2007-09-27 10:58:23[diff] [blame]18extern char *strbuf_detach(struct strbuf *, size_t *);
Pierre Habouzit917c9a72007-09-15 13:56:50[diff] [blame]19extern void strbuf_attach(struct strbuf *, void *, size_t, size_t);
Nguyễn Thái Ngọc Duy187e2902014-03-01 02:50:55[diff] [blame]20static inline void strbuf_swap(struct strbuf *a, struct strbuf *b)
21{
Pierre Habouzitc76689d2007-09-19 22:42:12[diff] [blame]22 struct strbuf tmp = *a;
23 *a = *b;
24 *b = tmp;
25}
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]26
27/*----- strbuf size related -----*/
Nguyễn Thái Ngọc Duy187e2902014-03-01 02:50:55[diff] [blame]28static inline size_t strbuf_avail(const struct strbuf *sb)
29{
Pierre Habouzitc76689d2007-09-19 22:42:12[diff] [blame]30 return sb->alloc ? sb->alloc - sb->len - 1 : 0;
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]31}
Junio C Hamanoa8f3e222007-09-26 09:26:06[diff] [blame]32
33extern void strbuf_grow(struct strbuf *, size_t);
34
Nguyễn Thái Ngọc Duy187e2902014-03-01 02:50:55[diff] [blame]35static inline void strbuf_setlen(struct strbuf *sb, size_t len)
36{
René Scharfe7141efa2011-04-27 17:24:50[diff] [blame]37 if (len > (sb->alloc ? sb->alloc - 1 : 0))
38 die("BUG: strbuf_setlen() beyond buffer");
Pierre Habouzitc76689d2007-09-19 22:42:12[diff] [blame]39 sb->len = len;
40 sb->buf[len] = '\0';
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]41}
Pierre Habouzitb315c5c2007-09-27 10:58:23[diff] [blame]42#define strbuf_reset(sb) strbuf_setlen(sb, 0)
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]43
Pierre Habouzitf1696ee2007-09-10 10:35:04[diff] [blame]44/*----- content related -----*/
Lukas Sandströmeacd6dc2008-07-13 18:29:18[diff] [blame]45extern void strbuf_trim(struct strbuf *);
Pierre Habouzitf1696ee2007-09-10 10:35:04[diff] [blame]46extern void strbuf_rtrim(struct strbuf *);
Lukas Sandströmeacd6dc2008-07-13 18:29:18[diff] [blame]47extern void strbuf_ltrim(struct strbuf *);
Jeff Kingd4241f52014-05-22 09:30:14[diff] [blame]48extern int strbuf_reencode(struct strbuf *sb, const char *from, const char *to);
Jeff Kingffb20ce2014-05-23 20:03:47[diff] [blame]49extern void strbuf_tolower(struct strbuf *sb);
Lukas Sandström9b200fd2008-07-13 18:28:24[diff] [blame]50extern int strbuf_cmp(const struct strbuf *, const struct strbuf *);
Lukas Sandströmeacd6dc2008-07-13 18:29:18[diff] [blame]51
Jeff King6dda4e62014-06-30 17:01:51[diff] [blame]52static inline int strbuf_strip_suffix(struct strbuf *sb, const char *suffix)
53{
54 if (strip_suffix_mem(sb->buf, &sb->len, suffix)) {
55 strbuf_setlen(sb, sb->len);
56 return 1;
57 } else
58 return 0;
59}
60
Michael Haggerty06379a62012-11-04 06:46:54[diff] [blame]61/*
62 * Split str (of length slen) at the specified terminator character.
63 * Return a null-terminated array of pointers to strbuf objects
64 * holding the substrings. The substrings include the terminator,
65 * except for the last substring, which might be unterminated if the
66 * original string did not end with a terminator. If max is positive,
67 * then split the string into at most max substrings (with the last
68 * substring containing everything following the (max-1)th terminator
69 * character).
70 *
71 * For lighter-weight alternatives, see string_list_split() and
72 * string_list_split_in_place().
73 */
Jeff King2f1d9e22011-06-09 15:54:58[diff] [blame]74extern struct strbuf **strbuf_split_buf(const char *, size_t,
Michael Haggerty17b73dc2012-11-04 06:46:53[diff] [blame]75 int terminator, int max);
Michael Haggerty06379a62012-11-04 06:46:54[diff] [blame]76
77/*
78 * Split a NUL-terminated string at the specified terminator
79 * character. See strbuf_split_buf() for more information.
80 */
Jeff King2f1d9e22011-06-09 15:54:58[diff] [blame]81static inline struct strbuf **strbuf_split_str(const char *str,
Michael Haggerty17b73dc2012-11-04 06:46:53[diff] [blame]82 int terminator, int max)
Jeff King2f1d9e22011-06-09 15:54:58[diff] [blame]83{
Michael Haggerty17b73dc2012-11-04 06:46:53[diff] [blame]84 return strbuf_split_buf(str, strlen(str), terminator, max);
Jeff King2f1d9e22011-06-09 15:54:58[diff] [blame]85}
Michael Haggerty06379a62012-11-04 06:46:54[diff] [blame]86
87/*
88 * Split a strbuf at the specified terminator character. See
89 * strbuf_split_buf() for more information.
90 */
Jeff King2f1d9e22011-06-09 15:54:58[diff] [blame]91static inline struct strbuf **strbuf_split_max(const struct strbuf *sb,
Michael Haggerty17b73dc2012-11-04 06:46:53[diff] [blame]92 int terminator, int max)
Jeff King2f1d9e22011-06-09 15:54:58[diff] [blame]93{
Michael Haggerty17b73dc2012-11-04 06:46:53[diff] [blame]94 return strbuf_split_buf(sb->buf, sb->len, terminator, max);
Jeff King2f1d9e22011-06-09 15:54:58[diff] [blame]95}
Michael Haggerty06379a62012-11-04 06:46:54[diff] [blame]96
97/*
98 * Split a strbuf at the specified terminator character. See
99 * strbuf_split_buf() for more information.
100 */
Michael Haggerty17b73dc2012-11-04 06:46:53[diff] [blame]101static inline struct strbuf **strbuf_split(const struct strbuf *sb,
102 int terminator)
Jeff King28fc3a62011-06-09 15:51:22[diff] [blame]103{
Michael Haggerty17b73dc2012-11-04 06:46:53[diff] [blame]104 return strbuf_split_max(sb, terminator, 0);
Jeff King28fc3a62011-06-09 15:51:22[diff] [blame]105}
Michael Haggerty06379a62012-11-04 06:46:54[diff] [blame]106
107/*
108 * Free a NULL-terminated list of strbufs (for example, the return
109 * values of the strbuf_split*() functions).
110 */
Lukas Sandströmeacd6dc2008-07-13 18:29:18[diff] [blame]111extern void strbuf_list_free(struct strbuf **);
Pierre Habouzitf1696ee2007-09-10 10:35:04[diff] [blame]112
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]113/*----- add data in your buffer -----*/
Nguyễn Thái Ngọc Duy187e2902014-03-01 02:50:55[diff] [blame]114static inline void strbuf_addch(struct strbuf *sb, int c)
115{
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]116 strbuf_grow(sb, 1);
117 sb->buf[sb->len++] = c;
118 sb->buf[sb->len] = '\0';
119}
120
Pierre Habouzitf1696ee2007-09-10 10:35:04[diff] [blame]121extern void strbuf_insert(struct strbuf *, size_t pos, const void *, size_t);
Pierre Habouzitc76689d2007-09-19 22:42:12[diff] [blame]122extern void strbuf_remove(struct strbuf *, size_t pos, size_t len);
Pierre Habouzitf1696ee2007-09-10 10:35:04[diff] [blame]123
Pierre Habouzit917c9a72007-09-15 13:56:50[diff] [blame]124/* splice pos..pos+len with given data */
125extern void strbuf_splice(struct strbuf *, size_t pos, size_t len,
Pierre Habouzitc76689d2007-09-19 22:42:12[diff] [blame]126 const void *, size_t);
Pierre Habouzit917c9a72007-09-15 13:56:50[diff] [blame]127
Junio C Hamanoeff80a92013-01-16 19:18:48[diff] [blame]128extern void strbuf_add_commented_lines(struct strbuf *out, const char *buf, size_t size);
129
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]130extern void strbuf_add(struct strbuf *, const void *, size_t);
Nguyễn Thái Ngọc Duy187e2902014-03-01 02:50:55[diff] [blame]131static inline void strbuf_addstr(struct strbuf *sb, const char *s)
132{
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]133 strbuf_add(sb, s, strlen(s));
134}
Nguyễn Thái Ngọc Duy187e2902014-03-01 02:50:55[diff] [blame]135static inline void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2)
136{
Junio C Hamano81d2cae2010-01-12 20:09:54[diff] [blame]137 strbuf_grow(sb, sb2->len);
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]138 strbuf_add(sb, sb2->buf, sb2->len);
139}
René Scharfe91db2672007-11-10 11:16:05[diff] [blame]140extern void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len);
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]141
Marco Costalbac3a670d2008-02-09 14:40:19[diff] [blame]142typedef size_t (*expand_fn_t) (struct strbuf *sb, const char *placeholder, void *context);
143extern void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn, void *context);
René Scharfe9b864e72008-11-22 23:09:30[diff] [blame]144struct strbuf_expand_dict_entry {
145 const char *placeholder;
146 const char *value;
147};
148extern size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder, void *context);
Jeff King361df5d2010-01-13 17:36:42[diff] [blame]149extern void strbuf_addbuf_percentquote(struct strbuf *dst, const struct strbuf *src);
René Scharfecde75e52007-11-09 00:49:42[diff] [blame]150
Tarmigan Casebolt28bea9e2009-11-14 21:33:13[diff] [blame]151__attribute__((format (printf,2,3)))
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]152extern void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
Junio C Hamanoeff80a92013-01-16 19:18:48[diff] [blame]153__attribute__((format (printf, 2, 3)))
154extern void strbuf_commented_addf(struct strbuf *sb, const char *fmt, ...);
Jeff Kingebeb6092011-02-26 05:08:53[diff] [blame]155__attribute__((format (printf,2,0)))
156extern void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap);
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]157
Junio C Hamano895680f2011-11-05 04:06:30[diff] [blame]158extern void strbuf_add_lines(struct strbuf *sb, const char *prefix, const char *buf, size_t size);
159
Michael Haggerty5963c032012-11-25 11:08:34[diff] [blame]160/*
161 * Append s to sb, with the characters '<', '>', '&' and '"' converted
162 * into XML entities.
163 */
164extern void strbuf_addstr_xml_quoted(struct strbuf *sb, const char *s);
165
Junio C Hamano895680f2011-11-05 04:06:30[diff] [blame]166static inline void strbuf_complete_line(struct strbuf *sb)
167{
168 if (sb->len && sb->buf[sb->len - 1] != '\n')
169 strbuf_addch(sb, '\n');
170}
171
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]172extern size_t strbuf_fread(struct strbuf *, size_t, FILE *);
173/* XXX: if read fails, any partial read is undone */
Pierre Habouzitf1696ee2007-09-10 10:35:04[diff] [blame]174extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
Pierre Habouzit387e7e12007-09-27 13:25:55[diff] [blame]175extern int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
Linus Torvaldsb11b7e12008-12-17 17:36:40[diff] [blame]176extern int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint);
Pierre Habouzitb449f4c2007-09-06 11:20:05[diff] [blame]177
Brandon Caseyc7e4f0d2009-08-05 03:31:56[diff] [blame]178extern int strbuf_getwholeline(struct strbuf *, FILE *, int);
Pierre Habouzite6c019d2007-09-17 09:19:04[diff] [blame]179extern int strbuf_getline(struct strbuf *, FILE *, int);
Thomas Rast5e8617f2012-02-22 19:34:22[diff] [blame]180extern int strbuf_getwholeline_fd(struct strbuf *, int, int);
Junio C Hamanod1df5742005-04-26 01:26:45[diff] [blame]181
Kristian Høgsberg6d69b6f2007-09-18 00:06:45[diff] [blame]182extern void stripspace(struct strbuf *buf, int skip_comments);
Stephan Beyer71982032008-07-25 16:28:42[diff] [blame]183extern int launch_editor(const char *path, struct strbuf *buffer, const char *const *env);
Kristian Høgsberg6d69b6f2007-09-18 00:06:45[diff] [blame]184
Junio C Hamanoa552de72009-03-21 20:17:30[diff] [blame]185extern int strbuf_branchname(struct strbuf *sb, const char *name);
Junio C Hamanoa2fab532009-03-21 21:35:51[diff] [blame]186extern int strbuf_check_branch_ref(struct strbuf *sb, const char *name);
Junio C Hamanoa552de72009-03-21 20:17:30[diff] [blame]187
Jeff Kingc5051162011-12-10 10:34:20[diff] [blame]188extern void strbuf_addstr_urlencode(struct strbuf *, const char *,
189 int reserved);
Antoine Pelisse079b5462013-04-10 19:03:23[diff] [blame]190extern void strbuf_humanise_bytes(struct strbuf *buf, off_t bytes);
Jeff Kingc5051162011-12-10 10:34:20[diff] [blame]191
Nguyễn Thái Ngọc Duy9a0a30a2012-04-23 12:30:22[diff] [blame]192__attribute__((format (printf,1,2)))
193extern int printf_ln(const char *fmt, ...);
194__attribute__((format (printf,2,3)))
195extern int fprintf_ln(FILE *fp, const char *fmt, ...);
196
Jeff King88d5a6f2014-05-22 09:44:09[diff] [blame]197char *xstrdup_tolower(const char *);
198
Jeff King30a0ddb2014-06-18 20:01:34[diff] [blame]199/*
200 * Create a newly allocated string using printf format. You can do this easily
201 * with a strbuf, but this provides a shortcut to save a few lines.
202 */
203__attribute__((format (printf, 1, 0)))
204char *xstrvfmt(const char *fmt, va_list ap);
205__attribute__((format (printf, 1, 2)))
206char *xstrfmt(const char *fmt, ...);
207
Junio C Hamanod1df5742005-04-26 01:26:45[diff] [blame]208#endif /* STRBUF_H */