2011-03-26 21:17:21 +01:00
|
|
|
/* Copyright (C) 2011 Wildfire Games.
|
2009-04-18 19:00:33 +02:00
|
|
|
* This file is part of 0 A.D.
|
|
|
|
*
|
|
|
|
* 0 A.D. 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 2 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* 0 A.D. 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 0 A.D. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
2007-05-07 18:33:24 +02:00
|
|
|
#ifndef INCLUDED_XMLWRITER
|
|
|
|
#define INCLUDED_XMLWRITER
|
2006-04-24 01:14:18 +02:00
|
|
|
|
|
|
|
/*
|
|
|
|
|
|
|
|
System for writing simple XML files, with human-readable formatting.
|
|
|
|
|
|
|
|
Example usage:
|
|
|
|
|
2006-12-03 18:13:22 +01:00
|
|
|
XML_Start();
|
2006-04-24 01:14:18 +02:00
|
|
|
|
|
|
|
{
|
|
|
|
XML_Element("Scenario");
|
|
|
|
{
|
|
|
|
XML_Element("Entities");
|
|
|
|
for (...)
|
|
|
|
{
|
|
|
|
XML_Element("Entity");
|
|
|
|
|
|
|
|
{
|
|
|
|
XML_Element("Template");
|
|
|
|
XML_Text(entity.name);
|
|
|
|
}
|
|
|
|
// Or equivalently:
|
|
|
|
XML_Setting("Template", entity.name);
|
|
|
|
|
|
|
|
{
|
|
|
|
XML_Element("Position");
|
|
|
|
XML_Attribute("x", entity.x);
|
|
|
|
XML_Attribute("y", entity.y);
|
|
|
|
XML_Attribute("z", entity.z);
|
|
|
|
}
|
|
|
|
|
|
|
|
{
|
|
|
|
XML_Element("Orientation");
|
|
|
|
XML_Attribute("angle", entity.angle);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
Handle h = vfs_open("/test.xml", FILE_WRITE|FILE_NO_AIO);
|
|
|
|
XML_StoreVFS(h);
|
|
|
|
|
|
|
|
In general, "{ XML_Element(name); ... }" means "<name> ... </name>" -- the
|
|
|
|
scoping braces are important to indicate where an element ends.
|
|
|
|
|
|
|
|
XML_Attribute/XML_Setting are templated. To support more types, alter the
|
|
|
|
end of XMLWriter.cpp.
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
2008-04-15 15:45:17 +02:00
|
|
|
// Starts generating a new XML file.
|
2006-12-03 18:13:22 +01:00
|
|
|
#define XML_Start() XMLWriter_File xml_file_
|
2006-04-24 01:14:18 +02:00
|
|
|
|
2006-12-03 18:13:22 +01:00
|
|
|
// Set pretty printing (newlines, tabs). Defaults to true.
|
|
|
|
#define XML_SetPrettyPrint(enabled) xml_file_.SetPrettyPrint(false)
|
2006-04-24 01:14:18 +02:00
|
|
|
|
|
|
|
// Add a comment to the XML file: <!-- text -->
|
|
|
|
#define XML_Comment(text) xml_file_.Comment(text)
|
|
|
|
|
|
|
|
// Start a new element: <name ...>
|
|
|
|
#define XML_Element(name) XMLWriter_Element xml_element_ (xml_file_, name)
|
|
|
|
|
2008-04-15 15:45:17 +02:00
|
|
|
// Add text to the interior of the current element: <...>text</...>
|
2010-04-30 01:22:18 +02:00
|
|
|
#define XML_Text(text) xml_element_.Text(text, false)
|
|
|
|
|
|
|
|
// Add CDATA-escaped text to the interior of the current element: <...><![CDATA[text]]></...>
|
|
|
|
#define XML_CDATA(text) xml_element_.Text(text, true)
|
2006-04-24 01:14:18 +02:00
|
|
|
|
|
|
|
// Add an attribute to the current element: <... name="value" ...>
|
|
|
|
#define XML_Attribute(name, value) xml_element_.Attribute(name, value)
|
|
|
|
|
|
|
|
// Add a 'setting': <name>value</name>
|
|
|
|
#define XML_Setting(name, value) xml_element_.Setting(name, value)
|
|
|
|
|
2011-03-26 21:17:21 +01:00
|
|
|
#define XML_WriteXMB(xero) xml_file_.XMB(xero)
|
|
|
|
|
2007-12-20 21:21:45 +01:00
|
|
|
// Create a VFS file from the XML data.
|
2006-04-24 01:14:18 +02:00
|
|
|
// Returns true on success, false (and logs an error) on failure.
|
2010-07-04 12:15:53 +02:00
|
|
|
#define XML_StoreVFS(vfs, pathname) xml_file_.StoreVFS(vfs, pathname)
|
2006-04-24 01:14:18 +02:00
|
|
|
|
2006-12-03 18:13:22 +01:00
|
|
|
// Returns the contents of the XML file as a UTF-8 byte stream in a const CStr&
|
|
|
|
// string. (Use CStr::FromUTF8 to get a Unicode string back.)
|
|
|
|
#define XML_GetOutput() xml_file_.GetOutput()
|
|
|
|
|
2006-04-24 01:14:18 +02:00
|
|
|
|
|
|
|
#include "ps/CStr.h"
|
2010-07-04 12:15:53 +02:00
|
|
|
#include "lib/file/vfs/vfs.h"
|
2006-04-24 01:14:18 +02:00
|
|
|
|
2011-03-26 21:17:21 +01:00
|
|
|
class XMBElement;
|
|
|
|
class XMBFile;
|
2006-04-24 01:14:18 +02:00
|
|
|
class XMLWriter_Element;
|
|
|
|
|
|
|
|
class XMLWriter_File
|
|
|
|
{
|
|
|
|
public:
|
2006-12-03 18:13:22 +01:00
|
|
|
XMLWriter_File();
|
|
|
|
|
|
|
|
void SetPrettyPrint(bool enabled) { m_PrettyPrint = enabled; }
|
2006-04-24 01:14:18 +02:00
|
|
|
|
|
|
|
void Comment(const char* text);
|
|
|
|
|
2011-03-26 21:17:21 +01:00
|
|
|
void XMB(const XMBFile& file);
|
|
|
|
|
2010-07-04 12:15:53 +02:00
|
|
|
bool StoreVFS(const PIVFS& vfs, const VfsPath& pathname);
|
2006-12-03 18:13:22 +01:00
|
|
|
const CStr& GetOutput();
|
2006-04-24 01:14:18 +02:00
|
|
|
|
|
|
|
private:
|
|
|
|
|
|
|
|
friend class XMLWriter_Element;
|
|
|
|
|
2011-03-26 21:17:21 +01:00
|
|
|
void ElementXMB(const XMBFile& file, XMBElement el);
|
|
|
|
|
2006-04-24 01:14:18 +02:00
|
|
|
void ElementStart(XMLWriter_Element* element, const char* name);
|
2010-04-30 01:22:18 +02:00
|
|
|
void ElementText(const char* text, bool cdata);
|
2006-04-24 01:14:18 +02:00
|
|
|
template <typename T> void ElementAttribute(const char* name, const T& value, bool newelement);
|
|
|
|
void ElementClose();
|
|
|
|
void ElementEnd(const char* name, int type);
|
|
|
|
|
|
|
|
CStr Indent();
|
|
|
|
|
2006-12-03 18:13:22 +01:00
|
|
|
bool m_PrettyPrint;
|
|
|
|
|
2006-04-24 01:14:18 +02:00
|
|
|
CStr m_Data;
|
|
|
|
int m_Indent;
|
|
|
|
XMLWriter_Element* m_LastElement;
|
|
|
|
};
|
|
|
|
|
|
|
|
class XMLWriter_Element
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
XMLWriter_Element(XMLWriter_File& file, const char* name);
|
|
|
|
~XMLWriter_Element();
|
|
|
|
|
2010-04-30 01:22:18 +02:00
|
|
|
template <typename constCharPtr> void Text(constCharPtr text, bool cdata);
|
2006-04-24 01:14:18 +02:00
|
|
|
template <typename T> void Attribute(const char* name, T value) { m_File->ElementAttribute(name, value, false); }
|
|
|
|
template <typename T> void Setting(const char* name, T value) { m_File->ElementAttribute(name, value, true); }
|
|
|
|
void Close(int type);
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
|
|
|
friend class XMLWriter_File;
|
|
|
|
|
|
|
|
XMLWriter_File* m_File;
|
|
|
|
CStr m_Name;
|
|
|
|
int m_Type;
|
|
|
|
};
|
|
|
|
|
2007-05-07 18:33:24 +02:00
|
|
|
#endif // INCLUDED_XMLWRITER
|