]>
git.saurik.com Git - redis.git/blob - src/sds.c
fc104a4a087674631385bcf74779fa9e5d8a4607
1 /* SDSLib, A C dynamic strings library
3 * Copyright (c) 2006-2010, Salvatore Sanfilippo <antirez at gmail dot com>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
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.
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.
32 * - 22 March 2011: History section created on top of sds.c
33 * - 22 March 2011: Fixed a problem with "\xab" escapes convertion in
34 * function sdssplitargs().
37 #define SDS_ABORT_ON_OOM
46 static void sdsOomAbort(void) {
47 fprintf(stderr
,"SDS: Out Of Memory (SDS_ABORT_ON_OOM defined)\n");
51 sds
sdsnewlen(const void *init
, size_t initlen
) {
55 sh
= zmalloc(sizeof(struct sdshdr
)+initlen
+1);
57 sh
= zcalloc(sizeof(struct sdshdr
)+initlen
+1);
59 #ifdef SDS_ABORT_ON_OOM
60 if (sh
== NULL
) sdsOomAbort();
62 if (sh
== NULL
) return NULL
;
67 memcpy(sh
->buf
, init
, initlen
);
68 sh
->buf
[initlen
] = '\0';
69 return (char*)sh
->buf
;
73 return sdsnewlen("",0);
76 sds
sdsnew(const char *init
) {
77 size_t initlen
= (init
== NULL
) ? 0 : strlen(init
);
78 return sdsnewlen(init
, initlen
);
81 sds
sdsdup(const sds s
) {
82 return sdsnewlen(s
, sdslen(s
));
86 if (s
== NULL
) return;
87 zfree(s
-sizeof(struct sdshdr
));
90 void sdsupdatelen(sds s
) {
91 struct sdshdr
*sh
= (void*) (s
-(sizeof(struct sdshdr
)));
92 int reallen
= strlen(s
);
93 sh
->free
+= (sh
->len
-reallen
);
97 void sdsclear(sds s
) {
98 struct sdshdr
*sh
= (void*) (s
-(sizeof(struct sdshdr
)));
104 /* Enlarge the free space at the end of the sds string so that the caller
105 * is sure that after calling this function can overwrite up to addlen
106 * bytes after the end of the string, plus one more byte for nul term.
108 * Note: this does not change the *size* of the sds string as returned
109 * by sdslen(), but only the free buffer space we have. */
110 static sds
sdsMakeRoomFor(sds s
, size_t addlen
) {
111 struct sdshdr
*sh
, *newsh
;
112 size_t free
= sdsavail(s
);
115 if (free
>= addlen
) return s
;
117 sh
= (void*) (s
-(sizeof(struct sdshdr
)));
118 newlen
= (len
+addlen
)*2;
119 newsh
= zrealloc(sh
, sizeof(struct sdshdr
)+newlen
+1);
120 #ifdef SDS_ABORT_ON_OOM
121 if (newsh
== NULL
) sdsOomAbort();
123 if (newsh
== NULL
) return NULL
;
126 newsh
->free
= newlen
- len
;
130 /* Grow the sds to have the specified length. Bytes that were not part of
131 * the original length of the sds will be set to zero. */
132 sds
sdsgrowzero(sds s
, size_t len
) {
133 struct sdshdr
*sh
= (void*)(s
-(sizeof(struct sdshdr
)));
134 size_t totlen
, curlen
= sh
->len
;
136 if (len
<= curlen
) return s
;
137 s
= sdsMakeRoomFor(s
,len
-curlen
);
138 if (s
== NULL
) return NULL
;
140 /* Make sure added region doesn't contain garbage */
141 sh
= (void*)(s
-(sizeof(struct sdshdr
)));
142 memset(s
+curlen
,0,(len
-curlen
+1)); /* also set trailing \0 byte */
143 totlen
= sh
->len
+sh
->free
;
145 sh
->free
= totlen
-sh
->len
;
149 sds
sdscatlen(sds s
, void *t
, size_t len
) {
151 size_t curlen
= sdslen(s
);
153 s
= sdsMakeRoomFor(s
,len
);
154 if (s
== NULL
) return NULL
;
155 sh
= (void*) (s
-(sizeof(struct sdshdr
)));
156 memcpy(s
+curlen
, t
, len
);
157 sh
->len
= curlen
+len
;
158 sh
->free
= sh
->free
-len
;
159 s
[curlen
+len
] = '\0';
163 sds
sdscat(sds s
, char *t
) {
164 return sdscatlen(s
, t
, strlen(t
));
167 sds
sdscpylen(sds s
, char *t
, size_t len
) {
168 struct sdshdr
*sh
= (void*) (s
-(sizeof(struct sdshdr
)));
169 size_t totlen
= sh
->free
+sh
->len
;
172 s
= sdsMakeRoomFor(s
,len
-sh
->len
);
173 if (s
== NULL
) return NULL
;
174 sh
= (void*) (s
-(sizeof(struct sdshdr
)));
175 totlen
= sh
->free
+sh
->len
;
180 sh
->free
= totlen
-len
;
184 sds
sdscpy(sds s
, char *t
) {
185 return sdscpylen(s
, t
, strlen(t
));
188 sds
sdscatvprintf(sds s
, const char *fmt
, va_list ap
) {
194 buf
= zmalloc(buflen
);
195 #ifdef SDS_ABORT_ON_OOM
196 if (buf
== NULL
) sdsOomAbort();
198 if (buf
== NULL
) return NULL
;
200 buf
[buflen
-2] = '\0';
202 vsnprintf(buf
, buflen
, fmt
, cpy
);
203 if (buf
[buflen
-2] != '\0') {
215 sds
sdscatprintf(sds s
, const char *fmt
, ...) {
219 t
= sdscatvprintf(s
,fmt
,ap
);
224 sds
sdstrim(sds s
, const char *cset
) {
225 struct sdshdr
*sh
= (void*) (s
-(sizeof(struct sdshdr
)));
226 char *start
, *end
, *sp
, *ep
;
230 ep
= end
= s
+sdslen(s
)-1;
231 while(sp
<= end
&& strchr(cset
, *sp
)) sp
++;
232 while(ep
> start
&& strchr(cset
, *ep
)) ep
--;
233 len
= (sp
> ep
) ? 0 : ((ep
-sp
)+1);
234 if (sh
->buf
!= sp
) memmove(sh
->buf
, sp
, len
);
236 sh
->free
= sh
->free
+(sh
->len
-len
);
241 sds
sdsrange(sds s
, int start
, int end
) {
242 struct sdshdr
*sh
= (void*) (s
-(sizeof(struct sdshdr
)));
243 size_t newlen
, len
= sdslen(s
);
245 if (len
== 0) return s
;
248 if (start
< 0) start
= 0;
252 if (end
< 0) end
= 0;
254 newlen
= (start
> end
) ? 0 : (end
-start
)+1;
256 if (start
>= (signed)len
) {
258 } else if (end
>= (signed)len
) {
260 newlen
= (start
> end
) ? 0 : (end
-start
)+1;
265 if (start
&& newlen
) memmove(sh
->buf
, sh
->buf
+start
, newlen
);
267 sh
->free
= sh
->free
+(sh
->len
-newlen
);
272 void sdstolower(sds s
) {
273 int len
= sdslen(s
), j
;
275 for (j
= 0; j
< len
; j
++) s
[j
] = tolower(s
[j
]);
278 void sdstoupper(sds s
) {
279 int len
= sdslen(s
), j
;
281 for (j
= 0; j
< len
; j
++) s
[j
] = toupper(s
[j
]);
284 int sdscmp(sds s1
, sds s2
) {
285 size_t l1
, l2
, minlen
;
290 minlen
= (l1
< l2
) ? l1
: l2
;
291 cmp
= memcmp(s1
,s2
,minlen
);
292 if (cmp
== 0) return l1
-l2
;
296 /* Split 's' with separator in 'sep'. An array
297 * of sds strings is returned. *count will be set
298 * by reference to the number of tokens returned.
300 * On out of memory, zero length string, zero length
301 * separator, NULL is returned.
303 * Note that 'sep' is able to split a string using
304 * a multi-character separator. For example
305 * sdssplit("foo_-_bar","_-_"); will return two
306 * elements "foo" and "bar".
308 * This version of the function is binary-safe but
309 * requires length arguments. sdssplit() is just the
310 * same function but for zero-terminated strings.
312 sds
*sdssplitlen(char *s
, int len
, char *sep
, int seplen
, int *count
) {
313 int elements
= 0, slots
= 5, start
= 0, j
;
316 if (seplen
< 1 || len
< 0) return NULL
;
318 tokens
= zmalloc(sizeof(sds
)*slots
);
319 #ifdef SDS_ABORT_ON_OOM
320 if (tokens
== NULL
) sdsOomAbort();
322 if (tokens
== NULL
) return NULL
;
329 for (j
= 0; j
< (len
-(seplen
-1)); j
++) {
330 /* make sure there is room for the next element and the final one */
331 if (slots
< elements
+2) {
335 newtokens
= zrealloc(tokens
,sizeof(sds
)*slots
);
336 if (newtokens
== NULL
) {
337 #ifdef SDS_ABORT_ON_OOM
345 /* search the separator */
346 if ((seplen
== 1 && *(s
+j
) == sep
[0]) || (memcmp(s
+j
,sep
,seplen
) == 0)) {
347 tokens
[elements
] = sdsnewlen(s
+start
,j
-start
);
348 if (tokens
[elements
] == NULL
) {
349 #ifdef SDS_ABORT_ON_OOM
357 j
= j
+seplen
-1; /* skip the separator */
360 /* Add the final element. We are sure there is room in the tokens array. */
361 tokens
[elements
] = sdsnewlen(s
+start
,len
-start
);
362 if (tokens
[elements
] == NULL
) {
363 #ifdef SDS_ABORT_ON_OOM
373 #ifndef SDS_ABORT_ON_OOM
377 for (i
= 0; i
< elements
; i
++) sdsfree(tokens
[i
]);
385 void sdsfreesplitres(sds
*tokens
, int count
) {
388 sdsfree(tokens
[count
]);
392 sds
sdsfromlonglong(long long value
) {
394 unsigned long long v
;
396 v
= (value
< 0) ? -value
: value
;
397 p
= buf
+31; /* point to the last character */
402 if (value
< 0) *p
-- = '-';
404 return sdsnewlen(p
,32-(p
-buf
));
407 sds
sdscatrepr(sds s
, char *p
, size_t len
) {
408 s
= sdscatlen(s
,"\"",1);
413 s
= sdscatprintf(s
,"\\%c",*p
);
415 case '\n': s
= sdscatlen(s
,"\\n",2); break;
416 case '\r': s
= sdscatlen(s
,"\\r",2); break;
417 case '\t': s
= sdscatlen(s
,"\\t",2); break;
418 case '\a': s
= sdscatlen(s
,"\\a",2); break;
419 case '\b': s
= sdscatlen(s
,"\\b",2); break;
422 s
= sdscatprintf(s
,"%c",*p
);
424 s
= sdscatprintf(s
,"\\x%02x",(unsigned char)*p
);
429 return sdscatlen(s
,"\"",1);
432 /* Helper function for sdssplitargs() that returns non zero if 'c'
433 * is a valid hex digit. */
434 int is_hex_digit(char c
) {
435 return (c
>= '0' && c
<= '9') || (c
>= 'a' && c
<= 'f') ||
436 (c
>= 'A' && c
<= 'F');
439 /* Helper function for sdssplitargs() that converts an hex digit into an
440 * integer from 0 to 15 */
441 int hex_digit_to_int(char c
) {
453 case 'a': case 'A': return 10;
454 case 'b': case 'B': return 11;
455 case 'c': case 'C': return 12;
456 case 'd': case 'D': return 13;
457 case 'e': case 'E': return 14;
458 case 'f': case 'F': return 15;
463 /* Split a line into arguments, where every argument can be in the
464 * following programming-language REPL-alike form:
466 * foo bar "newline are supported\n" and "\xff\x00otherstuff"
468 * The number of arguments is stored into *argc, and an array
469 * of sds is returned. The caller should sdsfree() all the returned
470 * strings and finally zfree() the array itself.
472 * Note that sdscatrepr() is able to convert back a string into
473 * a quoted string in the same format sdssplitargs() is able to parse.
475 sds
*sdssplitargs(char *line
, int *argc
) {
477 char *current
= NULL
;
478 char **vector
= NULL
;
483 while(*p
&& isspace(*p
)) p
++;
486 int inq
=0; /* set to 1 if we are in "quotes" */
487 int insq
=0; /* set to 1 if we are in 'single quotes' */
490 if (current
== NULL
) current
= sdsempty();
493 if (*p
== '\\' && *(p
+1) == 'x' &&
494 is_hex_digit(*(p
+2)) &&
495 is_hex_digit(*(p
+3)))
499 byte
= (hex_digit_to_int(*(p
+2))*16)+
500 hex_digit_to_int(*(p
+3));
501 current
= sdscatlen(current
,(char*)&byte
,1);
503 } else if (*p
== '\\' && *(p
+1)) {
508 case 'n': c
= '\n'; break;
509 case 'r': c
= '\r'; break;
510 case 't': c
= '\t'; break;
511 case 'b': c
= '\b'; break;
512 case 'a': c
= '\a'; break;
513 default: c
= *p
; break;
515 current
= sdscatlen(current
,&c
,1);
516 } else if (*p
== '"') {
517 /* closing quote must be followed by a space or
519 if (*(p
+1) && !isspace(*(p
+1))) goto err
;
522 /* unterminated quotes */
525 current
= sdscatlen(current
,p
,1);
528 if (*p
== '\\' && *(p
+1) == '\'') {
530 current
= sdscatlen(current
,"'",1);
531 } else if (*p
== '\'') {
532 /* closing quote must be followed by a space or
534 if (*(p
+1) && !isspace(*(p
+1))) goto err
;
537 /* unterminated quotes */
540 current
= sdscatlen(current
,p
,1);
558 current
= sdscatlen(current
,p
,1);
564 /* add the token to the vector */
565 vector
= zrealloc(vector
,((*argc
)+1)*sizeof(char*));
566 vector
[*argc
] = current
;
576 sdsfree(vector
[*argc
]);
578 if (current
) sdsfree(current
);
582 void sdssplitargs_free(sds
*argv
, int argc
) {
585 for (j
= 0 ;j
< argc
; j
++) sdsfree(argv
[j
]);
589 /* Modify the string substituting all the occurrences of the set of
590 * characters specifed in the 'from' string to the corresponding character
593 * For instance: sdsmapchars(mystring, "ho", "01", 2)
594 * will have the effect of turning the string "hello" into "0ell1".
596 * The function returns the sds string pointer, that is always the same
597 * as the input pointer since no resize is needed. */
598 sds
sdsmapchars(sds s
, char *from
, char *to
, size_t setlen
) {
599 size_t j
, i
, l
= sdslen(s
);
601 for (j
= 0; j
< l
; j
++) {
602 for (i
= 0; i
< setlen
; i
++) {
603 if (s
[j
] == from
[i
]) {
614 #include "testhelp.h"
618 sds x
= sdsnew("foo"), y
;
620 test_cond("Create a string and obtain the length",
621 sdslen(x
) == 3 && memcmp(x
,"foo\0",4) == 0)
624 x
= sdsnewlen("foo",2);
625 test_cond("Create a string with specified length",
626 sdslen(x
) == 2 && memcmp(x
,"fo\0",3) == 0)
629 test_cond("Strings concatenation",
630 sdslen(x
) == 5 && memcmp(x
,"fobar\0",6) == 0);
633 test_cond("sdscpy() against an originally longer string",
634 sdslen(x
) == 1 && memcmp(x
,"a\0",2) == 0)
636 x
= sdscpy(x
,"xyzxxxxxxxxxxyyyyyyyyyykkkkkkkkkk");
637 test_cond("sdscpy() against an originally shorter string",
639 memcmp(x
,"xyzxxxxxxxxxxyyyyyyyyyykkkkkkkkkk\0",33) == 0)
642 x
= sdscatprintf(sdsempty(),"%d",123);
643 test_cond("sdscatprintf() seems working in the base case",
644 sdslen(x
) == 3 && memcmp(x
,"123\0",4) ==0)
647 x
= sdstrim(sdsnew("xxciaoyyy"),"xy");
648 test_cond("sdstrim() correctly trims characters",
649 sdslen(x
) == 4 && memcmp(x
,"ciao\0",5) == 0)
651 y
= sdsrange(sdsdup(x
),1,1);
652 test_cond("sdsrange(...,1,1)",
653 sdslen(y
) == 1 && memcmp(y
,"i\0",2) == 0)
656 y
= sdsrange(sdsdup(x
),1,-1);
657 test_cond("sdsrange(...,1,-1)",
658 sdslen(y
) == 3 && memcmp(y
,"iao\0",4) == 0)
661 y
= sdsrange(sdsdup(x
),-2,-1);
662 test_cond("sdsrange(...,-2,-1)",
663 sdslen(y
) == 2 && memcmp(y
,"ao\0",3) == 0)
666 y
= sdsrange(sdsdup(x
),2,1);
667 test_cond("sdsrange(...,2,1)",
668 sdslen(y
) == 0 && memcmp(y
,"\0",1) == 0)
671 y
= sdsrange(sdsdup(x
),1,100);
672 test_cond("sdsrange(...,1,100)",
673 sdslen(y
) == 3 && memcmp(y
,"iao\0",4) == 0)
676 y
= sdsrange(sdsdup(x
),100,100);
677 test_cond("sdsrange(...,100,100)",
678 sdslen(y
) == 0 && memcmp(y
,"\0",1) == 0)
684 test_cond("sdscmp(foo,foa)", sdscmp(x
,y
) > 0)
690 test_cond("sdscmp(bar,bar)", sdscmp(x
,y
) == 0)
696 test_cond("sdscmp(bar,bar)", sdscmp(x
,y
) < 0)