IO::XmlWriter class

#include <Spore ModAPI/Spore/IO/XmlWriter.h>

Public types

enum WriteEncoding { kWriteEncodingUnknown, kWriteEncodingUTF16 = 1, kWriteEncodingLatin1 = 2, kWriteEncodingASCII = 3, kWriteEncodingUTF8 = 4 }

Character encodings for XmlWriter.

enum LineEnd { kLineEndUnix, kLineEndWindows, kLineEndDefault = kLineEndWindows }

Defines.

Public static variables

static const size_t kIndentSpacesDefault

Default number of space chars per indent.

Constructors, destructors, conversion operators

XmlWriter(bool bFormatPretty = true, WriteEncoding writeEncoding = kWriteEncodingUnknown)

Public functions

auto SetOutputStream(IO::IStream* pStream, bool bFormatPretty = true) -> void

Set the destination stream for the XML - output will fail if this is unset.

auto WriteXmlHeader() -> bool virtual

Write the header at the beginning of the XML file.

auto BeginElement(const char16_t* pElementName) -> bool virtual

Begin a new element.

auto EndElement(const char16_t* pElementName) -> bool virtual

End the current element.

auto BeginProcessingInstruction(const char16_t* pInstructionName) -> bool virtual

Begin a new processing intruction.

auto EndProcessingInstruction() -> bool virtual

End the current processing instruction.

auto AppendAttribute(const char16_t* pAttrName, const char16_t* pAttrValue) -> bool virtual

Append a eastl::string attribute to the most recently written element or processing instruction, assuming that it has not been closed.

auto AppendAttributeF(const char16_t* pAttrName, const char16_t* pAttrValueFmt, ...) -> bool virtual

VPrintF version of AppendAttribute().

auto WriteCharData(const char16_t* pCharData) -> bool virtual

Write a eastl::string of character data.

auto WriteCDATA(const char16_t* pCharData) -> bool virtual

Write a eastl::string of unencoded character data.

auto WriteComment(const char16_t* pCommentText, bool bNewlineBefore = true) -> bool virtual

Write a comment tag, including the enclosing .

auto WriteName(const char16_t* pString) -> bool virtual

Writes a C-eastlstring as a piece of raw text.

auto WriteText(const char16_t* pString, size_t nLength) -> bool virtual

Write a piece of raw text.

Protected types

enum EState { kStateChars, kStateElement, kStateProcessingInstruction, kStateCDATA }

Protected variables

WriteEncoding mWriteEncoding

bool mbFormatPretty

The text encoding (e.g. UTF8) that we write.

bool mbSimpleElement

True if we format the output to have automatic indentation.

EState mnState

True if the current element has no child elements.

size_t mnIndentLevel

Used to tell what we are currently writing.

size_t mnIndentSpaces

Level of indentation. Starts at zero, increases by one for each indentation.

LineEnd mLineEnd

Number of space chars per indent. Total indent at any time = mnIndentLevel * mnIndentSpaces.

IStreamPtr mpStream

Defines whether we use Windows or standard indentation.

Function documentation