#include <OpenDdlWriter.h>

Classes
struct	DdlState

Public Types
enum class	TypeStringMode { Compliant , ShortenedUnsignedInt , Shortest }
enum class	FloatPrecisionMode { Readable , Exact }

Public Member Functions
	xiiOpenDdlWriter ()
	Constructor.
void	SetOutputStream (xiiStreamWriter *pOutput)
	All output is written to this binary stream.
void	SetCompactMode (bool bCompact)
	Configures how much whitespace is output.
void	SetPrimitiveTypeStringMode (TypeStringMode mode)
	Configures how verbose the type strings are going to be written.
void	SetFloatPrecisionMode (FloatPrecisionMode mode)
	Configures how float values are output.
FloatPrecisionMode	GetFloatPrecisionMode () const
	Returns how float values are output.
void	SetIndentation (xiiInt8 iIndentation)
void	BeginObject (xiiStringView sType, xiiStringView sName={}, bool bGlobalName=false, bool bSingleLine=false)
	Begins outputting an object.
void	EndObject ()
	Ends outputting an object.
void	BeginPrimitiveList (xiiOpenDdlPrimitiveType type, xiiStringView sName={}, bool bGlobalName=false)
	Begins outputting a list of primitives of the given type.
void	EndPrimitiveList ()
	Ends outputting the list of primitives.
void	WriteBool (const bool *pValues, xiiUInt32 uiCount=1)
	Writes a number of values to the primitive list. Can be called multiple times between BeginPrimitiveList() / EndPrimitiveList().
void	WriteInt8 (const xiiInt8 *pValues, xiiUInt32 uiCount=1)
	Writes a number of values to the primitive list. Can be called multiple times between BeginPrimitiveList() / EndPrimitiveList().
void	WriteInt16 (const xiiInt16 *pValues, xiiUInt32 uiCount=1)
	Writes a number of values to the primitive list. Can be called multiple times between BeginPrimitiveList() / EndPrimitiveList().
void	WriteInt32 (const xiiInt32 *pValues, xiiUInt32 uiCount=1)
	Writes a number of values to the primitive list. Can be called multiple times between BeginPrimitiveList() / EndPrimitiveList().
void	WriteInt64 (const xiiInt64 *pValues, xiiUInt32 uiCount=1)
	Writes a number of values to the primitive list. Can be called multiple times between BeginPrimitiveList() / EndPrimitiveList().
void	WriteUInt8 (const xiiUInt8 *pValues, xiiUInt32 uiCount=1)
	Writes a number of values to the primitive list. Can be called multiple times between BeginPrimitiveList() / EndPrimitiveList().
void	WriteUInt16 (const xiiUInt16 *pValues, xiiUInt32 uiCount=1)
	Writes a number of values to the primitive list. Can be called multiple times between BeginPrimitiveList() / EndPrimitiveList().
void	WriteUInt32 (const xiiUInt32 *pValues, xiiUInt32 uiCount=1)
	Writes a number of values to the primitive list. Can be called multiple times between BeginPrimitiveList() / EndPrimitiveList().
void	WriteUInt64 (const xiiUInt64 *pValues, xiiUInt32 uiCount=1)
	Writes a number of values to the primitive list. Can be called multiple times between BeginPrimitiveList() / EndPrimitiveList().
void	WriteFloat (const float *pValues, xiiUInt32 uiCount=1)
	Writes a number of values to the primitive list. Can be called multiple times between BeginPrimitiveList() / EndPrimitiveList().
void	WriteDouble (const double *pValues, xiiUInt32 uiCount=1)
	Writes a number of values to the primitive list. Can be called multiple times between BeginPrimitiveList() / EndPrimitiveList().
void	WriteString (const xiiStringView &sString)
	Writes a single string to the primitive list. Can be called multiple times between BeginPrimitiveList() / EndPrimitiveList().
void	WriteBinaryAsString (const void *pData, xiiUInt32 uiBytes)
	Writes a single string to the primitive list, but the value is a HEX representation of the given binary data.

Protected Types

enum State {
Invalid = -5 , Empty = -4 , ObjectSingleLine = -3 , ObjectMultiLine = -2 ,
ObjectStart = -1 , PrimitivesBool = 0 , PrimitivesInt8 , PrimitivesInt16 ,
PrimitivesInt32 , PrimitivesInt64 , PrimitivesUInt8 , PrimitivesUInt16 ,
PrimitivesUInt32 , PrimitivesUInt64 , PrimitivesFloat , PrimitivesDouble ,
PrimitivesString
}

Protected Member Functions
XII_ALWAYS_INLINE void	OutputString (xiiStringView s)
XII_ALWAYS_INLINE void	OutputString (xiiStringView s, xiiUInt32 uiElementCount)
void	OutputEscapedString (const xiiStringView &string)
	Copyright (c) Theophilus Eriata. All Rights Reserved.
void	OutputIndentation ()
void	OutputPrimitiveTypeNameCompliant (xiiOpenDdlPrimitiveType type)
void	OutputPrimitiveTypeNameShort (xiiOpenDdlPrimitiveType type)
void	OutputPrimitiveTypeNameShortest (xiiOpenDdlPrimitiveType type)
void	WritePrimitiveType (xiiOpenDdlWriter::State exp)
void	OutputObjectName (xiiStringView sName, bool bGlobalName)
void	WriteBinaryAsHex (const void *pData, xiiUInt32 uiBytes)
void	OutputObjectBeginning ()

Protected Attributes
xiiInt32	m_iIndentation = 0
bool	m_bCompactMode = false
TypeStringMode	m_TypeStringMode = TypeStringMode::ShortenedUnsignedInt
FloatPrecisionMode	m_FloatPrecisionMode = FloatPrecisionMode::Exact
xiiStreamWriter *	m_pOutput = nullptr
xiiStringBuilder	m_sTemp
xiiHybridArray< DdlState, 16 >	m_StateStack

Detailed Description

The base class for OpenDDL writers.

Declares a common interface for writing OpenDDL files.

Member Enumeration Documentation

◆ FloatPrecisionMode

enum class xiiOpenDdlWriter::FloatPrecisionMode

strong

Enumerator
Readable	Float values are printed as readable numbers. Precision might get lost though.
Exact	Float values are printed as HEX, representing the exact binary data.

◆ TypeStringMode

enum class xiiOpenDdlWriter::TypeStringMode

strong

Enumerator
Compliant	All primitive types are written as the OpenDDL standard defines them (very verbose).
ShortenedUnsignedInt	unsigned_intX is shortened to uintX
Shortest	All primitive type names are shortened to one or two characters: i1, i2, i3, i4, u1, u2, u3, u4, b, s, f, d (int, uint, bool, string, float, double)

Member Function Documentation

◆ OutputObjectName()

void xiiOpenDdlWriter::OutputObjectName	(	xiiStringView	sName,
		bool	bGlobalName )

protected

Test: This code path is untested

◆ SetIndentation()

void xiiOpenDdlWriter::SetIndentation ( xiiInt8 iIndentation )

inline

Allows to set the indentation. Negative values are possible. This makes it possible to set the indentation e.g. to -2, thus the output will only have indentation after a level of 3 has been reached.

◆ WriteBinaryAsString()

void xiiOpenDdlWriter::WriteBinaryAsString	(	const void *	pData,
		xiiUInt32	uiBytes )

Writes a single string to the primitive list, but the value is a HEX representation of the given binary data.

Test: xiiOpenDdlWriter::WriteBinaryAsString

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

/home/runner/work/XII/XII/Source/Engine/Foundation/IO/OpenDdlWriter.h
/home/runner/work/XII/XII/Source/Engine/Foundation/IO/Implementation/OpenDdlWriter.cpp

Classes

Public Types

Public Member Functions