[svn-r3572] Purpose:

    Code Movement
Description:
    Moved some functions which worked only with the h5tools_str_t
    structure from the h5tools module to the h5tools_str module.
Platforms tested:
    Linux

2 files changed, 725 insertions, 10 deletions

diff --git a/tools/lib/h5tools_str.c b/tools/lib/h5tools_str.c
index d41c9c7..e594ebd 100644
--- a/tools/lib/h5tools_str.c
+++ b/tools/lib/h5tools_str.c
@@ -16,9 +16,25 @@
 #include "h5tools.h"            /*for h5dump_t structure    */
 #include "h5tools_str.h"        /*function prototypes       */
 
+/*
+ * If REPEAT_VERBOSE is defined then character strings will be printed so
+ * that repeated character sequences like "AAAAAAAAAA" are displayed as
+ *
+ * 	'A' repeates 9 times
+ *
+ * Otherwise the format is more Perl-like
+ *
+ * 	'A'*10
+ * 
+ */
+#define REPEAT_VERBOSE
+
 /* Variable length string datatype */
 #define STR_INIT_LEN    4096    /*initial length            */
 
+static char    *h5tools_escape(char *s, size_t size, int escape_spaces);
+static hbool_t  h5tools_is_zero(const void *_mem, size_t size);
+
 /*-------------------------------------------------------------------------
  * Function:	h5tools_str_close
  *
@@ -232,7 +248,7 @@ h5tools_str_fmt(h5tools_str_t *str/*in,out*/, size_t start, const char *fmt)
 }
 
 /*-------------------------------------------------------------------------
- * Function:	h5tools_prefix
+ * Function:	h5tools_str_prefix
  *
  * Purpose:	Renders the line prefix value into string STR.
  *
@@ -287,3 +303,697 @@ h5tools_str_prefix(h5tools_str_t *str/*in,out*/, const h5dump_t *info,
     /* Add prefix and suffix to the index */
     return h5tools_str_fmt(str, 0, OPT(info->idx_fmt, "%s: "));
 }
+
+/*-------------------------------------------------------------------------
+ * Function:	h5tools_str_dump_region
+ *
+ * Purpose:	Prints information about a dataspace region by appending
+ *		the information to the specified string.
+ *
+ * Return:	Success:	0
+ *
+ *		Failure:	NULL
+ *
+ * Programmer:	Robb Matzke
+ *              Monday, June  7, 1999
+ *
+ * Modifications:
+ *
+ *-------------------------------------------------------------------------
+ */
+int
+h5tools_str_dump_region(h5tools_str_t *str, hid_t region, const h5dump_t *info)
+{
+    hssize_t	nblocks, npoints;
+    hsize_t     alloc_size;
+    hsize_t    *ptdata;
+    int		ndims = H5Sget_simple_extent_ndims(region);
+
+    /*
+     * These two functions fail if the region does not have blocks or points,
+     * respectively. They do not currently know how to translate from one to
+     * the other.
+     */
+    H5E_BEGIN_TRY {
+        nblocks = H5Sget_select_hyper_nblocks(region);
+        npoints = H5Sget_select_elem_npoints(region);
+    } H5E_END_TRY;
+
+    h5tools_str_append(str, "{");
+
+    /* Print block information */
+    if (nblocks > 0) {
+        int i;
+
+        alloc_size = nblocks * ndims * 2 * sizeof(ptdata[0]);
+        assert(alloc_size == (hsize_t)((size_t)alloc_size)); /*check for overflow*/
+        ptdata = malloc((size_t)alloc_size);
+        H5_CHECK_OVERFLOW(nblocks, hssize_t, hsize_t);
+        H5Sget_select_hyper_blocklist(region, (hsize_t)0, (hsize_t)nblocks, ptdata);
+
+        for (i = 0; i < nblocks; i++) {
+            int j;
+
+            h5tools_str_append(str, info->dset_blockformat_pre,
+                               i ? "," OPTIONAL_LINE_BREAK " " : "",
+                               (unsigned long)i);
+            
+            /* Start coordinates and opposite corner */
+            for (j = 0; j < ndims; j++)
+                h5tools_str_append(str, "%s%lu", j ? "," : "(",
+                                   (unsigned long)ptdata[i * 2 * ndims + j]);
+
+            for (j = 0; j < ndims; j++)
+                h5tools_str_append(str, "%s%lu", j ? "," : ")-(",
+                                  (unsigned long)ptdata[i * 2 * ndims + j + ndims]);
+
+            h5tools_str_append(str, ")");
+        }
+
+        free(ptdata);
+    }
+
+    /* Print point information */
+    if (npoints > 0) {
+        int i;
+
+        alloc_size = npoints * ndims * sizeof(ptdata[0]);
+        assert(alloc_size == (hsize_t)((size_t)alloc_size)); /*check for overflow*/
+        ptdata = malloc((size_t)alloc_size);
+        H5_CHECK_OVERFLOW(npoints,hssize_t,hsize_t);
+        H5Sget_select_elem_pointlist(region, (hsize_t)0, (hsize_t)npoints, ptdata);
+
+        for (i = 0; i < npoints; i++) {
+            int j;
+
+            h5tools_str_append(str, info->dset_ptformat_pre ,
+                               i ? "," OPTIONAL_LINE_BREAK " " : "",
+                               (unsigned long)i);
+            
+            for (j = 0; j < ndims; j++)
+                h5tools_str_append(str, "%s%lu", j ? "," : "(",
+                                   (unsigned long)(ptdata[i * ndims + j]));
+
+            h5tools_str_append(str, ")");
+        }
+
+        free(ptdata);
+    }
+    
+    h5tools_str_append(str, "}");
+    return 0;
+}
+
+/*-------------------------------------------------------------------------
+ * Function:	h5tools_print_char
+ *
+ * Purpose:	Shove a character into the STR.
+ *
+ * Return:	Nothing
+ *
+ * Programmer:	Bill Wendling
+ *              Tuesday, 20. February 2001
+ *
+ * Modifications:
+ *
+ *-------------------------------------------------------------------------
+ */
+void
+h5tools_print_char(h5tools_str_t *str, const h5dump_t *info, unsigned char ch)
+{
+    if (info->str_locale == ESCAPE_HTML) {
+        if (ch <= ' ' || ch > '~')
+            h5tools_str_append(str, "%%%02x", ch);
+        else
+            h5tools_str_append(str, "%c", (char)ch);
+    } else {
+        switch (ch) {
+        case '"':
+            h5tools_str_append(str, "\\\"");
+            break;
+        case '\\':
+            h5tools_str_append(str, "\\\\");
+            break;
+        case '\b':
+            h5tools_str_append(str, "\\b");
+            break;
+        case '\f':
+            h5tools_str_append(str, "\\f");
+            break;
+        case '\n':
+            h5tools_str_append(str, "\\n");
+            break;
+        case '\r':
+            h5tools_str_append(str, "\\r");
+            break;
+        case '\t':
+            h5tools_str_append(str, "\\t");
+            break;
+        default:
+            if (isprint(ch))
+                h5tools_str_append(str, "%c", (char)ch);
+            else 
+                h5tools_str_append(str, "\\%03o", ch);
+
+            break;
+        }
+    }
+}
+
+/*-------------------------------------------------------------------------
+ * Function:	h5tools_str_sprint
+ *
+ * Purpose:	Renders the value pointed to by VP of type TYPE into variable
+ *		length string STR.
+ *
+ * Return:	A pointer to memory containing the result or NULL on error.
+ *
+ * Programmer:	Robb Matzke
+ *              Thursday, July 23, 1998
+ *
+ * Modifications:
+ * 		Robb Matzke, 1999-04-26
+ *		Made this function safe from overflow problems by allowing it
+ *		to reallocate the output string.
+ *
+ * 		Robb Matzke, 1999-06-04
+ *		Added support for object references. The new `container'
+ *		argument is the dataset where the reference came from.
+ *
+ * 		Robb Matzke, 1999-06-07
+ *		Added support for printing raw data. If info->raw is non-zero
+ *		then data is printed in hexadecimal format.
+ *
+ *-------------------------------------------------------------------------
+ */
+char *
+h5tools_str_sprint(h5tools_str_t *str, const h5dump_t *info, hid_t container,
+                   hid_t type, void *vp, h5tools_context_t *ctx)
+{
+    size_t         n, offset, size, nelmts, start;
+    char          *name, quote = '\0';
+    unsigned char *ucp_vp = (unsigned char *)vp;
+    char          *cp_vp = (char *)vp;
+    hid_t          memb, obj, region;
+    int	           nmembs, otype;
+    static char    fmt_llong[8], fmt_ullong[8];
+    H5T_str_t      pad;
+    H5G_stat_t     sb;
+
+    /*
+     * some tempvars to store the value before we append it to the string to
+     * get rid of the memory alignment problem
+     */
+    double             tempdouble;
+    float              tempfloat;
+    unsigned long_long tempullong;
+    long_long          templlong;
+    unsigned long      tempulong;
+    long               templong;
+    unsigned int       tempuint;
+    int                tempint;
+    unsigned short     tempushort;
+    short              tempshort;
+ 
+    /* Build default formats for long long types */
+    if (!fmt_llong[0]) {
+        sprintf(fmt_llong, "%%%sd", PRINTF_LL_WIDTH);
+        sprintf(fmt_ullong, "%%%su", PRINTF_LL_WIDTH);
+    }
+
+    /* Append value depending on data type */
+    start = h5tools_str_len(str);
+
+    if (info->raw) {
+        size_t i;
+
+        h5tools_str_append(str, "0x");
+        n = H5Tget_size(type);
+
+        for (i = 0; i < n; i++)
+            h5tools_str_append(str, OPT(info->fmt_raw, "%02x"), ucp_vp[i]);
+    } else if (H5Tequal(type, H5T_NATIVE_FLOAT)) {
+        memcpy(&tempfloat, vp, sizeof(float));	
+        h5tools_str_append(str, OPT(info->fmt_float, "%g"), tempfloat);
+    } else if (H5Tequal(type, H5T_NATIVE_DOUBLE)) {
+        memcpy(&tempdouble, vp, sizeof(double)); 
+        h5tools_str_append(str, OPT(info->fmt_double, "%g"), tempdouble);
+    } else if (info->ascii && (H5Tequal(type, H5T_NATIVE_SCHAR) ||
+                               H5Tequal(type, H5T_NATIVE_UCHAR))) {
+        h5tools_print_char(str, info, *ucp_vp);
+    } else if (H5T_STRING == H5Tget_class(type)) {
+        unsigned int i;
+
+        quote = '\0';
+        size = H5Tget_size(type);
+        pad = H5Tget_strpad(type);
+
+        for (i = 0; i < size && (cp_vp[i] != '\0' || pad != H5T_STR_NULLTERM); i++) {
+            int j = 1;
+
+            /*
+             * Count how many times the next character repeats. If the
+             * threshold is zero then that means it can repeat any number
+             * of times.
+             */
+            if (info->str_repeat > 0)
+                while (i + j < size && cp_vp[i] == cp_vp[i + j])
+                    j++;
+            
+            /*
+             * Print the opening quote.  If the repeat count is high enough to
+             * warrant printing the number of repeats instead of enumerating
+             * the characters, then make sure the character to be repeated is
+             * in it's own quote.
+             */
+            if (info->str_repeat > 0 && j > info->str_repeat) {
+                if (quote)
+                    h5tools_str_append(str, "%c", quote);
+
+                quote = '\'';
+                h5tools_str_append(str, "%s%c", i ? " " : "", quote);
+            } else if (!quote) {
+                quote = '"';
+                h5tools_str_append(str, "%s%c", i ? " " : "", quote);
+            }
+                
+            /* Print the character */
+            h5tools_print_char(str, info, ucp_vp[i]);
+            
+            /* Print the repeat count */
+            if (info->str_repeat && j > info->str_repeat) {
+#ifdef REPEAT_VERBOSE
+                h5tools_str_append(str, "%c repeats %d times", quote, j - 1);
+#else
+                h5tools_str_append(str, "%c*%d", quote, j - 1);
+#endif  /* REPEAT_VERBOSE */
+                quote = '\0';
+                i += j - 1;
+            }
+
+        }
+
+        if (quote)
+            h5tools_str_append(str, "%c", quote);
+
+        if (i == 0)
+            /*empty string*/
+            h5tools_str_append(str, "\"\"");
+    } else if (H5Tequal(type, H5T_NATIVE_INT)) {
+        memcpy(&tempint, vp, sizeof(int));
+        h5tools_str_append(str, OPT(info->fmt_int, "%d"), tempint);
+    } else if (H5Tequal(type, H5T_NATIVE_UINT)) {
+        memcpy(&tempuint, vp, sizeof(unsigned int));
+        h5tools_str_append(str, OPT(info->fmt_uint, "%u"), tempuint);
+    } else if (H5Tequal(type, H5T_NATIVE_SCHAR)) {
+        h5tools_str_append(str, OPT(info->fmt_schar, "%d"), *cp_vp);
+    } else if (H5Tequal(type, H5T_NATIVE_UCHAR)) {
+        h5tools_str_append(str, OPT(info->fmt_uchar, "%u"), *ucp_vp);
+    } else if (H5Tequal(type, H5T_NATIVE_SHORT)) {
+        memcpy(&tempshort, vp, sizeof(short));
+        h5tools_str_append(str, OPT(info->fmt_short, "%d"), tempshort);
+    } else if (H5Tequal(type, H5T_NATIVE_USHORT)) {
+        memcpy(&tempushort, vp, sizeof(unsigned short));
+        h5tools_str_append(str, OPT(info->fmt_ushort, "%u"), tempushort);
+    } else if (H5Tequal(type, H5T_NATIVE_LONG)) {
+        memcpy(&templong, vp, sizeof(long));
+        h5tools_str_append(str, OPT(info->fmt_long, "%ld"), templong);
+    } else if (H5Tequal(type, H5T_NATIVE_ULONG)) {
+        memcpy(&tempulong, vp, sizeof(unsigned long));
+        h5tools_str_append(str, OPT(info->fmt_ulong, "%lu"), tempulong);
+    } else if (H5Tequal(type, H5T_NATIVE_LLONG)) {
+        memcpy(&templlong, vp, sizeof(long_long));
+        h5tools_str_append(str, OPT(info->fmt_llong, fmt_llong), templlong);
+    } else if (H5Tequal(type, H5T_NATIVE_ULLONG)) {
+        memcpy(&tempullong, vp, sizeof(unsigned long_long));
+        h5tools_str_append(str, OPT(info->fmt_ullong, fmt_ullong), tempullong);
+    } else if (H5Tequal(type, H5T_NATIVE_HSSIZE)) {
+        if (sizeof(hssize_t) == sizeof(int)) {
+            memcpy(&tempint, vp, sizeof(int));	  
+            h5tools_str_append(str, OPT(info->fmt_int, "%d"), tempint);
+        } else if (sizeof(hssize_t) == sizeof(long)) {
+            memcpy(&templong, vp, sizeof(long));
+            h5tools_str_append(str, OPT(info->fmt_long, "%ld"), templong);
+        } else {
+            memcpy(&templlong, vp, sizeof(long_long));
+            h5tools_str_append(str, OPT(info->fmt_llong, fmt_llong), templlong);
+        }
+    } else if (H5Tequal(type, H5T_NATIVE_HSIZE)) {
+        if (sizeof(hsize_t) == sizeof(int)) {
+            memcpy(&tempuint, vp, sizeof(unsigned int));
+            h5tools_str_append(str, OPT(info->fmt_uint, "%u"), tempuint);
+        } else if (sizeof(hsize_t) == sizeof(long)) {
+            memcpy(&tempulong, vp, sizeof(long));
+            h5tools_str_append(str, OPT(info->fmt_ulong, "%lu"), tempulong);
+        } else {
+            memcpy(&tempullong, vp, sizeof(unsigned long_long));
+            h5tools_str_append(str, OPT(info->fmt_ullong, fmt_ullong), tempullong);
+        }
+    } else if (H5Tget_class(type) == H5T_COMPOUND) {
+        int j;
+
+        nmembs = H5Tget_nmembers(type);
+        h5tools_str_append(str, "%s", OPT(info->cmpd_pre, "{"));
+
+        for (j = 0; j < nmembs; j++) {
+            if (j)
+                h5tools_str_append(str, "%s", OPT(info->cmpd_sep, ", " OPTIONAL_LINE_BREAK));
+
+            /* RPM 2000-10-31
+             * If the previous character is a line-feed (which is true when
+             * h5dump is running) then insert some white space for
+             * indentation. Be warned that column number calculations will be
+             * incorrect and that object indices at the beginning of the line
+             * will be missing (h5dump doesn't display them anyway).  */
+            if (ctx->indent_level >= 0 && str->len && str->s[str->len - 1] == '\n') {
+                int x;
+
+                h5tools_str_append(str, OPT(info->line_pre, ""), "");
+
+                for (x = 0; x < ctx->indent_level + 1; x++)
+                    h5tools_str_append(str, "%s", OPT(info->line_indent, ""));
+            }
+
+            /* The name */
+            name = H5Tget_member_name(type, j);
+            h5tools_str_append(str, OPT(info->cmpd_name, ""), name);
+            free(name);
+
+            /* The value */
+            offset = H5Tget_member_offset(type, j);
+            memb = H5Tget_member_type(type, j);
+
+            ctx->indent_level++;
+            h5tools_str_sprint(str, info, container, memb, cp_vp + offset , ctx);
+            ctx->indent_level--;
+
+            H5Tclose(memb);
+        }
+
+        /* RPM 2000-10-31
+         * If the previous character is a line feed (which is true when
+         * h5dump is running) then insert some white space for indentation.
+         * Be warned that column number calculations will be incorrect and
+         * that object indices at the beginning of the line will be missing
+         * (h5dump doesn't display them anyway). */
+        h5tools_str_append(str, "%s", OPT(info->cmpd_end, ""));
+
+        if (ctx->indent_level >= 0 && str->len && str->s[str->len - 1] == '\n') {
+            int x;
+
+            h5tools_str_append(str, OPT(info->line_pre, ""), "");
+
+            for (x = 0; x < ctx->indent_level; x++)
+                h5tools_str_append(str, "%s", OPT(info->line_indent, ""));
+        }
+
+        h5tools_str_append(str, "%s", OPT(info->cmpd_suf, "}"));
+    } else if (H5Tget_class(type) == H5T_ENUM) {
+        char enum_name[1024];
+
+        if (H5Tenum_nameof(type, vp, enum_name, sizeof enum_name) >= 0) {
+            h5tools_str_append(str, h5tools_escape(enum_name, sizeof(enum_name), TRUE));
+        } else {
+            size_t i;
+
+            h5tools_str_append(str, "0x");
+            n = H5Tget_size(type);
+
+            for (i = 0; i < n; i++)
+                h5tools_str_append(str, "%02x", ucp_vp[i]);
+        }
+    } else if (H5Tequal(type, H5T_STD_REF_DSETREG)) {
+        /*
+         * Dataset region reference -- show the type and OID of the referenced
+         * object, but we are unable to show the region yet because there
+         * isn't enough support in the data space layer.  - rpm 19990604
+         */
+        if (h5tools_is_zero(vp, H5Tget_size(type))) {
+            h5tools_str_append(str, "NULL");
+        } else {
+            obj = H5Rdereference(container, H5R_DATASET_REGION, vp);
+            region = H5Rget_region(container, H5R_DATASET_REGION, vp);
+            H5Gget_objinfo(obj, ".", FALSE, &sb);
+
+            if (info->dset_hidefileno)
+                h5tools_str_append(str, info->dset_format, sb.objno[1], sb.objno[0]);
+            else
+                h5tools_str_append(str, info->dset_format,
+                      sb.fileno[1], sb.fileno[0], sb.objno[1], sb.objno[0]);
+
+            h5tools_str_dump_region(str, region, info);
+            H5Sclose(region);
+            H5Dclose(obj);
+        }
+    } else if (H5Tequal(type, H5T_STD_REF_OBJ)) {
+        /*
+         * Object references -- show the type and OID of the referenced
+         * object.
+         */
+        if (h5tools_is_zero(vp, H5Tget_size(type))) {
+            h5tools_str_append(str, "NULL");
+        } else {
+            otype = H5Rget_object_type(container, vp);
+            obj = H5Rdereference(container, H5R_OBJECT, vp);
+            H5Gget_objinfo(obj, ".", FALSE, &sb);
+
+            /* Print object type and close object */
+            switch (otype) {
+                case H5G_GROUP:
+                    h5tools_str_append(str, GROUPNAME);
+                    H5Gclose(obj);
+                    break;
+                case H5G_DATASET:
+                    h5tools_str_append(str, DATASET);
+                    H5Dclose(obj);
+                    break;
+                case H5G_TYPE:
+                    h5tools_str_append(str, DATATYPE);
+                    H5Tclose(obj);
+                    break;
+                default:
+                    h5tools_str_append(str, "%u-", otype);
+                    break;
+            }
+
+            /* Print OID */
+            if (info->obj_hidefileno) {
+                h5tools_str_append(str, info->obj_format, sb.objno[1], sb.objno[0]);
+            } else {
+                h5tools_str_append(str, info->obj_format,
+                          sb.fileno[1], sb.fileno[0], sb.objno[1], sb.objno[0]);
+            }
+        }
+    } else if (H5Tget_class(type) == H5T_ARRAY) {
+        int k, ndims;
+        hsize_t	i, dims[H5S_MAX_RANK];
+
+        /* Get the array's base datatype for each element */
+        memb = H5Tget_super(type);
+        size = H5Tget_size(memb);
+        ndims = H5Tget_array_ndims(type);
+        H5Tget_array_dims(type, dims, NULL);
+        assert(ndims >= 1 && ndims <= H5S_MAX_RANK);
+
+        /* Calculate the number of array elements */
+        for (k = 0, nelmts = 1; k < ndims; k++)
+            nelmts *= dims[k];
+			
+        /* Print the opening bracket */
+        h5tools_str_append(str, "%s", OPT(info->arr_pre, "["));
+
+        for (i = 0; i < nelmts; i++) {
+            if (i)
+                h5tools_str_append(str, "%s",
+                          OPT(info->arr_sep, "," OPTIONAL_LINE_BREAK));
+
+            if (info->arr_linebreak && i && i % dims[ndims - 1] == 0) {
+                int x;
+
+                h5tools_str_append(str, "%s", "\n");
+
+                /*need to indent some more here*/
+                if (ctx->indent_level >= 0)
+                    h5tools_str_append(str, "%s", OPT(info->line_pre, ""));
+
+                for (x = 0; x < ctx->indent_level + 1; x++)
+                    h5tools_str_append(str,"%s",OPT(info->line_indent,""));
+            } /* end if */
+
+            ctx->indent_level++;
+
+            /* Dump the array element */
+            h5tools_str_sprint(str, info, container, memb, cp_vp + i * size, ctx);
+
+            ctx->indent_level--;
+        } /* end for */
+
+        /* Print the closing bracket */
+ 	h5tools_str_append(str, "%s", OPT(info->arr_suf, "]"));
+        H5Tclose(memb);
+    } else if (H5Tget_class(type) == H5T_VLEN) {
+        unsigned int i;
+
+        /* Get the VL sequences's base datatype for each element */
+        memb = H5Tget_super(type);
+        size = H5Tget_size(memb);
+
+        /* Print the opening bracket */
+        h5tools_str_append(str, "%s", OPT(info->vlen_pre, "("));
+
+        /* Get the number of sequence elements */
+        nelmts = ((hvl_t *)cp_vp)->len;
+
+        for (i = 0; i < nelmts; i++) {
+            if (i)
+                h5tools_str_append(str, "%s",
+                          OPT(info->arr_sep, "," OPTIONAL_LINE_BREAK));
+
+#ifdef LATER
+/* Need to fix so VL data breaks at correct location on end of line -QAK */
+            if (info->arr_linebreak && h5tools_str_len(str)>=info->line_ncols) {
+                int x;
+
+                h5tools_str_append(str, "%s", "\n");
+
+                /* need to indent some more here */
+                if (ctx->indent_level >= 0)
+                    h5tools_str_append(str, "%s", OPT(info->line_pre, ""));
+
+                for (x = 0; x < ctx->indent_level + 1; x++)
+                    h5tools_str_append(str,"%s",OPT(info->line_indent,""));
+            } /* end if */
+#endif /* LATER */
+
+            ctx->indent_level++;
+
+            /* Dump the array element */
+            h5tools_str_sprint(str, info, container, memb,
+                           ((char *)(((hvl_t *)cp_vp)->p)) + i * size, ctx);
+
+            ctx->indent_level--;
+        } /* end for */
+
+        h5tools_str_append(str, "%s", OPT(info->vlen_suf, ")"));
+        H5Tclose(memb);
+    } else {
+        /* All other types get printed as hexadecimal */
+        size_t i;
+
+        h5tools_str_append(str, "0x");
+        n = H5Tget_size(type);
+
+        for (i = 0; i < n; i++)
+            h5tools_str_append(str, "%02x", ucp_vp[i]);
+    }
+
+    return h5tools_str_fmt(str, start, OPT(info->elmt_fmt, "%s"));
+}
+
+/*-------------------------------------------------------------------------
+ * Function:	h5tools_escape
+ *
+ * Purpose:	Changes all "funny" characters in S into standard C escape
+ *		sequences. If ESCAPE_SPACES is non-zero then spaces are
+ *		escaped by prepending a backslash.
+ *
+ * Return:	Success:	S
+ *
+ *		Failure:	NULL if the buffer would overflow. The
+ *				buffer has as many left-to-right escapes as
+ *				possible before overflow would have happened.
+ *
+ * Programmer:	Robb Matzke
+ *              Monday, April 26, 1999
+ *
+ * Modifications:
+ *
+ *-------------------------------------------------------------------------
+ */
+static char *
+h5tools_escape(char *s/*in,out*/, size_t size, int escape_spaces)
+{
+    register size_t i;
+    size_t n = strlen(s);
+    const char *escape;
+    char octal[8];
+    
+    for (i = 0; i < n; i++) {
+	switch (s[i]) {
+	case '"':
+	    escape = "\\\"";
+	    break;
+	case '\\':
+	    escape = "\\\\";
+	    break;
+	case '\b':
+	    escape = "\\b";
+	    break;
+	case '\f':
+	    escape = "\\f";
+	    break;
+	case '\n':
+	    escape = "\\n";
+	    break;
+	case '\r':
+	    escape = "\\r";
+	    break;
+	case '\t':
+	    escape = "\\t";
+	    break;
+	case ' ':
+	    escape = escape_spaces ? "\\ " : NULL;
+	    break;
+	default:
+	    if (!isprint((int)*s)) {
+		sprintf(octal, "\\%03o", (unsigned char)s[i]);
+		escape = octal;
+	    } else {
+		escape = NULL;
+	    }
+
+	    break;
+	}
+
+	if (escape) {
+	    size_t esc_size = strlen(escape);
+
+	    if (n + esc_size + 1 > size)
+		/*would overflow*/
+		return NULL;
+
+	    memmove(s + i + esc_size, s + i, (n - i) + 1); /*make room*/
+	    memcpy(s + i, escape, esc_size); /*insert*/
+	    n += esc_size;
+	    i += esc_size - 1;
+	}
+    }
+
+    return s;
+}
+
+/*-------------------------------------------------------------------------
+ * Function:	h5tools_is_zero
+ *
+ * Purpose:	Determines if memory is initialized to all zero bytes.
+ *
+ * Return:	TRUE if all bytes are zero; FALSE otherwise
+ *
+ * Programmer:	Robb Matzke
+ *              Monday, June  7, 1999
+ *
+ * Modifications:
+ *
+ *-------------------------------------------------------------------------
+ */
+static hbool_t
+h5tools_is_zero(const void *_mem, size_t size)
+{
+    const unsigned char *mem = (const unsigned char *)_mem;
+
+    while (size-- > 0)
+	if (mem[size])
+	    return FALSE;
+
+    return TRUE;
+}
diff --git a/tools/lib/h5tools_str.h b/tools/lib/h5tools_str.h
index 89c3322..58b5ba9 100644
--- a/tools/lib/h5tools_str.h
+++ b/tools/lib/h5tools_str.h
@@ -14,14 +14,19 @@ typedef struct h5tools_str_t {
     size_t	nalloc;		/*allocated size of string	*/
 } h5tools_str_t;
 
-extern void h5tools_str_close(h5tools_str_t *str);
-extern size_t h5tools_str_len(h5tools_str_t *str);
-extern char *h5tools_str_append(h5tools_str_t *str, const char *fmt, ...);
-extern char *h5tools_str_reset(h5tools_str_t *str);
-extern char *h5tools_str_trunc(h5tools_str_t *str, size_t size);
-extern char *h5tools_str_fmt(h5tools_str_t *str, size_t start, const char *fmt);
-extern char *h5tools_str_prefix(h5tools_str_t *str, const h5dump_t *info,
-                                hsize_t elmtno, int ndims, hsize_t min_idx[],
-                                hsize_t max_idx[]);
+extern void     h5tools_str_close(h5tools_str_t *str);
+extern size_t   h5tools_str_len(h5tools_str_t *str);
+extern char    *h5tools_str_append(h5tools_str_t *str, const char *fmt, ...);
+extern char    *h5tools_str_reset(h5tools_str_t *str);
+extern char    *h5tools_str_trunc(h5tools_str_t *str, size_t size);
+extern char    *h5tools_str_fmt(h5tools_str_t *str, size_t start, const char *fmt);
+extern char    *h5tools_str_prefix(h5tools_str_t *str, const h5dump_t *info,
+                                   hsize_t elmtno, int ndims, hsize_t min_idx[],
+                                   hsize_t max_idx[]);
+extern int      h5tools_str_dump_region(h5tools_str_t *, hid_t, const h5dump_t *);
+extern void     h5tools_print_char(h5tools_str_t *, const h5dump_t *, unsigned char);
+extern char    *h5tools_str_sprint(h5tools_str_t *str, const h5dump_t *info,
+                                   hid_t container, hid_t type, void *vp,
+                                   h5tools_context_t *ctx);
 
 #endif  /* H5TOOLS_STR_H__ */