Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
xbt_str_diff: make it use less memory.
[simgrid.git] / src / xbt / xbt_str.c
1 /* xbt_str.c - various helping functions to deal with strings               */
2
3 /* Copyright (c) 2007, 2008, 2009, 2010. The SimGrid Team.
4  * All rights reserved.                                                     */
5
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. */
8
9 #include "portable.h"
10 #include "xbt/misc.h"
11 #include "xbt/sysdep.h"
12 #include "xbt/str.h"            /* headers of these functions */
13 #include "xbt/strbuff.h"
14 #include "xbt/matrix.h"         /* for the diff */
15
16 /**  @brief Strip whitespace (or other characters) from the end of a string.
17  *
18  * Strips the whitespaces from the end of s.
19  * By default (when char_list=NULL), these characters get stripped:
20  *
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)) NULL.
26  *      - "\x0B"        (ASCII 11       (0x0B)) vertical tab.
27  *
28  * @param s The string to strip. Modified in place.
29  * @param char_list A string which contains the characters you want to strip.
30  *
31  */
32 void xbt_str_rtrim(char *s, const char *char_list)
33 {
34   char *cur = s;
35   const char *__char_list = " \t\n\r\x0B";
36   char white_char[256] = { 1, 0 };
37
38   if (!s)
39     return;
40
41   if (!char_list) {
42     while (*__char_list) {
43       white_char[(unsigned char) *__char_list++] = 1;
44     }
45   } else {
46     while (*char_list) {
47       white_char[(unsigned char) *char_list++] = 1;
48     }
49   }
50
51   while (*cur)
52     ++cur;
53
54   while ((cur >= s) && white_char[(unsigned char) *cur])
55     --cur;
56
57   *++cur = '\0';
58 }
59
60 /**  @brief Strip whitespace (or other characters) from the beginning of a string.
61  *
62  * Strips the whitespaces from the begining of s.
63  * By default (when char_list=NULL), these characters get stripped:
64  *
65  *      - " "           (ASCII 32       (0x20)) space.
66  *      - "\t"          (ASCII 9        (0x09)) tab.
67  *      - "\n"          (ASCII 10       (0x0A)) line feed.
68  *      - "\r"          (ASCII 13       (0x0D)) carriage return.
69  *      - "\0"          (ASCII 0        (0x00)) NULL.
70  *      - "\x0B"        (ASCII 11       (0x0B)) vertical tab.
71  *
72  * @param s The string to strip. Modified in place.
73  * @param char_list A string which contains the characters you want to strip.
74  *
75  */
76 void xbt_str_ltrim(char *s, const char *char_list)
77 {
78   char *cur = s;
79   const char *__char_list = " \t\n\r\x0B";
80   char white_char[256] = { 1, 0 };
81
82   if (!s)
83     return;
84
85   if (!char_list) {
86     while (*__char_list) {
87       white_char[(unsigned char) *__char_list++] = 1;
88     }
89   } else {
90     while (*char_list) {
91       white_char[(unsigned char) *char_list++] = 1;
92     }
93   }
94
95   while (*cur && white_char[(unsigned char) *cur])
96     ++cur;
97
98   memmove(s, cur, strlen(cur) + 1);
99 }
100
101 /**  @brief Strip whitespace (or other characters) from the end and the begining of a string.
102  *
103  * Strips the whitespaces from both the beginning and the end of s.
104  * By default (when char_list=NULL), these characters get stripped:
105  *
106  *      - " "           (ASCII 32       (0x20)) space.
107  *      - "\t"          (ASCII 9        (0x09)) tab.
108  *      - "\n"          (ASCII 10       (0x0A)) line feed.
109  *      - "\r"          (ASCII 13       (0x0D)) carriage return.
110  *      - "\0"          (ASCII 0        (0x00)) NULL.
111  *      - "\x0B"        (ASCII 11       (0x0B)) vertical tab.
112  *
113  * @param s The string to strip.
114  * @param char_list A string which contains the characters you want to strip.
115  *
116  */
117 void xbt_str_trim(char *s, const char *char_list)
118 {
119
120   if (!s)
121     return;
122
123   xbt_str_rtrim(s, char_list);
124   xbt_str_ltrim(s, char_list);
125 }
126
127 /**  @brief Replace double whitespaces (but no other characters) from the string.
128  *
129  * The function modifies the string so that each time that several spaces appear,
130  * they are replaced by a single space. It will only do so for spaces (ASCII 32, 0x20).
131  *
132  * @param s The string to strip. Modified in place.
133  *
134  */
135 void xbt_str_strip_spaces(char *s)
136 {
137   char *p = s;
138   int e = 0;
139
140   if (!s)
141     return;
142
143   while (1) {
144     if (!*p)
145       goto end;
146
147     if (*p != ' ')
148       break;
149
150     p++;
151   }
152
153   e = 1;
154
155   do {
156     if (e)
157       *s++ = *p;
158
159     if (!*++p)
160       goto end;
161
162     if (e ^ (*p != ' '))
163       if ((e = !e))
164         *s++ = ' ';
165   } while (1);
166
167 end:
168   *s = '\0';
169 }
170
171 /** @brief Substitutes a char for another in a string
172  *
173  * @param str the string to modify
174  * @param from char to search
175  * @param to char to put instead
176  * @param occurence number of changes to do (=0 means all)
177  */
178 void xbt_str_subst(char *str, char from, char to, int occurence)
179 {
180   char *p = str;
181   while (*p != '\0') {
182     if (*p == from) {
183       *p = to;
184       if (occurence == 1)
185         return;
186       occurence--;
187     }
188     p++;
189   }
190 }
191
192 /** @brief Replaces a set of variables by their values
193  *
194  * @param str The input of the replacement process
195  * @param patterns The changes to apply
196  * @return The string modified
197  *
198  * Both '$toto' and '${toto}' are valid (and the two writing are equivalent).
199  *
200  * If the variable name contains spaces, use the brace version (ie, ${toto tutu})
201  *
202  * You can provide a default value to use if the variable is not set in the dict by using
203  * '${var:=default}' or '${var:-default}'. These two forms are equivalent, even if they
204  * shouldn't to respect the shell standard (:= form should set the value in the dict,
205  * but does not) (BUG).
206  */
207
208 char *xbt_str_varsubst(const char *str, xbt_dict_t patterns)
209 {
210   xbt_strbuff_t buff = xbt_strbuff_new_from(str);
211   char *res;
212   xbt_strbuff_varsubst(buff, patterns);
213   res = buff->data;
214   xbt_strbuff_free_container(buff);
215   return res;
216 }
217
218
219 /** @brief Splits a string into a dynar of strings
220  *
221  * @param s: the string to split
222  * @param sep: a string of all chars to consider as separator.
223  *
224  * By default (with sep=NULL), these characters are used as separator:
225  *
226  *      - " "           (ASCII 32       (0x20)) space.
227  *      - "\t"          (ASCII 9        (0x09)) tab.
228  *      - "\n"          (ASCII 10       (0x0A)) line feed.
229  *      - "\r"          (ASCII 13       (0x0D)) carriage return.
230  *      - "\0"          (ASCII 0        (0x00)) NULL.
231  *      - "\x0B"        (ASCII 11       (0x0B)) vertical tab.
232  */
233
234 xbt_dynar_t xbt_str_split(const char *s, const char *sep)
235 {
236   xbt_dynar_t res = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
237   const char *p, *q;
238   int done;
239   const char *sep_dflt = " \t\n\r\x0B";
240   char is_sep[256] = { 1, 0 };
241
242   /* check what are the separators */
243   memset(is_sep, 0, sizeof(is_sep));
244   if (!sep) {
245     while (*sep_dflt)
246       is_sep[(unsigned char) *sep_dflt++] = 1;
247   } else {
248     while (*sep)
249       is_sep[(unsigned char) *sep++] = 1;
250   }
251   is_sep[0] = 1;                /* End of string is also separator */
252
253   /* Do the job */
254   p = q = s;
255   done = 0;
256
257   if (s[0] == '\0')
258     return res;
259
260   while (!done) {
261     char *topush;
262     while (!is_sep[(unsigned char) *q]) {
263       q++;
264     }
265     if (*q == '\0')
266       done = 1;
267
268     topush = xbt_malloc(q - p + 1);
269     memcpy(topush, p, q - p);
270     topush[q - p] = '\0';
271     xbt_dynar_push(res, &topush);
272     p = ++q;
273   }
274
275   return res;
276 }
277
278 /**
279  * \brief This functions splits a string after using another string as separator
280  * For example A!!B!!C splitted after !! will return the dynar {A,B,C}
281  * \return An array of dynars containing the string tokens
282  */
283 xbt_dynar_t xbt_str_split_str(const char *s, const char *sep)
284 {
285   xbt_dynar_t res = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
286   int done;
287   const char *p, *q;
288
289   p = q = s;
290   done = 0;
291
292   if (s[0] == '\0')
293     return res;
294   if (sep[0] == '\0') {
295     s = xbt_strdup(s);
296     xbt_dynar_push(res, &s);
297     return res;
298   }
299
300   while (!done) {
301     char *to_push;
302     int v = 0;
303     //get the start of the first occurence of the substring
304     q = strstr(p, sep);
305     //if substring was not found add the entire string
306     if (NULL == q) {
307       v = strlen(p);
308       to_push = malloc(v + 1);
309       memcpy(to_push, p, v);
310       to_push[v] = '\0';
311       xbt_dynar_push(res, &to_push);
312       done = 1;
313     } else {
314       //get the appearance
315       to_push = malloc(q - p + 1);
316       memcpy(to_push, p, q - p);
317       //add string terminator
318       to_push[q - p] = '\0';
319       xbt_dynar_push(res, &to_push);
320       p = q + strlen(sep);
321     }
322   }
323   return res;
324 }
325
326 /** @brief Just like @ref xbt_str_split_quoted (Splits a string into a dynar of strings), but without memory allocation
327  *
328  * The string passed as argument must be writable (not const)
329  * The elements of the dynar are just parts of the string passed as argument.
330  *
331  * To free the structure constructed by this function, free the first element and free the dynar:
332  *
333  * free(xbt_dynar_get_ptr(dynar,0));
334  * xbt_dynar_free(&dynar);
335  */
336 xbt_dynar_t xbt_str_split_quoted_in_place(char *s) {
337   xbt_dynar_t res = xbt_dynar_new(sizeof(char *), NULL);
338   char *beg, *end;              /* pointers around the parsed chunk */
339   int in_simple_quote = 0, in_double_quote = 0;
340   int done = 0;
341   int ctn = 0;                  /* Got something in this block */
342
343   if (s[0] == '\0')
344     return res;
345
346   beg = s;
347
348   /* do not trim leading spaces: caller responsability to clean his cruft */
349   end = beg;
350
351   while (!done) {
352
353
354     switch (*end) {
355     case '\\':
356       ctn = 1;
357       /* Protected char; move it closer */
358       memmove(end, end + 1, strlen(end));
359       if (*end == '\0')
360         THROWF(arg_error, 0, "String ends with \\");
361       end++;                    /* Pass the protected char */
362       break;
363
364     case '\'':
365       ctn = 1;
366       if (!in_double_quote) {
367         in_simple_quote = !in_simple_quote;
368         memmove(end, end + 1, strlen(end));
369       } else {
370         /* simple quote protected by double ones */
371         end++;
372       }
373       break;
374     case '"':
375       ctn = 1;
376       if (!in_simple_quote) {
377         in_double_quote = !in_double_quote;
378         memmove(end, end + 1, strlen(end));
379       } else {
380         /* double quote protected by simple ones */
381         end++;
382       }
383       break;
384
385     case ' ':
386     case '\t':
387     case '\n':
388     case '\0':
389       if (*end == '\0' && (in_simple_quote || in_double_quote)) {
390         THROWF(arg_error, 0,
391                "End of string found while searching for %c in %s",
392                (in_simple_quote ? '\'' : '"'), s);
393       }
394       if (in_simple_quote || in_double_quote) {
395         end++;
396       } else {
397         if (*end == '\0')
398           done = 1;
399
400         *end = '\0';
401         if (ctn) {
402           /* Found a separator. Push the string if contains something */
403           xbt_dynar_push(res, &beg);
404         }
405         ctn = 0;
406
407         if (done)
408           break;
409
410         beg = ++end;
411         /* trim within the string, manually to speed things up */
412         while (*beg == ' ')
413           beg++;
414         end = beg;
415       }
416       break;
417
418     default:
419       ctn = 1;
420       end++;
421     }
422   }
423   return res;
424 }
425
426 /** @brief Splits a string into a dynar of strings, taking quotes into account
427  *
428  * It basically does the same argument separation than the shell, where white
429  * spaces can be escaped and where arguments are never split within a
430  * quote group.
431  * Several subsequent spaces are ignored (unless within quotes, of course).
432  * You may want to trim the input string, if you want to avoid empty entries
433  *
434  */
435
436 xbt_dynar_t xbt_str_split_quoted(const char *s)
437 {
438   xbt_dynar_t res = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
439   xbt_dynar_t parsed;
440   char *str_to_free;            /* we have to copy the string before, to handle backslashes */
441   unsigned int cursor;
442   char *p;
443
444   if (s[0] == '\0')
445     return res;
446   str_to_free = xbt_strdup(s);
447
448   parsed = xbt_str_split_quoted_in_place(str_to_free);
449   xbt_dynar_foreach(parsed,cursor,p) {
450     char *q=xbt_strdup(p);
451     xbt_dynar_push(res,&q);
452   }
453   free(str_to_free);
454   xbt_dynar_shrink(res, 0);
455   xbt_dynar_free(&parsed);
456   return res;
457 }
458
459 /** @brief Join a set of strings as a single string */
460 char *xbt_str_join(xbt_dynar_t dyn, const char *sep)
461 {
462   int len = 1, dyn_len = xbt_dynar_length(dyn);
463   unsigned int cpt;
464   char *cursor;
465   char *res, *p;
466
467   if (!dyn_len)
468     return xbt_strdup("");
469
470   /* compute the length */
471   xbt_dynar_foreach(dyn, cpt, cursor) {
472     len += strlen(cursor);
473   }
474   len += strlen(sep) * dyn_len;
475   /* Do the job */
476   res = xbt_malloc(len);
477   p = res;
478   xbt_dynar_foreach(dyn, cpt, cursor) {
479     if ((int) cpt < dyn_len - 1)
480       p += sprintf(p, "%s%s", cursor, sep);
481     else
482       p += sprintf(p, "%s", cursor);
483   }
484   return res;
485 }
486 /** @brief Join a set of strings as a single string
487  *
488  * The parameter must be a NULL-terminated array of chars,
489  * just like xbt_dynar_to_array() produces
490  */
491 char *xbt_str_join_array(const char *const *strs, const char *sep)
492 {
493   char *res,*q;
494   int amount_strings=0;
495   int len=0;
496   int i;
497
498   if ((!strs) || (!strs[0]))
499     return xbt_strdup("");
500
501   /* compute the length before malloc */
502   for (i=0;strs[i];i++) {
503     len += strlen(strs[i]);
504     amount_strings++;
505   }
506   len += strlen(sep) * amount_strings;
507
508   /* Do the job */
509   q = res = xbt_malloc(len);
510   for (i=0;strs[i];i++) {
511     if (i!=0) { // not first loop
512       q += sprintf(q, "%s%s", sep, strs[i]);
513     } else {
514       q += sprintf(q,"%s",strs[i]);
515     }
516   }
517   return res;
518 }
519
520 #if defined(SIMGRID_NEED_GETLINE) || defined(DOXYGEN)
521 /** @brief Get a single line from the stream (reimplementation of the GNU getline)
522  *
523  * This is a redefinition of the GNU getline function, used on platforms where it does not exists.
524  *
525  * getline() reads an entire line from stream, storing the address of the buffer
526  * containing the text into *buf.  The buffer is null-terminated and includes
527  * the newline character, if one was found.
528  *
529  * If *buf is NULL, then getline() will allocate a buffer for storing the line,
530  * which should be freed by the user program.  Alternatively, before calling getline(),
531  * *buf can contain a pointer to a malloc()-allocated buffer *n bytes in size.  If the buffer
532  * is not large enough to hold the line, getline() resizes it with realloc(), updating *buf and *n
533  * as necessary.  In either case, on a successful call, *buf and *n will be updated to
534  * reflect the buffer address and allocated size respectively.
535  */
536 long getline(char **buf, size_t * n, FILE * stream)
537 {
538
539   size_t i;
540   int ch;
541
542   if (!*buf) {
543     *buf = xbt_malloc(512);
544     *n = 512;
545   }
546
547   if (feof(stream))
548     return (ssize_t) - 1;
549
550   for (i = 0; (ch = fgetc(stream)) != EOF; i++) {
551
552     if (i >= (*n) + 1)
553       *buf = xbt_realloc(*buf, *n += 512);
554
555     (*buf)[i] = ch;
556
557     if ((*buf)[i] == '\n') {
558       i++;
559       (*buf)[i] = '\0';
560       break;
561     }
562   }
563
564   if (i == *n)
565     *buf = xbt_realloc(*buf, *n += 1);
566
567   (*buf)[i] = '\0';
568
569   return (ssize_t) i;
570 }
571
572 #endif                          /* HAVE_GETLINE */
573
574 /*
575  * Diff related functions
576  */
577 static XBT_INLINE int diff_get(xbt_matrix_t C, int i, int j)
578 {
579   return (i == -1 || j == -1) ? 0 : xbt_matrix_get_as(C, i, j, int);
580 }
581
582 static xbt_matrix_t diff_build_LCS(xbt_dynar_t da, xbt_dynar_t db,
583                                    int len_a, int len_b)
584 {
585   xbt_matrix_t C = xbt_matrix_new(len_a, len_b, sizeof(int), NULL);
586   int i, j;
587
588   /* Compute the LCS */
589   /*
590      function LCSLength(X[1..m], Y[1..n])
591        C = array(0..m, 0..n)
592        for i := 0..m
593          C[i,0] = 0
594        for j := 1..n
595          C[0,j] = 0
596        for i := 1..m
597          for j := 1..n
598            if X[i] = Y[j]
599              C[i,j] := C[i-1,j-1] + 1
600            else:
601              C[i,j] := max(C[i,j-1], C[i-1,j])
602        return C[m,n]
603    */
604   for (i = 0; i < len_a; i++)
605     for (j = 0; j < len_b; j++) {
606
607       if (!strcmp(xbt_dynar_get_as(da, i, char *),
608                   xbt_dynar_get_as(db, j, char *)))
609         *((int *) xbt_matrix_get_ptr(C, i, j)) = diff_get(C, i - 1, j - 1) + 1;
610       else
611         *((int *) xbt_matrix_get_ptr(C, i, j)) = max(diff_get(C, i, j - 1),
612                                                      diff_get(C, i - 1, j));
613     }
614   return C;
615 }
616
617 static void diff_build_diff(xbt_dynar_t res,
618                             xbt_matrix_t C,
619                             xbt_dynar_t da, xbt_dynar_t db, int i, int j)
620 {
621   char *topush;
622   /* Construct the diff
623      function printDiff(C[0..m,0..n], X[1..m], Y[1..n], i, j)
624        if i > 0 and j > 0 and X[i] = Y[j]
625          printDiff(C, X, Y, i-1, j-1)
626          print "  " + X[i]
627        else
628          if j > 0 and (i = 0 or C[i,j-1] >= C[i-1,j])
629            printDiff(C, X, Y, i, j-1)
630            print "+ " + Y[j]
631          else if i > 0 and (j = 0 or C[i,j-1] < C[i-1,j])
632            printDiff(C, X, Y, i-1, j)
633            print "- " + X[i]
634    */
635
636   if (i >= 0 && j >= 0 && !strcmp(xbt_dynar_get_as(da, i, char *),
637                                   xbt_dynar_get_as(db, j, char *))) {
638     diff_build_diff(res, C, da, db, i - 1, j - 1);
639     topush = bprintf("  %s", xbt_dynar_get_as(da, i, char *));
640     xbt_dynar_push(res, &topush);
641   } else if (j >= 0 &&
642              (i == -1 || diff_get(C, i, j - 1) >= diff_get(C, i - 1, j))) {
643     diff_build_diff(res, C, da, db, i, j - 1);
644     topush = bprintf("+ %s", xbt_dynar_get_as(db, j, char *));
645     xbt_dynar_push(res, &topush);
646   } else if (i >= 0 &&
647              (j == -1 || diff_get(C, i, j - 1) < diff_get(C, i - 1, j))) {
648     diff_build_diff(res, C, da, db, i - 1, j);
649     topush = bprintf("- %s", xbt_dynar_get_as(da, i, char *));
650     xbt_dynar_push(res, &topush);
651   }
652 }
653
654 /** @brief Compute the unified diff of two strings */
655 char *xbt_str_diff(const char *a, const char *b)
656 {
657   xbt_dynar_t da = xbt_str_split(a, "\n");
658   xbt_dynar_t db = xbt_str_split(b, "\n");
659   xbt_matrix_t C;
660   xbt_dynar_t diff;
661   char *res;
662   size_t len;
663   unsigned length_da;
664
665   diff = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
666
667   /* Clean empty lines at the end of da and db */
668   len = strlen(a);
669   if (len > 0 && a[len - 1] == '\n')
670     xbt_dynar_pop(da, NULL);
671   len = strlen(b);
672   if (len > 0 && b[len - 1] == '\n')
673     xbt_dynar_pop(db, NULL);
674
675   /* Find the common suffix, do it before extracting the prefix,
676    * as xbt_dynar_pop costs less than xbt_dynar_shift */
677   length_da = xbt_dynar_length(da);
678   while (length_da > 0 && xbt_dynar_length(db) > 0 &&
679          !strcmp(xbt_dynar_get_as(da, length_da - 1, char *),
680                  xbt_dynar_getlast_as(db, char *))) {
681     xbt_dynar_pop(db, NULL);
682     length_da--;
683   }
684
685   /* Extract the common prefix */
686   while (length_da > 0 && xbt_dynar_length(db) > 0 &&
687          !strcmp(xbt_dynar_getfirst_as(da, char *),
688                  xbt_dynar_getfirst_as(db, char *))) {
689     char *topush = bprintf("  %s", xbt_dynar_getfirst_as(da, char *));
690     xbt_dynar_push(diff, &topush);
691     xbt_dynar_shift(da, NULL);
692     xbt_dynar_shift(db, NULL);
693     length_da--;
694   }
695
696   /* Compute the diff for the remaining */
697   C = diff_build_LCS(da, db, length_da, xbt_dynar_length(db));
698   diff_build_diff(diff, C, da, db, length_da - 1, xbt_dynar_length(db) - 1);
699   xbt_matrix_free(C);
700   xbt_dynar_free(&db);
701
702   /* Add the common suffix */
703   for (; length_da < xbt_dynar_length(da); length_da++) {
704     char *topush = bprintf("  %s", xbt_dynar_get_as(da, length_da, char *));
705     xbt_dynar_push(diff, &topush);
706   }
707   xbt_dynar_free(&da);
708
709   /* Build the final result */
710   res = xbt_str_join(diff, "\n");
711   xbt_dynar_free(&diff);
712
713   return res;
714 }
715
716
717 /** @brief creates a new string containing what can be read on a fd
718  *
719  */
720 char *xbt_str_from_file(FILE * file)
721 {
722   xbt_strbuff_t buff = xbt_strbuff_new();
723   char *res;
724   char bread[1024];
725   memset(bread, 0, 1024);
726
727   while (!feof(file)) {
728     int got = fread(bread, 1, 1023, file);
729     bread[got] = '\0';
730     xbt_strbuff_append(buff, bread);
731   }
732
733   res = buff->data;
734   xbt_strbuff_free_container(buff);
735   return res;
736 }
737
738 #ifdef SIMGRID_TEST
739 #include "xbt/str.h"
740
741 #define mytest(name, input, expected) \
742   xbt_test_add(name); \
743   d=xbt_str_split_quoted(input); \
744   s=xbt_str_join(d,"XXX"); \
745   xbt_test_assert(!strcmp(s,expected),\
746                    "Input (%s) leads to (%s) instead of (%s)", \
747                    input,s,expected);\
748                    free(s); \
749                    xbt_dynar_free(&d);
750
751 XBT_TEST_SUITE("xbt_str", "String Handling");
752 XBT_TEST_UNIT("xbt_str_split_quoted", test_split_quoted, "test the function xbt_str_split_quoted")
753 {
754   xbt_dynar_t d;
755   char *s;
756
757   mytest("Empty", "", "");
758   mytest("Basic test", "toto tutu", "totoXXXtutu");
759   mytest("Useless backslashes", "\\t\\o\\t\\o \\t\\u\\t\\u",
760          "totoXXXtutu");
761   mytest("Protected space", "toto\\ tutu", "toto tutu");
762   mytest("Several spaces", "toto   tutu", "totoXXXtutu");
763   mytest("LTriming", "  toto tatu", "totoXXXtatu");
764   mytest("Triming", "  toto   tutu  ", "totoXXXtutu");
765   mytest("Single quotes", "'toto tutu' tata", "toto tutuXXXtata");
766   mytest("Double quotes", "\"toto tutu\" tata", "toto tutuXXXtata");
767   mytest("Mixed quotes", "\"toto' 'tutu\" tata", "toto' 'tutuXXXtata");
768   mytest("Backslashed quotes", "\\'toto tutu\\' tata",
769          "'totoXXXtutu'XXXtata");
770   mytest("Backslashed quotes + quotes", "'toto \\'tutu' tata",
771          "toto 'tutuXXXtata");
772
773 }
774
775 #define mytest_str(name, input, separator, expected) \
776   xbt_test_add(name); \
777   d=xbt_str_split_str(input, separator); \
778   s=xbt_str_join(d,"XXX"); \
779   xbt_test_assert(!strcmp(s,expected),\
780                    "Input (%s) leads to (%s) instead of (%s)", \
781                    input,s,expected);\
782                    free(s); \
783                    xbt_dynar_free(&d);
784
785 XBT_TEST_UNIT("xbt_str_split_str", test_split_str, "test the function xbt_str_split_str")
786 {
787   xbt_dynar_t d;
788   char *s;
789
790   mytest_str("Empty string and separator", "", "", "");
791   mytest_str("Empty string", "", "##", "");
792   mytest_str("Empty separator", "toto", "", "toto");
793   mytest_str("String with no separator in it", "toto", "##", "toto");
794   mytest_str("Basic test", "toto##tutu", "##", "totoXXXtutu");
795 }
796
797 /* Last args are format string and parameters for xbt_test_add */
798 #define mytest_diff(s1, s2, diff, ...)                                  \
799   do {                                                                  \
800     char *mytest_diff_res;                                              \
801     xbt_test_add(__VA_ARGS__);                                          \
802     mytest_diff_res = xbt_str_diff(s1, s2);                             \
803     xbt_test_assert(!strcmp(mytest_diff_res, diff),                     \
804                     "Wrong output:\n--- got:\n%s\n--- expected:\n%s\n---", \
805                     mytest_diff_res, diff);                             \
806     free(mytest_diff_res);                                              \
807   } while (0)
808
809 XBT_TEST_UNIT("xbt_str_diff", test_diff, "test the function xbt_str_diff")
810 {
811   unsigned i;
812
813   /* Trivial cases */
814   mytest_diff("a", "a", "  a", "1 word, no difference");
815   mytest_diff("a", "A", "- a\n+ A", "1 word, different");
816   mytest_diff("a\n", "a\n", "  a", "1 line, no difference");
817   mytest_diff("a\n", "A\n", "- a\n+ A", "1 line, different");
818
819   /* Empty strings */
820   mytest_diff("", "", "", "empty strings");
821   mytest_diff("", "a", "+ a", "1 word, added");
822   mytest_diff("a", "", "- a", "1 word, removed");
823   mytest_diff("", "a\n", "+ a", "1 line, added");
824   mytest_diff("a\n", "", "- a", "1 line, removed");
825   mytest_diff("", "a\nb\nc\n", "+ a\n+ b\n+ c", "4 lines, all added");
826   mytest_diff("a\nb\nc\n", "", "- a\n- b\n- c", "4 lines, all removed");
827
828   /* Empty lines */
829   mytest_diff("\n", "\n", "  ", "empty lines");
830   mytest_diff("", "\n", "+ ", "empty line, added");
831   mytest_diff("\n", "", "- ", "empty line, removed");
832
833   mytest_diff("a", "\na", "+ \n  a", "empty line added before word");
834   mytest_diff("a", "a\n\n", "  a\n+ ", "empty line added after word");
835   mytest_diff("\na", "a", "- \n  a", "empty line removed before word");
836   mytest_diff("a\n\n", "a", "  a\n- ", "empty line removed after word");
837
838   mytest_diff("a\n", "\na\n", "+ \n  a", "empty line added before line");
839   mytest_diff("a\n", "a\n\n", "  a\n+ ", "empty line added after line");
840   mytest_diff("\na\n", "a\n", "- \n  a", "empty line removed before line");
841   mytest_diff("a\n\n", "a\n", "  a\n- ", "empty line removed after line");
842
843   mytest_diff("a\nb\nc\nd\n", "\na\nb\nc\nd\n", "+ \n  a\n  b\n  c\n  d",
844               "empty line added before 4 lines");
845   mytest_diff("a\nb\nc\nd\n", "a\nb\nc\nd\n\n", "  a\n  b\n  c\n  d\n+ ",
846               "empty line added after 4 lines");
847   mytest_diff("\na\nb\nc\nd\n", "a\nb\nc\nd\n", "- \n  a\n  b\n  c\n  d",
848               "empty line removed before 4 lines");
849   mytest_diff("a\nb\nc\nd\n\n", "a\nb\nc\nd\n", "  a\n  b\n  c\n  d\n- ",
850               "empty line removed after 4 lines");
851
852   /* Missing newline at the end of one of the strings */
853   mytest_diff("a\n", "a", "  a", "1 line, 1 word, no difference");
854   mytest_diff("a", "a\n", "  a", "1 word, 1 line, no difference");
855   mytest_diff("a\n", "A", "- a\n+ A", "1 line, 1 word, different");
856   mytest_diff("a", "A\n", "- a\n+ A", "1 word, 1 line, different");
857
858   mytest_diff("a\nb\nc\nd", "a\nb\nc\nd\n", "  a\n  b\n  c\n  d",
859               "4 lines, no newline on first");
860   mytest_diff("a\nb\nc\nd\n", "a\nb\nc\nd", "  a\n  b\n  c\n  d",
861               "4 lines, no newline on second");
862
863   /* Four lines, all combinations of differences */
864   for (i = 0 ; i < (1U << 4) ; i++) {
865     char d2[4 + 1];
866     char s2[4 * 2 + 1];
867     char res[4 * 8 + 1];
868     char *pd = d2;
869     char *ps = s2;
870     char *pr = res;
871     unsigned j = 0;
872     while (j < 4) {
873       unsigned k;
874       for (/* j */ ; j < 4 && !(i & (1U << j)) ; j++) {
875         *pd++ = "abcd"[j];
876         ps += sprintf(ps, "%c\n", "abcd"[j]);
877         pr += sprintf(pr, "  %c\n", "abcd"[j]);
878       }
879       for (k = j ; k < 4 && (i & (1U << k)) ; k++) {
880         *pd++ = "ABCD"[k];
881         ps += sprintf(ps, "%c\n", "ABCD"[k]);
882         pr += sprintf(pr, "- %c\n", "abcd"[k]);
883       }
884       for (/* j */ ; j < k ; j++) {
885         pr += sprintf(pr, "+ %c\n", "ABCD"[j]);
886       }
887     }
888     *pd = '\0';
889     *--pr = '\0';               /* strip last '\n' from expected result */
890     mytest_diff("a\nb\nc\nd\n", s2, res,
891                 "compare (abcd) with changed (%s)", d2);
892   }
893
894   /* Subsets of four lines, do not test for empty subset */
895   for (i = 1 ; i < (1U << 4) ; i++) {
896     char d2[4 + 1];
897     char s2[4 * 2 + 1];
898     char res[4 * 8 + 1];
899     char *pd = d2;
900     char *ps = s2;
901     char *pr = res;
902     unsigned j = 0;
903     while (j < 4) {
904       for (/* j */ ; j < 4 && (i & (1U << j)) ; j++) {
905         *pd++ = "abcd"[j];
906         ps += sprintf(ps, "%c\n", "abcd"[j]);
907         pr += sprintf(pr, "  %c\n", "abcd"[j]);
908       }
909       for (/* j */; j < 4 && !(i & (1U << j)) ; j++) {
910         pr += sprintf(pr, "- %c\n", "abcd"[j]);
911       }
912     }
913     *pd = '\0';
914     *--pr = '\0';               /* strip last '\n' from expected result */
915     mytest_diff("a\nb\nc\nd\n", s2, res,
916                 "compare (abcd) with subset (%s)", d2);
917
918     for (pr = res ; *pr != '\0' ; pr++)
919       if (*pr == '-')
920         *pr = '+';
921     mytest_diff(s2, "a\nb\nc\nd\n", res,
922                 "compare subset (%s) with (abcd)", d2);
923   }
924 }
925
926 #endif                          /* SIMGRID_TEST */