(svn r14546) -Codechange: Unify string(cpy|cat) functions

-Doc: string(cpy|cat) functions

2 files changed, 71 insertions, 19 deletions

diff --git a/src/string.cpp b/src/string.cpp
index d0b19f00b..23cd97b92 100644
--- a/src/string.cpp
+++ b/src/string.cpp
@@ -34,17 +34,21 @@ static int CDECL vseprintf(char *str, const char *last, const char *format, va_l
 void ttd_strlcat(char *dst, const char *src, size_t size)
 {
 	assert(size > 0);
-	for (; size > 0 && *dst != '\0'; --size, ++dst) {}
-	assert(size > 0);
-	while (--size > 0 && *src != '\0') *dst++ = *src++;
-	*dst = '\0';
+	while (size > 0 && *dst != '\0') {
+		size--;
+		dst++;
+	}
+
+	ttd_strlcpy(dst, src, size);
 }
 
 
 void ttd_strlcpy(char *dst, const char *src, size_t size)
 {
 	assert(size > 0);
-	while (--size > 0 && *src != '\0') *dst++ = *src++;
+	while (--size > 0 && *src != '\0') {
+		*dst++ = *src++;
+	}
 	*dst = '\0';
 }
 
@@ -52,10 +56,11 @@ void ttd_strlcpy(char *dst, const char *src, size_t size)
 char* strecat(char* dst, const char* src, const char* last)
 {
 	assert(dst <= last);
-	for (; *dst != '\0'; ++dst)
+	while (*dst != '\0') {
 		if (dst == last) return dst;
-	for (; *src != '\0' && dst != last; ++dst, ++src) *dst = *src;
-	*dst = '\0';
+		dst++;
+	}
+
 	return strecpy(dst, src, last);
 }
 
@@ -63,8 +68,11 @@ char* strecat(char* dst, const char* src, const char* last)
 char* strecpy(char* dst, const char* src, const char* last)
 {
 	assert(dst <= last);
-	for (; *src != '\0' && dst != last; ++dst, ++src) *dst = *src;
+	while (dst != last && *src != '\0') {
+		*dst++ = *src++;
+	}
 	*dst = '\0';
+
 	if (dst == last && *src != '\0') {
 #ifdef STRGEN
 		error("String too long for destination buffer");
diff --git a/src/string_func.h b/src/string_func.h
index 6c8ce4a5a..97834f456 100644
--- a/src/string_func.h
+++ b/src/string_func.h
@@ -22,23 +22,67 @@
 #include "string_type.h"
 
 /**
- * usage ttd_strlcpy(dst, src, lengthof(dst));
- * @param dst destination buffer
- * @param src string to copy/concatenate
- * @param size size of the destination buffer
+ * Appends characters from one string to another.
+ *
+ * Appends the source string to the destination string with respect of the
+ * terminating null-character and the maximum size of the destination
+ * buffer.
+ *
+ * @note usage ttd_strlcat(dst, src, lengthof(dst));
+ *
+ * @param dst The buffer containing the target string
+ * @param src The buffer containing the string to append
+ * @param size The maximum size of the destination buffer
  */
 void ttd_strlcat(char *dst, const char *src, size_t size);
+
+/**
+ * Copies characters from one buffer to another.
+ *
+ * Copies the source string to the destination buffer with respect of the
+ * terminating null-character and the maximum size of the destination
+ * buffer.
+ *
+ * @note usage ttd_strlcpy(dst, src, lengthof(dst));
+ *
+ * @param dst The destination buffer
+ * @param src The buffer containing the string to copy
+ * @param size The maximum size of the destination buffer
+ */
 void ttd_strlcpy(char *dst, const char *src, size_t size);
 
 /**
- * usage: strecpy(dst, src, lastof(dst));
- * @param dst destination buffer
- * @param src string to copy
- * @param last pointer to the last element in the dst array
- *             if NULL no boundary check is performed
- * @return a pointer to the terminating \0 in the destination buffer
+ * Appends characters from one string to another.
+ *
+ * Appends the source string to the destination string with respect of the
+ * terminating null-character and and the last pointer to the last element
+ * in the destination buffer. If the last pointer is set to NULL no
+ * boundary check is performed.
+ *
+ * @note usage: strecat(dst, src, lastof(dst));
+ *
+ * @param dst The buffer containing the target string
+ * @param src The buffer containing the string to append
+ * @param last The pointer to the last element of the destination buffer
+ * @return The pointer to the terminating null-character in the destination buffer
  */
 char *strecat(char *dst, const char *src, const char *last);
+
+/**
+ * Copies characters from one buffer to another.
+ *
+ * Copies the source string to the destination buffer with respect of the
+ * terminating null-character and the last pointer to the last element in
+ * the destination buffer. If the last pointer is set to NULL no boundary
+ * check is performed.
+ *
+ * @note usage: strecpy(dst, src, lastof(dst));
+ *
+ * @param dst The destination buffer
+ * @param src The buffer containing the string to copy
+ * @param last The pointer to the last element of the destination buffer
+ * @return The pointer to the terminating null-character in the destination buffer
+ */
 char *strecpy(char *dst, const char *src, const char *last);
 
 int CDECL seprintf(char *str, const char *last, const char *format, ...);