Remove keytab configuration
[mspang/pyceo.git] / src / strbuf.h
1 /*
2  Copyright (c) 2005-2008 Junio C. Hamano et al.
3
4  This program is free software; you can redistribute it and/or modify
5  it under the terms of the GNU General Public License (version 2)
6  as published by the Free Software Foundation.
7
8  This program is distributed in the hope that it will be useful,
9  but WITHOUT ANY WARRANTY; without even the implied warranty of
10  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11  GNU General Public License for more details.
12
13  You should have received a copy of the GNU General Public License
14  along with this program; if not, write to the Free Software
15  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16 */
17
18 #ifndef STRBUF_H
19 #define STRBUF_H
20
21 /*
22  * Strbuf's can be use in many ways: as a byte array, or to store arbitrary
23  * long, overflow safe strings.
24  *
25  * Strbufs has some invariants that are very important to keep in mind:
26  *
27  * 1. the ->buf member is always malloc-ed, hence strbuf's can be used to
28  *    build complex strings/buffers whose final size isn't easily known.
29  *
30  *    It is NOT legal to copy the ->buf pointer away.
31  *    `strbuf_detach' is the operation that detachs a buffer from its shell
32  *    while keeping the shell valid wrt its invariants.
33  *
34  * 2. the ->buf member is a byte array that has at least ->len + 1 bytes
35  *    allocated. The extra byte is used to store a '\0', allowing the ->buf
36  *    member to be a valid C-string. Every strbuf function ensure this
37  *    invariant is preserved.
38  *
39  *    Note that it is OK to "play" with the buffer directly if you work it
40  *    that way:
41  *
42  *    strbuf_grow(sb, SOME_SIZE);
43  *       ... Here, the memory array starting at sb->buf, and of length
44  *       ... strbuf_avail(sb) is all yours, and you are sure that
45  *       ... strbuf_avail(sb) is at least SOME_SIZE.
46  *    strbuf_setlen(sb, sb->len + SOME_OTHER_SIZE);
47  *
48  *    Of course, SOME_OTHER_SIZE must be smaller or equal to strbuf_avail(sb).
49  *
50  *    Doing so is safe, though if it has to be done in many places, adding the
51  *    missing API to the strbuf module is the way to go.
52  *
53  *    XXX: do _not_ assume that the area that is yours is of size ->alloc - 1
54  *         even if it's true in the current implementation. Alloc is somehow a
55  *         "private" member that should not be messed with.
56  */
57
58 #include <assert.h>
59 #include <sys/types.h>
60 #include <string.h>
61 #include <stdio.h>
62 #include <stdarg.h>
63
64 extern char strbuf_slopbuf[];
65 struct strbuf {
66         size_t alloc;
67         size_t len;
68         char *buf;
69 };
70
71 #define STRBUF_INIT  { 0, 0, strbuf_slopbuf }
72
73 /*----- strbuf life cycle -----*/
74 extern void strbuf_init(struct strbuf *, size_t);
75 extern void strbuf_release(struct strbuf *);
76 extern char *strbuf_detach(struct strbuf *, size_t *);
77 extern void strbuf_attach(struct strbuf *, void *, size_t, size_t);
78 static inline void strbuf_swap(struct strbuf *a, struct strbuf *b) {
79         struct strbuf tmp = *a;
80         *a = *b;
81         *b = tmp;
82 }
83
84 /*----- strbuf size related -----*/
85 static inline size_t strbuf_avail(const struct strbuf *sb) {
86         return sb->alloc ? sb->alloc - sb->len - 1 : 0;
87 }
88
89 extern void strbuf_grow(struct strbuf *, size_t);
90
91 static inline void strbuf_setlen(struct strbuf *sb, size_t len) {
92         if (!sb->alloc)
93                 strbuf_grow(sb, 0);
94         assert(len < sb->alloc);
95         sb->len = len;
96         sb->buf[len] = '\0';
97 }
98 #define strbuf_reset(sb)  strbuf_setlen(sb, 0)
99
100 /*----- content related -----*/
101 extern void strbuf_trim(struct strbuf *);
102 extern void strbuf_rtrim(struct strbuf *);
103 extern void strbuf_ltrim(struct strbuf *);
104 extern int strbuf_cmp(const struct strbuf *, const struct strbuf *);
105 extern void strbuf_tolower(struct strbuf *);
106
107 extern struct strbuf **strbuf_split(const struct strbuf *, int delim);
108 extern struct strbuf **strbuf_splitws(const struct strbuf *);
109 extern void strbuf_list_free(struct strbuf **);
110 extern size_t strbuf_list_len(struct strbuf **);
111
112 /*----- add data in your buffer -----*/
113 static inline void strbuf_addch(struct strbuf *sb, int c) {
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(struct strbuf *, const void *, size_t);
127 static inline void strbuf_addstr(struct strbuf *sb, const char *s) {
128         strbuf_add(sb, s, strlen(s));
129 }
130 static inline void strbuf_addbuf(struct strbuf *sb, const struct strbuf *sb2) {
131         strbuf_add(sb, sb2->buf, sb2->len);
132 }
133 extern void strbuf_adddup(struct strbuf *sb, size_t pos, size_t len);
134
135 typedef size_t (*expand_fn_t) (struct strbuf *sb, const char *placeholder, void *context);
136 extern void strbuf_expand(struct strbuf *sb, const char *format, expand_fn_t fn, void *context);
137 struct strbuf_expand_dict_entry {
138         const char *placeholder;
139         const char *value;
140 };
141 extern size_t strbuf_expand_dict_cb(struct strbuf *sb, const char *placeholder, void *context);
142
143 __attribute__((format(printf,2,3)))
144 extern void strbuf_addf(struct strbuf *sb, const char *fmt, ...);
145 extern void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap);
146
147 extern size_t strbuf_fread(struct strbuf *, size_t, FILE *);
148 /* XXX: if read fails, any partial read is undone */
149 extern ssize_t strbuf_read(struct strbuf *, int fd, size_t hint);
150 extern ssize_t strbuf_write(struct strbuf *sb, int fd);
151 extern int strbuf_read_file(struct strbuf *sb, const char *path, size_t hint);
152
153 extern int strbuf_getline(struct strbuf *, FILE *, int);
154
155 extern void stripspace(struct strbuf *buf, int skip_comments);
156 extern int launch_editor(const char *path, struct strbuf *buffer, const char *const *env);
157
158 #endif /* STRBUF_H */