Version: 2.5 Original reporter: Michael Sweet

1) When disabling line wrapping by calling mxmlSetWrapMargin(0) then calling mxmlSaveString() or mxmlSaveAllocString() will result in errors.

2) When setting line wrapping by calling, for example, mxmlSetWrapMargin(1024) then calling mxmlSaveString() or mxmlSaveAllocString() to get a string representation, newlines have been added much earlier in the string than 1024. The wrapping doesn't seem to change based on the mxmlSetWrapMargin() call.

Here is the sample program I used for testing:

include

include "mxml.h"

void error_cb (const char *string) { fprintf (stderr, "ERROR: %s\n", string); }

const char whitespace_cb (mxml_node_t node, int where) { return NULL; }

int main (int argc, char *argv) { mxml_node_t xmldoc;
mxml_node_t node; char xmlstr; char xmlbuf[8192]; int rv;

mxmlSetErrorCallback (error_cb);

// This does not work, errors will be returned from the mxmlSave* routines mxmlSetWrapMargin (0);

// This does not work, strings are wrapped early? //mxmlSetWrapMargin (1024);

xmldoc = mxmlNewXML ("1.0");

node = mxmlNewElement (xmldoc, "Root");

mxmlElementSetAttr (node, "Attribute", "Value");

if ( ! (rv = mxmlSaveString (xmldoc, xmlbuf, sizeof(xmlbuf), whitespace_cb)) ) { fprintf (stderr, "Error converting to XML\n"); return 1; } printf ("Return value :%d\n", rv); printf ("%s\n", xmlbuf);

if ( ! (xmlstr = mxmlSaveAllocString (xmldoc, whitespace_cb)) ) { fprintf (stderr, "Error converting to XML\n"); return 1; } printf ("%s\n", xmlstr);

mxmlRelease (xmldoc);

if ( xmlstr ) free (xmlstr);

return 0; }

Original reporter: Michael Sweet

The errors seem to be related to the usage of mxmlNewXML() and the initial standard XML element: <?xml version="1.0"?>.

If I create a root element using mxmlNewElement(MXML_NO_PARENT,...) instead, the usage of mxmlSetWrapMargin(0) does not cause errors. The example program still outputs wrapped XML when, for example, mxmlSetWrapMargin(1024) is called.

Original reporter: Michael Sweet

For STR #76, error occurs when mxmlSetWrapMargin(0):

This problem is original from: mxml_write_node(), which prefers newline for <?xml ?> line, and force col = global->wrap, col is easy to overflow if global->wrap = 2147483647.

It is easy to patch the bug, we need only to modify mxml_write_node() as follows: /==============================================================================/

'mxml_write_node()' - Save an XML node to a file. */

static int / O - Column or -1 on error / mxml_write_node(mxml_node_t node, / I - Node to write / void p, / I - File to write to / mxml_save_cb_t cb, / I - Whitespace callback / int col, / I - Current column / _mxml_putc_cb_t putc_cb,/ I - Output callback / _mxml_global_t global)/ I - Global data / { int i, / Looping var / width; / Width of attr + value / mxml_attr_t attr; / Current attribute / char s[255]; / Temporary string /

while (node != NULL) { /*

Print the node value... */

switch (node->type) { case MXML_ELEMENT : col = mxml_write_ws(node, p, cb, MXML_WS_BEFORE_OPEN, col, putc_cb);
```
  if ((*putc_cb)('<', p) < 0)
return (-1);
  if (node->value.element.name[0] == '?' ||
  !strncmp(node->value.element.name, "!--", 3) ||
  !strncmp(node->value.element.name, "![CDATA[", 8))
  {
```
/*
- Comments, CDATA, and processing instructions do not
- use character entities. */
  
  const char ptr; / Pointer into name */
  
  for (ptr = node->value.element.name; ptr; ptr ++) if ((putc_cb)(*ptr, p) < 0) return (-1);
  
  } else if (mxml_write_name(node->value.element.name, p, putc_cb) < 0) return (-1);
  
  col += strlen(node->value.element.name) + 1;
  
  for (i = node->value.element.num_attrs, attr = node->value.element.attrs; i > 0; i --, attr ++) { width = strlen(attr->name);
  
  if (attr->value) width += strlen(attr->value) + 3;
  
  if ((col + width) > global->wrap) { if ((*putc_cb)('\n', p) < 0) return (-1);
  
  col = 0; } else { if ((*putc_cb)(' ', p) < 0) return (-1);
  
  col ++; }
```
if (mxml_write_name(attr->name, p, putc_cb) < 0)
```
  return (-1);
  
  if (attr->value) { if ((putc_cb)('=', p) < 0) return (-1); if ((putc_cb)('\"', p) < 0) return (-1); if (mxml_write_string(attr->value, p, putc_cb) < 0) return (-1); if ((*putc_cb)('\"', p) < 0) return (-1); }
```
col += width;
```
  }
  
  if (node->child) { /*
- Write children... */
  
  if ((*putc_cb)('>', p) < 0) return (-1); else col ++;
```
col = mxml_write_ws(node, p, cb, MXML_WS_AFTER_OPEN, col, putc_cb);

if(col > 0 && !strncmp(node->value.element.name, "?xml", 4))
{
  if ((*putc_cb)('\n', p) < 0)
  return (-1); /* prefer a newline after ?xml... */

  col = 0;
} /* patched by Q.S. Luo, Mar. 2008 */
```
  if ((col = mxml_write_node(node->child, p, cb, col, putc_cb, global)) < 0) return (-1);
  
  /*
- The ? and ! elements are special-cases and have no end tags... */
```
if (node->value.element.name[0] != '!' &&
node->value.element.name[0] != '?')
```
  { col = mxml_write_ws(node, p, cb, MXML_WS_BEFORE_CLOSE, col, putc_cb);
```
  if ((*putc_cb)('<', p) < 0)
```
  return (-1); if ((putc_cb)('/', p) < 0) return (-1); if (mxml_write_string(node->value.element.name, p, putc_cb) < 0) return (-1); if ((putc_cb)('>', p) < 0) return (-1);
```
  col += strlen(node->value.element.name) + 3;

  col = mxml_write_ws(node, p, cb, MXML_WS_AFTER_CLOSE, col, putc_cb);
```
  } } else if (node->value.element.name[0] == '!' || node->value.element.name[0] == '?') { /*
- The ? and ! elements are special-cases... */
  
  if ((*putc_cb)('>', p) < 0) return (-1); else col ++;
```
col = mxml_write_ws(node, p, cb, MXML_WS_AFTER_OPEN, col, putc_cb);

if(col > 0 && !strncmp(node->value.element.name, "?xml", 4))
{ 
  if ((*putc_cb)('\n', p) < 0)
  return (-1); /* prefer a newline after ?xml... */

  col = 0;
} /* patched by Q.S. Luo, Mar. 2008 */
```
  } else { if ((putc_cb)(' ', p) < 0) return (-1); if ((putc_cb)('/', p) < 0) return (-1); if ((*putc_cb)('>', p) < 0) return (-1);
  
  col += 3;
```
col = mxml_write_ws(node, p, cb, MXML_WS_AFTER_OPEN, col, putc_cb);
```
  } break;
  
  case MXML_INTEGER : if (node->prev) { if (col > global->wrap) { if ((*putc_cb)('\n', p) < 0) return (-1);
  
  col = 0; } else if ((*putc_cb)(' ', p) < 0) return (-1); else col ++; }
  
  sprintf(s, "%d", node->value.integer); if (mxml_write_string(s, p, putc_cb) < 0) return (-1);
  
  col += strlen(s); break;
  
  case MXML_OPAQUE : if (mxml_write_string(node->value.opaque, p, putc_cb) < 0) return (-1);
  
  col += strlen(node->value.opaque); break;
  
  case MXML_REAL : if (node->prev) { if (col > global->wrap) { if ((*putc_cb)('\n', p) < 0) return (-1);
  
  col = 0; } else if ((*putc_cb)(' ', p) < 0) return (-1); else col ++; }
  
  sprintf(s, "%f", node->value.real); if (mxml_write_string(s, p, putc_cb) < 0) return (-1);
  
  col += strlen(s); break;
  
  case MXML_TEXT : if (node->value.text.whitespace && col > 0) { if (col > global->wrap) { if ((*putc_cb)('\n', p) < 0) return (-1);
  
  col = 0; } else if ((*putc_cb)(' ', p) < 0) return (-1); else col ++; }
  
  if (mxml_write_string(node->value.text.string, p, putc_cb) < 0) return (-1);
  
  col += strlen(node->value.text.string); break;
  
  case MXML_CUSTOM : if (global->custom_save_cb) { char data; / Custom data string / const char newline; / Last newline in string /
```
if ((data = (*global->custom_save_cb)(node)) == NULL)
```
  return (-1);
```
if (mxml_write_string(data, p, putc_cb) < 0)
```
  return (-1);
```
if ((newline = strrchr(data, '\n')) == NULL)
```
  col += strlen(data); else col = strlen(newline);
```
free(data);
```
  break; }
  
  default : / Should never happen / return (-1); }
/*
Next node... */

node = node->next; }

return (col); }

Original reporter: Michael Sweet

See attached patch...

Original reporter: Michael Sweet

Fixed in Subversion repository.

"str76.patch":

Index: mxml-file.c
===================================================================
--- mxml-file.c (revision 350)
+++ mxml-file.c (working copy)
@@ -606,22 +606,19 @@
 /*
  * 'mxmlSetWrapMargin()' - Set the the wrap margin when saving XML data.
  *
- * Wrapping is disabled when "column" is <= 0.
+ * Wrapping is disabled when "column" is 0.
  *
  * @since Mini-XML 2.3@
  */

 void
-mxmlSetWrapMargin(int column)      /* I - Column for wrapping */
+mxmlSetWrapMargin(int column)      /* I - Column for wrapping, 0 to disable wrapping */
 {
   _mxml_global_t *global = _mxml_global();
                    /* Global data */

-  if (column <= 0)
-    global->wrap = 2147483647;
-  else
-    global->wrap = column;
+  global->wrap = column;
 }

@@ -2804,13 +2801,6 @@
        for (ptr = node->value.element.name; *ptr; ptr ++)
          if ((*putc_cb)(*ptr, p) < 0)
            return (-1);
-
-           /*
-       * Prefer a newline for whitespace after ?xml...
-       */
-
-            if (!strncmp(node->value.element.name, "?xml", 4))
-              col = global->wrap;
      }
      else if (mxml_write_name(node->value.element.name, p, putc_cb) < 0)
        return (-1);
@@ -2826,7 +2816,7 @@
        if (attr->value)
          width += strlen(attr->value) + 3;

-       if ((col + width) > global->wrap)
+       if (global->wrap > 0 && (col + width) > global->wrap)
        {
          if ((*putc_cb)('\n', p) < 0)
            return (-1);
@@ -2931,7 +2921,7 @@
       case MXML_INTEGER :
      if (node->prev)
      {
-       if (col > global->wrap)
+       if (global->wrap > 0 && col > global->wrap)
        {
          if ((*putc_cb)('\n', p) < 0)
            return (-1);
@@ -2961,7 +2951,7 @@
       case MXML_REAL :
      if (node->prev)
      {
-       if (col > global->wrap)
+       if (global->wrap > 0 && col > global->wrap)
        {
          if ((*putc_cb)('\n', p) < 0)
            return (-1);
@@ -2984,7 +2974,7 @@
       case MXML_TEXT :
      if (node->value.text.whitespace && col > 0)
      {
-       if (col > global->wrap)
+       if (global->wrap > 0 && col > global->wrap)
        {
          if ((*putc_cb)('\n', p) < 0)
            return (-1);

michaelrsweet / mxml

mxmlSetWrapMargin causes errors and does not work properly #76

include

include

include

include "mxml.h"