1 /* xbt_str.cpp - various helping functions to deal with strings */
3 /* Copyright (c) 2007-2014. The SimGrid Team.
4 * All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
10 #include "src/internal_config.h"
12 #include "xbt/sysdep.h"
13 #include "xbt/str.h" /* headers of these functions */
14 #include "xbt/strbuff.h"
16 /** @brief Strip whitespace (or other characters) from the end of a string.
18 * Strips the whitespaces from the end of s.
19 * By default (when char_list=nullptr), these characters get stripped:
21 * - " " (ASCII 32 (0x20)) space.
22 * - "\t" (ASCII 9 (0x09)) tab.
23 * - "\n" (ASCII 10 (0x0A)) line feed.
24 * - "\r" (ASCII 13 (0x0D)) carriage return.
25 * - "\0" (ASCII 0 (0x00)) nullptr.
26 * - "\x0B" (ASCII 11 (0x0B)) vertical tab.
28 * @param s The string to strip. Modified in place.
29 * @param char_list A string which contains the characters you want to strip.
31 void xbt_str_rtrim(char *s, const char *char_list)
34 const char *__char_list = " \t\n\r\x0B";
35 char white_char[256] = { 1, 0 };
41 while (*__char_list) {
42 white_char[(unsigned char) *__char_list++] = 1;
46 white_char[(unsigned char) *char_list++] = 1;
53 while ((cur >= s) && white_char[(unsigned char) *cur])
59 /** @brief Strip whitespace (or other characters) from the beginning of a string.
61 * Strips the whitespaces from the begining of s.
62 * By default (when char_list=nullptr), these characters get stripped:
64 * - " " (ASCII 32 (0x20)) space.
65 * - "\t" (ASCII 9 (0x09)) tab.
66 * - "\n" (ASCII 10 (0x0A)) line feed.
67 * - "\r" (ASCII 13 (0x0D)) carriage return.
68 * - "\0" (ASCII 0 (0x00)) nullptr.
69 * - "\x0B" (ASCII 11 (0x0B)) vertical tab.
71 * @param s The string to strip. Modified in place.
72 * @param char_list A string which contains the characters you want to strip.
74 void xbt_str_ltrim(char *s, const char *char_list)
77 const char *__char_list = " \t\n\r\x0B";
78 char white_char[256] = { 1, 0 };
84 while (*__char_list) {
85 white_char[(unsigned char) *__char_list++] = 1;
89 white_char[(unsigned char) *char_list++] = 1;
93 while (*cur && white_char[(unsigned char) *cur])
96 memmove(s, cur, strlen(cur) + 1);
99 /** @brief Strip whitespace (or other characters) from the end and the begining of a string.
101 * Strips the whitespaces from both the beginning and the end of s.
102 * By default (when char_list=nullptr), these characters get stripped:
104 * - " " (ASCII 32 (0x20)) space.
105 * - "\t" (ASCII 9 (0x09)) tab.
106 * - "\n" (ASCII 10 (0x0A)) line feed.
107 * - "\r" (ASCII 13 (0x0D)) carriage return.
108 * - "\0" (ASCII 0 (0x00)) nullptr.
109 * - "\x0B" (ASCII 11 (0x0B)) vertical tab.
111 * @param s The string to strip.
112 * @param char_list A string which contains the characters you want to strip.
114 void xbt_str_trim(char *s, const char *char_list)
119 xbt_str_rtrim(s, char_list);
120 xbt_str_ltrim(s, char_list);
123 /** @brief Substitutes a char for another in a string
125 * @param str the string to modify
126 * @param from char to search
127 * @param to char to put instead
128 * @param occurence number of changes to do (=0 means all)
130 void xbt_str_subst(char *str, char from, char to, int occurence)
144 /** @brief Replaces a set of variables by their values
146 * @param str The input of the replacement process
147 * @param patterns The changes to apply
148 * @return The string modified
150 * Both '$toto' and '${toto}' are valid (and the two writing are equivalent).
152 * If the variable name contains spaces, use the brace version (ie, ${toto tutu})
154 * You can provide a default value to use if the variable is not set in the dict by using '${var:=default}' or
155 * '${var:-default}'. These two forms are equivalent, even if they shouldn't to respect the shell standard (:= form
156 * should set the value in the dict, but does not) (BUG).
158 char *xbt_str_varsubst(const char *str, xbt_dict_t patterns)
160 xbt_strbuff_t buff = xbt_strbuff_new_from(str);
162 xbt_strbuff_varsubst(buff, patterns);
164 xbt_strbuff_free_container(buff);
169 /** @brief Splits a string into a dynar of strings
171 * @param s: the string to split
172 * @param sep: a string of all chars to consider as separator.
174 * By default (with sep=nullptr), these characters are used as separator:
176 * - " " (ASCII 32 (0x20)) space.
177 * - "\t" (ASCII 9 (0x09)) tab.
178 * - "\n" (ASCII 10 (0x0A)) line feed.
179 * - "\r" (ASCII 13 (0x0D)) carriage return.
180 * - "\0" (ASCII 0 (0x00)) nullptr.
181 * - "\x0B" (ASCII 11 (0x0B)) vertical tab.
183 xbt_dynar_t xbt_str_split(const char *s, const char *sep)
185 xbt_dynar_t res = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
188 const char *sep_dflt = " \t\n\r\x0B";
189 char is_sep[256] = { 1, 0 };
191 /* check what are the separators */
192 memset(is_sep, 0, sizeof(is_sep));
195 is_sep[(unsigned char) *sep_dflt++] = 1;
198 is_sep[(unsigned char) *sep++] = 1;
200 is_sep[0] = 1; /* End of string is also separator */
212 while (!is_sep[(unsigned char) *q]) {
218 topush = (char*) xbt_malloc(q - p + 1);
219 memcpy(topush, p, q - p);
220 topush[q - p] = '\0';
221 xbt_dynar_push(res, &topush);
229 * \brief This functions splits a string after using another string as separator
230 * For example A!!B!!C splitted after !! will return the dynar {A,B,C}
231 * \return An array of dynars containing the string tokens
233 xbt_dynar_t xbt_str_split_str(const char *s, const char *sep)
235 xbt_dynar_t res = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
245 if (sep[0] == '\0') {
247 xbt_dynar_push(res, &s);
254 //get the start of the first occurence of the substring
256 //if substring was not found add the entire string
259 to_push = (char*) xbt_malloc(v + 1);
260 memcpy(to_push, p, v);
262 xbt_dynar_push(res, &to_push);
266 to_push = (char*) xbt_malloc(q - p + 1);
267 memcpy(to_push, p, q - p);
268 //add string terminator
269 to_push[q - p] = '\0';
270 xbt_dynar_push(res, &to_push);
277 /** @brief Just like @ref xbt_str_split_quoted (Splits a string into a dynar of strings), but without memory allocation
279 * The string passed as argument must be writable (not const)
280 * The elements of the dynar are just parts of the string passed as argument.
281 * So if you don't store that argument elsewhere, you should free it in addition to freeing the dynar. This can be done
282 * by simply freeing the first argument of the dynar:
283 * free(xbt_dynar_get_ptr(dynar,0));
285 * Actually this function puts a bunch of \0 in the memory area you passed as argument to separate the elements, and
286 * pushes the address of each chunk in the resulting dynar. Yes, that's uneven. Yes, that's gory. But that's efficient.
288 xbt_dynar_t xbt_str_split_quoted_in_place(char *s) {
289 xbt_dynar_t res = xbt_dynar_new(sizeof(char *), nullptr);
290 char *beg, *end; /* pointers around the parsed chunk */
291 int in_simple_quote = 0, in_double_quote = 0;
293 int ctn = 0; /* Got something in this block */
300 /* do not trim leading spaces: caller responsibility to clean his cruft */
307 /* Protected char; move it closer */
308 memmove(end, end + 1, strlen(end));
310 THROWF(arg_error, 0, "String ends with \\");
311 end++; /* Pass the protected char */
315 if (!in_double_quote) {
316 in_simple_quote = !in_simple_quote;
317 memmove(end, end + 1, strlen(end));
319 /* simple quote protected by double ones */
325 if (!in_simple_quote) {
326 in_double_quote = !in_double_quote;
327 memmove(end, end + 1, strlen(end));
329 /* double quote protected by simple ones */
337 if (*end == '\0' && (in_simple_quote || in_double_quote)) {
338 THROWF(arg_error, 0, "End of string found while searching for %c in %s", (in_simple_quote ? '\'' : '"'), s);
340 if (in_simple_quote || in_double_quote) {
348 /* Found a separator. Push the string if contains something */
349 xbt_dynar_push(res, &beg);
357 /* trim within the string, manually to speed things up */
371 /** @brief Splits a string into a dynar of strings, taking quotes into account
373 * It basically does the same argument separation than the shell, where white spaces can be escaped and where arguments
374 * are never split within a quote group.
375 * Several subsequent spaces are ignored (unless within quotes, of course).
376 * You may want to trim the input string, if you want to avoid empty entries
378 xbt_dynar_t xbt_str_split_quoted(const char *s)
380 xbt_dynar_t res = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
382 char *str_to_free; /* we have to copy the string before, to handle backslashes */
388 str_to_free = xbt_strdup(s);
390 parsed = xbt_str_split_quoted_in_place(str_to_free);
391 xbt_dynar_foreach(parsed,cursor,p) {
392 char *q=xbt_strdup(p);
393 xbt_dynar_push(res,&q);
396 xbt_dynar_shrink(res, 0);
397 xbt_dynar_free(&parsed);
401 /** @brief Join a set of strings as a single string */
402 char *xbt_str_join(xbt_dynar_t dyn, const char *sep)
404 int len = 1, dyn_len = xbt_dynar_length(dyn);
410 return xbt_strdup("");
412 /* compute the length */
413 xbt_dynar_foreach(dyn, cpt, cursor) {
414 len += strlen(cursor);
416 len += strlen(sep) * dyn_len;
418 res = (char*) xbt_malloc(len);
420 xbt_dynar_foreach(dyn, cpt, cursor) {
421 if ((int) cpt < dyn_len - 1)
422 p += snprintf(p,len, "%s%s", cursor, sep);
424 p += snprintf(p,len, "%s", cursor);
429 /** @brief Join a set of strings as a single string
431 * The parameter must be a nullptr-terminated array of chars,
432 * just like xbt_dynar_to_array() produces
434 char *xbt_str_join_array(const char *const *strs, const char *sep)
437 int amount_strings=0;
441 if ((!strs) || (!strs[0]))
442 return xbt_strdup("");
444 /* compute the length before malloc */
445 for (i=0;strs[i];i++) {
446 len += strlen(strs[i]);
449 len += strlen(sep) * amount_strings;
452 res = (char*) xbt_malloc(len);
454 for (i=0;strs[i];i++) {
455 if (i!=0) { // not first loop
456 q += snprintf(q,len, "%s%s", sep, strs[i]);
458 q += snprintf(q,len, "%s",strs[i]);
464 /** @brief creates a new string containing what can be read on a fd */
465 char *xbt_str_from_file(FILE * file)
467 xbt_strbuff_t buff = xbt_strbuff_new();
470 memset(bread, 0, 1024);
472 while (!feof(file)) {
473 int got = fread(bread, 1, 1023, file);
475 xbt_strbuff_append(buff, bread);
479 xbt_strbuff_free_container(buff);
483 /** @brief Parse an integer out of a string, or raise an error
485 * The @a str is passed as argument to your @a error_msg, as follows:
486 * @verbatim THROWF(arg_error, 0, error_msg, str); @endverbatim
488 long int xbt_str_parse_int(const char* str, const char* error_msg)
491 if (str == nullptr || str[0] == '\0')
492 THROWF(arg_error, 0, error_msg, str);
494 long int res = strtol(str, &endptr, 10);
495 if (endptr[0] != '\0')
496 THROWF(arg_error, 0, error_msg, str);
501 /** @brief Parse a double out of a string, or raise an error
503 * The @a str is passed as argument to your @a error_msg, as follows:
504 * @verbatim THROWF(arg_error, 0, error_msg, str); @endverbatim
506 double xbt_str_parse_double(const char* str, const char* error_msg)
509 if (str == nullptr || str[0] == '\0')
510 THROWF(arg_error, 0, error_msg, str);
512 double res = strtod(str, &endptr);
513 if (endptr[0] != '\0')
514 THROWF(arg_error, 0, error_msg, str);
520 #include <xbt/ex.hpp>
523 XBT_TEST_SUITE("xbt_str", "String Handling");
525 #define mytest(name, input, expected) \
526 xbt_test_add(name); \
527 d=xbt_str_split_quoted(input); \
528 s=xbt_str_join(d,"XXX"); \
529 xbt_test_assert(!strcmp(s,expected),\
530 "Input (%s) leads to (%s) instead of (%s)", \
534 XBT_TEST_UNIT("xbt_str_split_quoted", test_split_quoted, "test the function xbt_str_split_quoted")
539 mytest("Empty", "", "");
540 mytest("Basic test", "toto tutu", "totoXXXtutu");
541 mytest("Useless backslashes", "\\t\\o\\t\\o \\t\\u\\t\\u", "totoXXXtutu");
542 mytest("Protected space", "toto\\ tutu", "toto tutu");
543 mytest("Several spaces", "toto tutu", "totoXXXtutu");
544 mytest("LTriming", " toto tatu", "totoXXXtatu");
545 mytest("Triming", " toto tutu ", "totoXXXtutu");
546 mytest("Single quotes", "'toto tutu' tata", "toto tutuXXXtata");
547 mytest("Double quotes", "\"toto tutu\" tata", "toto tutuXXXtata");
548 mytest("Mixed quotes", "\"toto' 'tutu\" tata", "toto' 'tutuXXXtata");
549 mytest("Backslashed quotes", "\\'toto tutu\\' tata", "'totoXXXtutu'XXXtata");
550 mytest("Backslashed quotes + quotes", "'toto \\'tutu' tata", "toto 'tutuXXXtata");
553 #define mytest_str(name, input, separator, expected) \
554 xbt_test_add(name); \
555 d=xbt_str_split_str(input, separator); \
556 s=xbt_str_join(d,"XXX"); \
557 xbt_test_assert(!strcmp(s,expected),\
558 "Input (%s) leads to (%s) instead of (%s)", \
563 XBT_TEST_UNIT("xbt_str_split_str", test_split_str, "test the function xbt_str_split_str")
568 mytest_str("Empty string and separator", "", "", "");
569 mytest_str("Empty string", "", "##", "");
570 mytest_str("Empty separator", "toto", "", "toto");
571 mytest_str("String with no separator in it", "toto", "##", "toto");
572 mytest_str("Basic test", "toto##tutu", "##", "totoXXXtutu");
575 #define test_parse_error(function, name, variable, str) \
577 xbt_test_add(name); \
579 variable = function(str, "Parse error"); \
580 xbt_test_fail("The test '%s' did not detect the problem",name ); \
581 } catch(xbt_ex& e) { \
582 if (e.category != arg_error) { \
583 xbt_test_exception(e); \
587 #define test_parse_ok(function, name, variable, str, value) \
589 xbt_test_add(name); \
591 variable = function(str, "Parse error"); \
592 } catch(xbt_ex& e) { \
593 xbt_test_exception(e); \
595 xbt_test_assert(variable == value, "Fail to parse '%s'", str); \
598 XBT_TEST_UNIT("xbt_str_parse", test_parse, "Test the parsing functions")
601 test_parse_ok(xbt_str_parse_int, "Parse int", rint, "42", 42);
602 test_parse_ok(xbt_str_parse_int, "Parse 0 as an int", rint, "0", 0);
603 test_parse_ok(xbt_str_parse_int, "Parse -1 as an int", rint, "-1", -1);
605 test_parse_error(xbt_str_parse_int, "Parse int + noise", rint, "342 cruft");
606 test_parse_error(xbt_str_parse_int, "Parse nullptr as an int", rint, nullptr);
607 test_parse_error(xbt_str_parse_int, "Parse '' as an int", rint, "");
608 test_parse_error(xbt_str_parse_int, "Parse cruft as an int", rint, "cruft");
610 double rdouble = -9999;
611 test_parse_ok(xbt_str_parse_double, "Parse 42 as a double", rdouble, "42", 42);
612 test_parse_ok(xbt_str_parse_double, "Parse 42.5 as a double", rdouble, "42.5", 42.5);
613 test_parse_ok(xbt_str_parse_double, "Parse 0 as a double", rdouble, "0", 0);
614 test_parse_ok(xbt_str_parse_double, "Parse -1 as a double", rdouble, "-1", -1);
616 test_parse_error(xbt_str_parse_double, "Parse double + noise", rdouble, "342 cruft");
617 test_parse_error(xbt_str_parse_double, "Parse nullptr as a double", rdouble, nullptr);
618 test_parse_error(xbt_str_parse_double, "Parse '' as a double", rdouble, "");
619 test_parse_error(xbt_str_parse_double, "Parse cruft as a double", rdouble, "cruft");
621 #endif /* SIMGRID_TEST */