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