?? readme.txt
字號:
/** @mainpage<h1> TinyXML </h1>TinyXML is a simple, small, C++ XML parser that can be easily integrated into other programs.<h2> What it does. </h2> 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 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.The best place for the complete, correct, and quite frankly hard toread 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>.There are different ways to access and interact with XML data.TinyXML uses a Document Object Model (DOM), meaning the XML data is parsedinto 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 outputstream.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, so you can use it in open source or commercial code. The detailsof the license are at the top of every source file.TinyXML attempts to be a flexible parser, but with truly correct andcompliant 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 supportsthe 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(eXtensible Stylesheet Language.) There are other parsers out there (check out www.sourceforge.org, search for XML) that are much more fullyfeatured. But they are also much bigger, take longer to set up inyour project, have a higher learning curve, and often have a morerestrictive license. If you are working with browsers or have morecomplete XML needs, TinyXML is not the parser for you.The following DTD syntax will not parse at this time in TinyXML:@verbatim <!DOCTYPE Archiv [ <!ELEMENT Comment (#PCDATA)> ]>@endverbatimbecause TinyXML sees this as a !DOCTYPE node with an illegally embedded !ELEMENT node. This may be addressed in the future.<h2> Tutorials. </h2>For 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.- @subpage tutorial0<h2> Code Status. </h2>TinyXML is mature, tested code. It is very stable. If you findbugs, 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.There are some areas of improvement; please check sourceforge if you areinterested 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, TinyXMLuses 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. Allthe string classes are implemented by TinyXML itself. API methodsall use the 'const char*' form for input.Use the compile time #define: TIXML_USE_STLto compile one version or the other. This can be passed by the compiler,or set as the first line of "tinyxml.h".Note: If compiling the test code in Linux, setting the environmentvariable TINYXML_USE_STL=YES/NO will control STL compilation. In theWindows 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 firstline of tinyxml.h.<h3> UTF-8 </h3>TinyXML supports UTF-8 allowing to manipulate XML files in any language. TinyXMLalso supports "legacy mode" - the encoding used before UTF-8 support andprobably 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, TinyXMLcan be forced to always use one encoding.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> <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></ol>What happens if the encoding is incorrectly set or detected? TinyXML will tryto 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 ) orLoadFile( filename, TIXML_ENCODING_LEGACY ). You may force it to use legacy mode allthe time by setting TIXML_DEFAULT_ENCODING = TIXML_ENCODING_LEGACY. Likewise, you may force it to TIXML_ENCODING_UTF8 with the same technique.For English users, using English XML, UTF-8 is the same as low-ASCII. Youdon't need to be aware of UTF-8 or change your code in any way. You can thinkof 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. It is common to see the term "Unicode" improperly refer to UTF-16, a wide byte encodingof unicode. This is a source of confusion.For "high-ascii" languages - everything not English, pretty much - TinyXML canhandle all languages, at the same time, as long as the XML is encodedin UTF-8. That can be a little tricky, older programs and operating systemstend to use the "default" or "traditional" code page. Many apps (and almost allmodern ones) can output UTF-8, but older or stubborn (or just broken) onesstill 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. 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 greatjob covering the encoding issue.The 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 thatif you don't have the correct fonts (Simplified Chinese or Russian) on yoursystem, you won't see output that matches the GIF file even if you can parseit correctly. Also note that (at least on my Windows machine) console outputis in a Western code page, so that Print() or printf() cannot correctly displaythe 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 specialcharacters. Namely:@verbatim & & < < > > " " ' '@endverbatimThese are recognized when the XML document is read, and translated to thereUTF-8 equivalents. For instance, text with the XML of:@verbatim Far & Away@endverbatimwill 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 versionsof TinyXML "preserved" character entities, but the newer versions will translatethem 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 wellas C (FILE*) streams. There are some differences that you may need to be aware of.C style output: - based on FILE* - the Print() and SaveFile() methods Generates 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.C style input: - based on FILE* - the Parse() and LoadFile() methods A fast, tolerant read. Use whenever you don't need the C++ streams.C++ style output: - based on std::ostream - operator<< Generates 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.
?? 快捷鍵說明
復制代碼
Ctrl + C
搜索代碼
Ctrl + F
全屏模式
F11
切換主題
Ctrl + Shift + D
顯示快捷鍵
?
增大字號
Ctrl + =
減小字號
Ctrl + -