Ykkrosh
ea766c5663
XMLWriter: - Added automatic escaping of attribute values, character data and comments to ensure well-formedness. - Removed choice of encoding (it's always UTF-8). - Removed option for DOCTYPE / DTD; changed to standalone="yes". - Added pretty-print toggle. - Fixed bug when calling XML_Text multiple times per element. - Added tests. MapWriter: - removed some redundant braces This was SVN commit r4673.
242 lines
5.2 KiB
C++
242 lines
5.2 KiB
C++
#include "precompiled.h"
|
|
|
|
#include "XMLWriter.h"
|
|
|
|
#include "ps/CLogger.h"
|
|
#include "lib/res/file/vfs.h"
|
|
|
|
|
|
// TODO (maybe): Write to the VFS handle frequently, instead of buffering
|
|
// the entire file, so that large files get written faster.
|
|
|
|
namespace
|
|
{
|
|
CStr escapeAttributeValue(const char* input)
|
|
{
|
|
// Spec says:
|
|
// AttValue ::= '"' ([^<&"] | Reference)* '"'
|
|
// so > is allowed in attribute values, so we don't bother escaping it.
|
|
|
|
CStr ret = input;
|
|
ret.Replace("&", "&");
|
|
ret.Replace("<", "<");
|
|
ret.Replace("\"", """);
|
|
return ret;
|
|
}
|
|
|
|
CStr escapeCharacterData(const char* input)
|
|
{
|
|
// CharData ::= [^<&]* - ([^<&]* ']]>' [^<&]*)
|
|
|
|
CStr ret = input;
|
|
ret.Replace("&", "&");
|
|
ret.Replace("<", "<");
|
|
ret.Replace("]]>", "]]>");
|
|
return ret;
|
|
}
|
|
|
|
CStr escapeComment(const char* input)
|
|
{
|
|
// Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'
|
|
// This just avoids double-hyphens, and doesn't enforce the no-hyphen-at-end
|
|
// rule, since it's only used in contexts where there's already a space
|
|
// between this data and the -->.
|
|
CStr ret = input;
|
|
ret.Replace("--", "\xE2\x80\x90\xE2\x80\x90");
|
|
// replace with U+2010 HYPHEN, because it's close enough and it's
|
|
// probably nicer than inserting spaces or deleting hyphens or
|
|
// any alternative
|
|
return ret;
|
|
}
|
|
}
|
|
|
|
enum { EL_ATTR, EL_TEXT, EL_SUBEL };
|
|
|
|
XMLWriter_File::XMLWriter_File()
|
|
: m_Indent(0), m_LastElement(NULL),
|
|
m_PrettyPrint(true)
|
|
{
|
|
// Encoding is always UTF-8 - that's one of the only two guaranteed to be
|
|
// supported by XML parsers (along with UTF-16), and there's not much need
|
|
// to let people choose another.
|
|
m_Data = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n";
|
|
}
|
|
|
|
bool XMLWriter_File::StoreVFS(Handle h)
|
|
{
|
|
if (m_LastElement) debug_warn("ERROR: Saving XML while an element is still open");
|
|
|
|
FileIOBuf data = (FileIOBuf)m_Data.data();
|
|
int err = vfs_io(h, m_Data.Length(), &data);
|
|
if (err < 0)
|
|
{
|
|
LOG(ERROR, "xml", "Error saving XML data through VFS: %lld", h);
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
const CStr& XMLWriter_File::GetOutput()
|
|
{
|
|
return m_Data;
|
|
}
|
|
|
|
|
|
void XMLWriter_File::Comment(const char* text)
|
|
{
|
|
ElementStart(NULL, "!-- ");
|
|
m_Data += escapeComment(text);
|
|
m_Data += " -->";
|
|
--m_Indent;
|
|
}
|
|
|
|
CStr XMLWriter_File::Indent()
|
|
{
|
|
return std::string(m_Indent, '\t');
|
|
}
|
|
|
|
void XMLWriter_File::ElementStart(XMLWriter_Element* element, const char* name)
|
|
{
|
|
if (m_LastElement) m_LastElement->Close(EL_SUBEL);
|
|
m_LastElement = element;
|
|
|
|
if (m_PrettyPrint)
|
|
{
|
|
m_Data += "\n";
|
|
m_Data += Indent();
|
|
}
|
|
m_Data += "<";
|
|
m_Data += name;
|
|
|
|
++m_Indent;
|
|
}
|
|
|
|
void XMLWriter_File::ElementClose()
|
|
{
|
|
m_Data += ">";
|
|
}
|
|
|
|
void XMLWriter_File::ElementEnd(const char* name, int type)
|
|
{
|
|
--m_Indent;
|
|
m_LastElement = NULL;
|
|
|
|
switch (type)
|
|
{
|
|
case EL_ATTR:
|
|
m_Data += "/>";
|
|
break;
|
|
case EL_TEXT:
|
|
m_Data += "</";
|
|
m_Data += name;
|
|
m_Data += ">";
|
|
break;
|
|
case EL_SUBEL:
|
|
if (m_PrettyPrint)
|
|
{
|
|
m_Data += "\n";
|
|
m_Data += Indent();
|
|
}
|
|
m_Data += "</";
|
|
m_Data += name;
|
|
m_Data += ">";
|
|
break;
|
|
default:
|
|
debug_assert(0);
|
|
}
|
|
}
|
|
|
|
void XMLWriter_File::ElementText(const char* text)
|
|
{
|
|
m_Data += escapeCharacterData(text);
|
|
}
|
|
|
|
|
|
XMLWriter_Element::XMLWriter_Element(XMLWriter_File& file, const char* name)
|
|
: m_File(&file), m_Name(name), m_Type(EL_ATTR)
|
|
{
|
|
m_File->ElementStart(this, name);
|
|
}
|
|
|
|
|
|
XMLWriter_Element::~XMLWriter_Element()
|
|
{
|
|
m_File->ElementEnd(m_Name, m_Type);
|
|
}
|
|
|
|
|
|
void XMLWriter_Element::Close(int type)
|
|
{
|
|
if (m_Type == type)
|
|
return;
|
|
|
|
m_File->ElementClose();
|
|
m_Type = type;
|
|
}
|
|
|
|
|
|
// Template specialisations for various string types:
|
|
|
|
template <> void XMLWriter_Element::Text<const char*>(const char* text)
|
|
{
|
|
Close(EL_TEXT);
|
|
m_File->ElementText(text);
|
|
}
|
|
|
|
template <> void XMLWriter_Element::Text<const wchar_t*>(const wchar_t* text)
|
|
{
|
|
Text( CStrW(text).ToUTF8().c_str() );
|
|
}
|
|
|
|
//
|
|
|
|
template <> void XMLWriter_File::ElementAttribute<const char*>(const char* name, const char* const& value, bool newelement)
|
|
{
|
|
if (newelement)
|
|
{
|
|
ElementStart(NULL, name);
|
|
m_Data += ">";
|
|
ElementText(value);
|
|
ElementEnd(name, EL_TEXT);
|
|
}
|
|
else
|
|
{
|
|
debug_assert(m_LastElement && m_LastElement->m_Type == EL_ATTR);
|
|
m_Data += " ";
|
|
m_Data += name;
|
|
m_Data += "=\"";
|
|
m_Data += escapeAttributeValue(value);
|
|
m_Data += "\"";
|
|
}
|
|
}
|
|
|
|
// Attribute/setting value-to-string template specialisations.
|
|
//
|
|
// These only deal with basic types. Anything more complicated should
|
|
// be converted into a basic type by whatever is making use of XMLWriter,
|
|
// to keep game-related logic out of the not-directly-game-related code here.
|
|
|
|
template <> void XMLWriter_File::ElementAttribute<CStr>(const char* name, const CStr& value, bool newelement)
|
|
{
|
|
ElementAttribute(name, value.c_str(), newelement);
|
|
}
|
|
|
|
// Use CStr's conversion for most types:
|
|
#define TYPE2(ID_T, ARG_T) \
|
|
template <> void XMLWriter_File::ElementAttribute<ID_T>(const char* name, ARG_T value, bool newelement) \
|
|
{ \
|
|
ElementAttribute(name, CStr(value).c_str(), newelement); \
|
|
}
|
|
#define TYPE(T) TYPE2(T, const T &)
|
|
|
|
TYPE(int)
|
|
TYPE(unsigned int)
|
|
TYPE(float)
|
|
TYPE(double)
|
|
|
|
// Encode Unicode strings as UTF-8
|
|
template <> void XMLWriter_File::ElementAttribute<CStrW>(const char* name, const CStrW& value, bool newelement)
|
|
{
|
|
ElementAttribute(name, value.ToUTF8(), newelement);
|
|
}
|