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 <config.h>
  35 #include "dynamic-string.h"
  36 #include <assert.h>
  37 #include <stdlib.h>
  38 #include <string.h>
  39 #include <time.h>
  40 #include "timeval.h"
  41 #include "util.h"
  42
  43 void
  44 ds_init(struct ds *ds)
  45 {
  46     ds->string = NULL;
  47     ds->length = 0;
  48     ds->allocated = 0;
  49 }
  50
  51 void
  52 ds_clear(struct ds *ds)
  53 {
  54     ds->length = 0;
  55 }
  56
  57 void
  58 ds_truncate(struct ds *ds, size_t new_length)
  59 {
  60     if (ds->length > new_length) {
  61         ds->length = new_length;
  62         ds->string[new_length] = '\0';
  63     }
  64 }
  65
  66 void
  67 ds_reserve(struct ds *ds, size_t min_length)
  68 {
  69     if (min_length > ds->allocated || !ds->string) {
  70         ds->allocated += MAX(min_length, ds->allocated);
  71         ds->allocated = MAX(8, ds->allocated);
  72         ds->string = xrealloc(ds->string, ds->allocated + 1);
  73     }
  74 }
  75
  76 char *
  77 ds_put_uninit(struct ds *ds, size_t n)
  78 {
  79     ds_reserve(ds, ds->length + n);
  80     ds->length += n;
  81     ds->string[ds->length] = '\0';
  82     return &ds->string[ds->length - n];
  83 }
  84
  85 void
  86 ds_put_char(struct ds *ds, char c)
  87 {
  88     *ds_put_uninit(ds, 1) = c;
  89 }
  90
  91 void
  92 ds_put_char_multiple(struct ds *ds, char c, size_t n)
  93 {
  94     memset(ds_put_uninit(ds, n), c, n);
  95 }
  96
  97 void
  98 ds_put_buffer(struct ds *ds, const char *s, size_t n)
  99 {
 100     memcpy(ds_put_uninit(ds, n), s, n);
 101 }
 102
 103 void
 104 ds_put_cstr(struct ds *ds, const char *s)
 105 {
 106     size_t s_len = strlen(s);
 107     memcpy(ds_put_uninit(ds, s_len), s, s_len);
 108 }
 109
 110 void
 111 ds_put_format(struct ds *ds, const char *format, ...)
 112 {
 113     va_list args;
 114
 115     va_start(args, format);
 116     ds_put_format_valist(ds, format, args);
 117     va_end(args);
 118 }
 119
 120 void
 121 ds_put_format_valist(struct ds *ds, const char *format, va_list args_)
 122 {
 123     va_list args;
 124     size_t available;
 125     int needed;
 126
 127     va_copy(args, args_);
 128     available = ds->string ? ds->allocated - ds->length + 1 : 0;
 129     needed = vsnprintf(&ds->string[ds->length], available, format, args);
 130     va_end(args);
 131
 132     if (needed < available) {
 133         ds->length += needed;
 134     } else {
 135         size_t available;
 136
 137         ds_reserve(ds, ds->length + needed);
 138
 139         va_copy(args, args_);
 140         available = ds->allocated - ds->length + 1;
 141         needed = vsnprintf(&ds->string[ds->length], available, format, args);
 142         va_end(args);
 143
 144         assert(needed < available);
 145         ds->length += needed;
 146     }
 147 }
 148
 149 void
 150 ds_put_printable(struct ds *ds, const char *s, size_t n)
 151 {
 152     ds_reserve(ds, ds->length + n);
 153     while (n-- > 0) {
 154         unsigned char c = *s++;
 155         if (c < 0x20 || c > 0x7e || c == '\\' || c == '"') {
 156             ds_put_format(ds, "\\%03o", (int) c);
 157         } else {
 158             ds_put_char(ds, c);
 159         }
 160     }
 161 }
 162
 163 void
 164 ds_put_strftime(struct ds *ds, const char *template, const struct tm *tm)
 165 {
 166     if (!tm) {
 167         time_t now = time_now();
 168         tm = localtime(&now);
 169     }
 170     for (;;) {
 171         size_t avail = ds->string ? ds->allocated - ds->length + 1 : 0;
 172         size_t used = strftime(&ds->string[ds->length], avail, template, tm);
 173         if (used) {
 174             ds->length += used;
 175             return;
 176         }
 177         ds_reserve(ds, ds->length + (avail < 32 ? 64 : 2 * avail));
 178     }
 179 }
 180
 181 int
 182 ds_get_line(struct ds *ds, FILE *file)
 183 {
 184     ds_clear(ds);
 185     for (;;) {
 186         int c = getc(file);
 187         if (c == EOF) {
 188             return ds->length ? 0 : EOF;
 189         } else if (c == '\n') {
 190             return 0;
 191         } else {
 192             ds_put_char(ds, c);
 193         }
 194     }
 195 }
 196
 197 char *
 198 ds_cstr(struct ds *ds)
 199 {
 200     if (!ds->string) {
 201         ds_reserve(ds, 0);
 202     }
 203     ds->string[ds->length] = '\0';
 204     return ds->string;
 205 }
 206
 207 void
 208 ds_destroy(struct ds *ds)
 209 {
 210     free(ds->string);
 211 }
 212
 213 /* Writes the 'size' bytes in 'buf' to 'string' as hex bytes arranged 16 per
 214  * line.  Numeric offsets are also included, starting at 'ofs' for the first
 215  * byte in 'buf'.  If 'ascii' is true then the corresponding ASCII characters
 216  * are also rendered alongside. */
 217 void
 218 ds_put_hex_dump(struct ds *ds, const void *buf_, size_t size,
 219                 uintptr_t ofs, bool ascii)
 220 {
 221   const uint8_t *buf = buf_;
 222   const size_t per_line = 16; /* Maximum bytes per line. */
 223
 224   while (size > 0)
 225     {
 226       size_t start, end, n;
 227       size_t i;
 228
 229       /* Number of bytes on this line. */
 230       start = ofs % per_line;
 231       end = per_line;
 232       if (end - start > size)
 233         end = start + size;
 234       n = end - start;
 235
 236       /* Print line. */
 237       ds_put_format(ds, "%08jx  ", (uintmax_t) ROUND_DOWN(ofs, per_line));
 238       for (i = 0; i < start; i++)
 239         ds_put_format(ds, "   ");
 240       for (; i < end; i++)
 241         ds_put_format(ds, "%02hhx%c",
 242                 buf[i - start], i == per_line / 2 - 1? '-' : ' ');
 243       if (ascii)
 244         {
 245           for (; i < per_line; i++)
 246             ds_put_format(ds, "   ");
 247           ds_put_format(ds, "|");
 248           for (i = 0; i < start; i++)
 249             ds_put_format(ds, " ");
 250           for (; i < end; i++) {
 251               int c = buf[i - start];
 252               ds_put_char(ds, c >= 32 && c < 127 ? c : '.');
 253           }
 254           for (; i < per_line; i++)
 255             ds_put_format(ds, " ");
 256           ds_put_format(ds, "|");
 257         }
 258       ds_put_format(ds, "\n");
 259
 260       ofs += n;
 261       buf += n;
 262       size -= n;
 263     }
 264 }
 265
 266 int
 267 ds_last(const struct ds *ds)
 268 {
 269     return ds->length > 0 ? (unsigned char) ds->string[ds->length - 1] : EOF;
 270 }
 271
 272 void
 273 ds_chomp(struct ds *ds, int c)
 274 {
 275     if (ds->length > 0 && ds->string[ds->length - 1] == (char) c) {
 276         ds->string[--ds->length] = '\0';
 277     }
 278 }