diff --git a/CHANGES b/CHANGES index 72c5a06..2456a17 100644 --- a/CHANGES +++ b/CHANGES @@ -1,11 +1,12 @@ -README - 06/05/2003 +README - 06/07/2003 ------------------- CHANGES IN Mini-XML 0.94 - - The mxmldoc program now handles function arguments - properly. + - The mxmldoc program now handles function arguments, + structures, unions, enumerations, classes, and + typedefs properly. Finally some documentation... CHANGES IN Mini-XML 0.93 diff --git a/documentation.html b/documentation.html index d23803d..9142a11 100644 --- a/documentation.html +++ b/documentation.html @@ -9,7 +9,36 @@ -->
-Node Type
+Name | Description |
---|---|
MXML_ELEMENT | XML element with attributes |
MXML_INTEGER | Integer value |
MXML_OPAQUE | Opaque string |
MXML_REAL | Real value |
MXML_TEXT | Text fragment |
Add a node to a tree.
+Local functions...
void @@ -136,7 +165,7 @@ mxmlFindElement(Element node or NULL
mxmlLoadFile()
-Load a file into an XML node tree.
+mxml_node_t *Top nodeFILE *File to read frommxml_type_tCallback functionNew nodemxml_node_t *Create a new element node.mxml_node_t *Parent nodeconst char *Name of elementNew nodemxml_node_t *Create a new integer node.mxml_node_t *Parent nodeintInteger valueNew nodemxml_node_t *Create a new opaque string.mxml_node_t *Parent nodeconst char *Opaque stringNew nodemxml_node_t *Create a new real number node.mxml_node_t *Parent nodedoubleReal number valueNew nodemxml_node_t *Create a new text fragment node.mxml_node_t *Parent nodeintLeading whitespace?const char *StringRemove a node from its parent.mxml_node_t *Node to remove0 on success, -1 on errorintSave an XML tree to a file.mxml_node_t *Node to writeFILE *File to write tointWhitespace callbackNext node or NULLmxml_node_t *Walk to the next logical node in the tree.mxml_node_t *Current nodemxml_node_t *Top nodeintDescend into tree?Previous node or NULLmxml_node_t *Walk to the previous logical node in the tree.mxml_node_t *Current nodemxml_node_t *Top nodeintDescend into tree?Data types...char *Attribute namechar *Attribute valuestruct mxml_attr_sstruct mxml_value_smxml_node_t *First child nodemxml_node_t *Last child nodemxml_node_t *Next node under same parentmxml_node_t *Parent nodemxml_node_t *Previous node under same parentmxml_type_tNode typemxml_value_tNode valuechar *Fragment stringintLeading whitespace?struct mxml_text_sNode TypeXML element with attributesInteger valueOpaque stringReal valueText fragmentAttribute ValueElement ValueText ValueNode ValueNodeC++ support...Prototypes...C++ support...End of "$Id: documentation.html,v 1.3 2003/06/07 21:27:05 mike Exp $".enum mxml_type_emxml_attr_t *Attributeschar *Name of elementintNumber of attributesunion mxml_value_umxml_element_tElementintInteger numberchar *Opaque stringdoubleReal numbermxml_text_tText fragmentmxml_node_t *Current nodemxml_node_t *Parent nodeNode typeconst char *String to writeFile to write toint(*cb)(mxml_node_t *int) intWhere valueCurrent column
Syntax
mxml_node_t * @@ -154,7 +183,7 @@ mxmlLoadFile((*cb)(mxml_node_t *) Callback function Returns
-First node
+Local functions...
mxmlNewElement()
Create a new element node.
@@ -332,5 +361,162 @@ mxmlWalkPrev(Returns
Previous node or NULL
+Structures
+
Data types...
++struct mxml_attr_s +{ + char * name; + char * value; +}; ++
Name | Description |
---|---|
name | Attribute name |
value | Attribute value |
mxml_node_t *First child nodemxml_node_t *Last child nodemxml_node_t *Next node under same parentmxml_node_t *Parent nodemxml_node_t *Previous node under same parentmxml_type_tNode typemxml_value_tNode valuechar *Fragment stringintLeading whitespace?struct mxml_text_sNode TypeXML element with attributesInteger valueOpaque stringReal valueText fragmentAttribute ValueElement ValueText ValueNode ValueNodeC++ support...Prototypes...C++ support...End of "$Id: documentation.html,v 1.3 2003/06/07 21:27:05 mike Exp $".enum mxml_type_emxml_attr_t *Attributeschar *Name of elementintNumber of attributesunion mxml_value_umxml_element_tElementintInteger numberchar *Opaque stringdoubleReal numbermxml_text_tText fragmentmxml_node_t *Current nodemxml_node_t *Parent nodeNode typeconst char *String to writeFile to write toint(*cb)(mxml_node_t *int) intWhere valueCurrent column
++struct mxml_node_s +{ + mxml_node_t * child; + mxml_node_t * last_child; + mxml_node_t * next; + mxml_node_t * parent; + mxml_node_t * prev; + mxml_type_t type; + mxml_value_t value; +}; ++
Name | Description |
---|---|
child | First child node |
last_child | Last child node |
next | Next node under same parent |
parent | Parent node |
prev | Previous node under same parent |
type | Node type |
value | Node value |
char *Fragment stringintLeading whitespace?struct mxml_text_sNode TypeXML element with attributesInteger valueOpaque stringReal valueText fragmentAttribute ValueElement ValueText ValueNode ValueNodeC++ support...Prototypes...C++ support...End of "$Id: documentation.html,v 1.3 2003/06/07 21:27:05 mike Exp $".enum mxml_type_emxml_attr_t *Attributeschar *Name of elementintNumber of attributesunion mxml_value_umxml_element_tElementintInteger numberchar *Opaque stringdoubleReal numbermxml_text_tText fragmentmxml_node_t *Current nodemxml_node_t *Parent nodeNode typeconst char *String to writeFile to write toint(*cb)(mxml_node_t *int) intWhere valueCurrent column
++struct mxml_text_s +{ + char * string; + int whitespace; +}; ++
Name | Description |
---|---|
string | Fragment string |
whitespace | Leading whitespace? |
mxml_attr_t *Attributeschar *Name of elementintNumber of attributesunion mxml_value_umxml_element_tElementintInteger numberchar *Opaque stringdoubleReal numbermxml_text_tText fragmentmxml_node_t *Current nodemxml_node_t *Parent nodeNode typeconst char *String to writeFile to write toint(*cb)(mxml_node_t *int) intWhere valueCurrent column
++struct mxml_value_s +{ + mxml_attr_t * attrs; + char * name; + int num_attrs; +}; ++
Name | Description |
---|---|
attrs | Attributes |
name | Name of element |
num_attrs | Number of attributes |
+typedef struct mxml_attr_s mxml_attr_t; ++
+typedef struct mxml_value_s mxml_element_t; ++
+typedef struct mxml_text_s mxml_text_t; ++
+typedef enum mxml_type_e mxml_type_t; ++
+typedef union mxml_value_u mxml_value_t; ++
mxml_element_tElementintInteger numberchar *Opaque stringdoubleReal numbermxml_text_tText fragmentmxml_node_t *Current nodemxml_node_t *Parent nodeNode typeconst char *String to writeFile to write toint(*cb)(mxml_node_t *int) intWhere valueCurrent column
++struct mxml_value_u +{ + mxml_element_t element; + int integer; + char * opaque; + double real; + mxml_text_t text; +}; ++
Name | Description |
---|---|
element | Element |
integer | Integer number |
opaque | Opaque string |
real | Real number |
text | Text fragment |