Inheritance diagram for StringParameters:

Public Member Functions
	StringParameters (StringParameters &parent, size_t size)
	Create a new StringParameters instance that can reference part of the data of the given parent instance.

void	PrepareForNextRun ()
	Prepare the string parameters for the next formatting run.

void	SetTypeOfNextParameter (char32_t type)

size_t	GetOffset ()
	Get the current offset, so it can be backed up for certain processing steps, or be used to offset the argument index within sub strings.

void	SetOffset (size_t offset)
	Set the offset within the string from where to return the next result of `GetInt64` or `GetInt32`.

void	AdvanceOffset (size_t advance)
	Advance the offset within the string from where to return the next result of `GetInt64` or `GetInt32`.

template<typename T >
T	GetNextParameter ()
	Get the next parameter from our parameters.

const char *	GetNextParameterString ()
	Get the next string parameter from our parameters.

StringParameters	GetRemainingParameters ()
	Get a new instance of StringParameters that is a "range" into the remaining existing parameters.

StringParameters	GetRemainingParameters (size_t offset)
	Get a new instance of StringParameters that is a "range" into the remaining existing parameters from the given offset.

size_t	GetDataLeft () const
	Return the amount of elements which can still be read.

char32_t	GetTypeAtOffset (size_t offset) const
	Get the type of a specific element.

void	SetParam (size_t n, const StringParameterData &v)

void	SetParam (size_t n, uint64_t v)

template<typename T , std::enable_if_t< std::is_base_of< StrongTypedefBase, T >::value, int > = 0>
void	SetParam (size_t n, T v)

void	SetParam (size_t n, const char *str)

void	SetParam (size_t n, const std::string &str)

void	SetParam (size_t n, std::string &&str)

const StringParameterData &	GetParam (size_t n) const

Protected Member Functions
	StringParameters (std::span< StringParameter > parameters={})

const StringParameter &	GetNextParameterReference ()
	Get the next parameter from our parameters.

Protected Attributes
StringParameters *	parent = nullptr
	If not nullptr, this instance references data from this parent instance.

std::span< StringParameter >	parameters = {}
	Array with the actual parameters.

size_t	offset = 0
	Current offset in the parameters span.

char32_t	next_type = 0
	The type of the next data that is retrieved.

Detailed Description

Definition at line 22 of file strings_internal.h.

Constructor & Destructor Documentation

◆ StringParameters() [1/2]

StringParameters::StringParameters ( std::span< StringParameter > parameters = {} )

inlineprotected

Definition at line 30 of file strings_internal.h.

◆ StringParameters() [2/2]

StringParameters::StringParameters	(	StringParameters &	parent,
		size_t	size
	)

inline

Create a new StringParameters instance that can reference part of the data of the given parent instance.

Definition at line 41 of file strings_internal.h.

Member Function Documentation

◆ AdvanceOffset()

void StringParameters::AdvanceOffset ( size_t advance )

inline

Advance the offset within the string from where to return the next result of GetInt64 or GetInt32.

Parameters

advance The amount to advance the offset by.

Definition at line 79 of file strings_internal.h.

References parameters.

Referenced by FormatString().

◆ GetDataLeft()

size_t StringParameters::GetDataLeft ( ) const

inline

Return the amount of elements which can still be read.

Definition at line 146 of file strings_internal.h.

References offset.

Referenced by FormatString(), and RemapNewGRFStringControlCode().

◆ GetNextParameter()

template<typename T >

T StringParameters::GetNextParameter ( )

inline

Get the next parameter from our parameters.

This updates the offset, so the next time this is called the next parameter will be read.

Returns: The next parameter's value.

Definition at line 92 of file strings_internal.h.

References GetNextParameterReference().

Referenced by FormatString(), and GetStringWithArgs().

◆ GetNextParameterReference()

const StringParameter & StringParameters::GetNextParameterReference ( )

protected

Get the next parameter from our parameters.

This updates the offset, so the next time this is called the next parameter will be read.

Returns: The next parameter.

Definition at line 81 of file strings.cpp.

References next_type, offset, and parameters.

Referenced by GetNextParameter(), and GetNextParameterString().

◆ GetNextParameterString()

const char * StringParameters::GetNextParameterString ( )

inline

Get the next string parameter from our parameters.

This updates the offset, so the next time this is called the next parameter will be read.

Returns: The next parameter's value.

Definition at line 109 of file strings_internal.h.

References GetNextParameterReference().

Referenced by FormatString().

◆ GetOffset()

size_t StringParameters::GetOffset ( )

inline

Get the current offset, so it can be backed up for certain processing steps, or be used to offset the argument index within sub strings.

Returns: The current offset.

Definition at line 54 of file strings_internal.h.

References offset.

Referenced by FormatString().

◆ GetParam()

const StringParameterData & StringParameters::GetParam ( size_t n ) const

inline

Definition at line 190 of file strings_internal.h.

◆ GetRemainingParameters() [1/2]

StringParameters StringParameters::GetRemainingParameters ( )

inline

Get a new instance of StringParameters that is a "range" into the remaining existing parameters.

Upon destruction the offset in the parent is not updated. However, calls to SetDParam do update the parameters.

The returned StringParameters must not outlive this StringParameters.

Returns: A "range" of the string parameters.

Definition at line 128 of file strings_internal.h.

References GetRemainingParameters().

Referenced by FormatString(), and GetRemainingParameters().

◆ GetRemainingParameters() [2/2]

StringParameters StringParameters::GetRemainingParameters ( size_t offset )

inline

Get a new instance of StringParameters that is a "range" into the remaining existing parameters from the given offset.

Upon destruction the offset in the parent is not updated. However, calls to SetDParam do update the parameters.

The returned StringParameters must not outlive this StringParameters.

Parameters

offset The offset to get the remaining parameters for.

Returns: A "range" of the string parameters.

Definition at line 140 of file strings_internal.h.

References offset.

◆ GetTypeAtOffset()

char32_t StringParameters::GetTypeAtOffset ( size_t offset ) const

inline

Get the type of a specific element.

Definition at line 152 of file strings_internal.h.

References offset, and parameters.

Referenced by FormatString().

◆ PrepareForNextRun()

void StringParameters::PrepareForNextRun ( )

Prepare the string parameters for the next formatting run.

This means resetting the type information and resetting the offset to the begin.

Definition at line 68 of file strings.cpp.

References offset, and parameters.

◆ SetOffset()

void StringParameters::SetOffset ( size_t offset )

inline

Set the offset within the string from where to return the next result of GetInt64 or GetInt32.

Parameters

offset The offset.

Definition at line 61 of file strings_internal.h.

References offset, and parameters.

Referenced by FormatString().

◆ SetParam() [1/6]

void StringParameters::SetParam	(	size_t	n,
		const char *	str
	)

inline

Definition at line 176 of file strings_internal.h.

◆ SetParam() [2/6]

void StringParameters::SetParam	(	size_t	n,
		const std::string &	str
	)

inline

Definition at line 182 of file strings_internal.h.

◆ SetParam() [3/6]

void StringParameters::SetParam	(	size_t	n,
		const StringParameterData &	v
	)

inline

Definition at line 158 of file strings_internal.h.

◆ SetParam() [4/6]

void StringParameters::SetParam	(	size_t	n,
		std::string &&	str
	)

inline

Definition at line 184 of file strings_internal.h.

◆ SetParam() [5/6]

template<typename T , std::enable_if_t< std::is_base_of< StrongTypedefBase, T >::value, int > = 0>

void StringParameters::SetParam	(	size_t	n,
		T	v
	)

inline

Definition at line 171 of file strings_internal.h.

◆ SetParam() [6/6]

void StringParameters::SetParam	(	size_t	n,
		uint64_t	v
	)

inline

Definition at line 164 of file strings_internal.h.

◆ SetTypeOfNextParameter()

void StringParameters::SetTypeOfNextParameter ( char32_t type )

inline

Definition at line 47 of file strings_internal.h.

Field Documentation

◆ next_type

char32_t StringParameters::next_type = 0

protected

The type of the next data that is retrieved.

Definition at line 28 of file strings_internal.h.

Referenced by GetNextParameterReference().

◆ offset

size_t StringParameters::offset = 0

protected

Current offset in the parameters span.

Definition at line 27 of file strings_internal.h.

Referenced by GetDataLeft(), GetNextParameterReference(), GetOffset(), GetRemainingParameters(), GetTypeAtOffset(), PrepareForNextRun(), and SetOffset().

◆ parameters

std::span<StringParameter> StringParameters::parameters = {}

protected

Array with the actual parameters.

Definition at line 25 of file strings_internal.h.

Referenced by AdvanceOffset(), GetNextParameterReference(), GetTypeAtOffset(), PrepareForNextRun(), and SetOffset().

◆ parent

StringParameters* StringParameters::parent = nullptr

protected

If not nullptr, this instance references data from this parent instance.

Definition at line 24 of file strings_internal.h.

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

src/strings_internal.h
src/strings.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ StringParameters() [1/2]

◆ StringParameters() [2/2]

Member Function Documentation

◆ AdvanceOffset()

◆ GetDataLeft()

◆ GetNextParameter()

◆ GetNextParameterReference()

◆ GetNextParameterString()

◆ GetOffset()

◆ GetParam()

◆ GetRemainingParameters() [1/2]

◆ GetRemainingParameters() [2/2]

◆ GetTypeAtOffset()

◆ PrepareForNextRun()

◆ SetOffset()

◆ SetParam() [1/6]

◆ SetParam() [2/6]

◆ SetParam() [3/6]

◆ SetParam() [4/6]

◆ SetParam() [5/6]

◆ SetParam() [6/6]

◆ SetTypeOfNextParameter()

Field Documentation

◆ next_type

◆ offset

◆ parameters

◆ parent