diff options
author | Campbell Barton <ideasman42@gmail.com> | 2013-03-14 14:07:05 +0400 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2013-03-14 14:07:05 +0400 |
commit | 0159647ada64591e4edbcb1284cf499fc2ae9c09 (patch) | |
tree | 4261f47e922ac29fa4e0123a31d0d515f53b4b9b /source/blender/blenlib/BLI_string.h | |
parent | ccd05c33ede3ead7b249afbb0e93586f083b5921 (diff) |
add BLI_strncpy_rlen(), a clone of BLI_strncpy() that returns the number of bytes copied.
also move doxy comments for BLI_string.h into the C file.
Diffstat (limited to 'source/blender/blenlib/BLI_string.h')
-rw-r--r-- | source/blender/blenlib/BLI_string.h | 80 |
1 files changed, 10 insertions, 70 deletions
diff --git a/source/blender/blenlib/BLI_string.h b/source/blender/blenlib/BLI_string.h index 603831246ac..3bc9d733254 100644 --- a/source/blender/blenlib/BLI_string.h +++ b/source/blender/blenlib/BLI_string.h @@ -38,42 +38,20 @@ extern "C" { #endif -/** - * Duplicates the cstring \a str into a newly mallocN'd - * string and returns it. - * - * \param str The string to be duplicated - * \retval Returns the duplicated string - */ -char *BLI_strdup(const char *str) +char *BLI_strdupn(const char *str, const size_t len) #ifdef __GNUC__ __attribute__((warn_unused_result)) __attribute__((nonnull)) #endif ; -/** - * Duplicates the first \a len bytes of cstring \a str - * into a newly mallocN'd string and returns it. \a str - * is assumed to be at least len bytes long. - * - * \param str The string to be duplicated - * \param len The number of bytes to duplicate - * \retval Returns the duplicated string - */ -char *BLI_strdupn(const char *str, const size_t len) +char *BLI_strdup(const char *str) #ifdef __GNUC__ __attribute__((warn_unused_result)) __attribute__((nonnull)) #endif ; -/** - * Appends the two strings, and returns new mallocN'ed string - * \param str1 first string for copy - * \param str2 second string for append - * \retval Returns dst - */ char *BLI_strdupcat(const char *__restrict str1, const char *__restrict str2) #ifdef __GNUC__ __attribute__((warn_unused_result)) @@ -81,32 +59,19 @@ __attribute__((nonnull)) #endif ; -/** - * Like strncpy but ensures dst is always - * '\0' terminated. - * - * \param dst Destination for copy - * \param src Source string to copy - * \param maxncpy Maximum number of characters to copy (generally - * the size of dst) - * \retval Returns dst - */ char *BLI_strncpy(char *__restrict dst, const char *__restrict src, const size_t maxncpy) #ifdef __GNUC__ __attribute__((nonnull)) #endif ; -/** - *Makes a copy of the text within the "" that appear after some text 'blahblah' - * i.e. for string 'pose["apples"]' with prefix 'pose[', it should grab "apples" - * - * - str: is the entire string to chop - * - prefix: is the part of the string to leave out - * - * Assume that the strings returned must be freed afterwards, and that the inputs will contain - * data we want... - */ +size_t BLI_strncpy_rlen(char *__restrict dst, const char *__restrict src, const size_t maxncpy) +#ifdef __GNUC__ +__attribute__((warn_unused_result)) +__attribute__((nonnull)) +#endif +; + char *BLI_str_quoted_substrN(const char *__restrict str, const char *__restrict prefix) #ifdef __GNUC__ __attribute__((warn_unused_result)) @@ -114,16 +79,6 @@ __attribute__((nonnull)) #endif ; -/** - * Returns a copy of the cstring \a str into a newly mallocN'd - * string with all instances of oldText replaced with newText, - * and returns it. - * - * \param str The string to replace occurrences of oldText in - * \param oldText The text in the string to find and replace - * \param newText The text in the string to find and replace - * \retval Returns the duplicated string - */ char *BLI_replacestr(char *__restrict str, const char *__restrict oldText, const char *__restrict newText) #ifdef __GNUC__ __attribute__((warn_unused_result)) @@ -131,9 +86,6 @@ __attribute__((nonnull)) #endif ; -/* - * Replacement for snprintf - */ size_t BLI_snprintf(char *__restrict buffer, size_t len, const char *__restrict format, ...) #ifdef __GNUC__ __attribute__ ((format(printf, 3, 4))) @@ -141,19 +93,12 @@ __attribute__((nonnull)) #endif ; -/* - * Replacement for vsnprintf - */ size_t BLI_vsnprintf(char *__restrict buffer, size_t count, const char *__restrict format, va_list arg) #ifdef __GNUC__ __attribute__ ((format(printf, 3, 0))) #endif ; -/* - * Print formatted string into a newly mallocN'd string - * and return it. - */ char *BLI_sprintfN(const char *__restrict format, ...) #ifdef __GNUC__ __attribute__ ((format(printf, 1, 2))) @@ -168,11 +113,6 @@ __attribute__((nonnull)) #endif ; -/** - * Compare two strings without regard to case. - * - * \retval True if the strings are equal, false otherwise. - */ int BLI_strcaseeq(const char *a, const char *b) #ifdef __GNUC__ __attribute__((warn_unused_result)) @@ -214,7 +154,7 @@ void BLI_timestr(double _time, char *str) #ifdef __GNUC__ __attribute__((nonnull)) #endif -; /* time var is global */ +; void BLI_ascii_strtolower(char *str, const size_t len) #ifdef __GNUC__ |