include/dynamic-string.h

   1 /* Copyright (C) 2008 Board of Trustees, Leland Stanford Jr. University.
   2  *
   3  * Permission is hereby granted, free of charge, to any person obtaining a copy
   4  * of this software and associated documentation files (the "Software"), to
   5  * deal in the Software without restriction, including without limitation the
   6  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   7  * sell copies of the Software, and to permit persons to whom the Software is
   8  * furnished to do so, subject to the following conditions:
   9  *
  10  * The above copyright notice and this permission notice shall be included in
  11  * all copies or substantial portions of the Software.
  12  *
  13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  18  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  19  * IN THE SOFTWARE.
  20  */
  21
  22 #ifndef DYNAMIC_STRING_H
  23 #define DYNAMIC_STRING_H 1
  24
  25 #include <stdarg.h>
  26 #include <stddef.h>
  27 #include "compiler.h"
  28
  29 struct ds {
  30     char *string;       /* Null-terminated string. */
  31     size_t length;      /* Bytes used, not including null terminator. */
  32     size_t allocated;   /* Bytes allocated, not including null terminator. */
  33 };
  34
  35 #define DS_EMPTY_INITIALIZER { NULL, 0, 0 }
  36
  37 void ds_init(struct ds *);
  38 void ds_reserve(struct ds *, size_t min_length);
  39 void ds_put_format(struct ds *, const char *, ...) PRINTF_FORMAT(2, 3);
  40 void ds_put_format_valist(struct ds *, const char *, va_list)
  41     PRINTF_FORMAT(2, 0);
  42 char *ds_cstr(struct ds *);
  43 void ds_destroy(struct ds *);
  44
  45 #endif /* dynamic-string.h */