2 * vim:ts=8:sw=3:sts=8:noexpandtab:cino=>5n-3f0^-2{2
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 $ */
8 * Copyright (c) 1998 Todd C. Miller <Todd.Miller@courtesan.com>
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.
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.
24 * vim:ts=8:sw=3:sts=8:noexpandtab:cino=>5n-3f0^-2{2
42 #include "eina_private.h"
45 /*============================================================================*
47 *============================================================================*/
54 * Internal helper function used by eina_str_has_suffix() and
55 * eina_str_has_extension()
57 static inline Eina_Bool
58 eina_str_has_suffix_helper(const char *str,
60 int (*cmp)(const char *, const char *))
65 str_len = strlen(str);
66 suffix_len = eina_strlen_bounded(suffix, str_len);
67 if (suffix_len == (size_t)-1)
70 return cmp(str + str_len - suffix_len, suffix) == 0;
74 eina_str_split_full_helper(const char *str,
77 unsigned int *elements)
95 /* count tokens and check strlen(str) */
98 const char *d = delim, *d_end = d + dlen;
99 const char *tmp = src;
100 for (; (d < d_end) && (*tmp != '\0'); d++, tmp++)
102 if (EINA_LIKELY(*d != *tmp))
105 if (EINA_UNLIKELY(d == d_end))
115 if ((max_tokens > 0) && (tokens > (unsigned int)max_tokens))
118 str_array = malloc(sizeof(char *) * (tokens + 2));
137 /* copy tokens and string */
143 const char *d = delim, *d_end = d + dlen;
144 const char *tmp = src;
145 for (; (d < d_end) && (*tmp != '\0'); d++, tmp++)
147 if (EINA_LIKELY(*d != *tmp))
150 if (EINA_UNLIKELY(d == d_end))
156 str_array[tokens] = s;
166 str_array[tokens + 1] = NULL;
168 *elements = (tokens + 1);
177 /*============================================================================*
179 *============================================================================*/
181 /*============================================================================*
183 *============================================================================*/
186 * @addtogroup Eina_String_Group String
188 * @brief These functions provide useful C string management.
195 * @brief Copy a c-string to another.
197 * @param dst The destination string.
198 * @param src The source string.
199 * @param siz The size of the destination string.
200 * @return The length of the source string.
202 * This function copies up to @p siz - 1 characters from the
203 * NUL-terminated string @p src to @p dst, NUL-terminating the result
204 * (unless @p siz is equal to 0). The returned value is the length of
205 * @p src. If the returned value is greater than @p siz, truncation
209 eina_strlcpy(char *dst, const char *src, size_t siz)
212 return strlcpy(dst, src, siz);
218 /* Copy as many bytes as will fit */
222 if ((*d++ = *s++) == '\0')
226 /* Not enough room in dst, add NUL and traverse rest of src */
230 *d = '\0'; /* NUL-terminate dst */
236 return(s - src - 1); /* count does not include NUL */
241 * @brief Append a c-string.
243 * @param dst The destination string.
244 * @param src The source string.
245 * @param siz The size of the destination string.
246 * @return The length of the source string plus MIN(siz, strlen(initial dst))
248 * This function appends @p src to @p dst of size @p siz (unlike
249 * strncat, @p siz is the full size of @p dst, not space left). At
250 * most @p siz - 1 characters will be copied. Always NUL terminates
251 * (unless @p siz <= strlen(dst)). This function returns strlen(src) +
252 * MIN(siz, strlen(initial dst)). If the returned value is greater or
253 * equal than @p siz, truncation occurred.
256 eina_strlcat(char *dst, const char *src, size_t siz)
263 /* Find the end of dst and adjust bytes left but don't go past end */
264 while (n-- != 0 && *d != '\0')
270 return(dlen + strlen(s));
283 return(dlen + (s - src)); /* count does not include NUL */
287 * @brief Check if the given string has the given prefix.
289 * @param str The string to work with.
290 * @param prefix The prefix to check for.
291 * @return #EINA_TRUE if the string has the given prefix, #EINA_FALSE otherwise.
293 * This function returns #EINA_TRUE if @p str has the prefix
294 * @p prefix, #EINA_FALSE otherwise. If the length of @p prefix is
295 * greater than @p str, #EINA_FALSE is returned.
298 eina_str_has_prefix(const char *str, const char *prefix)
303 str_len = strlen(str);
304 prefix_len = eina_strlen_bounded(prefix, str_len);
305 if (prefix_len == (size_t)-1)
308 return (strncmp(str, prefix, prefix_len) == 0);
312 * @brief Check if the given string has the given suffix.
314 * @param str The string to work with.
315 * @param suffix The suffix to check for.
316 * @return #EINA_TRUE if the string has the given suffix, #EINA_FALSE otherwise.
318 * This function returns #EINA_TRUE if @p str has the suffix
319 * @p suffix, #EINA_FALSE otherwise. If the length of @p suffix is
320 * greater than @p str, #EINA_FALSE is returned.
323 * @param str the string to work with
324 * @param suffix the suffix to check for
325 * @return true if str has the given suffix
326 * @brief checks if the string has the given suffix
329 eina_str_has_suffix(const char *str, const char *suffix)
331 return eina_str_has_suffix_helper(str, suffix, strcmp);
335 * @brief Check if the given string has the given suffix.
337 * @param str The string to work with.
338 * @param ext The extension to check for.
339 * @return #EINA_TRUE if the string has the given extension, #EINA_FALSE otherwise.
341 * This function does the same like eina_str_has_suffix(), but with a
342 * case insensitive compare.
345 eina_str_has_extension(const char *str, const char *ext)
347 return eina_str_has_suffix_helper(str, ext, strcasecmp);
351 * @brief Split a string using a delimiter and returns number of elements.
353 * @param str The string to split.
354 * @param delim The string which specifies the places at which to split the string.
355 * @param max_tokens The maximum number of strings to split string into.
356 * @param elements Where to return the number of elements in returned
357 * array (not counting the terminating @c NULL). May be @c NULL.
358 * @return A newly-allocated NULL-terminated array of strings or NULL if it
359 * fails to allocate the array.
361 * This functin splits @p str into a maximum of @p max_tokens pieces,
362 * using the given delimiter @p delim. @p delim is not included in any
363 * of the resulting strings, unless @p max_tokens is reached. If
364 * @p max_tokens is less than @c 1, the string is splitted completely. If
365 * @p max_tokens is reached, the last string in the returned string
366 * array contains the remainder of string. The returned value is a
367 * newly allocated NULL-terminated array of strings or NULL if it fails to
368 * allocate the array. To free it, free the first element of the array and the
371 * @see eina_str_split()
374 eina_str_split_full(const char *str,
377 unsigned int *elements)
379 return eina_str_split_full_helper(str, delim, max_tokens, elements);
384 * @brief Split a string using a delimiter.
386 * @param str The string to split.
387 * @param delim The string which specifies the places at which to split the string.
388 * @param max_tokens The maximum number of strings to split string into.
389 * @return A newly-allocated NULL-terminated array of strings or NULL if it
390 * fails to allocate the array.
392 * This functin splits @p str into a maximum of @p max_tokens pieces,
393 * using the given delimiter @p delim. @p delim is not included in any
394 * of the resulting strings, unless @p max_tokens is reached. If
395 * @p max_tokens is less than @c 1, the string is splitted completely. If
396 * @p max_tokens is reached, the last string in the returned string
397 * array contains the remainder of string. The returned value is a
398 * newly allocated NULL-terminated array of strings or NULL if it fails to
399 * allocate the array. To free it, free the first element of the array and the
403 eina_str_split(const char *str, const char *delim, int max_tokens)
405 return eina_str_split_full_helper(str, delim, max_tokens, NULL);
409 * @brief Join two strings of known length.
411 * @param dst The buffer to store the result.
412 * @param size Size (in byte) of the buffer.
413 * @param sep The separator character to use.
414 * @param a First string to use, before @p sep.
415 * @param a_len length of @p a.
416 * @param b Second string to use, after @p sep.
417 * @param b_len length of @p b.
418 * @return The number of characters printed.
420 * This function joins the strings @p a and @p b (in that order) and
421 * separate them with @p sep. The result is stored in the buffer
422 * @p dst and at most @p size - 1 characters will be written and the
423 * string is NULL-terminated. @p a_len is the length of @p a (not
424 * including '\\0') and @p b_len is the length of @p b (not including
425 * '\\0'). This function returns the number of characters printed (not
426 * including the trailing '\\0' used to end output to strings). Just
427 * like snprintf(), it will not write more than @p size bytes, thus a
428 * returned value of @p size or more means that the output was
431 * @see eina_str_join()
432 * @see eina_str_join_static()
435 eina_str_join_len(char *dst,
443 size_t ret = a_len + b_len + 1;
451 memcpy(dst, a, size - 1);
452 dst[size - 1] = '\0';
456 memcpy(dst, a, a_len);
461 dst[size - 1] = '\0';
468 if (size <= off + b_len + 1)
470 memcpy(dst + off, b, size - off - 1);
471 dst[size - 1] = '\0';
475 memcpy(dst + off, b, b_len);
476 dst[off + b_len] = '\0';
481 * @brief Use iconv to convert a text string from one encoding to another
483 * @param enc_from encoding to convert from
484 * @param enc_to encoding to convert to
485 * @param text text to convert
490 eina_str_convert(const char *enc_from, const char *enc_to, const char *text)
493 char *new_txt, *inp, *outp;
494 size_t inb, outb, outlen, tob, outalloc;
499 ic = iconv_open(enc_to, enc_from);
500 if (ic == (iconv_t)(-1))
503 new_txt = malloc(64);
516 count = iconv(ic, &inp, &inb, &outp, &outb);
517 outlen += tob - outb;
518 if (count == (size_t)(-1))
522 new_txt = realloc(new_txt, outalloc + 64);
523 outp = new_txt + outlen;
527 else if (errno == EILSEQ)
535 else if (errno == EINVAL)
555 if (outalloc == outlen)
556 new_txt = realloc(new_txt, outalloc + 1);
567 eina_str_convert(const char *enc_from __UNUSED__,
568 const char *enc_to __UNUSED__,
569 const char *text __UNUSED__)
576 * @brief Put a \ before and Space( ), \ or ' in a string.
578 * @param str the string to escape
580 * A newly allocated string is returned.
583 eina_str_escape(const char *str)
588 s2 = malloc((strlen(str) * 2) + 1);
592 for (s = str, d = s2; *s != 0; s++, d++)
594 if ((*s == ' ') || (*s == '\\') || (*s == '\''))
607 * @brief Lowercase all the characters in range [A-Z] in the given string.
609 * @param str the string to lowercase
611 * This modifies the original string, changing all characters in [A-Z] to lowercase.
614 eina_str_tolower(char **str)
617 if ((!str) || (!(*str)))
620 for (p = *str; (*p); p++)
625 * @brief Uppercase all the characters in range [a-z] in the given string.
627 * @param str the string to uppercase
629 * This modifies the original string, changing all characters in [a-z] to uppercase.
632 eina_str_toupper(char **str)
635 if ((!str) || (!(*str)))
638 for (p = *str; (*p); p++)