1562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<title>TinyXml: Main Page</title>
4562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<link href="doxygen.css" rel="stylesheet" type="text/css">
5562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project</head><body>
6562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<!-- Generated by Doxygen 1.4.4 -->
7562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<div class="qindex"><a class="qindexHL" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a></div>
8562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h1>TinyXml Documentation</h1>
9562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
10562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h3 align="center">2.4.0 </h3><h1>TinyXml </h1>
11562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
12562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectTinyXml is a simple, small, C++ XML parser that can be easily integrating into other programs.<p>
13562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h2>What it does. </h2>
14562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
15562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectIn brief, TinyXml parses an XML document, and builds from that a Document Object Model (DOM) that can be read, modified, and saved.<p>
16562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectXML stands for "eXtensible Markup Language." It allows you to create your own document markups. Where HTML does a very good job of marking documents for browsers, XML allows you to define any kind of document markup, for example a document that describes a "to do" list for an organizer application. XML is a very structured and convenient format. All those random file formats created to store application data can all be replaced with XML. One parser for everything.<p>
17562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectThe best place for the complete, correct, and quite frankly hard to read spec is at <a href="http://www.w3.org/TR/2004/REC-xml-20040204/">http://www.w3.org/TR/2004/REC-xml-20040204/</a>. An intro to XML (that I really like) can be found at <a href="http://skew.org/xml/tutorial/">http://skew.org/xml/tutorial</a>.<p>
18562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectThere are different ways to access and interact with XML data. TinyXml uses a Document Object Model (DOM), meaning the XML data is parsed into a C++ objects that can be browsed and manipulated, and then written to disk or another output stream. You can also construct an XML document from scratch with C++ objects and write this to disk or another output stream.<p>
19562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectTinyXml is designed to be easy and fast to learn. It is two headers and four cpp files. Simply add these to your project and off you go. There is an example file - xmltest.cpp - to get you started.<p>
20562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectTinyXml is released under the ZLib license, so you can use it in open source or commercial code. The details of the license are at the top of every source file.<p>
21562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectTinyXml attempts to be a flexible parser, but with truly correct and compliant XML output. TinyXml should compile on any reasonably C++ compliant system. It does not rely on exceptions or RTTI. It can be compiled with or without STL support. TinyXml fully supports the UTF-8 encoding, and the first 64k character entities.<p>
22562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h2>What it doesn't do. </h2>
23562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
24562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectIt doesnt parse or use DTDs (Document Type Definitions) or XSLs (eXtensible Stylesheet Language.) There are other parsers out there (check out www.sourceforge.org, search for XML) that are much more fully featured. But they are also much bigger, take longer to set up in your project, have a higher learning curve, and often have a more restrictive license. If you are working with browsers or have more complete XML needs, TinyXml is not the parser for you.<p>
25562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectThe following DTD syntax will not parse at this time in TinyXml:<p>
26562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<div class="fragment"><pre class="fragment">	&lt;!DOCTYPE Archiv [
27562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project	 &lt;!ELEMENT Comment (#PCDATA)&gt;
28562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project	]&gt;
29562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project</pre></div><p>
30562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Projectbecause TinyXml sees this as a !DOCTYPE node with an illegally embedded !ELEMENT node. This may be addressed in the future.<p>
31562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h2>Tutorials. </h2>
32562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
33562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectFor the impatient, here is a tutorial to get you going. A great way to get started, but it is worth your time to read this (very short) manual completely.<p>
34562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<ul>
35562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<li><a class="el" href="tutorial0.html">TinyXML Tutorial</a></li></ul>
36562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
37562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h2>Code Status. </h2>
38562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
39562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectTinyXml is mature, tested code. It is very stable. If you find bugs, please file a bug report on the sourceforge web site (www.sourceforge.net/projects/tinyxml). We'll get them straightened out as soon as possible.<p>
40562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectThere are some areas of improvement; please check sourceforge if you are interested in working on TinyXml.<p>
41562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h2>Features </h2>
42562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
43562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h3>Using STL </h3>
44562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
45562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectTinyXml can be compiled to use or not use STL. When using STL, TinyXml uses the std::string class, and fully supports std::istream, std::ostream, operator&lt;&lt;, and operator&gt;&gt;. Many API methods have both 'const char*' and 'const std::string&amp;' forms.<p>
46562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectWhen STL support is compiled out, no STL files are included whatsover. All the string classes are implemented by TinyXml itself. API methods all use the 'const char*' form for input.<p>
47562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectUse the compile time define:<p>
48562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectTIXML_USE_STL<p>
49562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Projectto compile one version or the other. This can be passed by the compiler, or set as the first line of "tinyxml.h".<p>
50562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectNote: If compiling the test code in Linux, setting the environment variable TINYXML_USE_STL=YES/NO will control STL compilation. In the Windows project file, STL and non STL targets are provided. In your project, its probably easiest to add the line "#define TIXML_USE_STL" as the first line of <a class="el" href="tinyxml_8h-source.html">tinyxml.h</a>.<p>
51562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h3>UTF-8 </h3>
52562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
53562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectTinyXml supports UTF-8 allowing to manipulate XML files in any language. TinyXml also supports "legacy mode" - the encoding used before UTF-8 support and probably best described as "extended ascii".<p>
54562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectNormally, TinyXml will try to detect the correct encoding and use it. However, by setting the value of TIXML_DEFAULT_ENCODING in the header file, TinyXml can be forced to always use one encoding.<p>
55562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectTinyXml will assume Legacy Mode until one of the following occurs: <ol>
56562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<li>
57562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectIf the non-standard but common "UTF-8 lead bytes" (0xef 0xbb 0xbf) begin the file or data stream, TinyXml will read it as UTF-8.  </li>
58562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<li>
59562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectIf the declaration tag is read, and it has an encoding="UTF-8", then TinyXml will read it as UTF-8.  </li>
60562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<li>
61562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectIf the declaration tag is read, and it has no encoding specified, then TinyXml will read it as UTF-8.  </li>
62562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<li>
63562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectIf the declaration tag is read, and it has an encoding="something else", then TinyXml will read it as Legacy Mode. In legacy mode, TinyXml will work as it did before. It's not clear what that mode does exactly, but old content should keep working. </li>
64562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<li>
65562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectUntil one of the above criteria is met, TinyXml runs in Legacy Mode. </li>
66562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project</ol>
67562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
68562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectWhat happens if the encoding is incorrectly set or detected? TinyXml will try to read and pass through text seen as improperly encoded. You may get some strange results or mangled characters. You may want to force TinyXml to the correct mode.<p>
69562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<b> You may force TinyXml to Legacy Mode by using LoadFile( TIXML_ENCODING_LEGACY ) or LoadFile( filename, TIXML_ENCODING_LEGACY ). You may force it to use legacy mode all the time by setting TIXML_DEFAULT_ENCODING = TIXML_ENCODING_LEGACY. Likewise, you may force it to TIXML_ENCODING_UTF8 with the same technique.</b><p>
70562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectFor English users, using English XML, UTF-8 is the same as low-ASCII. You don't need to be aware of UTF-8 or change your code in any way. You can think of UTF-8 as a "superset" of ASCII.<p>
71562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectUTF-8 is not a double byte format - but it is a standard encoding of Unicode! TinyXml does not use or directly support wchar, TCHAR, or Microsofts _UNICODE at this time. It is common to see the term "Unicode" improperly refer to UTF-16, a wide byte encoding of unicode. This is a source of confusion.<p>
72562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectFor "high-ascii" languages - everything not English, pretty much - TinyXml can handle all languages, at the same time, as long as the XML is encoded in UTF-8. That can be a little tricky, older programs and operating systems tend to use the "default" or "traditional" code page. Many apps (and almost all modern ones) can output UTF-8, but older or stubborn (or just broken) ones still output text in the default code page.<p>
73562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectFor example, Japanese systems traditionally use SHIFT-JIS encoding. Text encoded as SHIFT-JIS can not be read by tinyxml. A good text editor can import SHIFT-JIS and then save as UTF-8.<p>
74562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectThe <a href="http://skew.org/xml/tutorial/">Skew.org link</a> does a great job covering the encoding issue.<p>
75562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectThe test file "utf8test.xml" is an XML containing English, Spanish, Russian, and Simplified Chinese. (Hopefully they are translated correctly). The file "utf8test.gif" is a screen capture of the XML file, rendered in IE. Note that if you don't have the correct fonts (Simplified Chinese or Russian) on your system, you won't see output that matches the GIF file even if you can parse it correctly. Also note that (at least on my Windows machine) console output is in a Western code page, so that Print() or printf() cannot correctly display the file. This is not a bug in TinyXml - just an OS issue. No data is lost or destroyed by TinyXml. The console just doesn't render UTF-8.<p>
76562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h3>Entities </h3>
77562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
78562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectTinyXml recognizes the pre-defined "character entities", meaning special characters. Namely:<p>
79562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<div class="fragment"><pre class="fragment">	&amp;amp;	&amp;
80562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project	&amp;lt;	&lt;
81562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project	&amp;gt;	&gt;
82562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project	&amp;quot;	"
83562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project	&amp;apos;	'
84562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project</pre></div><p>
85562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectThese are recognized when the XML document is read, and translated to there UTF-8 equivalents. For instance, text with the XML of:<p>
86562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<div class="fragment"><pre class="fragment">	Far &amp;amp; Away
87562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project</pre></div><p>
88562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Projectwill have the Value() of "Far &amp; Away" when queried from the <a class="el" href="classTiXmlText.html">TiXmlText</a> object, and will be written back to the XML stream/file as an ampersand. Older versions of TinyXml "preserved" character entities, but the newer versions will translate them into characters.<p>
89562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectAdditionally, any character can be specified by its Unicode code point: The syntax "&amp;#xA0;" or "&amp;#160;" are both to the non-breaking space characher.<p>
90562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h3>Streams </h3>
91562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
92562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectWith TIXML_USE_STL on, TiXml has been modified to support both C (FILE) and C++ (operator &lt;&lt;,&gt;&gt;) streams. There are some differences that you may need to be aware of.<p>
93562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectC style output:<ul>
94562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<li>based on FILE*</li><li>the Print() and SaveFile() methods</li></ul>
95562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
96562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectGenerates formatted output, with plenty of white space, intended to be as human-readable as possible. They are very fast, and tolerant of ill formed XML documents. For example, an XML document that contains 2 root elements and 2 declarations, will still print.<p>
97562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectC style input:<ul>
98562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<li>based on FILE*</li><li>the Parse() and LoadFile() methods</li></ul>
99562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
100562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectA fast, tolerant read. Use whenever you don't need the C++ streams.<p>
101562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectC++ style ouput:<ul>
102562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<li>based on std::ostream</li><li>operator&lt;&lt;</li></ul>
103562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
104562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectGenerates condensed output, intended for network transmission rather than readability. Depending on your system's implementation of the ostream class, these may be somewhat slower. (Or may not.) Not tolerant of ill formed XML: a document should contain the correct one root element. Additional root level elements will not be streamed out.<p>
105562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectC++ style input:<ul>
106562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<li>based on std::istream</li><li>operator&gt;&gt;</li></ul>
107562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
108562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectReads XML from a stream, making it useful for network transmission. The tricky part is knowing when the XML document is complete, since there will almost certainly be other data in the stream. TinyXml will assume the XML data is complete after it reads the root element. Put another way, documents that are ill-constructed with more than one root element will not read correctly. Also note that operator&gt;&gt; is somewhat slower than Parse, due to both implementation of the STL and limitations of TinyXml.<p>
109562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h3>White space </h3>
110562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
111562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectThe world simply does not agree on whether white space should be kept, or condensed. For example, pretend the '_' is a space, and look at "Hello____world". HTML, and at least some XML parsers, will interpret this as "Hello_world". They condense white space. Some XML parsers do not, and will leave it as "Hello____world". (Remember to keep pretending the _ is a space.) Others suggest that __Hello___world__ should become Hello___world.<p>
112562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectIt's an issue that hasn't been resolved to my satisfaction. TinyXml supports the first 2 approaches. Call <a class="el" href="classTiXmlBase.html#e0">TiXmlBase::SetCondenseWhiteSpace( bool )</a> to set the desired behavior. The default is to condense white space.<p>
113562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectIf you change the default, you should call <a class="el" href="classTiXmlBase.html#e0">TiXmlBase::SetCondenseWhiteSpace( bool )</a> before making any calls to Parse XML data, and I don't recommend changing it after it has been set.<p>
114562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h3>Handles </h3>
115562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
116562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectWhere browsing an XML document in a robust way, it is important to check for null returns from method calls. An error safe implementation can generate a lot of code like:<p>
117562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<div class="fragment"><pre class="fragment">TiXmlElement* root = document.FirstChildElement( "Document" );
118562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Projectif ( root )
119562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project{
120562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project	TiXmlElement* element = root-&gt;FirstChildElement( "Element" );
121562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project	if ( element )
122562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project	{
123562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project		TiXmlElement* child = element-&gt;FirstChildElement( "Child" );
124562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project		if ( child )
125562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project		{
126562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project			TiXmlElement* child2 = child-&gt;NextSiblingElement( "Child" );
127562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project			if ( child2 )
128562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project			{
129562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project				// Finally do something useful.
130562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project</pre></div><p>
131562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectHandles have been introduced to clean this up. Using the <a class="el" href="classTiXmlHandle.html">TiXmlHandle</a> class, the previous code reduces to:<p>
132562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<div class="fragment"><pre class="fragment">TiXmlHandle docHandle( &amp;document );
133562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectTiXmlElement* child2 = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).Child( "Child", 1 ).Element();
134562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Projectif ( child2 )
135562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project{
136562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project	// do something useful
137562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project</pre></div><p>
138562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectWhich is much easier to deal with. See <a class="el" href="classTiXmlHandle.html">TiXmlHandle</a> for more information.<p>
139562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h3>Row and Column tracking </h3>
140562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
141562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectBeing able to track nodes and attributes back to their origin location in source files can be very important for some applications. Additionally, knowing where parsing errors occured in the original source can be very time saving.<p>
142562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectTinyXml can tracks the row and column origin of all nodes and attributes in a text file. The <a class="el" href="classTiXmlBase.html#a3">TiXmlBase::Row()</a> and <a class="el" href="classTiXmlBase.html#a4">TiXmlBase::Column()</a> methods return the origin of the node in the source text. The correct tabs can be configured in <a class="el" href="classTiXmlDocument.html#a20">TiXmlDocument::SetTabSize()</a>.<p>
143562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h2>Using and Installing </h2>
144562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
145562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectTo Compile and Run xmltest:<p>
146562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectA Linux Makefile and a Windows Visual C++ .dsw file is provided. Simply compile and run. It will write the file demotest.xml to your disk and generate output on the screen. It also tests walking the DOM by printing out the number of nodes found using different techniques.<p>
147562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectThe Linux makefile is very generic and will probably run on other systems, but is only tested on Linux. You no longer need to run 'make depend'. The dependecies have been hard coded.<p>
148562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h3>Windows project file for VC6</h3>
149562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
150562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<ul>
151562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<li>
152562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Projecttinyxml: tinyxml library, non-STL  </li>
153562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<li>
154562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjecttinyxmlSTL: tinyxml library, STL  </li>
155562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<li>
156562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjecttinyXmlTest: test app, non-STL  </li>
157562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<li>
158562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjecttinyXmlTestSTL: test app, STL  </li>
159562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project</ul>
160562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
161562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h3>Linux Make file</h3>
162562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
163562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectAt the top of the makefile you can set:<p>
164562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectPROFILE, DEBUG, and TINYXML_USE_STL. Details (such that they are) are in the makefile.<p>
165562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectIn the tinyxml directory, type "make clean" then "make". The executable file 'xmltest' will be created.<p>
166562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h3>To Use in an Application:</h3>
167562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
168562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectAdd tinyxml.cpp, <a class="el" href="tinyxml_8h-source.html">tinyxml.h</a>, tinyxmlerror.cpp, tinyxmlparser.cpp, tinystr.cpp, and <a class="el" href="tinystr_8h-source.html">tinystr.h</a> to your project or make file. That's it! It should compile on any reasonably compliant C++ system. You do not need to enable exceptions or RTTI for TinyXml.<p>
169562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h2>How TinyXml works. </h2>
170562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
171562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectAn example is probably the best way to go. Take: <div class="fragment"><pre class="fragment">	&lt;?xml version="1.0" standalone=no&gt;
172562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project	&lt;!-- Our to do list data --&gt;
173562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project	&lt;ToDo&gt;
174562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project		&lt;Item priority="1"&gt; Go to the &lt;bold&gt;Toy store!&lt;/bold&gt;&lt;/Item&gt;
175562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project		&lt;Item priority="2"&gt; Do bills&lt;/Item&gt;
176562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project	&lt;/ToDo&gt;
177562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project</pre></div><p>
178562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectIts not much of a To Do list, but it will do. To read this file (say "demo.xml") you would create a document, and parse it in: <div class="fragment"><pre class="fragment">	TiXmlDocument doc( "demo.xml" );
179562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project	doc.LoadFile();
180562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project</pre></div><p>
181562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectAnd its ready to go. Now lets look at some lines and how they relate to the DOM.<p>
182562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<div class="fragment"><pre class="fragment">&lt;?xml version="1.0" standalone=no&gt;
183562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project</pre></div><p>
184562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectThe first line is a declaration, and gets turned into the <a class="el" href="classTiXmlDeclaration.html">TiXmlDeclaration</a> class. It will be the first child of the document node.<p>
185562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectThis is the only directive/special tag parsed by by TinyXml. Generally directive targs are stored in <a class="el" href="classTiXmlUnknown.html">TiXmlUnknown</a> so the commands wont be lost when it is saved back to disk.<p>
186562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<div class="fragment"><pre class="fragment">&lt;!-- Our to do list data --&gt;
187562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project</pre></div><p>
188562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectA comment. Will become a <a class="el" href="classTiXmlComment.html">TiXmlComment</a> object.<p>
189562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<div class="fragment"><pre class="fragment">&lt;ToDo&gt;
190562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project</pre></div><p>
191562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectThe "ToDo" tag defines a <a class="el" href="classTiXmlElement.html">TiXmlElement</a> object. This one does not have any attributes, but does contain 2 other elements.<p>
192562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<div class="fragment"><pre class="fragment">&lt;Item priority="1"&gt; 
193562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project</pre></div><p>
194562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectCreates another <a class="el" href="classTiXmlElement.html">TiXmlElement</a> which is a child of the "ToDo" element. This element has 1 attribute, with the name "priority" and the value "1".<p>
195562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectGo to the<p>
196562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectA <a class="el" href="classTiXmlText.html">TiXmlText</a>. This is a leaf node and cannot contain other nodes. It is a child of the "Item" <a class="el" href="classTiXmlElement.html">TiXmlElement</a>.<p>
197562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<div class="fragment"><pre class="fragment">&lt;bold&gt;
198562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project</pre></div><p>
199562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectAnother <a class="el" href="classTiXmlElement.html">TiXmlElement</a>, this one a child of the "Item" element.<p>
200562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectEtc.<p>
201562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectLooking at the entire object tree, you end up with: <div class="fragment"><pre class="fragment">TiXmlDocument				"demo.xml"
202562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project	TiXmlDeclaration		"version='1.0'" "standalone=no"
203562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project	TiXmlComment			" Our to do list data"
204562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project	TiXmlElement			"ToDo"
205562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project		TiXmlElement		"Item"		Attribtutes: priority = 1
206562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project			TiXmlText		"Go to the "
207562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project			TiXmlElement    "bold"
208562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project				TiXmlText	"Toy store!"
209562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project		TiXmlElement			"Item"		Attributes: priority=2
210562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project			TiXmlText			"Do bills"
211562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project</pre></div><p>
212562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h2>Documentation </h2>
213562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
214562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectThe documentation is build with Doxygen, using the 'dox' configuration file.<p>
215562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h2>License </h2>
216562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
217562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectTinyXml is released under the zlib license:<p>
218562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectThis software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.<p>
219562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectPermission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:<p>
220562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.<p>
221562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.<p>
222562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project3. This notice may not be removed or altered from any source distribution.<p>
223562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h2>References </h2>
224562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
225562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectThe World Wide Web Consortium is the definitive standard body for XML, and there web pages contain huge amounts of information.<p>
226562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectThe definitive spec: <a href="http://www.w3.org/TR/2004/REC-xml-20040204/">http://www.w3.org/TR/2004/REC-xml-20040204/</a><p>
227562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectI also recommend "XML Pocket Reference" by Robert Eckstein and published by OReilly...the book that got the whole thing started.<p>
228562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<h2>Contributors, Contacts, and a Brief History </h2>
229562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<p>
230562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectThanks very much to everyone who sends suggestions, bugs, ideas, and encouragement. It all helps, and makes this project fun. A special thanks to the contributors on the web pages that keep it lively.<p>
231562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectSo many people have sent in bugs and ideas, that rather than list here we try to give credit due in the "changes.txt" file.<p>
232562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectTinyXml was originally written be Lee Thomason. (Often the "I" still in the documenation.) Lee reviews changes and releases new versions, with the help of Yves Berquin and the tinyXml community.<p>
233562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectWe appreciate your suggestions, and would love to know if you use TinyXml. Hopefully you will enjoy it and find it useful. Please post questions, comments, file bugs, or contact us at:<p>
234562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Projectwww.sourceforge.net/projects/tinyxml<p>
235562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source ProjectLee Thomason, Yves Berquin <hr size="1"><address style="align: right;"><small>Generated on Sat Oct 8 14:15:30 2005 for TinyXml by&nbsp;
236562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<a href="http://www.doxygen.org/index.html">
237562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4 </small></address>
238562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project</body>
239562be06492c3ac43adf153f550abaede6bc18a44The Android Open Source Project</html>