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 {
 584   xbt_matrix_t C =
 585       xbt_matrix_new(xbt_dynar_length(da), xbt_dynar_length(db),
 586                      sizeof(int), NULL);
 587   int i, j;
 588
 589   /* Compute the LCS */
 590   /*
 591      function LCSLength(X[1..m], Y[1..n])
 592        C = array(0..m, 0..n)
 593        for i := 0..m
 594          C[i,0] = 0
 595        for j := 1..n
 596          C[0,j] = 0
 597        for i := 1..m
 598          for j := 1..n
 599            if X[i] = Y[j]
 600              C[i,j] := C[i-1,j-1] + 1
 601            else:
 602              C[i,j] := max(C[i,j-1], C[i-1,j])
 603        return C[m,n]
 604    */
 605   for (i = 0; i < (int)xbt_dynar_length(da); i++)
 606     for (j = 0; j < (int)xbt_dynar_length(db); j++) {
 607
 608       if (!strcmp(xbt_dynar_get_as(da, i, char *),
 609                   xbt_dynar_get_as(db, j, char *)))
 610         *((int *) xbt_matrix_get_ptr(C, i, j)) = diff_get(C, i - 1, j - 1) + 1;
 611       else
 612         *((int *) xbt_matrix_get_ptr(C, i, j)) = max(diff_get(C, i, j - 1),
 613                                                      diff_get(C, i - 1, j));
 614     }
 615   return C;
 616 }
 617
 618 static void diff_build_diff(xbt_dynar_t res,
 619                             xbt_matrix_t C,
 620                             xbt_dynar_t da, xbt_dynar_t db, int i, int j)
 621 {
 622   char *topush;
 623   /* Construct the diff
 624      function printDiff(C[0..m,0..n], X[1..m], Y[1..n], i, j)
 625        if i > 0 and j > 0 and X[i] = Y[j]
 626          printDiff(C, X, Y, i-1, j-1)
 627          print "  " + X[i]
 628        else
 629          if j > 0 and (i = 0 or C[i,j-1] >= C[i-1,j])
 630            printDiff(C, X, Y, i, j-1)
 631            print "+ " + Y[j]
 632          else if i > 0 and (j = 0 or C[i,j-1] < C[i-1,j])
 633            printDiff(C, X, Y, i-1, j)
 634            print "- " + X[i]
 635    */
 636
 637   if (i >= 0 && j >= 0 && !strcmp(xbt_dynar_get_as(da, i, char *),
 638                                   xbt_dynar_get_as(db, j, char *))) {
 639     diff_build_diff(res, C, da, db, i - 1, j - 1);
 640     topush = bprintf("  %s", xbt_dynar_get_as(da, i, char *));
 641     xbt_dynar_push(res, &topush);
 642   } else if (j >= 0 &&
 643              (i == -1 || diff_get(C, i, j - 1) >= diff_get(C, i - 1, j))) {
 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 == -1 || diff_get(C, i, j - 1) < diff_get(C, i - 1, j))) {
 649     diff_build_diff(res, C, da, db, i - 1, j);
 650     topush = bprintf("- %s", xbt_dynar_get_as(da, i, char *));
 651     xbt_dynar_push(res, &topush);
 652   }
 653 }
 654
 655 /** @brief Compute the unified diff of two strings */
 656 char *xbt_str_diff(const char *a, const char *b)
 657 {
 658   xbt_dynar_t da = xbt_str_split(a, "\n");
 659   xbt_dynar_t db = xbt_str_split(b, "\n");
 660   xbt_matrix_t C;
 661   xbt_dynar_t diff;
 662   char *res;
 663   size_t len;
 664
 665   /* Clean empty lines at the end of da and db */
 666   len = strlen(a);
 667   if (len > 0 && a[len - 1] == '\n') {
 668     char *str;
 669     xbt_dynar_pop(da, &str);
 670     free(str);
 671   }
 672   len = strlen(b);
 673   if (len > 0 && b[len - 1] == '\n') {
 674     char *str;
 675     xbt_dynar_pop(db, &str);
 676     free(str);
 677   }
 678
 679   C = diff_build_LCS(da, db);
 680   diff = xbt_dynar_new(sizeof(char *), &xbt_free_ref);
 681
 682   diff_build_diff(diff, C, da, db, xbt_dynar_length(da) - 1,
 683                   xbt_dynar_length(db) - 1);
 684   res = xbt_str_join(diff, "\n");
 685
 686   xbt_dynar_free(&da);
 687   xbt_dynar_free(&db);
 688   xbt_dynar_free(&diff);
 689   xbt_matrix_free(C);
 690
 691   return res;
 692 }
 693
 694
 695 /** @brief creates a new string containing what can be read on a fd
 696  *
 697  */
 698 char *xbt_str_from_file(FILE * file)
 699 {
 700   xbt_strbuff_t buff = xbt_strbuff_new();
 701   char *res;
 702   char bread[1024];
 703   memset(bread, 0, 1024);
 704
 705   while (!feof(file)) {
 706     int got = fread(bread, 1, 1023, file);
 707     bread[got] = '\0';
 708     xbt_strbuff_append(buff, bread);
 709   }
 710
 711   res = buff->data;
 712   xbt_strbuff_free_container(buff);
 713   return res;
 714 }
 715
 716 #ifdef SIMGRID_TEST
 717 #include "xbt/str.h"
 718
 719 #define mytest(name, input, expected) \
 720   xbt_test_add(name); \
 721   d=xbt_str_split_quoted(input); \
 722   s=xbt_str_join(d,"XXX"); \
 723   xbt_test_assert(!strcmp(s,expected),\
 724                    "Input (%s) leads to (%s) instead of (%s)", \
 725                    input,s,expected);\
 726                    free(s); \
 727                    xbt_dynar_free(&d);
 728
 729 XBT_TEST_SUITE("xbt_str", "String Handling");
 730 XBT_TEST_UNIT("xbt_str_split_quoted", test_split_quoted, "test the function xbt_str_split_quoted")
 731 {
 732   xbt_dynar_t d;
 733   char *s;
 734
 735   mytest("Empty", "", "");
 736   mytest("Basic test", "toto tutu", "totoXXXtutu");
 737   mytest("Useless backslashes", "\\t\\o\\t\\o \\t\\u\\t\\u",
 738          "totoXXXtutu");
 739   mytest("Protected space", "toto\\ tutu", "toto tutu");
 740   mytest("Several spaces", "toto   tutu", "totoXXXtutu");
 741   mytest("LTriming", "  toto tatu", "totoXXXtatu");
 742   mytest("Triming", "  toto   tutu  ", "totoXXXtutu");
 743   mytest("Single quotes", "'toto tutu' tata", "toto tutuXXXtata");
 744   mytest("Double quotes", "\"toto tutu\" tata", "toto tutuXXXtata");
 745   mytest("Mixed quotes", "\"toto' 'tutu\" tata", "toto' 'tutuXXXtata");
 746   mytest("Backslashed quotes", "\\'toto tutu\\' tata",
 747          "'totoXXXtutu'XXXtata");
 748   mytest("Backslashed quotes + quotes", "'toto \\'tutu' tata",
 749          "toto 'tutuXXXtata");
 750
 751 }
 752
 753 #define mytest_str(name, input, separator, expected) \
 754   xbt_test_add(name); \
 755   d=xbt_str_split_str(input, separator); \
 756   s=xbt_str_join(d,"XXX"); \
 757   xbt_test_assert(!strcmp(s,expected),\
 758                    "Input (%s) leads to (%s) instead of (%s)", \
 759                    input,s,expected);\
 760                    free(s); \
 761                    xbt_dynar_free(&d);
 762
 763 XBT_TEST_UNIT("xbt_str_split_str", test_split_str, "test the function xbt_str_split_str")
 764 {
 765   xbt_dynar_t d;
 766   char *s;
 767
 768   mytest_str("Empty string and separator", "", "", "");
 769   mytest_str("Empty string", "", "##", "");
 770   mytest_str("Empty separator", "toto", "", "toto");
 771   mytest_str("String with no separator in it", "toto", "##", "toto");
 772   mytest_str("Basic test", "toto##tutu", "##", "totoXXXtutu");
 773 }
 774
 775 /* Last args are format string and parameters for xbt_test_add */
 776 #define mytest_diff(s1, s2, diff, ...)                                  \
 777   do {                                                                  \
 778     char *mytest_diff_res;                                              \
 779     xbt_test_add(__VA_ARGS__);                                          \
 780     mytest_diff_res = xbt_str_diff(s1, s2);                             \
 781     xbt_test_assert(!strcmp(mytest_diff_res, diff),                     \
 782                     "Wrong output:\n--- got:\n%s\n--- expected:\n%s\n---", \
 783                     mytest_diff_res, diff);                             \
 784     free(mytest_diff_res);                                              \
 785   } while (0)
 786
 787 XBT_TEST_UNIT("xbt_str_diff", test_diff, "test the function xbt_str_diff")
 788 {
 789   unsigned i;
 790
 791   /* Trivial cases */
 792   mytest_diff("a", "a", "  a", "1 word, no difference");
 793   mytest_diff("a", "A", "- a\n+ A", "1 word, different");
 794   mytest_diff("a\n", "a\n", "  a", "1 line, no difference");
 795   mytest_diff("a\n", "A\n", "- a\n+ A", "1 line, different");
 796
 797   /* Empty strings */
 798   mytest_diff("", "", "", "empty strings");
 799   mytest_diff("", "a", "+ a", "1 word, added");
 800   mytest_diff("a", "", "- a", "1 word, removed");
 801   mytest_diff("", "a\n", "+ a", "1 line, added");
 802   mytest_diff("a\n", "", "- a", "1 line, removed");
 803   mytest_diff("", "a\nb\nc\n", "+ a\n+ b\n+ c", "4 lines, all added");
 804   mytest_diff("a\nb\nc\n", "", "- a\n- b\n- c", "4 lines, all removed");
 805
 806   /* Empty lines */
 807   mytest_diff("\n", "\n", "  ", "empty lines");
 808   mytest_diff("", "\n", "+ ", "empty line, added");
 809   mytest_diff("\n", "", "- ", "empty line, removed");
 810
 811   mytest_diff("a", "\na", "+ \n  a", "empty line added before word");
 812   mytest_diff("a", "a\n\n", "  a\n+ ", "empty line added after word");
 813   mytest_diff("\na", "a", "- \n  a", "empty line removed before word");
 814   mytest_diff("a\n\n", "a", "  a\n- ", "empty line removed after word");
 815
 816   mytest_diff("a\n", "\na\n", "+ \n  a", "empty line added before line");
 817   mytest_diff("a\n", "a\n\n", "  a\n+ ", "empty line added after line");
 818   mytest_diff("\na\n", "a\n", "- \n  a", "empty line removed before line");
 819   mytest_diff("a\n\n", "a\n", "  a\n- ", "empty line removed after line");
 820
 821   mytest_diff("a\nb\nc\nd\n", "\na\nb\nc\nd\n", "+ \n  a\n  b\n  c\n  d",
 822               "empty line added before 4 lines");
 823   mytest_diff("a\nb\nc\nd\n", "a\nb\nc\nd\n\n", "  a\n  b\n  c\n  d\n+ ",
 824               "empty line added after 4 lines");
 825   mytest_diff("\na\nb\nc\nd\n", "a\nb\nc\nd\n", "- \n  a\n  b\n  c\n  d",
 826               "empty line removed before 4 lines");
 827   mytest_diff("a\nb\nc\nd\n\n", "a\nb\nc\nd\n", "  a\n  b\n  c\n  d\n- ",
 828               "empty line removed after 4 lines");
 829
 830   /* Missing newline at the end of one of the strings */
 831   mytest_diff("a\n", "a", "  a", "1 line, 1 word, no difference");
 832   mytest_diff("a", "a\n", "  a", "1 word, 1 line, no difference");
 833   mytest_diff("a\n", "A", "- a\n+ A", "1 line, 1 word, different");
 834   mytest_diff("a", "A\n", "- a\n+ A", "1 word, 1 line, different");
 835
 836   mytest_diff("a\nb\nc\nd", "a\nb\nc\nd\n", "  a\n  b\n  c\n  d",
 837               "4 lines, no newline on first");
 838   mytest_diff("a\nb\nc\nd\n", "a\nb\nc\nd", "  a\n  b\n  c\n  d",
 839               "4 lines, no newline on second");
 840
 841   /* Four lines, all combinations of differences */
 842   for (i = 0 ; i < (1U << 4) ; i++) {
 843     char d2[4 + 1];
 844     char s2[4 * 2 + 1];
 845     char res[4 * 8 + 1];
 846     char *pd = d2;
 847     char *ps = s2;
 848     char *pr = res;
 849     unsigned j = 0;
 850     while (j < 4) {
 851       unsigned k;
 852       for (/* j */ ; j < 4 && !(i & (1U << j)) ; j++) {
 853         *pd++ = "abcd"[j];
 854         ps += sprintf(ps, "%c\n", "abcd"[j]);
 855         pr += sprintf(pr, "  %c\n", "abcd"[j]);
 856       }
 857       for (k = j ; k < 4 && (i & (1U << k)) ; k++) {
 858         *pd++ = "ABCD"[k];
 859         ps += sprintf(ps, "%c\n", "ABCD"[k]);
 860         pr += sprintf(pr, "- %c\n", "abcd"[k]);
 861       }
 862       for (/* j */ ; j < k ; j++) {
 863         pr += sprintf(pr, "+ %c\n", "ABCD"[j]);
 864       }
 865     }
 866     *pd = '\0';
 867     *--pr = '\0';               /* strip last '\n' from expected result */
 868     mytest_diff("a\nb\nc\nd\n", s2, res,
 869                 "compare (abcd) with changed (%s)", d2);
 870   }
 871
 872   /* Subsets of four lines, do not test for empty subset */
 873   for (i = 1 ; i < (1U << 4) ; i++) {
 874     char d2[4 + 1];
 875     char s2[4 * 2 + 1];
 876     char res[4 * 8 + 1];
 877     char *pd = d2;
 878     char *ps = s2;
 879     char *pr = res;
 880     unsigned j = 0;
 881     while (j < 4) {
 882       for (/* j */ ; j < 4 && (i & (1U << j)) ; j++) {
 883         *pd++ = "abcd"[j];
 884         ps += sprintf(ps, "%c\n", "abcd"[j]);
 885         pr += sprintf(pr, "  %c\n", "abcd"[j]);
 886       }
 887       for (/* j */; j < 4 && !(i & (1U << j)) ; j++) {
 888         pr += sprintf(pr, "- %c\n", "abcd"[j]);
 889       }
 890     }
 891     *pd = '\0';
 892     *--pr = '\0';               /* strip last '\n' from expected result */
 893     mytest_diff("a\nb\nc\nd\n", s2, res,
 894                 "compare (abcd) with subset (%s)", d2);
 895
 896     for (pr = res ; *pr != '\0' ; pr++)
 897       if (*pr == '-')
 898         *pr = '+';
 899     mytest_diff(s2, "a\nb\nc\nd\n", res,
 900                 "compare subset (%s) with (abcd)", d2);
 901   }
 902 }
 903
 904 #endif                          /* SIMGRID_TEST */