diff options
Diffstat (limited to 'doc/examples/examples.xml')
| -rw-r--r-- | doc/examples/examples.xml | 787 |
1 files changed, 576 insertions, 211 deletions
diff --git a/doc/examples/examples.xml b/doc/examples/examples.xml index 31b8525..2a0827b 100644 --- a/doc/examples/examples.xml +++ b/doc/examples/examples.xml @@ -1,53 +1,4 @@ <examples> - <example filename='parse1.c'> - <synopsis>Parse an XML file to a tree and free it</synopsis> - <purpose>Demonstrate the use of xmlReadFile() to read an XML file into a tree and and xmlFreeDoc() to free the resulting tree</purpose> - <usage>parse1 test1.xml</usage> - <test>parse1 test1.xml</test> - <author>Daniel Veillard</author> - <copy>see Copyright for the status of this software. </copy> - <section>Parsing</section> - <includes> - <include><libxml/tree.h></include> - <include><libxml/parser.h></include> - </includes> - <uses> - <function line='54' file='xmlmemory' name='xmlMemoryDump'/> - <function line='50' file='parser' name='xmlCleanupParser'/> - <macro line='45' file='xmlversion' name='LIBXML_TEST_VERSION'/> - <typedef line='24' file='tree' name='xmlDocPtr'/> - <function line='31' file='tree' name='xmlFreeDoc'/> - <function line='26' file='parser' name='xmlReadFile'/> - </uses> - </example> - <example filename='reader1.c'> - <synopsis>Parse an XML file with an xmlReader</synopsis> - <purpose>Demonstrate the use of xmlReaderForFile() to parse an XML file and dump the informations about the nodes found in the process. (Note that the XMLReader functions require libxml2 version later than 2.6.)</purpose> - <usage>reader1 <filename></usage> - <test>reader1 test2.xml > reader1.tmp ; diff reader1.tmp reader1.res ; rm reader1.tmp</test> - <author>Daniel Veillard</author> - <copy>see Copyright for the status of this software. </copy> - <section>xmlReader</section> - <includes> - <include><libxml/xmlreader.h></include> - </includes> - <uses> - <function line='44' file='xmlstring' name='xmlStrlen'/> - <function line='94' file='parser' name='xmlCleanupParser'/> - <function line='37' file='xmlreader' name='xmlTextReaderNodeType'/> - <typedef line='59' file='xmlreader' name='xmlTextReaderPtr'/> - <function line='98' file='xmlmemory' name='xmlMemoryDump'/> - <function line='33' file='xmlreader' name='xmlTextReaderConstValue'/> - <function line='36' file='xmlreader' name='xmlTextReaderDepth'/> - <function line='69' file='xmlreader' name='xmlFreeTextReader'/> - <macro line='89' file='xmlversion' name='LIBXML_TEST_VERSION'/> - <function line='29' file='xmlreader' name='xmlTextReaderConstName'/> - <function line='40' file='xmlreader' name='xmlTextReaderHasValue'/> - <function line='67' file='xmlreader' name='xmlTextReaderRead'/> - <function line='39' file='xmlreader' name='xmlTextReaderIsEmptyElement'/> - <function line='62' file='xmlreader' name='xmlReaderForFile'/> - </uses> - </example> <example filename='xpath2.c'> <synopsis>Load a document, locate subelements with XPath, modify said elements and save the resulting document.</synopsis> <purpose>Shows how to make a full round-trip from a load/edit/save</purpose> @@ -81,148 +32,57 @@ <typedef line='86' file='tree' name='xmlDocPtr'/> </uses> </example> - <example filename='io1.c'> - <synopsis>Example of custom Input/Output</synopsis> - <purpose>Demonstrate the use of xmlRegisterInputCallbacks to build a custom I/O layer, this is used in an XInclude method context to show how dynamic document can be built in a clean way.</purpose> - <usage>io1</usage> - <test>io1 > io1.tmp ; diff io1.tmp io1.res ; rm -f io1.tmp</test> + <example filename='reader1.c'> + <synopsis>Parse an XML file with an xmlReader</synopsis> + <purpose>Demonstrate the use of xmlReaderForFile() to parse an XML file and dump the informations about the nodes found in the process. (Note that the XMLReader functions require libxml2 version later than 2.6.)</purpose> + <usage>reader1 <filename></usage> + <test>reader1 test2.xml > reader1.tmp ; diff reader1.tmp reader1.res ; rm reader1.tmp</test> <author>Daniel Veillard</author> <copy>see Copyright for the status of this software. </copy> - <section>InputOutput</section> + <section>xmlReader</section> <includes> - <include><libxml/parser.h></include> - <include><libxml/xmlIO.h></include> - <include><libxml/xinclude.h></include> - <include><libxml/tree.h></include> + <include><libxml/xmlreader.h></include> </includes> <uses> - <function line='143' file='tree' name='xmlDocDump'/> - <function line='158' file='xmlmemory' name='xmlMemoryDump'/> - <function line='149' file='tree' name='xmlFreeDoc'/> - <function line='154' file='parser' name='xmlCleanupParser'/> - <macro line='117' file='xmlversion' name='LIBXML_TEST_VERSION'/> - <function line='134' file='xinclude' name='xmlXIncludeProcess'/> - <function line='117' file='xmlIO' name='xmlRegisterInputCallbacks'/> - <function line='124' file='parser' name='xmlReadMemory'/> - <typedef line='105' file='tree' name='xmlDocPtr'/> + <function line='44' file='xmlstring' name='xmlStrlen'/> + <function line='94' file='parser' name='xmlCleanupParser'/> + <function line='37' file='xmlreader' name='xmlTextReaderNodeType'/> + <typedef line='59' file='xmlreader' name='xmlTextReaderPtr'/> + <function line='98' file='xmlmemory' name='xmlMemoryDump'/> + <function line='33' file='xmlreader' name='xmlTextReaderConstValue'/> + <function line='36' file='xmlreader' name='xmlTextReaderDepth'/> + <function line='69' file='xmlreader' name='xmlFreeTextReader'/> + <macro line='89' file='xmlversion' name='LIBXML_TEST_VERSION'/> + <function line='29' file='xmlreader' name='xmlTextReaderConstName'/> + <function line='40' file='xmlreader' name='xmlTextReaderHasValue'/> + <function line='67' file='xmlreader' name='xmlTextReaderRead'/> + <function line='39' file='xmlreader' name='xmlTextReaderIsEmptyElement'/> + <function line='62' file='xmlreader' name='xmlReaderForFile'/> </uses> </example> - <example filename='reader3.c'> - <synopsis>Show how to extract subdocuments with xmlReader</synopsis> - <purpose>Demonstrate the use of xmlTextReaderPreservePattern() to parse an XML file with the xmlReader while collecting only some subparts of the document. (Note that the XMLReader functions require libxml2 version later than 2.6.)</purpose> - <usage>reader3</usage> - <test>reader3 > reader3.tmp ; diff reader3.tmp reader3.res ; rm reader3.tmp</test> - <author>Daniel Veillard</author> + <example filename='reader4.c'> + <synopsis>Parse multiple XML files reusing an xmlReader</synopsis> + <purpose>Demonstrate the use of xmlReaderForFile() and xmlReaderNewFile to parse XML files while reusing the reader object and parser context. (Note that the XMLReader functions require libxml2 version later than 2.6.)</purpose> + <usage>reader4 <filename> [ filename ... ]</usage> + <test>reader4 test1.xml test2.xml test3.xml > reader4.tmp ; diff reader4.tmp reader4.res ; rm reader4.tmp</test> + <author>Graham Bennett</author> <copy>see Copyright for the status of this software. </copy> <section>xmlReader</section> <includes> <include><libxml/xmlreader.h></include> </includes> <uses> - <function line='106' file='parser' name='xmlCleanupParser'/> - <typedef line='31' file='xmlreader' name='xmlTextReaderPtr'/> - <function line='110' file='xmlmemory' name='xmlMemoryDump'/> <function line='99' file='tree' name='xmlFreeDoc'/> - <function line='65' file='xmlreader' name='xmlFreeTextReader'/> - <macro line='90' file='xmlversion' name='LIBXML_TEST_VERSION'/> - <function line='95' file='tree' name='xmlDocDump'/> - <function line='51' file='xmlreader' name='xmlTextReaderRead'/> - <function line='61' file='xmlreader' name='xmlTextReaderCurrentDoc'/> - <function line='42' file='xmlreader' name='xmlTextReaderPreservePattern'/> - <function line='37' file='xmlreader' name='xmlReaderForFile'/> - <typedef line='76' file='tree' name='xmlDocPtr'/> - </uses> - </example> - <example filename='testWriter.c'> - <synopsis>use various APIs for the xmlWriter</synopsis> - <purpose>tests a number of APIs for the xmlWriter, especially the various methods to write to a filename, to a memory buffer, to a new document, or to a subtree. It shows how to do encoding string conversions too. The resulting documents are then serialized.</purpose> - <usage>testWriter</usage> - <test>testWriter ; for i in 1 2 3 4 ; do diff writer.xml writer$$i.res ; done ; rm writer*.res</test> - <author>Alfred Mickautsch</author> - <copy>see Copyright for the status of this software. </copy> - <section>xmlWriter</section> - <includes> - <include><libxml/encoding.h></include> - <include><libxml/xmlwriter.h></include> - </includes> - <uses> - <function line='913' file='xmlwriter' name='xmlTextWriterStartDocument'/> - <function line='1121' file='xmlwriter' name='xmlTextWriterEndDocument'/> - <variable line='1183' file='globals' name='xmlRealloc'/> - <function line='925' file='xmlwriter' name='xmlTextWriterWriteComment'/> - <function line='1156' file='encoding' name='xmlFindCharEncodingHandler'/> - <variable line='1166' file='globals' name='xmlMalloc'/> - <typedef line='879' file='tree' name='xmlDocPtr'/> - <typedef line='341' file='tree' name='xmlBufferPtr'/> - <function line='58' file='xmlmemory' name='xmlMemoryDump'/> - <macro line='885' file='parser' name='XML_DEFAULT_VERSION'/> - <function line='901' file='tree' name='xmlDocSetRootElement'/> - <function line='1127' file='xmlwriter' name='xmlFreeTextWriter'/> - <function line='1096' file='xmlwriter' name='xmlTextWriterStartElement'/> - <function line='347' file='tree' name='xmlBufferCreate'/> - <function line='1111' file='xmlwriter' name='xmlTextWriterEndElement'/> - <function line='76' file='xmlwriter' name='xmlNewTextWriterFilename'/> - <function line='959' file='xmlwriter' name='xmlTextWriterWriteFormatComment'/> - <function line='54' file='parser' name='xmlCleanupParser'/> - <function line='1073' file='xmlwriter' name='xmlTextWriterWriteFormatElement'/> - <typedef line='1151' file='encoding' name='xmlCharEncodingHandlerPtr'/> - <function line='1131' file='tree' name='xmlFreeDoc'/> - <typedef line='880' file='tree' name='xmlNodePtr'/> - <function line='949' file='xmlwriter' name='xmlTextWriterWriteAttribute'/> - <function line='632' file='xmlwriter' name='xmlNewTextWriterDoc'/> - <function line='894' file='tree' name='xmlNewDocNode'/> - <function line='1129' file='tree' name='xmlSaveFileEnc'/> - <function line='904' file='xmlwriter' name='xmlNewTextWriterTree'/> - <function line='355' file='xmlwriter' name='xmlNewTextWriterMemory'/> - <variable line='1180' file='globals' name='xmlFree'/> - <macro line='40' file='xmlversion' name='LIBXML_TEST_VERSION'/> - <function line='613' file='tree' name='xmlBufferFree'/> - <typedef line='878' file='xmlwriter' name='xmlTextWriterPtr'/> - <function line='1103' file='xmlwriter' name='xmlTextWriterWriteElement'/> - <function line='885' file='tree' name='xmlNewDoc'/> - </uses> - </example> - <example filename='tree1.c'> - <synopsis>Navigates a tree to print element names</synopsis> - <purpose>Parse a file to a tree, use xmlDocGetRootElement() to get the root element, then walk the document and print all the element name in document order.</purpose> - <usage>tree1 filename_or_URL</usage> - <test>tree1 test2.xml > tree1.tmp ; diff tree1.tmp tree1.res ; rm tree1.tmp</test> - <author>Dodji Seketeli</author> - <copy>see Copyright for the status of this software. </copy> - <section>Tree</section> - <includes> - <include><libxml/tree.h></include> - <include><libxml/parser.h></include> - </includes> - <uses> - <enum line='36' file='tree' name='XML_ELEMENT_NODE'/> - <function line='74' file='tree' name='xmlDocGetRootElement'/> - <function line='79' file='tree' name='xmlFreeDoc'/> - <function line='67' file='parser' name='xmlReadFile'/> - </uses> - </example> - <example filename='tree2.c'> - <synopsis>Creates a tree</synopsis> - <purpose>Shows how to create document, nodes and dump it to stdout or file.</purpose> - <usage>tree2 <filename> -Default output: stdout</usage> - <test>tree2 > tree2.tmp ; diff tree2.tmp tree2.res ; rm tree2.tmp</test> - <author>Lucas Brasilino <brasilino@recife.pe.gov.br></author> - <copy>see Copyright for the status of this software </copy> - <section>Tree</section> - <includes> - <include><libxml/tree.h></include> - <include><libxml/parser.h></include> - </includes> - <uses> - <function line='75' file='tree' name='xmlNewText'/> - <function line='96' file='tree' name='xmlSaveFormatFileEnc'/> - <function line='78' file='tree' name='xmlAddChild'/> - <function line='41' file='tree' name='xmlDocSetRootElement'/> - <function line='89' file='tree' name='xmlNewProp'/> - <function line='88' file='tree' name='xmlNewChild'/> - <function line='74' file='tree' name='xmlNewNode'/> - <function line='46' file='tree' name='xmlCreateIntSubset'/> - <function line='39' file='tree' name='xmlNewDoc'/> + <typedef line='54' file='xmlreader' name='xmlTextReaderPtr'/> + <function line='109' file='parser' name='xmlCleanupParser'/> + <function line='113' file='xmlmemory' name='xmlMemoryDump'/> + <function line='83' file='xmlreader' name='xmlReaderNewFile'/> + <function line='104' file='xmlreader' name='xmlFreeTextReader'/> + <macro line='72' file='xmlversion' name='LIBXML_TEST_VERSION'/> + <function line='26' file='xmlreader' name='xmlTextReaderRead'/> + <function line='97' file='xmlreader' name='xmlTextReaderCurrentDoc'/> + <function line='72' file='xmlreader' name='xmlReaderForFile'/> + <typedef line='56' file='tree' name='xmlDocPtr'/> </uses> </example> <example filename='parse2.c'> @@ -243,7 +103,11 @@ <function line='29' file='parser' name='xmlNewParserCtxt'/> <typedef line='25' file='tree' name='xmlParserCtxtPtr'/> <function line='35' file='parser' name='xmlCtxtReadFile'/> + <function line='66' file='parser' name='xmlCleanupParser'/> + <macro line='61' file='xmlversion' name='LIBXML_TEST_VERSION'/> + <function line='44' file='tree' name='xmlFreeDoc'/> <typedef line='26' file='tree' name='xmlDocPtr'/> + <function line='70' file='xmlmemory' name='xmlMemoryDump'/> </uses> </example> <example filename='reader2.c'> @@ -259,14 +123,17 @@ </includes> <uses> <function line='45' file='xmlstring' name='xmlStrlen'/> + <function line='109' file='parser' name='xmlCleanupParser'/> <function line='38' file='xmlreader' name='xmlTextReaderNodeType'/> <typedef line='60' file='xmlreader' name='xmlTextReaderPtr'/> + <function line='113' file='xmlmemory' name='xmlMemoryDump'/> <function line='34' file='xmlreader' name='xmlTextReaderConstValue'/> <enum line='70' file='parser' name='XML_PARSE_NOENT'/> <function line='37' file='xmlreader' name='xmlTextReaderDepth'/> <enum line='71' file='parser' name='XML_PARSE_DTDVALID'/> <enum line='69' file='parser' name='XML_PARSE_DTDATTR'/> <function line='84' file='xmlreader' name='xmlFreeTextReader'/> + <macro line='104' file='xmlversion' name='LIBXML_TEST_VERSION'/> <function line='30' file='xmlreader' name='xmlTextReaderConstName'/> <function line='41' file='xmlreader' name='xmlTextReaderHasValue'/> <function line='76' file='xmlreader' name='xmlTextReaderRead'/> @@ -275,24 +142,73 @@ <function line='81' file='xmlreader' name='xmlTextReaderIsValid'/> </uses> </example> - <example filename='reader4.c'> - <synopsis>Parse multiple XML files reusing an xmlReader</synopsis> - <purpose>Demonstrate the use of xmlReaderForFile() and xmlReaderNewFile to parse XML files while reusing the reader object and parser context. (Note that the XMLReader functions require libxml2 version later than 2.6.)</purpose> - <usage>reader4 <filename> [ filename ... ]</usage> - <test>reader4 test1.xml test2.xml test3.xml > reader4.tmp ; diff reader4.tmp reader4.res ; rm reader4.tmp</test> - <author>Graham Bennett</author> + <example filename='parse3.c'> + <synopsis>Parse an XML document in memory to a tree and free it</synopsis> + <purpose>Demonstrate the use of xmlReadMemory() to read an XML file into a tree and and xmlFreeDoc() to free the resulting tree</purpose> + <usage>parse3</usage> + <test>parse3</test> + <author>Daniel Veillard</author> + <copy>see Copyright for the status of this software. </copy> + <section>Parsing</section> + <includes> + <include><libxml/tree.h></include> + <include><libxml/parser.h></include> + </includes> + <uses> + <function line='33' file='parser' name='xmlReadMemory'/> + <function line='58' file='xmlmemory' name='xmlMemoryDump'/> + <function line='54' file='parser' name='xmlCleanupParser'/> + <macro line='49' file='xmlversion' name='LIBXML_TEST_VERSION'/> + <function line='38' file='tree' name='xmlFreeDoc'/> + <typedef line='27' file='tree' name='xmlDocPtr'/> + </uses> + </example> + <example filename='reader3.c'> + <synopsis>Show how to extract subdocuments with xmlReader</synopsis> + <purpose>Demonstrate the use of xmlTextReaderPreservePattern() to parse an XML file with the xmlReader while collecting only some subparts of the document. (Note that the XMLReader functions require libxml2 version later than 2.6.)</purpose> + <usage>reader3</usage> + <test>reader3 > reader3.tmp ; diff reader3.tmp reader3.res ; rm reader3.tmp</test> + <author>Daniel Veillard</author> <copy>see Copyright for the status of this software. </copy> <section>xmlReader</section> <includes> <include><libxml/xmlreader.h></include> </includes> <uses> - <typedef line='54' file='xmlreader' name='xmlTextReaderPtr'/> - <function line='83' file='xmlreader' name='xmlReaderNewFile'/> - <function line='104' file='xmlreader' name='xmlFreeTextReader'/> - <function line='26' file='xmlreader' name='xmlTextReaderRead'/> - <function line='97' file='xmlreader' name='xmlTextReaderCurrentDoc'/> - <function line='72' file='xmlreader' name='xmlReaderForFile'/> + <typedef line='31' file='xmlreader' name='xmlTextReaderPtr'/> + <function line='99' file='tree' name='xmlFreeDoc'/> + <function line='65' file='xmlreader' name='xmlFreeTextReader'/> + <function line='95' file='tree' name='xmlDocDump'/> + <function line='51' file='xmlreader' name='xmlTextReaderRead'/> + <function line='61' file='xmlreader' name='xmlTextReaderCurrentDoc'/> + <function line='42' file='xmlreader' name='xmlTextReaderPreservePattern'/> + <function line='37' file='xmlreader' name='xmlReaderForFile'/> + <typedef line='76' file='tree' name='xmlDocPtr'/> + </uses> + </example> + <example filename='tree2.c'> + <synopsis>Creates a tree</synopsis> + <purpose>Shows how to create document, nodes and dump it to stdout or file.</purpose> + <usage>tree2 <filename> -Default output: stdout</usage> + <test>tree2 > tree2.tmp ; diff tree2.tmp tree2.res ; rm tree2.tmp</test> + <author>Lucas Brasilino <brasilino@recife.pe.gov.br></author> + <copy>see Copyright for the status of this software </copy> + <section>Tree</section> + <includes> + <include><libxml/tree.h></include> + <include><libxml/parser.h></include> + </includes> + <uses> + <function line='75' file='tree' name='xmlNewText'/> + <function line='96' file='tree' name='xmlSaveFormatFileEnc'/> + <function line='78' file='tree' name='xmlAddChild'/> + <function line='41' file='tree' name='xmlDocSetRootElement'/> + <function line='89' file='tree' name='xmlNewProp'/> + <function line='88' file='tree' name='xmlNewChild'/> + <function line='74' file='tree' name='xmlNewNode'/> + <function line='46' file='tree' name='xmlCreateIntSubset'/> + <function line='99' file='tree' name='xmlFreeDoc'/> + <function line='39' file='tree' name='xmlNewDoc'/> </uses> </example> <example filename='parse4.c'> @@ -312,22 +228,93 @@ <function line='86' file='parser' name='xmlParseChunk'/> <function line='67' file='parser' name='xmlCreatePushParserCtxt'/> <typedef line='45' file='tree' name='xmlParserCtxtPtr'/> + <typedef line='47' file='tree' name='xmlDocPtr'/> </uses> </example> - <example filename='parse3.c'> - <synopsis>Parse an XML document in memory to a tree and free it</synopsis> - <purpose>Demonstrate the use of xmlReadMemory() to read an XML file into a tree and and xmlFreeDoc() to free the resulting tree</purpose> - <usage>parse3</usage> - <test>parse3</test> + <example filename='io2.c'> + <synopsis>Output to char buffer</synopsis> + <purpose>Demonstrate the use of xmlDocDumpMemory to output document to a character buffer</purpose> + <usage>io2</usage> + <test>io2 > io2.tmp ; diff io2.tmp io2.res ; rm -f io2.tmp</test> + <author>John Fleck</author> + <copy>see Copyright for the status of this software. </copy> + <section>InputOutput</section> + <includes> + <include><libxml/parser.h></include> + </includes> + <uses> + <function line='29' file='tree' name='xmlNodeSetContent'/> + <function line='36' file='tree' name='xmlDocDumpFormatMemory'/> + <variable line='42' file='globals' name='xmlFree'/> + <function line='30' file='tree' name='xmlDocSetRootElement'/> + <typedef line='19' file='tree' name='xmlNodePtr'/> + <function line='27' file='tree' name='xmlNewDoc'/> + <function line='28' file='tree' name='xmlNewNode'/> + </uses> + </example> + <example filename='testWriter.c'> + <synopsis>use various APIs for the xmlWriter</synopsis> + <purpose>tests a number of APIs for the xmlWriter, especially the various methods to write to a filename, to a memory buffer, to a new document, or to a subtree. It shows how to do encoding string conversions too. The resulting documents are then serialized.</purpose> + <usage>testWriter</usage> + <test>testWriter ; for i in 1 2 3 4 ; do diff writer.xml writer$$i.res ; done ; rm writer*.res</test> + <author>Alfred Mickautsch</author> + <copy>see Copyright for the status of this software. </copy> + <section>xmlWriter</section> + <includes> + <include><libxml/encoding.h></include> + <include><libxml/xmlwriter.h></include> + </includes> + <uses> + <function line='913' file='xmlwriter' name='xmlTextWriterStartDocument'/> + <function line='1121' file='xmlwriter' name='xmlTextWriterEndDocument'/> + <variable line='1183' file='globals' name='xmlRealloc'/> + <function line='925' file='xmlwriter' name='xmlTextWriterWriteComment'/> + <function line='1156' file='encoding' name='xmlFindCharEncodingHandler'/> + <variable line='1166' file='globals' name='xmlMalloc'/> + <typedef line='341' file='tree' name='xmlBufferPtr'/> + <macro line='885' file='parser' name='XML_DEFAULT_VERSION'/> + <function line='901' file='tree' name='xmlDocSetRootElement'/> + <function line='1127' file='xmlwriter' name='xmlFreeTextWriter'/> + <function line='1096' file='xmlwriter' name='xmlTextWriterStartElement'/> + <function line='347' file='tree' name='xmlBufferCreate'/> + <function line='1111' file='xmlwriter' name='xmlTextWriterEndElement'/> + <function line='76' file='xmlwriter' name='xmlNewTextWriterFilename'/> + <function line='959' file='xmlwriter' name='xmlTextWriterWriteFormatComment'/> + <function line='1073' file='xmlwriter' name='xmlTextWriterWriteFormatElement'/> + <typedef line='1151' file='encoding' name='xmlCharEncodingHandlerPtr'/> + <typedef line='880' file='tree' name='xmlNodePtr'/> + <function line='949' file='xmlwriter' name='xmlTextWriterWriteAttribute'/> + <function line='632' file='xmlwriter' name='xmlNewTextWriterDoc'/> + <function line='894' file='tree' name='xmlNewDocNode'/> + <function line='1129' file='tree' name='xmlSaveFileEnc'/> + <function line='904' file='xmlwriter' name='xmlNewTextWriterTree'/> + <function line='355' file='xmlwriter' name='xmlNewTextWriterMemory'/> + <variable line='1180' file='globals' name='xmlFree'/> + <function line='613' file='tree' name='xmlBufferFree'/> + <typedef line='878' file='xmlwriter' name='xmlTextWriterPtr'/> + <function line='1103' file='xmlwriter' name='xmlTextWriterWriteElement'/> + <function line='885' file='tree' name='xmlNewDoc'/> + </uses> + </example> + <example filename='io1.c'> + <synopsis>Example of custom Input/Output</synopsis> + <purpose>Demonstrate the use of xmlRegisterInputCallbacks to build a custom I/O layer, this is used in an XInclude method context to show how dynamic document can be built in a clean way.</purpose> + <usage>io1</usage> + <test>io1 > io1.tmp ; diff io1.tmp io1.res ; rm -f io1.tmp</test> <author>Daniel Veillard</author> <copy>see Copyright for the status of this software. </copy> - <section>Parsing</section> + <section>InputOutput</section> <includes> - <include><libxml/tree.h></include> <include><libxml/parser.h></include> + <include><libxml/xmlIO.h></include> + <include><libxml/xinclude.h></include> + <include><libxml/tree.h></include> </includes> <uses> - <function line='33' file='parser' name='xmlReadMemory'/> + <function line='143' file='tree' name='xmlDocDump'/> + <function line='134' file='xinclude' name='xmlXIncludeProcess'/> + <function line='117' file='xmlIO' name='xmlRegisterInputCallbacks'/> + <function line='124' file='parser' name='xmlReadMemory'/> </uses> </example> <example filename='xpath1.c'> @@ -363,24 +350,402 @@ <enum line='217' file='tree' name='XML_NAMESPACE_DECL'/> </uses> </example> - <example filename='io2.c'> - <synopsis>Output to char buffer</synopsis> - <purpose>Demonstrate the use of xmlDocDumpMemory to output document to a character buffer</purpose> - <usage>io2</usage> - <test>io2 > io2.tmp ; diff io2.tmp io2.res ; rm -f io2.tmp</test> - <author>John Fleck</author> + <example filename='parse1.c'> + <synopsis>Parse an XML file to a tree and free it</synopsis> + <purpose>Demonstrate the use of xmlReadFile() to read an XML file into a tree and and xmlFreeDoc() to free the resulting tree</purpose> + <usage>parse1 test1.xml</usage> + <test>parse1 test1.xml</test> + <author>Daniel Veillard</author> <copy>see Copyright for the status of this software. </copy> - <section>InputOutput</section> + <section>Parsing</section> <includes> + <include><libxml/tree.h></include> <include><libxml/parser.h></include> </includes> <uses> - <function line='29' file='tree' name='xmlNodeSetContent'/> - <function line='36' file='tree' name='xmlDocDumpFormatMemory'/> - <variable line='42' file='globals' name='xmlFree'/> - <function line='30' file='tree' name='xmlDocSetRootElement'/> - <typedef line='19' file='tree' name='xmlNodePtr'/> - <function line='27' file='tree' name='xmlNewDoc'/> - <function line='28' file='tree' name='xmlNewNode'/> + <function line='26' file='parser' name='xmlReadFile'/> + </uses> + </example> + <example filename='tree1.c'> + <synopsis>Navigates a tree to print element names</synopsis> + <purpose>Parse a file to a tree, use xmlDocGetRootElement() to get the root element, then walk the document and print all the element name in document order.</purpose> + <usage>tree1 filename_or_URL</usage> + <test>tree1 test2.xml > tree1.tmp ; diff tree1.tmp tree1.res ; rm tree1.tmp</test> + <author>Dodji Seketeli</author> + <copy>see Copyright for the status of this software. </copy> + <section>Tree</section> + <includes> + <include><libxml/tree.h></include> + <include><libxml/parser.h></include> + </includes> + <uses> + <enum line='36' file='tree' name='XML_ELEMENT_NODE'/> + <function line='74' file='tree' name='xmlDocGetRootElement'/> + <function line='67' file='parser' name='xmlReadFile'/> </uses> </example> + <symbols> + <symbol name='LIBXML_TEST_VERSION'> + <ref filename='xpath2.c'/> + <ref filename='reader1.c'/> + <ref filename='reader4.c'/> + <ref filename='parse2.c'/> + <ref filename='reader2.c'/> + <ref filename='parse3.c'/> + </symbol> + <symbol name='XML_DEFAULT_VERSION'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='XML_ELEMENT_NODE'> + <ref filename='xpath1.c'/> + <ref filename='tree1.c'/> + </symbol> + <symbol name='XML_NAMESPACE_DECL'> + <ref filename='xpath2.c'/> + <ref filename='xpath1.c'/> + </symbol> + <symbol name='XML_PARSE_DTDATTR'> + <ref filename='reader2.c'/> + </symbol> + <symbol name='XML_PARSE_DTDVALID'> + <ref filename='parse2.c'/> + <ref filename='reader2.c'/> + </symbol> + <symbol name='XML_PARSE_NOENT'> + <ref filename='reader2.c'/> + </symbol> + <symbol name='xmlAddChild'> + <ref filename='tree2.c'/> + </symbol> + <symbol name='xmlBufferCreate'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlBufferFree'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlBufferPtr'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlCharEncodingHandlerPtr'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlCleanupParser'> + <ref filename='xpath2.c'/> + <ref filename='reader1.c'/> + <ref filename='reader4.c'/> + <ref filename='parse2.c'/> + <ref filename='reader2.c'/> + <ref filename='parse3.c'/> + </symbol> + <symbol name='xmlCreateIntSubset'> + <ref filename='tree2.c'/> + </symbol> + <symbol name='xmlCreatePushParserCtxt'> + <ref filename='parse4.c'/> + </symbol> + <symbol name='xmlCtxtReadFile'> + <ref filename='parse2.c'/> + </symbol> + <symbol name='xmlDocDump'> + <ref filename='xpath2.c'/> + <ref filename='reader3.c'/> + <ref filename='io1.c'/> + </symbol> + <symbol name='xmlDocDumpFormatMemory'> + <ref filename='io2.c'/> + </symbol> + <symbol name='xmlDocGetRootElement'> + <ref filename='tree1.c'/> + </symbol> + <symbol name='xmlDocPtr'> + <ref filename='xpath2.c'/> + <ref filename='reader4.c'/> + <ref filename='parse2.c'/> + <ref filename='parse3.c'/> + <ref filename='reader3.c'/> + <ref filename='parse4.c'/> + </symbol> + <symbol name='xmlDocSetRootElement'> + <ref filename='tree2.c'/> + <ref filename='io2.c'/> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlFindCharEncodingHandler'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlFree'> + <ref filename='io2.c'/> + <ref filename='testWriter.c'/> + <ref filename='xpath1.c'/> + </symbol> + <symbol name='xmlFreeDoc'> + <ref filename='xpath2.c'/> + <ref filename='reader4.c'/> + <ref filename='parse2.c'/> + <ref filename='parse3.c'/> + <ref filename='reader3.c'/> + <ref filename='tree2.c'/> + </symbol> + <symbol name='xmlFreeParserCtxt'> + <ref filename='parse2.c'/> + <ref filename='parse4.c'/> + </symbol> + <symbol name='xmlFreeTextReader'> + <ref filename='reader1.c'/> + <ref filename='reader4.c'/> + <ref filename='reader2.c'/> + <ref filename='reader3.c'/> + </symbol> + <symbol name='xmlFreeTextWriter'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlInitParser'> + <ref filename='xpath2.c'/> + <ref filename='xpath1.c'/> + </symbol> + <symbol name='xmlMalloc'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlMemoryDump'> + <ref filename='xpath2.c'/> + <ref filename='reader1.c'/> + <ref filename='reader4.c'/> + <ref filename='parse2.c'/> + <ref filename='reader2.c'/> + <ref filename='parse3.c'/> + </symbol> + <symbol name='xmlNewChild'> + <ref filename='tree2.c'/> + </symbol> + <symbol name='xmlNewDoc'> + <ref filename='tree2.c'/> + <ref filename='io2.c'/> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlNewDocNode'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlNewNode'> + <ref filename='tree2.c'/> + <ref filename='io2.c'/> + </symbol> + <symbol name='xmlNewParserCtxt'> + <ref filename='parse2.c'/> + </symbol> + <symbol name='xmlNewProp'> + <ref filename='tree2.c'/> + </symbol> + <symbol name='xmlNewText'> + <ref filename='tree2.c'/> + </symbol> + <symbol name='xmlNewTextWriterDoc'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlNewTextWriterFilename'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlNewTextWriterMemory'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlNewTextWriterTree'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlNodePtr'> + <ref filename='io2.c'/> + <ref filename='testWriter.c'/> + <ref filename='xpath1.c'/> + </symbol> + <symbol name='xmlNodeSetContent'> + <ref filename='xpath2.c'/> + <ref filename='io2.c'/> + </symbol> + <symbol name='xmlNsPtr'> + <ref filename='xpath1.c'/> + </symbol> + <symbol name='xmlParseChunk'> + <ref filename='parse4.c'/> + </symbol> + <symbol name='xmlParseFile'> + <ref filename='xpath2.c'/> + <ref filename='xpath1.c'/> + </symbol> + <symbol name='xmlParserCtxtPtr'> + <ref filename='parse2.c'/> + <ref filename='parse4.c'/> + </symbol> + <symbol name='xmlReadFile'> + <ref filename='parse1.c'/> + <ref filename='tree1.c'/> + </symbol> + <symbol name='xmlReadMemory'> + <ref filename='parse3.c'/> + <ref filename='io1.c'/> + </symbol> + <symbol name='xmlReaderForFile'> + <ref filename='reader1.c'/> + <ref filename='reader4.c'/> + <ref filename='reader2.c'/> + <ref filename='reader3.c'/> + </symbol> + <symbol name='xmlReaderNewFile'> + <ref filename='reader4.c'/> + </symbol> + <symbol name='xmlRealloc'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlRegisterInputCallbacks'> + <ref filename='io1.c'/> + </symbol> + <symbol name='xmlSaveFileEnc'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlSaveFormatFileEnc'> + <ref filename='tree2.c'/> + </symbol> + <symbol name='xmlStrchr'> + <ref filename='xpath1.c'/> + </symbol> + <symbol name='xmlStrdup'> + <ref filename='xpath1.c'/> + </symbol> + <symbol name='xmlStrlen'> + <ref filename='reader1.c'/> + <ref filename='reader2.c'/> + </symbol> + <symbol name='xmlTextReaderConstName'> + <ref filename='reader1.c'/> + <ref filename='reader2.c'/> + </symbol> + <symbol name='xmlTextReaderConstValue'> + <ref filename='reader1.c'/> + <ref filename='reader2.c'/> + </symbol> + <symbol name='xmlTextReaderCurrentDoc'> + <ref filename='reader4.c'/> + <ref filename='reader3.c'/> + </symbol> + <symbol name='xmlTextReaderDepth'> + <ref filename='reader1.c'/> + <ref filename='reader2.c'/> + </symbol> + <symbol name='xmlTextReaderHasValue'> + <ref filename='reader1.c'/> + <ref filename='reader2.c'/> + </symbol> + <symbol name='xmlTextReaderIsEmptyElement'> + <ref filename='reader1.c'/> + <ref filename='reader2.c'/> + </symbol> + <symbol name='xmlTextReaderIsValid'> + <ref filename='reader2.c'/> + </symbol> + <symbol name='xmlTextReaderNodeType'> + <ref filename='reader1.c'/> + <ref filename='reader2.c'/> + </symbol> + <symbol name='xmlTextReaderPreservePattern'> + <ref filename='reader3.c'/> + </symbol> + <symbol name='xmlTextReaderPtr'> + <ref filename='reader1.c'/> + <ref filename='reader4.c'/> + <ref filename='reader2.c'/> + <ref filename='reader3.c'/> + </symbol> + <symbol name='xmlTextReaderRead'> + <ref filename='reader1.c'/> + <ref filename='reader4.c'/> + <ref filename='reader2.c'/> + <ref filename='reader3.c'/> + </symbol> + <symbol name='xmlTextWriterEndDocument'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlTextWriterEndElement'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlTextWriterPtr'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlTextWriterStartDocument'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlTextWriterStartElement'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlTextWriterWriteAttribute'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlTextWriterWriteComment'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlTextWriterWriteElement'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlTextWriterWriteFormatComment'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlTextWriterWriteFormatElement'> + <ref filename='testWriter.c'/> + </symbol> + <symbol name='xmlXIncludeProcess'> + <ref filename='io1.c'/> + </symbol> + <symbol name='xmlXPathContextPtr'> + <ref filename='xpath2.c'/> + <ref filename='xpath1.c'/> + </symbol> + <symbol name='xmlXPathEvalExpression'> + <ref filename='xpath2.c'/> + <ref filename='xpath1.c'/> + </symbol> + <symbol name='xmlXPathFreeContext'> + <ref filename='xpath2.c'/> + <ref filename='xpath1.c'/> + </symbol> + <symbol name='xmlXPathFreeObject'> + <ref filename='xpath2.c'/> + <ref filename='xpath1.c'/> + </symbol> + <symbol name='xmlXPathNewContext'> + <ref filename='xpath2.c'/> + <ref filename='xpath1.c'/> + </symbol> + <symbol name='xmlXPathObjectPtr'> + <ref filename='xpath2.c'/> + <ref filename='xpath1.c'/> + </symbol> + <symbol name='xmlXPathRegisterNs'> + <ref filename='xpath1.c'/> + </symbol> + </symbols> + <sections> + <section name='InputOutput'> + <example filename='io2.c'/> + <example filename='io1.c'/> + </section> + <section name='Parsing'> + <example filename='parse2.c'/> + <example filename='parse3.c'/> + <example filename='parse4.c'/> + <example filename='parse1.c'/> + </section> + <section name='Tree'> + <example filename='tree2.c'/> + <example filename='tree1.c'/> + </section> + <section name='XPath'> + <example filename='xpath2.c'/> + <example filename='xpath1.c'/> + </section> + <section name='xmlReader'> + <example filename='reader1.c'/> + <example filename='reader4.c'/> + <example filename='reader2.c'/> + <example filename='reader3.c'/> + </section> + <section name='xmlWriter'> + <example filename='testWriter.c'/> + </section> + </sections> +</examples> |