lib/sds.h

   1 /* SDS (Simple Dynamic Strings), A C dynamic strings library.
   2  *
   3  * Copyright (c) 2006-2014, 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 #ifndef __GNUC__
  35 #  undef __attribute__
  36 #  define __attribute__(x) /* nothing */
  37 #endif
  38
  39 #define SDS_MAX_PREALLOC (1024*1024)
  40
  41 #include <stddef.h>
  42 #include <sys/types.h>
  43 #include <stdarg.h>
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 typedef char *sds;
  50
  51 /* This is a dummy structure to compute `len' and `free' offsets, not to be
  52  * used by applications.  The original structure, `sdshdr' (defined in
  53  * `sds.c') uses a flexible array member for `buf', making it invalid for
  54  * C++.  Assuming that both C and C++ code gets compiled by the same compiler
  55  * suite, the replacement below should give the same offsets so that `sdslen'
  56  * and `sdavail' can stay as inline definitions. */
  57 struct sdshdr_h_ {
  58     int len;
  59     int free;
  60     char buf[1000];
  61 };
  62
  63 static inline size_t sdslen(const sds s) {
  64     struct sdshdr_h_ *sh = (struct sdshdr_h_*)
  65                              (s-(int)offsetof(struct sdshdr_h_, buf));
  66
  67     if (s == NULL) return 0;
  68     return sh->len;
  69 }
  70
  71 static inline size_t sdsavail(const sds s) {
  72     struct sdshdr_h_ *sh = (struct sdshdr_h_*)
  73                              (s-(int)offsetof(struct sdshdr_h_, buf));
  74
  75     if (s == NULL) return 0;
  76     return sh->free;
  77 }
  78
  79 sds sdsnewlen(const void *init, size_t initlen);
  80 sds sdsnew(const char *init);
  81 sds sdsempty(void);
  82 size_t sdslen(const sds s);
  83 sds sdsdup(const sds s);
  84 void sdsfree(sds s);
  85 size_t sdsavail(const sds s);
  86 sds sdsgrowzero(sds s, size_t len);
  87 sds sdscatlen(sds s, const void *t, size_t len);
  88 sds sdscat(sds s, const char *t);
  89 sds sdscatsds(sds s, const sds t);
  90 sds sdscpylen(sds s, const char *t, size_t len);
  91 sds sdscpy(sds s, const char *t);
  92
  93 sds sdscatvprintf(sds s, const char *fmt, va_list ap);
  94 sds sdscatprintf(sds s, const char *fmt, ...)
  95     __attribute__((format(printf, 2, 3)));
  96
  97 void sdstrim(sds s, const char *cset);
  98 void sdsrange(sds s, int start, int end);
  99 void sdsupdatelen(sds s);
 100 void sdsclear(sds s);
 101 int sdscmp(const sds s1, const sds s2);
 102 sds *sdssplitlen(const char *s, int len, const char *sep, int seplen, int *count)
 103     __attribute__((warn_unused_result));
 104 void sdsfreesplitres(sds *tokens, int count);
 105 void sdstolower(sds s);
 106 void sdstoupper(sds s);
 107 sds sdsfromlonglong(long long value);
 108 sds sdscatrepr(sds s, const char *p, size_t len);
 109 sds *sdssplitargs(const char *line, int *argc)
 110     __attribute__((warn_unused_result));
 111 sds sdsmapchars(sds s, const char *from, const char *to, size_t setlen);
 112 sds sdsjoin(char **argv, int argc, char *sep, size_t seplen);
 113 sds sdsjoinsds(sds *argv, int argc, const char *sep, size_t seplen);
 114
 115 /* Low level functions exposed to the user API */
 116 sds sdsMakeRoomFor(sds s, size_t addlen)
 117     __attribute__((warn_unused_result));
 118 void sdsIncrLen(sds s, int incr);
 119 sds sdsRemoveFreeSpace(sds s)
 120     __attribute__((warn_unused_result));
 121 size_t sdsAllocSize(sds s);
 122
 123 #ifdef __cplusplus
 124 } /* extern "C" */
 125 #endif
 126
 127 #endif