diff --git a/CHANGES b/CHANGES index 9ee9d07..3954841 100644 --- a/CHANGES +++ b/CHANGES @@ -1,16 +1,23 @@ -README - 04/30/2004 +README - 05/01/2004 ------------------- CHANGES IN Mini-XML 2.0 + - Changed the whitespace callback interface to return + strings instead of a single character, allowing for + greater control over the formatting of XML files + written using Mini-XML. THIS CHANGE WILL REQUIRE + CHANGES TO YOUR CODE IF YOU USE WHITESPACE CALLBACKS. + - The mxmldoc utility is now capable of documenting C++ + classes, functions, and structures, and correctly + handles C++ comments. + - Added new modular tests for mxmldoc. - Updated the mxmldoc output to be more compatible with embedding in manuals produced with HTMLDOC. - The makefile incorrectly included a "/" separator between the destination path and install path. This caused problems when building and installing with MingW. - - The mxmldoc utility is now capable of documenting C++ - structures and classes. CHANGES IN Mini-XML 1.3 diff --git a/TODO b/TODO index 8b73e41..7e3e64d 100644 --- a/TODO +++ b/TODO @@ -1,9 +1,6 @@ -TODO - 04/29/2004 +TODO - 05/01/2004 ----------------- - - Update write callback to return a string. - -- Return const char * - -- Loop through chars to figure out correct output column - UTF-16 support. -- Auto-detect in strings via initial FFFE or FEFF BOM -- Convert to UTF-8 @@ -21,10 +18,6 @@ TODO - 04/29/2004 - Add access methods and make node structure opaque. -- To allow for C++ migration -- To make future binary compatibility easier - - Build test file for mxmldoc. - -- C++ class documentation doesn't seem to work. - -- Do examples of all types of comments/code that mxmldoc is - supposed to handle. - Add VC++/VC++.NET project files. -- Include DLL .def file for making a DLL. - Add C++ class/struct. diff --git a/documentation.html b/documentation.html index f5f8b5b..b8fa9ef 100644 --- a/documentation.html +++ b/documentation.html @@ -523,7 +523,7 @@ allocated.

char * mxmlSaveAllocString( mxml_node_t * node, - int (*cb)(mxml_node_t *node, int ws)); + const char * (*cb)(mxml_node_t *node, int ws));

Arguments

@@ -551,7 +551,7 @@ int mxmlSaveFile( mxml_node_t * node, FILE * fp, - int (*cb)(mxml_node_t *node, int ws)); + const char * (*cb)(mxml_node_t *node, int ws));

Arguments

@@ -579,7 +579,7 @@ mxmlSaveString( mxml_node_t * node, char * buffer, int bufsize, - int (*cb)(mxml_node_t *node, int ws)); + const char * (*cb)(mxml_node_t *node, int ws));

Arguments

diff --git a/mxml-file.c b/mxml-file.c index 75a8938..926b2e9 100644 --- a/mxml-file.c +++ b/mxml-file.c @@ -1,5 +1,5 @@ /* - * "$Id: mxml-file.c,v 1.28 2004/04/06 01:47:20 mike Exp $" + * "$Id: mxml-file.c,v 1.29 2004/05/01 15:20:04 mike Exp $" * * File loading code for mini-XML, a small XML-like file parsing library. * @@ -71,13 +71,13 @@ static int mxml_string_putc(int ch, void *p); static int mxml_write_name(const char *s, void *p, int (*putc_cb)(int, void *)); static int mxml_write_node(mxml_node_t *node, void *p, - int (*cb)(mxml_node_t *, int), + const char *(*cb)(mxml_node_t *, int), int col, int (*putc_cb)(int, void *)); static int mxml_write_string(const char *s, void *p, int (*putc_cb)(int, void *)); static int mxml_write_ws(mxml_node_t *node, void *p, - int (*cb)(mxml_node_t *, int), int ws, + const char *(*cb)(mxml_node_t *, int), int ws, int col, int (*putc_cb)(int, void *)); @@ -143,7 +143,7 @@ mxmlLoadString(mxml_node_t *top, /* I - Top node */ char * /* O - Allocated string or NULL */ mxmlSaveAllocString(mxml_node_t *node, /* I - Node to write */ - int (*cb)(mxml_node_t *node, int ws)) + const char *(*cb)(mxml_node_t *node, int ws)) /* I - Whitespace callback or MXML_NO_CALLBACK */ { int bytes; /* Required bytes */ @@ -201,7 +201,7 @@ mxmlSaveAllocString(mxml_node_t *node, /* I - Node to write */ int /* O - 0 on success, -1 on error. */ mxmlSaveFile(mxml_node_t *node, /* I - Node to write */ FILE *fp, /* I - File to write to */ - int (*cb)(mxml_node_t *node, int ws)) + const char *(*cb)(mxml_node_t *node, int ws)) /* I - Whitespace callback or MXML_NO_CALLBACK */ { int col; /* Final column */ @@ -238,7 +238,7 @@ int /* O - Size of string */ mxmlSaveString(mxml_node_t *node, /* I - Node to write */ char *buffer, /* I - String buffer */ int bufsize, /* I - Size of string buffer */ - int (*cb)(mxml_node_t *node, int ws)) + const char *(*cb)(mxml_node_t *node, int ws)) /* I - Whitespace callback or MXML_NO_CALLBACK */ { int col; /* Final column */ @@ -1426,7 +1426,7 @@ mxml_write_name(const char *s, /* I - Name to write */ 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 */ - int (*cb)(mxml_node_t *, int), + const char *(*cb)(mxml_node_t *, int), /* I - Whitespace callback */ int col, /* I - Current column */ int (*putc_cb)(int, void *)) @@ -1699,29 +1699,34 @@ mxml_write_string(const char *s, /* I - String to write */ static int /* O - New column */ mxml_write_ws(mxml_node_t *node, /* I - Current node */ void *p, /* I - Write pointer */ - int (*cb)(mxml_node_t *, int), + const char *(*cb)(mxml_node_t *, int), /* I - Callback function */ int ws, /* I - Where value */ int col, /* I - Current column */ int (*putc_cb)(int, void *)) /* I - Write callback */ { - int ch; /* Whitespace character */ + const char *s; /* Whitespace string */ - if (cb && (ch = (*cb)(node, ws)) != 0) + if (cb && (s = (*cb)(node, ws)) != NULL) { - if ((*putc_cb)(ch, p) < 0) - return (-1); - else if (ch == '\n') - col = 0; - else if (ch == '\t') + while (*s) { - col += MXML_TAB; - col = col - (col % MXML_TAB); + if ((*putc_cb)(*s, p) < 0) + return (-1); + else if (*s == '\n') + col = 0; + else if (*s == '\t') + { + col += MXML_TAB; + col = col - (col % MXML_TAB); + } + else + col ++; + + s ++; } - else - col ++; } return (col); @@ -1729,5 +1734,5 @@ mxml_write_ws(mxml_node_t *node, /* I - Current node */ /* - * End of "$Id: mxml-file.c,v 1.28 2004/04/06 01:47:20 mike Exp $". + * End of "$Id: mxml-file.c,v 1.29 2004/05/01 15:20:04 mike Exp $". */ diff --git a/mxml.h b/mxml.h index 7044563..3087277 100644 --- a/mxml.h +++ b/mxml.h @@ -1,5 +1,5 @@ /* - * "$Id: mxml.h,v 1.17 2004/04/06 01:47:20 mike Exp $" + * "$Id: mxml.h,v 1.18 2004/05/01 15:20:04 mike Exp $" * * Header file for mini-XML, a small XML-like file parsing library. * @@ -160,12 +160,12 @@ __attribute__ ((__format__ (__printf__, 3, 4))) ; extern void mxmlRemove(mxml_node_t *node); extern char *mxmlSaveAllocString(mxml_node_t *node, - int (*cb)(mxml_node_t *, int)); + const char *(*cb)(mxml_node_t *, int)); extern int mxmlSaveFile(mxml_node_t *node, FILE *fp, - int (*cb)(mxml_node_t *, int)); + const char *(*cb)(mxml_node_t *, int)); extern int mxmlSaveString(mxml_node_t *node, char *buffer, int bufsize, - int (*cb)(mxml_node_t *, int)); + const char *(*cb)(mxml_node_t *, int)); extern int mxmlSetElement(mxml_node_t *node, const char *name); extern void mxmlSetErrorCallback(void (*cb)(const char *)); extern int mxmlSetInteger(mxml_node_t *node, int integer); @@ -206,5 +206,5 @@ extern mxml_type_t mxml_real_cb(mxml_node_t *node); /* - * End of "$Id: mxml.h,v 1.17 2004/04/06 01:47:20 mike Exp $". + * End of "$Id: mxml.h,v 1.18 2004/05/01 15:20:04 mike Exp $". */ diff --git a/mxml.xml b/mxml.xml index bbfed65..8e43d70 100644 --- a/mxml.xml +++ b/mxml.xml @@ -1,59 +1,111 @@ -Add a node to a tree. + + Add a node to a tree. Adds the specified node to the parent. If the child argument is not NULL, puts the new node before or after the specified child depending on the value of the where argument. If the child argument is NULL, puts the new node at the beginning of the child list (MXML_ADD_BEFORE) or at the end of the child list (MXML_ADD_AFTER). The constant -MXML_ADD_TO_PARENT can be used to specify a NULL child pointer.mxml_node_t *Parent node -intWhere to add, MXML_ADD_BEFORE or MXML_ADD_AFTER -mxml_node_t *Child node for where or MXML_ADD_TO_PARENT -mxml_node_t *Node to add +MXML_ADD_TO_PARENT can be used to specify a NULL child pointer. + + mxml_node_t * + Parent node + + + int + Where to add, MXML_ADD_BEFORE or MXML_ADD_AFTER + + + mxml_node_t * + Child node for where or MXML_ADD_TO_PARENT + + + mxml_node_t * + Node to add + -Delete a node and all of its children. + + Delete a node and all of its children. If the specified node has a parent, this function first removes the -node from its parent using the mxmlRemove() function.mxml_node_t *Node to delete +node from its parent using the mxmlRemove() function. + + mxml_node_t * + Node to delete + -Attribute value or NULLconst -char * -Get an attribute. + + + Attribute value or NULL + const char * + + Get an attribute. This function returns NULL if the node is not an element or the -named attribute does not exist.mxml_node_t *Element node -const char *Name of attribute +named attribute does not exist. + + mxml_node_t * + Element node + + + const char * + Name of attribute + -Set an attribute. + + Set an attribute. If the named attribute already exists, the value of the attribute is replaced by the new string value. The string value is copied into the element node. This function does nothing if the node is -not an element.mxml_node_t *Element node -const char *Name of attribute -const char *Attribute value +not an element. + + mxml_node_t * + Element node + + + const char * + Name of attribute + + + const char * + Attribute value + -Entity name or NULLconst -char * -Get the name that corresponds to the character value. + + + Entity name or NULL + const char * + + Get the name that corresponds to the character value. -If val does not need to be represented by a named entity, NULL is returned.intCharacter value +If val does not need to be represented by a named entity, NULL is returned. + + int + Character value + -Character value or -1 on errorint -Get the character corresponding to a named entity. + + + Character value or -1 on error + int + + Get the character corresponding to a named entity. The entity name can also be a numeric constant. -1 is returned if the -name is not known.const char *Entity name +name is not known. + + const char * + Entity name + -Element node or NULLmxml_node_t -* -Find the named element. + + + Element node or NULL + mxml_node_t * + + Find the named element. The search is constrained by the name, attribute name, and value; any NULL names or values are treated as wildcards, so different kinds of @@ -62,17 +114,38 @@ or all elements with a specific attribute. The descend argument determines whether the search descends into child nodes; normally you will use MXML_DESCEND_FIRST for the initial search and MXML_NO_DESCEND to find additional direct descendents of the node. The top node argument -constrains the search to a particular node's children.mxml_node_t *Current node -mxml_node_t *Top node -const char *Element name or NULL for any -const char *Attribute name, or NULL for none -const char *Attribute value, or NULL for any -intDescend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST +constrains the search to a particular node's children. + + mxml_node_t * + Current node + + + mxml_node_t * + Top node + + + const char * + Element name or NULL for any + + + const char * + Attribute name, or NULL for none + + + const char * + Attribute value, or NULL for any + + + int + Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST + -First node or NULL if the file could not be read.mxml_node_t -* -Load a file into an XML node tree. + + + First node or NULL if the file could not be read. + mxml_node_t * + + Load a file into an XML node tree. The nodes in the specified file are added to the specified top node. If no top node is provided, the XML file MUST be well-formed with a @@ -83,14 +156,26 @@ MXML_ELEMENT or MXML_TEXT nodes. The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK, MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading -child nodes of the specified type.mxml_node_t *Top node -FILE *File to read from -mxml_type_tCallback function or MXML_NO_CALLBACK +child nodes of the specified type. + + mxml_node_t * + Top node + + + FILE * + File to read from + + + mxml_type_t + Callback function or MXML_NO_CALLBACK + -First node or NULL if the string has errors.mxml_node_t -* -Load a string into an XML node tree. + + + First node or NULL if the string has errors. + mxml_node_t * + + Load a string into an XML node tree. The nodes in the specified string are added to the specified top node. If no top node is provided, the XML string MUST be well-formed with a @@ -101,235 +186,529 @@ MXML_ELEMENT or MXML_TEXT nodes. The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK, MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading -child nodes of the specified type.mxml_node_t *Top node -const char *String to load -mxml_type_tCallback function or MXML_NO_CALLBACK +child nodes of the specified type. + + mxml_node_t * + Top node + + + const char * + String to load + + + mxml_type_t + Callback function or MXML_NO_CALLBACK + -New nodemxml_node_t -* -Create a new element node. + + + New node + mxml_node_t * + + Create a new element node. The new element node is added to the end of the specified parent's child list. The constant MXML_NO_PARENT can be used to specify that the new -element node has no parent.mxml_node_t *Parent node or MXML_NO_PARENT -const char *Name of element +element node has no parent. + + mxml_node_t * + Parent node or MXML_NO_PARENT + + + const char * + Name of element + -New nodemxml_node_t -* -Create a new integer node. + + + New node + mxml_node_t * + + Create a new integer node. The new integer node is added to the end of the specified parent's child list. The constant MXML_NO_PARENT can be used to specify that the new -integer node has no parent.mxml_node_t *Parent node or MXML_NO_PARENT -intInteger value +integer node has no parent. + + mxml_node_t * + Parent node or MXML_NO_PARENT + + + int + Integer value + -New nodemxml_node_t -* -Create a new opaque string. + + + New node + mxml_node_t * + + Create a new opaque string. The new opaque node is added to the end of the specified parent's child list. The constant MXML_NO_PARENT can be used to specify that the new opaque node has no parent. The opaque string must be nul-terminated and -is copied into the new node.mxml_node_t *Parent node or MXML_NO_PARENT -const char *Opaque string +is copied into the new node. + + mxml_node_t * + Parent node or MXML_NO_PARENT + + + const char * + Opaque string + -New nodemxml_node_t -* -Create a new real number node. + + + New node + mxml_node_t * + + Create a new real number node. The new real number node is added to the end of the specified parent's child list. The constant MXML_NO_PARENT can be used to specify that -the new real number node has no parent.mxml_node_t *Parent node or MXML_NO_PARENT -doubleReal number value +the new real number node has no parent. + + mxml_node_t * + Parent node or MXML_NO_PARENT + + + double + Real number value + -New nodemxml_node_t -* -Create a new text fragment node. + + + New node + mxml_node_t * + + Create a new text fragment node. The new text node is added to the end of the specified parent's child list. The constant MXML_NO_PARENT can be used to specify that the new text node has no parent. The whitespace parameter is used to specify whether leading whitespace is present before the node. The text -string must be nul-terminated and is copied into the new node.mxml_node_t *Parent node or MXML_NO_PARENT -int1 = leading whitespace, 0 = no whitespace -const char *String +string must be nul-terminated and is copied into the new node. + + mxml_node_t * + Parent node or MXML_NO_PARENT + + + int + 1 = leading whitespace, 0 = no whitespace + + + const char * + String + -New nodemxml_node_t -* -Create a new formatted text fragment node. + + + New node + mxml_node_t * + + Create a new formatted text fragment node. The new text node is added to the end of the specified parent's child list. The constant MXML_NO_PARENT can be used to specify that the new text node has no parent. The whitespace parameter is used to specify whether leading whitespace is present before the node. The format -string must be nul-terminated and is formatted into the new node.mxml_node_t *Parent node or MXML_NO_PARENT -int1 = leading whitespace, 0 = no whitespace -const char *Printf-style frmat string -Additional args as needed +string must be nul-terminated and is formatted into the new node. + + mxml_node_t * + Parent node or MXML_NO_PARENT + + + int + 1 = leading whitespace, 0 = no whitespace + + + const char * + Printf-style frmat string + + + Additional args as needed + -Remove a node from its parent. + + Remove a node from its parent. Does not free memory used by the node - use mxmlDelete() for that. -This function does nothing if the node has no parent.mxml_node_t *Node to remove +This function does nothing if the node has no parent. + + mxml_node_t * + Node to remove + -Allocated string or NULLchar -* -Save an XML node tree to an allocated string. + + + Allocated string or NULL + char * + + Save an XML node tree to an allocated string. This function returns a pointer to a string containing the textual representation of the XML node tree. The string should be freed using the free() function when you are done with it. NULL is returned if the node would produce an empty string or if the string cannot be -allocated.mxml_node_t *Node to write -intWhitespace callback or MXML_NO_CALLBACK +allocated. + + mxml_node_t * + Node to write + + + const char * + Whitespace callback or MXML_NO_CALLBACK + -0 on success, -1 on error.int -Save an XML tree to a file. + + + 0 on success, -1 on error. + int + + Save an XML tree to a file. The callback argument specifies a function that returns a whitespace character or nul (0) before and after each element. If MXML_NO_CALLBACK is specified, whitespace will only be added before MXML_TEXT nodes with leading whitespace and before attribute names inside opening -element tags.mxml_node_t *Node to write -FILE *File to write to -intWhitespace callback or MXML_NO_CALLBACK +element tags. + + mxml_node_t * + Node to write + + + FILE * + File to write to + + + const char * + Whitespace callback or MXML_NO_CALLBACK + -Size of stringint -Save an XML node tree to a string. + + + Size of string + int + + Save an XML node tree to a string. This function returns the total number of bytes that would be required for the string but only copies (bufsize - 1) characters -into the specified buffer.mxml_node_t *Node to write -char *String buffer -intSize of string buffer -intWhitespace callback or MXML_NO_CALLBACK +into the specified buffer. + + mxml_node_t * + Node to write + + + char * + String buffer + + + int + Size of string buffer + + + const char * + Whitespace callback or MXML_NO_CALLBACK + -0 on success, -1 on failureint -Set the name of an element node. + + + 0 on success, -1 on failure + int + + Set the name of an element node. -The node is not changed if it is not an element node.mxml_node_t *Node to set -const char *New name string +The node is not changed if it is not an element node. + + mxml_node_t * + Node to set + + + const char * + New name string + -Set the error message callback.voidError callback function + + Set the error message callback. + + void + Error callback function + -0 on success, -1 on failureint -Set the value of an integer node. + + + 0 on success, -1 on failure + int + + Set the value of an integer node. -The node is not changed if it is not an integer node.mxml_node_t *Node to set -intInteger value +The node is not changed if it is not an integer node. + + mxml_node_t * + Node to set + + + int + Integer value + -0 on success, -1 on failureint -Set the value of an opaque node. + + + 0 on success, -1 on failure + int + + Set the value of an opaque node. -The node is not changed if it is not an opaque node.mxml_node_t *Node to set -const char *Opaque string +The node is not changed if it is not an opaque node. + + mxml_node_t * + Node to set + + + const char * + Opaque string + -0 on success, -1 on failureint -Set the value of a real number node. + + + 0 on success, -1 on failure + int + + Set the value of a real number node. -The node is not changed if it is not a real number node.mxml_node_t *Node to set -doubleReal number value +The node is not changed if it is not a real number node. + + mxml_node_t * + Node to set + + + double + Real number value + -0 on success, -1 on failureint -Set the value of a text node. + + + 0 on success, -1 on failure + int + + Set the value of a text node. -The node is not changed if it is not a text node.mxml_node_t *Node to set -int1 = leading whitespace, 0 = no whitespace -const char *String +The node is not changed if it is not a text node. + + mxml_node_t * + Node to set + + + int + 1 = leading whitespace, 0 = no whitespace + + + const char * + String + -0 on success, -1 on failureint -Set the value of a text node to a formatted string. + + + 0 on success, -1 on failure + int + + Set the value of a text node to a formatted string. -The node is not changed if it is not a text node.mxml_node_t *Node to set -int1 = leading whitespace, 0 = no whitespace -const char *Printf-style format string -Additional arguments as needed +The node is not changed if it is not a text node. + + mxml_node_t * + Node to set + + + int + 1 = leading whitespace, 0 = no whitespace + + + const char * + Printf-style format string + + + Additional arguments as needed + -Next node or NULLmxml_node_t -* -Walk to the next logical node in the tree. + + + Next node or NULL + mxml_node_t * + + Walk to the next logical node in the tree. The descend argument controls whether the first child is considered to be the next node. The top node argument constrains the walk to -the node's children.mxml_node_t *Current node -mxml_node_t *Top node -intDescend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST +the node's children. + + mxml_node_t * + Current node + + + mxml_node_t * + Top node + + + int + Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST + -Previous node or NULLmxml_node_t -* -Walk to the previous logical node in the tree. + + + Previous node or NULL + mxml_node_t * + + Walk to the previous logical node in the tree. The descend argument controls whether the previous node's last child is considered to be the previous node. The top node argument constrains -the walk to the node's children.mxml_node_t *Current node -mxml_node_t *Top node -intDescend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST +the walk to the node's children. + + mxml_node_t * + Current node + + + mxml_node_t * + Top node + + + int + Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST + -An XML element attribute value.char *Attribute name -char *Attribute value + + An XML element attribute value. + + char * + Attribute name + + + char * + Attribute value + -An XML element attribute value.struct -mxml_attr_s -An XML element value.struct -mxml_value_s -An XML node.struct mxml_node_s *First child node -struct mxml_node_s *Last child node -struct mxml_node_s *Next node under same parent -struct mxml_node_s *Parent node -struct mxml_node_s *Previous node under same parent -mxml_type_tNode type -mxml_value_tNode value + + An XML element attribute value. + struct mxml_attr_s + + + An XML element value. + struct mxml_value_s + + + An XML node. + + struct mxml_node_s * + First child node + + + struct mxml_node_s * + Last child node + + + struct mxml_node_s * + Next node under same parent + + + struct mxml_node_s * + Parent node + + + struct mxml_node_s * + Previous node under same parent + + + mxml_type_t + Node type + + + mxml_value_t + Node value + -An XML node.struct -mxml_node_s -An XML text value.char *Fragment string -intLeading whitespace? + + An XML node. + struct mxml_node_s + + + An XML text value. + + char * + Fragment string + + + int + Leading whitespace? + -An XML text value.struct -mxml_text_s -The XML node type.XML element with attributes -Integer value -Opaque string -Real value -Text fragment + + An XML text value. + struct mxml_text_s + + + The XML node type. + + XML element with attributes + + + Integer value + + + Opaque string + + + Real value + + + Text fragment + -The XML node type.enum -mxml_type_e -An XML element value.mxml_attr_t *Attributes -char *Name of element -intNumber of attributes + + The XML node type. + enum mxml_type_e + + + An XML element value. + + mxml_attr_t * + Attributes + + + char * + Name of element + + + int + Number of attributes + -An XML node value.union -mxml_value_u -An XML node value.mxml_element_tElement -intInteger number -char *Opaque string -doubleReal number -mxml_text_tText fragment + + An XML node value. + union mxml_value_u + + + An XML node value. + + mxml_element_t + Element + + + int + Integer number + + + char * + Opaque string + + + double + Real number + + + mxml_text_t + Text fragment + diff --git a/mxmldoc.c b/mxmldoc.c index 2d3e598..4189107 100644 --- a/mxmldoc.c +++ b/mxmldoc.c @@ -1,5 +1,5 @@ /* - * "$Id: mxmldoc.c,v 1.32 2004/05/01 07:08:14 mike Exp $" + * "$Id: mxmldoc.c,v 1.33 2004/05/01 15:20:05 mike Exp $" * * Documentation generator using mini-XML, a small XML-like file parsing * library. @@ -135,7 +135,7 @@ static void update_comment(mxml_node_t *parent, static void write_documentation(mxml_node_t *doc); static void write_element(mxml_node_t *doc, mxml_node_t *element); static void write_string(const char *s); -static int ws_cb(mxml_node_t *node, int where); +static const char *ws_cb(mxml_node_t *node, int where); /* @@ -2628,27 +2628,74 @@ write_string(const char *s) /* I - String to write */ * 'ws_cb()' - Whitespace callback for saving. */ -static int /* O - Whitespace char or 0 for none */ +static const char * /* O - Whitespace string or NULL for none */ ws_cb(mxml_node_t *node, /* I - Element node */ int where) /* I - Where value */ { - const char *name; /* Name of element */ + const char *name; /* Name of element */ + int depth; /* Depth of node */ + static const char *spaces = " "; + /* Whitespace (40 spaces) for indent */ name = node->value.element.name; - if ((!strcmp(name, "namespace") || !strcmp(name, "enumeration") || - !strcmp(name, "typedef") || !strcmp(name, "function") || - !strcmp(name, "variable") || !strcmp(name, "struct") || - !strcmp(name, "class") || !strcmp(name, "constant") || - !strcmp(name, "argument") || !strcmp(name, "returnvalue")) && - where == MXML_WS_AFTER_CLOSE) - return ('\n'); + switch (where) + { + case MXML_WS_BEFORE_CLOSE : + if (strcmp(name, "argument") && + strcmp(name, "class") && + strcmp(name, "constant") && + strcmp(name, "enumeration") && + strcmp(name, "function") && + strcmp(name, "namespace") && + strcmp(name, "returnvalue") && + strcmp(name, "struct") && + strcmp(name, "typedef") && + strcmp(name, "union") && + strcmp(name, "variable")) + return (NULL); + + for (depth = -4; node; node = node->parent, depth += 2); + if (depth > 40) + return (spaces); + else if (depth < 2) + return (NULL); + else + return (spaces + 40 - depth); - return (0); + case MXML_WS_AFTER_CLOSE : + return ("\n"); + + case MXML_WS_BEFORE_OPEN : + for (depth = -4; node; node = node->parent, depth += 2); + if (depth > 40) + return (spaces); + else if (depth < 2) + return (NULL); + else + return (spaces + 40 - depth); + + default : + case MXML_WS_AFTER_OPEN : + if (strcmp(name, "argument") && + strcmp(name, "class") && + strcmp(name, "constant") && + strcmp(name, "enumeration") && + strcmp(name, "function") && + strcmp(name, "namespace") && + strcmp(name, "returnvalue") && + strcmp(name, "struct") && + strcmp(name, "typedef") && + strcmp(name, "union") && + strcmp(name, "variable")) + return (NULL); + else + return ("\n"); + } } /* - * End of "$Id: mxmldoc.c,v 1.32 2004/05/01 07:08:14 mike Exp $". + * End of "$Id: mxmldoc.c,v 1.33 2004/05/01 15:20:05 mike Exp $". */ diff --git a/testmxml.c b/testmxml.c index 3f09e60..89816b3 100644 --- a/testmxml.c +++ b/testmxml.c @@ -1,5 +1,5 @@ /* - * "$Id: testmxml.c,v 1.14 2004/04/06 01:47:20 mike Exp $" + * "$Id: testmxml.c,v 1.15 2004/05/01 15:20:05 mike Exp $" * * Test program for mini-XML, a small XML-like file parsing library. * @@ -36,7 +36,7 @@ */ mxml_type_t type_cb(mxml_node_t *node); -int whitespace_cb(mxml_node_t *node, int where); +const char *whitespace_cb(mxml_node_t *node, int where); /* @@ -377,7 +377,7 @@ type_cb(mxml_node_t *node) /* I - Element node */ * newlines and tabs... */ -int /* O - Whitespace char or 0 */ +const char * /* O - Whitespace string or NULL */ whitespace_cb(mxml_node_t *node, /* I - Element node */ int where) /* I - Open or close tag? */ { @@ -400,7 +400,7 @@ whitespace_cb(mxml_node_t *node, /* I - Element node */ */ if (where == MXML_WS_BEFORE_OPEN || where == MXML_WS_AFTER_CLOSE) - return ('\n'); + return ("\n"); } else if (!strcmp(name, "dl") || !strcmp(name, "ol") || !strcmp(name, "ul")) { @@ -408,7 +408,7 @@ whitespace_cb(mxml_node_t *node, /* I - Element node */ * Put a newline before and after list elements... */ - return ('\n'); + return ("\n"); } else if (!strcmp(name, "dd") || !strcmp(name, "dt") || !strcmp(name, "li")) { @@ -417,19 +417,19 @@ whitespace_cb(mxml_node_t *node, /* I - Element node */ */ if (where == MXML_WS_BEFORE_OPEN) - return ('\t'); + return ("\t"); else if (where == MXML_WS_AFTER_CLOSE) - return ('\n'); + return ("\n"); } /* - * Return 0 for no added whitespace... + * Return NULL for no added whitespace... */ - return (0); + return (NULL); } /* - * End of "$Id: testmxml.c,v 1.14 2004/04/06 01:47:20 mike Exp $". + * End of "$Id: testmxml.c,v 1.15 2004/05/01 15:20:05 mike Exp $". */