Fix typos on pt_BR/gittutorial.txt translation
[git/git.git] / strbuf.h
CommitLineData
d1df5743
JH
1#ifndef STRBUF_H
2#define STRBUF_H
b449f4cf
PH
3
4/*
5 * Strbuf's can be use in many ways: as a byte array, or to store arbitrary
6 * long, overflow safe strings.
7 *
8 * Strbufs has some invariants that are very important to keep in mind:
9 *
10 * 1. the ->buf member is always malloc-ed, hence strbuf's can be used to
11 * build complex strings/buffers whose final size isn't easily known.
12 *
b315c5c0 13 * It is NOT legal to copy the ->buf pointer away.
3ea3c215 14 * `strbuf_detach' is the operation that detaches a buffer from its shell
b449f4cf
PH
15 * while keeping the shell valid wrt its invariants.
16 *
17 * 2. the ->buf member is a byte array that has at least ->len + 1 bytes
18 * allocated. The extra byte is used to store a '\0', allowing the ->buf
19 * member to be a valid C-string. Every strbuf function ensure this
20 * invariant is preserved.
21 *
22 * Note that it is OK to "play" with the buffer directly if you work it
23 * that way:
24 *
25 * strbuf_grow(sb, SOME_SIZE);
a1f611d5
SP
26 * ... Here, the memory array starting at sb->buf, and of length
27 * ... strbuf_avail(sb) is all yours, and you are sure that
28 * ... strbuf_avail(sb) is at least SOME_SIZE.
b449f4cf
PH
29 * strbuf_setlen(sb, sb->len + SOME_OTHER_SIZE);
30 *
a1f611d5 31 * Of course, SOME_OTHER_SIZE must be smaller or equal to strbuf_avail(sb).
b449f4cf
PH
32 *
33 * Doing so is safe, though if it has to be done in many places, adding the
34 * missing API to the strbuf module is the way to go.
35 *
36 * XXX: do _not_ assume that the area that is yours is of size ->alloc - 1
37 * even if it's true in the current implementation. Alloc is somehow a
38 * "private" member that should not be messed with.
39 */
40
41#include <assert.h>
42
b315c5c0 43extern char strbuf_slopbuf[];
d1df5743 44struct strbuf {
b449f4cf
PH
45 size_t alloc;
46 size_t len;
bf0f910d 47 char *buf;
d1df5743
JH
48};
49
b315c5c0 50#define STRBUF_INIT { 0, 0, strbuf_slopbuf }
b449f4cf
PH
51
52/*----- strbuf life cycle -----*/
f1696ee3 53extern void strbuf_init(struct strbuf *, size_t);
b449f4cf 54extern void strbuf_release(struct strbuf *);
b315c5c0 55extern char *strbuf_detach(struct strbuf *, size_t *);
917c9a71 56extern void strbuf_attach(struct strbuf *, void *, size_t, size_t);
c76689df
PH
57static inline void strbuf_swap(struct strbuf *a, struct strbuf *b) {
58 struct strbuf tmp = *a;
59 *a = *b;
60 *b = tmp;
61}
b449f4cf
PH
62
63/*----- strbuf size related -----*/
9b200fd6 64static inline size_t strbuf_avail(const struct strbuf *sb) {
c76689df 65 return sb->alloc ? sb->alloc - sb->len - 1 : 0;
b449f4cf 66}
a8f3e221
JH
67
68extern void strbuf_grow(struct strbuf *, size_t);
69
b449f4cf 70static inline void strbuf_setlen(struct strbuf *sb, size_t len) {
a8f3e221
JH
71 if (!sb->alloc)
72 strbuf_grow(sb, 0);
73 assert(len < sb->alloc);
c76689df
PH
74 sb->len = len;
75 sb->buf[len] = '\0';
b449f4cf 76}
b315c5c0 77#define strbuf_reset(sb) strbuf_setlen(sb, 0)
b449f4cf 78
f1696ee3 79/*----- content related -----*/
eacd6dc5 80extern void strbuf_trim(struct strbuf *);
f1696ee3 81extern void strbuf_rtrim(struct strbuf *);
eacd6dc5 82extern void strbuf_ltrim(struct strbuf *);
9b200fd6 83extern int strbuf_cmp(const struct strbuf *, const struct strbuf *);
eacd6dc5
LS
84extern void strbuf_tolower(struct strbuf *);
85
86extern struct strbuf **strbuf_split(const struct strbuf *, int delim);
87extern void strbuf_list_free(struct strbuf **);
f1696ee3 88
b449f4cf
PH
89/*----- add data in your buffer -----*/
90static inline void strbuf_addch(struct strbuf *sb, int c) {
91 strbuf_grow(sb, 1);
92 sb->buf[sb->len++] = c;
93 sb->buf[sb->len] = '\0';
94}
95
f1696ee3 96extern void strbuf_insert(struct strbuf *, size_t pos, const void *, size_t);
c76689df 97extern void strbuf_remove(struct strbuf *, size_t pos, size_t len);
f1696ee3 98
917c9a71
PH
99/* splice pos..pos+len with given data */
100extern void strbuf_splice(struct strbuf *, size_t pos, size_t len,
c76689df 101 const void *, size_t);
917c9a71 102
b449f4cf
PH
103extern void strbuf_add(struct strbuf *, const void *, size_t);
104static inline void strbuf_addstr(struct strbuf *sb, const char *s) {
105 strbuf_add(sb, s, strlen(s));
106}
9b200fd6 107static inline void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2) {
b449f4cf
PH
108 strbuf_add(sb, sb2->buf, sb2->len);
109}
91db267e 110extern void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len);
b449f4cf 111
c3a670de
MC
112typedef size_t (*expand_fn_t) (struct strbuf *sb, const char *placeholder, void *context);
113extern void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn, void *context);
9b864e73
RS
114struct strbuf_expand_dict_entry {
115 const char *placeholder;
116 const char *value;
117};
118extern size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder, void *context);
cde75e59 119
b449f4cf
PH
120__attribute__((format(printf,2,3)))
121extern void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
122
123extern size_t strbuf_fread(struct strbuf *, size_t, FILE *);
124/* XXX: if read fails, any partial read is undone */
f1696ee3 125extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
387e7e19 126extern int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
b11b7e13 127extern int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint);
b449f4cf 128
e6c019d0 129extern int strbuf_getline(struct strbuf *, FILE *, int);
d1df5743 130
6d69b6f6 131extern void stripspace(struct strbuf *buf, int skip_comments);
7198203a 132extern int launch_editor(const char *path, struct strbuf *buffer, const char *const *env);
6d69b6f6 133
a552de75 134extern int strbuf_branchname(struct strbuf *sb, const char *name);
a2fab531 135extern int strbuf_check_branch_ref(struct strbuf *sb, const char *name);
a552de75 136
d1df5743 137#endif /* STRBUF_H */