XML: Add XML to GFF3 creator

src/xml/gff3creator.cpp

@@ -0,0 +1,194 @@
+/* xoreos-tools - Tools to help with xoreos development
+ *
+ * xoreos-tools is the legal property of its developers, whose names
+ * can be found in the AUTHORS file distributed with this source
+ * distribution.
+ *
+ * xoreos-tools is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 3
+ * of the License, or (at your option) any later version.
+ *
+ * xoreos-tools is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with xoreos-tools. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/** @file
+ *  Creates V3.2 GFFs out of XML files.
+ */
+
+#include "src/common/strutil.h"
+
+#include "src/xml/gff3creator.h"
+
+namespace XML {
+
+void GFF3Creator::create(const XML::XMLNode &root, uint32 id, Common::WriteStream &file) {
+	Aurora::GFF3Writer gff3(id);
+
+	if (root.getChildren().size() > 1)
+		throw Common::Exception("GFF3Creator::create() More than one root struct");
+
+	if (root.getChildren().size() == 0)
+		throw Common::Exception("GFF3Creator::create() No root struct");
+
+	const XML::XMLNode &rootStruct = *root.getChildren().front();
+
+	Common::parseString(rootStruct.getProperty("id"), id);
+	if (id != 0xFFFFFFFF)
+		throw Common::Exception("GFF3Creator::create() Invalid root struct id");
+
+	readStructContents(rootStruct.getChildren(), gff3.getTopLevel());
+
+	gff3.write(file);
+}
+
+void GFF3Creator::readStructContents(const XMLNode::Children &strctNodes, Aurora::GFF3WriterStructPtr strctPtr) {
+	for (const auto &strctNode : strctNodes) {
+		if (strctNode->getName() == "byte") {
+			byte value;
+			Common::parseString(strctNode->findChild("text")->getContent(), value);
+			strctPtr->addByte(strctNode->getProperty("label"), value);
+		} else if (strctNode->getName() == "char") {
+			char value = *strctNode->getContent().getPosition(0);
+			strctPtr->addChar(strctNode->getProperty("label"), value);
+		} else if (strctNode->getName() == "sint16") {
+			int16 value;
+			Common::parseString(strctNode->findChild("text")->getContent(), value);
+			strctPtr->addSint16(strctNode->getProperty("label"), value);
+		} else if (strctNode->getName() == "float") {
+			float value;
+			Common::parseString(strctNode->findChild("text")->getContent(), value);
+			strctPtr->addFloat(strctNode->getProperty("label"), value);
+		} else if (strctNode->getName() == "float") {
+			double value;
+			Common::parseString(strctNode->findChild("text")->getContent(), value);
+			strctPtr->addDouble(strctNode->getProperty("label"), value);
+		} else if (strctNode->getName() == "sint32") {
+			int32 value;
+			Common::parseString(strctNode->findChild("text")->getContent(), value);
+			strctPtr->addSint32(strctNode->getProperty("label"), value);
+		} else if (strctNode->getName() == "sint64") {
+			int64 value;
+			Common::parseString(strctNode->findChild("text")->getContent(), value);
+			strctPtr->addSint64(strctNode->getProperty("label"), value);
+		} else if (strctNode->getName() == "uint16") {
+			uint16 value;
+			Common::parseString(strctNode->findChild("text")->getContent(), value);
+			strctPtr->addUint16(strctNode->getProperty("label"), value);
+		} else if (strctNode->getName() == "uint32") {
+			uint32 value;
+			Common::parseString(strctNode->findChild("text")->getContent(), value);
+			strctPtr->addUint32(strctNode->getProperty("label"), value);
+		} else if (strctNode->getName() == "uint64") {
+			uint64 value;
+			Common::parseString(strctNode->findChild("text")->getContent(), value);
+			strctPtr->addUint64(strctNode->getProperty("label"), value);
+		} else if (strctNode->getName() == "exostring") {
+			if (strctNode->findChild("text") == 0)
+				strctPtr->addExoString(strctNode->getProperty("label"), "");
+			else
+				strctPtr->addExoString(strctNode->getProperty("label"), strctNode->findChild("text")->getContent());
+		} else if (strctNode->getName() == "strref") {
+			uint32 value;
+			Common::parseString(strctNode->getProperty("strref"), value);
+			strctPtr->addStrRef(strctNode->getProperty("label"), value);
+		} else if (strctNode->getName() == "resref") {
+			if (strctNode->findChild("text") == 0)
+				strctPtr->addResRef(strctNode->getProperty("label"), "");
+			else
+				strctPtr->addResRef(strctNode->getProperty("label"), strctNode->findChild("text")->getContent());
+		} else if (strctNode->getName() == "void") {
+			strctPtr->addVoid(
+				strctNode->getProperty("label"),
+				reinterpret_cast<const byte*>(strctNode->findChild("text")->getContent().c_str()),
+				strctNode->findChild("text")->getContent().size()
+			);
+		} else if (strctNode->getName() == "vector") {
+			float x, y, z;
+
+			if (strctNode->getChildren().size() != 3)
+				throw Common::Exception("GFF3Creator::readStructContents() Invalid size of vector components");
+
+			XMLNode::Children::const_iterator iter = strctNode->getChildren().begin();
+			Common::UString xValue = (*iter)->getContent();
+			++iter;
+			Common::UString yValue = (*iter)->getContent();
+			++iter;
+			Common::UString zValue = (*iter)->getContent();
+
+			Common::parseString(xValue, x);
+			Common::parseString(yValue, y);
+			Common::parseString(zValue, z);
+
+			strctPtr->addVector(strctNode->getProperty("label"), x, y, z);
+		} else if (strctNode->getName() == "orientation") {
+			float x, y, z, w;
+
+			if (strctNode->getChildren().size() != 4)
+				throw Common::Exception("GFF3Creator::readStructContents() Invalid size of orientation components");
+
+			XMLNode::Children::const_iterator iter = strctNode->getChildren().begin();
+			Common::UString xValue = (*iter)->getContent();
+			++iter;
+			Common::UString yValue = (*iter)->getContent();
+			++iter;
+			Common::UString zValue = (*iter)->getContent();
+			++iter;
+			Common::UString wValue = (*iter)->getContent();
+
+			Common::parseString(xValue, x);
+			Common::parseString(yValue, y);
+			Common::parseString(zValue, z);
+			Common::parseString(wValue, w);
+
+			strctPtr->addOrientation(strctNode->getProperty("label"), x, y, z, w);
+		} else if (strctNode->getName() == "locstring") {
+			uint32 strref;
+			Aurora::LocString locString;
+
+			Common::parseString(strctNode->getProperty("strref"), strref);
+			locString.setID(strref);
+
+			if (!strctNode->getChildren().empty()) {
+				for (const auto &child : strctNode->getChildren()) {
+					if (child->getName() != "string")
+						throw Common::Exception("GFF3Creator::readStructContents() Invalid LocString string");
+
+					uint32 id;
+					Common::parseString(child->getProperty("language"), id);
+					locString.setString(
+						LangMan.getLanguage(id),
+						LangMan.getLanguageGender(id),
+						strctNode->findChild("text")->getContent()
+					);
+				}
+			}
+
+			strctPtr->addLocString(strctNode->getProperty("label"), locString);
+		} else if (strctNode->getName() == "struct") {
+			Aurora::GFF3WriterStructPtr strct = strctPtr->addStruct(strctNode->getProperty("label"));
+			readStructContents(strctNode->getChildren(), strct);
+		} else if (strctNode->getName() == "list") {
+			Aurora::GFF3WriterListPtr list = strctPtr->addList(strctNode->getProperty("label"));
+			readListContents(strctNode->getChildren(), list);
+		}
+	}
+}
+
+void GFF3Creator::readListContents(const XMLNode::Children &listNodes, Aurora::GFF3WriterListPtr listPtr) {
+	for (const auto &node : listNodes) {
+		if (node->getName() != "struct")
+			throw Common::Exception("GFF3Creator::readListContents() Invalid element in list");
+
+		Aurora::GFF3WriterStructPtr strct = listPtr->addStruct(node->getProperty("label"));
+		readStructContents(node->getChildren(), strct);
+	}
+}
+
+} // End of namespace XML

src/xml/gff3creator.h

@@ -0,0 +1,47 @@
+/* xoreos-tools - Tools to help with xoreos development
+ *
+ * xoreos-tools is the legal property of its developers, whose names
+ * can be found in the AUTHORS file distributed with this source
+ * distribution.
+ *
+ * xoreos-tools is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 3
+ * of the License, or (at your option) any later version.
+ *
+ * xoreos-tools is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with xoreos-tools. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/** @file
+ *  Creates V3.2 GFFs out of XML files.
+ */
+
+#ifndef XML_GFF3CREATOR_H
+#define XML_GFF3CREATOR_H
+
+#include "src/common/scopedptr.h"
+
+#include "src/aurora/gff3writer.h"
+
+#include "src/xml/xmlparser.h"
+
+namespace XML {
+
+class GFF3Creator {
+public:
+	static void create(const XML::XMLNode &root, uint32 id, Common::WriteStream &file);
+
+private:
+	static void readStructContents(const XMLNode::Children &strctNodes, Aurora::GFF3WriterStructPtr strctPtr);
+	static void readListContents(const XMLNode::Children &listNodes, Aurora::GFF3WriterListPtr listPtr);
+};
+
+} // End of namespace XML
+
+#endif // XML_GFF3CREATOR_H

src/xml/gffcreator.cpp

@@ -0,0 +1,50 @@
+/* xoreos-tools - Tools to help with xoreos development
+ *
+ * xoreos-tools is the legal property of its developers, whose names
+ * can be found in the AUTHORS file distributed with this source
+ * distribution.
+ *
+ * xoreos-tools is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 3
+ * of the License, or (at your option) any later version.
+ *
+ * xoreos-tools is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with xoreos-tools. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/** @file
+ *  Creates GFFs out of XML files.
+ */
+
+#include "src/common/error.h"
+
+#include "src/xml/xmlparser.h"
+#include "src/xml/gffcreator.h"
+#include "src/xml/gff3creator.h"
+
+namespace XML {
+
+void GFFCreator::create(Common::WriteStream &output, Common::ReadStream &input, const Common::UString &inputFileName) {
+	XMLParser xml(input, true, inputFileName);
+
+	const XMLNode &xmlRoot = xml.getRoot();
+
+	const Common::UString type = xmlRoot.getProperty("type") + "    ";
+	const uint32 typeId = MKTAG(*type.getPosition(0), *type.getPosition(1), *type.getPosition(2), *type.getPosition(3));
+
+	if (xmlRoot.getName() == "gff3") {
+		XML::GFF3Creator::create(xmlRoot, typeId, output);
+	} else if (xmlRoot.getName() == "gff4") {
+		throw Common::Exception("TODO: Add GFF4 writer support");
+	} else {
+		throw Common::Exception("GFFCreator::create() invalid root tag");
+	}
+}
+
+} // End of namespace XML

src/xml/gffcreator.h

@@ -0,0 +1,44 @@
+/* xoreos-tools - Tools to help with xoreos development
+ *
+ * xoreos-tools is the legal property of its developers, whose names
+ * can be found in the AUTHORS file distributed with this source
+ * distribution.
+ *
+ * xoreos-tools is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 3
+ * of the License, or (at your option) any later version.
+ *
+ * xoreos-tools is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with xoreos-tools. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/** @file
+ *  Creates GFFs out of XML files.
+ */
+
+#ifndef XML_GFFCREATOR_H
+#define XML_GFFCREATOR_H
+
+#include "src/common/ustring.h"
+
+namespace Common {
+	class ReadStream;
+	class WriteStream;
+}
+
+namespace XML {
+
+class GFFCreator {
+public:
+	static void create(Common::WriteStream &output, Common::ReadStream &input, const Common::UString &inputFileName);
+};
+
+} // End of namespace XML
+
+#endif // XML_GFFCREATOR_H

src/xml/rules.mk

@@ -33,6 +33,8 @@ src_xml_libxml_la_SOURCES += \
     src/xml/tlkcreator.h \
     src/xml/ssfdumper.h \
     src/xml/ssfcreator.h \
+    src/xml/gffcreator.h \
+    src/xml/gff3creator.h \
     $(EMPTY)
 
 src_xml_libxml_la_SOURCES += \
@@ -45,4 +47,6 @@ src_xml_libxml_la_SOURCES += \
     src/xml/tlkcreator.cpp \
     src/xml/ssfdumper.cpp \
     src/xml/ssfcreator.cpp \
+    src/xml/gffcreator.cpp \
+    src/xml/gff3creator.cpp \
     $(EMPTY)