src/utils/strbuf.c

   1 /*
   2  * SysDB - src/utils/strbuf.c
   3  * Copyright (C) 2012 Sebastian 'tokkee' Harl <sh@tokkee.org>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  17  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  18  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
  19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #include "utils/strbuf.h"
  29
  30 #include <assert.h>
  31
  32 #include <stdio.h>
  33 #include <stdlib.h>
  34 #include <stdarg.h>
  35 #include <string.h>
  36
  37 #include <unistd.h>
  38
  39 /*
  40  * private data structures
  41  */
  42
  43 struct sdb_strbuf {
  44         char  *string;
  45         size_t size;
  46         size_t pos;
  47 };
  48
  49 /*
  50  * private helper functions
  51  */
  52
  53 static int
  54 strbuf_resize(sdb_strbuf_t *strbuf, size_t new_size)
  55 {
  56         char *tmp;
  57
  58         if (new_size <= strbuf->size)
  59                 return 0;
  60
  61         tmp = realloc(strbuf->string, new_size);
  62         if (! tmp)
  63                 return -1;
  64
  65         strbuf->string = tmp;
  66         strbuf->size = new_size;
  67         return 0;
  68 } /* strbuf_resize */
  69
  70 /*
  71  * public API
  72  */
  73
  74 sdb_strbuf_t *
  75 sdb_strbuf_create(size_t size)
  76 {
  77         sdb_strbuf_t *strbuf;
  78
  79         strbuf = calloc(1, sizeof(*strbuf));
  80         if (! strbuf)
  81                 return NULL;
  82
  83         strbuf->string = NULL;
  84         if (size) {
  85                 strbuf->string = malloc(size);
  86                 if (! strbuf->string) {
  87                         free(strbuf);
  88                         return NULL;
  89                 }
  90
  91                 strbuf->string[0] = '\0';
  92         }
  93
  94         strbuf->size = size;
  95         strbuf->pos  = 0;
  96
  97         return strbuf;
  98 } /* sdb_strbuf_create */
  99
 100 void
 101 sdb_strbuf_destroy(sdb_strbuf_t *strbuf)
 102 {
 103         if (! strbuf)
 104                 return;
 105
 106         if (strbuf->string)
 107                 free(strbuf->string);
 108         free(strbuf);
 109 } /* sdb_strbuf_destroy */
 110
 111 ssize_t
 112 sdb_strbuf_vappend(sdb_strbuf_t *strbuf, const char *fmt, va_list ap)
 113 {
 114         va_list aq;
 115         int status;
 116
 117         if ((! strbuf) || (! fmt))
 118                 return -1;
 119
 120         assert((strbuf->size == 0) || (strbuf->string[strbuf->pos] == '\0'));
 121
 122         if (strbuf->pos >= strbuf->size)
 123                 /* use some arbitrary but somewhat reasonable default */
 124                 if (strbuf_resize(strbuf, strbuf->size ? 2 * strbuf->size : 64))
 125                         return -1;
 126
 127         assert(strbuf->size && strbuf->string);
 128         assert(strbuf->pos < strbuf->size);
 129
 130         /* 'ap' is invalid after calling vsnprintf; thus copy before using it */
 131         va_copy(aq, ap);
 132         status = vsnprintf(strbuf->string + strbuf->pos,
 133                         strbuf->size - strbuf->pos, fmt, ap);
 134
 135         if (status < 0) {
 136                 va_end(aq);
 137                 return status;
 138         }
 139
 140         if ((size_t)status >= strbuf->size - strbuf->pos) {
 141                 strbuf_resize(strbuf, (size_t)status + 1);
 142
 143                 /* reset string and try again */
 144                 strbuf->string[strbuf->pos] = '\0';
 145                 status = (int)sdb_strbuf_vappend(strbuf, fmt, aq);
 146         }
 147         else
 148                 strbuf->pos += (size_t)status;
 149
 150         va_end(aq);
 151         return (ssize_t)status;
 152 } /* sdb_strbuf_vappend */
 153
 154 ssize_t
 155 sdb_strbuf_append(sdb_strbuf_t *strbuf, const char *fmt, ...)
 156 {
 157         va_list ap;
 158         ssize_t status;
 159
 160         va_start(ap, fmt);
 161         status = sdb_strbuf_vappend(strbuf, fmt, ap);
 162         va_end(ap);
 163
 164         return status;
 165 } /* sdb_strbuf_append */
 166
 167 ssize_t
 168 sdb_strbuf_vsprintf(sdb_strbuf_t *strbuf, const char *fmt, va_list ap)
 169 {
 170         if (! strbuf)
 171                 return -1;
 172
 173         if (strbuf->size) {
 174                 strbuf->string[0] = '\0';
 175                 strbuf->pos = 0;
 176         }
 177
 178         return sdb_strbuf_vappend(strbuf, fmt, ap);
 179 } /* sdb_strbuf_vsprintf */
 180
 181 ssize_t
 182 sdb_strbuf_sprintf(sdb_strbuf_t *strbuf, const char *fmt, ...)
 183 {
 184         va_list ap;
 185         ssize_t status;
 186
 187         va_start(ap, fmt);
 188         status = sdb_strbuf_vsprintf(strbuf, fmt, ap);
 189         va_end(ap);
 190
 191         return status;
 192 } /* sdb_strbuf_sprintf */
 193
 194 ssize_t
 195 sdb_strbuf_memappend(sdb_strbuf_t *strbuf, const void *data, size_t n)
 196 {
 197         if ((! strbuf) || (! data))
 198                 return -1;
 199
 200         assert((strbuf->size == 0) || (strbuf->string[strbuf->pos] == '\0'));
 201
 202         if (strbuf->pos + n + 1 >= strbuf->size) {
 203                 size_t newsize = strbuf->size * 2;
 204
 205                 if (! newsize)
 206                         newsize = 64;
 207                 while (strbuf->pos + n + 1 >= newsize)
 208                         newsize *= 2;
 209
 210                 if (strbuf_resize(strbuf, newsize))
 211                         return -1;
 212         }
 213
 214         assert(strbuf->size && strbuf->string);
 215         assert(strbuf->pos < strbuf->size);
 216
 217         memcpy((void *)(strbuf->string + strbuf->pos), data, n);
 218         strbuf->pos += n;
 219         strbuf->string[strbuf->pos] = '\0';
 220
 221         return (ssize_t)n;
 222 } /* sdb_strbuf_memappend */
 223
 224 ssize_t
 225 sdb_strbuf_memcpy(sdb_strbuf_t *strbuf, const void *data, size_t n)
 226 {
 227         if ((! strbuf) || (! data))
 228                 return -1;
 229
 230         if (strbuf->size) {
 231                 strbuf->string[0] = '\0';
 232                 strbuf->pos = 0;
 233         }
 234
 235         return sdb_strbuf_memappend(strbuf, data, n);
 236 } /* sdb_strbuf_memcpy */
 237
 238 ssize_t
 239 sdb_strbuf_read(sdb_strbuf_t *strbuf, int fd, size_t n)
 240 {
 241         ssize_t ret;
 242
 243         if (! strbuf)
 244                 return -1;
 245
 246         if (strbuf_resize(strbuf, strbuf->pos + n + 1))
 247                 return -1;
 248
 249         ret = read(fd, strbuf->string + strbuf->pos, n);
 250         if (ret > 0)
 251                 strbuf->pos += (size_t)ret;
 252         return ret;
 253 } /* sdb_strbuf_read */
 254
 255 ssize_t
 256 sdb_strbuf_chomp(sdb_strbuf_t *strbuf)
 257 {
 258         ssize_t ret = 0;
 259
 260         if (! strbuf)
 261                 return -1;
 262
 263         assert((!strbuf->size) || (strbuf->pos < strbuf->size));
 264         assert(strbuf->pos <= strbuf->size);
 265
 266         while ((strbuf->pos > 0)
 267                         && (strbuf->string[strbuf->pos - 1] == '\n')) {
 268                 --strbuf->pos;
 269                 strbuf->string[strbuf->pos] = '\0';
 270                 ++ret;
 271         }
 272
 273         return ret;
 274 } /* sdb_strbuf_chomp */
 275
 276 void
 277 sdb_strbuf_skip(sdb_strbuf_t *strbuf, size_t n)
 278 {
 279         if ((! strbuf) || (! n))
 280                 return;
 281
 282         if (n >= strbuf->pos) {
 283                 strbuf->string[0] = '\0';
 284                 strbuf->pos = 0;
 285                 return;
 286         }
 287
 288         assert(n < strbuf->pos);
 289         memmove(strbuf->string, strbuf->string + n, strbuf->pos - n);
 290         strbuf->pos -= n;
 291         strbuf->string[strbuf->pos] = '\0';
 292 } /* sdb_strbuf_skip */
 293
 294 const char *
 295 sdb_strbuf_string(sdb_strbuf_t *strbuf)
 296 {
 297         if (! strbuf)
 298                 return NULL;
 299         if (! strbuf->size)
 300                 return "";
 301         return strbuf->string;
 302 } /* sdb_strbuf_string */
 303
 304 size_t
 305 sdb_strbuf_len(sdb_strbuf_t *strbuf)
 306 {
 307         if (! strbuf)
 308                 return 0;
 309         return strbuf->pos;
 310 } /* sdb_strbuf_string */
 311
 312 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 313