castor::TextWriterBase Class Reference

#include <TextWriter.hpp>

Inheritance diagram for castor::TextWriterBase:

Classes
class	WriterBlock

Public Member Functions
CU_API	TextWriterBase (TextWriterBase const &rhs)=delete
CU_API TextWriterBase &	operator= (TextWriterBase const &rhs)=delete
CU_API	TextWriterBase (TextWriterBase &&rhs) noexcept
CU_API TextWriterBase &	operator= (TextWriterBase &&rhs) noexcept
virtual CU_API	~TextWriterBase () noexcept=default
CU_API	TextWriterBase (String tabs=cuEmptyString, StringView name=cuEmptyString)
	Constructor.
CU_API void	checkError (bool error, xchar const *const action) const
	Reports eventual error.
CU_API void	checkError (bool error, String const &action) const
	Reports eventual error.
CU_API void	checkError (bool error, StringView const &action) const
	Reports eventual error.
CU_API WriterBlock	beginBlock (StringStream &file)
CU_API WriterBlock	beginBlock (StringStream &file, StringView name)
CU_API WriterBlock	beginBlock (StringStream &file, String const &type, StringView name)
CU_API bool	writeMask (StringStream &file, StringView name, uint32_t mask) const
CU_API bool	writeMask (StringStream &file, StringView name, uint64_t mask) const
CU_API bool	writeComment (StringStream &file, String const &comment) const
CU_API bool	write (StringStream &file, String const &value) const
CU_API bool	write (StringStream &file, StringView name, float value) const
CU_API bool	write (StringStream &file, StringView name, double value) const
CU_API bool	write (StringStream &file, StringView name, uint16_t value) const
CU_API bool	write (StringStream &file, StringView name, int16_t value) const
CU_API bool	write (StringStream &file, StringView name, uint32_t value) const
CU_API bool	write (StringStream &file, StringView name, int32_t value) const
CU_API bool	write (StringStream &file, StringView name, uint64_t value) const
CU_API bool	write (StringStream &file, StringView name, int64_t value) const
CU_API bool	write (StringStream &file, StringView name, bool value) const
CU_API bool	write (StringStream &file, StringView name, WString const &value) const
CU_API bool	write (StringStream &file, StringView name, MbString const &value) const
CU_API bool	writeOpt (StringStream &file, StringView name, bool value) const
CU_API bool	writeText (StringStream &file, WString const &value) const
CU_API bool	writeText (StringStream &file, MbString const &value) const
CU_API bool	writeName (StringStream &file, StringView name, WString const &value) const
CU_API bool	writeName (StringStream &file, StringView name, MbString const &value) const
CU_API bool	writeNameOpt (StringStream &file, StringView name, WString const &value, WString const &comp) const
CU_API bool	writeNameOpt (StringStream &file, StringView name, MbString const &value, MbString const &comp) const
CU_API bool	writePath (StringStream &file, StringView name, Path const &value) const
CU_API bool	writeFile (StringStream &file, StringView name, Path const &source, Path const &folder, String const &subfolder) const
CU_API String	tabs () const
template<typename Value1T , typename Value2T >
bool	write (StringStream &file, StringView name, Value1T const &value1, Value2T const &value2) const
template<typename ValueT >
bool	write (StringStream &file, StringView name, RangedValue< ValueT > const &value) const
template<typename ValueT >
bool	write (StringStream &file, StringView name, ChangeTracked< ValueT > const &value) const
template<typename ValueT >
bool	write (StringStream &file, StringView name, Point2< ValueT > const &value) const
template<typename ValueT >
bool	write (StringStream &file, StringView name, Point3< ValueT > const &value) const
template<typename ValueT >
bool	write (StringStream &file, StringView name, Point4< ValueT > const &value) const
template<typename ValueT >
bool	writeOpt (StringStream &file, StringView name, ValueT const &value, ValueT const &comp) const
template<typename ValueT , typename ... ParamsT>
bool	writeSub (StringStream &file, ValueT const &value, ParamsT const &... params) const
template<typename ValueT , typename ... ParamsT>
bool	writeNamedSub (StringStream &file, StringView name, ValueT const &value, ParamsT const &... params) const
template<typename ValueT , typename ... ParamsT>
bool	writeSubOpt (StringStream &file, ValueT const &value, ValueT const &comp, ParamsT const &... params) const
template<typename ValueT , typename ... ParamsT>
bool	writeNamedSubOpt (StringStream &file, StringView name, ValueT const &value, ValueT const &comp, ParamsT const &... params) const

Static Public Member Functions
static CU_API Path	copyFile (Path const &path, Path const &folder, Path const &subfolder)
	Copies the file with given path to output folder.

Friends
class	WriterBlock

Constructor & Destructor Documentation

TextWriterBase() [1/3]

CU_API castor::TextWriterBase::TextWriterBase ( TextWriterBase const & rhs )

delete

TextWriterBase() [2/3]

CU_API castor::TextWriterBase::TextWriterBase ( TextWriterBase && rhs )

noexcept

~TextWriterBase()

virtual CU_API castor::TextWriterBase::~TextWriterBase ( )

virtualdefaultnoexcept

TextWriterBase() [3/3]

CU_API castor::TextWriterBase::TextWriterBase ( String tabs = cuEmptyString, StringView name = cuEmptyString )

explicit

Constructor.

Member Function Documentation

beginBlock() [1/3]

CU_API WriterBlock castor::TextWriterBase::beginBlock

(

StringStream &

file

)

beginBlock() [2/3]

CU_API WriterBlock castor::TextWriterBase::beginBlock	(	StringStream &	file,
		String const &	type,
		StringView	name )

beginBlock() [3/3]

CU_API WriterBlock castor::TextWriterBase::beginBlock	(	StringStream &	file,
		StringView	name )

checkError() [1/3]

CU_API void castor::TextWriterBase::checkError	(	bool	error,
		String const &	action ) const

Reports eventual error.

checkError() [2/3]

CU_API void castor::TextWriterBase::checkError	(	bool	error,
		StringView const &	action ) const

Reports eventual error.

checkError() [3/3]

CU_API void castor::TextWriterBase::checkError	(	bool	error,
		xchar const *const	action ) const

Reports eventual error.

copyFile()

static CU_API Path castor::TextWriterBase::copyFile ( Path const & path, Path const & folder, Path const & subfolder )

static

Copies the file with given path to output folder.

Parameters

[in]	path	The path of the file to copy.
[in]	folder	The output folder.
[in]	subfolder	The output subfolder.

Returns

The copied file path, relative to output folder.

operator=() [1/2]

CU_API TextWriterBase & castor::TextWriterBase::operator= ( TextWriterBase && rhs )

noexcept

operator=() [2/2]

CU_API TextWriterBase & castor::TextWriterBase::operator= ( TextWriterBase const & rhs )

delete

tabs()

CU_API String castor::TextWriterBase::tabs

(

)

const

write() [1/18]

CU_API bool castor::TextWriterBase::write	(	StringStream &	file,
		String const &	value ) const

write() [2/18]

CU_API bool castor::TextWriterBase::write	(	StringStream &	file,
		StringView	name,
		bool	value ) const

write() [3/18]

template<typename ValueT >

bool castor::TextWriterBase::write	(	StringStream &	file,
		StringView	name,
		ChangeTracked< ValueT > const &	value ) const

write() [4/18]

CU_API bool castor::TextWriterBase::write	(	StringStream &	file,
		StringView	name,
		double	value ) const

write() [5/18]

CU_API bool castor::TextWriterBase::write	(	StringStream &	file,
		StringView	name,
		float	value ) const

write() [6/18]

CU_API bool castor::TextWriterBase::write	(	StringStream &	file,
		StringView	name,
		int16_t	value ) const

write() [7/18]

CU_API bool castor::TextWriterBase::write	(	StringStream &	file,
		StringView	name,
		int32_t	value ) const

write() [8/18]

CU_API bool castor::TextWriterBase::write	(	StringStream &	file,
		StringView	name,
		int64_t	value ) const

write() [9/18]

CU_API bool castor::TextWriterBase::write	(	StringStream &	file,
		StringView	name,
		MbString const &	value ) const

write() [10/18]

template<typename ValueT >

bool castor::TextWriterBase::write	(	StringStream &	file,
		StringView	name,
		Point2< ValueT > const &	value ) const

write() [11/18]

template<typename ValueT >

bool castor::TextWriterBase::write	(	StringStream &	file,
		StringView	name,
		Point3< ValueT > const &	value ) const

write() [12/18]

template<typename ValueT >

bool castor::TextWriterBase::write	(	StringStream &	file,
		StringView	name,
		Point4< ValueT > const &	value ) const

write() [13/18]

template<typename ValueT >

bool castor::TextWriterBase::write	(	StringStream &	file,
		StringView	name,
		RangedValue< ValueT > const &	value ) const

write() [14/18]

CU_API bool castor::TextWriterBase::write	(	StringStream &	file,
		StringView	name,
		uint16_t	value ) const

write() [15/18]

CU_API bool castor::TextWriterBase::write	(	StringStream &	file,
		StringView	name,
		uint32_t	value ) const

write() [16/18]

CU_API bool castor::TextWriterBase::write	(	StringStream &	file,
		StringView	name,
		uint64_t	value ) const

write() [17/18]

template<typename Value1T , typename Value2T >

bool castor::TextWriterBase::write	(	StringStream &	file,
		StringView	name,
		Value1T const &	value1,
		Value2T const &	value2 ) const

write() [18/18]

CU_API bool castor::TextWriterBase::write	(	StringStream &	file,
		StringView	name,
		WString const &	value ) const

writeComment()

CU_API bool castor::TextWriterBase::writeComment	(	StringStream &	file,
		String const &	comment ) const

writeFile()

CU_API bool castor::TextWriterBase::writeFile	(	StringStream &	file,
		StringView	name,
		Path const &	source,
		Path const &	folder,
		String const &	subfolder ) const

writeMask() [1/2]

CU_API bool castor::TextWriterBase::writeMask	(	StringStream &	file,
		StringView	name,
		uint32_t	mask ) const

writeMask() [2/2]

CU_API bool castor::TextWriterBase::writeMask	(	StringStream &	file,
		StringView	name,
		uint64_t	mask ) const

writeName() [1/2]

CU_API bool castor::TextWriterBase::writeName	(	StringStream &	file,
		StringView	name,
		MbString const &	value ) const

writeName() [2/2]

CU_API bool castor::TextWriterBase::writeName	(	StringStream &	file,
		StringView	name,
		WString const &	value ) const

writeNamedSub()

template<typename ValueT , typename ... ParamsT>

bool castor::TextWriterBase::writeNamedSub	(	StringStream &	file,
		StringView	name,
		ValueT const &	value,
		ParamsT const &...	params ) const

writeNamedSubOpt()

template<typename ValueT , typename ... ParamsT>

bool castor::TextWriterBase::writeNamedSubOpt	(	StringStream &	file,
		StringView	name,
		ValueT const &	value,
		ValueT const &	comp,
		ParamsT const &...	params ) const

writeNameOpt() [1/2]

CU_API bool castor::TextWriterBase::writeNameOpt	(	StringStream &	file,
		StringView	name,
		MbString const &	value,
		MbString const &	comp ) const

writeNameOpt() [2/2]

CU_API bool castor::TextWriterBase::writeNameOpt	(	StringStream &	file,
		StringView	name,
		WString const &	value,
		WString const &	comp ) const

writeOpt() [1/2]

CU_API bool castor::TextWriterBase::writeOpt	(	StringStream &	file,
		StringView	name,
		bool	value ) const

writeOpt() [2/2]

template<typename ValueT >

bool castor::TextWriterBase::writeOpt	(	StringStream &	file,
		StringView	name,
		ValueT const &	value,
		ValueT const &	comp ) const

writePath()

CU_API bool castor::TextWriterBase::writePath	(	StringStream &	file,
		StringView	name,
		Path const &	value ) const

writeSub()

template<typename ValueT , typename ... ParamsT>

bool castor::TextWriterBase::writeSub	(	StringStream &	file,
		ValueT const &	value,
		ParamsT const &...	params ) const

writeSubOpt()

template<typename ValueT , typename ... ParamsT>

bool castor::TextWriterBase::writeSubOpt	(	StringStream &	file,
		ValueT const &	value,
		ValueT const &	comp,
		ParamsT const &...	params ) const

writeText() [1/2]

CU_API bool castor::TextWriterBase::writeText	(	StringStream &	file,
		MbString const &	value ) const

writeText() [2/2]

CU_API bool castor::TextWriterBase::writeText	(	StringStream &	file,
		WString const &	value ) const

Friends And Related Symbol Documentation

WriterBlock

friend class WriterBlock

friend

---

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

• CastorUtils/Data/TextWriter.hpp