1 /* Licensed under BSD-MIT - see LICENSE file for details */
5 #include <ccan/tal/talloc/talloc.h>
7 #include <ccan/tal/tal.h>
13 * tal_strdup - duplicate a string
14 * @ctx: NULL, or tal allocated object to be parent.
15 * @p: the string to copy (can be take()).
17 char *tal_strdup(const tal_t *ctx, const char *p);
20 * tal_strndup - duplicate a limited amount of a string.
21 * @ctx: NULL, or tal allocated object to be parent.
22 * @p: the string to copy (can be take()).
23 * @n: the maximum length to copy.
25 * Always gives a nul-terminated string, with strlen() <= @n.
27 char *tal_strndup(const tal_t *ctx, const char *p, size_t n);
30 * tal_fmt - allocate a formatted string
31 * @ctx: NULL, or tal allocated object to be parent.
32 * @fmt: the printf-style format (can be take()).
34 char *tal_fmt(const tal_t *ctx, const char *fmt, ...) PRINTF_FMT(2,3);
37 * tal_vfmt - allocate a formatted string (va_list version)
38 * @ctx: NULL, or tal allocated object to be parent.
39 * @fmt: the printf-style format (can be take()).
40 * @va: the va_list containing the format args.
42 char *tal_vfmt(const tal_t *ctx, const char *fmt, va_list ap)
46 * tal_append_fmt - append a formatted string to a talloc string.
47 * @baseptr: a pointer to the tal string to be appended to.
48 * @fmt: the printf-style format (can be take()).
50 * Returns false on allocation failure.
52 bool tal_append_fmt(char **baseptr, const char *fmt, ...) PRINTF_FMT(2,3);
55 * tal_append_vfmt - append a formatted string to a talloc string (va_list)
56 * @baseptr: a pointer to the tal string to be appended to.
57 * @fmt: the printf-style format (can be take()).
58 * @va: the va_list containing the format args.
60 * Returns false on allocation failure.
62 bool tal_append_vfmt(char **baseptr, const char *fmt, va_list ap);
65 * tal_strcat - join two strings together
66 * @ctx: NULL, or tal allocated object to be parent.
67 * @s1: the first string (can be take()).
68 * @s2: the second string (can be take()).
70 char *tal_strcat(const tal_t *ctx, const char *s1, const char *s2);
78 * tal_strsplit - Split string into an array of substrings
79 * @ctx: the context to tal from (often NULL).
80 * @string: the string to split (can be take()).
81 * @delims: delimiters where lines should be split (can be take()).
82 * @flags: whether to include empty substrings.
84 * This function splits a single string into multiple strings.
86 * If @string is take(), the returned array will point into the
89 * Multiple delimiters result in empty substrings. By definition, no
90 * delimiters will appear in the substrings.
92 * The final char * in the array will be NULL, and tal_count() will
93 * return the number of elements plus 1 (for that NULL).
96 * #include <ccan/tal/str/str.h>
98 * static unsigned int count_long_lines(const char *string)
101 * unsigned int i, long_lines = 0;
103 * // Can only fail on out-of-memory.
104 * lines = tal_strsplit(NULL, string, "\n", STR_NO_EMPTY);
105 * for (i = 0; lines[i] != NULL; i++)
106 * if (strlen(lines[i]) > 80)
112 char **tal_strsplit(const tal_t *ctx,
113 const char *string, const char *delims, enum strsplit flag);
121 * tal_strjoin - Join an array of substrings into one long string
122 * @ctx: the context to tal from (often NULL).
123 * @strings: the NULL-terminated array of strings to join (can be take())
124 * @delim: the delimiter to insert between the strings (can be take())
125 * @flags: whether to add a delimieter to the end
127 * This function joins an array of strings into a single string. The
128 * return value is allocated using tal. Each string in @strings is
129 * followed by a copy of @delim.
132 * // Append the string "--EOL" to each line.
133 * static char *append_to_all_lines(const char *string)
135 * char **lines, *ret;
137 * lines = tal_strsplit(NULL, string, "\n", STR_EMPTY_OK);
138 * ret = tal_strjoin(NULL, lines, "-- EOL\n", STR_TRAIL);
143 char *tal_strjoin(const void *ctx, char *strings[], const char *delim,
147 * tal_strreg - match/extract from a string via (extended) regular expressions.
148 * @ctx: the context to tal from (often NULL)
149 * @string: the string to try to match (can be take())
150 * @regex: the regular expression to match (can be take())
151 * ...: pointers to strings to allocate for subexpressions.
153 * Returns true if we matched, in which case any parenthesized
154 * expressions in @regex are allocated and placed in the char **
155 * arguments following @regex. NULL arguments mean the match is not
156 * saved. The order of the strings is the order
157 * of opening braces in the expression: in the case of repeated
158 * expressions (eg "([a-z])*") the last one is saved, in the case of
159 * non-existent matches (eg "([a-z]*)?") the pointer is set to NULL.
161 * Allocation failures or malformed regular expressions return false.
164 * regcomp(3), regex(3).
167 * // Given 'My name is Rusty' outputs 'Hello Rusty!'
168 * // Given 'my first name is Rusty Russell' outputs 'Hello Rusty Russell!'
169 * // Given 'My name isnt Rusty Russell' outputs 'Hello there!'
170 * int main(int argc, char *argv[])
172 * char *person, *input;
174 * // Join args and trim trailing space.
175 * input = tal_strjoin(NULL, argv+1, " ", STR_NO_TRAIL);
176 * if (tal_strreg(NULL, input,
177 * "[Mm]y (first )?name is ([A-Za-z ]+)",
179 * printf("Hello %s!\n", person);
181 * printf("Hello there!\n");
185 bool tal_strreg(const void *ctx, const char *string, const char *regex, ...);
186 #endif /* CCAN_STR_TAL_H */