Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
kill an unused variable, fix a segfault after resizing the buffer while varsubsting...
[simgrid.git] / src / xbt / xbt_strbuff.c
index 4fc131e..9e5e949 100644 (file)
@@ -35,6 +35,21 @@ xbt_strbuff_t xbt_strbuff_new(void) {
   xbt_strbuff_empty(res);
   return res;
 }
+/** @brief creates a new string buffer containing the provided string
+ *
+ * Beware, we store the ctn directly, not a copy of it
+ */
+xbt_strbuff_t xbt_strbuff_new_from(char *ctn) {
+  xbt_strbuff_t res=malloc(sizeof(s_xbt_strbuff_t));
+  res->data=ctn;
+  res->used=res->size=strlen(ctn);
+  return res;
+}
+/** @brief frees only the container without touching to the contained string */
+void xbt_strbuff_free_container(xbt_strbuff_t b) {
+  free(b);
+}
+/** @brief frees the buffer and its content */
 void xbt_strbuff_free(xbt_strbuff_t b) {
   if (b) {
     if (b->data)
@@ -79,16 +94,21 @@ void xbt_strbuff_trim(xbt_strbuff_t b) {
  * Both '$toto' and '${toto}' are valid (and the two writing are equivalent).
  *
  * If the variable name contains spaces, use the brace version (ie, ${toto tutu})
+ *
+ * You can provide a default value to use if the variable is not set in the dict by using
+ * '${var:=default}' or '${var:-default}'. These two forms are equivalent, even if they
+ * shouldn't to respect the shell standard (:= form should set the value in the dict,
+ * but does not) (BUG).
  */
 void xbt_strbuff_varsubst(xbt_strbuff_t b, xbt_dict_t patterns) {
 
-  char *beg, *end; /* pointers around the parsed chunk */
+  char *end; /* pointers around the parsed chunk */
   int in_simple_quote=0, in_double_quote=0;
   int done = 0;
 
   if (b->data[0] == '\0')
     return;
-  end = beg = b->data;
+  end = b->data;
 
   while (!done) {
 
@@ -129,17 +149,18 @@ void xbt_strbuff_varsubst(xbt_strbuff_t b, xbt_dict_t patterns) {
             /* Search name's end */
             end_var = beg_var;
             while (*end_var != '\0' && *end_var != '}') {
-              if (*end_var == ':') {
+              /* TODO: we do not respect the standard for ":=", we should set this value in the dict */
+              if (*end_var == ':' && ((*(end_var+1) == '=') || (*(end_var+1) == '-'))) {
                 /* damn, we have a default value */
-                char *p = end_var;
+                char *p = end_var+1;
                 while (*p != '\0' && *p != '}')
                   p++;
                 if (*p == '\0')
                   THROW0(arg_error,0,"Variable default value not terminated ('}' missing)");
 
-                default_value = xbt_malloc(p-end_var);
-                memcpy(default_value, end_var+1, p-end_var-1);
-                default_value[p-end_var-1] = '\0';
+                default_value = xbt_malloc(p-end_var-1);
+                memcpy(default_value, end_var+2, p-end_var-2);
+                default_value[p-end_var-2] = '\0';
 
                 end_subst = p+1; /* eat '}' */
 
@@ -193,11 +214,13 @@ void xbt_strbuff_varsubst(xbt_strbuff_t b, xbt_dict_t patterns) {
             memmove(beg_subst,value,val_len); /* substitute */
 //            INFO3("Substitute '%s' with '%s' for %d chars",beg_subst+val_len,end_subst, b->used-(end_subst-b->data)+1);
             memmove(beg_subst+val_len,end_subst, b->used-(end_subst - b->data)+1); /* move the end of the string closer */
+            end = beg_subst+val_len; /* update the currently explored char in the overall loop*/
             b->used -= end_subst-beg_subst-val_len;  /* update string buffer used size */
           } else {
             /* we have to extend the data area */
             int tooshort = val_len-(end_subst-beg_subst) +1/*don't forget \0*/;
             int newused = b->used + tooshort;
+            end += tooshort; /* update the pointer of the overall loop */
 //            DEBUG2("Too short (by %d chars; %d chars left in area)",val_len- (end_subst-beg_subst), b->size - b->used);
             if (newused > b->size) {
               /* We have to realloc the data area before (because b->size is too small). We have to update our pointers, too */
@@ -205,21 +228,23 @@ void xbt_strbuff_varsubst(xbt_strbuff_t b, xbt_dict_t patterns) {
               int offset = newdata - b->data;
               b->data = newdata;
               b->size = b->used + MAX(minimal_increment,tooshort);
+              end += offset;
               beg_subst += offset;
               end_subst += offset;
             }
-            memmove(beg_subst+val_len,end_subst, b->used-(end_subst - b->data)+1); /* move the end of the string a bit further */
+            memmove(beg_subst+val_len,end_subst, b->used-(end_subst - b->data)+2); /* move the end of the string a bit further */
             memmove(beg_subst,value,val_len); /* substitute */
             b->used = newused;
           }
           free(value);
 
-
           if (default_value)
             free(default_value);
         }
+        break;
+
       case '\0':
-        return;
+        done=1;
     }
     end++;
   }
@@ -241,13 +266,12 @@ void xbt_strbuff_varsubst(xbt_strbuff_t b, xbt_dict_t patterns) {
   "9.........1.........2.........3.........4.........5.........6.........7.........8.........9........." \
   "0.........1.........2.........3.........4.........5.........6.........7.........8.........9........."
 
-static void mytest(const char *name, const char *input, const char *patterns, const char *expected) {
+static void mytest(const char *input, const char *patterns, const char *expected) {
   xbt_dynar_t dyn_patterns; /* splited string */
   xbt_dict_t p; /* patterns */
   unsigned int cpt;  char *str; /*foreach*/
   xbt_strbuff_t sb; /* what we test */
 
-  xbt_test_add0(name);
   p=xbt_dict_new();
   dyn_patterns=xbt_str_split(patterns," ");
   xbt_dynar_foreach(dyn_patterns,cpt,str) {
@@ -271,53 +295,54 @@ static void mytest(const char *name, const char *input, const char *patterns, co
 
 XBT_TEST_SUITE("xbt_strbuff","String Buffers");
 XBT_TEST_UNIT("xbt_strbuff_substitute",test_strbuff_substitute, "test the function xbt_strbuff_substitute") {
-  mytest("Empty", "", "", "");
-
-  mytest("Value shorter, no braces, only variable", "$tutu", "tutu=t", "t");
-  mytest("Value shorter, braces, only variable", "${tutu}", "tutu=t", "t");
-  mytest("Value shorter, no braces, data after", "$tutu toto", "tutu=t", "t toto");
-  mytest("Value shorter, braces, data after", "${tutu} toto", "tutu=t", "t toto");
-  mytest("Value shorter, no braces, data before", "toto $tutu", "tutu=t", "toto t");
-  mytest("Value shorter, braces, data before", "toto ${tutu}", "tutu=t", "toto t");
-  mytest("Value shorter, no braces, data before and after", "toto $tutu tata", "tutu=t", "toto t tata");
-  mytest("Value shorter, braces, data before and after", "toto ${tutu} tata", "tutu=t", "toto t tata");
-
-  mytest("Value as long, no braces, only variable", "$tutu", "tutu=12345", "12345");
-  mytest("Value as long, braces, only variable", "${tutu}", "tutu=1234567", "1234567");
-  mytest("Value as long, no braces, data after", "$tutu toto", "tutu=12345", "12345 toto");
-  mytest("Value as long, braces, data after", "${tutu} toto", "tutu=1234567", "1234567 toto");
-  mytest("Value as long, no braces, data before", "toto $tutu", "tutu=12345", "toto 12345");
-  mytest("Value as long, braces, data before", "toto ${tutu}", "tutu=1234567", "toto 1234567");
-  mytest("Value as long, no braces, data before and after", "toto $tutu tata", "tutu=12345", "toto 12345 tata");
-  mytest("Value as long, braces, data before and after", "toto ${tutu} tata", "tutu=1234567", "toto 1234567 tata");
-
-  mytest("Value longer, no braces, only variable", "$t", "t=tututu", "tututu");
-  mytest("Value longer, braces, only variable", "${t}", "t=tututu", "tututu");
-  mytest("Value longer, no braces, data after", "$t toto", "t=tututu", "tututu toto");
-  mytest("Value longer, braces, data after", "${t} toto", "t=tututu", "tututu toto");
-  mytest("Value longer, no braces, data before", "toto $t", "t=tututu", "toto tututu");
-  mytest("Value longer, braces, data before", "toto ${t}", "t=tututu", "toto tututu");
-  mytest("Value longer, no braces, data before and after", "toto $t tata", "t=tututu", "toto tututu tata");
-  mytest("Value longer, braces, data before and after", "toto ${t} tata", "t=tututu", "toto tututu tata");
-
-  mytest("Value much longer, no braces, only variable", "$t", "t=" force_resize, force_resize);
-  mytest("Value much longer, braces, only variable", "${t}", "t=" force_resize, force_resize);
-  mytest("Value much longer, no braces, data after", "$t toto", "t=" force_resize, force_resize " toto");
-  mytest("Value much longer, braces, data after", "${t} toto", "t=" force_resize, force_resize " toto");
-  mytest("Value much longer, no braces, data before", "toto $t", "t=" force_resize, "toto " force_resize);
-  mytest("Value much longer, braces, data before", "toto ${t}", "t=" force_resize, "toto " force_resize);
-  mytest("Value much longer, no braces, data before and after", "toto $t tata", "t=" force_resize, "toto " force_resize " tata");
-  mytest("Value much longer, braces, data before and after", "toto ${t} tata", "t=" force_resize, "toto " force_resize " tata");
-
-  mytest("Escaped $", "\\$tutu", "tutu=t", "\\$tutu");
-  mytest("Space in var name (with braces)", "${tu ti}", "tu_ti=t", "t");
+  xbt_test_add0("Empty");mytest("", "", "");
+
+  xbt_test_add0("Value shorter, no braces, only variable");mytest("$tutu", "tutu=t", "t");
+  xbt_test_add0("Value shorter, braces, only variable");mytest("${tutu}", "tutu=t", "t");
+  xbt_test_add0("Value shorter, no braces, data after");mytest("$tutu toto", "tutu=t", "t toto");
+  xbt_test_add0("Value shorter, braces, data after");mytest("${tutu} toto", "tutu=t", "t toto");
+  xbt_test_add0("Value shorter, no braces, data before");mytest("toto $tutu", "tutu=t", "toto t");
+  xbt_test_add0("Value shorter, braces, data before");mytest("toto ${tutu}", "tutu=t", "toto t");
+  xbt_test_add0("Value shorter, no braces, data before and after");mytest("toto $tutu tata", "tutu=t", "toto t tata");
+  xbt_test_add0("Value shorter, braces, data before and after");mytest("toto ${tutu} tata", "tutu=t", "toto t tata");
+
+  xbt_test_add0("Value as long, no braces, only variable");mytest("$tutu", "tutu=12345", "12345");
+  xbt_test_add0("Value as long, braces, only variable");mytest("${tutu}", "tutu=1234567", "1234567");
+  xbt_test_add0("Value as long, no braces, data after");mytest("$tutu toto", "tutu=12345", "12345 toto");
+  xbt_test_add0("Value as long, braces, data after");mytest("${tutu} toto", "tutu=1234567", "1234567 toto");
+  xbt_test_add0("Value as long, no braces, data before");mytest("toto $tutu", "tutu=12345", "toto 12345");
+  xbt_test_add0("Value as long, braces, data before");mytest("toto ${tutu}", "tutu=1234567", "toto 1234567");
+  xbt_test_add0("Value as long, no braces, data before and after");mytest("toto $tutu tata", "tutu=12345", "toto 12345 tata");
+  xbt_test_add0("Value as long, braces, data before and after");mytest("toto ${tutu} tata", "tutu=1234567", "toto 1234567 tata");
+
+  xbt_test_add0("Value longer, no braces, only variable");mytest("$t", "t=tututu", "tututu");
+  xbt_test_add0("Value longer, braces, only variable");mytest("${t}", "t=tututu", "tututu");
+  xbt_test_add0("Value longer, no braces, data after");mytest("$t toto", "t=tututu", "tututu toto");
+  xbt_test_add0("Value longer, braces, data after");mytest("${t} toto", "t=tututu", "tututu toto");
+  xbt_test_add0("Value longer, no braces, data before");mytest("toto $t", "t=tututu", "toto tututu");
+  xbt_test_add0("Value longer, braces, data before");mytest("toto ${t}", "t=tututu", "toto tututu");
+  xbt_test_add0("Value longer, no braces, data before and after");mytest("toto $t tata", "t=tututu", "toto tututu tata");
+  xbt_test_add0("Value longer, braces, data before and after");mytest("toto ${t} tata", "t=tututu", "toto tututu tata");
+
+  xbt_test_add0("Value much longer, no braces, only variable");mytest("$t", "t=" force_resize, force_resize);
+  xbt_test_add0("Value much longer, no braces, data after");mytest("$t toto", "t=" force_resize, force_resize " toto");
+  xbt_test_add0("Value much longer, braces, data after");mytest("${t} toto", "t=" force_resize, force_resize " toto");
+  xbt_test_add0("Value much longer, no braces, data before");mytest("toto $t", "t=" force_resize, "toto " force_resize);
+  xbt_test_add0("Value much longer, braces, data before");mytest("toto ${t}", "t=" force_resize, "toto " force_resize);
+  xbt_test_add0("Value much longer, no braces, data before and after");mytest("toto $t tata", "t=" force_resize, "toto " force_resize " tata");
+  xbt_test_add0("Value much longer, braces, data before and after");mytest("toto ${t} tata", "t=" force_resize, "toto " force_resize " tata");
+
+  xbt_test_add0("Escaped $");mytest("\\$tutu", "tutu=t", "\\$tutu");
+  xbt_test_add0("Space in var name (with braces)");mytest("${tu ti}", "tu_ti=t", "t");
+
+  xbt_test_add0("Two variables");mytest("$toto $tutu","toto=1 tutu=2", "1 2");
 
   // Commented: I'm too lazy to do a memmove in var name to remove the backslash after use.
   // Users should use braces.
-  //  mytest("Escaped space in var name", "$tu\\ ti", "tu_ti=t", "t");
+  //  xbt_test_add0("Escaped space in var name", "$tu\\ ti", "tu_ti=t", "t");
 
-  mytest("Default value", "${t:toto}", "", "toto");
-  mytest("Useless default value (variable already defined)", "${t:toto}", "t=TRUC", "TRUC");
+  xbt_test_add0("Default value");mytest("${t:-toto}", "", "toto");
+  xbt_test_add0("Useless default value (variable already defined)");mytest("${t:-toto}", "t=TRUC", "TRUC");
 
 }