1 /* xbt_str.cpp - various helping functions to deal with strings */
3 /* Copyright (c) 2007-2019. The SimGrid Team. All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
8 #include "simgrid/Exception.hpp"
10 #include "xbt/str.h" /* headers of these functions */
12 /** @brief Splits a string into a dynar of strings
14 * @param s: the string to split
15 * @param sep: a string of all chars to consider as separator.
17 * By default (with sep=nullptr), these characters are used as separator:
19 * - " " (ASCII 32 (0x20)) space.
20 * - "\t" (ASCII 9 (0x09)) tab.
21 * - "\n" (ASCII 10 (0x0A)) line feed.
22 * - "\r" (ASCII 13 (0x0D)) carriage return.
23 * - "\0" (ASCII 0 (0x00)) nullptr.
24 * - "\x0B" (ASCII 11 (0x0B)) vertical tab.
26 xbt_dynar_t xbt_str_split(const char *s, const char *sep)
28 xbt_dynar_t res = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
29 const char *sep_dflt = " \t\n\r\x0B";
30 char is_sep[256] = { 1, 0 };
32 /* check what are the separators */
33 memset(is_sep, 0, sizeof(is_sep));
36 is_sep[(unsigned char) *sep_dflt++] = 1;
39 is_sep[(unsigned char) *sep++] = 1;
41 is_sep[0] = 1; /* End of string is also separator */
53 while (not is_sep[(unsigned char)*q]) {
59 topush = (char*) xbt_malloc(q - p + 1);
60 memcpy(topush, p, q - p);
62 xbt_dynar_push(res, &topush);
69 /** @brief Just like @ref xbt_str_split_quoted (Splits a string into a dynar of strings), but without memory allocation
71 * The string passed as argument must be writable (not const)
72 * The elements of the dynar are just parts of the string passed as argument.
73 * So if you don't store that argument elsewhere, you should free it in addition to freeing the dynar. This can be done
74 * by simply freeing the first argument of the dynar:
75 * free(xbt_dynar_get_ptr(dynar,0));
77 * Actually this function puts a bunch of \0 in the memory area you passed as argument to separate the elements, and
78 * pushes the address of each chunk in the resulting dynar. Yes, that's uneven. Yes, that's gory. But that's efficient.
80 xbt_dynar_t xbt_str_split_quoted_in_place(char *s) {
81 xbt_dynar_t res = xbt_dynar_new(sizeof(char *), nullptr);
83 char* end; /* pointers around the parsed chunk */
84 int in_simple_quote = 0;
85 int in_double_quote = 0;
87 int ctn = 0; /* Got something in this block */
94 /* do not trim leading spaces: caller responsibility to clean his cruft */
101 /* Protected char; move it closer */
102 memmove(end, end + 1, strlen(end));
104 THROWF(arg_error, 0, "String ends with \\");
105 end++; /* Pass the protected char */
109 if (not in_double_quote) {
110 in_simple_quote = not in_simple_quote;
111 memmove(end, end + 1, strlen(end));
113 /* simple quote protected by double ones */
119 if (not in_simple_quote) {
120 in_double_quote = not in_double_quote;
121 memmove(end, end + 1, strlen(end));
123 /* double quote protected by simple ones */
131 if (*end == '\0' && (in_simple_quote || in_double_quote)) {
132 THROWF(arg_error, 0, "End of string found while searching for %c in %s", (in_simple_quote ? '\'' : '"'), s);
134 if (in_simple_quote || in_double_quote) {
142 /* Found a separator. Push the string if contains something */
143 xbt_dynar_push(res, &beg);
151 /* trim within the string, manually to speed things up */
165 /** @brief Splits a string into a dynar of strings, taking quotes into account
167 * It basically does the same argument separation than the shell, where white spaces can be escaped and where arguments
168 * are never split within a quote group.
169 * Several subsequent spaces are ignored (unless within quotes, of course).
170 * You may want to trim the input string, if you want to avoid empty entries
172 xbt_dynar_t xbt_str_split_quoted(const char *s)
174 xbt_dynar_t res = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
176 char *str_to_free; /* we have to copy the string before, to handle backslashes */
182 str_to_free = xbt_strdup(s);
184 parsed = xbt_str_split_quoted_in_place(str_to_free);
185 xbt_dynar_foreach(parsed,cursor,p) {
186 char *q=xbt_strdup(p);
187 xbt_dynar_push(res,&q);
189 xbt_free(str_to_free);
190 xbt_dynar_shrink(res, 0);
191 xbt_dynar_free(&parsed);
195 /** @brief Join a set of strings as a single string
197 * The parameter must be a nullptr-terminated array of chars,
198 * just like xbt_dynar_to_array() produces
200 char *xbt_str_join_array(const char *const *strs, const char *sep)
202 int amount_strings=0;
205 if ((not strs) || (not strs[0]))
206 return xbt_strdup("");
208 /* compute the length before malloc */
209 for (int i = 0; strs[i]; i++) {
210 len += strlen(strs[i]);
213 len += strlen(sep) * amount_strings;
216 char* res = (char*)xbt_malloc(len);
218 for (int i = 0; strs[i]; i++) {
219 if (i != 0) { // not first loop
220 q += snprintf(q,len, "%s%s", sep, strs[i]);
222 q += snprintf(q,len, "%s",strs[i]);
228 /** @brief Parse an integer out of a string, or raise an error
230 * The @a str is passed as argument to your @a error_msg, as follows:
231 * @verbatim THROWF(arg_error, 0, error_msg, str); @endverbatim
233 long int xbt_str_parse_int(const char* str, const char* error_msg)
236 if (str == nullptr || str[0] == '\0')
237 THROWF(arg_error, 0, error_msg, str);
239 long int res = strtol(str, &endptr, 10);
240 if (endptr[0] != '\0')
241 THROWF(arg_error, 0, error_msg, str);
246 /** @brief Parse a double out of a string, or raise an error
248 * The @a str is passed as argument to your @a error_msg, as follows:
249 * @verbatim THROWF(arg_error, 0, error_msg, str); @endverbatim
251 double xbt_str_parse_double(const char* str, const char* error_msg)
254 if (str == nullptr || str[0] == '\0')
255 THROWF(arg_error, 0, error_msg, str);
257 double res = strtod(str, &endptr);
258 if (endptr[0] != '\0')
259 THROWF(arg_error, 0, error_msg, str);
265 #include "simgrid/Exception.hpp"
268 XBT_TEST_SUITE("xbt_str", "String Handling");
270 #define mytest(name, input, expected) \
271 xbt_test_add(name); \
272 a = static_cast<char**>(xbt_dynar_to_array(xbt_str_split_quoted(input))); \
273 s = xbt_str_join_array(a, "XXX"); \
274 xbt_test_assert(not strcmp(s, expected), "Input (%s) leads to (%s) instead of (%s)", input, s, expected); \
276 for (int i = 0; a[i] != nullptr; i++) \
279 XBT_TEST_UNIT("xbt_str_split_quoted", test_split_quoted, "Test the function xbt_str_split_quoted")
284 mytest("Empty", "", "");
285 mytest("Basic test", "toto tutu", "totoXXXtutu");
286 mytest("Useless backslashes", "\\t\\o\\t\\o \\t\\u\\t\\u", "totoXXXtutu");
287 mytest("Protected space", "toto\\ tutu", "toto tutu");
288 mytest("Several spaces", "toto tutu", "totoXXXtutu");
289 mytest("LTriming", " toto tatu", "totoXXXtatu");
290 mytest("Triming", " toto tutu ", "totoXXXtutu");
291 mytest("Single quotes", "'toto tutu' tata", "toto tutuXXXtata");
292 mytest("Double quotes", "\"toto tutu\" tata", "toto tutuXXXtata");
293 mytest("Mixed quotes", "\"toto' 'tutu\" tata", "toto' 'tutuXXXtata");
294 mytest("Backslashed quotes", "\\'toto tutu\\' tata", "'totoXXXtutu'XXXtata");
295 mytest("Backslashed quotes + quotes", "'toto \\'tutu' tata", "toto 'tutuXXXtata");
298 #define test_parse_error(function, name, variable, str) \
300 xbt_test_add(name); \
302 variable = function(str, "Parse error"); \
303 xbt_test_fail("The test '%s' did not detect the problem",name ); \
304 } catch(xbt_ex& e) { \
305 if (e.category != arg_error) { \
306 xbt_test_exception(e); \
310 #define test_parse_ok(function, name, variable, str, value) \
312 xbt_test_add(name); \
314 variable = function(str, "Parse error"); \
315 } catch(xbt_ex& e) { \
316 xbt_test_exception(e); \
318 xbt_test_assert(variable == value, "Fail to parse '%s'", str); \
321 XBT_TEST_UNIT("xbt_str_parse", test_parse, "Test the parsing functions")
324 test_parse_ok(xbt_str_parse_int, "Parse int", rint, "42", 42);
325 test_parse_ok(xbt_str_parse_int, "Parse 0 as an int", rint, "0", 0);
326 test_parse_ok(xbt_str_parse_int, "Parse -1 as an int", rint, "-1", -1);
328 test_parse_error(xbt_str_parse_int, "Parse int + noise", rint, "342 cruft");
329 test_parse_error(xbt_str_parse_int, "Parse nullptr as an int", rint, nullptr);
330 test_parse_error(xbt_str_parse_int, "Parse '' as an int", rint, "");
331 test_parse_error(xbt_str_parse_int, "Parse cruft as an int", rint, "cruft");
333 double rdouble = -9999;
334 test_parse_ok(xbt_str_parse_double, "Parse 42 as a double", rdouble, "42", 42);
335 test_parse_ok(xbt_str_parse_double, "Parse 42.5 as a double", rdouble, "42.5", 42.5);
336 test_parse_ok(xbt_str_parse_double, "Parse 0 as a double", rdouble, "0", 0);
337 test_parse_ok(xbt_str_parse_double, "Parse -1 as a double", rdouble, "-1", -1);
339 test_parse_error(xbt_str_parse_double, "Parse double + noise", rdouble, "342 cruft");
340 test_parse_error(xbt_str_parse_double, "Parse nullptr as a double", rdouble, nullptr);
341 test_parse_error(xbt_str_parse_double, "Parse '' as a double", rdouble, "");
342 test_parse_error(xbt_str_parse_double, "Parse cruft as a double", rdouble, "cruft");
344 #endif /* SIMGRID_TEST */