Added function to find element and imp

roved tests

Author: Velli20

README.md

@@ -1,95 +1,100 @@
 # XML-parser
-Work in progress. Lightweight xml-parser with minimal system requirements.
+
+Work in progress. Lightweight xml-parser for microcontrollers.
 
 
 # Usage
 
-Example program:
+Example of parsing string:
 
 ```c
-static const PARSER_XML_NAME elements[]=
-{
-	// Predefined element and attribute names.
-
-	{ "ELEM_type_1"     },
-	{ "ELEM_type_2"     },
-	{ "ELEM_type_3"     },
+// List of element and attribute names in test string.
 
-	{ "testElementId"   },
-	{ "intAttribute"    },
-	{ "floatAttribute"  },
-	{ "stringAttribute" },
+static const PARSER_XML_NAME xml_names[]=
+{
+    { "element_type_1"     },
+    { "element_type_2"     },
+    { "element_type_3"     },
+    { "element_type_4"     },
+    { "element_type_5"     },
+    { "element_type_6"     },
+    { "element_type_7"     },
+
+    { "testElementId"   },
+    { "intAttribute"    },
+    { "floatAttribute"  },
+    { "stringAttribute" },
 };
 
-// Test string to parse
+// String to parse.
 
-static const char test_1[]= 
+static const char parse_test_string[]=
 {
-"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
-"\n"
-"<ELEM_type_1 testElementId='0' intAttribute='20' floatAttribute='1.23' stringAttribute=\"TEST\">\n"
-"\n"
-"    <!-- Single line comment -->\n"
-"    <ELEM_type_2 testElementId='1'>\n"
-"        <ELEM_type_3 testElementId='11'/>\n"
-"        <ELEM_type_3 testElementId='12'/>\n"
-"        <ELEM_type_3 testElementId='13'/>\n"
-"\n"
-"        <!-- Single line comment -->\n"
-"        <ELEM_type_3 testElementId='14'>\n"
-"            <!-- Multiline\n"
-"            comment -->\n"
-"        </ELEM_type_3>\n"
-"    </ELEM_type_2>\n"
-"\n"
-"    <ELEM_type_2 testElementId='2'>Child element with string content</ELEM_type_2>\n"
-"</ELEM_type_1>\n"
-""
+"<element_type_1 testElementId=\"0\" intAttribute=\"20\" floatAttribute=\"1.230000\" stringAttribute=\"TEST\">\n"
+"  <element_type_2 testElementId=\"1\">\n"
+"    <element_type_3 testElementId=\"11\"/>\n"
+"    <element_type_3 testElementId=\"12\"/>\n"
+"    <element_type_3 testElementId=\"13\"/>\n"
+"    <element_type_3 testElementId=\"14\"/>\n"
+"  </element_type_2>\n"
+"  <element_type_4>\n"
+"    <element_type_5>\n"
+"      <element_type_6 testElementId=\"15\"/>\n"
+"      <element_type_6 testElementId=\"17\"/>\n"
+"    </element_type_5>\n"
+"  </element_type_4>\n"
+"  <element_type_7>\n"
+"    <element_type_8 testElementId=\"18\"/>\n"
+"  </element_type_7>\n"
+"</element_type_1>\n"
 };
 
-int main(void)
+static PARSER_ERROR test_parse(void)
 {
     PARSER_XML*  xml;
-    PARSER_CHAR  out[1024];
-    PARSER_INT   bw;
+    PARSER_CHAR  buffer_out[1024];
+    PARSER_INT   buffer_lenght;
+    PARSER_INT   bytes_written;
     PARSER_ERROR error;
 
     // Initialize xml-struct.
 
     xml= parser_begin();
     if ( !xml )
-    {
-        printf("%s %d: XML-struct initialization failed.\n", __FUNCTION__, __LINE__);
         return(1);
-    }
 
-    // Parse xml-string.
+    // Parse string.
 
-    error= parser_parse_string(xml, test_1, elements, sizeof(elements)/sizeof(PARSER_XML_NAME));
+    error= parser_parse_string(xml, parse_test_string, strlen(parse_test_string), xml_names, sizeof(xml_names)/sizeof(PARSER_XML_NAME));
     if ( error )
-    {
-        printf("%d %s: Error parsing xml-string.", __FUNCTION__, __LINE__);
-        goto end;
-    }
+        return(error);
 
     // End parsing.
 
     error= parser_finalize(xml);
-    if ( !error )
-    {
-        // Write parsed xml back to string.
+    if ( error )
+        return(error);
 
-        error= parser_write_xml_to_buffer(xml, elements, out, sizeof(out), &bw, 0);
-        if ( !error )
-            printf("Bytes written:%d Buffer content:\n%s", bw, out);
-    }
+    // Write parsed xml back to string.
+
+    error= parser_write_xml_to_buffer(xml, xml_names, buffer_out, sizeof(buffer_out), &bytes_written, 0);
+    if ( error )
+        return(error);
 
-    end:
+    // Check that output buffer matches original string.
+
+    if ( strncmp(buffer_out, parse_test_string, sizeof(buffer_out)) )
+    {
+        printf("%s %d: Parse result error: input and output string does not match.\n", __FUNCTION__, __LINE__);
+        printf("Original string:\n%s\n\n", parse_test_string);
+        printf("Output buffer string:\n%s\n\n", buffer_out);
+    }
 
     // Free xml.
 
-    if ( xml )
-        parser_free_xml(xml);
+    error= parser_free_xml(xml);
+    if ( error )
+        return(error);
 
     return(0);
 }

inc/xml_parser.h

@@ -201,7 +201,7 @@ PARSER_XML;
 #define PARSER_ASSERT(CONDITION)             \
     if ( !(CONDITION) )                      \
     {                                        \
-        printf("Parser error %s %d: %s",     \
+        printf("Parser assert %s %d: %s",    \
         __FUNCTION__, __LINE__, #CONDITION); \
         return(PARSER_RESULT_ERROR);         \
     }
@@ -235,4 +235,13 @@ PARSER_ERROR parser_write_xml_to_buffer(const PARSER_XML*      xml,
                                         PARSER_INT*            bytes_written,
                                         PARSER_INT             flags);
 
+// parser_find_element
+
+const PARSER_ELEMENT* parser_find_element(const PARSER_XML*      xml,
+                                          const PARSER_XML_NAME* xml_name_list,
+                                          const PARSER_ELEMENT*  offset,
+                                          PARSER_INT             max_depth,
+                                          PARSER_INT             xml_name_list_length,
+                                          const PARSER_CHAR*     element_name);
+
 #endif