c/libxml2
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/libxml2 synced 2025-03-28 21:33:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: Move doc/examples to example

Browse Source
This commit is contained in:
Nick Wellnhofer 2024-04-28 21:14:32 +02:00
parent 1cdfece12b
commit d381e5de4a
33 changed files with 68 additions and 1771 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -5,7 +5,6 @@
*.pyc
# Executables
/example/gjobread
/xmlcatalog
/xmllint

2
.gitlab-ci.yml
View File

@ -290,8 +290,6 @@ pages:
script:
- mkdir -p public
- cp -r doc/devhelp doc/tutorial doc/xmllint.html doc/xmlcatalog.html public
- mkdir -p public/examples
- cp doc/examples/*.html doc/examples/*.c public/examples
artifacts:
paths:
- public

1
Makefile.am
View File

@ -380,7 +380,6 @@ DISTCLEANFILES = COPYING missing.lst
EXTRA_DIST = Copyright check-xml-test-suite.py gentest.py \
check-relaxng-test-suite.py check-relaxng-test-suite2.py \
check-xsddata-test-suite.py check-xinclude-test-suite.py \
example/Makefile.am example/gjobread.c example/gjobs.xml \
libxml2-config.cmake.in autogen.sh \
libxml.h \
genUnicode.py \

2
configure.ac
View File

@ -1158,7 +1158,7 @@ RELDATE=`date +'%a %b %e %Y'`
AC_SUBST(RELDATE)
# keep on one line for cygwin c.f. #130896
AC_CONFIG_FILES([Makefile include/Makefile include/libxml/Makefile include/private/Makefile doc/Makefile doc/examples/Makefile doc/devhelp/Makefile example/Makefile fuzz/Makefile python/Makefile python/tests/Makefile xstc/Makefile include/libxml/xmlversion.h libxml-2.0.pc libxml-2.0-uninstalled.pc libxml2-config.cmake])
AC_CONFIG_FILES([Makefile include/Makefile include/libxml/Makefile include/private/Makefile doc/Makefile doc/devhelp/Makefile example/Makefile fuzz/Makefile python/Makefile python/tests/Makefile xstc/Makefile include/libxml/xmlversion.h libxml-2.0.pc libxml-2.0-uninstalled.pc libxml2-config.cmake])
AC_CONFIG_FILES([python/setup.py], [chmod +x python/setup.py])
AC_CONFIG_FILES([xml2-config], [chmod +x xml2-config])
AC_OUTPUT

3
doc/Makefile.am
View File

@ -1,5 +1,5 @@
## Process this file with automake to produce Makefile.in
SUBDIRS = . devhelp examples
SUBDIRS = . devhelp
nobase_dist_doc_DATA = \
tutorial/apa.html \
@ -72,7 +72,6 @@ rebuild:
cd $(srcdir) && $(XSLTPROC) --nonet xmlcatalog.xml
cd $(srcdir) && $(XSLTPROC) --nonet -o xmlcatalog.html $(DOCBOOK_HTML) xmlcatalog.xml
cd devhelp && $(MAKE) rebuild
cd examples && $(MAKE) rebuild
cd .. && $(MAKE) rebuild_testapi
.PHONY: rebuild

101
doc/examples/Makefile.am
View File

@ -1,101 +0,0 @@
AM_CPPFLAGS = -I$(top_builddir)/include -I$(top_srcdir)/include
LDADD = $(top_builddir)/libxml2.la
rebuild:
cd $(srcdir) && $(PYTHON) index.py
$(MAKE) Makefile
cd $(srcdir) && xsltproc examples.xsl examples.xml
-cd $(srcdir) && xmllint --valid --noout index.html
.PHONY: rebuild
install-data-local:
$(MKDIR_P) $(DESTDIR)$(docdir)/examples
-$(INSTALL) -m 0644 $(srcdir)/*.html $(srcdir)/*.c $(DESTDIR)$(docdir)/examples/
uninstall-local:
rm -f $(DESTDIR)$(docdir)/examples/*.c
rm -f $(DESTDIR)$(docdir)/examples/*.html
-rmdir $(DESTDIR)$(docdir)/examples
clean-local:
test -f Makefile.am || rm -f test?.xml
EXTRA_DIST = \
examples.xml \
examples.xsl \
index.html \
index.py \
test1.xml \
test2.xml \
test3.xml \
meson.build
check_PROGRAMS = \
io1 \
io2 \
parse1 \
parse2 \
parse3 \
parse4 \
reader1 \
reader2 \
reader3 \
reader4 \
testWriter \
tree1 \
tree2 \
xpath1 \
xpath2
io1_SOURCES = io1.c
io2_SOURCES = io2.c
parse1_SOURCES = parse1.c
parse2_SOURCES = parse2.c
parse3_SOURCES = parse3.c
parse4_SOURCES = parse4.c
reader1_SOURCES = reader1.c
reader2_SOURCES = reader2.c
reader3_SOURCES = reader3.c
reader4_SOURCES = reader4.c
testWriter_SOURCES = testWriter.c
tree1_SOURCES = tree1.c
tree2_SOURCES = tree2.c
xpath1_SOURCES = xpath1.c
xpath2_SOURCES = xpath2.c
valgrind:
$(MAKE) CHECKER='valgrind' check
check-local:
@test -f Makefile.am || test -f test1.xml || $(LN_S) $(srcdir)/test?.xml .
@(echo '## examples regression tests')
@$(CHECKER) ./io1 >/dev/null
@$(CHECKER) ./io2 >/dev/null
@$(CHECKER) ./parse1 test1.xml
@$(CHECKER) ./parse2 test2.xml
@$(CHECKER) ./parse3
@$(CHECKER) ./parse4 test3.xml
@$(CHECKER) ./reader1 test2.xml >/dev/null
@$(CHECKER) ./reader2 test2.xml >/dev/null
@$(CHECKER) ./reader3 >/dev/null
@$(CHECKER) ./reader4 test1.xml test2.xml test3.xml >/dev/null
@$(CHECKER) ./testWriter
@$(CHECKER) ./tree1 test2.xml >/dev/null
@$(CHECKER) ./tree2 >/dev/null
@$(CHECKER) ./xpath1 test3.xml '//child2' >/dev/null
@$(CHECKER) ./xpath2 test3.xml '//discarded' discarded >/dev/null

723
doc/examples/examples.xml
View File

@ -1,723 +0,0 @@
<examples>
<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 &gt; io1.tmp &amp;&amp; diff io1.tmp $(srcdir)/io1.res</test>
<author>Daniel Veillard</author>
<copy>see Copyright for the status of this software. </copy>
<section>InputOutput</section>
<includes>
<include line='17'>&lt;libxml/parser.h&gt;</include>
<include line='18'>&lt;libxml/tree.h&gt;</include>
<include line='19'>&lt;libxml/xinclude.h&gt;</include>
<include line='20'>&lt;libxml/xmlIO.h&gt;</include>
</includes>
<uses>
<macro line='118' file='xmlversion' name='LIBXML_TEST_VERSION'/>
<function line='144' file='tree' name='xmlDocDump'/>
<typedef line='106' file='tree' name='xmlDocPtr'/>
<function line='150' file='tree' name='xmlFreeDoc'/>
<function line='125' file='parser' name='xmlReadMemory'/>
<function line='118' file='xmlIO' name='xmlRegisterInputCallbacks'/>
<function line='135' file='xinclude' name='xmlXIncludeProcess'/>
</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 &gt; io2.tmp &amp;&amp; diff io2.tmp $(srcdir)/io2.res</test>
<author>John Fleck</author>
<copy>see Copyright for the status of this software. </copy>
<section>InputOutput</section>
<includes>
<include line='12'>&lt;libxml/parser.h&gt;</include>
</includes>
<uses>
<function line='36' file='tree' name='xmlDocDumpFormatMemory'/>
<typedef line='20' file='tree' name='xmlDocPtr'/>
<function line='30' file='tree' name='xmlDocSetRootElement'/>
<variable line='42' file='xmlmemory' name='xmlFree'/>
<function line='43' file='tree' name='xmlFreeDoc'/>
<function line='27' file='tree' name='xmlNewDoc'/>
<function line='28' file='tree' name='xmlNewDocNode'/>
<typedef line='19' file='tree' name='xmlNodePtr'/>
<function line='29' file='tree' name='xmlNodeSetContent'/>
</uses>
</example>
<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 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 line='13'>&lt;libxml/parser.h&gt;</include>
<include line='14'>&lt;libxml/tree.h&gt;</include>
</includes>
<uses>
<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='parse2.c'>
<synopsis>Parse and validate an XML file to a tree and free the result</synopsis>
<purpose>Create a parser context for an XML file, then parse and validate the file, creating a tree, check the validation result and xmlFreeDoc() to free the resulting tree.</purpose>
<usage>parse2 test2.xml</usage>
<test>parse2 test2.xml</test>
<author>Daniel Veillard</author>
<copy>see Copyright for the status of this software. </copy>
<section>Parsing</section>
<includes>
<include line='14'>&lt;libxml/parser.h&gt;</include>
<include line='15'>&lt;libxml/tree.h&gt;</include>
</includes>
<uses>
<macro line='61' file='xmlversion' name='LIBXML_TEST_VERSION'/>
<enum line='35' file='parser' name='XML_PARSE_DTDVALID'/>
<function line='35' file='parser' name='xmlCtxtReadFile'/>
<typedef line='26' file='tree' name='xmlDocPtr'/>
<function line='44' file='tree' name='xmlFreeDoc'/>
<function line='47' file='parser' name='xmlFreeParserCtxt'/>
<function line='29' file='parser' name='xmlNewParserCtxt'/>
<typedef line='25' file='tree' name='xmlParserCtxtPtr'/>
</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 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 line='13'>&lt;libxml/parser.h&gt;</include>
<include line='14'>&lt;libxml/tree.h&gt;</include>
</includes>
<uses>
<macro line='49' file='xmlversion' name='LIBXML_TEST_VERSION'/>
<typedef line='27' file='tree' name='xmlDocPtr'/>
<function line='38' file='tree' name='xmlFreeDoc'/>
<function line='33' file='parser' name='xmlReadMemory'/>
</uses>
</example>
<example filename='parse4.c'>
<synopsis>Parse an XML document chunk by chunk to a tree and free it</synopsis>
<purpose>Demonstrate the use of xmlCreatePushParserCtxt() and xmlParseChunk() to read an XML file progressively into a tree and xmlFreeDoc() to free the resulting tree</purpose>
<usage>parse4 test3.xml</usage>
<test>parse4 test3.xml</test>
<author>Daniel Veillard</author>
<copy>see Copyright for the status of this software. </copy>
<section>Parsing</section>
<includes>
<include line='14'>&lt;libxml/parser.h&gt;</include>
<include line='15'>&lt;libxml/tree.h&gt;</include>
</includes>
<uses>
<macro line='120' file='xmlversion' name='LIBXML_TEST_VERSION'/>
<function line='67' file='parser' name='xmlCreatePushParserCtxt'/>
<typedef line='47' file='tree' name='xmlDocPtr'/>
<function line='103' file='tree' name='xmlFreeDoc'/>
<function line='94' file='parser' name='xmlFreeParserCtxt'/>
<function line='80' file='parser' name='xmlParseChunk'/>
<typedef line='45' file='tree' name='xmlParserCtxtPtr'/>
</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 information about the nodes found in the process. (Note that the XMLReader functions require libxml2 version later than 2.6.)</purpose>
<usage>reader1 &lt;filename&gt;</usage>
<test>reader1 test2.xml &gt; reader1.tmp &amp;&amp; diff reader1.tmp $(srcdir)/reader1.res</test>
<author>Daniel Veillard</author>
<copy>see Copyright for the status of this software. </copy>
<section>xmlReader</section>
<includes>
<include line='15'>&lt;libxml/xmlreader.h&gt;</include>
</includes>
<uses>
<macro line='89' file='xmlversion' name='LIBXML_TEST_VERSION'/>
<function line='69' file='xmlreader' name='xmlFreeTextReader'/>
<function line='62' file='xmlreader' name='xmlReaderForFile'/>
<function line='44' file='xmlstring' name='xmlStrlen'/>
<function line='29' file='xmlreader' name='xmlTextReaderConstName'/>
<function line='33' file='xmlreader' name='xmlTextReaderConstValue'/>
<function line='36' file='xmlreader' name='xmlTextReaderDepth'/>
<function line='40' file='xmlreader' name='xmlTextReaderHasValue'/>
<function line='39' file='xmlreader' name='xmlTextReaderIsEmptyElement'/>
<function line='37' file='xmlreader' name='xmlTextReaderNodeType'/>
<typedef line='59' file='xmlreader' name='xmlTextReaderPtr'/>
<function line='64' file='xmlreader' name='xmlTextReaderRead'/>
</uses>
</example>
<example filename='reader2.c'>
<synopsis>Parse and validate an XML file with an xmlReader</synopsis>
<purpose>Demonstrate the use of xmlReaderForFile() to parse an XML file validating the content in the process and activating options like entities substitution, and DTD attributes defaulting. (Note that the XMLReader functions require libxml2 version later than 2.6.)</purpose>
<usage>reader2 &lt;valid_xml_filename&gt;</usage>
<test>reader2 test2.xml &gt; reader1.tmp &amp;&amp; diff reader1.tmp $(srcdir)/reader1.res</test>
<author>Daniel Veillard</author>
<copy>see Copyright for the status of this software. </copy>
<section>xmlReader</section>
<includes>
<include line='17'>&lt;libxml/parser.h&gt;</include>
<include line='16'>&lt;libxml/xmlreader.h&gt;</include>
</includes>
<uses>
<enum line='70' file='parser' name='XML_PARSE_DTDATTR'/>
<enum line='72' file='parser' name='XML_PARSE_DTDVALID'/>
<enum line='71' file='parser' name='XML_PARSE_NOENT'/>
<function line='85' file='xmlreader' name='xmlFreeTextReader'/>
<function line='69' file='xmlreader' name='xmlReaderForFile'/>
<function line='46' file='xmlstring' name='xmlStrlen'/>
<function line='31' file='xmlreader' name='xmlTextReaderConstName'/>
<function line='35' file='xmlreader' name='xmlTextReaderConstValue'/>
<function line='38' file='xmlreader' name='xmlTextReaderDepth'/>
<function line='42' file='xmlreader' name='xmlTextReaderHasValue'/>
<function line='41' file='xmlreader' name='xmlTextReaderIsEmptyElement'/>
<function line='82' file='xmlreader' name='xmlTextReaderIsValid'/>
<function line='39' file='xmlreader' name='xmlTextReaderNodeType'/>
<typedef line='61' file='xmlreader' name='xmlTextReaderPtr'/>
<function line='74' file='xmlreader' name='xmlTextReaderRead'/>
</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 &gt; reader3.tmp &amp;&amp; diff reader3.tmp $(srcdir)/reader3.res</test>
<author>Daniel Veillard</author>
<copy>see Copyright for the status of this software. </copy>
<section>xmlReader</section>
<includes>
<include line='16'>&lt;libxml/xmlreader.h&gt;</include>
</includes>
<uses>
<function line='96' file='tree' name='xmlDocDump'/>
<function line='56' file='xmlreader' name='xmlFreeTextReader'/>
<function line='38' file='xmlreader' name='xmlReaderForFile'/>
<function line='62' file='xmlreader' name='xmlTextReaderCurrentDoc'/>
<function line='43' file='xmlreader' name='xmlTextReaderPreservePattern'/>
<typedef line='32' file='xmlreader' name='xmlTextReaderPtr'/>
<function line='50' file='xmlreader' name='xmlTextReaderRead'/>
</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 &lt;filename&gt; [ filename ... ]</usage>
<test>reader4 test1.xml test2.xml test3.xml &gt; reader4.tmp &amp;&amp; diff reader4.tmp $(srcdir)/reader4.res</test>
<author>Graham Bennett</author>
<copy>see Copyright for the status of this software. </copy>
<section>xmlReader</section>
<includes>
<include line='15'>&lt;libxml/xmlreader.h&gt;</include>
</includes>
<uses>
<function line='104' file='xmlreader' name='xmlFreeTextReader'/>
<function line='72' file='xmlreader' name='xmlReaderForFile'/>
<function line='83' file='xmlreader' name='xmlReaderNewFile'/>
<function line='34' file='xmlreader' name='xmlTextReaderCurrentDoc'/>
<typedef line='54' file='xmlreader' name='xmlTextReaderPtr'/>
<function line='24' file='xmlreader' name='xmlTextReaderRead'/>
</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 &amp;&amp; for i in 1 2 3 4 ; do diff $(srcdir)/writer.xml writer$$i.tmp || break ; done</test>
<author>Alfred Mickautsch</author>
<copy>see Copyright for the status of this software. </copy>
<section>xmlWriter</section>
<includes>
<include line='16'>&lt;libxml/encoding.h&gt;</include>
<include line='18'>&lt;libxml/parser.h&gt;</include>
<include line='17'>&lt;libxml/xmlwriter.h&gt;</include>
</includes>
<uses>
<macro line='878' file='parser' name='XML_DEFAULT_VERSION'/>
<function line='340' file='tree' name='xmlBufferCreate'/>
<function line='606' file='tree' name='xmlBufferFree'/>
<typedef line='334' file='tree' name='xmlBufferPtr'/>
<typedef line='1144' file='encoding' name='xmlCharEncodingHandlerPtr'/>
<function line='894' file='tree' name='xmlDocSetRootElement'/>
<function line='1149' file='encoding' name='xmlFindCharEncodingHandler'/>
<variable line='106' file='xmlmemory' name='xmlFree'/>
<function line='320' file='xmlwriter' name='xmlFreeTextWriter'/>
<variable line='1159' file='xmlmemory' name='xmlMalloc'/>
<function line='878' file='tree' name='xmlNewDoc'/>
<function line='887' file='tree' name='xmlNewDocNode'/>
<function line='625' file='xmlwriter' name='xmlNewTextWriterDoc'/>
<function line='69' file='xmlwriter' name='xmlNewTextWriterFilename'/>
<function line='348' file='xmlwriter' name='xmlNewTextWriterMemory'/>
<function line='897' file='xmlwriter' name='xmlNewTextWriterTree'/>
<typedef line='873' file='tree' name='xmlNodePtr'/>
<variable line='1176' file='xmlmemory' name='xmlRealloc'/>
<function line='856' file='tree' name='xmlSaveFileEnc'/>
<function line='313' file='xmlwriter' name='xmlTextWriterEndDocument'/>
<function line='193' file='xmlwriter' name='xmlTextWriterEndElement'/>
<typedef line='65' file='xmlwriter' name='xmlTextWriterPtr'/>
<function line='78' file='xmlwriter' name='xmlTextWriterStartDocument'/>
<function line='87' file='xmlwriter' name='xmlTextWriterStartElement'/>
<function line='117' file='xmlwriter' name='xmlTextWriterWriteAttribute'/>
<function line='100' file='xmlwriter' name='xmlTextWriterWriteComment'/>
<function line='174' file='xmlwriter' name='xmlTextWriterWriteElement'/>
<function line='136' file='xmlwriter' name='xmlTextWriterWriteFormatComment'/>
<function line='155' file='xmlwriter' name='xmlTextWriterWriteFormatElement'/>
</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 &gt; tree1.tmp &amp;&amp; diff tree1.tmp $(srcdir)/tree1.res</test>
<author>Dodji Seketeli</author>
<copy>see Copyright for the status of this software. </copy>
<section>Tree</section>
<includes>
<include line='13'>&lt;libxml/parser.h&gt;</include>
<include line='14'>&lt;libxml/tree.h&gt;</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>
<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 &lt;filename&gt; -Default output: stdout</usage>
<test>tree2 &gt; tree2.tmp &amp;&amp; diff tree2.tmp $(srcdir)/tree2.res</test>
<author>Lucas Brasilino &lt;brasilino@recife.pe.gov.br&gt;</author>
<copy>see Copyright for the status of this software </copy>
<section>Tree</section>
<includes>
<include line='12'>&lt;libxml/parser.h&gt;</include>
<include line='13'>&lt;libxml/tree.h&gt;</include>
</includes>
<uses>
<function line='76' file='tree' name='xmlAddChild'/>
<function line='45' file='tree' name='xmlCreateIntSubset'/>
<function line='40' file='tree' name='xmlDocSetRootElement'/>
<function line='51' file='tree' name='xmlNewChild'/>
<function line='38' file='tree' name='xmlNewDoc'/>
<function line='39' file='tree' name='xmlNewDocNode'/>
<function line='74' file='tree' name='xmlNewDocText'/>
<function line='65' file='tree' name='xmlNewProp'/>
<function line='95' file='tree' name='xmlSaveFormatFileEnc'/>
</uses>
</example>
<example filename='xpath1.c'>
<synopsis>Evaluate XPath expression and prints result node set.</synopsis>
<purpose>Shows how to evaluate XPath expression and register known namespaces in XPath context.</purpose>
<usage>xpath1 &lt;xml-file&gt; &lt;xpath-expr&gt; [&lt;known-ns-list&gt;]</usage>
<test>xpath1 test3.xml &apos;//child2&apos; &gt; xpath1.tmp &amp;&amp; diff xpath1.tmp $(srcdir)/xpath1.res</test>
<author>Aleksey Sanin</author>
<copy>see Copyright for the status of this software. </copy>
<section>XPath</section>
<includes>
<include line='17'>&lt;libxml/parser.h&gt;</include>
<include line='16'>&lt;libxml/tree.h&gt;</include>
<include line='18'>&lt;libxml/xpath.h&gt;</include>
<include line='19'>&lt;libxml/xpathInternals.h&gt;</include>
</includes>
<uses>
<enum line='222' file='tree' name='XML_ELEMENT_NODE'/>
<enum line='210' file='tree' name='XML_NAMESPACE_DECL'/>
<variable line='166' file='xmlmemory' name='xmlFree'/>
<function line='39' file='parser' name='xmlInitParser'/>
<typedef line='199' file='tree' name='xmlNodePtr'/>
<typedef line='211' file='tree' name='xmlNsPtr'/>
<function line='87' file='parser' name='xmlParseFile'/>
<function line='163' file='xmlstring' name='xmlStrchr'/>
<function line='149' file='xmlstring' name='xmlStrdup'/>
<typedef line='80' file='xpath' name='xmlXPathContextPtr'/>
<function line='110' file='xpath' name='xmlXPathEvalExpression'/>
<function line='104' file='xpath' name='xmlXPathFreeContext'/>
<function line='122' file='xpath' name='xmlXPathFreeObject'/>
<function line='94' file='xpath' name='xmlXPathNewContext'/>
<typedef line='81' file='xpath' name='xmlXPathObjectPtr'/>
<function line='179' file='xpathInternals' name='xmlXPathRegisterNs'/>
</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>
<usage>xpath2 &lt;xml-file&gt; &lt;xpath-expr&gt; &lt;new-value&gt;</usage>
<test>xpath2 test3.xml &apos;//discarded&apos; discarded &gt; xpath2.tmp &amp;&amp; diff xpath2.tmp $(srcdir)/xpath2.res</test>
<author>Aleksey Sanin and Daniel Veillard</author>
<copy>see Copyright for the status of this software. </copy>
<section>XPath</section>
<includes>
<include line='17'>&lt;libxml/parser.h&gt;</include>
<include line='16'>&lt;libxml/tree.h&gt;</include>
<include line='18'>&lt;libxml/xpath.h&gt;</include>
<include line='19'>&lt;libxml/xpathInternals.h&gt;</include>
</includes>
<uses>
<enum line='173' file='tree' name='XML_NAMESPACE_DECL'/>
<function line='120' file='tree' name='xmlDocDump'/>
<function line='41' file='parser' name='xmlInitParser'/>
<function line='155' file='tree' name='xmlNodeSetContent'/>
<function line='88' file='parser' name='xmlParseFile'/>
<typedef line='80' file='xpath' name='xmlXPathContextPtr'/>
<function line='103' file='xpath' name='xmlXPathEvalExpression'/>
<function line='106' file='xpath' name='xmlXPathFreeContext'/>
<function line='116' file='xpath' name='xmlXPathFreeObject'/>
<function line='95' file='xpath' name='xmlXPathNewContext'/>
<typedef line='81' file='xpath' name='xmlXPathObjectPtr'/>
</uses>
</example>
<symbols>
<symbol name='LIBXML_TEST_VERSION'>
<ref filename='io1.c'/>
<ref filename='parse1.c'/>
<ref filename='parse2.c'/>
<ref filename='parse3.c'/>
<ref filename='parse4.c'/>
<ref filename='reader1.c'/>
</symbol>
<symbol name='XML_DEFAULT_VERSION'>
<ref filename='testWriter.c'/>
</symbol>
<symbol name='XML_ELEMENT_NODE'>
<ref filename='tree1.c'/>
<ref filename='xpath1.c'/>
</symbol>
<symbol name='XML_NAMESPACE_DECL'>
<ref filename='xpath1.c'/>
<ref filename='xpath2.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='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='io1.c'/>
<ref filename='reader3.c'/>
<ref filename='xpath2.c'/>
</symbol>
<symbol name='xmlDocDumpFormatMemory'>
<ref filename='io2.c'/>
</symbol>
<symbol name='xmlDocGetRootElement'>
<ref filename='tree1.c'/>
</symbol>
<symbol name='xmlDocPtr'>
<ref filename='io1.c'/>
<ref filename='io2.c'/>
<ref filename='parse1.c'/>
<ref filename='parse2.c'/>
<ref filename='parse3.c'/>
<ref filename='parse4.c'/>
</symbol>
<symbol name='xmlDocSetRootElement'>
<ref filename='io2.c'/>
<ref filename='testWriter.c'/>
<ref filename='tree2.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='io1.c'/>
<ref filename='io2.c'/>
<ref filename='parse1.c'/>
<ref filename='parse2.c'/>
<ref filename='parse3.c'/>
<ref filename='parse4.c'/>
</symbol>
<symbol name='xmlFreeParserCtxt'>
<ref filename='parse2.c'/>
<ref filename='parse4.c'/>
</symbol>
<symbol name='xmlFreeTextReader'>
<ref filename='reader1.c'/>
<ref filename='reader2.c'/>
<ref filename='reader3.c'/>
<ref filename='reader4.c'/>
</symbol>
<symbol name='xmlFreeTextWriter'>
<ref filename='testWriter.c'/>
</symbol>
<symbol name='xmlInitParser'>
<ref filename='xpath1.c'/>
<ref filename='xpath2.c'/>
</symbol>
<symbol name='xmlMalloc'>
<ref filename='testWriter.c'/>
</symbol>
<symbol name='xmlNewChild'>
<ref filename='tree2.c'/>
</symbol>
<symbol name='xmlNewDoc'>
<ref filename='io2.c'/>
<ref filename='testWriter.c'/>
<ref filename='tree2.c'/>
</symbol>
<symbol name='xmlNewDocNode'>
<ref filename='io2.c'/>
<ref filename='testWriter.c'/>
<ref filename='tree2.c'/>
</symbol>
<symbol name='xmlNewDocText'>
<ref filename='tree2.c'/>
</symbol>
<symbol name='xmlNewParserCtxt'>
<ref filename='parse2.c'/>
</symbol>
<symbol name='xmlNewProp'>
<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='io2.c'/>
<ref filename='xpath2.c'/>
</symbol>
<symbol name='xmlNsPtr'>
<ref filename='xpath1.c'/>
</symbol>
<symbol name='xmlParseChunk'>
<ref filename='parse4.c'/>
</symbol>
<symbol name='xmlParseFile'>
<ref filename='xpath1.c'/>
<ref filename='xpath2.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='io1.c'/>
<ref filename='parse3.c'/>
</symbol>
<symbol name='xmlReaderForFile'>
<ref filename='reader1.c'/>
<ref filename='reader2.c'/>
<ref filename='reader3.c'/>
<ref filename='reader4.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='reader3.c'/>
<ref filename='reader4.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='reader2.c'/>
<ref filename='reader3.c'/>
<ref filename='reader4.c'/>
</symbol>
<symbol name='xmlTextReaderRead'>
<ref filename='reader1.c'/>
<ref filename='reader2.c'/>
<ref filename='reader3.c'/>
<ref filename='reader4.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='xpath1.c'/>
<ref filename='xpath2.c'/>
</symbol>
<symbol name='xmlXPathEvalExpression'>
<ref filename='xpath1.c'/>
<ref filename='xpath2.c'/>
</symbol>
<symbol name='xmlXPathFreeContext'>
<ref filename='xpath1.c'/>
<ref filename='xpath2.c'/>
</symbol>
<symbol name='xmlXPathFreeObject'>
<ref filename='xpath1.c'/>
<ref filename='xpath2.c'/>
</symbol>
<symbol name='xmlXPathNewContext'>
<ref filename='xpath1.c'/>
<ref filename='xpath2.c'/>
</symbol>
<symbol name='xmlXPathObjectPtr'>
<ref filename='xpath1.c'/>
<ref filename='xpath2.c'/>
</symbol>
<symbol name='xmlXPathRegisterNs'>
<ref filename='xpath1.c'/>
</symbol>
</symbols>
<sections>
<section name='InputOutput'>
<example filename='io1.c'/>
<example filename='io2.c'/>
</section>
<section name='Parsing'>
<example filename='parse1.c'/>
<example filename='parse2.c'/>
<example filename='parse3.c'/>
<example filename='parse4.c'/>
</section>
<section name='Tree'>
<example filename='tree1.c'/>
<example filename='tree2.c'/>
</section>
<section name='XPath'>
<example filename='xpath1.c'/>
<example filename='xpath2.c'/>
</section>
<section name='xmlReader'>
<example filename='reader1.c'/>
<example filename='reader2.c'/>
<example filename='reader3.c'/>
<example filename='reader4.c'/>
</section>
<section name='xmlWriter'>
<example filename='testWriter.c'/>
</section>
</sections>
</examples>

112
doc/examples/examples.xsl
View File

@ -1,112 +0,0 @@
<?xml version="1.0"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:variable name="apidoc-prefix">https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-</xsl:variable>
<xsl:template match="include">
<xsl:variable name="header" select="substring-before(substring-after(., '/'), '&gt;')"/>
<xsl:variable name="doc" select="concat($apidoc-prefix, $header, 'tml')"/>
<li><a href="{$doc}"><xsl:value-of select="."/></a></li>
</xsl:template>
<xsl:template match="typedef">
<xsl:variable name="name" select="@name"/>
<xsl:variable name="header" select="concat(@file, '.h')"/>
<xsl:variable name="doc" select="concat($apidoc-prefix, @file, '.html#', $name)"/>
<li> line <xsl:value-of select="@line"/>: Type <a href="{$doc}"><xsl:value-of select="$name"/></a> from <xsl:value-of select="$header"/></li>
</xsl:template>
<xsl:template match="function">
<xsl:variable name="name" select="@name"/>
<xsl:variable name="header" select="concat(@file, '.h')"/>
<xsl:variable name="doc" select="concat($apidoc-prefix, @file, '.html#', $name)"/>
<li> line <xsl:value-of select="@line"/>: Function <a href="{$doc}"><xsl:value-of select="$name"/></a> from <xsl:value-of select="$header"/></li>
</xsl:template>
<xsl:template match="macro">
<xsl:variable name="name" select="@name"/>
<xsl:variable name="header" select="concat(@file, '.h')"/>
<xsl:variable name="doc" select="concat($apidoc-prefix, @file, '.html#', $name)"/>
<li> line <xsl:value-of select="@line"/>: Macro <a href="{$doc}"><xsl:value-of select="$name"/></a> from <xsl:value-of select="$header"/></li>
</xsl:template>
<xsl:template match="example">
<xsl:variable name="filename" select="string(@filename)"/>
<h3><a name="{$filename}" href="{$filename}"><xsl:value-of select="$filename"/></a>: <xsl:value-of select="synopsis"/></h3>
<p><xsl:value-of select="purpose"/></p>
<p>Includes:</p>
<ul>
<xsl:for-each select="includes/include">
<xsl:sort select="@line" data-type="number"/>
<xsl:apply-templates select='.'/>
</xsl:for-each>
</ul>
<p>Uses:</p>
<ul>
<xsl:for-each select="uses/*">
<xsl:sort select="@line" data-type="number"/>
<xsl:apply-templates select='.'/>
</xsl:for-each>
</ul>
<p>Usage:</p>
<p><xsl:value-of select="usage"/></p>
<p>Author: <xsl:value-of select="author"/></p>
</xsl:template>
<xsl:template match="section">
<li><p> <a href="#{@name}"><xsl:value-of select="@name"/></a> :</p>
<ul>
<xsl:for-each select="example">
<xsl:sort select='.'/>
<xsl:variable name="filename" select="@filename"/>
<li> <a href="#{$filename}"><xsl:value-of select="$filename"/></a>: <xsl:value-of select="/examples/example[@filename = $filename]/synopsis"/></li>
</xsl:for-each>
</ul>
</li>
</xsl:template>
<xsl:template match="sections">
<p> The examples are stored per section depending on the main focus
of the example:</p>
<ul>
<xsl:for-each select="section">
<xsl:sort select='.'/>
<xsl:apply-templates select='.'/>
</xsl:for-each>
</ul>
<p> Getting the compilation options and libraries dependencies needed
to generate binaries from the examples is best done on Linux/Unix by using
the xml2-config script which should have been installed as part of <i>make
install</i> step or when installing the libxml2 development package:</p>
<pre>gcc -o example `xml2-config --cflags` example.c `xml2-config --libs`</pre>
</xsl:template>
<xsl:template name="sections-list">
<xsl:for-each select="sections/section">
<xsl:variable name="section" select="@name"/>
<h2> <a name="{$section}"></a><xsl:value-of select="$section"/> Examples</h2>
<xsl:apply-templates select='/examples/example[section = $section]'/>
</xsl:for-each>
</xsl:template>
<xsl:template match="examples">
<xsl:variable name="title">Libxml2 set of examples</xsl:variable>
<xsl:document href="index.html" method="xml" indent="yes" omit-xml-declaration="yes"
doctype-public="-//W3C//DTD XHTML 1.0 Transitional//EN"
doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<title>
<xsl:value-of select="$title"/>
</title>
</head>
<body>
<h1><xsl:value-of select="$title"/></h1>
<xsl:apply-templates select="sections"/>
<xsl:call-template name="sections-list"/>
</body>
</html>
</xsl:document>
</xsl:template>
</xsl:stylesheet>

468
doc/examples/index.html
View File

@ -1,468 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Libxml2 set of examples</title>
</head>
<body>
<h1>Libxml2 set of examples</h1>
<p> The examples are stored per section depending on the main focus
of the example:</p>
<ul>
<li>
<p><a href="#xmlWriter">xmlWriter</a> :</p>
<ul>
<li><a href="#testWriter.c">testWriter.c</a>: use various APIs for the xmlWriter</li>
</ul>
</li>
<li>
<p><a href="#InputOutput">InputOutput</a> :</p>
<ul>
<li><a href="#io1.c">io1.c</a>: Example of custom Input/Output</li>
<li><a href="#io2.c">io2.c</a>: Output to char buffer</li>
</ul>
</li>
<li>
<p><a href="#Tree">Tree</a> :</p>
<ul>
<li><a href="#tree1.c">tree1.c</a>: Navigates a tree to print element names</li>
<li><a href="#tree2.c">tree2.c</a>: Creates a tree</li>
</ul>
</li>
<li>
<p><a href="#XPath">XPath</a> :</p>
<ul>
<li><a href="#xpath1.c">xpath1.c</a>: Evaluate XPath expression and prints result node set.</li>
<li><a href="#xpath2.c">xpath2.c</a>: Load a document, locate subelements with XPath, modify said elements and save the resulting document.</li>
</ul>
</li>
<li>
<p><a href="#Parsing">Parsing</a> :</p>
<ul>
<li><a href="#parse1.c">parse1.c</a>: Parse an XML file to a tree and free it</li>
<li><a href="#parse2.c">parse2.c</a>: Parse and validate an XML file to a tree and free the result</li>
<li><a href="#parse3.c">parse3.c</a>: Parse an XML document in memory to a tree and free it</li>
<li><a href="#parse4.c">parse4.c</a>: Parse an XML document chunk by chunk to a tree and free it</li>
</ul>
</li>
<li>
<p><a href="#xmlReader">xmlReader</a> :</p>
<ul>
<li><a href="#reader1.c">reader1.c</a>: Parse an XML file with an xmlReader</li>
<li><a href="#reader2.c">reader2.c</a>: Parse and validate an XML file with an xmlReader</li>
<li><a href="#reader3.c">reader3.c</a>: Show how to extract subdocuments with xmlReader</li>
<li><a href="#reader4.c">reader4.c</a>: Parse multiple XML files reusing an xmlReader</li>
</ul>
</li>
</ul>
<p> Getting the compilation options and libraries dependencies needed
to generate binaries from the examples is best done on Linux/Unix by using
the xml2-config script which should have been installed as part of <i>make
install</i> step or when installing the libxml2 development package:</p>
<pre>gcc -o example `xml2-config --cflags` example.c `xml2-config --libs`</pre>
<h2><a name="InputOutput" id="InputOutput"></a>InputOutput Examples</h2>
<h3><a name="io1.c" href="io1.c" id="io1.c">io1.c</a>: Example of custom Input/Output</h3>
<p>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.</p>
<p>Includes:</p>
<ul>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html">&lt;libxml/parser.h&gt;</a>
</li>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html">&lt;libxml/tree.h&gt;</a>
</li>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xinclude.html">&lt;libxml/xinclude.h&gt;</a>
</li>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlIO.html">&lt;libxml/xmlIO.h&gt;</a>
</li>
</ul>
<p>Uses:</p>
<ul>
<li> line 106: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> from tree.h</li>
<li> line 118: Macro <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlversion.html#LIBXML_TEST_VERSION">LIBXML_TEST_VERSION</a> from xmlversion.h</li>
<li> line 118: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlIO.html#xmlRegisterInputCallbacks">xmlRegisterInputCallbacks</a> from xmlIO.h</li>
<li> line 125: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html#xmlReadMemory">xmlReadMemory</a> from parser.h</li>
<li> line 135: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xinclude.html#xmlXIncludeProcess">xmlXIncludeProcess</a> from xinclude.h</li>
<li> line 144: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlDocDump">xmlDocDump</a> from tree.h</li>
<li> line 150: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlFreeDoc">xmlFreeDoc</a> from tree.h</li>
</ul>
<p>Usage:</p>
<p>io1</p>
<p>Author: Daniel Veillard</p>
<h3><a name="io2.c" href="io2.c" id="io2.c">io2.c</a>: Output to char buffer</h3>
<p>Demonstrate the use of xmlDocDumpMemory to output document to a character buffer</p>
<p>Includes:</p>
<ul>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html">&lt;libxml/parser.h&gt;</a>
</li>
</ul>
<p>Uses:</p>
<ul>
<li> line 19: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> from tree.h</li>
<li> line 20: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> from tree.h</li>
<li> line 27: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlNewDoc">xmlNewDoc</a> from tree.h</li>
<li> line 28: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlNewDocNode">xmlNewDocNode</a> from tree.h</li>
<li> line 29: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlNodeSetContent">xmlNodeSetContent</a> from tree.h</li>
<li> line 30: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlDocSetRootElement">xmlDocSetRootElement</a> from tree.h</li>
<li> line 36: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlDocDumpFormatMemory">xmlDocDumpFormatMemory</a> from tree.h</li>
<li> line 43: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlFreeDoc">xmlFreeDoc</a> from tree.h</li>
</ul>
<p>Usage:</p>
<p>io2</p>
<p>Author: John Fleck</p>
<h2><a name="Parsing" id="Parsing"></a>Parsing Examples</h2>
<h3><a name="parse1.c" href="parse1.c" id="parse1.c">parse1.c</a>: Parse an XML file to a tree and free it</h3>
<p>Demonstrate the use of xmlReadFile() to read an XML file into a tree and xmlFreeDoc() to free the resulting tree</p>
<p>Includes:</p>
<ul>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html">&lt;libxml/parser.h&gt;</a>
</li>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html">&lt;libxml/tree.h&gt;</a>
</li>
</ul>
<p>Uses:</p>
<ul>
<li> line 24: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> from tree.h</li>
<li> line 26: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html#xmlReadFile">xmlReadFile</a> from parser.h</li>
<li> line 31: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlFreeDoc">xmlFreeDoc</a> from tree.h</li>
<li> line 45: Macro <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlversion.html#LIBXML_TEST_VERSION">LIBXML_TEST_VERSION</a> from xmlversion.h</li>
</ul>
<p>Usage:</p>
<p>parse1 test1.xml</p>
<p>Author: Daniel Veillard</p>
<h3><a name="parse2.c" href="parse2.c" id="parse2.c">parse2.c</a>: Parse and validate an XML file to a tree and free the result</h3>
<p>Create a parser context for an XML file, then parse and validate the file, creating a tree, check the validation result and xmlFreeDoc() to free the resulting tree.</p>
<p>Includes:</p>
<ul>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html">&lt;libxml/parser.h&gt;</a>
</li>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html">&lt;libxml/tree.h&gt;</a>
</li>
</ul>
<p>Uses:</p>
<ul>
<li> line 25: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> from tree.h</li>
<li> line 26: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> from tree.h</li>
<li> line 29: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html#xmlNewParserCtxt">xmlNewParserCtxt</a> from parser.h</li>
<li> line 35: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html#xmlCtxtReadFile">xmlCtxtReadFile</a> from parser.h</li>
<li> line 44: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlFreeDoc">xmlFreeDoc</a> from tree.h</li>
<li> line 47: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html#xmlFreeParserCtxt">xmlFreeParserCtxt</a> from parser.h</li>
<li> line 61: Macro <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlversion.html#LIBXML_TEST_VERSION">LIBXML_TEST_VERSION</a> from xmlversion.h</li>
</ul>
<p>Usage:</p>
<p>parse2 test2.xml</p>
<p>Author: Daniel Veillard</p>
<h3><a name="parse3.c" href="parse3.c" id="parse3.c">parse3.c</a>: Parse an XML document in memory to a tree and free it</h3>
<p>Demonstrate the use of xmlReadMemory() to read an XML file into a tree and xmlFreeDoc() to free the resulting tree</p>
<p>Includes:</p>
<ul>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html">&lt;libxml/parser.h&gt;</a>
</li>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html">&lt;libxml/tree.h&gt;</a>
</li>
</ul>
<p>Uses:</p>
<ul>
<li> line 27: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> from tree.h</li>
<li> line 33: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html#xmlReadMemory">xmlReadMemory</a> from parser.h</li>
<li> line 38: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlFreeDoc">xmlFreeDoc</a> from tree.h</li>
<li> line 49: Macro <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlversion.html#LIBXML_TEST_VERSION">LIBXML_TEST_VERSION</a> from xmlversion.h</li>
</ul>
<p>Usage:</p>
<p>parse3</p>
<p>Author: Daniel Veillard</p>
<h3><a name="parse4.c" href="parse4.c" id="parse4.c">parse4.c</a>: Parse an XML document chunk by chunk to a tree and free it</h3>
<p>Demonstrate the use of xmlCreatePushParserCtxt() and xmlParseChunk() to read an XML file progressively into a tree and xmlFreeDoc() to free the resulting tree</p>
<p>Includes:</p>
<ul>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html">&lt;libxml/parser.h&gt;</a>
</li>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html">&lt;libxml/tree.h&gt;</a>
</li>
</ul>
<p>Uses:</p>
<ul>
<li> line 45: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> from tree.h</li>
<li> line 47: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> from tree.h</li>
<li> line 67: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html#xmlCreatePushParserCtxt">xmlCreatePushParserCtxt</a> from parser.h</li>
<li> line 80: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html#xmlParseChunk">xmlParseChunk</a> from parser.h</li>
<li> line 94: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html#xmlFreeParserCtxt">xmlFreeParserCtxt</a> from parser.h</li>
<li> line 103: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlFreeDoc">xmlFreeDoc</a> from tree.h</li>
<li> line 120: Macro <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlversion.html#LIBXML_TEST_VERSION">LIBXML_TEST_VERSION</a> from xmlversion.h</li>
</ul>
<p>Usage:</p>
<p>parse4 test3.xml</p>
<p>Author: Daniel Veillard</p>
<h2><a name="Tree" id="Tree"></a>Tree Examples</h2>
<h3><a name="tree1.c" href="tree1.c" id="tree1.c">tree1.c</a>: Navigates a tree to print element names</h3>
<p>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.</p>
<p>Includes:</p>
<ul>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html">&lt;libxml/parser.h&gt;</a>
</li>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html">&lt;libxml/tree.h&gt;</a>
</li>
</ul>
<p>Uses:</p>
<ul>
<li> line 67: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html#xmlReadFile">xmlReadFile</a> from parser.h</li>
<li> line 74: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlDocGetRootElement">xmlDocGetRootElement</a> from tree.h</li>
</ul>
<p>Usage:</p>
<p>tree1 filename_or_URL</p>
<p>Author: Dodji Seketeli</p>
<h3><a name="tree2.c" href="tree2.c" id="tree2.c">tree2.c</a>: Creates a tree</h3>
<p>Shows how to create document, nodes and dump it to stdout or file.</p>
<p>Includes:</p>
<ul>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html">&lt;libxml/parser.h&gt;</a>
</li>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html">&lt;libxml/tree.h&gt;</a>
</li>
</ul>
<p>Uses:</p>
<ul>
<li> line 38: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlNewDoc">xmlNewDoc</a> from tree.h</li>
<li> line 39: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlNewDocNode">xmlNewDocNode</a> from tree.h</li>
<li> line 40: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlDocSetRootElement">xmlDocSetRootElement</a> from tree.h</li>
<li> line 45: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlCreateIntSubset">xmlCreateIntSubset</a> from tree.h</li>
<li> line 51: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlNewChild">xmlNewChild</a> from tree.h</li>
<li> line 65: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlNewProp">xmlNewProp</a> from tree.h</li>
<li> line 74: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlNewDocText">xmlNewDocText</a> from tree.h</li>
<li> line 76: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlAddChild">xmlAddChild</a> from tree.h</li>
<li> line 95: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlSaveFormatFileEnc">xmlSaveFormatFileEnc</a> from tree.h</li>
</ul>
<p>Usage:</p>
<p>tree2 &lt;filename&gt; -Default output: stdout</p>
<p>Author: Lucas Brasilino &lt;brasilino@recife.pe.gov.br&gt;</p>
<h2><a name="XPath" id="XPath"></a>XPath Examples</h2>
<h3><a name="xpath1.c" href="xpath1.c" id="xpath1.c">xpath1.c</a>: Evaluate XPath expression and prints result node set.</h3>
<p>Shows how to evaluate XPath expression and register known namespaces in XPath context.</p>
<p>Includes:</p>
<ul>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html">&lt;libxml/tree.h&gt;</a>
</li>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html">&lt;libxml/parser.h&gt;</a>
</li>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xpath.html">&lt;libxml/xpath.h&gt;</a>
</li>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xpathInternals.html">&lt;libxml/xpathInternals.h&gt;</a>
</li>
</ul>
<p>Uses:</p>
<ul>
<li> line 39: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html#xmlInitParser">xmlInitParser</a> from parser.h</li>
<li> line 80: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xpath.html#xmlXPathContextPtr">xmlXPathContextPtr</a> from xpath.h</li>
<li> line 81: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xpath.html#xmlXPathObjectPtr">xmlXPathObjectPtr</a> from xpath.h</li>
<li> line 87: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html#xmlParseFile">xmlParseFile</a> from parser.h</li>
<li> line 94: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xpath.html#xmlXPathNewContext">xmlXPathNewContext</a> from xpath.h</li>
<li> line 104: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xpath.html#xmlXPathFreeContext">xmlXPathFreeContext</a> from xpath.h</li>
<li> line 110: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xpath.html#xmlXPathEvalExpression">xmlXPathEvalExpression</a> from xpath.h</li>
<li> line 122: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xpath.html#xmlXPathFreeObject">xmlXPathFreeObject</a> from xpath.h</li>
<li> line 149: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlstring.html#xmlStrdup">xmlStrdup</a> from xmlstring.h</li>
<li> line 163: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlstring.html#xmlStrchr">xmlStrchr</a> from xmlstring.h</li>
<li> line 179: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xpathInternals.html#xmlXPathRegisterNs">xmlXPathRegisterNs</a> from xpathInternals.h</li>
<li> line 199: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> from tree.h</li>
<li> line 211: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlNsPtr">xmlNsPtr</a> from tree.h</li>
</ul>
<p>Usage:</p>
<p>xpath1 &lt;xml-file&gt; &lt;xpath-expr&gt; [&lt;known-ns-list&gt;]</p>
<p>Author: Aleksey Sanin</p>
<h3><a name="xpath2.c" href="xpath2.c" id="xpath2.c">xpath2.c</a>: Load a document, locate subelements with XPath, modify said elements and save the resulting document.</h3>
<p>Shows how to make a full round-trip from a load/edit/save</p>
<p>Includes:</p>
<ul>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html">&lt;libxml/tree.h&gt;</a>
</li>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html">&lt;libxml/parser.h&gt;</a>
</li>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xpath.html">&lt;libxml/xpath.h&gt;</a>
</li>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xpathInternals.html">&lt;libxml/xpathInternals.h&gt;</a>
</li>
</ul>
<p>Uses:</p>
<ul>
<li> line 41: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html#xmlInitParser">xmlInitParser</a> from parser.h</li>
<li> line 80: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xpath.html#xmlXPathContextPtr">xmlXPathContextPtr</a> from xpath.h</li>
<li> line 81: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xpath.html#xmlXPathObjectPtr">xmlXPathObjectPtr</a> from xpath.h</li>
<li> line 88: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html#xmlParseFile">xmlParseFile</a> from parser.h</li>
<li> line 95: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xpath.html#xmlXPathNewContext">xmlXPathNewContext</a> from xpath.h</li>
<li> line 103: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xpath.html#xmlXPathEvalExpression">xmlXPathEvalExpression</a> from xpath.h</li>
<li> line 106: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xpath.html#xmlXPathFreeContext">xmlXPathFreeContext</a> from xpath.h</li>
<li> line 116: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xpath.html#xmlXPathFreeObject">xmlXPathFreeObject</a> from xpath.h</li>
<li> line 120: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlDocDump">xmlDocDump</a> from tree.h</li>
<li> line 155: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlNodeSetContent">xmlNodeSetContent</a> from tree.h</li>
</ul>
<p>Usage:</p>
<p>xpath2 &lt;xml-file&gt; &lt;xpath-expr&gt; &lt;new-value&gt;</p>
<p>Author: Aleksey Sanin and Daniel Veillard</p>
<h2><a name="xmlReader" id="xmlReader"></a>xmlReader Examples</h2>
<h3><a name="reader1.c" href="reader1.c" id="reader1.c">reader1.c</a>: Parse an XML file with an xmlReader</h3>
<p>Demonstrate the use of xmlReaderForFile() to parse an XML file and dump the information about the nodes found in the process. (Note that the XMLReader functions require libxml2 version later than 2.6.)</p>
<p>Includes:</p>
<ul>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html">&lt;libxml/xmlreader.h&gt;</a>
</li>
</ul>
<p>Uses:</p>
<ul>
<li> line 29: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderConstName">xmlTextReaderConstName</a> from xmlreader.h</li>
<li> line 33: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderConstValue">xmlTextReaderConstValue</a> from xmlreader.h</li>
<li> line 36: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderDepth">xmlTextReaderDepth</a> from xmlreader.h</li>
<li> line 37: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderNodeType">xmlTextReaderNodeType</a> from xmlreader.h</li>
<li> line 39: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderIsEmptyElement">xmlTextReaderIsEmptyElement</a> from xmlreader.h</li>
<li> line 40: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderHasValue">xmlTextReaderHasValue</a> from xmlreader.h</li>
<li> line 44: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlstring.html#xmlStrlen">xmlStrlen</a> from xmlstring.h</li>
<li> line 59: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> from xmlreader.h</li>
<li> line 62: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlReaderForFile">xmlReaderForFile</a> from xmlreader.h</li>
<li> line 64: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderRead">xmlTextReaderRead</a> from xmlreader.h</li>
<li> line 69: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlFreeTextReader">xmlFreeTextReader</a> from xmlreader.h</li>
<li> line 89: Macro <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlversion.html#LIBXML_TEST_VERSION">LIBXML_TEST_VERSION</a> from xmlversion.h</li>
</ul>
<p>Usage:</p>
<p>reader1 &lt;filename&gt;</p>
<p>Author: Daniel Veillard</p>
<h3><a name="reader2.c" href="reader2.c" id="reader2.c">reader2.c</a>: Parse and validate an XML file with an xmlReader</h3>
<p>Demonstrate the use of xmlReaderForFile() to parse an XML file validating the content in the process and activating options like entities substitution, and DTD attributes defaulting. (Note that the XMLReader functions require libxml2 version later than 2.6.)</p>
<p>Includes:</p>
<ul>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html">&lt;libxml/xmlreader.h&gt;</a>
</li>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html">&lt;libxml/parser.h&gt;</a>
</li>
</ul>
<p>Uses:</p>
<ul>
<li> line 31: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderConstName">xmlTextReaderConstName</a> from xmlreader.h</li>
<li> line 35: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderConstValue">xmlTextReaderConstValue</a> from xmlreader.h</li>
<li> line 38: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderDepth">xmlTextReaderDepth</a> from xmlreader.h</li>
<li> line 39: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderNodeType">xmlTextReaderNodeType</a> from xmlreader.h</li>
<li> line 41: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderIsEmptyElement">xmlTextReaderIsEmptyElement</a> from xmlreader.h</li>
<li> line 42: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderHasValue">xmlTextReaderHasValue</a> from xmlreader.h</li>
<li> line 46: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlstring.html#xmlStrlen">xmlStrlen</a> from xmlstring.h</li>
<li> line 61: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> from xmlreader.h</li>
<li> line 69: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlReaderForFile">xmlReaderForFile</a> from xmlreader.h</li>
<li> line 74: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderRead">xmlTextReaderRead</a> from xmlreader.h</li>
<li> line 82: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderIsValid">xmlTextReaderIsValid</a> from xmlreader.h</li>
<li> line 85: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlFreeTextReader">xmlFreeTextReader</a> from xmlreader.h</li>
</ul>
<p>Usage:</p>
<p>reader2 &lt;valid_xml_filename&gt;</p>
<p>Author: Daniel Veillard</p>
<h3><a name="reader3.c" href="reader3.c" id="reader3.c">reader3.c</a>: Show how to extract subdocuments with xmlReader</h3>
<p>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.)</p>
<p>Includes:</p>
<ul>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html">&lt;libxml/xmlreader.h&gt;</a>
</li>
</ul>
<p>Uses:</p>
<ul>
<li> line 32: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> from xmlreader.h</li>
<li> line 38: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlReaderForFile">xmlReaderForFile</a> from xmlreader.h</li>
<li> line 43: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderPreservePattern">xmlTextReaderPreservePattern</a> from xmlreader.h</li>
<li> line 50: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderRead">xmlTextReaderRead</a> from xmlreader.h</li>
<li> line 56: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlFreeTextReader">xmlFreeTextReader</a> from xmlreader.h</li>
<li> line 62: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderCurrentDoc">xmlTextReaderCurrentDoc</a> from xmlreader.h</li>
<li> line 96: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlDocDump">xmlDocDump</a> from tree.h</li>
</ul>
<p>Usage:</p>
<p>reader3</p>
<p>Author: Daniel Veillard</p>
<h3><a name="reader4.c" href="reader4.c" id="reader4.c">reader4.c</a>: Parse multiple XML files reusing an xmlReader</h3>
<p>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.)</p>
<p>Includes:</p>
<ul>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html">&lt;libxml/xmlreader.h&gt;</a>
</li>
</ul>
<p>Uses:</p>
<ul>
<li> line 24: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderRead">xmlTextReaderRead</a> from xmlreader.h</li>
<li> line 34: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderCurrentDoc">xmlTextReaderCurrentDoc</a> from xmlreader.h</li>
<li> line 54: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> from xmlreader.h</li>
<li> line 72: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlReaderForFile">xmlReaderForFile</a> from xmlreader.h</li>
<li> line 83: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlReaderNewFile">xmlReaderNewFile</a> from xmlreader.h</li>
<li> line 104: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlreader.html#xmlFreeTextReader">xmlFreeTextReader</a> from xmlreader.h</li>
</ul>
<p>Usage:</p>
<p>reader4 &lt;filename&gt; [ filename ... ]</p>
<p>Author: Graham Bennett</p>
<h2><a name="xmlWriter" id="xmlWriter"></a>xmlWriter Examples</h2>
<h3><a name="testWriter.c" href="testWriter.c" id="testWriter.c">testWriter.c</a>: use various APIs for the xmlWriter</h3>
<p>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.</p>
<p>Includes:</p>
<ul>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-encoding.html">&lt;libxml/encoding.h&gt;</a>
</li>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlwriter.html">&lt;libxml/xmlwriter.h&gt;</a>
</li>
<li>
<a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html">&lt;libxml/parser.h&gt;</a>
</li>
</ul>
<p>Uses:</p>
<ul>
<li> line 65: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlwriter.html#xmlTextWriterPtr">xmlTextWriterPtr</a> from xmlwriter.h</li>
<li> line 69: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlwriter.html#xmlNewTextWriterFilename">xmlNewTextWriterFilename</a> from xmlwriter.h</li>
<li> line 78: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlwriter.html#xmlTextWriterStartDocument">xmlTextWriterStartDocument</a> from xmlwriter.h</li>
<li> line 87: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlwriter.html#xmlTextWriterStartElement">xmlTextWriterStartElement</a> from xmlwriter.h</li>
<li> line 100: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlwriter.html#xmlTextWriterWriteComment">xmlTextWriterWriteComment</a> from xmlwriter.h</li>
<li> line 117: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlwriter.html#xmlTextWriterWriteAttribute">xmlTextWriterWriteAttribute</a> from xmlwriter.h</li>
<li> line 136: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlwriter.html#xmlTextWriterWriteFormatComment">xmlTextWriterWriteFormatComment</a> from xmlwriter.h</li>
<li> line 155: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlwriter.html#xmlTextWriterWriteFormatElement">xmlTextWriterWriteFormatElement</a> from xmlwriter.h</li>
<li> line 174: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlwriter.html#xmlTextWriterWriteElement">xmlTextWriterWriteElement</a> from xmlwriter.h</li>
<li> line 193: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlwriter.html#xmlTextWriterEndElement">xmlTextWriterEndElement</a> from xmlwriter.h</li>
<li> line 313: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlwriter.html#xmlTextWriterEndDocument">xmlTextWriterEndDocument</a> from xmlwriter.h</li>
<li> line 320: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlwriter.html#xmlFreeTextWriter">xmlFreeTextWriter</a> from xmlwriter.h</li>
<li> line 334: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlBufferPtr">xmlBufferPtr</a> from tree.h</li>
<li> line 340: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlBufferCreate">xmlBufferCreate</a> from tree.h</li>
<li> line 348: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlwriter.html#xmlNewTextWriterMemory">xmlNewTextWriterMemory</a> from xmlwriter.h</li>
<li> line 606: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlBufferFree">xmlBufferFree</a> from tree.h</li>
<li> line 625: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlwriter.html#xmlNewTextWriterDoc">xmlNewTextWriterDoc</a> from xmlwriter.h</li>
<li> line 856: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlSaveFileEnc">xmlSaveFileEnc</a> from tree.h</li>
<li> line 873: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> from tree.h</li>
<li> line 878: Macro <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-parser.html#XML_DEFAULT_VERSION">XML_DEFAULT_VERSION</a> from parser.h</li>
<li> line 878: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlNewDoc">xmlNewDoc</a> from tree.h</li>
<li> line 887: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlNewDocNode">xmlNewDocNode</a> from tree.h</li>
<li> line 894: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-tree.html#xmlDocSetRootElement">xmlDocSetRootElement</a> from tree.h</li>
<li> line 897: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-xmlwriter.html#xmlNewTextWriterTree">xmlNewTextWriterTree</a> from xmlwriter.h</li>
<li> line 1144: Type <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-encoding.html#xmlCharEncodingHandlerPtr">xmlCharEncodingHandlerPtr</a> from encoding.h</li>
<li> line 1149: Function <a href="https://gnome.pages.gitlab.gnome.org/libxml2/devhelp/libxml2-encoding.html#xmlFindCharEncodingHandler">xmlFindCharEncodingHandler</a> from encoding.h</li>
</ul>
<p>Usage:</p>
<p>testWriter</p>
<p>Author: Alfred Mickautsch</p>
</body>
</html>

290
doc/examples/index.py
View File

@ -1,290 +0,0 @@
#!/usr/bin/env python3
#
# Indexes the examples and build an XML description
#
import glob
import sys
try:
import libxml2
except:
print("libxml2 python bindings not available")
sys.exit(1)
sys.path.insert(0, "..")
from apibuild import CParser, escape
examples = []
extras = ['examples.xsl', 'index.html', 'index.py']
tests = []
sections = {}
symbols = {}
api_dict = None
api_doc = None
def load_api():
global api_dict
global api_doc
if api_dict != None:
return
api_dict = {}
try:
print("loading ../libxml2-api.xml")
api_doc = libxml2.parseFile("../libxml2-api.xml")
except:
print("failed to parse ../libxml2-api.xml")
sys.exit(1)
def find_symbol(name):
global api_dict
global api_doc
if api_doc == None:
load_api()
if name == None:
return
if name in api_dict:
return api_dict[name]
ctxt = api_doc.xpathNewContext()
res = ctxt.xpathEval("/api/symbols/*[@name = '%s']" % (name))
if type(res) == type([]) and len(res) >= 1:
if len(res) > 1:
print("Found %d references to %s in the API" % (len(res), name))
node = res[0]
typ = node.name
file = node.xpathEval("string(@file)")
info = node.xpathEval("string(info)")
else:
print("Reference %s not found in the API" % (name))
return None
ret = (typ, file, info)
api_dict[name] = ret
return ret
def parse_top_comment(filename, comment):
res = {}
lines = comment.split("\n")
item = None
for line in lines:
while line != "" and (line[0] == ' ' or line[0] == '\t'):
line = line[1:]
while line != "" and line[0] == '*':
line = line[1:]
while line != "" and (line[0] == ' ' or line[0] == '\t'):
line = line[1:]
try:
(it, line) = line.split(":", 1)
item = it
while line != "" and (line[0] == ' ' or line[0] == '\t'):
line = line[1:]
if item in res:
res[item] = res[item] + " " + line
else:
res[item] = line
except:
if item != None:
if item in res:
res[item] = res[item] + " " + line
else:
res[item] = line
return res
def parse(filename, output):
global symbols
global sections
parser = CParser(filename)
parser.collect_references()
idx = parser.parse()
info = parse_top_comment(filename, parser.top_comment)
output.write(" <example filename='%s'>\n" % filename)
try:
synopsis = info['synopsis']
output.write(" <synopsis>%s</synopsis>\n" % escape(synopsis));
except:
print("Example %s lacks a synopsis description" % (filename))
try:
purpose = info['purpose']
output.write(" <purpose>%s</purpose>\n" % escape(purpose));
except:
print("Example %s lacks a purpose description" % (filename))
try:
usage = info['usage']
output.write(" <usage>%s</usage>\n" % escape(usage));
except:
print("Example %s lacks an usage description" % (filename))
try:
test = info['test']
output.write(" <test>%s</test>\n" % escape(test));
progname=filename[0:-2]
command=test.replace(progname, './' + progname, 1)
tests.append(command)
except:
pass
try:
author = info['author']
output.write(" <author>%s</author>\n" % escape(author));
except:
print("Example %s lacks an author description" % (filename))
try:
copy = info['copy']
output.write(" <copy>%s</copy>\n" % escape(copy));
except:
print("Example %s lacks a copyright description" % (filename))
try:
section = info['section']
output.write(" <section>%s</section>\n" % escape(section));
if section in sections:
sections[section].append(filename)
else:
sections[section] = [filename]
except:
print("Example %s lacks a section description" % (filename))
for topic in sorted(info.keys()):
if topic != "purpose" and topic != "usage" and \
topic != "author" and topic != "copy" and \
topic != "section" and topic != "synopsis" and topic != "test":
str = info[topic]
output.write(" <extra topic='%s'>%s</extra>\n" % (
escape(topic), escape(str)))
output.write(" <includes>\n")
for include in sorted(idx.includes.keys()):
if include.find("libxml") != -1:
id = idx.includes[include]
line = id.get_lineno()
output.write(" <include line='%d'>%s</include>\n" %
(line, escape(include)))
output.write(" </includes>\n")
output.write(" <uses>\n")
for ref in sorted(idx.references.keys()):
id = idx.references[ref]
name = id.get_name()
line = id.get_lineno()
if name in symbols:
sinfo = symbols[name]
refs = sinfo[0]
# gather at most 5 references per symbols
if refs > 5:
continue
sinfo.append(filename)
sinfo[0] = refs + 1
else:
symbols[name] = [1, filename]
info = find_symbol(name)
if info != None:
type = info[0]
file = info[1]
output.write(" <%s line='%d' file='%s' name='%s'/>\n" % (type,
line, file, name))
else:
type = id.get_type()
output.write(" <%s line='%d' name='%s'/>\n" % (type,
line, name))
output.write(" </uses>\n")
output.write(" </example>\n")
return idx
def dump_symbols(output):
global symbols
output.write(" <symbols>\n")
for symbol in sorted(symbols.keys()):
output.write(" <symbol name='%s'>\n" % (symbol))
info = symbols[symbol]
i = 1
while i < len(info):
output.write(" <ref filename='%s'/>\n" % (info[i]))
i = i + 1
output.write(" </symbol>\n")
output.write(" </symbols>\n")
def dump_sections(output):
global sections
output.write(" <sections>\n")
for section in sorted(sections.keys()):
output.write(" <section name='%s'>\n" % (section))
info = sections[section]
i = 0
while i < len(info):
output.write(" <example filename='%s'/>\n" % (info[i]))
i = i + 1
output.write(" </section>\n")
output.write(" </sections>\n")
def dump_Makefile():
for file in glob.glob('*.xml'):
extras.append(file)
for file in glob.glob('*.res'):
extras.append(file)
Makefile="""##
## This file is auto-generated by index.py
## DO NOT EDIT !!!
##
AM_CPPFLAGS = -I$(top_builddir)/include -I$(top_srcdir)/include
LDADD = $(top_builddir)/libxml2.la
CLEANFILES = *.tmp
rebuild:
\tcd $(srcdir) && $(PYTHON) index.py
\t$(MAKE) Makefile
\tcd $(srcdir) && xsltproc examples.xsl examples.xml
\t-cd $(srcdir) && xmllint --valid --noout index.html
.PHONY: rebuild
install-data-local:
\t$(MKDIR_P) $(DESTDIR)$(docdir)/examples
\t-$(INSTALL) -m 0644 $(srcdir)/*.html $(srcdir)/*.c $(DESTDIR)$(docdir)/examples/
clean-local:
\ttest -f Makefile.am || rm -f test?.xml
"""
examples.sort()
extras.sort()
tests.sort()
EXTRA_DIST=""
for extra in extras:
EXTRA_DIST = EXTRA_DIST + " \\\n\t" + extra
Makefile = Makefile + "EXTRA_DIST =%s\n\n" % (EXTRA_DIST)
check_PROGRAMS=""
for example in examples:
check_PROGRAMS = check_PROGRAMS + " \\\n\t" + example
Makefile = Makefile + "check_PROGRAMS =%s\n\n" % (check_PROGRAMS)
for example in examples:
Makefile = Makefile + "%s_SOURCES = %s.c\n\n" % (example, example)
Makefile = Makefile + "valgrind: \n\t$(MAKE) CHECKER='valgrind' tests\n\n"
Makefile = Makefile + "tests: $(check_PROGRAMS)\n"
Makefile = Makefile + "\t@test -f Makefile.am || test -f test1.xml || $(LN_S) $(srcdir)/test?.xml .\n"
Makefile = Makefile + "\t@(echo '## examples regression tests')\n"
for test in tests:
Makefile = Makefile + "\t@$(CHECKER) %s\n" % (test)
Makefile = Makefile + "\t@rm *.tmp\n"
try:
old = open("Makefile.am", "r").read()
if old != Makefile:
n = open("Makefile.am", "w").write(Makefile)
print("Updated Makefile.am")
except:
print("Failed to read or save Makefile.am")
if __name__ == "__main__":
load_api()
output = open("examples.xml", "w")
output.write("<examples>\n")
for file in sorted(glob.glob('*.c')):
parse(file, output)
examples.append(file[:-2])
dump_symbols(output)
dump_sections(output)
output.write("</examples>\n")
output.close()
#dump_Makefile()

59
doc/examples/meson.build
View File

@ -1,59 +0,0 @@
## tests
example_checks = [
['io1', ''],
['io2', ''],
['parse1', 'test1.xml'],
['parse2', 'test2.xml'],
['parse3', ''],
['parse4', 'test3.xml'],
['reader1', 'test2.xml'],
['reader2', 'test2.xml'],
['reader3', ''],
['reader4', ['test1.xml', 'test2.xml', 'test3.xml']],
['testWriter', ''],
['tree1', 'test2.xml'],
['tree2', ''],
['xpath1', ['test3.xml', '//child2']],
['xpath2', ['test3.xml', '//discarded', 'discarded']],
]
foreach check : example_checks
exe = executable(
check[0],
files(check[0] + '.c'),
dependencies: xml_dep,
include_directories: config_dir,
)
test(
check[0],
exe,
args: check[1],
timeout: 0,
workdir: meson.current_source_dir(),
)
endforeach
## example files
example_files = files(
'index.html',
'io1.c',
'io2.c',
'parse1.c',
'parse2.c',
'parse3.c',
'parse4.c',
'reader1.c',
'reader2.c',
'reader3.c',
'reader4.c',
'testWriter.c',
'tree1.c',
'tree2.c',
'xpath1.c',
'xpath2.c',
)
install_data(example_files, install_dir: dir_doc / 'examples')

1
doc/meson.build
View File

@ -10,5 +10,4 @@ tutorial_files = files(
install_data(tutorial_files, install_dir: dir_doc)
subdir('devhelp')
subdir('examples')
subdir('tutorial')

1
doc/examples/.gitignore → example/.gitignore vendored
View File

@ -1,3 +1,4 @@
/gjobread
/io1
/io2
/parse1

42
example/Makefile.am
View File

@ -1,8 +1,44 @@
check_PROGRAMS = gjobread
EXTRA_DIST = \
gjobs.xml \
meson.build \
test1.xml \
test2.xml \
test3.xml
check_PROGRAMS = \
gjobread \
io1 \
io2 \
parse1 \
parse2 \
parse3 \
parse4 \
reader1 \
reader2 \
reader3 \
reader4 \
testWriter \
tree1 \
tree2 \
xpath1 \
xpath2
AM_CPPFLAGS = -I$(top_builddir)/include -I$(top_srcdir)/include
LDADD = $(top_builddir)/libxml2.la
gjobread_SOURCES=gjobread.c
EXTRA_DIST = meson.build
io1_SOURCES = io1.c
io2_SOURCES = io2.c
parse1_SOURCES = parse1.c
parse2_SOURCES = parse2.c
parse3_SOURCES = parse3.c
parse4_SOURCES = parse4.c
reader1_SOURCES = reader1.c
reader2_SOURCES = reader2.c
reader3_SOURCES = reader3.c
reader4_SOURCES = reader4.c
testWriter_SOURCES = testWriter.c
tree1_SOURCES = tree1.c
tree2_SOURCES = tree2.c
xpath1_SOURCES = xpath1.c
xpath2_SOURCES = xpath2.c

0
doc/examples/io1.c → example/io1.c
View File

0
doc/examples/io2.c → example/io2.c
View File

33
example/meson.build
View File

@ -1,8 +1,27 @@
exe = executable(
examples = [
'gjobread',
files('gjobread.c'),
dependencies: xml_dep,
include_directories: config_dir,
)
test('gjobread', exe, timeout: 0)
'io1',
'io2',
'parse1',
'parse2',
'parse3',
'parse4',
'reader1',
'reader2',
'reader3',
'reader4',
'testWriter',
'tree1',
'tree2',
'xpath1',
'xpath2',
]
foreach example : examples
exe = executable(
example,
files(example + '.c'),
dependencies: xml_dep,
include_directories: config_dir,
)
endforeach

0
doc/examples/parse1.c → example/parse1.c
View File

0
doc/examples/parse2.c → example/parse2.c
View File

0
doc/examples/parse3.c → example/parse3.c
View File

0
doc/examples/parse4.c → example/parse4.c
View File

0
doc/examples/reader1.c → example/reader1.c
View File

0
doc/examples/reader2.c → example/reader2.c
View File

0
doc/examples/reader3.c → example/reader3.c
View File

0
doc/examples/reader4.c → example/reader4.c
View File

0
doc/examples/test1.xml → example/test1.xml
View File

0
doc/examples/test2.xml → example/test2.xml
View File

0
doc/examples/test3.xml → example/test3.xml
View File

0
doc/examples/testWriter.c → example/testWriter.c
View File

0
doc/examples/tree1.c → example/tree1.c
View File

0
doc/examples/tree2.c → example/tree2.c
View File

0
doc/examples/xpath1.c → example/xpath1.c
View File

0
doc/examples/xpath2.c → example/xpath2.c
View File