New function ds_clear().
[openvswitch] / lib / dynamic-string.c
1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
2  * Junior University
3  * 
4  * We are making the OpenFlow specification and associated documentation
5  * (Software) available for public use and benefit with the expectation
6  * that others will use, modify and enhance the Software and contribute
7  * those enhancements back to the community. However, since we would
8  * like to make the Software available for broadest use, with as few
9  * restrictions as possible permission is hereby granted, free of
10  * charge, to any person obtaining a copy of this Software to deal in
11  * the Software under the copyrights without restriction, including
12  * without limitation the rights to use, copy, modify, merge, publish,
13  * distribute, sublicense, and/or sell copies of the Software, and to
14  * permit persons to whom the Software is furnished to do so, subject to
15  * the following conditions:
16  * 
17  * The above copyright notice and this permission notice shall be
18  * included in all copies or substantial portions of the Software.
19  * 
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27  * SOFTWARE.
28  * 
29  * The name and trademarks of copyright holder(s) may NOT be used in
30  * advertising or publicity pertaining to the Software or any
31  * derivatives without specific, written prior permission.
32  */
33
34 #include "dynamic-string.h"
35 #include <assert.h>
36 #include <stdlib.h>
37 #include <string.h>
38 #include "util.h"
39
40 void
41 ds_init(struct ds *ds)
42 {
43     ds->string = NULL;
44     ds->length = 0;
45     ds->allocated = 0;
46 }
47
48 void
49 ds_clear(struct ds *ds) 
50 {
51     ds->length = 0;
52 }
53
54 void
55 ds_reserve(struct ds *ds, size_t min_length)
56 {
57     if (min_length > ds->allocated || !ds->string) {
58         ds->allocated += MAX(min_length, ds->allocated);
59         ds->allocated = MAX(8, ds->allocated);
60         ds->string = xrealloc(ds->string, ds->allocated + 1);
61     }
62 }
63
64 void
65 ds_put_char(struct ds *ds, char c)
66 {
67     ds_reserve(ds, ds->length + 1);
68     ds->string[ds->length++] = c;
69     ds->string[ds->length] = '\0';
70 }
71
72 void
73 ds_put_cstr(struct ds *ds, const char *s)
74 {
75     size_t s_len = strlen(s);
76     ds_reserve(ds, ds->length + s_len);
77     memcpy(&ds->string[ds->length], s, s_len + 1);
78     ds->length += s_len;
79 }
80
81 void
82 ds_put_format(struct ds *ds, const char *format, ...)
83 {
84     va_list args;
85
86     va_start(args, format);
87     ds_put_format_valist(ds, format, args);
88     va_end(args);
89 }
90
91 void
92 ds_put_format_valist(struct ds *ds, const char *format, va_list args_)
93 {
94     va_list args;
95     size_t available;
96     int needed;
97
98     va_copy(args, args_);
99     available = ds->string ? ds->allocated - ds->length + 1 : 0;
100     needed = vsnprintf(&ds->string[ds->length], available, format, args);
101     va_end(args);
102
103     if (needed < available) {
104         ds->length += needed;
105     } else {
106         size_t available;
107
108         ds_reserve(ds, ds->length + needed);
109
110         va_copy(args, args_);
111         available = ds->allocated - ds->length + 1;
112         needed = vsnprintf(&ds->string[ds->length], available, format, args);
113         va_end(args);
114
115         assert(needed < available);
116         ds->length += needed;
117     }
118 }
119
120 char *
121 ds_cstr(struct ds *ds)
122 {
123     if (!ds->string) {
124         ds_reserve(ds, 0);
125         ds->string[0] = '\0';
126     }
127     return ds->string;
128 }
129
130 void
131 ds_destroy(struct ds *ds)
132 {
133     free(ds->string);
134 }
135
136 /* Writes the 'size' bytes in 'buf' to 'string' as hex bytes arranged 16 per
137  * line.  Numeric offsets are also included, starting at 'ofs' for the first
138  * byte in 'buf'.  If 'ascii' is true then the corresponding ASCII characters
139  * are also rendered alongside. */
140 void
141 ds_put_hex_dump(struct ds *ds, const void *buf_, size_t size,
142                 uintptr_t ofs, bool ascii)
143 {
144   const uint8_t *buf = buf_;
145   const size_t per_line = 16; /* Maximum bytes per line. */
146
147   while (size > 0)
148     {
149       size_t start, end, n;
150       size_t i;
151
152       /* Number of bytes on this line. */
153       start = ofs % per_line;
154       end = per_line;
155       if (end - start > size)
156         end = start + size;
157       n = end - start;
158
159       /* Print line. */
160       ds_put_format(ds, "%08jx  ", (uintmax_t) ROUND_DOWN(ofs, per_line));
161       for (i = 0; i < start; i++)
162         ds_put_format(ds, "   ");
163       for (; i < end; i++)
164         ds_put_format(ds, "%02hhx%c",
165                 buf[i - start], i == per_line / 2 - 1? '-' : ' ');
166       if (ascii)
167         {
168           for (; i < per_line; i++)
169             ds_put_format(ds, "   ");
170           ds_put_format(ds, "|");
171           for (i = 0; i < start; i++)
172             ds_put_format(ds, " ");
173           for (; i < end; i++) {
174               int c = buf[i - start];
175               ds_put_char(ds, c >= 32 && c < 127 ? c : '.');
176           }
177           for (; i < per_line; i++)
178             ds_put_format(ds, " ");
179           ds_put_format(ds, "|");
180         }
181       ds_put_format(ds, "\n");
182
183       ofs += n;
184       buf += n;
185       size -= n;
186     }
187 }