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