xref: /redis-3.2.3/src/sds.h (revision 4942145d)
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 sds sdsnewlen(const void *init, size_t initlen);
46 sds sdsnew(const char *init);
47 sds sdsempty();
48 size_t sdslen(const sds s);
49 sds sdsdup(const sds s);
50 void sdsfree(sds s);
51 size_t sdsavail(sds s);
52 sds sdsgrowzero(sds s, size_t len);
53 sds sdscatlen(sds s, void *t, size_t len);
54 sds sdscat(sds s, char *t);
55 sds sdscpylen(sds s, char *t, size_t len);
56 sds sdscpy(sds s, char *t);
57 
58 sds sdscatvprintf(sds s, const char *fmt, va_list ap);
59 #ifdef __GNUC__
60 sds sdscatprintf(sds s, const char *fmt, ...)
61     __attribute__((format(printf, 2, 3)));
62 #else
63 sds sdscatprintf(sds s, const char *fmt, ...);
64 #endif
65 
66 sds sdstrim(sds s, const char *cset);
67 sds sdsrange(sds s, int start, int end);
68 void sdsupdatelen(sds s);
69 int sdscmp(sds s1, sds s2);
70 sds *sdssplitlen(char *s, int len, char *sep, int seplen, int *count);
71 void sdsfreesplitres(sds *tokens, int count);
72 void sdstolower(sds s);
73 void sdstoupper(sds s);
74 sds sdsfromlonglong(long long value);
75 sds sdscatrepr(sds s, char *p, size_t len);
76 sds *sdssplitargs(char *line, int *argc);
77 
78 #endif
79