string.c

   1 /*
   2  * Copyright (C) 2004-2013 Andre Noll <maan@systemlinux.org>
   3  *
   4  * Licensed under the GPL v2. For licencing details see COPYING.
   5  */
   6
   7 /** \file string.c Memory allocation and string handling functions. */
   8
   9 #include <sys/time.h> /* gettimeofday */
  10 #include <pwd.h>
  11 #include <sys/utsname.h> /* uname() */
  12 #include <string.h>
  13 #include <regex.h>
  14
  15 #include "para.h"
  16 #include "string.h"
  17 #include "error.h"
  18
  19 /**
  20  * Paraslash's version of realloc().
  21  *
  22  * \param p Pointer to the memory block, may be \p NULL.
  23  * \param size The desired new size.
  24  *
  25  * A wrapper for realloc(3). It calls \p exit(\p EXIT_FAILURE) on errors,
  26  * i.e. there is no need to check the return value in the caller.
  27  *
  28  * \return A pointer to  the newly allocated memory, which is suitably aligned
  29  * for any kind of variable and may be different from \a p.
  30  *
  31  * \sa realloc(3).
  32  */
  33 __must_check __malloc void *para_realloc(void *p, size_t size)
  34 {
  35         /*
  36          * No need to check for NULL pointers: If p is NULL, the call
  37          * to realloc is equivalent to malloc(size)
  38          */
  39         assert(size);
  40         if (!(p = realloc(p, size))) {
  41                 PARA_EMERG_LOG("realloc failed (size = %zu), aborting\n",
  42                         size);
  43                 exit(EXIT_FAILURE);
  44         }
  45         return p;
  46 }
  47
  48 /**
  49  * Paraslash's version of malloc().
  50  *
  51  * \param size The desired new size.
  52  *
  53  * A wrapper for malloc(3) which exits on errors.
  54  *
  55  * \return A pointer to the allocated memory, which is suitably aligned for any
  56  * kind of variable.
  57  *
  58  * \sa malloc(3).
  59  */
  60 __must_check __malloc void *para_malloc(size_t size)
  61 {
  62         void *p;
  63
  64         assert(size);
  65         p = malloc(size);
  66         if (!p) {
  67                 PARA_EMERG_LOG("malloc failed (size = %zu), aborting\n",
  68                         size);
  69                 exit(EXIT_FAILURE);
  70         }
  71         return p;
  72 }
  73
  74 /**
  75  * Paraslash's version of calloc().
  76  *
  77  * \param size The desired new size.
  78  *
  79  * A wrapper for calloc(3) which exits on errors.
  80  *
  81  * \return A pointer to the allocated and zeroed-out memory, which is suitably
  82  * aligned for any kind of variable.
  83  *
  84  * \sa calloc(3)
  85  */
  86 __must_check __malloc void *para_calloc(size_t size)
  87 {
  88         void *ret = para_malloc(size);
  89
  90         memset(ret, 0, size);
  91         return ret;
  92 }
  93
  94 /**
  95  * Paraslash's version of strdup().
  96  *
  97  * \param s The string to be duplicated.
  98  *
  99  * A wrapper for strdup(3). It calls \p exit(EXIT_FAILURE) on errors, i.e.
 100  * there is no need to check the return value in the caller.
 101  *
 102  * \return A pointer to the duplicated string. If \a s was the \p NULL pointer,
 103  * an pointer to an empty string is returned.
 104  *
 105  * \sa strdup(3)
 106  */
 107 __must_check __malloc char *para_strdup(const char *s)
 108 {
 109         char *ret;
 110
 111         if ((ret = strdup(s? s: "")))
 112                 return ret;
 113         PARA_EMERG_LOG("strdup failed, aborting\n");
 114         exit(EXIT_FAILURE);
 115 }
 116
 117 /**
 118  * Print a formated message to a dynamically allocated string.
 119  *
 120  * \param result The formated string is returned here.
 121  * \param fmt The format string.
 122  * \param ap Initialized list of arguments.
 123  *
 124  * This function is similar to vasprintf(), a GNU extension which is not in C
 125  * or POSIX. It allocates a string large enough to hold the output including
 126  * the terminating null byte. The allocated string is returned via the first
 127  * argument and must be freed by the caller. However, unlike vasprintf(), this
 128  * function calls exit() if insufficient memory is available, while vasprintf()
 129  * returns -1 in this case.
 130  *
 131  * \return Number of bytes written, not including the terminating \p NULL
 132  * character.
 133  *
 134  * \sa printf(3), vsnprintf(3), va_start(3), vasprintf(3), \ref xasprintf().
 135  */
 136 __printf_2_0 unsigned xvasprintf(char **result, const char *fmt, va_list ap)
 137 {
 138         int ret;
 139         size_t size;
 140         va_list aq;
 141
 142         va_copy(aq, ap);
 143         ret = vsnprintf(NULL, 0, fmt, aq);
 144         va_end(aq);
 145         assert(ret >= 0);
 146         size = ret + 1;
 147         *result = para_malloc(size);
 148         va_copy(aq, ap);
 149         ret = vsnprintf(*result, size, fmt, aq);
 150         va_end(aq);
 151         assert(ret >= 0 && ret < size);
 152         return ret;
 153 }
 154
 155 /**
 156  * Print to a dynamically allocated string, variable number of arguments.
 157  *
 158  * \param result See \ref xvasprintf().
 159  * \param fmt Usual format string.
 160  *
 161  * \return The return value of the underlying call to \ref xvasprintf().
 162  *
 163  * \sa \ref xvasprintf() and the references mentioned there.
 164  */
 165 __printf_2_3 unsigned xasprintf(char **result, const char *fmt, ...)
 166 {
 167         va_list ap;
 168         unsigned ret;
 169
 170         va_start(ap, fmt);
 171         ret = xvasprintf(result, fmt, ap);
 172         va_end(ap);
 173         return ret;
 174 }
 175
 176 /**
 177  * Allocate a sufficiently large string and print into it.
 178  *
 179  * \param fmt A usual format string.
 180  *
 181  * Produce output according to \p fmt. No artificial bound on the length of the
 182  * resulting string is imposed.
 183  *
 184  * \return This function either returns a pointer to a string that must be
 185  * freed by the caller or aborts without returning.
 186  *
 187  * \sa printf(3), xasprintf().
 188  */
 189 __must_check __printf_1_2 __malloc char *make_message(const char *fmt, ...)
 190 {
 191         char *msg;
 192         va_list ap;
 193
 194         va_start(ap, fmt);
 195         xvasprintf(&msg, fmt, ap);
 196         va_end(ap);
 197         return msg;
 198 }
 199
 200 /**
 201  * Free the content of a pointer and set it to \p NULL.
 202  *
 203  * This is equivalent to "free(*arg); *arg = NULL;".
 204  *
 205  * \param arg The pointer whose content should be freed.
 206  */
 207 void freep(void *arg)
 208 {
 209         void **ptr = (void **)arg;
 210         free(*ptr);
 211         *ptr = NULL;
 212 }
 213
 214 /**
 215  * Paraslash's version of strcat().
 216  *
 217  * \param a String to be appended to.
 218  * \param b String to append.
 219  *
 220  * Append \p b to \p a.
 221  *
 222  * \return If \a a is \p NULL, return a pointer to a copy of \a b, i.e.
 223  * para_strcat(NULL, b) is equivalent to para_strdup(b). If \a b is \p NULL,
 224  * return \a a without making a copy of \a a.  Otherwise, construct the
 225  * concatenation \a c, free \a a (but not \a b) and return \a c.
 226  *
 227  * \sa strcat(3)
 228  */
 229 __must_check __malloc char *para_strcat(char *a, const char *b)
 230 {
 231         char *tmp;
 232
 233         if (!a)
 234                 return para_strdup(b);
 235         if (!b)
 236                 return a;
 237         tmp = make_message("%s%s", a, b);
 238         free(a);
 239         return tmp;
 240 }
 241
 242 /**
 243  * Paraslash's version of dirname().
 244  *
 245  * \param name Pointer to the full path.
 246  *
 247  * Compute the directory component of \p name.
 248  *
 249  * \return If \a name is \p NULL or the empty string, return \p NULL.
 250  * Otherwise, Make a copy of \a name and return its directory component. Caller
 251  * is responsible to free the result.
 252  */
 253 __must_check __malloc char *para_dirname(const char *name)
 254 {
 255         char *p, *ret;
 256
 257         if (!name || !*name)
 258                 return NULL;
 259         ret = para_strdup(name);
 260         p = strrchr(ret, '/');
 261         if (!p)
 262                 *ret = '\0';
 263         else
 264                 *p = '\0';
 265         return ret;
 266 }
 267
 268 /**
 269  * Paraslash's version of basename().
 270  *
 271  * \param name Pointer to the full path.
 272  *
 273  * Compute the filename component of \a name.
 274  *
 275  * \return \p NULL if (a) \a name is the empty string or \p NULL, or (b) name
 276  * ends with a slash.  Otherwise, a pointer within \a name is returned.  Caller
 277  * must not free the result.
 278  */
 279 __must_check char *para_basename(const char *name)
 280 {
 281         char *ret;
 282
 283         if (!name || !*name)
 284                 return NULL;
 285         ret = strrchr(name, '/');
 286         if (!ret)
 287                 return (char *)name;
 288         ret++;
 289         return ret;
 290 }
 291
 292 /**
 293  * Cut trailing newline.
 294  *
 295  * \param buf The string to be chopped.
 296  *
 297  * Replace the last character in \p buf by zero if it is equal to
 298  * the newline character.
 299  */
 300 void chop(char *buf)
 301 {
 302         int n = strlen(buf);
 303
 304         if (!n)
 305                 return;
 306         if (buf[n - 1] == '\n')
 307                 buf[n - 1] = '\0';
 308 }
 309
 310 /**
 311  * Get the logname of the current user.
 312  *
 313  * \return A dynamically allocated string that must be freed by the caller. On
 314  * errors, the string "unknown_user" is returned, i.e. this function never
 315  * returns \p NULL.
 316  *
 317  * \sa getpwuid(3).
 318  */
 319 __must_check __malloc char *para_logname(void)
 320 {
 321         struct passwd *pw = getpwuid(getuid());
 322         return para_strdup(pw? pw->pw_name : "unknown_user");
 323 }
 324
 325 /**
 326  * Get the home directory of the current user.
 327  *
 328  * \return A dynamically allocated string that must be freed by the caller. If
 329  * the home directory could not be found, this function returns "/tmp".
 330  */
 331 __must_check __malloc char *para_homedir(void)
 332 {
 333         struct passwd *pw = getpwuid(getuid());
 334         return para_strdup(pw? pw->pw_dir : "/tmp");
 335 }
 336
 337 /**
 338  * Get the own hostname.
 339  *
 340  * \return A dynamically allocated string containing the hostname.
 341  *
 342  * \sa uname(2).
 343  */
 344 __malloc char *para_hostname(void)
 345 {
 346         struct utsname u;
 347
 348         uname(&u);
 349         return para_strdup(u.nodename);
 350 }
 351
 352 /**
 353  * Controls behavior of for_each_complete_line().
 354  *
 355  * \sa for_each_line(), for_each_line_ro().
 356  */
 357 enum for_each_line_flags {
 358         /** Activate read-only mode. */
 359         FELF_READ_ONLY = 1 << 0,
 360 };
 361
 362 static int for_each_complete_line(unsigned flags, char *buf,
 363                 size_t size, line_handler_t *line_handler, void *private_data)
 364 {
 365         char *start = buf, *end;
 366         int ret, i, num_lines = 0;
 367
 368 //      PARA_NOTICE_LOG("buf: %s\n", buf);
 369         while (start < buf + size) {
 370                 char *next_null;
 371                 char *next_cr;
 372
 373                 next_cr = memchr(start, '\n', buf + size - start);
 374                 next_null = memchr(start, '\0', buf + size - start);
 375                 if (!next_cr && !next_null)
 376                         break;
 377                 if (next_cr && next_null) {
 378                         end = next_cr < next_null? next_cr : next_null;
 379                 } else if (next_null) {
 380                         end = next_null;
 381                 } else
 382                         end = next_cr;
 383                 num_lines++;
 384                 if (!line_handler) {
 385                         start = ++end;
 386                         continue;
 387                 }
 388                 if (flags & FELF_READ_ONLY) {
 389                         size_t s = end - start;
 390                         char *b = para_malloc(s + 1);
 391                         memcpy(b, start, s);
 392                         b[s] = '\0';
 393 //                      PARA_NOTICE_LOG("b: %s, start: %s\n", b, start);
 394                         ret = line_handler(b, private_data);
 395                         free(b);
 396                 } else {
 397                         *end = '\0';
 398                         ret = line_handler(start, private_data);
 399                 }
 400                 if (ret < 0)
 401                         return ret;
 402                 start = ++end;
 403         }
 404         if (!line_handler || (flags & FELF_READ_ONLY))
 405                 return num_lines;
 406         i = buf + size - start;
 407         if (i && i != size)
 408                 memmove(buf, start, i);
 409         return i;
 410 }
 411
 412 /**
 413  * Call a custom function for each complete line.
 414  *
 415  * \param buf The buffer containing data separated by newlines.
 416  * \param size The number of bytes in \a buf.
 417  * \param line_handler The custom function.
 418  * \param private_data Pointer passed to \a line_handler.
 419  *
 420  * If \p line_handler is \p NULL, the function returns the number of complete
 421  * lines in \p buf.  Otherwise, \p line_handler is called for each complete
 422  * line in \p buf.  The first argument to \p line_handler is the current line,
 423  * and \p private_data is passed as the second argument.  The function returns
 424  * if \p line_handler returns a negative value or no more lines are in the
 425  * buffer.  The rest of the buffer (last chunk containing an incomplete line)
 426  * is moved to the beginning of the buffer.
 427  *
 428  * \return If \p line_handler is not \p NULL, this function returns the number
 429  * of bytes not handled to \p line_handler on success, or the negative return
 430  * value of the \p line_handler on errors.
 431  *
 432  * \sa for_each_line_ro().
 433  */
 434 int for_each_line(char *buf, size_t size, line_handler_t *line_handler,
 435                 void *private_data)
 436 {
 437         return for_each_complete_line(0, buf, size, line_handler, private_data);
 438 }
 439
 440 /**
 441  * Call a custom function for each complete line.
 442  *
 443  * \param buf Same meaning as in \p for_each_line().
 444  * \param size Same meaning as in \p for_each_line().
 445  * \param line_handler Same meaning as in \p for_each_line().
 446  * \param private_data Same meaning as in \p for_each_line().
 447  *
 448  * This function behaves like \p for_each_line(), but \a buf is left unchanged.
 449  *
 450  * \return On success, the function returns the number of complete lines in \p
 451  * buf, otherwise the (negative) return value of \p line_handler is returned.
 452  *
 453  * \sa for_each_line().
 454  */
 455 int for_each_line_ro(char *buf, size_t size, line_handler_t *line_handler,
 456                 void *private_data)
 457 {
 458         return for_each_complete_line(FELF_READ_ONLY, buf, size, line_handler,
 459                 private_data);
 460 }
 461
 462 /** Return the hex characters of the lower 4 bits. */
 463 #define hex(a) (hexchar[(a) & 15])
 464
 465 static void write_size_header(char *buf, int n)
 466 {
 467         static char hexchar[] = "0123456789abcdef";
 468
 469         buf[0] = hex(n >> 12);
 470         buf[1] = hex(n >> 8);
 471         buf[2] = hex(n >> 4);
 472         buf[3] = hex(n);
 473         buf[4] = ' ';
 474 }
 475
 476 /**
 477  * Read a four-byte hex-number and return its value.
 478  *
 479  * Each status item sent by para_server is prefixed with such a hex number in
 480  * ASCII which describes the size of the status item.
 481  *
 482  * \param buf The buffer which must be at least four bytes long.
 483  *
 484  * \return The value of the hex number on success, \p -E_SIZE_PREFIX if the
 485  * buffer did not contain only hex digits.
 486  */
 487 int read_size_header(const char *buf)
 488 {
 489         int i, len = 0;
 490
 491         for (i = 0; i < 4; i++) {
 492                 unsigned char c = buf[i];
 493                 len <<= 4;
 494                 if (c >= '0' && c <= '9') {
 495                         len += c - '0';
 496                         continue;
 497                 }
 498                 if (c >= 'a' && c <= 'f') {
 499                         len += c - 'a' + 10;
 500                         continue;
 501                 }
 502                 return -E_SIZE_PREFIX;
 503         }
 504         if (buf[4] != ' ')
 505                 return -E_SIZE_PREFIX;
 506         return len;
 507 }
 508
 509 /**
 510  * Safely print into a buffer at a given offset.
 511  *
 512  * \param b Determines the buffer, its size, and the offset.
 513  * \param fmt The format string.
 514  *
 515  * This function prints into the buffer given by \a b at the offset which is
 516  * also given by \a b. If there is not enough space to hold the result, the
 517  * buffer size is doubled until the underlying call to vsnprintf() succeeds
 518  * or the size of the buffer exceeds the maximal size specified in \a b.
 519  *
 520  * In the latter case the unmodified \a buf and \a offset values as well as the
 521  * private_data pointer of \a b are passed to the \a max_size_handler of \a b.
 522  * If this function succeeds, i.e. returns a non-negative value, the offset of
 523  * \a b is reset to zero and the given data is written to the beginning of the
 524  * buffer. If \a max_size_handler() returns a negative value, this value is
 525  * returned by \a para_printf().
 526  *
 527  * Upon return, the offset of \a b is adjusted accordingly so that subsequent
 528  * calls to this function append data to what is already contained in the
 529  * buffer.
 530  *
 531  * It's OK to call this function with \p b->buf being \p NULL. In this case, an
 532  * initial buffer is allocated.
 533  *
 534  * \return The number of bytes printed into the buffer (not including the
 535  * terminating \p NULL byte) on success, negative on errors. If there is no
 536  * size-bound on \a b, i.e. if \p b->max_size is zero, this function never
 537  * fails.
 538  *
 539  * \sa make_message(), vsnprintf(3).
 540  */
 541 __printf_2_3 int para_printf(struct para_buffer *b, const char *fmt, ...)
 542 {
 543         int ret, sz_off = (b->flags & PBF_SIZE_PREFIX)? 5 : 0;
 544
 545         if (!b->buf) {
 546                 b->buf = para_malloc(128);
 547                 b->size = 128;
 548                 b->offset = 0;
 549         }
 550         while (1) {
 551                 char *p = b->buf + b->offset;
 552                 size_t size = b->size - b->offset;
 553                 va_list ap;
 554
 555                 if (size > sz_off) {
 556                         va_start(ap, fmt);
 557                         ret = vsnprintf(p + sz_off, size - sz_off, fmt, ap);
 558                         va_end(ap);
 559                         if (ret > -1 && ret < size - sz_off) { /* success */
 560                                 b->offset += ret + sz_off;
 561                                 if (sz_off)
 562                                         write_size_header(p, ret);
 563                                 return ret + sz_off;
 564                         }
 565                 }
 566                 /* check if we may grow the buffer */
 567                 if (!b->max_size || 2 * b->size < b->max_size) { /* yes */
 568                         /* try again with more space */
 569                         b->size *= 2;
 570                         b->buf = para_realloc(b->buf, b->size);
 571                         continue;
 572                 }
 573                 /* can't grow buffer */
 574                 if (!b->offset || !b->max_size_handler) /* message too large */
 575                         return -ERRNO_TO_PARA_ERROR(ENOSPC);
 576                 ret = b->max_size_handler(b->buf, b->offset, b->private_data);
 577                 if (ret < 0)
 578                         return ret;
 579                 b->offset = 0;
 580         }
 581 }
 582
 583 /** \cond llong_minmax */
 584 /* LLONG_MAX and LLONG_MIN might not be defined. */
 585 #ifndef LLONG_MAX
 586 #define LLONG_MAX 9223372036854775807LL
 587 #endif
 588 #ifndef LLONG_MIN
 589 #define LLONG_MIN (-LLONG_MAX - 1LL)
 590 #endif
 591 /** \endcond llong_minmax */
 592
 593 /**
 594  * Convert a string to a 64-bit signed integer value.
 595  *
 596  * \param str The string to be converted.
 597  * \param value Result pointer.
 598  *
 599  * \return Standard.
 600  *
 601  * \sa para_atoi32(), strtol(3), atoi(3).
 602  */
 603 int para_atoi64(const char *str, int64_t *value)
 604 {
 605         char *endptr;
 606         long long tmp;
 607
 608         errno = 0; /* To distinguish success/failure after call */
 609         tmp = strtoll(str, &endptr, 10);
 610         if (errno == ERANGE && (tmp == LLONG_MAX || tmp == LLONG_MIN))
 611                 return -E_ATOI_OVERFLOW;
 612         if (errno != 0 && tmp == 0) /* other error */
 613                 return -E_STRTOLL;
 614         if (endptr == str)
 615                 return -E_ATOI_NO_DIGITS;
 616         if (*endptr != '\0') /* Further characters after number */
 617                 return -E_ATOI_JUNK_AT_END;
 618         *value = tmp;
 619         return 1;
 620 }
 621
 622 /**
 623  * Convert a string to a 32-bit signed integer value.
 624  *
 625  * \param str The string to be converted.
 626  * \param value Result pointer.
 627  *
 628  * \return Standard.
 629  *
 630  * \sa para_atoi64().
 631 */
 632 int para_atoi32(const char *str, int32_t *value)
 633 {
 634         int64_t tmp;
 635         int ret;
 636         const int32_t max = 2147483647;
 637
 638         ret = para_atoi64(str, &tmp);
 639         if (ret < 0)
 640                 return ret;
 641         if (tmp > max || tmp < -max - 1)
 642                 return -E_ATOI_OVERFLOW;
 643         *value = tmp;
 644         return 1;
 645 }
 646
 647 static inline int loglevel_equal(const char *arg, const char * const ll)
 648 {
 649         return !strncasecmp(arg, ll, strlen(ll));
 650 }
 651
 652 /**
 653  * Compute the loglevel number from its name.
 654  *
 655  * \param txt The name of the loglevel (debug, info, ...).
 656  *
 657  * \return The numeric representation of the loglevel name.
 658  */
 659 int get_loglevel_by_name(const char *txt)
 660 {
 661         if (loglevel_equal(txt, "debug"))
 662                 return LL_DEBUG;
 663         if (loglevel_equal(txt, "info"))
 664                 return LL_INFO;
 665         if (loglevel_equal(txt, "notice"))
 666                 return LL_NOTICE;
 667         if (loglevel_equal(txt, "warning"))
 668                 return LL_WARNING;
 669         if (loglevel_equal(txt, "error"))
 670                 return LL_ERROR;
 671         if (loglevel_equal(txt, "crit"))
 672                 return LL_CRIT;
 673         if (loglevel_equal(txt, "emerg"))
 674                 return LL_EMERG;
 675         return -1;
 676 }
 677
 678 static int get_next_word(const char *buf, const char *delim, char **word)
 679 {
 680         enum line_state_flags {LSF_HAVE_WORD = 1, LSF_BACKSLASH = 2,
 681                 LSF_SINGLE_QUOTE = 4, LSF_DOUBLE_QUOTE = 8};
 682         const char *in;
 683         char *out;
 684         int ret, state = 0;
 685
 686         out = para_malloc(strlen(buf) + 1);
 687         *out = '\0';
 688         *word = out;
 689         for (in = buf; *in; in++) {
 690                 const char *p;
 691
 692                 switch (*in) {
 693                 case '\\':
 694                         if (state & LSF_BACKSLASH) /* \\ */
 695                                 goto copy_char;
 696                         state |= LSF_BACKSLASH;
 697                         state |= LSF_HAVE_WORD;
 698                         continue;
 699                 case 'n':
 700                 case 't':
 701                         if (state & LSF_BACKSLASH) { /* \n or \t */
 702                                 *out++ = (*in == 'n')? '\n' : '\t';
 703                                 state &= ~LSF_BACKSLASH;
 704                                 continue;
 705                         }
 706                         goto copy_char;
 707                 case '"':
 708                         if (state & LSF_BACKSLASH) /* \" */
 709                                 goto copy_char;
 710                         if (state & LSF_SINGLE_QUOTE) /* '" */
 711                                 goto copy_char;
 712                         if (state & LSF_DOUBLE_QUOTE) {
 713                                 state &= ~LSF_DOUBLE_QUOTE;
 714                                 continue;
 715                         }
 716                         state |= LSF_HAVE_WORD;
 717                         state |= LSF_DOUBLE_QUOTE;
 718                         continue;
 719                 case '\'':
 720                         if (state & LSF_BACKSLASH) /* \' */
 721                                 goto copy_char;
 722                         if (state & LSF_DOUBLE_QUOTE) /* "' */
 723                                 goto copy_char;
 724                         if (state & LSF_SINGLE_QUOTE) {
 725                                 state &= ~LSF_SINGLE_QUOTE;
 726                                 continue;
 727                         }
 728                         state |= LSF_HAVE_WORD;
 729                         state |= LSF_SINGLE_QUOTE;
 730                         continue;
 731                 }
 732                 for (p = delim; *p; p++) {
 733                         if (*in != *p)
 734                                 continue;
 735                         if (state & LSF_BACKSLASH)
 736                                 goto copy_char;
 737                         if (state & LSF_SINGLE_QUOTE)
 738                                 goto copy_char;
 739                         if (state & LSF_DOUBLE_QUOTE)
 740                                 goto copy_char;
 741                         if (state & LSF_HAVE_WORD)
 742                                 goto success;
 743                         break;
 744                 }
 745                 if (*p) /* ignore delimiter at the beginning */
 746                         continue;
 747 copy_char:
 748                 state |= LSF_HAVE_WORD;
 749                 *out++ = *in;
 750                 state &= ~LSF_BACKSLASH;
 751         }
 752         ret = 0;
 753         if (!(state & LSF_HAVE_WORD))
 754                 goto out;
 755         ret = -ERRNO_TO_PARA_ERROR(EINVAL);
 756         if (state & LSF_BACKSLASH) {
 757                 PARA_ERROR_LOG("trailing backslash\n");
 758                 goto out;
 759         }
 760         if ((state & LSF_SINGLE_QUOTE) || (state & LSF_DOUBLE_QUOTE)) {
 761                 PARA_ERROR_LOG("unmatched quote character\n");
 762                 goto out;
 763         }
 764 success:
 765         *out = '\0';
 766         return in - buf;
 767 out:
 768         free(*word);
 769         *word = NULL;
 770         return ret;
 771 }
 772
 773 /**
 774  * Get the number of the word the cursor is on.
 775  *
 776  * \param buf The zero-terminated line buffer.
 777  * \param delim Characters that separate words.
 778  * \param point The cursor position.
 779  *
 780  * \return Zero-based word number.
 781  */
 782 int compute_word_num(const char *buf, const char *delim, int point)
 783 {
 784         int ret, num_words;
 785         const char *p;
 786         char *word;
 787
 788         for (p = buf, num_words = 0; ; p += ret, num_words++) {
 789                 ret = get_next_word(p, delim, &word);
 790                 if (ret <= 0)
 791                         break;
 792                 free(word);
 793                 if (p + ret >= buf + point)
 794                         break;
 795         }
 796         return num_words;
 797 }
 798
 799 /**
 800  * Free an array of words created by create_argv() or create_shifted_argv().
 801  *
 802  * \param argv A pointer previously obtained by \ref create_argv().
 803  */
 804 void free_argv(char **argv)
 805 {
 806         int i;
 807
 808         if (!argv)
 809                 return;
 810         for (i = 0; argv[i]; i++)
 811                 free(argv[i]);
 812         free(argv);
 813 }
 814
 815 static int create_argv_offset(int offset, const char *buf, const char *delim,
 816                 char ***result)
 817 {
 818         char *word, **argv = para_malloc((offset + 1) * sizeof(char *));
 819         const char *p;
 820         int i, ret;
 821
 822         for (i = 0; i < offset; i++)
 823                 argv[i] = NULL;
 824         for (p = buf; p && *p; p += ret, i++) {
 825                 ret = get_next_word(p, delim, &word);
 826                 if (ret < 0)
 827                         goto err;
 828                 if (!ret)
 829                         break;
 830                 argv = para_realloc(argv, (i + 2) * sizeof(char*));
 831                 argv[i] = word;
 832         }
 833         argv[i] = NULL;
 834         *result = argv;
 835         return i;
 836 err:
 837         while (i > 0)
 838                 free(argv[--i]);
 839         free(argv);
 840         *result = NULL;
 841         return ret;
 842 }
 843
 844 /**
 845  * Split a buffer into words.
 846  *
 847  * This parser honors single and double quotes, backslash-escaped characters
 848  * and special characters like \p \\n. The result contains pointers to copies
 849  * of the words contained in \a buf and has to be freed by using \ref
 850  * free_argv().
 851  *
 852  * \param buf The buffer to be split.
 853  * \param delim Each character in this string is treated as a separator.
 854  * \param result The array of words is returned here.
 855  *
 856  * \return Number of words in \a buf, negative on errors.
 857  */
 858 int create_argv(const char *buf, const char *delim, char ***result)
 859 {
 860         return create_argv_offset(0, buf, delim, result);
 861 }
 862
 863 /**
 864  * Split a buffer into words, offset one.
 865  *
 866  * This is similar to \ref create_argv() but the returned array is one element
 867  * larger, words start at index one and element zero is initialized to \p NULL.
 868  * Callers must set element zero to a non-NULL value before calling free_argv()
 869  * on the returned array to avoid a memory leak.
 870  *
 871  * \param buf See \ref create_argv().
 872  * \param delim See \ref create_argv().
 873  * \param result See \ref create_argv().
 874  *
 875  * \return Number of words plus one on success, negative on errors.
 876  */
 877 int create_shifted_argv(const char *buf, const char *delim, char ***result)
 878 {
 879         return create_argv_offset(1, buf, delim, result);
 880 }
 881
 882 /**
 883  * Find out if the given string is contained in the arg vector.
 884  *
 885  * \param arg The string to look for.
 886  * \param argv The array to search.
 887  *
 888  * \return The first index whose value equals \a arg, or \p -E_ARG_NOT_FOUND if
 889  * arg was not found in \a argv.
 890  */
 891 int find_arg(const char *arg, char **argv)
 892 {
 893         int i;
 894
 895         if (!argv)
 896                 return -E_ARG_NOT_FOUND;
 897         for (i = 0; argv[i]; i++)
 898                 if (strcmp(arg, argv[i]) == 0)
 899                         return i;
 900         return -E_ARG_NOT_FOUND;
 901 }
 902
 903 /**
 904  * Compile a regular expression.
 905  *
 906  * This simple wrapper calls regcomp() and logs a message on errors.
 907  *
 908  * \param preg See regcomp(3).
 909  * \param regex See regcomp(3).
 910  * \param cflags See regcomp(3).
 911  *
 912  * \return Standard.
 913  */
 914 int para_regcomp(regex_t *preg, const char *regex, int cflags)
 915 {
 916         char *buf;
 917         size_t size;
 918         int ret = regcomp(preg, regex, cflags);
 919
 920         if (ret == 0)
 921                 return 1;
 922         size = regerror(ret, preg, NULL, 0);
 923         buf = para_malloc(size);
 924         regerror(ret, preg, buf, size);
 925         PARA_ERROR_LOG("%s\n", buf);
 926         free(buf);
 927         return -E_REGEX;
 928 }
 929
 930 /**
 931  * strdup() for not necessarily zero-terminated strings.
 932  *
 933  * \param src The source buffer.
 934  * \param len The number of bytes to be copied.
 935  *
 936  * \return A 0-terminated buffer of length \a len + 1.
 937  *
 938  * This is similar to strndup(), which is a GNU extension. However, one
 939  * difference is that strndup() returns \p NULL if insufficient memory was
 940  * available while this function aborts in this case.
 941  *
 942  * \sa strdup(), \ref para_strdup().
 943  */
 944 char *safe_strdup(const char *src, size_t len)
 945 {
 946         char *p;
 947
 948         assert(len < (size_t)-1);
 949         p = para_malloc(len + 1);
 950         if (len > 0)
 951                 memcpy(p, src, len);
 952         p[len] = '\0';
 953         return p;
 954 }
 955
 956 /**
 957  * Copy the value of a key=value pair.
 958  *
 959  * This checks whether the given buffer starts with "key=", ignoring case. If
 960  * yes, a copy of the value is returned. The source buffer may not be
 961  * zero-terminated.
 962  *
 963  * \param src The source buffer.
 964  * \param len The number of bytes of the tag.
 965  * \param key Only copy if it is the value of this key.
 966  *
 967  * \return A zero-terminated buffer, or \p NULL if the key was
 968  * not of the given type.
 969  */
 970 char *key_value_copy(const char *src, size_t len, const char *key)
 971 {
 972         int keylen = strlen(key);
 973
 974         if (len <= keylen)
 975                 return NULL;
 976         if (strncasecmp(src, key, keylen))
 977                 return NULL;
 978         if (src[keylen] != '=')
 979                 return NULL;
 980         return safe_strdup(src + keylen + 1, len - keylen - 1);
 981 }