extended string API from rt11733

diff --git a/lib/isc/include/isc/string.h b/lib/isc/include/isc/string.h
index d3899aac753c3a02dc929787d49afa8041971c7e..5cc9d82e5c32fe4f58079981a0756dc14baf18cc 100644 (file)
--- a/lib/isc/include/isc/string.h
+++ b/lib/isc/include/isc/string.h
@@ -15,7 +15,7 @@
  * PERFORMANCE OF THIS SOFTWARE.
  */
 
-/* $Id: string.h,v 1.14 2005/04/29 00:23:45 marka Exp $ */
+/* $Id: string.h,v 1.15 2005/05/14 22:11:56 jakob Exp $ */
 
 #ifndef ISC_STRING_H
 #define ISC_STRING_H 1
@@ -27,6 +27,9 @@
 #include <isc/int.h>
 #include <isc/lang.h>
 #include <isc/platform.h>
+#include <isc/types.h>
+
+#define ISC_STRING_MAGIC 0x5e
 
 ISC_LANG_BEGINDECLS
 
@@ -45,6 +48,149 @@ isc_string_touint64(char *source, char **endp, int base);
  * On error 'endp' points to 'source'.
  */
 
+isc_result_t
+isc_string_copy(char *target, size_t size, const char *source);
+/*
+ * Copy the string pointed to by 'source' to 'target' which is a
+ * pointer to a string of at least 'size' bytes.
+ *
+ * Requires:
+ *     'target' is a pointer to a char[] of at least 'size' bytes.
+ *     'size' an integer > 0.
+ *     'source' == NULL or points to a NUL terminated string.
+ *
+ * Ensures:
+ *     If result == ISC_R_SUCCESS
+ *             'target' will be a NUL terminated string of no more
+ *             than 'size' bytes (including NUL).
+ *
+ *     If result == ISC_R_NOSPACE
+ *             'target' is undefined.
+ *
+ * Returns:
+ *     ISC_R_SUCCESS  -- 'source' was successfully copied to 'target'.
+ *     ISC_R_NOSPACE  -- 'source' could not be copied since 'target'
+ *                       is too small.
+ */
+
+void
+isc_string_copy_truncate(char *target, size_t size, const char *source);
+/*
+ * Copy the string pointed to by 'source' to 'target' which is a
+ * pointer to a string of at least 'size' bytes.
+ *
+ * Requires:
+ *     'target' is a pointer to a char[] of at least 'size' bytes.
+ *     'size' an integer > 0.
+ *     'source' == NULL or points to a NUL terminated string.
+ *
+ * Ensures:
+ *     'target' will be a NUL terminated string of no more
+ *     than 'size' bytes (including NUL).
+ */
+
+isc_result_t
+isc_string_append(char *target, size_t size, const char *source);
+/*
+ * Append the string pointed to by 'source' to 'target' which is a
+ * pointer to a NUL terminated string of at least 'size' bytes.
+ *
+ * Requires:
+ *     'target' is a pointer to a NUL terminated char[] of at
+ *     least 'size' bytes.
+ *     'size' an integer > 0.
+ *     'source' == NULL or points to a NUL terminated string.
+ *
+ * Ensures:
+ *     If result == ISC_R_SUCCESS
+ *             'target' will be a NUL terminated string of no more
+ *             than 'size' bytes (including NUL).
+ *
+ *     If result == ISC_R_NOSPACE
+ *             'target' is undefined.
+ *
+ * Returns:
+ *     ISC_R_SUCCESS  -- 'source' was successfully appended to 'target'.
+ *     ISC_R_NOSPACE  -- 'source' could not be appended since 'target'
+ *                       is too small.
+ */
+
+void
+isc_string_append_truncate(char *target, size_t size, const char *source);
+/*
+ * Append the string pointed to by 'source' to 'target' which is a
+ * pointer to a NUL terminated string of at least 'size' bytes.
+ *
+ * Requires:
+ *     'target' is a pointer to a NUL terminated char[] of at
+ *     least 'size' bytes.
+ *     'size' an integer > 0.
+ *     'source' == NULL or points to a NUL terminated string.
+ *
+ * Ensures:
+ *     'target' will be a NUL terminated string of no more
+ *     than 'size' bytes (including NUL).
+ */
+
+isc_result_t
+isc_string_printf(char *target, size_t size, const char *format, ...);
+/*
+ * Print 'format' to 'target' which is a pointer to a string of at least
+ * 'size' bytes.
+ *
+ * Requires:
+ *     'target' is a pointer to a char[] of at least 'size' bytes.
+ *     'size' an integer > 0.
+ *     'format' == NULL or points to a NUL terminated string.
+ *
+ * Ensures:
+ *     If result == ISC_R_SUCCESS
+ *             'target' will be a NUL terminated string of no more
+ *             than 'size' bytes (including NUL).
+ *
+ *     If result == ISC_R_NOSPACE
+ *             'target' is undefined.
+ *
+ * Returns:
+ *     ISC_R_SUCCESS  -- 'format' was successfully printed to 'target'.
+ *     ISC_R_NOSPACE  -- 'format' could not be printed to 'target' since it
+ *                       is too small.
+ */
+
+void
+isc_string_printf_truncate(char *target, size_t size, const char *format, ...);
+/*
+ * Print 'format' to 'target' which is a pointer to a string of at least
+ * 'size' bytes.
+ *
+ * Requires:
+ *     'target' is a pointer to a char[] of at least 'size' bytes.
+ *     'size' an integer > 0.
+ *     'format' == NULL or points to a NUL terminated string.
+ *
+ * Ensures:
+ *     'target' will be a NUL terminated string of no more
+ *     than 'size' bytes (including NUL).
+ */
+
+
+char *
+isc_string_regiondup(isc_mem_t *mctx, const isc_region_t *source);
+/*
+ * Copy the region pointed to by r to a NUL terminated string
+ * allocated from the memory context pointed to by mctx.
+ *
+ * The result should be deallocated using isc_mem_free()
+ *
+ * Requires:
+ *     'mctx' is a point to a valid memory context.
+ *     'source' is a pointer to a valid region.
+ *
+ * Returns:
+ *     a pointer to a NUL terminated string or
+ *     NULL if memory for the copy could not be allocated
+ *
+ */
 
 char *
 isc_string_separate(char **stringp, const char *delim);

diff --git a/lib/isc/string.c b/lib/isc/string.c
index fdf9916a625a1504970b8504552eadd94a804120..c8f760e1fc8906f82dadf92c718d37f7b5d673af 100644 (file)
--- a/lib/isc/string.c
+++ b/lib/isc/string.c
@@ -15,7 +15,7 @@
  * PERFORMANCE OF THIS SOFTWARE.
  */
 
-/* $Id: string.c,v 1.13 2005/04/29 00:23:31 marka Exp $ */
+/* $Id: string.c,v 1.14 2005/05/14 22:11:56 jakob Exp $ */
 
 /*! \file */
 
@@ -23,7 +23,10 @@
 
 #include <ctype.h>
 
+#include <isc/mem.h>
+#include <isc/region.h>
 #include <isc/string.h>
+#include <isc/util.h>
 
 static char digits[] = "0123456789abcdefghijklmnoprstuvwxyz";
 
@@ -91,6 +94,112 @@ isc_string_touint64(char *source, char **end, int base) {
        return (tmp);
 }
 
+isc_result_t
+isc_string_copy(char *target, size_t size, const char *source)
+{
+       REQUIRE(size > 0);
+
+       if (strlcpy(target, source, size) >= size) {
+               memset(target, ISC_STRING_MAGIC, size);
+               return (ISC_R_NOSPACE);
+       }
+
+       ENSURE(strlen(target) < size);
+
+       return (ISC_R_SUCCESS);
+}
+
+void
+isc_string_copy_truncate(char *target, size_t size, const char *source)
+{
+       REQUIRE(size > 0);
+
+       strlcpy(target, source, size);
+
+       ENSURE(strlen(target) < size);
+}
+
+isc_result_t
+isc_string_append(char *target, size_t size, const char *source)
+{
+       REQUIRE(size > 0);
+       REQUIRE(strlen(target) < size);
+
+       if (strlcat(target, source, size) >= size) {
+               memset(target, ISC_STRING_MAGIC, size);
+               return (ISC_R_NOSPACE);
+       }
+
+       ENSURE(strlen(target) < size);
+
+       return (ISC_R_SUCCESS);
+}
+
+void
+isc_string_append_truncate(char *target, size_t size, const char *source)
+{
+       REQUIRE(size > 0);
+       REQUIRE(strlen(target) < size);
+
+       strlcat(target, source, size);
+
+       ENSURE(strlen(target) < size);
+}
+
+isc_result_t
+isc_string_printf(char *target, size_t size, const char *format, ...)
+{
+       va_list args;
+       size_t n;
+
+       REQUIRE(size > 0);
+
+       va_start(args, format);
+       n = vsnprintf(target, size, format, args);
+       va_end(args);
+
+       if (n >= size) {
+               memset(target, ISC_STRING_MAGIC, size);
+               return (ISC_R_NOSPACE);
+       }
+
+       ENSURE(strlen(target) < size);
+
+       return (ISC_R_SUCCESS);
+}
+
+void
+isc_string_printf_truncate(char *target, size_t size, const char *format, ...)
+{
+       va_list args;
+       size_t n;
+
+       REQUIRE(size > 0);
+
+       va_start(args, format);
+       n = vsnprintf(target, size, format, args);
+       va_end(args);
+
+       ENSURE(strlen(target) < size);
+}
+
+char *
+isc_string_regiondup(isc_mem_t *mctx, const isc_region_t *source)
+{
+       char *target;
+
+       REQUIRE(mctx != NULL);
+       REQUIRE(source != NULL);
+
+       target = (char *) isc_mem_allocate(mctx, source->length + 1);
+       if (target != NULL) {
+               memcpy(source->base, target, source->length);
+               target[source->length] = '\0';
+       }
+
+       return (target);
+}
+
 char *
 isc_string_separate(char **stringp, const char *delim) {
        char *string = *stringp;