1 /* $Id: buff.c 3483 2007-05-07 11:18:56Z mquinson $ */
3 /* strbuff -- string buffers */
5 /* Copyright (c) 2007 Martin Quinson. */
6 /* All rights reserved. */
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. */
11 /* specific to Borland Compiler */
16 #include "xbt/strbuff.h"
18 #define minimal_increment 512
20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(strbuff, xbt, "String buffers");
26 void xbt_strbuff_empty(xbt_strbuff_t b)
33 xbt_strbuff_t xbt_strbuff_new(void)
35 xbt_strbuff_t res = malloc(sizeof(s_xbt_strbuff_t));
36 res->data = malloc(512);
38 xbt_strbuff_empty(res);
42 /** @brief creates a new string buffer containing the provided string
44 * Beware, we store the ctn directly, not a copy of it
46 xbt_strbuff_t xbt_strbuff_new_from(char *ctn)
48 xbt_strbuff_t res = malloc(sizeof(s_xbt_strbuff_t));
50 res->used = res->size = strlen(ctn);
54 /** @brief frees only the container without touching to the contained string */
55 void xbt_strbuff_free_container(xbt_strbuff_t b)
60 /** @brief frees the buffer and its content */
61 void xbt_strbuff_free(xbt_strbuff_t b)
70 void xbt_strbuff_append(xbt_strbuff_t b, const char *toadd)
76 THROW0(arg_error, 0, "Asked to append stuff to NULL buffer");
78 addlen = strlen(toadd);
79 needed_space = b->used + addlen + 1;
81 if (needed_space > b->size) {
83 realloc(b->data, MAX(minimal_increment + b->used, needed_space));
84 b->size = MAX(minimal_increment + b->used, needed_space);
86 strcpy(b->data + b->used, toadd);
90 void xbt_strbuff_chomp(xbt_strbuff_t b)
92 while (b->data[b->used] == '\n') {
93 b->data[b->used] = '\0';
99 void xbt_strbuff_trim(xbt_strbuff_t b)
101 xbt_str_trim(b->data, " ");
102 b->used = strlen(b->data);
105 /** @brief Replaces a set of variables by their values
107 * @param b buffer to modify
108 * @param patterns variables to substitute in the buffer
110 * Both '$toto' and '${toto}' are valid (and the two writing are equivalent).
112 * If the variable name contains spaces, use the brace version (ie, ${toto tutu})
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).
119 void xbt_strbuff_varsubst(xbt_strbuff_t b, xbt_dict_t patterns)
122 char *end; /* pointers around the parsed chunk */
123 int in_simple_quote = 0, in_double_quote = 0;
126 if (b->data[0] == '\0')
134 /* Protected char; pass the protection */
137 THROW0(arg_error, 0, "String ends with \\");
141 if (!in_double_quote) {
142 /* simple quote not protected by double ones, note it */
143 in_simple_quote = !in_simple_quote;
147 if (!in_simple_quote) {
148 /* double quote protected by simple ones, note it */
149 in_double_quote = !in_double_quote;
154 if (!in_simple_quote) {
155 /* Go for the substitution. First search the variable name */
156 char *beg_var, *end_var; /* variable name boundary */
157 char *beg_subst, *end_subst = NULL; /* where value should be written to */
158 char *value, *default_value = NULL;
163 if (*(++end) == '{') {
164 /* the variable name is enclosed in braces. */
166 /* Search name's end */
168 while (*end_var != '\0' && *end_var != '}') {
169 /* TODO: we do not respect the standard for ":=", we should set this value in the dict */
171 && ((*(end_var + 1) == '=') || (*(end_var + 1) == '-'))) {
172 /* damn, we have a default value */
173 char *p = end_var + 1;
174 while (*p != '\0' && *p != '}')
178 "Variable default value not terminated ('}' missing)");
180 default_value = xbt_malloc(p - end_var - 1);
181 memcpy(default_value, end_var + 2, p - end_var - 2);
182 default_value[p - end_var - 2] = '\0';
184 end_subst = p + 1; /* eat '}' */
190 if (*end_var == '\0')
192 "Variable name not terminated ('}' missing)");
194 if (!end_subst) /* already set if there's a default value */
195 end_subst = end_var + 1; /* also kill the } in the name */
197 if (end_var == beg_var)
198 THROW0(arg_error, 0, "Variable name empty (${} is not valid)");
202 /* name given directly */
205 while (*end_var != '\0' && *end_var != ' ' && *end_var != '\t'
209 if (end_var == beg_var)
210 THROW0(arg_error, 0, "Variable name empty ($ is not valid)");
212 // DEBUG1("End_var = %s",end_var);
214 /* ok, we now have the variable name. Search the dictionary for the substituted value */
216 xbt_dict_get_or_null_ext(patterns, beg_var, end_var - beg_var);
217 // DEBUG4("Search for %.*s, found %s (default value = %s)\n",
218 // end_var-beg_var,beg_var,
219 // (value?value:"NULL"),
220 // (default_value?default_value:"NULL"));
223 value = xbt_strdup(value);
225 value = xbt_strdup(default_value);
228 value = xbt_strdup("");
230 /* En route for the actual substitution */
231 val_len = strlen(value);
232 // DEBUG2("val_len = %d, key_len=%d",val_len,end_subst-beg_subst);
233 if (val_len <= end_subst - beg_subst) {
234 /* enough room to do the substitute in place */
235 // INFO3("Substitute '%s' with '%s' for %d chars",beg_subst,value, val_len);
236 memmove(beg_subst, value, val_len); /* substitute */
237 // INFO3("Substitute '%s' with '%s' for %d chars",beg_subst+val_len,end_subst, b->used-(end_subst-b->data)+1);
238 memmove(beg_subst + val_len, end_subst, b->used - (end_subst - b->data) + 1); /* move the end of the string closer */
239 end = beg_subst + val_len; /* update the currently explored char in the overall loop */
240 b->used -= end_subst - beg_subst - val_len; /* update string buffer used size */
242 /* we have to extend the data area */
244 val_len - (end_subst - beg_subst) + 1 /*don't forget \0 */ ;
245 int newused = b->used + tooshort;
246 end += tooshort; /* update the pointer of the overall loop */
247 // DEBUG2("Too short (by %d chars; %d chars left in area)",val_len- (end_subst-beg_subst), b->size - b->used);
248 if (newused > b->size) {
249 /* We have to realloc the data area before (because b->size is too small). We have to update our pointers, too */
251 realloc(b->data, b->used + MAX(minimal_increment, tooshort));
252 int offset = newdata - b->data;
254 b->size = b->used + MAX(minimal_increment, tooshort);
259 memmove(beg_subst + val_len, end_subst, b->used - (end_subst - b->data) + 2); /* move the end of the string a bit further */
260 memmove(beg_subst, value, val_len); /* substitute */
278 #include "xbt/strbuff.h"
280 /* 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 */
281 #define force_resize \
282 "1.........1.........2.........3.........4.........5.........6.........7.........8.........9........." \
283 "2.........1.........2.........3.........4.........5.........6.........7.........8.........9........." \
284 "3.........1.........2.........3.........4.........5.........6.........7.........8.........9........." \
285 "4.........1.........2.........3.........4.........5.........6.........7.........8.........9........." \
286 "5.........1.........2.........3.........4.........5.........6.........7.........8.........9........." \
287 "6.........1.........2.........3.........4.........5.........6.........7.........8.........9........." \
288 "7.........1.........2.........3.........4.........5.........6.........7.........8.........9........." \
289 "8.........1.........2.........3.........4.........5.........6.........7.........8.........9........." \
290 "9.........1.........2.........3.........4.........5.........6.........7.........8.........9........." \
291 "0.........1.........2.........3.........4.........5.........6.........7.........8.........9........."
293 static void mytest(const char *input, const char *patterns,
294 const char *expected)
296 xbt_dynar_t dyn_patterns; /* splited string */
297 xbt_dict_t p; /* patterns */
299 char *str; /*foreach */
300 xbt_strbuff_t sb; /* what we test */
303 dyn_patterns = xbt_str_split(patterns, " ");
304 xbt_dynar_foreach(dyn_patterns, cpt, str) {
305 xbt_dynar_t keyvals = xbt_str_split(str, "=");
306 char *key = xbt_dynar_get_as(keyvals, 0, char *);
307 char *val = xbt_dynar_get_as(keyvals, 1, char *);
308 xbt_str_subst(key, '_', ' ', 0); // to put space in names without breaking the enclosing dynar_foreach
309 xbt_dict_set(p, key, xbt_strdup(val), free);
310 xbt_dynar_free(&keyvals);
312 xbt_dynar_free(&dyn_patterns);
313 sb = xbt_strbuff_new();
314 xbt_strbuff_append(sb, input);
315 xbt_strbuff_varsubst(sb, p);
317 xbt_test_assert4(!strcmp(sb->data, expected),
318 "Input (%s) with patterns (%s) leads to (%s) instead of (%s)",
319 input, patterns, sb->data, expected);
320 xbt_strbuff_free(sb);
323 XBT_TEST_SUITE("xbt_strbuff", "String Buffers");
324 XBT_TEST_UNIT("xbt_strbuff_substitute", test_strbuff_substitute,"test the function xbt_strbuff_substitute")
326 xbt_test_add0("Empty");
329 xbt_test_add0("Value shorter, no braces, only variable");
330 mytest("$tutu", "tutu=t", "t");
331 xbt_test_add0("Value shorter, braces, only variable");
332 mytest("${tutu}", "tutu=t", "t");
333 xbt_test_add0("Value shorter, no braces, data after");
334 mytest("$tutu toto", "tutu=t", "t toto");
335 xbt_test_add0("Value shorter, braces, data after");
336 mytest("${tutu} toto", "tutu=t", "t toto");
337 xbt_test_add0("Value shorter, no braces, data before");
338 mytest("toto $tutu", "tutu=t", "toto t");
339 xbt_test_add0("Value shorter, braces, data before");
340 mytest("toto ${tutu}", "tutu=t", "toto t");
341 xbt_test_add0("Value shorter, no braces, data before and after");
342 mytest("toto $tutu tata", "tutu=t", "toto t tata");
343 xbt_test_add0("Value shorter, braces, data before and after");
344 mytest("toto ${tutu} tata", "tutu=t", "toto t tata");
346 xbt_test_add0("Value as long, no braces, only variable");
347 mytest("$tutu", "tutu=12345", "12345");
348 xbt_test_add0("Value as long, braces, only variable");
349 mytest("${tutu}", "tutu=1234567", "1234567");
350 xbt_test_add0("Value as long, no braces, data after");
351 mytest("$tutu toto", "tutu=12345", "12345 toto");
352 xbt_test_add0("Value as long, braces, data after");
353 mytest("${tutu} toto", "tutu=1234567", "1234567 toto");
354 xbt_test_add0("Value as long, no braces, data before");
355 mytest("toto $tutu", "tutu=12345", "toto 12345");
356 xbt_test_add0("Value as long, braces, data before");
357 mytest("toto ${tutu}", "tutu=1234567", "toto 1234567");
358 xbt_test_add0("Value as long, no braces, data before and after");
359 mytest("toto $tutu tata", "tutu=12345", "toto 12345 tata");
360 xbt_test_add0("Value as long, braces, data before and after");
361 mytest("toto ${tutu} tata", "tutu=1234567", "toto 1234567 tata");
363 xbt_test_add0("Value longer, no braces, only variable");
364 mytest("$t", "t=tututu", "tututu");
365 xbt_test_add0("Value longer, braces, only variable");
366 mytest("${t}", "t=tututu", "tututu");
367 xbt_test_add0("Value longer, no braces, data after");
368 mytest("$t toto", "t=tututu", "tututu toto");
369 xbt_test_add0("Value longer, braces, data after");
370 mytest("${t} toto", "t=tututu", "tututu toto");
371 xbt_test_add0("Value longer, no braces, data before");
372 mytest("toto $t", "t=tututu", "toto tututu");
373 xbt_test_add0("Value longer, braces, data before");
374 mytest("toto ${t}", "t=tututu", "toto tututu");
375 xbt_test_add0("Value longer, no braces, data before and after");
376 mytest("toto $t tata", "t=tututu", "toto tututu tata");
377 xbt_test_add0("Value longer, braces, data before and after");
378 mytest("toto ${t} tata", "t=tututu", "toto tututu tata");
380 xbt_test_add0("Value much longer, no braces, only variable");
381 mytest("$t", "t=" force_resize, force_resize);
382 xbt_test_add0("Value much longer, no braces, data after");
383 mytest("$t toto", "t=" force_resize, force_resize " toto");
384 xbt_test_add0("Value much longer, braces, data after");
385 mytest("${t} toto", "t=" force_resize, force_resize " toto");
386 xbt_test_add0("Value much longer, no braces, data before");
387 mytest("toto $t", "t=" force_resize, "toto " force_resize);
388 xbt_test_add0("Value much longer, braces, data before");
389 mytest("toto ${t}", "t=" force_resize, "toto " force_resize);
390 xbt_test_add0("Value much longer, no braces, data before and after");
391 mytest("toto $t tata", "t=" force_resize, "toto " force_resize " tata");
392 xbt_test_add0("Value much longer, braces, data before and after");
393 mytest("toto ${t} tata", "t=" force_resize, "toto " force_resize " tata");
395 xbt_test_add0("Escaped $");
396 mytest("\\$tutu", "tutu=t", "\\$tutu");
397 xbt_test_add0("Space in var name (with braces)");
398 mytest("${tu ti}", "tu_ti=t", "t");
400 xbt_test_add0("Two variables");
401 mytest("$toto $tutu", "toto=1 tutu=2", "1 2");
403 // Commented: I'm too lazy to do a memmove in var name to remove the backslash after use.
404 // Users should use braces.
405 // xbt_test_add0("Escaped space in var name", "$tu\\ ti", "tu_ti=t", "t");
407 xbt_test_add0("Default value");
408 mytest("${t:-toto}", "", "toto");
409 xbt_test_add0("Useless default value (variable already defined)");
410 mytest("${t:-toto}", "t=TRUC", "TRUC");
414 #endif /* SIMGRID_TEST */