Класс QRegularExpressionMatchIterator

Класс QRegularExpressionMatchIterator предоставляет итератор по результатам глобального совпадения объекта QRegularExpression со строкой. Подробнее...

• Список всех членов, включая унаследованные

Примечание: Все функции в этом классе являются реентерабельными.

Открытые функции

Подробное описание

Объект QRegularExpressionMatchIterator — это итератор только вперед, похожий на Java-итератор; его можно получить, вызвав функцию QRegularExpression::globalMatch(). Новый QRegularExpressionMatchIterator будет размещён перед первым результатом. Затем вы можете вызвать функцию hasNext(), чтобы проверить, есть ли ещё результаты; если да, функция next() вернёт следующий результат и продвинет итератор.

Каждый результат — это объект QRegularExpressionMatch, содержащий всю информацию для этого результата (включая захваченные подстроки).

Например:

// extracts the words
QRegularExpression re("(\\w+)");
QString subject("the quick fox");
QRegularExpressionMatchIterator i = re.globalMatch(subject);
while (i.hasNext()) {
    QRegularExpressionMatch match = i.next();
    // ...
}

Кроме того, QRegularExpressionMatchIterator предлагает функцию peekNext(), чтобы получить следующий результат без продвижения итератора.

Начиная с Qt 6.0, также возможно просто использовать результат QRegularExpression::globalMatch в цикле for с диапазоном, например так:

QRegularExpression re(R"(\w+)");
QString subject("the quick fox");
for (const QRegularExpressionMatch &match : re.globalMatch(subject)) {
    // ...
}

Вы можете получить объект QRegularExpression, по которому проверялась строка-подлежащая-сопоставлению, вызвав функцию regularExpression(); тип совпадения и параметры совпадения также доступны, соответственно, с помощью вызовов matchType() и matchOptions().

Дополнительную информацию об классах регулярных выражений Qt см. в документации к QRegularExpression.

См. также QRegularExpression и QRegularExpressionMatch.

Документация по членам-функциям

QRegularExpressionMatchIterator::QRegularExpressionMatchIterator(const QRegularExpressionMatchIterator &iterator)

Создаёт объект QRegularExpressionMatchIterator как копию iterator.

См. также operator=().

[since 5.1] QRegularExpressionMatchIterator::QRegularExpressionMatchIterator()

Создаёт пустой, валидный объект QRegularExpressionMatchIterator. Регулярное выражение устанавливается как созданный по умолчанию; тип совпадения — QRegularExpression::NoMatch, а параметры совпадения — QRegularExpression::NoMatchOption.

Вызов метода hasNext() на созданном объекте вернёт false, так как итератор не итерирует по валидной последовательности совпадений.

Эта функция была добавлена в Qt 5.1.

QRegularExpressionMatchIterator &QRegularExpressionMatchIterator::operator=(QRegularExpressionMatchIterator &&iterator)

Перемещающее присваивание iterator этому объекту.

QRegularExpressionMatchIterator &QRegularExpressionMatchIterator::operator=(const QRegularExpressionMatchIterator &iterator)

Присваивает итератор iterator этому объекту и возвращает ссылку на копию.

QRegularExpressionMatchIterator::~QRegularExpressionMatchIterator()

Уничтожает объект QRegularExpressionMatchIterator.

bool QRegularExpressionMatchIterator::hasNext() const

Возвращает true если есть хотя бы один результат совпадения перед итератором; в противном случае возвращает false.

См. также next().

bool QRegularExpressionMatchIterator::isValid() const

Возвращает true если объект итератора был получен в результате вызова функции QRegularExpression::globalMatch() с валидным объектом QRegularExpression; возвращает false если QRegularExpression был невалидным.

См. также QRegularExpression::globalMatch() и QRegularExpression::isValid().

QRegularExpression::MatchOptions QRegularExpressionMatchIterator::matchOptions() const

Возвращает параметры совпадения, которые были использованы для получения этого объекта QRegularExpressionMatchIterator, то есть параметры совпадения, переданные в QRegularExpression::globalMatch().

См. также QRegularExpression::globalMatch(), regularExpression() и matchType().

QRegularExpression::MatchType QRegularExpressionMatchIterator::matchType() const

Возвращает тип совпадения, который был использован для получения этого объекта QRegularExpressionMatchIterator, то есть тип совпадения, переданный в QRegularExpression::globalMatch().

См. также QRegularExpression::globalMatch(), regularExpression() и matchOptions().

QRegularExpressionMatch QRegularExpressionMatchIterator::next()

Возвращает следующий результат совпадения и продвигает итератор на одну позицию.

Примечание: Вызов этой функции, когда итератор находится в конце набора результатов, приводит к неопределённому поведению.

QRegularExpressionMatch QRegularExpressionMatchIterator::peekNext() const

Возвращает результат следующего совпадения без перемещения итератора.

Примечание: Вызов этой функции, когда итератор находится в конце набора результатов, приводит к неопределённым результатам.

QRegularExpression QRegularExpressionMatchIterator::regularExpression() const

Возвращает объект QRegularExpression, чья функция globalMatch() вернула этот объект.

См. также QRegularExpression::globalMatch(), matchType() и matchOptions().

void QRegularExpressionMatchIterator::swap(QRegularExpressionMatchIterator &other)

Меняет местами итератор other с этим объектом итератора. Эта операция очень быстрая и никогда не завершается ошибкой.