Recent changes to Home

Home modified by Charles Oehmke

Charles Oehmke — Sat, 21 Jun 2014 20:10:56 -0000

--- v7
+++ v8
@@ -1,3 +1,6 @@
+For general information about btrxml, check the website:
+http://eonedgestudios.com/btrxml/btrxml.html
+
 The best way to learn how to use btrxml is to probably read through the accompanying header file.  At the bottom are 6 function declarations that should be of particular interest.

 **Quick example of how to parse an XML file in C**:

Home modified by Charles Oehmke

Charles Oehmke — Mon, 22 Jul 2013 14:33:07 -0000

--- v6
+++ v7
@@ -13,6 +13,7 @@
     {
         //... do stuff ...
     }
+    bxDestroy(&xdoc);
 }
 ~~~~~~

Home modified by Charles Oehmke

Charles Oehmke — Fri, 12 Jul 2013 13:07:33 -0000

--- v5
+++ v6
@@ -1,6 +1,6 @@
 The best way to learn how to use btrxml is to probably read through the accompanying header file.  At the bottom are 6 function declarations that should be of particular interest.

-A quick sample of how to parse a file in C:
+**Quick example of how to parse an XML file in C**:

 ~~~~~~
 bxDocument xdoc;
@@ -16,7 +16,9 @@
 }
 ~~~~~~

-The relevant function prototypes are here as well for quick reference.
+Below is a direct extraction from the header file for all the functions used in btrxml.
+
+**function prototypes from btrxml.h**:

 ~~~~~~

Home modified by Charles Oehmke

Charles Oehmke — Fri, 12 Jul 2013 12:57:56 -0000

--- v4
+++ v5
@@ -16,4 +16,36 @@
 }
 ~~~~~~

+The relevant function prototypes are here as well for quick reference.
+
+~~~~~~
+
+//parses the given filename in to the passed bxDocument structure
+//returns number of errors found
+extern uint_fast32_t bxParseFile(bxDocument* xdoc, const char* fname);
+
+//parses the given string data in to the passed bxDocument structure
+//if this is called directly, the user is responsible for cleaning up
+//the string buffer after processing!
+//returns number of errors found
+extern uint_fast32_t bxParseStr(bxDocument* xdoc, const char* strBuffer);
+
+//will find the first child of nodeParent with strTagToFind as a tag name
+//returns NULL if no such child was found
+extern bxNode* bxFindChildNodeByTag(bxNode* nodeParent, const char* strTagToFind);
+
+//given some node, will go through all *next* siblings, returning the first one
+//matching the strTagtoFind tag name; ideally use this to cycle through all
+//siblings to find collections of nodes, eg all 's
+//returns NULL if no sibling was found
+extern bxNode* bxFindNextSiblingByTag(bxNode* nodeCurrent, const char* strTagToFind);
+
+//will return a bxAttribute where the name = strName, if it exists.
+//returns NULL if not found or node is NULL
+extern bxAttribute* bxGetAttributeByName(bxNode* node, const char* strName);
+
+//destroy the DOM-like structure data associated with xdoc
+extern uint_fast32_t bxDestroy(bxDocument* xdoc);
+~~~~~~
+
 [[project_admins]]

Home modified by Charles Oehmke

Charles Oehmke — Fri, 12 Jul 2013 12:56:28 -0000

--- v3
+++ v4
@@ -2,13 +2,18 @@

 A quick sample of how to parse a file in C:

+~~~~~~
 bxDocument xdoc;
-bxNode\* myNode = NULL;
-bxParseFile(&xdoc, *"myxml.xml"*);
-myNode = bxFindChildNodeByTag(xdoc.nodeRoot, *"firstchild"*);
-if (myNode)
+bxNode* myNode = NULL;
+
+if (bxParseFile(&xdoc, "myxml.xml") == 0)
 {
-//... do stuff ...
+    myNode = bxFindChildNodeByTag(xdoc.nodeRoot, "firstchild");
+    if (myNode)
+    {
+        //... do stuff ...
+    }
 }
+~~~~~~

 [[project_admins]]

WikiPage Home modified by Charles Oehmke

Charles Oehmke — Mon, 25 Mar 2013 13:57:12 -0000

--- v2
+++ v3
@@ -1,4 +1,14 @@
-Wiki coming soon? (tm)
+The best way to learn how to use btrxml is to probably read through the accompanying header file.  At the bottom are 6 function declarations that should be of particular interest.
+
+A quick sample of how to parse a file in C:
+
+bxDocument xdoc;
+bxNode\* myNode = NULL;
+bxParseFile(&xdoc, *"myxml.xml"*);
+myNode = bxFindChildNodeByTag(xdoc.nodeRoot, *"firstchild"*);
+if (myNode)
+{
+//... do stuff ...
+}

 [[project_admins]]
-

WikiPage Home modified by Charles Oehmke

Charles Oehmke — Sun, 24 Mar 2013 23:52:59 -0000

--- v1
+++ v2
@@ -1,8 +1,4 @@
-Welcome to your wiki!
-
-This is the default page, edit it as you see fit. To add a new page simply reference it within brackets, e.g.: [SamplePage].
-
-The wiki uses [Markdown](/p/btrxml/wiki/markdown_syntax/) syntax.
+Wiki coming soon? (tm)

 [[project_admins]]
-[[download_button]]
+

Discussion for Home page

Charles Oehmke — Sun, 24 Mar 2013 23:52:03 -0000

Wiki coming soon? (tm)

WikiPage Home modified by Charles Oehmke

Charles Oehmke — Sun, 24 Mar 2013 23:43:59 -0000

Welcome to your wiki!

This is the default page, edit it as you see fit. To add a new page simply reference it within brackets, e.g.: [SamplePage].

The wiki uses Markdown syntax.

Charles Oehmke