XMLSerializer Class Reference

Inheritance diagram for XMLSerializer:

Collaboration diagram for XMLSerializer:

Public Member Functions
void	writeAttribute (char const *name, int32_t number, bool onNewLine=true) override
void	writeAttribute (char const *name, char const *value, bool onNewLine=true) override
void	writeAttributeHex (char const *name, int32_t number, int32_t numChars, bool onNewLine=true) override
void	writeAttributeHexBytes (char const *name, uint8_t *data, int32_t numBytes, bool onNewLine=true) override
void	writeTagNameAndSeperator (char const *tag) override
void	writeTag (char const *tag, int32_t number, bool box=false) override
void	writeTag (char const *tag, char const *contents, bool box=false, bool quote=true) override
void	writeOpeningTag (char const *tag, bool startNewLineAfter=true, bool box=false) override
void	writeOpeningTagBeginning (char const *tag, bool box=false, bool newLineBefore=true) override
void	writeOpeningTagEnd (bool startNewLineAfter=true) override
void	closeTag (bool box=false) override
void	writeClosingTag (char const *tag, bool shouldPrintIndents=true, bool box=false) override
void	writeArrayStart (char const *tag, bool shouldPrintIndents=true, bool box=true) override
void	writeArrayEnding (char const *tag, bool shouldPrintIndents=true, bool box=true) override
void	insertCommaIfNeeded () override
void	printIndents () override
void	write (char const *output) override
Error	closeFileAfterWriting (char const *path=nullptr, char const *beginningString=nullptr, char const *endString=nullptr) override
void	reset () override
Public Member Functions inherited from Serializer
void	writeFirmwareVersion ()
void	writeEarliestCompatibleFirmwareVersion (char const *versionString)
void	writeSyncTypeToFile (Song *song, char const *name, SyncType value, bool onNewLine)
void	writeAbsoluteSyncLevelToFile (Song *song, char const *name, SyncLevel internalValue, bool onNewLine)
Public Member Functions inherited from FileWriter
	FileWriter (bool inMem)
Error	closeAfterWriting (char const *path, char const *beginningString, char const *endString)
void	writeByte (int8_t b)
void	writeBlock (uint8_t *block, uint32_t size)
void	writeChars (char const *output)
FRESULT	closeWriter ()
char *	getBufferPtr ()
int32_t	bytesWritten ()
void	setMemoryBased ()

Private Attributes
uint8_t	indentAmount

Additional Inherited Members
Public Attributes inherited from FileWriter
FIL	writeFIL
Protected Member Functions inherited from FileWriter
void	resetWriter ()
Error	writeBufferToFile ()
Protected Attributes inherited from FileWriter
bool	memoryBased = false
bool	callRoutines = true
uint8_t	indentAmount
char *	writeClusterBuffer
uint32_t	bufferSize
int32_t	fileWriteBufferCurrentPos
int32_t	fileTotalBytesWritten
bool	fileAccessFailedDuringWrite

Member Function Documentation

closeFileAfterWriting()

Error XMLSerializer::closeFileAfterWriting ( char const * path = nullptr, char const * beginningString = nullptr, char const * endString = nullptr )

overridevirtual

Implements Serializer.

closeTag()

void XMLSerializer::closeTag ( bool box = false )

overridevirtual

Implements Serializer.

insertCommaIfNeeded()

void XMLSerializer::insertCommaIfNeeded ( )

inlineoverridevirtual

Implements Serializer.

printIndents()

void XMLSerializer::printIndents ( )

overridevirtual

Implements Serializer.

reset()

void XMLSerializer::reset ( )

overridevirtual

Implements Serializer.

write()

void XMLSerializer::write ( char const * output )

overridevirtual

Implements Serializer.

writeArrayEnding()

void XMLSerializer::writeArrayEnding ( char const * tag, bool shouldPrintIndents = true, bool box = true )

overridevirtual

Implements Serializer.

writeArrayStart()

void XMLSerializer::writeArrayStart ( char const * tag, bool shouldPrintIndents = true, bool box = true )

overridevirtual

Implements Serializer.

writeAttribute() [1/2]

void XMLSerializer::writeAttribute ( char const * name, char const * value, bool onNewLine = true )

overridevirtual

Implements Serializer.

writeAttribute() [2/2]

void XMLSerializer::writeAttribute ( char const * name, int32_t number, bool onNewLine = true )

overridevirtual

Implements Serializer.

writeAttributeHex()

void XMLSerializer::writeAttributeHex ( char const * name, int32_t number, int32_t numChars, bool onNewLine = true )

overridevirtual

Implements Serializer.

writeAttributeHexBytes()

void XMLSerializer::writeAttributeHexBytes ( char const * name, uint8_t * data, int32_t numBytes, bool onNewLine = true )

overridevirtual

Implements Serializer.

writeClosingTag()

void XMLSerializer::writeClosingTag ( char const * tag, bool shouldPrintIndents = true, bool box = false )

overridevirtual

Implements Serializer.

writeOpeningTag()

void XMLSerializer::writeOpeningTag ( char const * tag, bool startNewLineAfter = true, bool box = false )

overridevirtual

Implements Serializer.

writeOpeningTagBeginning()

void XMLSerializer::writeOpeningTagBeginning ( char const * tag, bool box = false, bool newLineBefore = true )

overridevirtual

Implements Serializer.

writeOpeningTagEnd()

void XMLSerializer::writeOpeningTagEnd ( bool startNewLineAfter = true )

overridevirtual

Implements Serializer.

writeTag() [1/2]

void XMLSerializer::writeTag ( char const * tag, char const * contents, bool box = false, bool quote = true )

overridevirtual

Implements Serializer.

writeTag() [2/2]

void XMLSerializer::writeTag ( char const * tag, int32_t number, bool box = false )

overridevirtual

Implements Serializer.

writeTagNameAndSeperator()

void XMLSerializer::writeTagNameAndSeperator ( char const * tag )

overridevirtual

Implements Serializer.

---

The documentation for this class was generated from the following files:

• src/deluge/storage/storage_manager.h
• src/deluge/storage/Serializer.cpp