lib/dynamic-string.h

   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 #ifndef DYNAMIC_STRING_H
  35 #define DYNAMIC_STRING_H 1
  36
  37 #include <stdarg.h>
  38 #include <stdbool.h>
  39 #include <stddef.h>
  40 #include <stdint.h>
  41 #include <stdio.h>
  42 #include "compiler.h"
  43
  44 struct tm;
  45
  46 struct ds {
  47     char *string;       /* Null-terminated string. */
  48     size_t length;      /* Bytes used, not including null terminator. */
  49     size_t allocated;   /* Bytes allocated, not including null terminator. */
  50 };
  51
  52 #define DS_EMPTY_INITIALIZER { NULL, 0, 0 }
  53
  54 void ds_init(struct ds *);
  55 void ds_clear(struct ds *);
  56 void ds_truncate(struct ds *, size_t new_length);
  57 void ds_reserve(struct ds *, size_t min_length);
  58 char *ds_put_uninit(struct ds *, size_t n);
  59 void ds_put_char(struct ds *, char);
  60 void ds_put_char_multiple(struct ds *, char, size_t n);
  61 void ds_put_buffer(struct ds *, const char *, size_t n);
  62 void ds_put_cstr(struct ds *, const char *);
  63 void ds_put_format(struct ds *, const char *, ...) PRINTF_FORMAT(2, 3);
  64 void ds_put_format_valist(struct ds *, const char *, va_list)
  65     PRINTF_FORMAT(2, 0);
  66 void ds_put_printable(struct ds *, const char *, size_t);
  67 void ds_put_strftime(struct ds *, const char *, const struct tm *)
  68     STRFTIME_FORMAT(2);
  69 void ds_put_hex_dump(struct ds *ds, const void *buf_, size_t size,
  70                      uintptr_t ofs, bool ascii);
  71 int ds_get_line(struct ds *, FILE *);
  72
  73 char *ds_cstr(struct ds *);
  74 void ds_destroy(struct ds *);
  75
  76 int ds_last(const struct ds *);
  77 void ds_chomp(struct ds *, int c);
  78
  79 #endif /* dynamic-string.h */