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