A very simplistic map for ASCII strings and arbitrary value types. More...

#include <canvastools.hxx>

Collaboration diagram for canvas::tools::ValueMap< ValueType >:

Classes
struct	MapEntry

Public Member Functions
	ValueMap (const MapEntry *pMap, ::std::size_t nEntries, bool bCaseSensitive)
	Create a ValueMap for the given array of MapEntries. More...

bool	lookup (const OUString &rName, ValueType &o_rResult) const
	Lookup a value for the given query string. More...

Static Private Member Functions
static bool	mapComparator (const MapEntry &rLHS, const MapEntry &rRHS)

Private Attributes
const MapEntry *	mpMap

::std::size_t	mnEntries

bool	mbCaseSensitive

Detailed Description

template<typename ValueType>
class canvas::tools::ValueMap< ValueType >

A very simplistic map for ASCII strings and arbitrary value types.

This class internally references a constant, static array of sorted MapEntries, and performs a binary search to look up values for a given query string. Note that this map is static, i.e. not meant to be extended at runtime.

Template parameter: \n ValueType: The value type this map should store, associated with an ASCII string.

Definition at line 421 of file canvastools.hxx.

Constructor & Destructor Documentation

◆ ValueMap()

template<typename ValueType >

canvas::tools::ValueMap< ValueType >::ValueMap	(	const MapEntry *	pMap,
		::std::size_t	nEntries,
		bool	bCaseSensitive
	)

inline

Create a ValueMap for the given array of MapEntries.

Parameters

pMap	Pointer to a static array of MapEntries. Must live longer than this object! Make absolutely sure that the string entries passed via pMap are ASCII-only - everything else might not yield correct string comparisons, and thus will result in undefined behaviour.
nEntries	Number of entries for pMap
bCaseSensitive	Whether the map query should be performed case sensitive or not. When bCaseSensitive is false, all MapEntry strings must be lowercase!

Definition at line 447 of file canvastools.hxx.

References aStr, i, maKey, canvas::tools::ValueMap< ValueType >::MapEntry::maKey, canvas::tools::ValueMap< ValueType >::mapComparator(), canvas::tools::ValueMap< ValueType >::mbCaseSensitive, canvas::tools::ValueMap< ValueType >::mnEntries, and SAL_WARN.

Member Function Documentation

◆ lookup()

template<typename ValueType >

bool canvas::tools::ValueMap< ValueType >::lookup	(	const OUString &	rName,
		ValueType &	o_rResult
	)		const

inline

Lookup a value for the given query string.

Parameters

rName	The string to lookup. If the map was created with the case insensitive flag, the lookup is performed case-insensitive, otherwise, case-sensitive.
o_rResult	Output parameter, which receives the value associated with the query string. If no value was found, the referenced object is kept unmodified.