QStringMatcher Class Reference

The QStringMatcher class holds a sequence of characters that can be quickly matched in a Unicode string. More...

#include <qstringmatcher.h>

Classes
struct	Data

Public Functions
Qt::CaseSensitivity	caseSensitivity () const
	Returns the case sensitivity setting for this string matcher. More...
int	indexIn (const QString &str, int from=0) const
	Searches the string str from character position from (default 0, i.e. More...
int	indexIn (const QChar *str, int length, int from=0) const
	Searches the string starting at str (of length length) from character position from (default 0, i. More...
QStringMatcher &	operator= (const QStringMatcher &other)
	Assigns the other string matcher to this string matcher. More...
QString	pattern () const
	Returns the string pattern that this string matcher will search for. More...
	QStringMatcher ()
	Constructs an empty string matcher that won't match anything. More...
	QStringMatcher (const QString &pattern, Qt::CaseSensitivity cs=Qt::CaseSensitive)
	Constructs a string matcher that will search for pattern, with case sensitivity cs. More...
	QStringMatcher (const QChar *uc, int len, Qt::CaseSensitivity cs=Qt::CaseSensitive)
	QStringMatcher (const QStringMatcher &other)
	Copies the other string matcher to this string matcher. More...
void	setCaseSensitivity (Qt::CaseSensitivity cs)
	Sets the case sensitivity setting of this string matcher to cs. More...
void	setPattern (const QString &pattern)
	Sets the string that this string matcher will search for to pattern. More...
	~QStringMatcher ()
	Destroys the string matcher. More...

Properties
union {
Data   p
uint   q_data [256]
};
QStringMatcherPrivate *	d_ptr
Qt::CaseSensitivity	q_cs
QString	q_pattern

Detailed Description

The QStringMatcher class holds a sequence of characters that can be quickly matched in a Unicode string.

This class is useful when you have a sequence of QChar that you want to repeatedly match against some strings (perhaps in a loop), or when you want to search for the same sequence of characters multiple times in the same string. Using a matcher object and indexIn() is faster than matching a plain QString with QString::indexOf() if repeated matching takes place. This class offers no benefit if you are doing one-off string matches.

Create the QStringMatcher with the QString you want to search for. Then call indexIn() on the QString that you want to search.

See also

QString, QByteArrayMatcher, QRegExp

Definition at line 55 of file qstringmatcher.h.

Constructors and Destructors

QStringMatcher() [1/4]

QStringMatcher::QStringMatcher

(

)

Constructs an empty string matcher that won't match anything.

Call setPattern() to give it a pattern to match.

Definition at line 154 of file qstringmatcher.cpp.

    : d_ptr(0), q_cs(Qt::CaseSensitive)
{
    qMemSet(q_data, 0, sizeof(q_data));
}

QStringMatcher() [2/4]

QStringMatcher::QStringMatcher	(	const QString &	pattern,
		Qt::CaseSensitivity	cs = Qt::CaseSensitive
	)

Constructs a string matcher that will search for pattern, with case sensitivity cs.

Call indexIn() to perform a search.

Definition at line 166 of file qstringmatcher.cpp.

    : d_ptr(0), q_pattern(pattern), q_cs(cs)
{
    p.uc = pattern.unicode();
    p.len = pattern.size();
    bm_init_skiptable((const ushort *)p.uc, p.len, p.q_skiptable, cs);
}

QStringMatcher() [3/4]

QStringMatcher::QStringMatcher	(	const QChar *	uc,
		int	length,
		Qt::CaseSensitivity	cs = Qt::CaseSensitive
	)

Since

4.5

Constructs a string matcher that will search for the pattern referred to by uc with the given length and case sensitivity specified by cs.

Definition at line 181 of file qstringmatcher.cpp.

    : d_ptr(0), q_cs(cs)
{
    p.uc = uc;
    p.len = len;
    bm_init_skiptable((const ushort *)p.uc, len, p.q_skiptable, cs);
}

QStringMatcher() [4/4]

QStringMatcher::QStringMatcher

(

const QStringMatcher &

other

)

Copies the other string matcher to this string matcher.

Definition at line 192 of file qstringmatcher.cpp.

    : d_ptr(0)
{
    operator=(other);
}

~QStringMatcher()

QStringMatcher::~QStringMatcher

(

)

Destroys the string matcher.

Definition at line 201 of file qstringmatcher.cpp.

{
}

Functions

caseSensitivity()

Qt::CaseSensitivity QStringMatcher::caseSensitivity ( ) const

inline

Returns the case sensitivity setting for this string matcher.

See also

setCaseSensitivity()

Definition at line 74 of file qstringmatcher.h.

{ return q_cs; }

indexIn() [1/2]

int QStringMatcher::indexIn	(	const QString &	str,
		int	from = 0
	)		const

Searches the string str from character position from (default 0, i.e.

from the first character), for the string pattern() that was set in the constructor or in the most recent call to setPattern(). Returns the position where the pattern() matched in str, or -1 if no match was found.

See also

setPattern(), setCaseSensitivity()

Definition at line 274 of file qstringmatcher.cpp.

Referenced by QtPrivate::QStringList_filter(), qt_string_count(), and QString::replace().

{
    if (from < 0)
        from = 0;
    return bm_find((const ushort *)str.unicode(), str.size(), from,
                   (const ushort *)p.uc, p.len,
                   p.q_skiptable, q_cs);
}

indexIn() [2/2]

int QStringMatcher::indexIn	(	const QChar *	str,
		int	length,
		int	from = 0
	)		const

Searches the string starting at str (of length length) from character position from (default 0, i.

Since

4.5

e. from the first character), for the string pattern() that was set in the constructor or in the most recent call to setPattern(). Returns the position where the pattern() matched in str, or -1 if no match was found.

See also

setPattern(), setCaseSensitivity()

Definition at line 298 of file qstringmatcher.cpp.

{
    if (from < 0)
        from = 0;
    return bm_find((const ushort *)str, length, from,
                   (const ushort *)p.uc, p.len,
                   p.q_skiptable, q_cs);
}

operator=()

QStringMatcher & QStringMatcher::operator=

(

const QStringMatcher &

other

)

Assigns the other string matcher to this string matcher.

Definition at line 208 of file qstringmatcher.cpp.

Referenced by QStringMatcher().

{
    if (this != &other) {
        q_pattern = other.q_pattern;
        q_cs = other.q_cs;
        memcpy(q_data, other.q_data, sizeof(q_data));
    }
    return *this;
}

pattern()

QString QStringMatcher::pattern

(

)

const

Returns the string pattern that this string matcher will search for.

See also

setPattern()

Definition at line 244 of file qstringmatcher.cpp.

Referenced by setPattern().

{
    if (!q_pattern.isEmpty())
        return q_pattern;
    return QString(p.uc, p.len);
}

setCaseSensitivity()

void QStringMatcher::setCaseSensitivity

(

Qt::CaseSensitivity

cs

)

Sets the case sensitivity setting of this string matcher to cs.

See also

caseSensitivity(), setPattern(), indexIn()

Definition at line 257 of file qstringmatcher.cpp.

{
    if (cs == q_cs)
        return;
    bm_init_skiptable((const ushort *)q_pattern.unicode(), q_pattern.size(), p.q_skiptable, cs);
    q_cs = cs;
}

setPattern()

void QStringMatcher::setPattern

(

const QString &

pattern

)

Sets the string that this string matcher will search for to pattern.

See also

pattern(), setCaseSensitivity(), indexIn()

Definition at line 224 of file qstringmatcher.cpp.

{
    q_pattern = pattern;
    p.uc = pattern.unicode();
    p.len = pattern.size();
    bm_init_skiptable((const ushort *)pattern.unicode(), pattern.size(), p.q_skiptable, q_cs);
}

Properties

@86

union { ... }

d_ptr

QStringMatcherPrivate* QStringMatcher::d_ptr

private

Definition at line 77 of file qstringmatcher.h.

p

Data QStringMatcher::p

Definition at line 92 of file qstringmatcher.h.

Referenced by indexIn(), pattern(), QStringMatcher(), setCaseSensitivity(), and setPattern().

q_cs

Qt::CaseSensitivity QStringMatcher::q_cs

private

Definition at line 79 of file qstringmatcher.h.

Referenced by indexIn(), operator=(), setCaseSensitivity(), and setPattern().

q_data

uint QStringMatcher::q_data[256]

Definition at line 91 of file qstringmatcher.h.

Referenced by operator=(), and QStringMatcher().

q_pattern

QString QStringMatcher::q_pattern

private

Definition at line 78 of file qstringmatcher.h.

Referenced by operator=(), pattern(), setCaseSensitivity(), and setPattern().

---

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

• /src/corelib/tools/qstringmatcher.h
• /src/corelib/tools/qstringmatcher.cpp