enlightenment/efl
enlightenment
/
efl
8
7
Fork 14
Code Issues 13 Pull Requests 3 Projects Releases Wiki Activity

doxy -> .h 

SVN revision: 58444
This commit is contained in:
Carsten Haitzler 2011-04-07 13:11:27 +00:00
parent 1c640c7704
commit c46642cb97
2 changed files with 194 additions and 191 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

194
legacy/eina/src/include/eina_str.h
View File

@ -6,6 +6,14 @@
#include "eina_types.h"
/**
* @addtogroup Eina_String_Group String
*
* @brief These functions provide useful C string management.
*
* @{
*/
/**
* @addtogroup Eina_Tools_Group Tools
*
@ -19,23 +27,205 @@
*/
/* strlcpy implementation for libc's lacking it */
/**
* @brief Copy a c-string to another.
*
* @param dst The destination string.
* @param src The source string.
* @param siz The size of the destination string.
* @return The length of the source string.
*
* This function copies up to @p siz - 1 characters from the
* NUL-terminated string @p src to @p dst, NUL-terminating the result
* (unless @p siz is equal to 0). The returned value is the length of
* @p src. If the returned value is greater than @p siz, truncation
* occurred.
*/
EAPI size_t eina_strlcpy(char *dst, const char *src, size_t siz) EINA_ARG_NONNULL(1, 2);
/**
* @brief Append a c-string.
*
* @param dst The destination string.
* @param src The source string.
* @param siz The size of the destination string.
* @return The length of the source string plus MIN(siz, strlen(initial dst))
*
* This function appends @p src to @p dst of size @p siz (unlike
* strncat, @p siz is the full size of @p dst, not space left). At
* most @p siz - 1 characters will be copied. Always NUL terminates
* (unless @p siz <= strlen(dst)). This function returns strlen(src) +
* MIN(siz, strlen(initial dst)). If the returned value is greater or
* equal than @p siz, truncation occurred.
*/
EAPI size_t eina_strlcat(char *dst, const char *src, size_t siz) EINA_ARG_NONNULL(1, 2);
/**
* @brief Check if the given string has the given prefix.
*
* @param str The string to work with.
* @param prefix The prefix to check for.
* @return #EINA_TRUE if the string has the given prefix, #EINA_FALSE otherwise.
*
* This function returns #EINA_TRUE if @p str has the prefix
* @p prefix, #EINA_FALSE otherwise. If the length of @p prefix is
* greater than @p str, #EINA_FALSE is returned.
*/
EAPI Eina_Bool eina_str_has_prefix(const char *str, const char *prefix) EINA_PURE EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT;
/**
* @brief Check if the given string has the given suffix.
*
* @param str The string to work with.
* @param suffix The suffix to check for.
* @return #EINA_TRUE if the string has the given suffix, #EINA_FALSE otherwise.
*
* This function returns #EINA_TRUE if @p str has the suffix
* @p suffix, #EINA_FALSE otherwise. If the length of @p suffix is
* greater than @p str, #EINA_FALSE is returned.
*/
EAPI Eina_Bool eina_str_has_suffix(const char *str, const char *suffix) EINA_PURE EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT;
/**
* @brief Check if the given string has the given extension.
*
* @param str The string to work with.
* @param ext The extension to check for.
* @return #EINA_TRUE if the string has the given extension, #EINA_FALSE otherwise.
*
* This function does the same like eina_str_has_suffix(), but with a
* case insensitive compare.
*/
EAPI Eina_Bool eina_str_has_extension(const char *str, const char *ext) EINA_PURE EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT;
/**
* @brief Split a string using a delimiter.
*
* @param str The string to split.
* @param delim The string which specifies the places at which to split the string.
* @param max_tokens The maximum number of strings to split string into.
* @return A newly-allocated NULL-terminated array of strings or NULL if it
* fails to allocate the array.
*
* This functin splits @p str into a maximum of @p max_tokens pieces,
* using the given delimiter @p delim. @p delim is not included in any
* of the resulting strings, unless @p max_tokens is reached. If
* @p max_tokens is less than @c 1, the string is splitted completely. If
* @p max_tokens is reached, the last string in the returned string
* array contains the remainder of string. The returned value is a
* newly allocated NULL-terminated array of strings or NULL if it fails to
* allocate the array. To free it, free the first element of the array and the
* array itself.
*/
EAPI char **eina_str_split(const char *string, const char *delimiter, int max_tokens) EINA_ARG_NONNULL(1, 2) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
/**
* @brief Split a string using a delimiter and returns number of elements.
*
* @param str The string to split.
* @param delim The string which specifies the places at which to split the string.
* @param max_tokens The maximum number of strings to split string into.
* @param elements Where to return the number of elements in returned
* array (not counting the terminating @c NULL). May be @c NULL.
* @return A newly-allocated NULL-terminated array of strings or NULL if it
* fails to allocate the array.
*
* This functin splits @p str into a maximum of @p max_tokens pieces,
* using the given delimiter @p delim. @p delim is not included in any
* of the resulting strings, unless @p max_tokens is reached. If
* @p max_tokens is less than @c 1, the string is splitted completely. If
* @p max_tokens is reached, the last string in the returned string
* array contains the remainder of string. The returned value is a
* newly allocated NULL-terminated array of strings or NULL if it fails to
* allocate the array. To free it, free the first element of the array and the
* array itself.
*
* @see eina_str_split()
*/
EAPI char **eina_str_split_full(const char *string, const char *delimiter, int max_tokens, unsigned int *elements) EINA_ARG_NONNULL(1, 2, 4) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
/**
* @brief Join two strings of known length.
*
* @param dst The buffer to store the result.
* @param size Size (in byte) of the buffer.
* @param sep The separator character to use.
* @param a First string to use, before @p sep.
* @param a_len length of @p a.
* @param b Second string to use, after @p sep.
* @param b_len length of @p b.
* @return The number of characters printed.
*
* This function joins the strings @p a and @p b (in that order) and
* separate them with @p sep. The result is stored in the buffer
* @p dst and at most @p size - 1 characters will be written and the
* string is NULL-terminated. @p a_len is the length of @p a (not
* including '\\0') and @p b_len is the length of @p b (not including
* '\\0'). This function returns the number of characters printed (not
* including the trailing '\\0' used to end output to strings). Just
* like snprintf(), it will not write more than @p size bytes, thus a
* returned value of @p size or more means that the output was
* truncated.
*
* @see eina_str_join()
* @see eina_str_join_static()
*/
EAPI size_t 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) EINA_ARG_NONNULL(1, 4, 6);
/**
* @brief Use Iconv to convert a text string from one encoding to another.
*
* @param enc_from Encoding to convert from.
* @param enc_to Encoding to convert to.
* @param text The text to convert.
* @return The converted text.
*
* This function converts @p text, encoded in @p enc_from. On success,
* the converted text is returned and is encoded in @p enc_to. On
* failure, @c NULL is returned. Iconv is used to convert @p text. If
* Iconv is not available, @c NULL is returned. When not used anymore,
* the returned value must be freed.
*/
EAPI char *eina_str_convert(const char *enc_from, const char *enc_to, const char *text) EINA_WARN_UNUSED_RESULT EINA_MALLOC EINA_ARG_NONNULL(1, 2, 3);
/**
* @brief Put a \ before and Space( ), \ or ' in a string.
*
* @param str The string to escape.
* @return The escaped string.
*
* This function returns a newly allocated escaped string on success,
* @c NULL on failure. When not used anymore, the returned value must
* be freed.
*/
EAPI char *eina_str_escape(const char *str) EINA_WARN_UNUSED_RESULT EINA_MALLOC EINA_ARG_NONNULL(1);
/**
* @brief Lowercase all the characters in range [A-Z] in the given string.
*
* @param str The string to lowercase.
*
* This function modifies the original string, changing all characters
* in [A-Z] to lowercase. If @p str is @c NULL or is an empty string,
* this function does nothing.
*/
EAPI void eina_str_tolower(char **str);
/**
* @brief Uppercase all the characters in range [a-z] in the given string.
*
* @param str The string to uppercase.
*
* This function modifies the original string, changing all characters
* in [a-z] to uppercase. If @p str is @c NULL or is an empty string,
* this function does nothing.
*/
EAPI void eina_str_toupper(char **str);
static inline size_t eina_str_join(char *dst, size_t size, char sep, const char *a, const char *b) EINA_ARG_NONNULL(1, 4, 5);
@ -70,4 +260,8 @@ static inline size_t eina_strlen_bounded(const char *str, size_t maxlen) EINA_PU
* @}
*/
/**
* @}
*/
#endif /* EINA_STR_H */

191
legacy/eina/src/lib/eina_str.c
View File

@ -176,29 +176,6 @@ eina_str_split_full_helper(const char *str,
* API *
*============================================================================*/
/**
* @addtogroup Eina_String_Group String
*
* @brief These functions provide useful C string management.
*
* @{
*/
/**
* @brief Copy a c-string to another.
*
* @param dst The destination string.
* @param src The source string.
* @param siz The size of the destination string.
* @return The length of the source string.
*
* This function copies up to @p siz - 1 characters from the
* NUL-terminated string @p src to @p dst, NUL-terminating the result
* (unless @p siz is equal to 0). The returned value is the length of
* @p src. If the returned value is greater than @p siz, truncation
* occurred.
*/
EAPI size_t
eina_strlcpy(char *dst, const char *src, size_t siz)
{
@ -231,21 +208,6 @@ eina_strlcpy(char *dst, const char *src, size_t siz)
#endif
}
/**
* @brief Append a c-string.
*
* @param dst The destination string.
* @param src The source string.
* @param siz The size of the destination string.
* @return The length of the source string plus MIN(siz, strlen(initial dst))
*
* This function appends @p src to @p dst of size @p siz (unlike
* strncat, @p siz is the full size of @p dst, not space left). At
* most @p siz - 1 characters will be copied. Always NUL terminates
* (unless @p siz <= strlen(dst)). This function returns strlen(src) +
* MIN(siz, strlen(initial dst)). If the returned value is greater or
* equal than @p siz, truncation occurred.
*/
EAPI size_t
eina_strlcat(char *dst, const char *src, size_t siz)
{
@ -277,17 +239,6 @@ eina_strlcat(char *dst, const char *src, size_t siz)
return(dlen + (s - src)); /* count does not include NUL */
}
/**
* @brief Check if the given string has the given prefix.
*
* @param str The string to work with.
* @param prefix The prefix to check for.
* @return #EINA_TRUE if the string has the given prefix, #EINA_FALSE otherwise.
*
* This function returns #EINA_TRUE if @p str has the prefix
* @p prefix, #EINA_FALSE otherwise. If the length of @p prefix is
* greater than @p str, #EINA_FALSE is returned.
*/
EAPI Eina_Bool
eina_str_has_prefix(const char *str, const char *prefix)
{
@ -302,68 +253,18 @@ eina_str_has_prefix(const char *str, const char *prefix)
return (strncmp(str, prefix, prefix_len) == 0);
}
/**
* @brief Check if the given string has the given suffix.
*
* @param str The string to work with.
* @param suffix The suffix to check for.
* @return #EINA_TRUE if the string has the given suffix, #EINA_FALSE otherwise.
*
* This function returns #EINA_TRUE if @p str has the suffix
* @p suffix, #EINA_FALSE otherwise. If the length of @p suffix is
* greater than @p str, #EINA_FALSE is returned.
*/
/**
* @param str the string to work with
* @param suffix the suffix to check for
* @return true if str has the given suffix
* @brief checks if the string has the given suffix
*/
EAPI Eina_Bool
eina_str_has_suffix(const char *str, const char *suffix)
{
return eina_str_has_suffix_helper(str, suffix, strcmp);
}
/**
* @brief Check if the given string has the given suffix.
*
* @param str The string to work with.
* @param ext The extension to check for.
* @return #EINA_TRUE if the string has the given extension, #EINA_FALSE otherwise.
*
* This function does the same like eina_str_has_suffix(), but with a
* case insensitive compare.
*/
EAPI Eina_Bool
eina_str_has_extension(const char *str, const char *ext)
{
return eina_str_has_suffix_helper(str, ext, strcasecmp);
}
/**
* @brief Split a string using a delimiter and returns number of elements.
*
* @param str The string to split.
* @param delim The string which specifies the places at which to split the string.
* @param max_tokens The maximum number of strings to split string into.
* @param elements Where to return the number of elements in returned
* array (not counting the terminating @c NULL). May be @c NULL.
* @return A newly-allocated NULL-terminated array of strings or NULL if it
* fails to allocate the array.
*
* This functin splits @p str into a maximum of @p max_tokens pieces,
* using the given delimiter @p delim. @p delim is not included in any
* of the resulting strings, unless @p max_tokens is reached. If
* @p max_tokens is less than @c 1, the string is splitted completely. If
* @p max_tokens is reached, the last string in the returned string
* array contains the remainder of string. The returned value is a
* newly allocated NULL-terminated array of strings or NULL if it fails to
* allocate the array. To free it, free the first element of the array and the
* array itself.
*
* @see eina_str_split()
*/
EAPI char **
eina_str_split_full(const char *str,
const char *delim,
@ -374,57 +275,12 @@ eina_str_split_full(const char *str,
}
/**
* @brief Split a string using a delimiter.
*
* @param str The string to split.
* @param delim The string which specifies the places at which to split the string.
* @param max_tokens The maximum number of strings to split string into.
* @return A newly-allocated NULL-terminated array of strings or NULL if it
* fails to allocate the array.
*
* This functin splits @p str into a maximum of @p max_tokens pieces,
* using the given delimiter @p delim. @p delim is not included in any
* of the resulting strings, unless @p max_tokens is reached. If
* @p max_tokens is less than @c 1, the string is splitted completely. If
* @p max_tokens is reached, the last string in the returned string
* array contains the remainder of string. The returned value is a
* newly allocated NULL-terminated array of strings or NULL if it fails to
* allocate the array. To free it, free the first element of the array and the
* array itself.
*/
EAPI char **
eina_str_split(const char *str, const char *delim, int max_tokens)
{
return eina_str_split_full_helper(str, delim, max_tokens, NULL);
}
/**
* @brief Join two strings of known length.
*
* @param dst The buffer to store the result.
* @param size Size (in byte) of the buffer.
* @param sep The separator character to use.
* @param a First string to use, before @p sep.
* @param a_len length of @p a.
* @param b Second string to use, after @p sep.
* @param b_len length of @p b.
* @return The number of characters printed.
*
* This function joins the strings @p a and @p b (in that order) and
* separate them with @p sep. The result is stored in the buffer
* @p dst and at most @p size - 1 characters will be written and the
* string is NULL-terminated. @p a_len is the length of @p a (not
* including '\\0') and @p b_len is the length of @p b (not including
* '\\0'). This function returns the number of characters printed (not
* including the trailing '\\0' used to end output to strings). Just
* like snprintf(), it will not write more than @p size bytes, thus a
* returned value of @p size or more means that the output was
* truncated.
*
* @see eina_str_join()
* @see eina_str_join_static()
*/
EAPI size_t
eina_str_join_len(char *dst,
size_t size,
@ -471,20 +327,6 @@ eina_str_join_len(char *dst,
return ret;
}
/**
* @brief Use Iconv to convert a text string from one encoding to another.
*
* @param enc_from Encoding to convert from.
* @param enc_to Encoding to convert to.
* @param text The text to convert.
* @return The converted text.
*
* This function converts @p text, encoded in @p enc_from. On success,
* the converted text is returned and is encoded in @p enc_to. On
* failure, @c NULL is returned. Iconv is used to convert @p text. If
* Iconv is not available, @c NULL is returned. When not used anymore,
* the returned value must be freed.
*/
#ifdef HAVE_ICONV
EAPI char *
eina_str_convert(const char *enc_from, const char *enc_to, const char *text)
@ -572,16 +414,6 @@ eina_str_convert(const char *enc_from __UNUSED__,
}
#endif
/**
* @brief Put a \ before and Space( ), \ or ' in a string.
*
* @param str The string to escape.
* @return The escaped string.
*
* This function returns a newly allocated escaped string on success,
* @c NULL on failure. When not used anymore, the returned value must
* be freed.
*/
EAPI char *
eina_str_escape(const char *str)
{
@ -606,15 +438,6 @@ eina_str_escape(const char *str)
return s2;
}
/**
* @brief Lowercase all the characters in range [A-Z] in the given string.
*
* @param str The string to lowercase.
*
* This function modifies the original string, changing all characters
* in [A-Z] to lowercase. If @p str is @c NULL or is an empty string,
* this function does nothing.
*/
EAPI void
eina_str_tolower(char **str)
{
@ -626,15 +449,6 @@ eina_str_tolower(char **str)
*p = tolower((unsigned char )(*p));
}
/**
* @brief Uppercase all the characters in range [a-z] in the given string.
*
* @param str The string to uppercase.
*
* This function modifies the original string, changing all characters
* in [a-z] to uppercase. If @p str is @c NULL or is an empty string,
* this function does nothing.
*/
EAPI void
eina_str_toupper(char **str)
{
@ -645,8 +459,3 @@ eina_str_toupper(char **str)
for (p = *str; (*p); p++)
*p = toupper((unsigned char)(*p));
}
/**
* @}
*/