X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Ftal%2Fstr%2Fstr.h;h=0fe542cf235eeb9c08119f0de14ced6f6050a0ea;hp=7d0a94541e41b10501ca2076ab6536ffa489d7e1;hb=97d99004bec31012400b6c1d9bad045ae1c9b075;hpb=f103f73ff040a8700a2bbd47948277e7c484baa2 diff --git a/ccan/tal/str/str.h b/ccan/tal/str/str.h index 7d0a9454..0fe542cf 100644 --- a/ccan/tal/str/str.h +++ b/ccan/tal/str/str.h @@ -1,18 +1,81 @@ /* Licensed under BSD-MIT - see LICENSE file for details */ #ifndef CCAN_STR_TAL_H #define CCAN_STR_TAL_H +#ifdef TAL_USE_TALLOC +#include +#else #include -#include +#endif #include #include +/** + * tal_strdup - duplicate a string + * @ctx: NULL, or tal allocated object to be parent. + * @p: the string to copy (can be take()). + */ +char *tal_strdup(const tal_t *ctx, const char *p); + +/** + * tal_strndup - duplicate a limited amount of a string. + * @ctx: NULL, or tal allocated object to be parent. + * @p: the string to copy (can be take()). + * @n: the maximum length to copy. + * + * Always gives a nul-terminated string, with strlen() <= @n. + */ +char *tal_strndup(const tal_t *ctx, const char *p, size_t n); + +/** + * tal_fmt - allocate a formatted string + * @ctx: NULL, or tal allocated object to be parent. + * @fmt: the printf-style format (can be take()). + */ +char *tal_fmt(const tal_t *ctx, const char *fmt, ...) PRINTF_FMT(2,3); + +/** + * tal_vfmt - allocate a formatted string (va_list version) + * @ctx: NULL, or tal allocated object to be parent. + * @fmt: the printf-style format (can be take()). + * @va: the va_list containing the format args. + */ +char *tal_vfmt(const tal_t *ctx, const char *fmt, va_list ap) + PRINTF_FMT(2,0); + +/** + * tal_append_fmt - append a formatted string to a talloc string. + * @baseptr: a pointer to the tal string to be appended to. + * @fmt: the printf-style format (can be take()). + * + * Returns false on allocation failure. + */ +bool tal_append_fmt(char **baseptr, const char *fmt, ...) PRINTF_FMT(2,3); + +/** + * tal_append_vfmt - append a formatted string to a talloc string (va_list) + * @baseptr: a pointer to the tal string to be appended to. + * @fmt: the printf-style format (can be take()). + * @va: the va_list containing the format args. + * + * Returns false on allocation failure. + */ +bool tal_append_vfmt(char **baseptr, const char *fmt, va_list ap); + +/** + * tal_strcat - join two strings together + * @ctx: NULL, or tal allocated object to be parent. + * @s1: the first string (can be take()). + * @s2: the second string (can be take()). + */ +char *tal_strcat(const tal_t *ctx, const char *s1, const char *s2); + enum strsplit { STR_EMPTY_OK, STR_NO_EMPTY }; /** - * strsplit - Split string into an array of substrings + * tal_strsplit - Split string into an array of substrings * @ctx: the context to tal from (often NULL). * @string: the string to split (can be take()). * @delims: delimiters where lines should be split (can be take()). @@ -26,7 +89,8 @@ enum strsplit { * Multiple delimiters result in empty substrings. By definition, no * delimiters will appear in the substrings. * - * The final char * in the array will be NULL. + * The final char * in the array will be NULL, and tal_count() will + * return the number of elements plus 1 (for that NULL). * * Example: * #include @@ -37,7 +101,7 @@ enum strsplit { * unsigned int i, long_lines = 0; * * // Can only fail on out-of-memory. - * lines = strsplit(NULL, string, "\n", STR_NO_EMPTY); + * lines = tal_strsplit(NULL, string, "\n", STR_NO_EMPTY); * for (i = 0; lines[i] != NULL; i++) * if (strlen(lines[i]) > 80) * long_lines++; @@ -45,8 +109,8 @@ enum strsplit { * return long_lines; * } */ -char **strsplit(const tal_t *ctx, - const char *string, const char *delims, enum strsplit flags); +char **tal_strsplit(const tal_t *ctx, + const char *string, const char *delims, enum strsplit flag); enum strjoin { STR_TRAIL, @@ -54,7 +118,7 @@ enum strjoin { }; /** - * strjoin - Join an array of substrings into one long string + * tal_strjoin - Join an array of substrings into one long string * @ctx: the context to tal from (often NULL). * @strings: the NULL-terminated array of strings to join (can be take()) * @delim: the delimiter to insert between the strings (can be take()) @@ -70,17 +134,17 @@ enum strjoin { * { * char **lines, *ret; * - * lines = strsplit(NULL, string, "\n", STR_EMPTY_OK); - * ret = strjoin(NULL, lines, "-- EOL\n", STR_TRAIL); + * lines = tal_strsplit(NULL, string, "\n", STR_EMPTY_OK); + * ret = tal_strjoin(NULL, lines, "-- EOL\n", STR_TRAIL); * tal_free(lines); * return ret; * } */ -char *strjoin(const void *ctx, char *strings[], const char *delim, - enum strjoin flags); +char *tal_strjoin(const void *ctx, char *strings[], const char *delim, + enum strjoin flags); /** - * strreg - match and extract from a string via (extended) regular expressions. + * tal_strreg - match/extract from a string via (extended) regular expressions. * @ctx: the context to tal from (often NULL) * @string: the string to try to match (can be take()) * @regex: the regular expression to match (can be take()) @@ -108,14 +172,15 @@ char *strjoin(const void *ctx, char *strings[], const char *delim, * char *person, *input; * * // Join args and trim trailing space. - * input = strjoin(NULL, argv+1, " ", STR_NO_TRAIL); - * if (strreg(NULL, input, "[Mm]y (first )?name is ([A-Za-z ]+)", - * NULL, &person)) + * input = tal_strjoin(NULL, argv+1, " ", STR_NO_TRAIL); + * if (tal_strreg(NULL, input, + * "[Mm]y (first )?name is ([A-Za-z ]+)", + * NULL, &person)) * printf("Hello %s!\n", person); * else * printf("Hello there!\n"); * return 0; * } */ -bool strreg(const void *ctx, const char *string, const char *regex, ...); +bool tal_strreg(const void *ctx, const char *string, const char *regex, ...); #endif /* CCAN_STR_TAL_H */