Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
do not trim in split_quoted, that's expensive, and the caller can do it if his input...
[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 where to apply the change
195  * @param patterns what to change
196  * @return The string modified
197  *
198  * Check xbt_strbuff_varsubst() for more details, and remember that the string may be reallocated (moved) in the process.
199  */
200
201 char *xbt_str_varsubst(char *str, xbt_dict_t patterns)
202 {
203   xbt_strbuff_t buff = xbt_strbuff_new_from(str);
204   char *res;
205   xbt_strbuff_varsubst(buff, patterns);
206   res = buff->data;
207   xbt_strbuff_free_container(buff);
208   return res;
209 }
210
211
212 /** @brief Splits a string into a dynar of strings
213  *
214  * @param s: the string to split
215  * @param sep: a string of all chars to consider as separator.
216  *
217  * By default (with sep=NULL), these characters are used as separator:
218  *
219  *      - " "           (ASCII 32       (0x20)) space.
220  *      - "\t"          (ASCII 9        (0x09)) tab.
221  *      - "\n"          (ASCII 10       (0x0A)) line feed.
222  *      - "\r"          (ASCII 13       (0x0D)) carriage return.
223  *      - "\0"          (ASCII 0        (0x00)) NULL.
224  *      - "\x0B"        (ASCII 11       (0x0B)) vertical tab.
225  */
226
227 xbt_dynar_t xbt_str_split(const char *s, const char *sep)
228 {
229   xbt_dynar_t res = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
230   const char *p, *q;
231   int done;
232   const char *sep_dflt = " \t\n\r\x0B";
233   char is_sep[256] = { 1, 0 };
234
235   /* check what are the separators */
236   memset(is_sep, 0, sizeof(is_sep));
237   if (!sep) {
238     while (*sep_dflt)
239       is_sep[(unsigned char) *sep_dflt++] = 1;
240   } else {
241     while (*sep)
242       is_sep[(unsigned char) *sep++] = 1;
243   }
244   is_sep[0] = 1;                /* End of string is also separator */
245
246   /* Do the job */
247   p = q = s;
248   done = 0;
249
250   if (s[0] == '\0')
251     return res;
252
253   while (!done) {
254     char *topush;
255     while (!is_sep[(unsigned char) *q]) {
256       q++;
257     }
258     if (*q == '\0')
259       done = 1;
260
261     topush = xbt_malloc(q - p + 1);
262     memcpy(topush, p, q - p);
263     topush[q - p] = '\0';
264     xbt_dynar_push(res, &topush);
265     p = ++q;
266   }
267
268   return res;
269 }
270
271 /**
272  * \brief This functions splits a string after using another string as separator
273  * For example A!!B!!C splitted after !! will return the dynar {A,B,C}
274  * \return An array of dynars containing the string tokens
275  */
276 xbt_dynar_t xbt_str_split_str(const char *s, const char *sep)
277 {
278   xbt_dynar_t res = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
279   int done;
280   const char *p, *q;
281
282   p = q = s;
283   done = 0;
284
285   if (s[0] == '\0')
286     return res;
287   if (sep[0] == '\0') {
288     s = xbt_strdup(s);
289     xbt_dynar_push(res, &s);
290     return res;
291   }
292
293   while (!done) {
294     char *to_push;
295     int v = 0;
296     //get the start of the first occurence of the substring
297     q = strstr(p, sep);
298     //if substring was not found add the entire string
299     if (NULL == q) {
300       v = strlen(p);
301       to_push = malloc(v + 1);
302       memcpy(to_push, p, v);
303       to_push[v] = '\0';
304       xbt_dynar_push(res, &to_push);
305       done = 1;
306     } else {
307       //get the appearance
308       to_push = malloc(q - p + 1);
309       memcpy(to_push, p, q - p);
310       //add string terminator
311       to_push[q - p] = '\0';
312       xbt_dynar_push(res, &to_push);
313       p = q + strlen(sep);
314     }
315   }
316   return res;
317 }
318
319 /** @brief Splits a string into a dynar of strings, taking quotes into account
320  *
321  * It basically does the same argument separation than the shell, where white
322  * spaces can be escaped and where arguments are never split within a
323  * quote group.
324  * Several subsequent spaces are ignored (unless within quotes, of course).
325  * You may want to trim the input string, if you want to avoid empty entries
326  *
327  */
328
329 xbt_dynar_t xbt_str_split_quoted(const char *s)
330 {
331   xbt_dynar_t res = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
332   char *str_to_free;            /* we have to copy the string before, to handle backslashes */
333   char *beg, *end;              /* pointers around the parsed chunk */
334   int in_simple_quote = 0, in_double_quote = 0;
335   int done = 0;
336   int ctn = 0;                  /* Got something in this block */
337
338   if (s[0] == '\0')
339     return res;
340   beg = str_to_free = xbt_strdup(s);
341
342   /* do not trim leading spaces: caller responsability to clean his cruft */
343   end = beg;
344
345   while (!done) {
346
347
348     switch (*end) {
349     case '\\':
350       ctn = 1;
351       /* Protected char; move it closer */
352       memmove(end, end + 1, strlen(end));
353       if (*end == '\0')
354         THROW0(arg_error, 0, "String ends with \\");
355       end++;                    /* Pass the protected char */
356       break;
357
358     case '\'':
359       ctn = 1;
360       if (!in_double_quote) {
361         in_simple_quote = !in_simple_quote;
362         memmove(end, end + 1, strlen(end));
363       } else {
364         /* simple quote protected by double ones */
365         end++;
366       }
367       break;
368     case '"':
369       ctn = 1;
370       if (!in_simple_quote) {
371         in_double_quote = !in_double_quote;
372         memmove(end, end + 1, strlen(end));
373       } else {
374         /* double quote protected by simple ones */
375         end++;
376       }
377       break;
378
379     case ' ':
380     case '\t':
381     case '\n':
382     case '\0':
383       if (*end == '\0' && (in_simple_quote || in_double_quote)) {
384         THROW2(arg_error, 0,
385                "End of string found while searching for %c in %s",
386                (in_simple_quote ? '\'' : '"'), s);
387       }
388       if (in_simple_quote || in_double_quote) {
389         end++;
390       } else {
391         if (ctn) {
392           /* Found a separator. Push the string if contains something */
393           char *topush = xbt_malloc(end - beg + 1);
394           memcpy(topush, beg, end - beg);
395           topush[end - beg] = '\0';
396           xbt_dynar_push(res, &topush);
397         }
398         ctn = 0;
399
400         if (*end == '\0') {
401           done = 1;
402           break;
403         }
404
405         beg = ++end;
406         /* trim within the string, manually to speed things up */
407         while (*beg == ' ')
408           beg++;
409         end = beg;
410       }
411       break;
412
413     default:
414       ctn = 1;
415       end++;
416     }
417   }
418   free(str_to_free);
419   xbt_dynar_shrink(res, 0);
420   return res;
421 }
422
423 #ifdef SIMGRID_TEST
424 #include "xbt/str.h"
425
426 #define mytest(name, input, expected) \
427   xbt_test_add0(name); \
428   d=xbt_str_split_quoted(input); \
429   s=xbt_str_join(d,"XXX"); \
430   xbt_test_assert3(!strcmp(s,expected),\
431                    "Input (%s) leads to (%s) instead of (%s)", \
432                    input,s,expected);\
433                    free(s); \
434                    xbt_dynar_free(&d);
435
436 XBT_TEST_SUITE("xbt_str", "String Handling");
437 XBT_TEST_UNIT("xbt_str_split_quoted", test_split_quoted, "test the function xbt_str_split_quoted")
438 {
439   xbt_dynar_t d;
440   char *s;
441
442   mytest("Empty", "", "");
443   mytest("Basic test", "toto tutu", "totoXXXtutu");
444   mytest("Useless backslashes", "\\t\\o\\t\\o \\t\\u\\t\\u",
445          "totoXXXtutu");
446   mytest("Protected space", "toto\\ tutu", "toto tutu");
447   mytest("Several spaces", "toto   tutu", "totoXXXtutu");
448   mytest("LTriming", "  toto tatu", "totoXXXtatu");
449   mytest("Triming", "  toto   tutu  ", "totoXXXtutu");
450   mytest("Single quotes", "'toto tutu' tata", "toto tutuXXXtata");
451   mytest("Double quotes", "\"toto tutu\" tata", "toto tutuXXXtata");
452   mytest("Mixed quotes", "\"toto' 'tutu\" tata", "toto' 'tutuXXXtata");
453   mytest("Backslashed quotes", "\\'toto tutu\\' tata",
454          "'totoXXXtutu'XXXtata");
455   mytest("Backslashed quotes + quotes", "'toto \\'tutu' tata",
456          "toto 'tutuXXXtata");
457
458 }
459
460 #define mytest_str(name, input, separator, expected) \
461   xbt_test_add0(name); \
462   d=xbt_str_split_str(input, separator); \
463   s=xbt_str_join(d,"XXX"); \
464   xbt_test_assert3(!strcmp(s,expected),\
465                    "Input (%s) leads to (%s) instead of (%s)", \
466                    input,s,expected);\
467                    free(s); \
468                    xbt_dynar_free(&d);
469
470 XBT_TEST_UNIT("xbt_str_split_str", test_split_str, "test the function xbt_str_split_str")
471 {
472   xbt_dynar_t d;
473   char *s;
474
475   mytest_str("Empty string and separator", "", "", "");
476   mytest_str("Empty string", "", "##", "");
477   mytest_str("Empty separator", "toto", "", "toto");
478   mytest_str("String with no separator in it", "toto", "##", "toto");
479   mytest_str("Basic test", "toto##tutu", "##", "totoXXXtutu");
480 }
481 #endif                          /* SIMGRID_TEST */
482
483 /** @brief Join a set of strings as a single string */
484
485 char *xbt_str_join(xbt_dynar_t dyn, const char *sep)
486 {
487   int len = 1, dyn_len = xbt_dynar_length(dyn);
488   unsigned int cpt;
489   char *cursor;
490   char *res, *p;
491
492   if (!dyn_len)
493     return xbt_strdup("");
494
495   /* compute the length */
496   xbt_dynar_foreach(dyn, cpt, cursor) {
497     len += strlen(cursor);
498   }
499   len += strlen(sep) * dyn_len;
500   /* Do the job */
501   res = xbt_malloc(len);
502   p = res;
503   xbt_dynar_foreach(dyn, cpt, cursor) {
504     if ((int) cpt < dyn_len - 1)
505       p += sprintf(p, "%s%s", cursor, sep);
506     else
507       p += sprintf(p, "%s", cursor);
508   }
509   return res;
510 }
511
512 #if defined(SIMGRID_NEED_GETLINE) || defined(DOXYGEN)
513 /** @brief Get a single line from the stream (reimplementation of the GNU getline)
514  *
515  * This is a redefinition of the GNU getline function, used on platforms where it does not exists.
516  *
517  * getline() reads an entire line from stream, storing the address of the buffer
518  * containing the text into *buf.  The buffer is null-terminated and includes
519  * the newline character, if one was found.
520  *
521  * If *buf is NULL, then getline() will allocate a buffer for storing the line,
522  * which should be freed by the user program.  Alternatively, before calling getline(),
523  * *buf can contain a pointer to a malloc()-allocated buffer *n bytes in size.  If the buffer
524  * is not large enough to hold the line, getline() resizes it with realloc(), updating *buf and *n
525  * as necessary.  In either case, on a successful call, *buf and *n will be updated to
526  * reflect the buffer address and allocated size respectively.
527  */
528 long getline(char **buf, size_t * n, FILE * stream)
529 {
530
531   size_t i;
532   int ch;
533
534   if (!*buf) {
535     *buf = xbt_malloc(512);
536     *n = 512;
537   }
538
539   if (feof(stream))
540     return (ssize_t) - 1;
541
542   for (i = 0; (ch = fgetc(stream)) != EOF; i++) {
543
544     if (i >= (*n) + 1)
545       *buf = xbt_realloc(*buf, *n += 512);
546
547     (*buf)[i] = ch;
548
549     if ((*buf)[i] == '\n') {
550       i++;
551       (*buf)[i] = '\0';
552       break;
553     }
554   }
555
556   if (i == *n)
557     *buf = xbt_realloc(*buf, *n += 1);
558
559   (*buf)[i] = '\0';
560
561   return (ssize_t) i;
562 }
563
564 #endif                          /* HAVE_GETLINE */
565
566 /*
567  * Diff related functions
568  */
569 static xbt_matrix_t diff_build_LCS(xbt_dynar_t da, xbt_dynar_t db)
570 {
571   xbt_matrix_t C =
572       xbt_matrix_new(xbt_dynar_length(da), xbt_dynar_length(db),
573                      sizeof(int), NULL);
574   unsigned long i, j;
575
576   /* Compute the LCS */
577   /*
578      C = array(0..m, 0..n)
579      for i := 0..m
580      C[i,0] = 0
581      for j := 1..n
582      C[0,j] = 0
583      for i := 1..m
584      for j := 1..n
585      if X[i] = Y[j]
586      C[i,j] := C[i-1,j-1] + 1
587      else:
588      C[i,j] := max(C[i,j-1], C[i-1,j])
589      return C[m,n]
590    */
591   if (xbt_dynar_length(db) != 0)
592     for (i = 0; i < xbt_dynar_length(da); i++)
593       *((int *) xbt_matrix_get_ptr(C, i, 0)) = 0;
594
595   if (xbt_dynar_length(da) != 0)
596     for (j = 0; j < xbt_dynar_length(db); j++)
597       *((int *) xbt_matrix_get_ptr(C, 0, j)) = 0;
598
599   for (i = 1; i < xbt_dynar_length(da); i++)
600     for (j = 1; j < xbt_dynar_length(db); j++) {
601
602       if (!strcmp
603           (xbt_dynar_get_as(da, i, char *),
604            xbt_dynar_get_as(db, j, char *)))
605         *((int *) xbt_matrix_get_ptr(C, i, j)) =
606             xbt_matrix_get_as(C, i - 1, j - 1, int) + 1;
607       else
608         *((int *) xbt_matrix_get_ptr(C, i, j)) =
609             max(xbt_matrix_get_as(C, i, j - 1, int),
610                 xbt_matrix_get_as(C, i - 1, j, int));
611     }
612   return C;
613 }
614
615 static void diff_build_diff(xbt_dynar_t res,
616                             xbt_matrix_t C,
617                             xbt_dynar_t da, xbt_dynar_t db, int i, int j)
618 {
619   char *topush;
620   /* Construct the diff
621      function printDiff(C[0..m,0..n], X[1..m], Y[1..n], i, j)
622      if i > 0 and j > 0 and X[i] = Y[j]
623      printDiff(C, X, Y, i-1, j-1)
624      print "  " + X[i]
625      else
626      if j > 0 and (i = 0 or C[i,j-1] >= C[i-1,j])
627      printDiff(C, X, Y, i, j-1)
628      print "+ " + Y[j]
629      else if i > 0 and (j = 0 or C[i,j-1] < C[i-1,j])
630      printDiff(C, X, Y, i-1, j)
631      print "- " + X[i]
632    */
633
634   if (i >= 0 && j >= 0 && !strcmp(xbt_dynar_get_as(da, i, char *),
635                                   xbt_dynar_get_as(db, j, char *))) {
636     diff_build_diff(res, C, da, db, i - 1, j - 1);
637     topush = bprintf("  %s", xbt_dynar_get_as(da, i, char *));
638     xbt_dynar_push(res, &topush);
639   } else if (j >= 0 &&
640              (i <= 0 || j == 0
641               || xbt_matrix_get_as(C, i, j - 1,
642                                    int) >= xbt_matrix_get_as(C, i - 1, j,
643                                                              int))) {
644     diff_build_diff(res, C, da, db, i, j - 1);
645     topush = bprintf("+ %s", xbt_dynar_get_as(db, j, char *));
646     xbt_dynar_push(res, &topush);
647   } else if (i >= 0 &&
648              (j <= 0
649               || xbt_matrix_get_as(C, i, j - 1, int) < xbt_matrix_get_as(C,
650                                                                          i
651                                                                          -
652                                                                          1,
653                                                                          j,
654                                                                          int)))
655   {
656     diff_build_diff(res, C, da, db, i - 1, j);
657     topush = bprintf("- %s", xbt_dynar_get_as(da, i, char *));
658     xbt_dynar_push(res, &topush);
659   } else if (i <= 0 && j <= 0) {
660     return;
661   } else {
662     THROW2(arg_error, 0, "Invalid values: i=%d, j=%d", i, j);
663   }
664
665 }
666
667 /** @brief Compute the unified diff of two strings */
668 char *xbt_str_diff(char *a, char *b)
669 {
670   xbt_dynar_t da = xbt_str_split(a, "\n");
671   xbt_dynar_t db = xbt_str_split(b, "\n");
672
673   xbt_matrix_t C = diff_build_LCS(da, db);
674   xbt_dynar_t diff = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
675   char *res = NULL;
676
677   diff_build_diff(diff, C, da, db, xbt_dynar_length(da) - 1,
678                   xbt_dynar_length(db) - 1);
679   /* Clean empty lines at the end */
680   while (xbt_dynar_length(diff) > 0) {
681     char *str;
682     xbt_dynar_pop(diff, &str);
683     if (str[0] == '\0' || !strcmp(str, "  ")) {
684       free(str);
685     } else {
686       xbt_dynar_push(diff, &str);
687       break;
688     }
689   }
690   res = xbt_str_join(diff, "\n");
691
692   xbt_dynar_free(&da);
693   xbt_dynar_free(&db);
694   xbt_dynar_free(&diff);
695   xbt_matrix_free(C);
696
697   return res;
698 }
699
700
701 /** @brief creates a new string containing what can be read on a fd
702  *
703  */
704 char *xbt_str_from_file(FILE * file)
705 {
706   xbt_strbuff_t buff = xbt_strbuff_new();
707   char *res;
708   char bread[1024];
709   memset(bread, 0, 1024);
710
711   while (!feof(file)) {
712     int got = fread(bread, 1, 1023, file);
713     bread[got] = '\0';
714     xbt_strbuff_append(buff, bread);
715   }
716
717   res = buff->data;
718   xbt_strbuff_free_container(buff);
719   return res;
720 }