Revert "Update to version 2.6.2."
Have the fix things for some other branches.
This reverts commit c3bbea3c3cfee4908189a57b3fc54f105b78c59b.
Change-Id: I57e6ff5cecb0b0a73673b52d00b2549c3cd3615e
diff --git a/readme.txt b/readme.txt
index 89d9e8d..e28084b 100644
--- a/readme.txt
+++ b/readme.txt
@@ -1,13 +1,13 @@
/** @mainpage
-<h1> TinyXML </h1>
+<h1> TinyXml </h1>
-TinyXML is a simple, small, C++ XML parser that can be easily
-integrated into other programs.
+TinyXml is a simple, small, C++ XML parser that can be easily
+integrating into other programs.
<h2> What it does. </h2>
-In brief, TinyXML parses an XML document, and builds from that a
+In brief, TinyXml parses an XML document, and builds from that a
Document Object Model (DOM) that can be read, modified, and saved.
XML stands for "eXtensible Markup Language." It allows you to create
@@ -25,38 +25,38 @@
<a href="http://skew.org/xml/tutorial/">http://skew.org/xml/tutorial</a>.
There are different ways to access and interact with XML data.
-TinyXML uses a Document Object Model (DOM), meaning the XML data is parsed
+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
+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.
-TinyXML is designed to be easy and fast to learn. It is two headers
+TinyXml 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.
-TinyXML is released under the ZLib license,
+TinyXml 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.
-TinyXML attempts to be a flexible parser, but with truly correct and
-compliant XML output. TinyXML should compile on any reasonably C++
+TinyXml 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
+compiled with or without STL support. TinyXml fully supports
the UTF-8 encoding, and the first 64k character entities.
<h2> What it doesn't do. </h2>
-TinyXML doesn't parse or use DTDs (Document Type Definitions) or XSLs
+It 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.
+complete XML needs, TinyXml is not the parser for you.
-The following DTD syntax will not parse at this time in TinyXML:
+The following DTD syntax will not parse at this time in TinyXml:
@verbatim
<!DOCTYPE Archiv [
@@ -64,7 +64,7 @@
]>
@endverbatim
-because TinyXML sees this as a !DOCTYPE node with an illegally
+because TinyXml sees this as a !DOCTYPE node with an illegally
embedded !ELEMENT node. This may be addressed in the future.
<h2> Tutorials. </h2>
@@ -76,37 +76,26 @@
<h2> Code Status. </h2>
-TinyXML is mature, tested code. It is very stable. If you find
+TinyXml 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.
+(www.sourceforge.net/projects/tinyxml).
+We'll get them straightened out as soon as possible.
There are some areas of improvement; please check sourceforge if you are
-interested in working on TinyXML.
+interested in working on TinyXml.
-<h2> Related Projects </h2>
-
-TinyXML projects you may find useful! (Descriptions provided by the projects.)
-
-<ul>
-<li> <b>TinyXPath</b> (http://tinyxpath.sourceforge.net). TinyXPath is a small footprint
- XPath syntax decoder, written in C++.</li>
-<li> <b>TinyXML++</b> (http://code.google.com/p/ticpp/). TinyXML++ is a completely new
- interface to TinyXML that uses MANY of the C++ strengths. Templates,
- exceptions, and much better error handling.</li>
-</ul>
<h2> Features </h2>
<h3> Using STL </h3>
-TinyXML can be compiled to use or not use STL. When using STL, TinyXML
+TinyXml 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<<, and operator>>. Many API methods have both 'const char*' and
'const std::string&' forms.
-When STL support is compiled out, no STL files are included whatsoever. All
-the string classes are implemented by TinyXML itself. API methods
+When 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.
Use the compile time #define:
@@ -119,52 +108,53 @@
Note: 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,
-It's probably easiest to add the line "#define TIXML_USE_STL" as the first
+its probably easiest to add the line "#define TIXML_USE_STL" as the first
line of tinyxml.h.
<h3> UTF-8 </h3>
-TinyXML supports UTF-8 allowing to manipulate XML files in any language. TinyXML
+TinyXml 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".
-Normally, 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
+Normally, 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.
-TinyXML will assume Legacy Mode until one of the following occurs:
+TinyXml will assume Legacy Mode until one of the following occurs:
<ol>
<li> If 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>
+ begin the file or data stream, TinyXml will read it as UTF-8. </li>
<li> If the declaration tag is read, and it has an encoding="UTF-8", then
- TinyXML will read it as UTF-8. </li>
- <li> If the declaration tag is read, and it has no encoding specified, then TinyXML will
- read it as UTF-8. </li>
- <li> If 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>
- <li> Until one of the above criteria is met, TinyXML runs in Legacy Mode.</li>
+ TinyXml will read it as UTF-8. </li>
+ <li> If the declaration tag is read, and it has no encoding specified, then
+ TinyXml will read it as UTF-8. </li>
+ <li> If 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>
+ <li> Until one of the above criteria is met, TinyXml runs in Legacy Mode.</li>
</ol>
-What 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.
+What 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.
-You may force TinyXML to Legacy Mode by using LoadFile( TIXML_ENCODING_LEGACY ) or
+<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.
+force it to TIXML_ENCODING_UTF8 with the same technique.</b>
For 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.
UTF-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 Microsoft's _UNICODE at this time.
+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.
-For "high-ascii" languages - everything not English, pretty much - TinyXML can
+For "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
@@ -172,7 +162,7 @@
still output text in the default code page.
For example, Japanese systems traditionally use SHIFT-JIS encoding.
-Text encoded as SHIFT-JIS can not be read by TinyXML.
+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.
The <a href="http://skew.org/xml/tutorial/">Skew.org link</a> does a great
@@ -185,12 +175,12 @@
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.
+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.
<h3> Entities </h3>
-TinyXML recognizes the pre-defined "character entities", meaning special
+TinyXml recognizes the pre-defined "character entities", meaning special
characters. Namely:
@verbatim
@@ -210,34 +200,17 @@
will have the Value() of "Far & Away" when queried from the TiXmlText 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
+of TinyXml "preserved" character entities, but the newer versions will translate
them into characters.
Additionally, any character can be specified by its Unicode code point:
The syntax " " or " " are both to the non-breaking space characher.
-<h3> Printing </h3>
-TinyXML can print output in several different ways that all have strengths and limitations.
-
-- Print( FILE* ). Output to a std-C stream, which includes all C files as well as stdout.
- - "Pretty prints", but you don't have control over printing options.
- - The output is streamed directly to the FILE object, so there is no memory overhead
- in the TinyXML code.
- - used by Print() and SaveFile()
-
-- operator<<. Output to a c++ stream.
- - Integrates with standart C++ iostreams.
- - Outputs in "network printing" mode without line breaks. Good for network transmission
- and moving XML between C++ objects, but hard for a human to read.
-
-- TiXmlPrinter. Output to a std::string or memory buffer.
- - API is less concise
- - Future printing options will be put here.
- - Printing may change slightly in future versions as it is refined and expanded.
<h3> Streams </h3>
-With TIXML_USE_STL on TinyXML supports C++ streams (operator <<,>>) streams as well
-as C (FILE*) streams. There are some differences that you may need to be aware of.
+With TIXML_USE_STL on,
+TiXml has been modified to support both C (FILE) and C++ (operator <<,>>)
+streams. There are some differences that you may need to be aware of.
C style output:
- based on FILE*
@@ -254,7 +227,7 @@
A fast, tolerant read. Use whenever you don't need the C++ streams.
-C++ style output:
+C++ style ouput:
- based on std::ostream
- operator<<
@@ -270,11 +243,11 @@
Reads 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
+ 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>> is somewhat slower than Parse, due to both
- implementation of the STL and limitations of TinyXML.
+ implementation of the STL and limitations of TinyXml.
<h3> White space </h3>
The world simply does not agree on whether white space should be kept, or condensed.
@@ -284,7 +257,7 @@
to keep pretending the _ is a space.) Others suggest that __Hello___world__ should become
Hello___world.
-It's an issue that hasn't been resolved to my satisfaction. TinyXML supports the
+It's an issue that hasn't been resolved to my satisfaction. TinyXml supports the
first 2 approaches. Call TiXmlBase::SetCondenseWhiteSpace( bool ) to set the desired behavior.
The default is to condense white space.
@@ -320,7 +293,7 @@
@verbatim
TiXmlHandle docHandle( &document );
-TiXmlElement* child2 = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).Child( "Child", 1 ).ToElement();
+TiXmlElement* child2 = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).Child( "Child", 1 ).Element();
if ( child2 )
{
// do something useful
@@ -335,7 +308,7 @@
knowing where parsing errors occured in the original source can be very
time saving.
-TinyXML can tracks the row and column origin of all nodes and attributes
+TinyXml can tracks the row and column origin of all nodes and attributes
in a text file. The TiXmlBase::Row() and TiXmlBase::Column() methods return
the origin of the node in the source text. The correct tabs can be
configured in TiXmlDocument::SetTabSize().
@@ -351,9 +324,9 @@
DOM by printing out the number of nodes found using different
techniques.
-The Linux makefile is very generic and runs on many systems - it
-is currently tested on mingw and
-MacOSX. You do not need to run 'make depend'. The dependecies have been
+The 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.
<h3>Windows project file for VC6</h3>
@@ -364,7 +337,7 @@
<li>tinyXmlTestSTL: test app, STL </li>
</ul>
-<h3>Makefile</h3>
+<h3>Linux Make file</h3>
At the top of the makefile you can set:
PROFILE, DEBUG, and TINYXML_USE_STL. Details (such that they are) are in
@@ -380,10 +353,10 @@
Add tinyxml.cpp, tinyxml.h, tinyxmlerror.cpp, tinyxmlparser.cpp, tinystr.cpp, and tinystr.h 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.
+RTTI for TinyXml.
-<h2> How TinyXML works. </h2>
+<h2> How TinyXml works. </h2>
An example is probably the best way to go. Take:
@verbatim
@@ -413,8 +386,8 @@
TiXmlDeclaration class. It will be the first child of the
document node.
- This is the only directive/special tag parsed by TinyXML.
- Generally directive tags are stored in TiXmlUnknown so the
+ This is the only directive/special tag parsed by by TinyXml.
+ Generally directive targs are stored in TiXmlUnknown so the
commands wont be lost when it is saved back to disk.
@verbatim
@@ -438,9 +411,7 @@
This element has 1 attribute, with the name "priority" and the value
"1".
-@verbatim
-Go to the
-@endverbatim
+Go to the
A TiXmlText. This is a leaf node and cannot contain other nodes.
It is a child of the "Item" TiXmlElement.
@@ -456,15 +427,15 @@
Looking at the entire object tree, you end up with:
@verbatim
-TiXmlDocument "demo.xml"
- TiXmlDeclaration "version='1.0'" "standalone=no"
- TiXmlComment " Our to do list data"
- TiXmlElement "ToDo"
- TiXmlElement "Item" Attribtutes: priority = 1
- TiXmlText "Go to the "
- TiXmlElement "bold"
- TiXmlText "Toy store!"
- TiXmlElement "Item" Attributes: priority=2
+TiXmlDocument "demo.xml"
+ TiXmlDeclaration "version='1.0'" "standalone=no"
+ TiXmlComment " Our to do list data"
+ TiXmlElement "ToDo"
+ TiXmlElement "Item" Attribtutes: priority = 1
+ TiXmlText "Go to the "
+ TiXmlElement "bold"
+ TiXmlText "Toy store!"
+ TiXmlElement "Item" Attributes: priority=2
TiXmlText "Do bills"
@endverbatim
@@ -475,7 +446,7 @@
<h2> License </h2>
-TinyXML is released under the zlib license:
+TinyXml is released under the zlib license:
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any
@@ -499,7 +470,7 @@
<h2> References </h2>
The World Wide Web Consortium is the definitive standard body for
-XML, and their web pages contain huge amounts of information.
+XML, and there web pages contain huge amounts of information.
The definitive spec: <a href="http://www.w3.org/TR/2004/REC-xml-20040204/">
http://www.w3.org/TR/2004/REC-xml-20040204/</a>
@@ -516,15 +487,16 @@
So many people have sent in bugs and ideas, that rather than list here
we try to give credit due in the "changes.txt" file.
-TinyXML was originally written by Lee Thomason. (Often the "I" still
-in the documentation.) Lee reviews changes and releases new versions,
-with the help of Yves Berquin, Andrew Ellerton, and the tinyXml community.
+TinyXml 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.
We appreciate your suggestions, and would love to know if you
-use TinyXML. Hopefully you will enjoy it and find it useful.
+use TinyXml. Hopefully you will enjoy it and find it useful.
Please post questions, comments, file bugs, or contact us at:
www.sourceforge.net/projects/tinyxml
-Lee Thomason, Yves Berquin, Andrew Ellerton
+Lee Thomason,
+Yves Berquin
*/