lib/dynamic-string.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include "dynamic-string.h"
  19 #include <assert.h>
  20 #include <stdlib.h>
  21 #include <string.h>
  22 #include <time.h>
  23 #include "timeval.h"
  24 #include "util.h"
  25
  26 void
  27 ds_init(struct ds *ds)
  28 {
  29     ds->string = NULL;
  30     ds->length = 0;
  31     ds->allocated = 0;
  32 }
  33
  34 void
  35 ds_clear(struct ds *ds)
  36 {
  37     ds->length = 0;
  38 }
  39
  40 void
  41 ds_truncate(struct ds *ds, size_t new_length)
  42 {
  43     if (ds->length > new_length) {
  44         ds->length = new_length;
  45         ds->string[new_length] = '\0';
  46     }
  47 }
  48
  49 void
  50 ds_reserve(struct ds *ds, size_t min_length)
  51 {
  52     if (min_length > ds->allocated || !ds->string) {
  53         ds->allocated += MAX(min_length, ds->allocated);
  54         ds->allocated = MAX(8, ds->allocated);
  55         ds->string = xrealloc(ds->string, ds->allocated + 1);
  56     }
  57 }
  58
  59 char *
  60 ds_put_uninit(struct ds *ds, size_t n)
  61 {
  62     ds_reserve(ds, ds->length + n);
  63     ds->length += n;
  64     ds->string[ds->length] = '\0';
  65     return &ds->string[ds->length - n];
  66 }
  67
  68 void
  69 ds_put_char__(struct ds *ds, char c)
  70 {
  71     *ds_put_uninit(ds, 1) = c;
  72 }
  73
  74 /* Appends unicode code point 'uc' to 'ds' in UTF-8 encoding. */
  75 void
  76 ds_put_utf8(struct ds *ds, int uc)
  77 {
  78     if (uc <= 0x7f) {
  79         ds_put_char(ds, uc);
  80     } else if (uc <= 0x7ff) {
  81         ds_put_char(ds, 0xc0 | (uc >> 6));
  82         ds_put_char(ds, 0x80 | (uc & 0x3f));
  83     } else if (uc <= 0xffff) {
  84         ds_put_char(ds, 0xe0 | (uc >> 12));
  85         ds_put_char(ds, 0x80 | ((uc >> 6) & 0x3f));
  86         ds_put_char(ds, 0x80 | (uc & 0x3f));
  87     } else if (uc <= 0x10ffff) {
  88         ds_put_char(ds, 0xf0 | (uc >> 18));
  89         ds_put_char(ds, 0x80 | ((uc >> 12) & 0x3f));
  90         ds_put_char(ds, 0x80 | ((uc >> 6) & 0x3f));
  91         ds_put_char(ds, 0x80 | (uc & 0x3f));
  92     } else {
  93         /* Invalid code point.  Insert the Unicode general substitute
  94          * REPLACEMENT CHARACTER. */
  95         ds_put_utf8(ds, 0xfffd);
  96     }
  97 }
  98
  99 void
 100 ds_put_char_multiple(struct ds *ds, char c, size_t n)
 101 {
 102     memset(ds_put_uninit(ds, n), c, n);
 103 }
 104
 105 void
 106 ds_put_buffer(struct ds *ds, const char *s, size_t n)
 107 {
 108     memcpy(ds_put_uninit(ds, n), s, n);
 109 }
 110
 111 void
 112 ds_put_cstr(struct ds *ds, const char *s)
 113 {
 114     size_t s_len = strlen(s);
 115     memcpy(ds_put_uninit(ds, s_len), s, s_len);
 116 }
 117
 118 void
 119 ds_put_and_free_cstr(struct ds *ds, char *s)
 120 {
 121     ds_put_cstr(ds, s);
 122     free(s);
 123 }
 124
 125 void
 126 ds_put_format(struct ds *ds, const char *format, ...)
 127 {
 128     va_list args;
 129
 130     va_start(args, format);
 131     ds_put_format_valist(ds, format, args);
 132     va_end(args);
 133 }
 134
 135 void
 136 ds_put_format_valist(struct ds *ds, const char *format, va_list args_)
 137 {
 138     va_list args;
 139     size_t available;
 140     int needed;
 141
 142     va_copy(args, args_);
 143     available = ds->string ? ds->allocated - ds->length + 1 : 0;
 144     needed = vsnprintf(&ds->string[ds->length], available, format, args);
 145     va_end(args);
 146
 147     if (needed < available) {
 148         ds->length += needed;
 149     } else {
 150         ds_reserve(ds, ds->length + needed);
 151
 152         va_copy(args, args_);
 153         available = ds->allocated - ds->length + 1;
 154         needed = vsnprintf(&ds->string[ds->length], available, format, args);
 155         va_end(args);
 156
 157         assert(needed < available);
 158         ds->length += needed;
 159     }
 160 }
 161
 162 void
 163 ds_put_printable(struct ds *ds, const char *s, size_t n)
 164 {
 165     ds_reserve(ds, ds->length + n);
 166     while (n-- > 0) {
 167         unsigned char c = *s++;
 168         if (c < 0x20 || c > 0x7e || c == '\\' || c == '"') {
 169             ds_put_format(ds, "\\%03o", (int) c);
 170         } else {
 171             ds_put_char(ds, c);
 172         }
 173     }
 174 }
 175
 176 /* Writes the current time to 'string' based on 'template'.
 177  * The current time is either localtime or UTC based on 'utc'. */
 178 void
 179 ds_put_strftime(struct ds *ds, const char *template, bool utc)
 180 {
 181     const struct tm *tm;
 182     time_t now = time_wall();
 183     if (utc) {
 184         tm = gmtime(&now);
 185     } else {
 186         tm = localtime(&now);
 187     }
 188
 189     for (;;) {
 190         size_t avail = ds->string ? ds->allocated - ds->length + 1 : 0;
 191         size_t used = strftime(&ds->string[ds->length], avail, template, tm);
 192         if (used) {
 193             ds->length += used;
 194             return;
 195         }
 196         ds_reserve(ds, ds->length + (avail < 32 ? 64 : 2 * avail));
 197     }
 198 }
 199
 200 int
 201 ds_get_line(struct ds *ds, FILE *file)
 202 {
 203     ds_clear(ds);
 204     for (;;) {
 205         int c = getc(file);
 206         if (c == EOF) {
 207             return ds->length ? 0 : EOF;
 208         } else if (c == '\n') {
 209             return 0;
 210         } else {
 211             ds_put_char(ds, c);
 212         }
 213     }
 214 }
 215
 216 /* Reads a line from 'file' into 'ds', clearing anything initially in 'ds'.
 217  * Deletes comments introduced by "#" and skips lines that contains only white
 218  * space (after deleting comments).
 219  *
 220  * Returns 0 if successful, EOF if no non-blank line was found. */
 221 int
 222 ds_get_preprocessed_line(struct ds *ds, FILE *file)
 223 {
 224     while (!ds_get_line(ds, file)) {
 225         char *line = ds_cstr(ds);
 226         char *comment;
 227
 228         /* Delete comments. */
 229         comment = strchr(line, '#');
 230         if (comment) {
 231             *comment = '\0';
 232         }
 233
 234         /* Return successfully unless the line is all spaces. */
 235         if (line[strspn(line, " \t\n")] != '\0') {
 236             return 0;
 237         }
 238     }
 239     return EOF;
 240 }
 241
 242 char *
 243 ds_cstr(struct ds *ds)
 244 {
 245     if (!ds->string) {
 246         ds_reserve(ds, 0);
 247     }
 248     ds->string[ds->length] = '\0';
 249     return ds->string;
 250 }
 251
 252 const char *
 253 ds_cstr_ro(const struct ds *ds)
 254 {
 255     return ds_cstr((struct ds *) ds);
 256 }
 257
 258 /* Returns a null-terminated string representing the current contents of 'ds',
 259  * which the caller is expected to free with free(), then clears the contents
 260  * of 'ds'. */
 261 char *
 262 ds_steal_cstr(struct ds *ds)
 263 {
 264     char *s = ds_cstr(ds);
 265     ds_init(ds);
 266     return s;
 267 }
 268
 269 void
 270 ds_destroy(struct ds *ds)
 271 {
 272     free(ds->string);
 273 }
 274
 275 /* Swaps the content of 'a' and 'b'. */
 276 void
 277 ds_swap(struct ds *a, struct ds *b)
 278 {
 279     struct ds temp = *a;
 280     *a = *b;
 281     *b = temp;
 282 }
 283
 284 /* Writes the 'size' bytes in 'buf' to 'string' as hex bytes arranged 16 per
 285  * line.  Numeric offsets are also included, starting at 'ofs' for the first
 286  * byte in 'buf'.  If 'ascii' is true then the corresponding ASCII characters
 287  * are also rendered alongside. */
 288 void
 289 ds_put_hex_dump(struct ds *ds, const void *buf_, size_t size,
 290                 uintptr_t ofs, bool ascii)
 291 {
 292   const uint8_t *buf = buf_;
 293   const size_t per_line = 16; /* Maximum bytes per line. */
 294
 295   while (size > 0)
 296     {
 297       size_t start, end, n;
 298       size_t i;
 299
 300       /* Number of bytes on this line. */
 301       start = ofs % per_line;
 302       end = per_line;
 303       if (end - start > size)
 304         end = start + size;
 305       n = end - start;
 306
 307       /* Print line. */
 308       ds_put_format(ds, "%08jx  ", (uintmax_t) ROUND_DOWN(ofs, per_line));
 309       for (i = 0; i < start; i++)
 310         ds_put_format(ds, "   ");
 311       for (; i < end; i++)
 312         ds_put_format(ds, "%02hhx%c",
 313                 buf[i - start], i == per_line / 2 - 1? '-' : ' ');
 314       if (ascii)
 315         {
 316           for (; i < per_line; i++)
 317             ds_put_format(ds, "   ");
 318           ds_put_format(ds, "|");
 319           for (i = 0; i < start; i++)
 320             ds_put_format(ds, " ");
 321           for (; i < end; i++) {
 322               int c = buf[i - start];
 323               ds_put_char(ds, c >= 32 && c < 127 ? c : '.');
 324           }
 325           for (; i < per_line; i++)
 326             ds_put_format(ds, " ");
 327           ds_put_format(ds, "|");
 328         }
 329       ds_put_format(ds, "\n");
 330
 331       ofs += n;
 332       buf += n;
 333       size -= n;
 334     }
 335 }
 336
 337 int
 338 ds_last(const struct ds *ds)
 339 {
 340     return ds->length > 0 ? (unsigned char) ds->string[ds->length - 1] : EOF;
 341 }
 342
 343 void
 344 ds_chomp(struct ds *ds, int c)
 345 {
 346     if (ds->length > 0 && ds->string[ds->length - 1] == (char) c) {
 347         ds->string[--ds->length] = '\0';
 348     }
 349 }