Mdt::Algorithm Namespace Reference

Some helper that could be usefull. More...

Functions
QString	removeFirstLastCharIf (const QString &str, QChar c)
	Get a string with first and last char removed in str if they match c.
int	indexOfFirstEscapedToken (const QString &str, int from, const std::vector< QChar > &tokens, const QChar &escape)
	Find the first token that is escaped in str. More...
QString	unescapeEscapedTokens (const QString &str, const std::vector< QChar > &tokens, const QChar &escape)
	Get a string in which each escaped token is unescaped. More...
int	indexOfFirstNonEscapedToken (const QString &str, int from, const std::vector< QChar > &tokens, const QChar &escape)
	Find the first token that is not escaped in str. More...
QString	replaceNonEscapedTokens (const QString &str, const std::initializer_list< std::pair< QChar, QString > > &replaceList, const QChar &escape)
	Get a string in which each non escaped token is replaced. More...
template<typename ForwardIt , typename OutputIt , typename UnaryPredicate >
ForwardIt	moveIf (ForwardIt first, ForwardIt last, OutputIt d_first, UnaryPredicate p)
	Move a range of elements to a new location. More...
template<typename SourceContainer , typename DestinationContainer , typename UnaryPredicate >
void	moveIf (SourceContainer &sourceConatiner, DestinationContainer &destinationContainer, UnaryPredicate p)
	Move a range of elements to a new location. More...

Detailed Description

Some helper that could be usefull.

Function Documentation

int MDT_ALGORITHM_EXPORT Mdt::Algorithm::indexOfFirstEscapedToken	(	const QString &	str,
		int	from,
		const std::vector< QChar > &	tokens,
		const QChar &	escape
	)

Find the first token that is escaped in str.

Parameters

str	String in which to find token
from	Index in str from which to start
tokens	List of elements that are tokens
escape	Char that is used to escape

Precondition

from must be in a valid position in str: 0 <= from < str length . This implies also that str is not empty.

tokens must not be a empty list

Todo:

Define what happens when escape is same as a token

Returns

The position of escape that matched a token, or -1 if no token was found.

Example:

QString str = "A?B\\?CD\\?E";
int i;

i = indexOfFirstEscapedToken(str, 0, {'?','*'}, '\\');
// i == 3

i = indexOfFirstEscapedToken(str, 4, {'?','*'}, '\\');
// i == 7

Definition at line 43 of file Algorithm.cpp.

int MDT_ALGORITHM_EXPORT Mdt::Algorithm::indexOfFirstNonEscapedToken	(	const QString &	str,
		int	from,
		const std::vector< QChar > &	tokens,
		const QChar &	escape
	)

Find the first token that is not escaped in str.

Parameters

str	String in which to find token
from	Index in str from which to start
tokens	List of elements that are tokens
escape	Char that is used to escape

Precondition

from must be in a valid position in str: 0 <= from < str length . This implies also that str is not empty.

tokens must not be a empty list

Todo:

Define what happens when escape is same as a token

Returns

The position that matched, or -1 if no token was found.

Example:

QString str = "A?B\\?C?";
int i;

i = indexOfFirstNonEscapedToken(str, 0, {'?','*'}, '\\');
// i == 1

i = indexOfFirstNonEscapedToken(str, 2, {'?','*'}, '\\');
// i == 6

Definition at line 87 of file Algorithm.cpp.

template<typename ForwardIt , typename OutputIt , typename UnaryPredicate >

ForwardIt Mdt::Algorithm::moveIf	(	ForwardIt	first,
		ForwardIt	last,
		OutputIt	d_first,
		UnaryPredicate	p
	)

Move a range of elements to a new location.

Todo:

Add moveIf() in Mdt::Algorithm:

Note

Probably not a good idea

• Internaly, use std::partition
• Explain what SourceContainer requires: iterator, begin(), end()
• Explain what DestinationContainer requires: iterator, compatible with std::back_inserter, erase(const_iterator first, const_iterator last) erase: QVector has erase(iterator first, iterator last), check.

template<typename ForwardIt, typename OutputIt, typename UnaryPredicate> void moveIf(ForwardIt first, ForwardIt last, OutputIt d_first, UnaryPredicate p);

template<typename SourceContainer, typename DestinationContainer, typename UnaryPredicate> void moveIf(SourceContainer & sourceConatiner, DestinationContainer & destinationContainer, UnaryPredicate p);

Move the elements, for which the predicate p returns true, from range [first, last) to range d_first .

Parameters

first	The beginnig of the source range
last	The end of the source range
d_first
p	The unary predicate which returns true if a element must be moved. The signature of the predicate function should be equivalent to the following: bool pred(const Type & value);

Returns

A iterator past the end of the new source range.

Precondition

first and last must meet the requirement of ValueSwappable and ForwardIterator

d_first must meet the requirement of OutputIterator

Example:

QStringList sourceList{"A","B","C"};
QStringList destinationList;

const auto predicate = [](const QString & value){
  return value == QLatin1String("B");
};
auto it = Mdt::Algorithm::moveIf(sourceList.cbegin(), sourceList.cend(), std::back_inserter(destinationList), predicate);
sourceList.erase(it, sourceList.cend());

sourceList will contain A,C abd destinationList will contain B .

Todo:

Check, think that cbegin()/cend() will not work

See also

void moveIf(SourceContainer &, DestinationContainer &, UnaryPredicate)

Definition at line 188 of file Algorithm.h.

template<typename SourceContainer , typename DestinationContainer , typename UnaryPredicate >

void Mdt::Algorithm::moveIf	(	SourceContainer &	sourceConatiner,
		DestinationContainer &	destinationContainer,
		UnaryPredicate	p
	)

Move a range of elements to a new location.

Move the elements, for which the predicate p returns true, from sourceConatiner to destinationContainer .

Parameters

p	The unary predicate which returns true if a element must be moved. The signature of the predicate function should be equivalent to the following: bool pred(const Type & value);

Precondition

SourceContainer requires STL compatible begin(), end() and erase() methods.

DestinationContainer requires a push_back() method that can be used by std::back_inserter .

Example:

QStringList sourceList{"A","B","C"};
QStringList destinationList;

const auto predicate = [](const QString & value){
  return value == QLatin1String("B");
};
Mdt::Algorithm::moveIf(sourceList, destinationList, predicate);

sourceList will contain A,C abd destinationList will contain B .

See also

ForwardIt moveIf(ForwardIt, ForwardIt, OutputIt, UnaryPredicate)

Definition at line 225 of file Algorithm.h.

QString MDT_ALGORITHM_EXPORT Mdt::Algorithm::replaceNonEscapedTokens	(	const QString &	str,
		const std::initializer_list< std::pair< QChar, QString > > &	replaceList,
		const QChar &	escape
	)

Get a string in which each non escaped token is replaced.

Parameters

str	String in which to search tokens to replace
replaceList	List of replacement par. For each pair, first is the token to match and second is its replacement
escape	Char that is used to escape

Returns

str with tokens replaced

Example:

QString str = "A*B?C\\?D";

str = replaceNonEscapedTokens(str, {{'?',"."},{'*',".*"}}, '\\' );
// str == "A%B_C\\?D"

Definition at line 119 of file Algorithm.cpp.

QString MDT_ALGORITHM_EXPORT Mdt::Algorithm::unescapeEscapedTokens	(	const QString &	str,
		const std::vector< QChar > &	tokens,
		const QChar &	escape
	)

Get a string in which each escaped token is unescaped.

Parameters

str	String in which to find escaped tokens
tokens	List of elements that are tokens
escape	Char that is used to escape

Returns

str with tokens unescaped

Example:

QString str = "A*B?C\\?D";

str = unescapeEscapedTokens(str, {'?',"*"}, '\\' );
// str == "A*B?C?D"

Definition at line 66 of file Algorithm.cpp.