src/xbt/xbt_strbuff.c

   1 /* $Id: buff.c 3483 2007-05-07 11:18:56Z mquinson $ */
   2
   3 /* strbuff -- string buffers                                                */
   4
   5 /* Copyright (c) 2007, 2008, 2009, 2010. The SimGrid Team.
   6  * All rights reserved.                                                     */
   7
   8 /* This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the license (GNU LGPL) which comes with this package. */
  10
  11 /* specific to Borland Compiler */
  12 #ifdef __BORLANDDC__
  13 #pragma hdrstop
  14 #endif
  15
  16 #include "xbt/strbuff.h"
  17
  18 #define minimal_increment 512
  19
  20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(strbuff, xbt, "String buffers");
  21
  22 /**
  23 ** Buffer code
  24 **/
  25
  26 XBT_INLINE void xbt_strbuff_empty(xbt_strbuff_t b)
  27 {
  28   b->used = 0;
  29   b->data[0] = '\n';
  30   b->data[1] = '\0';
  31 }
  32
  33 xbt_strbuff_t xbt_strbuff_new(void)
  34 {
  35   xbt_strbuff_t res = malloc(sizeof(s_xbt_strbuff_t));
  36   res->data = malloc(512);
  37   res->size = 512;
  38   xbt_strbuff_empty(res);
  39   return res;
  40 }
  41
  42 /** @brief creates a new string buffer containing the provided string
  43  *
  44  * Beware, we store the ctn directly, not a copy of it
  45  */
  46 XBT_INLINE xbt_strbuff_t xbt_strbuff_new_from(char *ctn)
  47 {
  48   xbt_strbuff_t res = malloc(sizeof(s_xbt_strbuff_t));
  49   res->data = ctn;
  50   res->used = res->size = strlen(ctn);
  51   return res;
  52 }
  53
  54 /** @brief frees only the container without touching to the contained string */
  55 XBT_INLINE void xbt_strbuff_free_container(xbt_strbuff_t b)
  56 {
  57   free(b);
  58 }
  59
  60 /** @brief frees the buffer and its content */
  61 XBT_INLINE void xbt_strbuff_free(xbt_strbuff_t b)
  62 {
  63   if (b) {
  64     if (b->data)
  65       free(b->data);
  66     free(b);
  67   }
  68 }
  69
  70 void xbt_strbuff_append(xbt_strbuff_t b, const char *toadd)
  71 {
  72   int addlen;
  73   int needed_space;
  74
  75   if (!b)
  76     THROWF(arg_error, 0, "Asked to append stuff to NULL buffer");
  77
  78   addlen = strlen(toadd);
  79   needed_space = b->used + addlen + 1;
  80
  81   if (needed_space > b->size) {
  82     b->data =
  83         realloc(b->data, MAX(minimal_increment + b->used, needed_space));
  84     b->size = MAX(minimal_increment + b->used, needed_space);
  85   }
  86   strcpy(b->data + b->used, toadd);
  87   b->used += addlen;
  88 }
  89
  90 XBT_INLINE void xbt_strbuff_chomp(xbt_strbuff_t b)
  91 {
  92   while (b->data[b->used] == '\n') {
  93     b->data[b->used] = '\0';
  94     if (b->used)
  95       b->used--;
  96   }
  97 }
  98
  99 XBT_INLINE void xbt_strbuff_trim(xbt_strbuff_t b)
 100 {
 101   xbt_str_trim(b->data, " ");
 102   b->used = strlen(b->data);
 103 }
 104
 105 /** @brief Replaces a set of variables by their values
 106  *
 107  * @param b buffer to modify
 108  * @param patterns variables to substitute in the buffer
 109  *
 110  * Both '$toto' and '${toto}' are valid (and the two writing are equivalent).
 111  *
 112  * If the variable name contains spaces, use the brace version (ie, ${toto tutu})
 113  *
 114  * You can provide a default value to use if the variable is not set in the dict by using
 115  * '${var:=default}' or '${var:-default}'. These two forms are equivalent, even if they
 116  * shouldn't to respect the shell standard (:= form should set the value in the dict,
 117  * but does not) (BUG).
 118  */
 119 void xbt_strbuff_varsubst(xbt_strbuff_t b, xbt_dict_t patterns)
 120 {
 121
 122   char *end;                    /* pointers around the parsed chunk */
 123   int in_simple_quote = 0, in_double_quote = 0;
 124   int done = 0;
 125
 126   if (b->data[0] == '\0')
 127     return;
 128   end = b->data;
 129
 130   while (!done) {
 131     switch (*end) {
 132     case '\\':
 133       /* Protected char; pass the protection */
 134       end++;
 135       if (*end == '\0')
 136         THROWF(arg_error, 0, "String ends with \\");
 137       break;
 138
 139     case '\'':
 140       if (!in_double_quote) {
 141         /* simple quote not protected by double ones, note it */
 142         in_simple_quote = !in_simple_quote;
 143       }
 144       break;
 145     case '"':
 146       if (!in_simple_quote) {
 147         /* double quote protected by simple ones, note it */
 148         in_double_quote = !in_double_quote;
 149       }
 150       break;
 151
 152     case '$':
 153       if (!in_simple_quote) {
 154         /* Go for the substitution. First search the variable name */
 155         char *beg_var, *end_var;        /* variable name boundary */
 156         char *beg_subst, *end_subst = NULL;     /* where value should be written to */
 157         char *value, *default_value = NULL;
 158         int val_len;
 159         beg_subst = end;
 160
 161
 162         if (*(++end) == '{') {
 163           /* the variable name is enclosed in braces. */
 164           beg_var = end + 1;
 165           /* Search name's end */
 166           end_var = beg_var;
 167           while (*end_var != '\0' && *end_var != '}') {
 168             /* TODO: we do not respect the standard for ":=", we should set this value in the dict */
 169             if (*end_var == ':'
 170                 && ((*(end_var + 1) == '=') || (*(end_var + 1) == '-'))) {
 171               /* damn, we have a default value */
 172               char *p = end_var + 1;
 173               while (*p != '\0' && *p != '}')
 174                 p++;
 175               if (*p == '\0')
 176                 THROWF(arg_error, 0,
 177                        "Variable default value not terminated ('}' missing)");
 178
 179               default_value = xbt_malloc(p - end_var - 1);
 180               memcpy(default_value, end_var + 2, p - end_var - 2);
 181               default_value[p - end_var - 2] = '\0';
 182
 183               end_subst = p + 1;        /* eat '}' */
 184
 185               break;
 186             }
 187             end_var++;
 188           }
 189           if (*end_var == '\0')
 190             THROWF(arg_error, 0,
 191                    "Variable name not terminated ('}' missing)");
 192
 193           if (!end_subst)       /* already set if there's a default value */
 194             end_subst = end_var + 1;    /* also kill the } in the name */
 195
 196           if (end_var == beg_var)
 197             THROWF(arg_error, 0, "Variable name empty (${} is not valid)");
 198
 199
 200         } else {
 201           /* name given directly */
 202           beg_var = end;
 203           end_var = beg_var;
 204           while (*end_var != '\0' && *end_var != ' ' && *end_var != '\t'
 205                  && *end_var != '\n')
 206             end_var++;
 207           end_subst = end_var;
 208           if (end_var == beg_var)
 209             THROWF(arg_error, 0, "Variable name empty ($ is not valid)");
 210         }
 211 /*        XBT_DEBUG("var='%.*s'; subst='%.*s'; End_var = '%s'",
 212             end_var-beg_var,beg_var,
 213             end_subst-beg_subst,beg_subst,
 214             end_var);*/
 215
 216         /* ok, we now have the variable name. Search the dictionary for the substituted value */
 217         value =
 218             xbt_dict_get_or_null_ext(patterns, beg_var, end_var - beg_var);
 219 /*        XBT_DEBUG("Deal with '%s'",b->data);
 220         XBT_DEBUG("Search for %.*s, found %s (default value = %s)\n",
 221             end_var-beg_var,beg_var,
 222             (value?value:"(no value)"),
 223             (default_value?default_value:"(no value)"));*/
 224
 225         if (value)
 226           value = xbt_strdup(value);
 227         else if (default_value)
 228           value = xbt_strdup(default_value);
 229         else
 230           value = xbt_strdup("");
 231
 232         /* En route for the actual substitution */
 233         val_len = strlen(value);
 234 //        XBT_DEBUG("val_len = %d, key_len=%d",val_len,end_subst-beg_subst);
 235         if (val_len <= end_subst - beg_subst) {
 236           /* enough room to do the substitute in place */
 237 //          XBT_DEBUG("Substitute key name by its value: ie '%.*s' by '%.*s'",end_subst-beg_subst,beg_subst,val_len,value);
 238           memmove(beg_subst, value, val_len);   /* substitute */
 239 //          XBT_DEBUG("String is now: '%s'",b->data);
 240 /*          XBT_DEBUG("Move end of string closer (%d chars moved) :\n-'%.*s%.*s'\n+'%.*s%s'",
 241               b->used - (end_subst - b->data) + 1,
 242               beg_subst-b->data,b->data,
 243               b->used-(end_subst-b->data)+1,beg_subst+val_len,
 244               beg_subst-b->data,b->data,
 245               end_subst);*/
 246           memmove(beg_subst + val_len, end_subst, b->used - (end_subst - b->data) + 1); /* move the end of the string closer */
 247 //          XBT_DEBUG("String is now: '%s'",b->data);
 248           end = beg_subst + val_len;    /* update the currently explored char in the overall loop */
 249 //          XBT_DEBUG("end of substituted section is now '%s'",end);
 250           b->used -= end_subst - beg_subst - val_len;   /* update string buffer used size */
 251 //          XBT_DEBUG("Used:%d end:%d ending char:%d",b->used,end-b->data,*end);
 252         } else {
 253           /* we have to extend the data area */
 254           int tooshort =
 255               val_len - (end_subst - beg_subst) + 1 /*don't forget \0 */ ;
 256           int newused = b->used + tooshort;
 257           end += tooshort;      /* update the pointer of the overall loop */
 258 //          XBT_DEBUG("Too short (by %d chars; %d chars left in area)",val_len- (end_subst-beg_subst), b->size - b->used);
 259           if (newused > b->size) {
 260             /* We have to realloc the data area before (because b->size is too small). We have to update our pointers, too */
 261             char *newdata = realloc(b->data,
 262                                     b->used + MAX(minimal_increment,
 263                                                   tooshort));
 264             int offset = newdata - b->data;
 265             b->data = newdata;
 266             b->size = b->used + MAX(minimal_increment, tooshort);
 267             end += offset;
 268             beg_subst += offset;
 269             end_subst += offset;
 270           }
 271           memmove(beg_subst + val_len, end_subst, b->used - (end_subst - b->data) + 1); /* move the end of the string a bit further */
 272           memmove(beg_subst, value, val_len);   /* substitute */
 273           b->used = newused;
 274 //          XBT_DEBUG("String is now: %s",b->data);
 275         }
 276         free(value);
 277
 278         if (default_value)
 279           free(default_value);
 280
 281         end--;                  /* compensate the next end++ */
 282       }
 283       break;
 284
 285     case '\0':
 286       done = 1;
 287     }
 288     end++;
 289   }
 290 }
 291
 292 #ifdef SIMGRID_TEST
 293 #include "xbt/strbuff.h"
 294
 295 /* buffstr have 512 chars by default. Adding 1000 chars like this will force a resize, allowing us to test that b->used and b->size are consistent */
 296 #define force_resize \
 297   "1.........1.........2.........3.........4.........5.........6.........7.........8.........9........." \
 298   "2.........1.........2.........3.........4.........5.........6.........7.........8.........9........." \
 299   "3.........1.........2.........3.........4.........5.........6.........7.........8.........9........." \
 300   "4.........1.........2.........3.........4.........5.........6.........7.........8.........9........." \
 301   "5.........1.........2.........3.........4.........5.........6.........7.........8.........9........." \
 302   "6.........1.........2.........3.........4.........5.........6.........7.........8.........9........." \
 303   "7.........1.........2.........3.........4.........5.........6.........7.........8.........9........." \
 304   "8.........1.........2.........3.........4.........5.........6.........7.........8.........9........." \
 305   "9.........1.........2.........3.........4.........5.........6.........7.........8.........9........." \
 306   "0.........1.........2.........3.........4.........5.........6.........7.........8.........9........."
 307
 308 static void mytest(const char *input, const char *patterns,
 309                    const char *expected)
 310 {
 311   xbt_dynar_t dyn_patterns;     /* splited string */
 312   xbt_dict_t p;                 /* patterns */
 313   unsigned int cpt;
 314   char *str;                    /*foreach */
 315   xbt_strbuff_t sb;             /* what we test */
 316
 317   p = xbt_dict_new();
 318   dyn_patterns = xbt_str_split(patterns, " ");
 319   xbt_dynar_foreach(dyn_patterns, cpt, str) {
 320     xbt_dynar_t keyvals = xbt_str_split(str, "=");
 321     char *key = xbt_dynar_get_as(keyvals, 0, char *);
 322     char *val = xbt_dynar_get_as(keyvals, 1, char *);
 323     xbt_str_subst(key, '_', ' ', 0);    // to put space in names without breaking the enclosing dynar_foreach
 324     xbt_dict_set(p, key, xbt_strdup(val), free);
 325     xbt_dynar_free(&keyvals);
 326   }
 327   xbt_dynar_free(&dyn_patterns);
 328   sb = xbt_strbuff_new();
 329   xbt_strbuff_append(sb, input);
 330   xbt_strbuff_varsubst(sb, p);
 331   xbt_dict_free(&p);
 332   xbt_test_assert(!strcmp(sb->data, expected),
 333                    "Input (%s) with patterns (%s) leads to (%s) instead of (%s)",
 334                    input, patterns, sb->data, expected);
 335   xbt_strbuff_free(sb);
 336 }
 337
 338 XBT_TEST_SUITE("xbt_strbuff", "String Buffers");
 339 XBT_TEST_UNIT("xbt_strbuff_substitute", test_strbuff_substitute, "test the function xbt_strbuff_substitute")
 340 {
 341   xbt_test_add("Empty");
 342   mytest("", "", "");
 343
 344   xbt_test_add("Value shorter, no braces, only variable");
 345   mytest("$tutu", "tutu=t", "t");
 346   xbt_test_add("Value shorter, braces, only variable");
 347   mytest("${tutu}", "tutu=t", "t");
 348   xbt_test_add("Value shorter, no braces, data after");
 349   mytest("$tutu toto", "tutu=t", "t toto");
 350   xbt_test_add("Value shorter, braces, data after");
 351   mytest("${tutu} toto", "tutu=t", "t toto");
 352   xbt_test_add("Value shorter, no braces, data before");
 353   mytest("toto $tutu", "tutu=t", "toto t");
 354   xbt_test_add("Value shorter, braces, data before");
 355   mytest("toto ${tutu}", "tutu=t", "toto t");
 356   xbt_test_add("Value shorter, no braces, data before and after");
 357   mytest("toto $tutu tata", "tutu=t", "toto t tata");
 358   xbt_test_add("Value shorter, braces, data before and after");
 359   mytest("toto ${tutu} tata", "tutu=t", "toto t tata");
 360
 361   xbt_test_add("Value as long, no braces, only variable");
 362   mytest("$tutu", "tutu=12345", "12345");
 363   xbt_test_add("Value as long, braces, only variable");
 364   mytest("${tutu}", "tutu=1234567", "1234567");
 365   xbt_test_add("Value as long, no braces, data after");
 366   mytest("$tutu toto", "tutu=12345", "12345 toto");
 367   xbt_test_add("Value as long, braces, data after");
 368   mytest("${tutu} toto", "tutu=1234567", "1234567 toto");
 369   xbt_test_add("Value as long, no braces, data before");
 370   mytest("toto $tutu", "tutu=12345", "toto 12345");
 371   xbt_test_add("Value as long, braces, data before");
 372   mytest("toto ${tutu}", "tutu=1234567", "toto 1234567");
 373   xbt_test_add("Value as long, no braces, data before and after");
 374   mytest("toto $tutu tata", "tutu=12345", "toto 12345 tata");
 375   xbt_test_add("Value as long, braces, data before and after");
 376   mytest("toto ${tutu} tata", "tutu=1234567", "toto 1234567 tata");
 377
 378   xbt_test_add("Value longer, no braces, only variable");
 379   mytest("$t", "t=tututu", "tututu");
 380   xbt_test_add("Value longer, braces, only variable");
 381   mytest("${t}", "t=tututu", "tututu");
 382   xbt_test_add("Value longer, no braces, data after");
 383   mytest("$t toto", "t=tututu", "tututu toto");
 384   xbt_test_add("Value longer, braces, data after");
 385   mytest("${t} toto", "t=tututu", "tututu toto");
 386   xbt_test_add("Value longer, no braces, data before");
 387   mytest("toto $t", "t=tututu", "toto tututu");
 388   xbt_test_add("Value longer, braces, data before");
 389   mytest("toto ${t}", "t=tututu", "toto tututu");
 390   xbt_test_add("Value longer, no braces, data before and after");
 391   mytest("toto $t tata", "t=tututu", "toto tututu tata");
 392   xbt_test_add("Value longer, braces, data before and after");
 393   mytest("toto ${t} tata", "t=tututu", "toto tututu tata");
 394
 395   xbt_test_add("Value much longer, no braces, only variable");
 396   mytest("$t", "t=" force_resize, force_resize);
 397   xbt_test_add("Value much longer, no braces, data after");
 398   mytest("$t toto", "t=" force_resize, force_resize " toto");
 399   xbt_test_add("Value much longer, braces, data after");
 400   mytest("${t} toto", "t=" force_resize, force_resize " toto");
 401   xbt_test_add("Value much longer, no braces, data before");
 402   mytest("toto $t", "t=" force_resize, "toto " force_resize);
 403   xbt_test_add("Value much longer, braces, data before");
 404   mytest("toto ${t}", "t=" force_resize, "toto " force_resize);
 405   xbt_test_add("Value much longer, no braces, data before and after");
 406   mytest("toto $t tata", "t=" force_resize, "toto " force_resize " tata");
 407   xbt_test_add("Value much longer, braces, data before and after");
 408   mytest("toto ${t} tata", "t=" force_resize,
 409          "toto " force_resize " tata");
 410
 411   xbt_test_add("Escaped $");
 412   mytest("\\$tutu", "tutu=t", "\\$tutu");
 413   xbt_test_add("Space in var name (with braces)");
 414   mytest("${tu ti}", "tu_ti=t", "t");
 415
 416   xbt_test_add("Two variables");
 417   mytest("$toto $tutu", "toto=1 tutu=2", "1 2");
 418
 419   // Commented: I'm too lazy to do a memmove in var name to remove the backslash after use.
 420   // Users should use braces.
 421   //  xbt_test_add("Escaped space in var name", "$tu\\ ti", "tu_ti=t", "t");
 422
 423   xbt_test_add("Default value");
 424   mytest("${t:-toto}", "", "toto");
 425   xbt_test_add("Useless default value (variable already defined)");
 426   mytest("${t:-toto}", "t=TRUC", "TRUC");
 427
 428 }
 429
 430 #endif                          /* SIMGRID_TEST */