QRegularExpressionMatch 類

QRegularExpressionMatch 類提供的結果,匹配 QRegularExpression 與字符串。 更多...

頭: #include <QRegularExpressionMatch>
CMake: find_package(Qt6 REQUIRED COMPONENTS Core)
target_link_libraries(mytarget PRIVATE Qt6::Core)
qmake: QT += core

注意: 此類的所有函數 可重入 .

公共函數

QRegularExpressionMatch ()
QRegularExpressionMatch (const QRegularExpressionMatch & match )
(從 6.1 起) QRegularExpressionMatch (QRegularExpressionMatch && match )
~QRegularExpressionMatch ()
QString captured (QAnyStringView name ) const
QString captured (int nth = 0) const
qsizetype capturedEnd (QAnyStringView name ) const
qsizetype capturedEnd (int nth = 0) const
qsizetype capturedLength (QAnyStringView name ) const
qsizetype capturedLength (int nth = 0) const
qsizetype capturedStart (QAnyStringView name ) const
qsizetype capturedStart (int nth = 0) const
QStringList capturedTexts () const
QStringView capturedView (QAnyStringView name ) const
QStringView capturedView (int nth = 0) const
(從 6.3 起) bool hasCaptured (QAnyStringView name ) const
(從 6.3 起) bool hasCaptured (int nth ) const
bool hasMatch () const
bool hasPartialMatch () const
bool isValid () const
int lastCapturedIndex () const
QRegularExpression::MatchOptions matchOptions () const
QRegularExpression::MatchType matchType () const
QRegularExpression regularExpression () const
void swap (QRegularExpressionMatch & other )
QRegularExpressionMatch & operator= (QRegularExpressionMatch && match )
QRegularExpressionMatch & operator= (const QRegularExpressionMatch & match )
QDebug operator<< (QDebug debug , const QRegularExpressionMatch & match )

詳細描述

QRegularExpressionMatch 對象可以被獲得,通過調用 QRegularExpression::match () 函數,或作為全局匹配的單個結果來自 QRegularExpressionMatchIterator .

The success or the failure of a match attempt can be inspected by calling the hasMatch () function. QRegularExpressionMatch also reports a successful partial match through the hasPartialMatch () 函數。

In addition, QRegularExpressionMatch returns the substrings captured by the capturing groups in the pattern string. The implicit capturing group with index 0 captures the result of the whole match. The captured () function returns each substring captured, either by the capturing group's index or by its name:

QRegularExpression re("(\\d\\d) (?<name>\\w+)");
QRegularExpressionMatch match = re.match("23 Jordan");
if (match.hasMatch()) {
    QString number = match.captured(1); // first == "23"
    QString name = match.captured("name"); // name == "Jordan"
}
					

For each captured substring it is possible to query its starting and ending offsets in the subject string by calling the capturedStart () 和 capturedEnd () function, respectively. The length of each captured substring is available using the capturedLength () 函數。

The convenience function capturedTexts () 會返迴 all the captured substrings at once (including the substring matched by the entire pattern) in the order they have been captured by capturing groups; that is, captured(i) == capturedTexts().at(i) .

可以檢索 QRegularExpression object the subject string was matched against by calling the regularExpression () function; the match type and the match options are available as well by calling the matchType () 和 matchOptions () 分彆。

請參考 QRegularExpression 文檔編製,瞭解有關 Qt 正則錶達式類的更多信息。

另請參閱 QRegularExpression .

成員函數文檔編製

QRegularExpressionMatch:: QRegularExpressionMatch ()

Constructs a valid, empty QRegularExpressionMatch object. The regular expression is set to a default-constructed one; the match type to QRegularExpression::NoMatch and the match options to QRegularExpression::NoMatchOption .

The object will report no match through the hasMatch () 和 hasPartialMatch () member functions.

QRegularExpressionMatch:: QRegularExpressionMatch (const QRegularExpressionMatch & match )

Constructs a match result by copying the result of the given match .

另請參閱 operator= ().

[noexcept, since 6.1] QRegularExpressionMatch:: QRegularExpressionMatch ( QRegularExpressionMatch && match )

Constructs a match result by moving the result from the given match .

Note that a moved-from QRegularExpressionMatch can only be destroyed or assigned to. The effect of calling other functions than the destructor or one of the assignment operators is undefined.

該函數在 Qt 6.1 引入。

另請參閱 operator= ().

[noexcept] QRegularExpressionMatch:: ~QRegularExpressionMatch ()

銷毀匹配結果。

QString QRegularExpressionMatch:: captured ( QAnyStringView name ) const

Returns the substring captured by the capturing group named name .

If the named capturing group name did not capture a string, or if there is no capturing group named name , returns a null QString .

注意: In Qt versions prior to 6.8, this function took QString or QStringView , not QAnyStringView .

另請參閱 capturedView (), capturedStart (), capturedEnd (), capturedLength (),和 QString::isNull ().

QString QRegularExpressionMatch:: captured ( int nth = 0) const

返迴子字符串捕獲通過 nth 捕獲組。

nth capturing group did not capture a string, or if there is no such capturing group, returns a null QString .

注意: The implicit capturing group number 0 captures the substring matched by the entire pattern.

另請參閱 capturedView (), lastCapturedIndex (), capturedStart (), capturedEnd (), capturedLength (),和 QString::isNull ().

qsizetype QRegularExpressionMatch:: capturedEnd ( QAnyStringView name ) const

Returns the offset inside the subject string immediately after the ending position of the substring captured by the capturing group named name . If the capturing group named name did not capture a string or doesn't exist, returns -1.

注意: In Qt versions prior to 6.8, this function took QString or QStringView , not QAnyStringView .

另請參閱 capturedStart (), capturedLength (),和 captured ().

qsizetype QRegularExpressionMatch:: capturedEnd ( int nth = 0) const

Returns the offset inside the subject string immediately after the ending position of the substring captured by the nth capturing group. If the nth capturing group did not capture a string or doesn't exist, returns -1.

另請參閱 capturedStart (), capturedLength (),和 captured ().

qsizetype QRegularExpressionMatch:: capturedLength ( QAnyStringView name ) const

Returns the length of the substring captured by the capturing group named name .

注意: This function returns 0 if the capturing group named name did not capture a string or doesn't exist.

注意: In Qt versions prior to 6.8, this function took QString or QStringView , not QAnyStringView .

另請參閱 capturedStart (), capturedEnd (),和 captured ().

qsizetype QRegularExpressionMatch:: capturedLength ( int nth = 0) const

Returns the length of the substring captured by the nth 捕獲組。

注意: This function returns 0 if the nth capturing group did not capture a string or doesn't exist.

另請參閱 capturedStart (), capturedEnd (),和 captured ().

qsizetype QRegularExpressionMatch:: capturedStart ( QAnyStringView name ) const

Returns the offset inside the subject string corresponding to the starting position of the substring captured by the capturing group named name . If the capturing group named name did not capture a string or doesn't exist, returns -1.

注意: In Qt versions prior to 6.8, this function took QString or QStringView , not QAnyStringView .

另請參閱 capturedEnd (), capturedLength (),和 captured ().

qsizetype QRegularExpressionMatch:: capturedStart ( int nth = 0) const

Returns the offset inside the subject string corresponding to the starting position of the substring captured by the nth capturing group. If the nth capturing group did not capture a string or doesn't exist, returns -1.

另請參閱 capturedEnd (), capturedLength (),和 captured ().

QStringList QRegularExpressionMatch:: capturedTexts () const

Returns a list of all strings captured by capturing groups, in the order the groups themselves appear in the pattern string. The list includes the implicit capturing group number 0, capturing the substring matched by the entire pattern.

QStringView QRegularExpressionMatch:: capturedView ( QAnyStringView name ) const

Returns a view of the string captured by the capturing group named name .

If the named capturing group name did not capture a string, or if there is no capturing group named name , returns a null QStringView .

注意: In Qt versions prior to 6.8, this function took QString or QStringView , not QAnyStringView .

另請參閱 captured (), capturedStart (), capturedEnd (), capturedLength (),和 QStringView::isNull ().

QStringView QRegularExpressionMatch:: capturedView ( int nth = 0) const

Returns a view of the substring captured by the nth 捕獲組。

nth capturing group did not capture a string, or if there is no such capturing group, returns a null QStringView .

注意: The implicit capturing group number 0 captures the substring matched by the entire pattern.

另請參閱 captured (), lastCapturedIndex (), capturedStart (), capturedEnd (), capturedLength (),和 QStringView::isNull ().

[since 6.3] bool QRegularExpressionMatch:: hasCaptured ( QAnyStringView name ) const

Returns true if the capturing group named name captured something in the subject string, and false otherwise (or if there is no capturing group called name ).

注意: Some capturing groups in a regular expression may not have captured anything even if the regular expression matched. This may happen, for instance, if a conditional operator is used in the pattern:

QRegularExpression re("([a-z]+)|([A-Z]+)");
QRegularExpressionMatch m = re.match("UPPERCASE");
if (m.hasMatch()) {
    qDebug() << m.hasCaptured(0); // true
    qDebug() << m.hasCaptured(1); // false
    qDebug() << m.hasCaptured(2); // true
}
					

Similarly, a capturing group may capture a substring of length 0; this function will return true for such a capturing group.

注意: In Qt versions prior to 6.8, this function took QString or QStringView , not QAnyStringView .

該函數在 Qt 6.3 引入。

另請參閱 captured () 和 hasMatch ().

[since 6.3] bool QRegularExpressionMatch:: hasCaptured ( int nth ) const

返迴 true 若 nth capturing group captured something in the subject string, and false otherwise (or if there is no such capturing group).

注意: The implicit capturing group number 0 captures the substring matched by the entire pattern.

注意: Some capturing groups in a regular expression may not have captured anything even if the regular expression matched. This may happen, for instance, if a conditional operator is used in the pattern:

QRegularExpression re("([a-z]+)|([A-Z]+)");
QRegularExpressionMatch m = re.match("UPPERCASE");
if (m.hasMatch()) {
    qDebug() << m.hasCaptured(0); // true
    qDebug() << m.hasCaptured(1); // false
    qDebug() << m.hasCaptured(2); // true
}
					

Similarly, a capturing group may capture a substring of length 0; this function will return true for such a capturing group.

該函數在 Qt 6.3 引入。

另請參閱 captured (), lastCapturedIndex (),和 hasMatch ().

bool QRegularExpressionMatch:: hasMatch () const

返迴 true if the regular expression matched against the subject string, or false otherwise.

另請參閱 QRegularExpression::match () 和 hasPartialMatch ().

bool QRegularExpressionMatch:: hasPartialMatch () const

返迴 true if the regular expression partially matched against the subject string, or false otherwise.

注意: Only a match that explicitly used the one of the partial match types can yield a partial match. Still, if such a match succeeds totally, this function will return false, while hasMatch () will return true.

另請參閱 QRegularExpression::match (), QRegularExpression::MatchType ,和 hasMatch ().

bool QRegularExpressionMatch:: isValid () const

返迴 true if the match object was obtained as a result from the QRegularExpression::match () function invoked on a valid QRegularExpression 對象;返迴 false QRegularExpression was invalid.

另請參閱 QRegularExpression::match () 和 QRegularExpression::isValid ().

int QRegularExpressionMatch:: lastCapturedIndex () const

Returns the index of the last capturing group that captured something, including the implicit capturing group 0. This can be used to extract all the substrings that were captured:

QRegularExpressionMatch match = re.match(string);
for (int i = 0; i <= match.lastCapturedIndex(); ++i) {
    QString captured = match.captured(i);
    // ...
}
					

Note that some of the capturing groups with an index less than lastCapturedIndex() could have not matched, and therefore captured nothing.

If the regular expression did not match, this function returns -1.

另請參閱 hasCaptured (), captured (), capturedStart (), capturedEnd (),和 capturedLength ().

QRegularExpression::MatchOptions QRegularExpressionMatch:: matchOptions () const

Returns the match options that were used to get this QRegularExpressionMatch object, that is, the match options that were passed to QRegularExpression::match () 或 QRegularExpression::globalMatch ().

另請參閱 QRegularExpression::match (), regularExpression (),和 matchType ().

QRegularExpression::MatchType QRegularExpressionMatch:: matchType () const

Returns the match type that was used to get this QRegularExpressionMatch object, that is, the match type that was passed to QRegularExpression::match () 或 QRegularExpression::globalMatch ().

另請參閱 QRegularExpression::match (), regularExpression (),和 matchOptions ().

QRegularExpression QRegularExpressionMatch:: regularExpression () const

返迴 QRegularExpression object whose match() function returned this object.

另請參閱 QRegularExpression::match (), matchType (),和 matchOptions ().

[noexcept] void QRegularExpressionMatch:: swap ( QRegularExpressionMatch & other )

Swaps this match result with other 。此操作很快且從不失敗。

[noexcept] QRegularExpressionMatch &QRegularExpressionMatch:: operator= ( QRegularExpressionMatch && match )

Move-assigns the match result match to this object, and returns a reference to the result.

Note that a moved-from QRegularExpressionMatch can only be destroyed or assigned to. The effect of calling other functions than the destructor or one of the assignment operators is undefined.

QRegularExpressionMatch &QRegularExpressionMatch:: operator= (const QRegularExpressionMatch & match )

Assigns the match result match to this object, and returns a reference to the copy.

相關非成員

QDebug operator<< ( QDebug debug , const QRegularExpressionMatch & match )

Writes the match object match 到 debug 對象 debug 為調試目的。

另請參閱 調試技術 .