src/lib/eina_str.c

   1 /*
   2  * vim:ts=8:sw=3:sts=8:noexpandtab:cino=>5n-3f0^-2{2
   3  */
   4 /* Leave the OpenBSD version below so we can track upstream fixes */
   5 /*      $OpenBSD: strlcpy.c,v 1.11 2006/05/05 15:27:38 millert Exp $        */
   6
   7 /*
   8  * Copyright (c) 1998 Todd C. Miller <Todd.Miller@courtesan.com>
   9  *
  10  * Permission to use, copy, modify, and distribute this software for any
  11  * purpose with or without fee is hereby granted, provided that the above
  12  * copyright notice and this permission notice appear in all copies.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  15  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  16  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  17  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  18  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  19  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  20  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  21  */
  22
  23 /*
  24  * vim:ts=8:sw=3:sts=8:noexpandtab:cino=>5n-3f0^-2{2
  25  */
  26
  27 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30
  31 #include <stdio.h>
  32 #include <stdlib.h>
  33 #include <string.h>
  34 #include <limits.h>
  35
  36 #ifdef HAVE_ICONV
  37 # include <errno.h>
  38 # include <iconv.h>
  39 #endif
  40
  41 #include "eina_private.h"
  42 #include "eina_str.h"
  43
  44 /*============================================================================*
  45  *                                  Local                                     *
  46  *============================================================================*/
  47
  48 /**
  49  * @cond LOCAL
  50  */
  51
  52 /*
  53  * Internal helper function used by eina_str_has_suffix() and
  54  * eina_str_has_extension()
  55  */
  56 static inline Eina_Bool
  57 eina_str_has_suffix_helper(const char *str,
  58                            const char *suffix,
  59                            int (*cmp)(const char *, const char *))
  60 {
  61    size_t str_len;
  62    size_t suffix_len;
  63
  64    str_len = strlen(str);
  65    suffix_len = eina_strlen_bounded(suffix, str_len);
  66    if (suffix_len == (size_t)-1)
  67      return EINA_FALSE;
  68
  69    return cmp(str + str_len - suffix_len, suffix) == 0;
  70 }
  71
  72 static inline char **
  73 eina_str_split_full_helper(const char *str, const char *delim, int max_tokens, unsigned int *elements)
  74 {
  75    char *s, **str_array;
  76    const char *src;
  77    size_t len, dlen;
  78    unsigned int tokens;
  79
  80    dlen = strlen(delim);
  81    if (dlen == 0)
  82      {
  83         if (elements) *elements = 0;
  84         return NULL;
  85      }
  86
  87    tokens = 0;
  88    src = str;
  89    /* count tokens and check strlen(str) */
  90    while (*src != '\0')
  91      {
  92         const char *d = delim, *d_end = d + dlen;
  93         const char *tmp = src;
  94         for (; (d < d_end) && (*tmp != '\0'); d++, tmp++)
  95           {
  96              if (EINA_LIKELY(*d != *tmp))
  97                break;
  98           }
  99         if (EINA_UNLIKELY(d == d_end))
 100           {
 101              src = tmp;
 102              tokens++;
 103           }
 104         else
 105           src++;
 106      }
 107    len = src - str;
 108
 109    if ((max_tokens > 0) && (tokens > (unsigned int)max_tokens))
 110      tokens = max_tokens;
 111
 112    str_array = malloc(sizeof(char *) * (tokens + 2));
 113    if (!str_array)
 114      {
 115         if (elements) *elements = 0;
 116         return NULL;
 117      }
 118
 119    s = malloc(len + 1);
 120    if (!s)
 121      {
 122         free(str_array);
 123         if (elements) *elements = 0;
 124         return NULL;
 125      }
 126
 127    /* copy tokens and string */
 128    tokens = 0;
 129    str_array[0] = s;
 130    src = str;
 131    while (*src != '\0')
 132      {
 133         const char *d = delim, *d_end = d + dlen;
 134         const char *tmp = src;
 135         for (; (d < d_end) && (*tmp != '\0'); d++, tmp++)
 136           {
 137              if (EINA_LIKELY(*d != *tmp))
 138                break;
 139           }
 140         if (EINA_UNLIKELY(d == d_end))
 141           {
 142              src = tmp;
 143              *s = '\0';
 144              s += dlen;
 145              tokens++;
 146              str_array[tokens] = s;
 147           }
 148         else
 149           {
 150              *s = *src;
 151              s++;
 152              src++;
 153           }
 154      }
 155    *s = '\0';
 156    str_array[tokens + 1] = NULL;
 157    if (elements) *elements = (tokens + 1);
 158    return str_array;
 159 }
 160
 161 /**
 162  * @endcond
 163  */
 164
 165 /*============================================================================*
 166  *                                 Global                                     *
 167  *============================================================================*/
 168
 169 /*============================================================================*
 170  *                                   API                                      *
 171  *============================================================================*/
 172
 173 /**
 174  * @addtogroup Eina_String_Group String
 175  *
 176  * @brief These functions provide useful C string management.
 177  *
 178  * @{
 179  */
 180
 181
 182 /**
 183  * @brief Copy a c-string to another.
 184  *
 185  * @param dst The destination string.
 186  * @param src The source string.
 187  * @param siz The size of the destination string.
 188  * @return The length of the source string.
 189  *
 190  * This function copies up to @p siz - 1 characters from the
 191  * NUL-terminated string @p src to @p dst, NUL-terminating the result
 192  * (unless @p siz is equal to 0). The returned value is the length of
 193  * @p src. If the returned value is greater than @p siz, truncation
 194  * occured.
 195  */
 196 EAPI size_t
 197 eina_strlcpy(char *dst, const char *src, size_t siz)
 198 {
 199 #ifdef HAVE_STRLCPY
 200    return strlcpy(dst, src, siz);
 201 #else
 202    char *d = dst;
 203    const char *s = src;
 204    size_t n = siz;
 205
 206    /* Copy as many bytes as will fit */
 207    if (n != 0)
 208      {
 209         while (--n != 0)
 210           {
 211              if ((*d++ = *s++) == '\0')
 212                break;
 213           }
 214      }
 215
 216    /* Not enough room in dst, add NUL and traverse rest of src */
 217    if (n == 0)
 218      {
 219         if (siz != 0)
 220           *d = '\0';                /* NUL-terminate dst */
 221         while (*s++)
 222           ;
 223      }
 224
 225    return(s - src - 1);        /* count does not include NUL */
 226 #endif
 227 }
 228
 229 /**
 230  * @brief Append a c-string.
 231  *
 232  * @param dst The destination string.
 233  * @param src The source string.
 234  * @param siz The size of the destination string.
 235  * @return The length of the source string plus MIN(siz, strlen(initial dst))
 236  *
 237  * This function appends @p src to @p dst of size @p siz (unlike
 238  * strncat, @p siz is the full size of @p dst, not space left).  At
 239  * most @p siz - 1 characters will be copied.  Always NUL terminates
 240  * (unless @p siz <= strlen(dst)). This function returns strlen(src) +
 241  * MIN(siz, strlen(initial dst)). If the returned value is greater or
 242  * equal than @p siz, truncation occurred.
 243  */
 244 EAPI size_t
 245 eina_strlcat(char *dst, const char *src, size_t siz)
 246 {
 247    char *d = dst;
 248    const char *s = src;
 249    size_t n = siz;
 250    size_t dlen;
 251
 252    /* Find the end of dst and adjust bytes left but don't go past end */
 253    while (n-- != 0 && *d != '\0')
 254      d++;
 255    dlen = d - dst;
 256    n = siz - dlen;
 257
 258    if (n == 0)
 259      return(dlen + strlen(s));
 260    while (*s != '\0') {
 261         if (n != 1) {
 262              *d++ = *s;
 263              n--;
 264         }
 265         s++;
 266    }
 267    *d = '\0';
 268
 269    return(dlen + (s - src));        /* count does not include NUL */
 270 }
 271
 272 /**
 273  * @brief Check if the given string has the given prefix.
 274  *
 275  * @param str The string to work with.
 276  * @param prefix The prefix to check for.
 277  * @return #EINA_TRUE if the string has the given prefix, #EINA_FALSE otherwise.
 278  *
 279  * This function returns #EINA_TRUE if @p str has the prefix
 280  * @p prefix, #EINA_FALSE otherwise. If the length of @p prefix is
 281  * greater than @p str, #EINA_FALSE is returned.
 282  */
 283 EAPI Eina_Bool
 284 eina_str_has_prefix(const char *str, const char *prefix)
 285 {
 286    size_t str_len;
 287    size_t prefix_len;
 288
 289    str_len = strlen(str);
 290    prefix_len = eina_strlen_bounded(prefix, str_len);
 291    if (prefix_len == (size_t)-1)
 292      return EINA_FALSE;
 293
 294    return (strncmp(str, prefix, prefix_len) == 0);
 295 }
 296
 297 /**
 298  * @brief Check if the given string has the given suffix.
 299  *
 300  * @param str The string to work with.
 301  * @param suffix The suffix to check for.
 302  * @return #EINA_TRUE if the string has the given suffix, #EINA_FALSE otherwise.
 303  *
 304  * This function returns #EINA_TRUE if @p str has the suffix
 305  * @p suffix, #EINA_FALSE otherwise. If the length of @p suffix is
 306  * greater than @p str, #EINA_FALSE is returned.
 307  */
 308 /**
 309  * @param str the string to work with
 310  * @param suffix the suffix to check for
 311  * @return true if str has the given suffix
 312  * @brief checks if the string has the given suffix
 313  */
 314 EAPI Eina_Bool
 315 eina_str_has_suffix(const char *str, const char *suffix)
 316 {
 317    return eina_str_has_suffix_helper(str, suffix, strcmp);
 318 }
 319
 320 /**
 321  * @brief Check if the given string has the given suffix.
 322  *
 323  * @param str The string to work with.
 324  * @param ext The  extension to check for.
 325  * @return #EINA_TRUE if the string has the given extension, #EINA_FALSE otherwise.
 326  *
 327  * This function does the same like eina_str_has_suffix(), but with a
 328  * case insensitive compare.
 329  */
 330 EAPI Eina_Bool
 331 eina_str_has_extension(const char *str, const char *ext)
 332 {
 333    return eina_str_has_suffix_helper(str, ext, strcasecmp);
 334 }
 335
 336 /**
 337  * @brief Split a string using a delimiter and returns number of elements.
 338  *
 339  * @param str The string to split.
 340  * @param delim The string which specifies the places at which to split the string.
 341  * @param max_tokens The maximum number of strings to split string into.
 342  * @param elements Where to return the number of elements in returned
 343  *        array (not counting the terminating @c NULL). May be @c NULL.
 344  * @return A newly-allocated NULL-terminated array of strings or NULL if it
 345  * fails to allocate the array.
 346  *
 347  * This functin splits @p str into a maximum of @p max_tokens pieces,
 348  * using the given delimiter @p delim. @p delim is not included in any
 349  * of the resulting strings, unless @p max_tokens is reached. If
 350  * @p max_tokens is less than @c 1, the string is splitted completely. If
 351  * @p max_tokens is reached, the last string in the returned string
 352  * array contains the remainder of string. The returned value is a
 353  * newly allocated NULL-terminated array of strings or NULL if it fails to
 354  * allocate the array. To free it, free the first element of the array and the
 355  * array itself.
 356  *
 357  * @see eina_str_split()
 358  */
 359 EAPI char **
 360 eina_str_split_full(const char *str, const char *delim, int max_tokens, unsigned int *elements)
 361 {
 362    return eina_str_split_full_helper(str, delim, max_tokens, elements);
 363 }
 364
 365
 366 /**
 367  * @brief Split a string using a delimiter.
 368  *
 369  * @param str The string to split.
 370  * @param delim The string which specifies the places at which to split the string.
 371  * @param max_tokens The maximum number of strings to split string into.
 372  * @return A newly-allocated NULL-terminated array of strings or NULL if it
 373  * fails to allocate the array.
 374  *
 375  * This functin splits @p str into a maximum of @p max_tokens pieces,
 376  * using the given delimiter @p delim. @p delim is not included in any
 377  * of the resulting strings, unless @p max_tokens is reached. If
 378  * @p max_tokens is less than @c 1, the string is splitted completely. If
 379  * @p max_tokens is reached, the last string in the returned string
 380  * array contains the remainder of string. The returned value is a
 381  * newly allocated NULL-terminated array of strings or NULL if it fails to
 382  * allocate the array. To free it, free the first element of the array and the
 383  * array itself.
 384  */
 385 EAPI char **
 386 eina_str_split(const char *str, const char *delim, int max_tokens)
 387 {
 388    return eina_str_split_full_helper(str, delim, max_tokens, NULL);
 389 }
 390
 391 /**
 392  * @brief Join two strings of known length.
 393  *
 394  * @param dst The buffer to store the result.
 395  * @param size Size (in byte) of the buffer.
 396  * @param sep The separator character to use.
 397  * @param a First string to use, before @p sep.
 398  * @param a_len length of @p a.
 399  * @param b Second string to use, after @p sep.
 400  * @param b_len length of @p b.
 401  * @return The number of characters printed.
 402  *
 403  * This function joins the strings @p a and @p b (in that order) and
 404  * separate them with @p sep. The result is stored in the buffer
 405  * @p dst and at most @p size - 1 characters will be written and the
 406  * string is NULL-terminated. @p a_len is the length of @p a (not
 407  * including '\\0') and @p b_len is the length of @p b (not including
 408  * '\\0'). This function returns the number of characters printed (not
 409  * including the trailing '\\0' used to end output to strings). Just
 410  * like snprintf(), it will not write more than @p size bytes, thus a
 411  * returned value of @p size or more means that the output was
 412  * truncated.
 413  *
 414  * @see eina_str_join()
 415  * @see eina_str_join_static()
 416  */
 417 EAPI size_t
 418 eina_str_join_len(char *dst, size_t size, char sep, const char *a, size_t a_len, const char *b, size_t b_len)
 419 {
 420    size_t ret = a_len + b_len + 1;
 421    size_t off;
 422
 423    if (size < 1) return ret;
 424
 425    if (size <= a_len)
 426      {
 427         memcpy(dst, a, size - 1);
 428         dst[size - 1] = '\0';
 429         return ret;
 430      }
 431
 432    memcpy(dst, a, a_len);
 433    off = a_len;
 434
 435    if (size <= off + 1)
 436      {
 437         dst[size - 1] = '\0';
 438         return ret;
 439      }
 440
 441    dst[off] = sep;
 442    off++;
 443
 444    if (size <= off + b_len + 1)
 445      {
 446         memcpy(dst + off, b, size - off - 1);
 447         dst[size - 1] = '\0';
 448         return ret;
 449      }
 450
 451    memcpy(dst + off, b, b_len);
 452    dst[off + b_len] = '\0';
 453    return ret;
 454 }
 455
 456 /**
 457  * @brief Use iconv to convert a text string from one encoding to another
 458  *
 459  * @param enc_from encoding to convert from
 460  * @param enc_to   encoding to convert to
 461  * @param text     text to convert
 462  *
 463  */
 464 #ifdef HAVE_ICONV
 465 EAPI char *
 466 eina_str_convert(const char *enc_from, const char *enc_to, const char *text)
 467 {
 468    iconv_t ic;
 469    char *new_txt, *inp, *outp;
 470    size_t inb, outb, outlen, tob, outalloc;
 471
 472    if (!text) return NULL;
 473    ic = iconv_open(enc_to, enc_from);
 474    if (ic == (iconv_t)(-1)) return NULL;
 475    new_txt  = malloc(64);
 476    inb      = strlen(text);
 477    outb     = 64;
 478    inp      = (char*)text;
 479    outp     = new_txt;
 480    outalloc = 64;
 481    outlen   = 0;
 482
 483    for (;;)
 484      {
 485         size_t count;
 486
 487         tob = outb;
 488         count = iconv(ic, &inp, &inb, &outp, &outb);
 489         outlen += tob - outb;
 490         if (count == (size_t)(-1))
 491           {
 492              if (errno == E2BIG)
 493                {
 494                   new_txt = realloc(new_txt, outalloc + 64);
 495                   outp = new_txt + outlen;
 496                   outalloc += 64;
 497                   outb += 64;
 498                }
 499              else if (errno == EILSEQ)
 500                {
 501                   if (new_txt) free(new_txt);
 502                   new_txt = NULL;
 503                   break;
 504                }
 505              else if (errno == EINVAL)
 506                {
 507                   if (new_txt) free(new_txt);
 508                   new_txt = NULL;
 509                   break;
 510                }
 511              else
 512                {
 513                   if (new_txt) free(new_txt);
 514                   new_txt = NULL;
 515                   break;
 516                }
 517           }
 518         if (inb == 0)
 519           {
 520              if (outalloc == outlen) new_txt = realloc(new_txt, outalloc + 1);
 521              new_txt[outlen] = 0;
 522              break;
 523           }
 524      }
 525    iconv_close(ic);
 526    return new_txt;
 527 }
 528 #else
 529 EAPI char *
 530 eina_str_convert(const char *enc_from __UNUSED__, const char *enc_to __UNUSED__, const char *text __UNUSED__)
 531 {
 532    return NULL;
 533 }
 534 #endif
 535
 536 /**
 537  * @brief Put a \ before and Space( ), \ or ' in a string.
 538  *
 539  * @param str the string to escape
 540  *
 541  * A newly allocated string is returned.
 542  */
 543 EAPI char *
 544 eina_str_escape(const char *str)
 545 {
 546    char *s2, *d;
 547    const char *s;
 548
 549    s2 = malloc((strlen(str) * 2) + 1);
 550    if (!s2) return NULL;
 551    for (s = str, d = s2; *s != 0; s++, d++)
 552      {
 553         if ((*s == ' ') || (*s == '\\') || (*s == '\''))
 554           {
 555              *d = '\\';
 556              d++;
 557           }
 558         *d = *s;
 559      }
 560    *d = 0;
 561    return s2;
 562 }
 563
 564 /**
 565  * @brief Lowercase all the characters in range [A-Z] in the given string.
 566  *
 567  * @param str the string to lowercase
 568  *
 569  * This modifies the original string, changing all characters in [A-Z] to lowercase.
 570  */
 571 EAPI void
 572 eina_str_tolower(char **str)
 573 {
 574    char *p;
 575    if ((!str) || (!(*str))) return;
 576
 577    for (p = *str; (*p); *p++)
 578      if ((*p >= 'A') && (*p <= 'Z'))
 579        *p = tolower(*p);
 580 }
 581
 582
 583 /**
 584  * @}
 585  */