TurtleBrains::Core::Formatter Class Reference

#include <tb_formatter.hpp>

Public Member Functions
	Formatter (const char *formattedMessage,...)
	Formatter (const Formatter &other)
	Formatter (Formatter &&other)
	~Formatter (void)
Formatter &	operator= (const Formatter &other)
Formatter &	operator= (Formatter &&other) noexcept
const char *	c_str (void) const

Static Public Member Functions
static Formatter	FromArgumentList (const char *formattedMessage, va_list argumentsList)

Detailed Description

The Formatter is a very small helper function that will take a printf style formatted string and the additional parameters to build and hold the string in memory until the Formatter object dies.

Constructor & Destructor Documentation

Formatter() [1/3]

TurtleBrains::Core::Formatter::Formatter ( const char *  formattedMessage,   ...  )

explicit

Build a Formatter object from the printf style formatted string and the additional parameters.

Parameters

formattedMessage

A string using printf formatter options to specify how to use the additional parameters sent in. Formatter("Hello %s!", "world") for instance.

Formatter() [2/3]

TurtleBrains::Core::Formatter::Formatter

(

const Formatter &

other

)

Constructs a Formatter object by copying another. This will invoke memory allocations to create a buffer for the message.

Parameters

other

The formatter object to copy from. The contents will be duplicated.

Formatter() [3/3]

TurtleBrains::Core::Formatter::Formatter

(

Formatter &&

other

)

Moves one Formatter into another without invoking additional memory allocations.

Parameters

other

The formatter object to move the buffer from without allocation memory.

~Formatter()

TurtleBrains::Core::Formatter::~Formatter

(

void

)

Cleans up all the resources used from the Formatter object, which will include freeing memory.

Member Function Documentation

c_str()

const char* TurtleBrains::Core::Formatter::c_str

(

void

)

const

Returns a null-terminated string of the buffer contents, or an empty string if buffer is empty.

FromArgumentList()

static Formatter TurtleBrains::Core::Formatter::FromArgumentList ( const char *  formattedMessage, va_list  argumentsList  )

static

Build a Formatter object from the printf style formatted string and the additional parameters supplied by a va_list.

Parameters

formattedMessage	A string using printf formatter options to specify how to use the additional parameters sent in.
argumentList	A list of the arguments to use to format a message like vasprintf().

operator=() [1/2]

Formatter& TurtleBrains::Core::Formatter::operator=

(

const Formatter &

other

)

Assigns one Formatter object to that of another one by assignment. This may invoke memory allocations to if required to create the buffer for the message.

Parameters

other

The formatter object to copy from. The contents will be duplicated.

operator=() [2/2]

Formatter& TurtleBrains::Core::Formatter::operator= ( Formatter &&  other )

noexcept

Moves one Formatter into another without invoking additional memory allocations.

Parameters

other

The formatter object to move the buffer from without allocation memory.