Detailed Description

MRPT custom INI file parser to allow minimal file preprocessing:

multiline entries via an end-of-line backslash ('\')

Definition at line 2104 of file SimpleIni.h.

#include <simpleini/SimpleIni.h>

Inheritance diagram for mrpt::config::simpleini::MRPT_IniFileParser:

Classes
struct	ParseContext

Public Member Functions
	MRPT_IniFileParser ()

	MRPT_IniFileParser (const MRPT_IniFileParser &rhs)

MRPT_IniFileParser &	operator= (const MRPT_IniFileParser &rhs)

virtual size_t	SizeFromStore (const char *a_pInputData, size_t a_uInputDataLen) override
	Calculate the number of SI_CHAR required for converting the input from the storage format. More...

virtual bool	ConvertFromStore (const char a_pInputData, size_t a_uInputDataLen, char a_pOutputData, size_t a_uOutputDataSize) override
	Convert the input string from the storage format to SI_CHAR. More...

size_t	SizeToStore (const char *a_pInputData)
	Calculate the number of char required by the storage format of this data. More...

bool	ConvertToStore (const char a_pInputData, char a_pOutputData, size_t a_uOutputDataSize)
	Convert the input string to the storage format of this data. More...

Private Member Functions
std::string	parse_process_var_eval (const ParseContext &pc, std::string expr)

void	parse_process_var_define (ParseContext &pc, const std::string &var_name, const std::string &var_value)

size_t	do_parse (const char in_str, const size_t in_len, char out_str)
	Shared code for the two virtual methods. More...

Constructor & Destructor Documentation

◆ MRPT_IniFileParser() [1/2]

mrpt::config::simpleini::MRPT_IniFileParser::MRPT_IniFileParser ( )

inline

Definition at line 2106 of file SimpleIni.h.

◆ MRPT_IniFileParser() [2/2]

mrpt::config::simpleini::MRPT_IniFileParser::MRPT_IniFileParser ( const MRPT_IniFileParser & rhs )

inline

Definition at line 2108 of file SimpleIni.h.

References mrpt::config::simpleini::SI_ConvertA< SI_CHAR >::operator=().

Member Function Documentation

◆ ConvertFromStore()

virtual bool mrpt::config::simpleini::MRPT_IniFileParser::ConvertFromStore	(	const char *	a_pInputData,
		size_t	a_uInputDataLen,
		char *	a_pOutputData,
		size_t	a_uOutputDataSize
	)

inlineoverridevirtual

Convert the input string from the storage format to SI_CHAR.

The storage format is always UTF-8 or MBCS.

Parameters

a_pInputData	Data in storage format to be converted to SI_CHAR.
a_uInputDataLen	Length of storage format data in bytes. This must be the actual length of the data, including nullptr byte if nullptr terminated string is required.
a_pOutputData	Pointer to the output buffer to received the converted data.
a_uOutputDataSize	Size of the output buffer in SI_CHAR.

Returns: true if all of the input data was successfully converted.

Reimplemented from mrpt::config::simpleini::SI_ConvertA< char >.

Definition at line 2125 of file SimpleIni.h.

References do_parse().

◆ ConvertToStore()

bool mrpt::config::simpleini::SI_ConvertA< char >::ConvertToStore	(	const char *	a_pInputData,
		char *	a_pOutputData,
		size_t	a_uOutputDataSize
	)

inlineinherited

Convert the input string to the storage format of this data.

The storage format is always UTF-8 or MBCS.

Parameters

a_pInputData	nullptr terminated source string to convert. All of the data will be converted including the terminating nullptr character.
a_pOutputData	Pointer to the buffer to receive the converted string.
a_uOutputDataSize	Size of the output buffer in char.

Returns: true if all of the input data, including the terminating nullptr character was successfully converted.

Definition at line 2084 of file SimpleIni.h.

◆ do_parse()

size_t mrpt::config::simpleini::MRPT_IniFileParser::do_parse	(	const char *	in_str,
		const size_t	in_len,
		char *	out_str
	)

inlineprivate

Shared code for the two virtual methods.

If out_str==NULL, just count output bytes

Definition at line 2204 of file SimpleIni.h.

References mrpt::config::simpleini::MRPT_IniFileParser::ParseContext::defined_vars, mrpt::format(), mrpt::config::simpleini::MRPT_IniFileParser::ParseContext::line_count, parse_process_var_define(), and parse_process_var_eval().

Referenced by ConvertFromStore(), and SizeFromStore().

◆ operator=()

MRPT_IniFileParser& mrpt::config::simpleini::MRPT_IniFileParser::operator= ( const MRPT_IniFileParser & rhs )

inline

Definition at line 2112 of file SimpleIni.h.

References mrpt::config::simpleini::SI_ConvertA< SI_CHAR >::operator=().

◆ parse_process_var_define()

void mrpt::config::simpleini::MRPT_IniFileParser::parse_process_var_define	(	ParseContext &	pc,
		const std::string &	var_name,
		const std::string &	var_value
	)

inlineprivate

Definition at line 2187 of file SimpleIni.h.

References mrpt::config::simpleini::MRPT_IniFileParser::ParseContext::defined_vars, mrpt::config::simpleini::MRPT_IniFileParser::ParseContext::defined_vars_values, and parse_process_var_eval().

Referenced by do_parse().

◆ parse_process_var_eval()

std::string mrpt::config::simpleini::MRPT_IniFileParser::parse_process_var_eval	(	const ParseContext &	pc,
		std::string	expr
	)

inlineprivate

Definition at line 2142 of file SimpleIni.h.

References mrpt::expr::CRuntimeCompiledExpression::compile(), mrpt::config::simpleini::MRPT_IniFileParser::ParseContext::defined_vars_values, mrpt::expr::CRuntimeCompiledExpression::eval(), mrpt::format(), mrpt::config::simpleini::MRPT_IniFileParser::ParseContext::line_count, and mrpt::system::trim().

Referenced by do_parse(), and parse_process_var_define().

◆ SizeFromStore()

virtual size_t mrpt::config::simpleini::MRPT_IniFileParser::SizeFromStore	(	const char *	a_pInputData,
		size_t	a_uInputDataLen
	)

inlineoverridevirtual

Calculate the number of SI_CHAR required for converting the input from the storage format.

The storage format is always UTF-8 or MBCS.

Parameters

a_pInputData	Data in storage format to be converted to SI_CHAR.
a_uInputDataLen	Length of storage format data in bytes. This must be the actual length of the data, including nullptr byte if nullptr terminated string is required.

Returns: Number of SI_CHAR required by the string when converted. If there are embedded nullptr bytes in the input data, only the string up and not including the nullptr byte will be converted.; -1 cast to size_t on a conversion error.

Reimplemented from mrpt::config::simpleini::SI_ConvertA< char >.

Definition at line 2118 of file SimpleIni.h.

References do_parse(), and SI_ASSERT.

◆ SizeToStore()

size_t mrpt::config::simpleini::SI_ConvertA< char >::SizeToStore ( const char * a_pInputData )

inlineinherited

Calculate the number of char required by the storage format of this data.

The storage format is always UTF-8 or MBCS.

Parameters

a_pInputData nullptr terminated string to calculate the number of bytes required to be converted to storage format.

Returns: Number of bytes required by the string when converted to storage format. This size always includes space for the terminating nullptr character.; -1 cast to size_t on a conversion error.

Definition at line 2065 of file SimpleIni.h.

Detailed Description

Classes

Public Member Functions

Private Member Functions

Constructor & Destructor Documentation

◆ MRPT_IniFileParser() [1/2]

◆ MRPT_IniFileParser() [2/2]

Member Function Documentation

◆ ConvertFromStore()

◆ ConvertToStore()

◆ do_parse()

◆ operator=()

◆ parse_process_var_define()

◆ parse_process_var_eval()

◆ SizeFromStore()

◆ SizeToStore()