Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add const qualifier to parameters of xbt_str_diff.
[simgrid.git] / src / xbt / xbt_str.c
index 73279a4..add78b4 100644 (file)
@@ -1,19 +1,16 @@
-/* $Id$ */
-
 /* xbt_str.c - various helping functions to deal with strings               */
 
-/* Copyright (C) 2005-2008 The SimGrid Team.                                */
-/* All rights reserved.                                                     */
+/* Copyright (c) 2007, 2008, 2009, 2010. The SimGrid Team.
+ * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
- * under the terms of the license (GNU LGPL) which comes with this package.
- */
+ * under the terms of the license (GNU LGPL) which comes with this package. */
 
+#include "portable.h"
 #include "xbt/misc.h"
 #include "xbt/sysdep.h"
 #include "xbt/str.h"            /* headers of these functions */
 #include "xbt/strbuff.h"
-#include "portable.h"
 #include "xbt/matrix.h"         /* for the diff */
 
 /**  @brief Strip whitespace (or other characters) from the end of a string.
@@ -176,7 +173,7 @@ end:
  * @param str the string to modify
  * @param from char to search
  * @param to char to put instead
- * @param amount amount of changes to do (=0 means all)
+ * @param occurence number of changes to do (=0 means all)
  */
 void xbt_str_subst(char *str, char from, char to, int occurence)
 {
@@ -229,7 +226,7 @@ char *xbt_str_varsubst(char *str, xbt_dict_t patterns)
 
 xbt_dynar_t xbt_str_split(const char *s, const char *sep)
 {
-  xbt_dynar_t res = xbt_dynar_new(sizeof(char *), xbt_free_ref);
+  xbt_dynar_t res = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
   const char *p, *q;
   int done;
   const char *sep_dflt = " \t\n\r\x0B";
@@ -278,7 +275,7 @@ xbt_dynar_t xbt_str_split(const char *s, const char *sep)
  */
 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);
+  xbt_dynar_t res = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
   int done;
   const char *p, *q;
 
@@ -319,19 +316,18 @@ xbt_dynar_t xbt_str_split_str(const char *s, const char *sep)
   return res;
 }
 
-/** @brief Splits a string into a dynar of strings, taking quotes into account
+/** @brief Just like @ref xbt_str_split_quoted (Splits a string into a dynar of strings), but without memory allocation
  *
- * It basically does the same argument separation than the shell, where white
- * spaces can be escaped and where arguments are never splitted within a
- * quote group.
- * Several subsequent spaces are ignored (unless within quotes, of course).
+ * The string passed as argument must be writable (not const)
+ * The elements of the dynar are just parts of the string passed as argument.
  *
+ * To free the structure constructed by this function, free the first element and free the dynar:
+ *
+ * free(xbt_dynar_get_ptr(dynar,0));
+ * xbt_dynar_free(&dynar);
  */
-
-xbt_dynar_t xbt_str_split_quoted(const char *s)
-{
-  xbt_dynar_t res = xbt_dynar_new(sizeof(char *), xbt_free_ref);
-  char *str_to_free;            /* we have to copy the string before, to handle backslashes */
+xbt_dynar_t xbt_str_split_quoted_in_place(char *s) {
+  xbt_dynar_t res = xbt_dynar_new(sizeof(char *), NULL);
   char *beg, *end;              /* pointers around the parsed chunk */
   int in_simple_quote = 0, in_double_quote = 0;
   int done = 0;
@@ -339,10 +335,10 @@ xbt_dynar_t xbt_str_split_quoted(const char *s)
 
   if (s[0] == '\0')
     return res;
-  beg = str_to_free = xbt_strdup(s);
 
-  /* trim leading spaces */
-  xbt_str_ltrim(beg, " ");
+  beg = s;
+
+  /* do not trim leading spaces: caller responsability to clean his cruft */
   end = beg;
 
   while (!done) {
@@ -354,7 +350,7 @@ xbt_dynar_t xbt_str_split_quoted(const char *s)
       /* Protected char; move it closer */
       memmove(end, end + 1, strlen(end));
       if (*end == '\0')
-        THROW0(arg_error, 0, "String ends with \\");
+        THROWF(arg_error, 0, "String ends with \\");
       end++;                    /* Pass the protected char */
       break;
 
@@ -384,29 +380,30 @@ xbt_dynar_t xbt_str_split_quoted(const char *s)
     case '\n':
     case '\0':
       if (*end == '\0' && (in_simple_quote || in_double_quote)) {
-        THROW2(arg_error, 0,
+        THROWF(arg_error, 0,
                "End of string found while searching for %c in %s",
                (in_simple_quote ? '\'' : '"'), s);
       }
       if (in_simple_quote || in_double_quote) {
         end++;
       } else {
+        if (*end == '\0')
+          done = 1;
+
+        *end = '\0';
         if (ctn) {
           /* Found a separator. Push the string if contains something */
-          char *topush = xbt_malloc(end - beg + 1);
-          memcpy(topush, beg, end - beg);
-          topush[end - beg] = '\0';
-          xbt_dynar_push(res, &topush);
+          xbt_dynar_push(res, &beg);
         }
         ctn = 0;
 
-        if (*end == '\0') {
-          done = 1;
+        if (done)
           break;
-        }
 
         beg = ++end;
-        xbt_str_ltrim(beg, " ");
+        /* trim within the string, manually to speed things up */
+        while (*beg == ' ')
+          beg++;
         end = beg;
       }
       break;
@@ -416,73 +413,43 @@ xbt_dynar_t xbt_str_split_quoted(const char *s)
       end++;
     }
   }
-  free(str_to_free);
   return res;
 }
 
-#ifdef SIMGRID_TEST
-#include "xbt/str.h"
-
-#define mytest(name, input, expected) \
-  xbt_test_add0(name); \
-  d=xbt_str_split_quoted(input); \
-  s=xbt_str_join(d,"XXX"); \
-  xbt_test_assert3(!strcmp(s,expected),\
-                   "Input (%s) leads to (%s) instead of (%s)", \
-                   input,s,expected);\
-                   free(s); \
-                   xbt_dynar_free(&d);
+/** @brief Splits a string into a dynar of strings, taking quotes into account
+ *
+ * It basically does the same argument separation than the shell, where white
+ * spaces can be escaped and where arguments are never split within a
+ * quote group.
+ * Several subsequent spaces are ignored (unless within quotes, of course).
+ * You may want to trim the input string, if you want to avoid empty entries
+ *
+ */
 
-XBT_TEST_SUITE("xbt_str", "String Handling");
-XBT_TEST_UNIT("xbt_str_split_quoted", test_split_quoted,
-              "test the function xbt_str_split_quoted")
+xbt_dynar_t xbt_str_split_quoted(const char *s)
 {
-  xbt_dynar_t d;
-  char *s;
-
-  mytest("Empty", "", "");
-  mytest("Basic test", "toto tutu", "totoXXXtutu");
-  mytest("Useless backslashes", "\\t\\o\\t\\o \\t\\u\\t\\u", "totoXXXtutu");
-  mytest("Protected space", "toto\\ tutu", "toto tutu");
-  mytest("Several spaces", "toto   tutu", "totoXXXtutu");
-  mytest("LTriming", "  toto tatu", "totoXXXtatu");
-  mytest("Triming", "  toto   tutu  ", "totoXXXtutu");
-  mytest("Single quotes", "'toto tutu' tata", "toto tutuXXXtata");
-  mytest("Double quotes", "\"toto tutu\" tata", "toto tutuXXXtata");
-  mytest("Mixed quotes", "\"toto' 'tutu\" tata", "toto' 'tutuXXXtata");
-  mytest("Backslashed quotes", "\\'toto tutu\\' tata",
-         "'totoXXXtutu'XXXtata");
-  mytest("Backslashed quotes + quotes", "'toto \\'tutu' tata",
-         "toto 'tutuXXXtata");
-
-}
-
-#define mytest_str(name, input, separator, expected) \
-  xbt_test_add0(name); \
-  d=xbt_str_split_str(input, separator); \
-  s=xbt_str_join(d,"XXX"); \
-  xbt_test_assert3(!strcmp(s,expected),\
-                   "Input (%s) leads to (%s) instead of (%s)", \
-                   input,s,expected);\
-                   free(s); \
-                   xbt_dynar_free(&d);
+  xbt_dynar_t res = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
+  xbt_dynar_t parsed;
+  char *str_to_free;            /* we have to copy the string before, to handle backslashes */
+  unsigned int cursor;
+  char *p;
 
-XBT_TEST_UNIT("xbt_str_split_str", test_split_str,
-              "test the function xbt_str_split_str")
-{
-  xbt_dynar_t d;
-  char *s;
+  if (s[0] == '\0')
+    return res;
+  str_to_free = xbt_strdup(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");
+  parsed = xbt_str_split_quoted_in_place(str_to_free);
+  xbt_dynar_foreach(parsed,cursor,p) {
+    char *q=xbt_strdup(p);
+    xbt_dynar_push(res,&q);
+  }
+  free(str_to_free);
+  xbt_dynar_shrink(res, 0);
+  xbt_dynar_free(&parsed);
+  return res;
 }
-#endif /* SIMGRID_TEST */
 
 /** @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);
@@ -509,11 +476,41 @@ char *xbt_str_join(xbt_dynar_t dyn, const char *sep)
   }
   return res;
 }
+/** @brief Join a set of strings as a single string
+ *
+ * The parameter must be a NULL-terminated array of chars,
+ * just like xbt_dynar_to_array() produces
+ */
+char *xbt_str_join_array(const char *const *strs, const char *sep)
+{
+  char *res,*q;
+  int amount_strings=0;
+  int len=0;
+  int i;
+
+  if ((!strs) || (!strs[0]))
+    return xbt_strdup("");
 
-#if !defined(HAVE_GETLINE) || defined(DOXYGEN)
-/* prototype here, just in case */
-long getline(char **buf, size_t * n, FILE * stream);
+  /* compute the length before malloc */
+  for (i=0;strs[i];i++) {
+    len += strlen(strs[i]);
+    amount_strings++;
+  }
+  len += strlen(sep) * amount_strings;
+
+  /* Do the job */
+  q = res = xbt_malloc(len);
+  for (i=0;strs[i];i++) {
+    if (i!=0) { // not first loop
+      q += sprintf(q, "%s%s", sep, strs[i]);
+    } else {
+      q += sprintf(q,"%s",strs[i]);
+    }
+  }
+  return res;
+}
 
+#if defined(SIMGRID_NEED_GETLINE) || defined(DOXYGEN)
 /** @brief Get a single line from the stream (reimplementation of the GNU getline)
  *
  * This is a redefinition of the GNU getline function, used on platforms where it does not exists.
@@ -565,15 +562,16 @@ long getline(char **buf, size_t * n, FILE * stream)
   return (ssize_t) i;
 }
 
-#endif /* HAVE_GETLINE */
+#endif                          /* HAVE_GETLINE */
 
 /*
  * Diff related functions
  */
 static xbt_matrix_t diff_build_LCS(xbt_dynar_t da, xbt_dynar_t db)
 {
-  xbt_matrix_t C = xbt_matrix_new(xbt_dynar_length(da), xbt_dynar_length(db),
-                                  sizeof(int), NULL);
+  xbt_matrix_t C =
+      xbt_matrix_new(xbt_dynar_length(da), xbt_dynar_length(db),
+                     sizeof(int), NULL);
   unsigned long i, j;
 
   /* Compute the LCS */
@@ -603,13 +601,14 @@ static xbt_matrix_t diff_build_LCS(xbt_dynar_t da, xbt_dynar_t db)
     for (j = 1; j < xbt_dynar_length(db); j++) {
 
       if (!strcmp
-          (xbt_dynar_get_as(da, i, char *), xbt_dynar_get_as(db, j, char *)))
-         *((int *) xbt_matrix_get_ptr(C, i, j)) =
-          xbt_matrix_get_as(C, i - 1, j - 1, int) + 1;
+          (xbt_dynar_get_as(da, i, char *),
+           xbt_dynar_get_as(db, j, char *)))
+        *((int *) xbt_matrix_get_ptr(C, i, j)) =
+            xbt_matrix_get_as(C, i - 1, j - 1, int) + 1;
       else
         *((int *) xbt_matrix_get_ptr(C, i, j)) =
-          max(xbt_matrix_get_as(C, i, j - 1, int),
-              xbt_matrix_get_as(C, i - 1, j, int));
+            max(xbt_matrix_get_as(C, i, j - 1, int),
+                xbt_matrix_get_as(C, i - 1, j, int));
     }
   return C;
 }
@@ -640,20 +639,19 @@ static void diff_build_diff(xbt_dynar_t res,
     xbt_dynar_push(res, &topush);
   } else if (j >= 0 &&
              (i <= 0 || j == 0
-              || xbt_matrix_get_as(C, i, j - 1, int) >= xbt_matrix_get_as(C,
-                                                                          i -
-                                                                          1,
-                                                                          j,
-                                                                          int)))
-  {
+              || xbt_matrix_get_as(C, i, j - 1,
+                                   int) >= xbt_matrix_get_as(C, i - 1, j,
+                                                             int))) {
     diff_build_diff(res, C, da, db, i, j - 1);
     topush = bprintf("+ %s", xbt_dynar_get_as(db, j, char *));
     xbt_dynar_push(res, &topush);
   } else if (i >= 0 &&
              (j <= 0
               || xbt_matrix_get_as(C, i, j - 1, int) < xbt_matrix_get_as(C,
-                                                                         i -
-                                                                         1, j,
+                                                                         i
+                                                                         -
+                                                                         1,
+                                                                         j,
                                                                          int)))
   {
     diff_build_diff(res, C, da, db, i - 1, j);
@@ -662,19 +660,19 @@ static void diff_build_diff(xbt_dynar_t res,
   } else if (i <= 0 && j <= 0) {
     return;
   } else {
-    THROW2(arg_error, 0, "Invalid values: i=%d, j=%d", i, j);
+    THROWF(arg_error, 0, "Invalid values: i=%d, j=%d", i, j);
   }
 
 }
 
 /** @brief Compute the unified diff of two strings */
-char *xbt_str_diff(char *a, char *b)
+char *xbt_str_diff(const char *a, const char *b)
 {
   xbt_dynar_t da = xbt_str_split(a, "\n");
   xbt_dynar_t db = xbt_str_split(b, "\n");
 
   xbt_matrix_t C = diff_build_LCS(da, db);
-  xbt_dynar_t diff = xbt_dynar_new(sizeof(char *), xbt_free_ref);
+  xbt_dynar_t diff = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
   char *res = NULL;
 
   diff_build_diff(diff, C, da, db, xbt_dynar_length(da) - 1,
@@ -699,3 +697,85 @@ char *xbt_str_diff(char *a, char *b)
 
   return res;
 }
+
+
+/** @brief creates a new string containing what can be read on a fd
+ *
+ */
+char *xbt_str_from_file(FILE * file)
+{
+  xbt_strbuff_t buff = xbt_strbuff_new();
+  char *res;
+  char bread[1024];
+  memset(bread, 0, 1024);
+
+  while (!feof(file)) {
+    int got = fread(bread, 1, 1023, file);
+    bread[got] = '\0';
+    xbt_strbuff_append(buff, bread);
+  }
+
+  res = buff->data;
+  xbt_strbuff_free_container(buff);
+  return res;
+}
+
+#ifdef SIMGRID_TEST
+#include "xbt/str.h"
+
+#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_SUITE("xbt_str", "String Handling");
+XBT_TEST_UNIT("xbt_str_split_quoted", test_split_quoted, "test the function xbt_str_split_quoted")
+{
+  xbt_dynar_t d;
+  char *s;
+
+  mytest("Empty", "", "");
+  mytest("Basic test", "toto tutu", "totoXXXtutu");
+  mytest("Useless backslashes", "\\t\\o\\t\\o \\t\\u\\t\\u",
+         "totoXXXtutu");
+  mytest("Protected space", "toto\\ tutu", "toto tutu");
+  mytest("Several spaces", "toto   tutu", "totoXXXtutu");
+  mytest("LTriming", "  toto tatu", "totoXXXtatu");
+  mytest("Triming", "  toto   tutu  ", "totoXXXtutu");
+  mytest("Single quotes", "'toto tutu' tata", "toto tutuXXXtata");
+  mytest("Double quotes", "\"toto tutu\" tata", "toto tutuXXXtata");
+  mytest("Mixed quotes", "\"toto' 'tutu\" tata", "toto' 'tutuXXXtata");
+  mytest("Backslashed quotes", "\\'toto tutu\\' tata",
+         "'totoXXXtutu'XXXtata");
+  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");
+}
+#endif                          /* SIMGRID_TEST */