src/sds.h

   1 /* SDSLib, A C dynamic strings library
   2  *
   3  * Copyright (c) 2006-2010, Salvatore Sanfilippo <antirez at gmail dot com>
   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 are met:
   8  *
   9  *   * Redistributions of source code must retain the above copyright notice,
  10  *     this list of conditions and the following disclaimer.
  11  *   * 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  *   * Neither the name of Redis nor the names of its contributors may be used
  15  *     to endorse or promote products derived from this software without
  16  *     specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef __SDS_H
  32 #define __SDS_H
  33
  34 #include <sys/types.h>
  35 #include <stdarg.h>
  36
  37 typedef char *sds;
  38
  39 struct sdshdr {
  40     int len;
  41     int free;
  42     char buf[];
  43 };
  44
  45 static inline size_t sdslen(const sds s) {
  46     struct sdshdr *sh = (void*)(s-(sizeof(struct sdshdr)));
  47     return sh->len;
  48 }
  49
  50 static inline size_t sdsavail(const sds s) {
  51     struct sdshdr *sh = (void*)(s-(sizeof(struct sdshdr)));
  52     return sh->free;
  53 }
  54
  55 sds sdsnewlen(const void *init, size_t initlen);
  56 sds sdsnew(const char *init);
  57 sds sdsempty();
  58 size_t sdslen(const sds s);
  59 sds sdsdup(const sds s);
  60 void sdsfree(sds s);
  61 size_t sdsavail(sds s);
  62 sds sdsgrowzero(sds s, size_t len);
  63 sds sdscatlen(sds s, void *t, size_t len);
  64 sds sdscat(sds s, char *t);
  65 sds sdscpylen(sds s, char *t, size_t len);
  66 sds sdscpy(sds s, char *t);
  67
  68 sds sdscatvprintf(sds s, const char *fmt, va_list ap);
  69 #ifdef __GNUC__
  70 sds sdscatprintf(sds s, const char *fmt, ...)
  71     __attribute__((format(printf, 2, 3)));
  72 #else
  73 sds sdscatprintf(sds s, const char *fmt, ...);
  74 #endif
  75
  76 sds sdstrim(sds s, const char *cset);
  77 sds sdsrange(sds s, int start, int end);
  78 void sdsupdatelen(sds s);
  79 void sdsclear(sds s);
  80 int sdscmp(sds s1, sds s2);
  81 sds *sdssplitlen(char *s, int len, char *sep, int seplen, int *count);
  82 void sdsfreesplitres(sds *tokens, int count);
  83 void sdstolower(sds s);
  84 void sdstoupper(sds s);
  85 sds sdsfromlonglong(long long value);
  86 sds sdscatrepr(sds s, char *p, size_t len);
  87 sds *sdssplitargs(char *line, int *argc);
  88 void sdssplitargs_free(sds *argv, int argc);
  89 sds sdsmapchars(sds s, char *from, char *to, size_t setlen);
  90
  91 /* Low level functions exposed to the user API */
  92 sds sdsMakeRoomFor(sds s, size_t addlen);
  93 void sdsIncrLen(sds s, int incr);
  94
  95 #endif