Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
rename the plugins from the command line, and document it
[simgrid.git] / src / xbt / xbt_str.cpp
index 6a102b3..b0ab069 100644 (file)
@@ -1,6 +1,6 @@
 /* xbt_str.cpp - various helping functions to deal with strings               */
 
-/* Copyright (c) 2007-2014. The SimGrid Team.
+/* Copyright (c) 2007-2018. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
 #include "xbt/sysdep.h"
 #include "xbt/str.h"            /* headers of these functions */
 
-/**  @brief Strip whitespace (or other characters) from the end of a string.
- *
- * Strips the whitespaces from the end of s.
- * By default (when char_list=nullptr), these characters get stripped:
- *
- *  - " "    (ASCII 32  (0x20))  space.
- *  - "\t"    (ASCII 9  (0x09))  tab.
- *  - "\n"    (ASCII 10  (0x0A))  line feed.
- *  - "\r"    (ASCII 13  (0x0D))  carriage return.
- *  - "\0"    (ASCII 0  (0x00))  nullptr.
- *  - "\x0B"  (ASCII 11  (0x0B))  vertical tab.
- *
- * @param s The string to strip. Modified in place.
- * @param char_list A string which contains the characters you want to strip.
- */
-void xbt_str_rtrim(char *s, const char *char_list)
-{
-  char *cur = s;
-  const char *__char_list = " \t\n\r\x0B";
-  char white_char[256] = { 1, 0 };
-
-  if (!s)
-    return;
-
-  if (!char_list) {
-    while (*__char_list) {
-      white_char[(unsigned char) *__char_list++] = 1;
-    }
-  } else {
-    while (*char_list) {
-      white_char[(unsigned char) *char_list++] = 1;
-    }
-  }
-
-  while (*cur)
-    ++cur;
-
-  while ((cur >= s) && white_char[(unsigned char) *cur])
-    --cur;
-
-  *++cur = '\0';
-}
-
-/**  @brief Strip whitespace (or other characters) from the beginning of a string.
- *
- * Strips the whitespaces from the begining of s.
- * By default (when char_list=nullptr), these characters get stripped:
- *
- *  - " "    (ASCII 32  (0x20))  space.
- *  - "\t"    (ASCII 9  (0x09))  tab.
- *  - "\n"    (ASCII 10  (0x0A))  line feed.
- *  - "\r"    (ASCII 13  (0x0D))  carriage return.
- *  - "\0"    (ASCII 0  (0x00))  nullptr.
- *  - "\x0B"  (ASCII 11  (0x0B))  vertical tab.
- *
- * @param s The string to strip. Modified in place.
- * @param char_list A string which contains the characters you want to strip.
- */
-void xbt_str_ltrim(char *s, const char *char_list)
-{
-  char *cur = s;
-  const char *__char_list = " \t\n\r\x0B";
-  char white_char[256] = { 1, 0 };
-
-  if (!s)
-    return;
-
-  if (!char_list) {
-    while (*__char_list) {
-      white_char[(unsigned char) *__char_list++] = 1;
-    }
-  } else {
-    while (*char_list) {
-      white_char[(unsigned char) *char_list++] = 1;
-    }
-  }
-
-  while (*cur && white_char[(unsigned char) *cur])
-    ++cur;
-
-  memmove(s, cur, strlen(cur) + 1);
-}
-
-/**  @brief Strip whitespace (or other characters) from the end and the begining of a string.
- *
- * Strips the whitespaces from both the beginning and the end of s.
- * By default (when char_list=nullptr), these characters get stripped:
- *
- *  - " "    (ASCII 32  (0x20))  space.
- *  - "\t"    (ASCII 9  (0x09))  tab.
- *  - "\n"    (ASCII 10  (0x0A))  line feed.
- *  - "\r"    (ASCII 13  (0x0D))  carriage return.
- *  - "\0"    (ASCII 0  (0x00))  nullptr.
- *  - "\x0B"  (ASCII 11  (0x0B))  vertical tab.
- *
- * @param s The string to strip.
- * @param char_list A string which contains the characters you want to strip.
- */
-void xbt_str_trim(char *s, const char *char_list)
-{
-  if (!s)
-    return;
-
-  xbt_str_rtrim(s, char_list);
-  xbt_str_ltrim(s, char_list);
-}
-
-/** @brief Substitutes a char for another in a string
- *
- * @param str the string to modify
- * @param from char to search
- * @param to char to put instead
- * @param occurence number of changes to do (=0 means all)
- */
-void xbt_str_subst(char *str, char from, char to, int occurence)
-{
-  char *p = str;
-  while (*p != '\0') {
-    if (*p == from) {
-      *p = to;
-      if (occurence == 1)
-        return;
-      occurence--;
-    }
-    p++;
-  }
-}
-
 /** @brief Splits a string into a dynar of strings
  *
  * @param s: the string to split
@@ -161,7 +33,7 @@ xbt_dynar_t xbt_str_split(const char *s, const char *sep)
 
   /* check what are the separators */
   memset(is_sep, 0, sizeof(is_sep));
-  if (!sep) {
+  if (not sep) {
     while (*sep_dflt)
       is_sep[(unsigned char) *sep_dflt++] = 1;
   } else {
@@ -178,9 +50,9 @@ xbt_dynar_t xbt_str_split(const char *s, const char *sep)
   if (s[0] == '\0')
     return res;
 
-  while (!done) {
+  while (not done) {
     char *topush;
-    while (!is_sep[(unsigned char) *q]) {
+    while (not is_sep[(unsigned char)*q]) {
       q++;
     }
     if (*q == '\0')
@@ -196,53 +68,6 @@ xbt_dynar_t xbt_str_split(const char *s, const char *sep)
   return res;
 }
 
-/**
- * \brief This functions splits a string after using another string as separator
- * For example A!!B!!C split after !! will return the dynar {A,B,C}
- * \return An array of dynars containing the string tokens
- */
-xbt_dynar_t xbt_str_split_str(const char *s, const char *sep)
-{
-  xbt_dynar_t res = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
-
-  const char* p = s;
-  const char* q = s;
-  int done      = 0;
-
-  if (s[0] == '\0')
-    return res;
-  if (sep[0] == '\0') {
-    s = xbt_strdup(s);
-    xbt_dynar_push(res, &s);
-    return res;
-  }
-
-  while (!done) {
-    char *to_push;
-    int v = 0;
-    // get the start of the first occurrence of the substring
-    q = strstr(p, sep);
-    //if substring was not found add the entire string
-    if (nullptr == q) {
-      v = strlen(p);
-      to_push = (char*) xbt_malloc(v + 1);
-      memcpy(to_push, p, v);
-      to_push[v] = '\0';
-      xbt_dynar_push(res, &to_push);
-      done = 1;
-    } else {
-      //get the appearance
-      to_push = (char*) xbt_malloc(q - p + 1);
-      memcpy(to_push, p, q - p);
-      //add string terminator
-      to_push[q - p] = '\0';
-      xbt_dynar_push(res, &to_push);
-      p = q + strlen(sep);
-    }
-  }
-  return res;
-}
-
 /** @brief Just like @ref xbt_str_split_quoted (Splits a string into a dynar of strings), but without memory allocation
  *
  * The string passed as argument must be writable (not const)
@@ -271,7 +96,7 @@ xbt_dynar_t xbt_str_split_quoted_in_place(char *s) {
   /* do not trim leading spaces: caller responsibility to clean his cruft */
   end = beg;
 
-  while (!done) {
+  while (not done) {
     switch (*end) {
     case '\\':
       ctn = 1;
@@ -283,8 +108,8 @@ xbt_dynar_t xbt_str_split_quoted_in_place(char *s) {
       break;
     case '\'':
       ctn = 1;
-      if (!in_double_quote) {
-        in_simple_quote = !in_simple_quote;
+      if (not in_double_quote) {
+        in_simple_quote = not in_simple_quote;
         memmove(end, end + 1, strlen(end));
       } else {
         /* simple quote protected by double ones */
@@ -293,8 +118,8 @@ xbt_dynar_t xbt_str_split_quoted_in_place(char *s) {
       break;
     case '"':
       ctn = 1;
-      if (!in_simple_quote) {
-        in_double_quote = !in_double_quote;
+      if (not in_simple_quote) {
+        in_double_quote = not in_double_quote;
         memmove(end, end + 1, strlen(end));
       } else {
         /* double quote protected by simple ones */
@@ -363,39 +188,12 @@ xbt_dynar_t xbt_str_split_quoted(const char *s)
     char *q=xbt_strdup(p);
     xbt_dynar_push(res,&q);
   }
-  free(str_to_free);
+  xbt_free(str_to_free);
   xbt_dynar_shrink(res, 0);
   xbt_dynar_free(&parsed);
   return res;
 }
 
-/** @brief Join a set of strings as a single string */
-char *xbt_str_join(xbt_dynar_t dyn, const char *sep)
-{
-  int len = 1, dyn_len = xbt_dynar_length(dyn);
-  unsigned int cpt;
-  char* cursor;
-
-  if (!dyn_len)
-    return xbt_strdup("");
-
-  /* compute the length */
-  xbt_dynar_foreach(dyn, cpt, cursor) {
-    len += strlen(cursor);
-  }
-  len += strlen(sep) * dyn_len;
-  /* Do the job */
-  char* res = (char*)xbt_malloc(len);
-  char* p   = res;
-  xbt_dynar_foreach(dyn, cpt, cursor) {
-    if ((int) cpt < dyn_len - 1)
-      p += snprintf(p,len, "%s%s", cursor, sep);
-    else
-      p += snprintf(p,len, "%s", cursor);
-  }
-  return res;
-}
-
 /** @brief Join a set of strings as a single string
  *
  * The parameter must be a nullptr-terminated array of chars,
@@ -406,7 +204,7 @@ char *xbt_str_join_array(const char *const *strs, const char *sep)
   int amount_strings=0;
   int len=0;
 
-  if ((!strs) || (!strs[0]))
+  if ((not strs) || (not strs[0]))
     return xbt_strdup("");
 
   /* compute the length before malloc */
@@ -471,18 +269,18 @@ double xbt_str_parse_double(const char* str, const char* error_msg)
 
 XBT_TEST_SUITE("xbt_str", "String Handling");
 
-#define mytest(name, input, expected) \
-  xbt_test_add(name); \
-  d=xbt_str_split_quoted(input); \
-  s=xbt_str_join(d,"XXX"); \
-  xbt_test_assert(!strcmp(s,expected),\
-                   "Input (%s) leads to (%s) instead of (%s)", \
-                   input,s,expected);\
-                   free(s); \
-                   xbt_dynar_free(&d);
-XBT_TEST_UNIT("xbt_str_split_quoted", test_split_quoted, "test the function xbt_str_split_quoted")
+#define mytest(name, input, expected)                                                                                  \
+  xbt_test_add(name);                                                                                                  \
+  a = static_cast<char**>(xbt_dynar_to_array(xbt_str_split_quoted(input)));                                            \
+  s = xbt_str_join_array(a, "XXX");                                                                                    \
+  xbt_test_assert(not strcmp(s, expected), "Input (%s) leads to (%s) instead of (%s)", input, s, expected);            \
+  xbt_free(s);                                                                                                         \
+  for (int i = 0; a[i] != nullptr; i++)                                                                                \
+    xbt_free(a[i]);                                                                                                    \
+  xbt_free(a);
+XBT_TEST_UNIT("xbt_str_split_quoted", test_split_quoted, "Test the function xbt_str_split_quoted")
 {
-  xbt_dynar_t d;
+  char** a;
   char *s;
 
   mytest("Empty", "", "");
@@ -499,28 +297,6 @@ XBT_TEST_UNIT("xbt_str_split_quoted", test_split_quoted, "test the function xbt_
   mytest("Backslashed quotes + quotes", "'toto \\'tutu' tata", "toto 'tutuXXXtata");
 }
 
-#define mytest_str(name, input, separator, expected) \
-  xbt_test_add(name); \
-  d=xbt_str_split_str(input, separator); \
-  s=xbt_str_join(d,"XXX"); \
-  xbt_test_assert(!strcmp(s,expected),\
-                   "Input (%s) leads to (%s) instead of (%s)", \
-                   input,s,expected);\
-                   free(s); \
-                   xbt_dynar_free(&d);
-
-XBT_TEST_UNIT("xbt_str_split_str", test_split_str, "test the function xbt_str_split_str")
-{
-  xbt_dynar_t d;
-  char *s;
-
-  mytest_str("Empty string and separator", "", "", "");
-  mytest_str("Empty string", "", "##", "");
-  mytest_str("Empty separator", "toto", "", "toto");
-  mytest_str("String with no separator in it", "toto", "##", "toto");
-  mytest_str("Basic test", "toto##tutu", "##", "totoXXXtutu");
-}
-
 #define test_parse_error(function, name, variable, str)                 \
   do {                                                                  \
     xbt_test_add(name);                                                 \