Changed all the licence notices in all the files.
[pspp] / src / str.c
1 /* PSPP - computes sample statistics.
2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
3    Written by Ben Pfaff <blp@gnu.org>.
4
5    This program is free software; you can redistribute it and/or
6    modify it under the terms of the GNU General Public License as
7    published by the Free Software Foundation; either version 2 of the
8    License, or (at your option) any later version.
9
10    This program is distributed in the hope that it will be useful, but
11    WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this program; if not, write to the Free Software
17    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18    02110-1301, USA. */
19
20 #include <config.h>
21 #include "str.h"
22 #include "error.h"
23 #include <ctype.h>
24 #include <limits.h>
25 #include <stdlib.h>
26 #include "alloc.h"
27 #include "error.h"
28 #include "pool.h"
29 \f
30 /* sprintf() wrapper functions for convenience. */
31
32 #if !__GNUC__
33 char *
34 spprintf (char *buf, const char *format,...)
35 {
36 #if HAVE_GOOD_SPRINTF
37   int count;
38 #endif
39   va_list args;
40
41   va_start (args, format);
42 #if HAVE_GOOD_SPRINTF
43   count =
44 #endif
45     vsprintf (buf, format, args);
46   va_end (args);
47
48 #if HAVE_GOOD_SPRINTF
49   return &buf[count];
50 #else
51   return strchr (buf, 0);
52 #endif
53 }
54 #endif /* !__GNUC__ */
55
56 #if !__GNUC__ && !HAVE_GOOD_SPRINTF
57 int
58 nsprintf (char *buf, const char *format,...)
59 {
60   va_list args;
61
62   va_start (args, format);
63   vsprintf (buf, format, args);
64   va_end (args);
65
66   return strlen (buf);
67 }
68
69 int
70 nvsprintf (char *buf, const char *format, va_list args)
71 {
72   vsprintf (buf, format, args);
73   return strlen (buf);
74 }
75 #endif /* Not GNU C and not good sprintf(). */
76 \f
77 /* Reverses the order of NBYTES bytes at address P, thus converting
78    between little- and big-endian byte orders.  */
79 void
80 mm_reverse (void *p, size_t nbytes)
81 {
82   unsigned char *h = p, *t = &h[nbytes - 1];
83   unsigned char temp;
84
85   nbytes /= 2;
86   while (nbytes--)
87     {
88       temp = *h;
89       *h++ = *t;
90       *t-- = temp;
91     }
92 }
93
94 /* Finds the last NEEDLE of length NEEDLE_LEN in a HAYSTACK of length
95    HAYSTACK_LEN.  Returns a pointer to the needle found. */
96 char *
97 mm_find_reverse (const char *haystack, size_t haystack_len,
98          const char *needle, size_t needle_len)
99 {
100   int i;
101   for (i = haystack_len - needle_len; i >= 0; i--)
102     if (!memcmp (needle, &haystack[i], needle_len))
103       return (char *) &haystack[i];
104   return 0;
105 }
106
107 /* Compares A of length A_LEN to B of length B_LEN.  The shorter
108    string is considered to be padded with spaces to the length of
109    the longer. */
110 int
111 st_compare_pad (const char *a, size_t a_len, const char *b, size_t b_len)
112 {
113   size_t min_len;
114   int result;
115
116   min_len = a_len < b_len ? a_len : b_len;
117   result = memcmp (a, b, min_len);
118   if (result != 0)
119     return result;
120   else 
121     {
122       size_t idx;
123       
124       if (a_len < b_len) 
125         {
126           for (idx = min_len; idx < b_len; idx++)
127             if (' ' != b[idx])
128               return ' ' > b[idx] ? 1 : -1;
129         }
130       else 
131         {
132           for (idx = min_len; idx < a_len; idx++)
133             if (a[idx] != ' ')
134               return a[idx] > ' ' ? 1 : -1;
135         }
136       return 0;
137     }
138 }
139
140 /* Copies SRC to DEST, truncating to N characters or right-padding
141    with spaces to N characters as necessary.  Does not append a null
142    character.  SRC must be null-terminated. */
143 void
144 st_bare_pad_copy (char *dest, const char *src, size_t n)
145 {
146   size_t len;
147
148   len = strlen (src);
149   if (len >= n)
150     memcpy (dest, src, n);
151   else
152     {
153       memcpy (dest, src, len);
154       memset (&dest[len], ' ', n - len);
155     }
156 }
157
158 /* Copies SRC to DEST, truncating SRC to N characters or right-padding
159    with spaces to N characters if necessary.  Does not append a null
160    character.  SRC must be LEN characters long but does not need to be
161    null-terminated. */
162 void
163 st_bare_pad_len_copy (char *dest, const char *src, size_t n, size_t len)
164 {
165   if (len >= n)
166     memmove (dest, src, n);
167   else
168     {
169       memmove (dest, src, len);
170       memset (&dest[len], ' ', n - len);
171     }
172 }
173
174 /* Copies SRC to DEST, truncating SRC to N-1 characters or
175    right-padding with spaces to N-1 characters if necessary.  Always
176    appends a null character. */
177 void
178 st_pad_copy (char *dest, const char *src, size_t n)
179 {
180   size_t len;
181
182   len = strlen (src);
183   if (len == n - 1)
184     strcpy (dest, src);
185   else if (len < n - 1)
186     {
187       memcpy (dest, src, len);
188       memset (&dest[len], ' ', n - 1 - len);
189       dest[n - 1] = 0;
190     }
191   else
192     {
193       memcpy (dest, src, n - 1);
194       dest[n - 1] = 0;
195     }
196 }
197
198 /* Copies SRC to DST, truncating DST to N-1 characters if
199    necessary.  Always appends a null character. */
200 void
201 st_trim_copy (char *dst, const char *src, size_t n) 
202 {
203   size_t len = strlen (src);
204   assert (n > 0);
205   if (len + 1 < n)
206     memcpy (dst, src, len + 1);
207   else 
208     {
209       memcpy (dst, src, n - 1);
210       dst[n - 1] = '\0';
211     }
212 }
213
214
215 /* Converts each character in S to uppercase. */
216 void
217 st_uppercase (char *s) 
218 {
219   for (; *s != '\0'; s++)
220     *s = toupper ((unsigned char) *s);
221 }
222 \f
223 /* Initializes ST with initial contents S. */
224 void
225 ds_create (struct string *st, const char *s)
226 {
227   st->length = strlen (s);
228   st->capacity = 8 + st->length * 2;
229   st->string = xmalloc (st->capacity + 1);
230   strcpy (st->string, s);
231 }
232
233 /* Initializes ST, making room for at least CAPACITY characters. */
234 void
235 ds_init (struct string *st, size_t capacity)
236 {
237   st->length = 0;
238   if (capacity > 8)
239     st->capacity = capacity;
240   else
241     st->capacity = 8;
242   st->string = xmalloc (st->capacity + 1);
243 }
244
245 /* Replaces the contents of ST with STRING.  STRING may overlap with
246    ST. */
247 void
248 ds_replace (struct string *st, const char *string)
249 {
250   size_t new_length = strlen (string);
251   if (new_length > st->capacity) 
252     {
253       /* The new length is longer than the allocated length, so
254          there can be no overlap. */
255       st->length = 0;
256       ds_concat (st, string, new_length);
257     }
258   else
259     {
260       /* Overlap is possible, but the new string will fit in the
261          allocated space, so we can just copy data. */
262       st->length = new_length;
263       memmove (st->string, string, st->length);
264     }
265 }
266
267 /* Frees ST. */
268 void
269 ds_destroy (struct string *st)
270 {
271   free (st->string);
272 }
273
274 /* Truncates ST to zero length. */
275 void
276 ds_clear (struct string *st)
277 {
278   st->length = 0;
279 }
280
281 /* Pad ST on the right with copies of PAD until ST is at least
282    LENGTH characters in size.  If ST is initially LENGTH
283    characters or longer, this is a no-op. */
284 void
285 ds_rpad (struct string *st, size_t length, char pad) 
286 {
287   assert (st != NULL);
288   if (st->length < length) 
289     {
290       if (st->capacity < length)
291         ds_extend (st, length);
292       memset (&st->string[st->length], pad, length - st->length);
293       st->length = length;
294     }
295 }
296
297 /* Ensures that ST can hold at least MIN_CAPACITY characters plus a null
298    terminator. */
299 void
300 ds_extend (struct string *st, size_t min_capacity)
301 {
302   if (min_capacity > st->capacity)
303     {
304       st->capacity *= 2;
305       if (st->capacity < min_capacity)
306         st->capacity = min_capacity * 2;
307       
308       st->string = xrealloc (st->string, st->capacity + 1);
309     }
310 }
311
312 /* Shrink ST to the minimum capacity need to contain its content. */
313 void
314 ds_shrink (struct string *st)
315 {
316   if (st->capacity != st->length)
317     {
318       st->capacity = st->length;
319       st->string = xrealloc (st->string, st->capacity + 1);
320     }
321 }
322
323 /* Truncates ST to at most LENGTH characters long. */
324 void
325 ds_truncate (struct string *st, size_t length)
326 {
327   if (length >= st->length)
328     return;
329   st->length = length;
330 }
331
332 /* Returns the length of ST. */
333 size_t
334 ds_length (const struct string *st)
335 {
336   return st->length;
337 }
338
339 /* Returns the allocation size of ST. */
340 size_t
341 ds_capacity (const struct string *st)
342 {
343   return st->capacity;
344 }
345
346 /* Returns the value of ST as a null-terminated string. */
347 char *
348 ds_c_str (const struct string *st)
349 {
350   ((char *) st->string)[st->length] = '\0';
351   return st->string;
352 }
353
354 /* Returns the string data inside ST. */
355 char *
356 ds_data (const struct string *st)
357 {
358   return st->string;
359 }
360
361 /* Returns a pointer to the null terminator ST.
362    This might not be an actual null character unless ds_c_str() has
363    been called since the last modification to ST. */
364 char *
365 ds_end (const struct string *st)
366 {
367   return st->string + st->length;
368 }
369
370 /* Concatenates S onto ST. */
371 void
372 ds_puts (struct string *st, const char *s)
373 {
374   size_t s_len;
375
376   if (!s) return;
377
378   s_len = strlen (s);
379   ds_extend (st, st->length + s_len);
380   strcpy (st->string + st->length, s);
381   st->length += s_len;
382 }
383
384 /* Concatenates LEN characters from BUF onto ST. */
385 void
386 ds_concat (struct string *st, const char *buf, size_t len)
387 {
388   ds_extend (st, st->length + len);
389   memcpy (st->string + st->length, buf, len);
390   st->length += len;
391 }
392
393 void ds_vprintf (struct string *st, const char *format, va_list args);
394
395
396 /* Formats FORMAT as a printf string and appends the result to ST. */
397 void
398 ds_printf (struct string *st, const char *format, ...)
399 {
400   va_list args;
401
402   va_start (args, format);
403   ds_vprintf(st,format,args);
404   va_end (args);
405
406 }
407
408 /* Formats FORMAT as a printf string and appends the result to ST. */
409 void
410 ds_vprintf (struct string *st, const char *format, va_list args)
411 {
412   /* Fscking glibc silently changed behavior between 2.0 and 2.1.
413      Fsck fsck fsck.  Before, it returned -1 on buffer overflow.  Now,
414      it returns the number of characters (not bytes) that would have
415      been written. */
416
417   int avail, needed;
418
419   avail = st->capacity - st->length + 1;
420   needed = vsnprintf (st->string + st->length, avail, format, args);
421
422
423   if (needed >= avail)
424     {
425       ds_extend (st, st->length + needed);
426       
427       vsprintf (st->string + st->length, format, args);
428     }
429   else
430     while (needed == -1)
431       {
432         ds_extend (st, (st->capacity + 1) * 2);
433         avail = st->capacity - st->length + 1;
434
435         needed = vsnprintf (st->string + st->length, avail, format, args);
436
437       }
438
439   st->length += needed;
440 }
441
442 /* Appends character CH to ST. */
443 void
444 ds_putc (struct string *st, int ch)
445 {
446   if (st->length == st->capacity)
447     ds_extend (st, st->length + 1);
448   st->string[st->length++] = ch;
449 }
450
451 /* Appends to ST a newline-terminated line read from STREAM.
452    Newline is the last character of ST on return, unless an I/O error
453    or end of file is encountered after reading some characters.
454    Returns 1 if a line is successfully read, or 0 if no characters at
455    all were read before an I/O error or end of file was
456    encountered. */
457 int
458 ds_gets (struct string *st, FILE *stream)
459 {
460   int c;
461
462   c = getc (stream);
463   if (c == EOF)
464     return 0;
465
466   for (;;)
467     {
468       ds_putc (st, c);
469       if (c == '\n')
470         return 1;
471
472       c = getc (stream);
473       if (c == EOF)
474         return 1;
475     }
476 }
477
478 /* Reads a line from STREAM into ST, then preprocesses as follows:
479
480    - Splices lines terminated with `\'.
481
482    - Deletes comments introduced by `#' outside of single or double
483      quotes.
484
485    - Trailing whitespace will be deleted.  
486
487    Increments cust_ln as appropriate.
488
489    Returns nonzero only if a line was successfully read. */
490 int
491 ds_get_config_line (FILE *stream, struct string *st, struct file_locator *where)
492 {
493   /* Read the first line. */
494   ds_clear (st);
495   where->line_number++;
496   if (!ds_gets (st, stream))
497     return 0;
498
499   /* Read additional lines, if any. */
500   for (;;)
501     {
502       /* Remove trailing whitespace. */
503       {
504         char *s = ds_c_str (st);
505         size_t len = ds_length (st);
506       
507         while (len > 0 && isspace ((unsigned char) s[len - 1]))
508           len--;
509         ds_truncate (st, len);
510       }
511
512       /* Check for trailing \.  Remove if found, bail otherwise. */
513       if (ds_length (st) == 0 || ds_c_str (st)[ds_length (st) - 1] != '\\')
514         break;
515       ds_truncate (st, ds_length (st) - 1);
516
517       /* Append another line and go around again. */
518       {
519         int success = ds_gets (st, stream);
520         where->line_number++;
521         if (!success)
522           return 1;
523       }
524     }
525
526   /* Find a comment and remove. */
527   {
528     char *cp;
529     int quote = 0;
530       
531     for (cp = ds_c_str (st); *cp; cp++)
532       if (quote)
533         {
534           if (*cp == quote)
535             quote = 0;
536           else if (*cp == '\\')
537             cp++;
538         }
539       else if (*cp == '\'' || *cp == '"')
540         quote = *cp;
541       else if (*cp == '#')
542         {
543           ds_truncate (st, cp - ds_c_str (st));
544           break;
545         }
546   }
547
548   return 1;
549 }
550 \f
551 /* Lengthed strings. */
552
553 /* Creates a new lengthed string LS with contents as a copy of
554    S. */
555 void
556 ls_create (struct fixed_string *ls, const char *s)
557 {
558   ls->length = strlen (s);
559   ls->string = xmalloc (ls->length + 1);
560   memcpy (ls->string, s, ls->length + 1);
561 }
562
563 /* Creates a new lengthed string LS with contents as a copy of
564    BUFFER with length LEN. */
565 void
566 ls_create_buffer (struct fixed_string *ls,
567                   const char *buffer, size_t len)
568 {
569   ls->length = len;
570   ls->string = xmalloc (len + 1);
571   memcpy (ls->string, buffer, len);
572   ls->string[len] = '\0';
573 }
574
575 /* Sets the fields of LS to the specified values. */
576 void
577 ls_init (struct fixed_string *ls, const char *string, size_t length)
578 {
579   ls->string = (char *) string;
580   ls->length = length;
581 }
582
583 /* Copies the fields of SRC to DST. */
584 void
585 ls_shallow_copy (struct fixed_string *dst, const struct fixed_string *src)
586 {
587   *dst = *src;
588 }
589
590 /* Frees the memory backing LS. */
591 void
592 ls_destroy (struct fixed_string *ls)
593 {
594   free (ls->string);
595 }
596
597 /* Sets LS to a null pointer value. */
598 void
599 ls_null (struct fixed_string *ls)
600 {
601   ls->string = NULL;
602 }
603
604 /* Returns nonzero only if LS has a null pointer value. */
605 int
606 ls_null_p (const struct fixed_string *ls)
607 {
608   return ls->string == NULL;
609 }
610
611 /* Returns nonzero only if LS is a null pointer or has length 0. */
612 int
613 ls_empty_p (const struct fixed_string *ls)
614 {
615   return ls->string == NULL || ls->length == 0;
616 }
617
618 /* Returns the length of LS, which must not be null. */
619 size_t
620 ls_length (const struct fixed_string *ls)
621 {
622   return ls->length;
623 }
624
625 /* Returns a pointer to the character string in LS. */
626 char *
627 ls_c_str (const struct fixed_string *ls)
628 {
629   return (char *) ls->string;
630 }
631
632 /* Returns a pointer to the null terminator of the character string in
633    LS. */
634 char *
635 ls_end (const struct fixed_string *ls)
636 {
637   return (char *) (ls->string + ls->length);
638 }