Merge pull request #804 from peastman/xml

Replaced TinyXML with irrXML

libraries/irrxml/readme.txt

+==========================================================================
+irrXML 1.2
+==========================================================================
+
+  Welcome to irrXML
+
+  Content of this file:
+
+  1. Directory structure overview
+  2. How to use
+  3. Requirements
+  5. License
+  6. Contact
+
+
+
+==========================================================================
+1. Directory structure overview
+==========================================================================
+
+  You will find some directories after decompressing the archive in which
+  came the SDK. These are:
+  
+  \doc         Documentation of irrXML.
+  \example     A short example showing how to use the parser with solution
+               and make files.
+  \src         The source code of irrXML.   
+
+==========================================================================
+2. How to use
+==========================================================================
+
+  For Linux/Unix users: Simply go into the directory /example and run
+  'make'. This will create a sample project using irrXML.
+  
+  Windows users: Just add the source files to your project. That's all. 
+  For more information see the documentation in the \doc directory.
+    
+  Alternatively, you could compile irrXML as .lib, after this you would
+  only need to use the irrXML.h header file, nothing more.
+
+
+==========================================================================
+3. Requirements
+==========================================================================
+
+  You can use one of the following compilers/IDEs to develop applications
+  with irrXML. However, other compilers/IDEs make work  as well, 
+  we simply didn't test them. 
+  
+  * gcc 3.2
+  * gcc 3.3
+  * Visual Studio 6.0
+  * Visual Studio.NET (7.0)
+  * Visual Studio.NET 2003 (7.1)
+  * Visual Studio.NET 2005 (8.0)
+  * DevC++ 4.9 & gcc (project files included)
+ 
+==========================================================================
+5. License
+==========================================================================
+
+  The license of irrXML is based on the zlib/libpng license.
+  Even though this license does not require you to mention that you are
+  using the Irrlicht Engine in your product, an acknowledgement
+  would be highly appreciated.
+
+  The irrXML License
+  ===========================
+
+  Copyright (C) 2002-2005 Nikolaus Gebhardt
+
+  This 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.
+
+  Permission 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:
+
+  1. 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.
+  2. Altered source versions must be plainly marked as such, and must not be
+     misrepresented as being the original software.
+  3. This notice may not be removed or altered from any source distribution.
+  
+
+  
+==========================================================================
+6. Contact
+==========================================================================
+
+  If you have problems, questions or suggestions, please visit the 
+  official homepage of irrXML:
+  
+  http://xml.irrlicht3d.org
+  
+  You will find forums, patches, documentation, and other stuff
+  which will help you out.
+  
+  If want to contact the author of the engine, please send an email to
+  Nikolaus Gebhardt:
+  
+  irrlicht@users.sourceforge.net
+
+
+  
+    
\ No newline at end of file

libraries/irrxml/src/irrXML.cpp

+// Copyright (C) 2002-2005 Nikolaus Gebhardt
+// This file is part of the "Irrlicht Engine" and the "irrXML" project.
+// For conditions of distribution and use, see copyright notice in irrlicht.h and/or irrXML.h
+
+#include "irrXML.h"
+#include "irrString.h"
+#include "irrArray.h"
+#include "fast_atof.h"
+#include "CXMLReaderImpl.h"
+
+namespace irr
+{
+namespace io
+{
+
+//! Implementation of the file read callback for ordinary files
+class CFileReadCallBack : public IFileReadCallBack
+{
+public:
+
+	//! construct from filename
+	CFileReadCallBack(const char* filename)
+		: File(0), Size(0), Close(true)
+	{
+		// open file
+		File = fopen(filename, "rb");
+
+		if (File)
+			getFileSize();
+	}
+
+	//! construct from FILE pointer
+	CFileReadCallBack(FILE* file)
+		: File(file), Size(0), Close(false)
+	{
+		if (File)
+			getFileSize();
+	}
+
+	//! destructor
+	virtual ~CFileReadCallBack()
+	{
+		if (Close && File)
+			fclose(File);
+	}
+
+	//! Reads an amount of bytes from the file.
+	virtual int read(void* buffer, int sizeToRead)
+	{
+		if (!File)
+			return 0;
+
+		return (int)fread(buffer, 1, sizeToRead, File);
+	}
+
+	//! Returns size of file in bytes
+	virtual int getSize()
+	{
+		return Size;
+	}
+
+private:
+
+	//! retrieves the file size of the open file
+	void getFileSize()
+	{
+		fseek(File, 0, SEEK_END);
+		Size = ftell(File);
+		fseek(File, 0, SEEK_SET);
+	}
+
+	FILE* File;
+	int Size;
+	bool Close;
+
+}; // end class CFileReadCallBack
+
+
+
+// FACTORY FUNCTIONS:
+
+
+//! Creates an instance of an UFT-8 or ASCII character xml parser. 
+IrrXMLReader* createIrrXMLReader(const char* filename)
+{
+	return new CXMLReaderImpl<char, IXMLBase>(new CFileReadCallBack(filename)); 
+}
+
+
+//! Creates an instance of an UFT-8 or ASCII character xml parser. 
+IrrXMLReader* createIrrXMLReader(FILE* file)
+{
+	return new CXMLReaderImpl<char, IXMLBase>(new CFileReadCallBack(file)); 
+}
+
+
+//! Creates an instance of an UFT-8 or ASCII character xml parser. 
+IrrXMLReader* createIrrXMLReader(IFileReadCallBack* callback)
+{
+	return new CXMLReaderImpl<char, IXMLBase>(callback, false); 
+}
+
+
+//! Creates an instance of an UTF-16 xml parser. 
+IrrXMLReaderUTF16* createIrrXMLReaderUTF16(const char* filename)
+{
+	return new CXMLReaderImpl<char16, IXMLBase>(new CFileReadCallBack(filename)); 
+}
+
+
+//! Creates an instance of an UTF-16 xml parser. 
+IrrXMLReaderUTF16* createIrrXMLReaderUTF16(FILE* file)
+{
+	return new CXMLReaderImpl<char16, IXMLBase>(new CFileReadCallBack(file)); 
+}
+
+
+//! Creates an instance of an UTF-16 xml parser. 
+IrrXMLReaderUTF16* createIrrXMLReaderUTF16(IFileReadCallBack* callback)
+{
+	return new CXMLReaderImpl<char16, IXMLBase>(callback, false); 
+}
+
+
+//! Creates an instance of an UTF-32 xml parser. 
+IrrXMLReaderUTF32* createIrrXMLReaderUTF32(const char* filename)
+{
+	return new CXMLReaderImpl<char32, IXMLBase>(new CFileReadCallBack(filename)); 
+}
+
+
+//! Creates an instance of an UTF-32 xml parser. 
+IrrXMLReaderUTF32* createIrrXMLReaderUTF32(FILE* file)
+{
+	return new CXMLReaderImpl<char32, IXMLBase>(new CFileReadCallBack(file)); 
+}
+
+
+//! Creates an instance of an UTF-32 xml parser. 
+IrrXMLReaderUTF32* createIrrXMLReaderUTF32(IFileReadCallBack* callback)
+{
+	return new CXMLReaderImpl<char32, IXMLBase>(callback, false); 
+}
+
+
+} // end namespace io
+} // end namespace irr

serialization/include/openmm/serialization/XmlSerializer.h

@@ -9,7 +9,7 @@
  * Biological Structures at Stanford, funded under the NIH Roadmap for        *
  * Medical Research, grant U54 GM072970. See https://simtk.org.               *
  *                                                                            *
- * Portions copyright (c) 2010-2014 Stanford University and the Authors.      *
+ * Portions copyright (c) 2010-2015 Stanford University and the Authors.      *
  * Authors: Peter Eastman                                                     *
  * Contributors:                                                              *
  *                                                                            *
@@ -38,8 +38,6 @@
 #include "openmm/internal/windowsExport.h"
 #include <iosfwd>
 
-class TiXmlElement;
-
 namespace OpenMM {
 
 /**
@@ -77,10 +75,10 @@ public:
         return reinterpret_cast<T*>(deserializeStream(stream));
     }
 private:
+    class StreamReader;
     static void serialize(const SerializationNode& node, std::ostream& stream);
     static void* deserializeStream(std::istream& stream);
     static void encodeNode(const SerializationNode& node, std::ostream& stream, int depth);
-    static void decodeNode(SerializationNode& node, const TiXmlElement& element);
 };
 
 } // namespace OpenMM

serialization/src/XmlSerializer.cpp

@@ -6,7 +6,7 @@
  * Biological Structures at Stanford, funded under the NIH Roadmap for        *
  * Medical Research, grant U54 GM072970. See https://simtk.org.               *
  *                                                                            *
- * Portions copyright (c) 2010-2014 Stanford University and the Authors.      *
+ * Portions copyright (c) 2010-2015 Stanford University and the Authors.      *
  * Authors: Peter Eastman                                                     *
  * Contributors:                                                              *
  *                                                                            *
@@ -30,10 +30,81 @@
  * -------------------------------------------------------------------------- */
 
 #include "openmm/serialization/XmlSerializer.h"
-#include "tinyxml.h"
+#include "irrXML.h"
+#include <cstring>
+#include <iostream>
+#include <map>
 
 using namespace OpenMM;
 using namespace std;
+using namespace irr;
+using namespace io;
+
+/**
+ * Apply XML encoding to a string.  This is adapted from TinyXML (written by Lee Thomason).
+ */
+static void encodeString(const string& str, string* outString) {
+    static map<char, string> entities;
+    static bool hasInitialized = false;
+    if (!hasInitialized) {
+        hasInitialized = true;
+	entities['&'] = "&amp;";
+	entities['<'] = "&lt;";
+	entities['>'] = "&gt;";
+	entities['\"'] = "&quot;";
+	entities['\''] = "&apos;";
+    }
+
+    int i=0;
+
+    while (i<(int)str.length()) {
+        unsigned char c = (unsigned char) str[i];
+
+        if (c == '&' 
+             && i < ((int)str.length() - 2)
+             && str[i+1] == '#'
+             && str[i+2] == 'x') {
+            // Hexadecimal character reference.
+            // Pass through unchanged.
+            // &#xA9;	-- copyright symbol, for example.
+            //
+            // The -1 is a bug fix from Rob Laveaux. It keeps
+            // an overflow from happening if there is no ';'.
+            // There are actually 2 ways to exit this loop -
+            // while fails (error case) and break (semicolon found).
+            // However, there is no mechanism (currently) for
+            // this function to return an error.
+            while (i<(int)str.length()-1) {
+                outString->append(str.c_str() + i, 1);
+                ++i;
+                if (str[i] == ';')
+                    break;
+            }
+        }
+        else if (entities.find(c) != entities.end()) {
+            outString->append(entities[c]);
+            ++i;
+        }
+        else if (c < 32) {
+            // Easy pass at non-alpha/numeric/symbol
+            // Below 32 is symbolic.
+            char buf[ 32 ];
+
+            snprintf(buf, sizeof(buf), "&#x%02X;", (unsigned) (c & 0xff));
+
+            //*ME:	warning C4267: convert 'size_t' to 'int'
+            //*ME:	Int-Cast to make compiler happy ...
+            outString->append(buf, (int)strlen(buf));
+            ++i;
+        }
+        else {
+            //char realc = (char) c;
+            //outString->append(&realc, 1);
+            *outString += (char) c;	// somewhat more efficient function call.
+            ++i;
+        }
+    }
+}
 
 void XmlSerializer::serialize(const SerializationNode& node, std::ostream& stream) {
     stream << "<?xml version=\"1.0\" ?>\n";
@@ -47,8 +118,8 @@ void XmlSerializer::encodeNode(const SerializationNode& node, std::ostream& stre
     const map<string, string>& properties = node.getProperties();
     for (map<string, string>::const_iterator iter = properties.begin(); iter != properties.end(); ++iter) {
         string name, value;
-        TiXmlBase::EncodeString(iter->first, &name);
-        TiXmlBase::EncodeString(iter->second, &value);
+        encodeString(iter->first, &name);
+        encodeString(iter->second, &value);
         stream << ' ' << name << "=\"" << value << '\"';
     }
     const vector<SerializationNode>& children = node.getChildren();
@@ -64,20 +135,64 @@ void XmlSerializer::encodeNode(const SerializationNode& node, std::ostream& stre
     }
 }
 
+/**
+ * Adapter class to let irrXML read a C++ stream.
+ */
+class XmlSerializer::StreamReader : public IFileReadCallBack {
+public:
+    StreamReader(std::istream& stream) : stream(stream) {
+        stream.seekg(0, ios_base::end);
+        size = stream.tellg();
+        stream.seekg(0);
+    }
+    int read(void* buffer, int sizeToRead) {
+        stream.read((char*) buffer, sizeToRead);
+        return stream.gcount();
+    }
+    int getSize() {
+        return size;
+    }
+private:
+    std::istream& stream;
+    int size;
+};
+
+/**
+ * Process an XML node, storing its content into a SerializationNode.
+ */
+static void decodeNode(SerializationNode& node, IrrXMLReader& xml) {
+    for (int i = 0; i < xml.getAttributeCount(); i++)
+        node.setStringProperty(xml.getAttributeName(i), xml.getAttributeValue(i));
+    if (xml.isEmptyElement())
+        return;
+    while (xml.read()) {
+        switch (xml.getNodeType()) {
+            case EXN_ELEMENT:
+            {
+                SerializationNode& childNode = node.createChildNode(xml.getNodeName());
+                decodeNode(childNode, xml);
+                break;
+            }
+            case EXN_ELEMENT_END:
+                return;
+        }
+    }
+}
+
 void* XmlSerializer::deserializeStream(std::istream& stream) {
-    TiXmlDocument doc;
-    stream >> doc;
     SerializationNode root;
-    decodeNode(root, *doc.FirstChildElement());
+    StreamReader reader(stream);
+    IrrXMLReader* xml = createIrrXMLReader(&reader);
+    
+    // Find the root node in the file.
+    
+    while (xml->read() && xml->getNodeType() != EXN_ELEMENT)
+        ;
+    decodeNode(root, *xml);
+    delete xml;
+    
+    // Process the SerializationNodes.
+    
     const SerializationProxy& proxy = SerializationProxy::getProxy(root.getStringProperty("type"));
     return proxy.deserialize(root);
 }
-
-void XmlSerializer::decodeNode(SerializationNode& node, const TiXmlElement& element) {
-    for (const TiXmlAttribute* attribute = element.FirstAttribute(); attribute != NULL; attribute = attribute->Next())
-        node.setStringProperty(attribute->NameTStr(), attribute->ValueStr());
-    for (const TiXmlElement* child = element.FirstChildElement(); child != NULL; child = child->NextSiblingElement()) {
-        SerializationNode& childNode = node.createChildNode(child->ValueTStr());
-        decodeNode(childNode, *child);
-    }
-}
\ No newline at end of file

serialization/src/tinyxmlerror.cpp

-/*
-www.sourceforge.net/projects/tinyxml
-Original code (2.0 and earlier )copyright (c) 2000-2006 Lee Thomason (www.grinninglizard.com)
-
-This 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.
-
-Permission 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:
-
-1. 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.
-
-2. Altered source versions must be plainly marked as such, and
-must not be misrepresented as being the original software.
-
-3. This notice may not be removed or altered from any source
-distribution.
-*/
-
-#include "tinyxml.h"
-
-// The goal of the seperate error file is to make the first
-// step towards localization. tinyxml (currently) only supports
-// english error messages, but the could now be translated.
-//
-// It also cleans up the code a bit.
-//
-
-const char* TiXmlBase::errorString[ TIXML_ERROR_STRING_COUNT ] =
-{
-	"No error",
-	"Error",
-	"Failed to open file",
-	"Error parsing Element.",
-	"Failed to read Element name",
-	"Error reading Element value.",
-	"Error reading Attributes.",
-	"Error: empty tag.",
-	"Error reading end tag.",
-	"Error parsing Unknown.",
-	"Error parsing Comment.",
-	"Error parsing Declaration.",
-	"Error document empty.",
-	"Error null (0) or unexpected EOF found in input stream.",
-	"Error parsing CDATA.",
-	"Error when TiXmlDocument added to document, because TiXmlDocument can only be at the root.",
-};