Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
7d5cf08e8f1b10b89d8f01a08dd42219dbdbcec9
[simgrid.git] / src / xbt / xbt_str.c
1
2 /* xbt_str.c - various helping functions to deal with strings               */
3
4 /* Copyright (C) 2005-2007 Malek Cherier, Martin Quinson.                   */
5 /* All rights reserved.                                                     */
6
7 /* This program is free software; you can redistribute it and/or modify it
8  * under the terms of the license (GNU LGPL) which comes with this package. 
9  */
10   
11 #include "xbt/misc.h"
12 #include "xbt/sysdep.h"
13 #include "xbt/str.h" /* headers of these functions */
14 #include "portable.h"
15 #include "xbt/matrix.h" /* for the diff */
16
17 static void free_string(void *d){
18   free(*(void**)d);
19 }
20
21 /**  @brief Strip whitespace (or other characters) from the end of a string.
22  *
23  * Strips the whitespaces from the end of s. 
24  * By default (when char_list=NULL), these characters get stripped:
25  *      
26  *      - " "           (ASCII 32       (0x20)) space. 
27  *      - "\t"          (ASCII 9        (0x09)) tab. 
28  *      - "\n"          (ASCII 10       (0x0A)) line feed. 
29  *      - "\r"          (ASCII 13       (0x0D)) carriage return. 
30  *      - "\0"          (ASCII 0        (0x00)) NULL. 
31  *      - "\x0B"        (ASCII 11       (0x0B)) vertical tab. 
32  *
33  * @param s The string to strip. Modified in place.
34  * @param char_list A string which contains the characters you want to strip.
35  *
36  */
37 void
38 xbt_str_rtrim(char* s, const char* char_list)
39 {
40         char* cur = s;
41         const char* __char_list = " \t\n\r\x0B";
42         char white_char[256] = {1,0};
43         
44         if(!s)
45                 return;
46
47         if(!char_list){
48                 while(*__char_list) {
49                         white_char[(unsigned char)*__char_list++] = 1;
50                 }
51         }else{
52                 while(*char_list) {
53                         white_char[(unsigned char)*char_list++] = 1;
54                 }
55         }
56
57         while(*cur)
58                 ++cur;
59
60         while((cur >= s) && white_char[(unsigned char)*cur])
61                 --cur;
62
63         *++cur = '\0';
64 }
65
66 /**  @brief Strip whitespace (or other characters) from the beginning of a string.
67  *
68  * Strips the whitespaces from the begining of s.
69  * By default (when char_list=NULL), these characters get stripped:
70  *      
71  *      - " "           (ASCII 32       (0x20)) space. 
72  *      - "\t"          (ASCII 9        (0x09)) tab. 
73  *      - "\n"          (ASCII 10       (0x0A)) line feed. 
74  *      - "\r"          (ASCII 13       (0x0D)) carriage return. 
75  *      - "\0"          (ASCII 0        (0x00)) NULL. 
76  *      - "\x0B"        (ASCII 11       (0x0B)) vertical tab. 
77  *
78  * @param s The string to strip. Modified in place.
79  * @param char_list A string which contains the characters you want to strip.
80  *
81  */
82 void
83 xbt_str_ltrim( char* s, const char* char_list)
84 {
85         char* cur = s;
86         const char* __char_list = " \t\n\r\x0B";
87         char white_char[256] = {1,0};
88         
89         if(!s)
90                 return;
91
92         if(!char_list){
93                 while(*__char_list) {
94                         white_char[(unsigned char)*__char_list++] = 1;
95                 }
96         }else{
97                 while(*char_list) {
98                         white_char[(unsigned char)*char_list++] = 1;
99                 }
100         }
101
102         while(*cur && white_char[(unsigned char)*cur])
103                 ++cur;
104
105         memmove(s,cur, strlen(cur)+1);
106 }
107
108 /**  @brief Strip whitespace (or other characters) from the end and the begining of a string.
109  *
110  * Strips the whitespaces from both the beginning and the end of s.
111  * By default (when char_list=NULL), these characters get stripped:
112  *      
113  *      - " "           (ASCII 32       (0x20)) space. 
114  *      - "\t"          (ASCII 9        (0x09)) tab. 
115  *      - "\n"          (ASCII 10       (0x0A)) line feed. 
116  *      - "\r"          (ASCII 13       (0x0D)) carriage return. 
117  *      - "\0"          (ASCII 0        (0x00)) NULL. 
118  *      - "\x0B"        (ASCII 11       (0x0B)) vertical tab. 
119  *
120  * @param s The string to strip.
121  * @param char_list A string which contains the characters you want to strip.
122  *
123  */
124 void
125 xbt_str_trim(char* s, const char* char_list ){
126         
127         if(!s)
128                 return;
129                 
130     xbt_str_rtrim(s,char_list);
131     xbt_str_ltrim(s,char_list);
132 }
133
134 /**  @brief Replace double whitespaces (but no other characters) from the string.
135  *
136  * The function modifies the string so that each time that several spaces appear,
137  * they are replaced by a single space. It will only do so for spaces (ASCII 32, 0x20). 
138  *
139  * @param s The string to strip. Modified in place.
140  *
141  */
142 void
143 xbt_str_strip_spaces(char *s) {
144   char *p = s;
145   int   e = 0;
146
147   if (!s)
148     return;
149
150   while (1) {
151     if (!*p)
152       goto end;
153     
154     if (*p != ' ')
155       break;
156     
157     p++;
158   }
159   
160   e = 1;
161   
162   do {
163     if (e)
164       *s++ = *p;
165     
166     if (!*++p)
167       goto end;
168     
169     if (e ^ (*p!=' '))
170       if ((e = !e))
171         *s++ = ' ';
172   } while (1);
173
174  end:
175   *s = '\0';
176 }
177
178 /** @brief Splits a string into a dynar of strings 
179  * 
180  * @param s: the string to split
181  * @param sep: a string of all chars to consider as separator.
182  *
183  * By default (with sep=NULL), these characters are used as separator: 
184  *      
185  *      - " "           (ASCII 32       (0x20)) space. 
186  *      - "\t"          (ASCII 9        (0x09)) tab. 
187  *      - "\n"          (ASCII 10       (0x0A)) line feed. 
188  *      - "\r"          (ASCII 13       (0x0D)) carriage return. 
189  *      - "\0"          (ASCII 0        (0x00)) NULL. 
190  *      - "\x0B"        (ASCII 11       (0x0B)) vertical tab. 
191  */
192
193 xbt_dynar_t xbt_str_split(const char *s, const char *sep) {
194   xbt_dynar_t res = xbt_dynar_new(sizeof(char*), free_string);
195   const char *p, *q;
196   int done;
197   const char* sep_dflt = " \t\n\r\x0B";
198   char is_sep[256] = {1,0};
199
200   /* check what are the separators */
201   memset(is_sep,0,sizeof(is_sep));
202   if (!sep) {
203     while (*sep_dflt)
204       is_sep[(unsigned char) *sep_dflt++] = 1;
205   } else {
206     while (*sep)
207       is_sep[(unsigned char) *sep++] = 1;
208   }
209   is_sep[0] = 1; /* End of string is also separator */
210    
211   /* Do the job */
212   p=q=s; 
213   done=0;
214
215   if (s[0] == '\0')
216     return res;
217
218   while (!done) {
219     char *topush;
220     while (!is_sep[(unsigned char)*q]) {
221       q++;
222     }
223     if (*q == '\0')
224       done = 1;
225
226     topush=xbt_malloc(q-p+1);
227     memcpy(topush,p,q-p);
228     topush[q - p] = '\0';
229     xbt_dynar_push(res,&topush);
230     p = ++q;
231   }
232
233   return res;
234 }
235
236 /**
237  * \brief This functions splits a string after using another string as separator
238  * For example A!!B!!C splitted after !! will return the dynar {A,B,C}
239  * \return An array of dynars containing the string tokens
240 */
241 xbt_dynar_t xbt_str_split_str(const char *s, const char *sep) {
242   xbt_dynar_t res = xbt_dynar_new(sizeof(char*), free_string);
243   int done;
244   const char *p, *q;
245  
246   p = q = s;
247   done = 0;
248  
249   if (s[0] == '\0') 
250     return res;
251   if (sep[0] == '\0') {
252     s = xbt_strdup(s);
253     xbt_dynar_push(res, &s);
254     return res;
255   }
256
257   while (!done) {
258     char *to_push;
259     int v = 0;
260     //get the start of the first occurence of the substring
261     q = strstr(p, sep);
262     //if substring was not found add the entire string
263     if (NULL == q) {
264       v = strlen(p);
265       to_push = malloc(v + 1);
266       memcpy(to_push, p, v);
267       to_push[v] = '\0';
268       xbt_dynar_push(res, &to_push);
269       done = 1;
270     }
271     else {
272       //get the appearance
273       to_push = malloc(q - p + 1);
274       memcpy(to_push, p, q - p);
275       //add string terminator
276       to_push[q - p] = '\0';
277           xbt_dynar_push(res, &to_push);
278       p = q +strlen(sep);
279     }
280   }
281   return res;
282 }
283
284 /** @brief Splits a string into a dynar of strings, taking quotes into account
285  * 
286  * It basically does the same argument separation than the shell, where white 
287  * spaces can be escaped and where arguments are never splitted within a 
288  * quote group.
289  * Several subsequent spaces are ignored (unless within quotes, of course).
290  *
291  */
292
293 xbt_dynar_t xbt_str_split_quoted(const char *s) {
294   xbt_dynar_t res = xbt_dynar_new(sizeof(char*), free_string);
295   char *str; /* we have to copy the string before, to handle backslashes */
296   char *beg, *end; /* pointers around the parsed chunk */
297   int in_simple_quote=0, in_double_quote=0;
298   int done = 0;
299   int ctn = 0; /* Got something in this block */
300
301   if (s[0] == '\0')
302     return res;
303   beg = str = xbt_strdup(s);
304    
305   /* trim leading spaces */
306   xbt_str_ltrim(beg," ");
307   end=beg;
308      
309   while (!done) {
310     
311        
312     switch (*end) {
313     case '\\':
314       ctn = 1;
315       /* Protected char; move it closer */
316       memmove(end,end+1,strlen(end)); 
317       if (*end=='\0')
318         THROW0(arg_error,0,"String ends with \\");
319       end++; /* Pass the protected char */
320       break;
321
322     case '\'':
323       ctn = 1;
324       if (!in_double_quote) { 
325         in_simple_quote = !in_simple_quote;
326         memmove(end,end+1,strlen(end));
327       } else {         
328         /* simple quote protected by double ones */
329         end++;
330       }
331       break;
332     case '"':
333       ctn = 1;
334       if (!in_simple_quote) { 
335         in_double_quote = !in_double_quote;
336         memmove(end,end+1,strlen(end));
337       } else {         
338         /* double quote protected by simple ones */
339         end++;
340       }   
341       break;
342
343     case ' ':
344     case '\t':
345     case '\n':
346     case '\0':
347       if (*end == '\0' && (in_simple_quote || in_double_quote)) {
348         THROW2(arg_error,0,
349                "End of string found while searching for %c in %s",
350                (in_simple_quote?'\'':'"'),
351                s);
352       }
353       if (in_simple_quote || in_double_quote) {
354         end++;
355       } else {  
356         if (ctn) {
357           /* Found a separator. Push the string if contains something */
358           char *topush=xbt_malloc(end-beg+1);
359           memcpy(topush,beg,end-beg);
360           topush[end - beg] = '\0';
361           xbt_dynar_push(res,&topush);
362         }
363         ctn= 0;
364
365         if (*end == '\0') {
366           done = 1;
367           break;
368         }
369         
370         beg=++end;
371         xbt_str_ltrim(beg," ");
372         end=beg;
373       }   
374       break;
375       
376     default:
377       ctn = 1;
378       end++;
379     }       
380   }
381   free(str);
382   return res;
383 }
384
385 #ifdef SIMGRID_TEST
386 #include "xbt/str.h"
387
388 #define mytest(name, input, expected) \
389   xbt_test_add0(name); \
390   d=xbt_str_split_quoted(input); \
391   s=xbt_str_join(d,"XXX"); \
392   xbt_test_assert3(!strcmp(s,expected),\
393                    "Input (%s) leads to (%s) instead of (%s)", \
394                    input,s,expected);\
395   free(s); \
396   xbt_dynar_free(&d);
397
398 XBT_TEST_SUITE("xbt_str","String Handling");
399 XBT_TEST_UNIT("xbt_str_split_quoted",test_split_quoted, "test the function xbt_str_split_quoted") {
400   xbt_dynar_t d;
401   char *s;
402
403   mytest("Empty", "", "");
404   mytest("Basic test", "toto tutu", "totoXXXtutu");
405   mytest("Useless backslashes", "\\t\\o\\t\\o \\t\\u\\t\\u", "totoXXXtutu");
406   mytest("Protected space", "toto\\ tutu", "toto tutu");
407   mytest("Several spaces", "toto   tutu", "totoXXXtutu");
408   mytest("LTriming", "  toto tatu", "totoXXXtatu");
409   mytest("Triming", "  toto   tutu  ", "totoXXXtutu");
410   mytest("Single quotes", "'toto tutu' tata", "toto tutuXXXtata");
411   mytest("Double quotes", "\"toto tutu\" tata", "toto tutuXXXtata");
412   mytest("Mixed quotes", "\"toto' 'tutu\" tata", "toto' 'tutuXXXtata");
413   mytest("Backslashed quotes", "\\'toto tutu\\' tata", "'totoXXXtutu'XXXtata");
414   mytest("Backslashed quotes + quotes", "'toto \\'tutu' tata", "toto 'tutuXXXtata");
415
416 }
417
418 #define mytest_str(name, input, separator, expected) \
419   xbt_test_add0(name); \
420   d=xbt_str_split_str(input, separator); \
421   s=xbt_str_join(d,"XXX"); \
422   xbt_test_assert3(!strcmp(s,expected),\
423                    "Input (%s) leads to (%s) instead of (%s)", \
424                    input,s,expected);\
425   free(s); \
426   xbt_dynar_free(&d);
427
428 XBT_TEST_UNIT("xbt_str_split_str",test_split_str, "test the function xbt_str_split_str") {
429   xbt_dynar_t d;
430   char *s;
431
432   mytest_str("Empty string and separator", "", "", "");
433   mytest_str("Empty string", "", "##", "");
434   mytest_str("Empty separator", "toto", "", "toto");
435   mytest_str("String with no separator in it", "toto", "##", "toto");
436   mytest_str("Basic test", "toto##tutu",  "##", "totoXXXtutu");
437 }
438 #endif /* SIMGRID_TEST */
439    
440 /** @brief Join a set of strings as a single string */
441
442 char *xbt_str_join(xbt_dynar_t dyn, const char*sep) {
443   int len=1,dyn_len=xbt_dynar_length(dyn);
444   unsigned int cpt;
445   char *cursor;
446   char *res,*p;
447   
448   if (!dyn_len)
449     return xbt_strdup("");
450
451   /* compute the length */
452   xbt_dynar_foreach(dyn,cpt,cursor) {
453     len+=strlen(cursor);
454   }
455   len+=strlen(sep)*dyn_len;
456   /* Do the job */
457   res = xbt_malloc(len);
458   p=res;
459   xbt_dynar_foreach(dyn,cpt,cursor) {
460     if ((int)cpt<dyn_len-1)
461       p+=sprintf(p,"%s%s",cursor,sep);    
462     else
463       p+=sprintf(p,"%s",cursor);    
464   }
465   return res;
466 }
467    
468 #if !defined(HAVE_GETLINE) || defined(DOXYGEN)
469 /* prototype here, just in case */
470 long getline(char **buf, size_t *n, FILE *stream);
471
472 /** @brief Get a single line from the stream (reimplementation of the GNU getline)
473  * 
474  * This is a redefinition of the GNU getline function, used on platforms where it does not exists.
475  * 
476  * getline() reads an entire line from stream, storing the address of the buffer 
477  * containing the text into *buf.  The buffer is null-terminated and includes 
478  * the newline character, if one was found.
479  * 
480  * If *buf is NULL, then getline() will allocate a buffer for storing the line, 
481  * which should be freed by the user program.  Alternatively, before calling getline(), 
482  * *buf can contain a pointer to a malloc()-allocated buffer *n bytes in size.  If the buffer 
483  * is not large enough to hold the line, getline() resizes it with realloc(), updating *buf and *n 
484  * as necessary.  In either case, on a successful call, *buf and *n will be updated to 
485  * reflect the buffer address and allocated size respectively.
486  */
487 long getline(char **buf, size_t *n, FILE *stream) {
488    
489    size_t i;
490    int ch;
491    
492    if (!*buf) {
493      *buf = xbt_malloc(512);
494      *n = 512;
495    }
496    
497    if (feof(stream))
498      return (ssize_t)-1;
499    
500    for (i=0; (ch = fgetc(stream)) != EOF; i++)  {
501         
502       if (i >= (*n) + 1)
503         *buf = xbt_realloc(*buf, *n += 512);
504         
505       (*buf)[i] = ch;
506         
507       if ((*buf)[i] == '\n')  {
508          i++;
509          (*buf)[i] = '\0';
510          break;
511       }      
512    }
513       
514    if (i == *n) 
515      *buf = xbt_realloc(*buf, *n += 1);
516    
517    (*buf)[i] = '\0';
518
519    return (ssize_t)i;
520 }
521
522 #endif /* HAVE_GETLINE */
523
524 /*
525  * Diff related functions 
526  */
527 static xbt_matrix_t diff_build_LCS(xbt_dynar_t da, xbt_dynar_t db) {
528   xbt_matrix_t C = xbt_matrix_new(xbt_dynar_length(da),xbt_dynar_length(db),
529                                   sizeof(int),NULL); 
530   unsigned long i,j;
531
532   /* Compute the LCS */
533   /*
534     C = array(0..m, 0..n)
535     for i := 0..m
536        C[i,0] = 0
537     for j := 1..n
538        C[0,j] = 0
539     for i := 1..m
540         for j := 1..n
541             if X[i] = Y[j]
542                 C[i,j] := C[i-1,j-1] + 1
543             else:
544                 C[i,j] := max(C[i,j-1], C[i-1,j])
545     return C[m,n]
546           */
547   if (xbt_dynar_length(db) != 0)
548     for (i=0; i<xbt_dynar_length(da); i++) 
549       *((int*) xbt_matrix_get_ptr(C,i,0) ) = 0;
550
551   if (xbt_dynar_length(da) != 0)
552     for (j=0; j<xbt_dynar_length(db); j++) 
553       *((int*) xbt_matrix_get_ptr(C,0,j) ) = 0;
554
555   for (i=1; i<xbt_dynar_length(da); i++) 
556     for (j=1; j<xbt_dynar_length(db); j++) {
557
558       if (!strcmp(xbt_dynar_get_as(da,i,char*), xbt_dynar_get_as(db,j,char*)))
559         *((int*) xbt_matrix_get_ptr(C,i,j) ) = xbt_matrix_get_as(C,i-1,j-1,int) + 1;
560       else
561         *((int*) xbt_matrix_get_ptr(C,i,j) ) = max(xbt_matrix_get_as(C,i  ,j-1,int),
562                                                    xbt_matrix_get_as(C,i-1,j,int));
563     }
564   return C;
565 }
566
567 static void diff_build_diff(xbt_dynar_t res,
568                             xbt_matrix_t C,
569                             xbt_dynar_t da, xbt_dynar_t db,
570                             int i,int j) {
571   char *topush;
572   /* Construct the diff 
573   function printDiff(C[0..m,0..n], X[1..m], Y[1..n], i, j)
574     if i > 0 and j > 0 and X[i] = Y[j]
575         printDiff(C, X, Y, i-1, j-1)
576         print "  " + X[i]
577     else
578         if j > 0 and (i = 0 or C[i,j-1] >= C[i-1,j])
579             printDiff(C, X, Y, i, j-1)
580             print "+ " + Y[j]
581         else if i > 0 and (j = 0 or C[i,j-1] < C[i-1,j])
582             printDiff(C, X, Y, i-1, j)
583             print "- " + X[i]
584   */
585
586   if (i>=0 && j >= 0 && !strcmp(xbt_dynar_get_as(da,i,char*),
587                                 xbt_dynar_get_as(db,j,char*))) {
588     diff_build_diff(res,C,da,db,i-1,j-1);
589     topush = bprintf("  %s",xbt_dynar_get_as(da,i,char*));
590     xbt_dynar_push(res, &topush);
591   } else if (j>=0 && 
592              (i<=0 ||j==0|| xbt_matrix_get_as(C,i,j-1,int) >= xbt_matrix_get_as(C,i-1,j,int))) {
593     diff_build_diff(res,C,da,db,i,j-1);
594     topush = bprintf("+ %s",xbt_dynar_get_as(db,j,char*));
595     xbt_dynar_push(res,&topush);
596   } else if (i>=0 && 
597              (j<=0 || xbt_matrix_get_as(C,i,j-1,int) < xbt_matrix_get_as(C,i-1,j,int))) {
598     diff_build_diff(res,C,da,db,i-1,j);
599     topush = bprintf("- %s",xbt_dynar_get_as(da,i,char*));
600     xbt_dynar_push(res,&topush);        
601   } else if (i<=0 && j<=0) {
602     return;
603   } else {
604     THROW2(arg_error,0,"Invalid values: i=%d, j=%d",i,j);
605   }
606    
607 }
608
609 /** @brief Compute the unified diff of two strings */
610 char *xbt_str_diff(char *a, char *b) {
611   xbt_dynar_t da = xbt_str_split(a, "\n");
612   xbt_dynar_t db = xbt_str_split(b, "\n");
613
614   xbt_matrix_t C = diff_build_LCS(da,db);
615   xbt_dynar_t diff = xbt_dynar_new(sizeof(char*),free_string);
616   char *res=NULL;
617   
618   diff_build_diff(diff, C, da,db, xbt_dynar_length(da)-1, xbt_dynar_length(db)-1);
619   /* Clean empty lines at the end */
620   while (xbt_dynar_length(diff) > 0) {
621      char *str;
622      xbt_dynar_pop(diff,&str);
623      if (str[0]=='\0' || !strcmp(str,"  ")) {
624         free(str);
625      } else {
626         xbt_dynar_push(diff,&str);
627         break;
628      }     
629   }   
630   res = xbt_str_join(diff, "\n");
631
632   xbt_dynar_free(&da);
633   xbt_dynar_free(&db);
634   xbt_dynar_free(&diff);
635   xbt_matrix_free(C);
636   
637   return res;
638 }