src/libpspp/str.c

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 1997-9, 2000, 2006 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 "message.h"
  23 #include <ctype.h>
  24 #include <limits.h>
  25 #include <stdlib.h>
  26 #include "alloc.h"
  27 #include "message.h"
  28 \f
  29 /* Reverses the order of NBYTES bytes at address P, thus converting
  30    between little- and big-endian byte orders.  */
  31 void
  32 buf_reverse (char *p, size_t nbytes)
  33 {
  34   char *h = p, *t = &h[nbytes - 1];
  35   char temp;
  36
  37   nbytes /= 2;
  38   while (nbytes--)
  39     {
  40       temp = *h;
  41       *h++ = *t;
  42       *t-- = temp;
  43     }
  44 }
  45
  46 /* Finds the last NEEDLE of length NEEDLE_LEN in a HAYSTACK of length
  47    HAYSTACK_LEN.  Returns a pointer to the needle found. */
  48 char *
  49 buf_find_reverse (const char *haystack, size_t haystack_len,
  50                  const char *needle, size_t needle_len)
  51 {
  52   int i;
  53   for (i = haystack_len - needle_len; i >= 0; i--)
  54     if (!memcmp (needle, &haystack[i], needle_len))
  55       return (char *) &haystack[i];
  56   return 0;
  57 }
  58
  59 /* Compares the SIZE bytes in A to those in B, disregarding case,
  60    and returns a strcmp()-type result. */
  61 int
  62 buf_compare_case (const char *a_, const char *b_, size_t size)
  63 {
  64   const unsigned char *a = (unsigned char *) a_;
  65   const unsigned char *b = (unsigned char *) b_;
  66
  67   while (size-- > 0)
  68     {
  69       unsigned char ac = toupper (*a++);
  70       unsigned char bc = toupper (*b++);
  71
  72       if (ac != bc)
  73         return ac > bc ? 1 : -1;
  74     }
  75
  76   return 0;
  77 }
  78
  79 /* Compares A of length A_LEN to B of length B_LEN.  The shorter
  80    string is considered to be padded with spaces to the length of
  81    the longer. */
  82 int
  83 buf_compare_rpad (const char *a, size_t a_len, const char *b, size_t b_len)
  84 {
  85   size_t min_len;
  86   int result;
  87
  88   min_len = a_len < b_len ? a_len : b_len;
  89   result = memcmp (a, b, min_len);
  90   if (result != 0)
  91     return result;
  92   else
  93     {
  94       size_t idx;
  95
  96       if (a_len < b_len)
  97         {
  98           for (idx = min_len; idx < b_len; idx++)
  99             if (' ' != b[idx])
 100               return ' ' > b[idx] ? 1 : -1;
 101         }
 102       else
 103         {
 104           for (idx = min_len; idx < a_len; idx++)
 105             if (a[idx] != ' ')
 106               return a[idx] > ' ' ? 1 : -1;
 107         }
 108       return 0;
 109     }
 110 }
 111
 112 /* Compares strin A to string B.  The shorter string is
 113    considered to be padded with spaces to the length of the
 114    longer. */
 115 int
 116 str_compare_rpad (const char *a, const char *b)
 117 {
 118   return buf_compare_rpad (a, strlen (a), b, strlen (b));
 119 }
 120
 121 /* Copies string SRC to buffer DST, of size DST_SIZE bytes.
 122    DST is truncated to DST_SIZE bytes or padded on the right with
 123    spaces as needed. */
 124 void
 125 buf_copy_str_rpad (char *dst, size_t dst_size, const char *src)
 126 {
 127   size_t src_len = strlen (src);
 128   if (src_len >= dst_size)
 129     memcpy (dst, src, dst_size);
 130   else
 131     {
 132       memcpy (dst, src, src_len);
 133       memset (&dst[src_len], ' ', dst_size - src_len);
 134     }
 135 }
 136
 137 /* Copies string SRC to buffer DST, of size DST_SIZE bytes.
 138    DST is truncated to DST_SIZE bytes or padded on the left with
 139    spaces as needed. */
 140 void
 141 buf_copy_str_lpad (char *dst, size_t dst_size, const char *src)
 142 {
 143   size_t src_len = strlen (src);
 144   if (src_len >= dst_size)
 145     memcpy (dst, src, dst_size);
 146   else
 147     {
 148       size_t pad_cnt = dst_size - src_len;
 149       memset (&dst[0], ' ', pad_cnt);
 150       memcpy (dst + pad_cnt, src, src_len);
 151     }
 152 }
 153
 154 /* Copies buffer SRC, of SRC_SIZE bytes, to DST, of DST_SIZE bytes.
 155    DST is truncated to DST_SIZE bytes or padded on the right with
 156    spaces as needed. */
 157 void
 158 buf_copy_rpad (char *dst, size_t dst_size,
 159                const char *src, size_t src_size)
 160 {
 161   if (src_size >= dst_size)
 162     memmove (dst, src, dst_size);
 163   else
 164     {
 165       memmove (dst, src, src_size);
 166       memset (&dst[src_size], ' ', dst_size - src_size);
 167     }
 168 }
 169
 170 /* Copies string SRC to string DST, which is in a buffer DST_SIZE
 171    bytes long.
 172    Truncates DST to DST_SIZE - 1 characters or right-pads with
 173    spaces to DST_SIZE - 1 characters if necessary. */
 174 void
 175 str_copy_rpad (char *dst, size_t dst_size, const char *src)
 176 {
 177   size_t src_len = strlen (src);
 178   if (src_len < dst_size - 1)
 179     {
 180       memcpy (dst, src, src_len);
 181       memset (&dst[src_len], ' ', dst_size - 1 - src_len);
 182     }
 183   else
 184     memcpy (dst, src, dst_size - 1);
 185   dst[dst_size - 1] = 0;
 186 }
 187
 188 /* Copies SRC to DST, which is in a buffer DST_SIZE bytes long.
 189    Truncates DST to DST_SIZE - 1 characters, if necessary. */
 190 void
 191 str_copy_trunc (char *dst, size_t dst_size, const char *src)
 192 {
 193   size_t src_len = strlen (src);
 194   assert (dst_size > 0);
 195   if (src_len + 1 < dst_size)
 196     memcpy (dst, src, src_len + 1);
 197   else
 198     {
 199       memcpy (dst, src, dst_size - 1);
 200       dst[dst_size - 1] = '\0';
 201     }
 202 }
 203
 204 /* Copies buffer SRC, of SRC_LEN bytes,
 205    to DST, which is in a buffer DST_SIZE bytes long.
 206    Truncates DST to DST_SIZE - 1 characters, if necessary. */
 207 void
 208 str_copy_buf_trunc (char *dst, size_t dst_size,
 209                     const char *src, size_t src_size)
 210 {
 211   size_t dst_len;
 212   assert (dst_size > 0);
 213
 214   dst_len = src_size < dst_size ? src_size : dst_size - 1;
 215   memcpy (dst, src, dst_len);
 216   dst[dst_len] = '\0';
 217 }
 218
 219 /* Converts each character in S to uppercase. */
 220 void
 221 str_uppercase (char *s)
 222 {
 223   for (; *s != '\0'; s++)
 224     *s = toupper ((unsigned char) *s);
 225 }
 226
 227 /* Converts each character in S to lowercase. */
 228 void
 229 str_lowercase (char *s)
 230 {
 231   for (; *s != '\0'; s++)
 232     *s = tolower ((unsigned char) *s);
 233 }
 234 \f
 235 /* Initializes ST with initial contents S. */
 236 void
 237 ds_create (struct string *st, const char *s)
 238 {
 239   st->length = strlen (s);
 240   st->capacity = 8 + st->length * 2;
 241   st->string = xmalloc (st->capacity + 1);
 242   strcpy (st->string, s);
 243 }
 244
 245 /* Initializes ST, making room for at least CAPACITY characters. */
 246 void
 247 ds_init (struct string *st, size_t capacity)
 248 {
 249   st->length = 0;
 250   if (capacity > 8)
 251     st->capacity = capacity;
 252   else
 253     st->capacity = 8;
 254   st->string = xmalloc (st->capacity + 1);
 255 }
 256
 257 /* Replaces the contents of ST with STRING.  STRING may overlap with
 258    ST. */
 259 void
 260 ds_replace (struct string *st, const char *string)
 261 {
 262   size_t new_length = strlen (string);
 263   if (new_length > st->capacity)
 264     {
 265       /* The new length is longer than the allocated length, so
 266          there can be no overlap. */
 267       st->length = 0;
 268       ds_concat (st, string, new_length);
 269     }
 270   else
 271     {
 272       /* Overlap is possible, but the new string will fit in the
 273          allocated space, so we can just copy data. */
 274       st->length = new_length;
 275       memmove (st->string, string, st->length);
 276     }
 277 }
 278
 279 /* Frees ST. */
 280 void
 281 ds_destroy (struct string *st)
 282 {
 283   free (st->string);
 284   st->string = NULL;
 285 }
 286
 287 /* Swaps the contents of strings A and B. */
 288 void
 289 ds_swap (struct string *a, struct string *b)
 290 {
 291   struct string tmp = *a;
 292   *a = *b;
 293   *b = tmp;
 294 }
 295
 296 /* Truncates ST to zero length. */
 297 void
 298 ds_clear (struct string *st)
 299 {
 300   st->length = 0;
 301 }
 302
 303 /* Pad ST on the right with copies of PAD until ST is at least
 304    LENGTH characters in size.  If ST is initially LENGTH
 305    characters or longer, this is a no-op. */
 306 void
 307 ds_rpad (struct string *st, size_t length, char pad)
 308 {
 309   assert (st != NULL);
 310   if (st->length < length)
 311     {
 312       if (st->capacity < length)
 313         ds_extend (st, length);
 314       memset (&st->string[st->length], pad, length - st->length);
 315       st->length = length;
 316     }
 317 }
 318
 319 /* Removes trailing spaces from ST.
 320    Returns number of spaces removed. */
 321 int
 322 ds_rtrim_spaces (struct string *st)
 323 {
 324   int cnt = 0;
 325   while (isspace (ds_last (st)))
 326     {
 327       st->length--;
 328       cnt++;
 329     }
 330   return cnt;
 331 }
 332
 333 /* If the last character in ST is C, removes it and returns true.
 334    Otherwise, returns false without modifying ST. */
 335 bool
 336 ds_chomp (struct string *st, char c_)
 337 {
 338   unsigned char c = c_;
 339   if (ds_last (st) == c)
 340     {
 341       st->length--;
 342       return true;
 343     }
 344   else
 345     return false;
 346 }
 347
 348 /* Ensures that ST can hold at least MIN_CAPACITY characters plus a null
 349    terminator. */
 350 void
 351 ds_extend (struct string *st, size_t min_capacity)
 352 {
 353   if (min_capacity > st->capacity)
 354     {
 355       st->capacity *= 2;
 356       if (st->capacity < min_capacity)
 357         st->capacity = min_capacity * 2;
 358
 359       st->string = xrealloc (st->string, st->capacity + 1);
 360     }
 361 }
 362
 363 /* Shrink ST to the minimum capacity need to contain its content. */
 364 void
 365 ds_shrink (struct string *st)
 366 {
 367   if (st->capacity != st->length)
 368     {
 369       st->capacity = st->length;
 370       st->string = xrealloc (st->string, st->capacity + 1);
 371     }
 372 }
 373
 374 /* Truncates ST to at most LENGTH characters long. */
 375 void
 376 ds_truncate (struct string *st, size_t length)
 377 {
 378   if (length >= st->length)
 379     return;
 380   st->length = length;
 381 }
 382
 383 /* Returns true if ST is empty, false otherwise. */
 384 bool
 385 ds_is_empty (const struct string *st)
 386 {
 387   return st->length == 0;
 388 }
 389
 390 /* Returns the length of ST. */
 391 size_t
 392 ds_length (const struct string *st)
 393 {
 394   return st->length;
 395 }
 396
 397 /* Returns the allocation size of ST. */
 398 size_t
 399 ds_capacity (const struct string *st)
 400 {
 401   return st->capacity;
 402 }
 403
 404 /* Returns the first character in ST as a value in the range of
 405    unsigned char.  Returns EOF if ST is the empty string. */
 406 int
 407 ds_first (const struct string *st)
 408 {
 409   return st->length > 0 ? (unsigned char) st->string[0] : EOF;
 410 }
 411
 412 /* Returns the last character in ST as a value in the range of
 413    unsigned char.  Returns EOF if ST is the empty string. */
 414 int
 415 ds_last (const struct string *st)
 416 {
 417   return st->length > 0 ? (unsigned char) st->string[st->length - 1] : EOF;
 418 }
 419
 420 /* Returns the value of ST as a null-terminated string. */
 421 char *
 422 ds_c_str (const struct string *st)
 423 {
 424   ((char *) st->string)[st->length] = '\0';
 425   return st->string;
 426 }
 427
 428 /* Returns the string data inside ST. */
 429 char *
 430 ds_data (const struct string *st)
 431 {
 432   return st->string;
 433 }
 434
 435 /* Returns a pointer to the null terminator ST.
 436    This might not be an actual null character unless ds_c_str() has
 437    been called since the last modification to ST. */
 438 char *
 439 ds_end (const struct string *st)
 440 {
 441   return st->string + st->length;
 442 }
 443
 444 /* Concatenates S onto ST. */
 445 void
 446 ds_puts (struct string *st, const char *s)
 447 {
 448   size_t s_len;
 449
 450   if (!s) return;
 451
 452   s_len = strlen (s);
 453   ds_extend (st, st->length + s_len);
 454   strcpy (st->string + st->length, s);
 455   st->length += s_len;
 456 }
 457
 458 /* Concatenates LEN characters from BUF onto ST. */
 459 void
 460 ds_concat (struct string *st, const char *buf, size_t len)
 461 {
 462   ds_extend (st, st->length + len);
 463   memcpy (st->string + st->length, buf, len);
 464   st->length += len;
 465 }
 466
 467 void ds_vprintf (struct string *st, const char *format, va_list args);
 468
 469
 470 /* Formats FORMAT as a printf string and appends the result to ST. */
 471 void
 472 ds_printf (struct string *st, const char *format, ...)
 473 {
 474   va_list args;
 475
 476   va_start (args, format);
 477   ds_vprintf(st,format,args);
 478   va_end (args);
 479
 480 }
 481
 482 /* Formats FORMAT as a printf string and appends the result to ST. */
 483 void
 484 ds_vprintf (struct string *st, const char *format, va_list args)
 485 {
 486   /* Fscking glibc silently changed behavior between 2.0 and 2.1.
 487      Fsck fsck fsck.  Before, it returned -1 on buffer overflow.  Now,
 488      it returns the number of characters (not bytes) that would have
 489      been written. */
 490
 491   int avail, needed;
 492   va_list a1;
 493
 494   va_copy(a1, args);
 495   avail = st->capacity - st->length + 1;
 496   needed = vsnprintf (st->string + st->length, avail, format, args);
 497
 498
 499   if (needed >= avail)
 500     {
 501       ds_extend (st, st->length + needed);
 502
 503       vsprintf (st->string + st->length, format, a1);
 504     }
 505   else
 506     while (needed == -1)
 507       {
 508         va_list a2;
 509         va_copy(a2, a1);
 510
 511         ds_extend (st, (st->capacity + 1) * 2);
 512         avail = st->capacity - st->length + 1;
 513
 514         needed = vsnprintf (st->string + st->length, avail, format, a2);
 515         va_end(a2);
 516
 517       }
 518   va_end(a1);
 519
 520   st->length += needed;
 521 }
 522
 523 /* Appends character CH to ST. */
 524 void
 525 ds_putc (struct string *st, int ch)
 526 {
 527   if (st->length == st->capacity)
 528     ds_extend (st, st->length + 1);
 529   st->string[st->length++] = ch;
 530 }
 531
 532 /* Appends to ST a newline-terminated line read from STREAM.
 533    Newline is the last character of ST on return, unless an I/O error
 534    or end of file is encountered after reading some characters.
 535    Returns 1 if a line is successfully read, or 0 if no characters at
 536    all were read before an I/O error or end of file was
 537    encountered. */
 538 int
 539 ds_gets (struct string *st, FILE *stream)
 540 {
 541   int c;
 542
 543   c = getc (stream);
 544   if (c == EOF)
 545     return 0;
 546
 547   for (;;)
 548     {
 549       ds_putc (st, c);
 550       if (c == '\n')
 551         return 1;
 552
 553       c = getc (stream);
 554       if (c == EOF)
 555         return 1;
 556     }
 557 }
 558
 559 /* Reads a line from STREAM into ST, then preprocesses as follows:
 560
 561    - Splices lines terminated with `\'.
 562
 563    - Deletes comments introduced by `#' outside of single or double
 564      quotes.
 565
 566    - Trailing whitespace will be deleted.
 567
 568    Increments cust_ln as appropriate.
 569
 570    Returns nonzero only if a line was successfully read. */
 571 int
 572 ds_get_config_line (FILE *stream, struct string *st, struct file_locator *where)
 573 {
 574   /* Read the first line. */
 575   ds_clear (st);
 576   where->line_number++;
 577   if (!ds_gets (st, stream))
 578     return 0;
 579
 580   /* Read additional lines, if any. */
 581   for (;;)
 582     {
 583       /* Remove trailing whitespace. */
 584       {
 585         char *s = ds_c_str (st);
 586         size_t len = ds_length (st);
 587
 588         while (len > 0 && isspace ((unsigned char) s[len - 1]))
 589           len--;
 590         ds_truncate (st, len);
 591       }
 592
 593       /* Check for trailing \.  Remove if found, bail otherwise. */
 594       if (ds_length (st) == 0 || ds_c_str (st)[ds_length (st) - 1] != '\\')
 595         break;
 596       ds_truncate (st, ds_length (st) - 1);
 597
 598       /* Append another line and go around again. */
 599       {
 600         int success = ds_gets (st, stream);
 601         where->line_number++;
 602         if (!success)
 603           return 1;
 604       }
 605     }
 606
 607   /* Find a comment and remove. */
 608   {
 609     char *cp;
 610     int quote = 0;
 611
 612     for (cp = ds_c_str (st); *cp; cp++)
 613       if (quote)
 614         {
 615           if (*cp == quote)
 616             quote = 0;
 617           else if (*cp == '\\')
 618             cp++;
 619         }
 620       else if (*cp == '\'' || *cp == '"')
 621         quote = *cp;
 622       else if (*cp == '#')
 623         {
 624           ds_truncate (st, cp - ds_c_str (st));
 625           break;
 626         }
 627   }
 628
 629   return 1;
 630 }
 631 \f
 632 /* Lengthed strings. */
 633
 634 /* Creates a new lengthed string LS with contents as a copy of
 635    S. */
 636 void
 637 ls_create (struct fixed_string *ls, const char *s)
 638 {
 639   ls->length = strlen (s);
 640   ls->string = xmalloc (ls->length + 1);
 641   memcpy (ls->string, s, ls->length + 1);
 642 }
 643
 644 /* Creates a new lengthed string LS with contents as a copy of
 645    BUFFER with length LEN. */
 646 void
 647 ls_create_buffer (struct fixed_string *ls,
 648                   const char *buffer, size_t len)
 649 {
 650   ls->length = len;
 651   ls->string = xmalloc (len + 1);
 652   memcpy (ls->string, buffer, len);
 653   ls->string[len] = '\0';
 654 }
 655
 656 /* Sets the fields of LS to the specified values. */
 657 void
 658 ls_init (struct fixed_string *ls, const char *string, size_t length)
 659 {
 660   ls->string = (char *) string;
 661   ls->length = length;
 662 }
 663
 664 /* Copies the fields of SRC to DST. */
 665 void
 666 ls_shallow_copy (struct fixed_string *dst, const struct fixed_string *src)
 667 {
 668   *dst = *src;
 669 }
 670
 671 /* Frees the memory backing LS. */
 672 void
 673 ls_destroy (struct fixed_string *ls)
 674 {
 675   free (ls->string);
 676 }
 677
 678 /* Sets LS to a null pointer value. */
 679 void
 680 ls_null (struct fixed_string *ls)
 681 {
 682   ls->string = NULL;
 683 }
 684
 685 /* Returns nonzero only if LS has a null pointer value. */
 686 int
 687 ls_null_p (const struct fixed_string *ls)
 688 {
 689   return ls->string == NULL;
 690 }
 691
 692 /* Returns nonzero only if LS is a null pointer or has length 0. */
 693 int
 694 ls_empty_p (const struct fixed_string *ls)
 695 {
 696   return ls->string == NULL || ls->length == 0;
 697 }
 698
 699 /* Returns the length of LS, which must not be null. */
 700 size_t
 701 ls_length (const struct fixed_string *ls)
 702 {
 703   return ls->length;
 704 }
 705
 706 /* Returns a pointer to the character string in LS. */
 707 char *
 708 ls_c_str (const struct fixed_string *ls)
 709 {
 710   return (char *) ls->string;
 711 }
 712
 713 /* Returns a pointer to the null terminator of the character string in
 714    LS. */
 715 char *
 716 ls_end (const struct fixed_string *ls)
 717 {
 718   return (char *) (ls->string + ls->length);
 719 }