RegexMatchFlags
Added in version 2.14.
- class RegexMatchFlags
Flags specifying match-time options.
Fields
- class RegexMatchFlags
- ANCHORED
The pattern is forced to be “anchored”, that is, it is constrained to match only at the first matching point in the string that is being searched. This effect can also be achieved by appropriate constructs in the pattern itself such as the “^” metacharacter.
- BSR_ANY
Overrides the newline definition for “R” set when creating a new
Regex
; any Unicode newline character or character sequence are recognized as a newline by “R”. These are ‘r’, ‘n’ and ‘rn’, and the single characters U+000B LINE TABULATION, U+000C FORM FEED (FF), U+0085 NEXT LINE (NEL), U+2028 LINE SEPARATOR and U+2029 PARAGRAPH SEPARATOR. Since: 2.34
- BSR_ANYCRLF
Overrides the newline definition for “R” set when creating a new
Regex
; only ‘r’, ‘n’, or ‘rn’ character sequences are recognized as a newline by “R”. Since: 2.34
- DEFAULT
No special options set. Since: 2.74
- NEWLINE_ANY
Overrides the newline definition set when creating a new
Regex
, any Unicode newline sequence is recognised as a newline. These are ‘r’, ‘n’ and ‘rn’, and the single characters U+000B LINE TABULATION, U+000C FORM FEED (FF), U+0085 NEXT LINE (NEL), U+2028 LINE SEPARATOR and U+2029 PARAGRAPH SEPARATOR.
- NEWLINE_ANYCRLF
Overrides the newline definition set when creating a new
Regex
; any ‘r’, ‘n’, or ‘rn’ character sequence is recognized as a newline. Since: 2.34
- NEWLINE_CR
Overrides the newline definition set when creating a new
Regex
, setting the ‘r’ character as line terminator.
- NEWLINE_CRLF
Overrides the newline definition set when creating a new
Regex
, setting the ‘rn’ characters sequence as line terminator.
- NEWLINE_LF
Overrides the newline definition set when creating a new
Regex
, setting the ‘n’ character as line terminator.
- NOTBOL
Specifies that first character of the string is not the beginning of a line, so the circumflex metacharacter should not match before it. Setting this without
MULTILINE
(at compile time) causes circumflex never to match. This option affects only the behaviour of the circumflex metacharacter, it does not affect “A”.
- NOTEMPTY
An empty string is not considered to be a valid match if this option is set. If there are alternatives in the pattern, they are tried. If all the alternatives match the empty string, the entire match fails. For example, if the pattern “a?b?” is applied to a string not beginning with “a” or “b”, it matches the empty string at the start of the string. With this flag set, this match is not valid, so GRegex searches further into the string for occurrences of “a” or “b”.
- NOTEMPTY_ATSTART
Like
NOTEMPTY
, but only applied to the start of the matched string. For anchored patterns this can only happen for pattern containing “K”. Since: 2.34
- NOTEOL
Specifies that the end of the subject string is not the end of a line, so the dollar metacharacter should not match it nor (except in multiline mode) a newline immediately before it. Setting this without
MULTILINE
(at compile time) causes dollar never to match. This option affects only the behaviour of the dollar metacharacter, it does not affect “Z” or “z”.
- PARTIAL
Turns on the partial matching feature, for more documentation on partial matching see
is_partial_match()
.
- PARTIAL_HARD
Turns on the partial matching feature. In contrast to to
PARTIAL_SOFT
, this stops matching as soon as a partial match is found, without continuing to search for a possible complete match. Seeis_partial_match()
for more information. Since: 2.34