RegexCompileFlags

Added in version 2.14.

class RegexCompileFlags

Flags specifying compile-time options.

Fields

class RegexCompileFlags
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_ANYCRLF
Usually any newline character or character sequence

is recognised. If this option is set, then “R” only recognizes the newline

characters ‘r’, ‘n’ and ‘rn’. Since: 2.34

CASELESS

Letters in the pattern match both upper- and lowercase letters. This option can be changed within a pattern by a “(?i)” option setting.

DEFAULT

No special options set. Since: 2.74

DOLLAR_ENDONLY

A dollar metacharacter (“$”) in the pattern matches only at the end of the string. Without this option, a dollar also matches immediately before the final character if it is a newline (but not before any other newlines). This option is ignored if MULTILINE is set.

DOTALL

A dot metacharacter (“.”) in the pattern matches all characters, including newlines. Without it, newlines are excluded. This option can be changed within a pattern by a (“?s”) option setting.

DUPNAMES

Names used to identify capturing subpatterns need not be unique. This can be helpful for certain types of pattern when it is known that only one instance of the named subpattern can ever be matched.

EXTENDED

Whitespace data characters in the pattern are totally ignored except when escaped or inside a character class. Whitespace does not include the VT character (code 11). In addition, characters between an unescaped “#” outside a character class and the next newline character, inclusive, are also ignored. This can be changed within a pattern by a “(?x)” option setting.

FIRSTLINE

Limits an unanchored pattern to match before (or at) the first newline. Since: 2.34

JAVASCRIPT_COMPAT

Changes behaviour so that it is compatible with JavaScript rather than PCRE. Since GLib 2.74 this is no longer supported, as libpcre2 does not support it. Since: 2.34 Deprecated: 2.74

MULTILINE

By default, GRegex treats the strings as consisting of a single line of characters (even if it actually contains newlines). The “start of line” metacharacter (“^”) matches only at the start of the string, while the “end of line” metacharacter (“$”) matches only at the end of the string, or before a terminating newline (unless DOLLAR_ENDONLY is set). When MULTILINE is set, the “start of line” and “end of line” constructs match immediately following or immediately before any newline in the string, respectively, as well as at the very start and end. This can be changed within a pattern by a “(?m)” option setting.

NEWLINE_ANYCRLF

Usually any newline character or character sequence is recognized. If this option is set, the only recognized newline character sequences are ‘r’, ‘n’, and ‘rn’. Since: 2.34

NEWLINE_CR

Usually any newline character or character sequence is recognized. If this option is set, the only recognized newline character is ‘r’.

NEWLINE_CRLF

Usually any newline character or character sequence is recognized. If this option is set, the only recognized newline character sequence is ‘rn’.

NEWLINE_LF

Usually any newline character or character sequence is recognized. If this option is set, the only recognized newline character is ‘n’.

NO_AUTO_CAPTURE

Disables the use of numbered capturing parentheses in the pattern. Any opening parenthesis that is not followed by “?” behaves as if it were followed by “?:” but named parentheses can still be used for capturing (and they acquire numbers in the usual way).

OPTIMIZE

Since 2.74 and the port to pcre2, requests JIT compilation, which, if the just-in-time compiler is available, further processes a compiled pattern into machine code that executes much faster. However, it comes at the cost of extra processing before the match is performed, so it is most beneficial to use this when the same compiled pattern is used for matching many times. Before 2.74 this option used the built-in non-JIT optimizations in pcre1.

RAW

Usually strings must be valid UTF-8 strings, using this flag they are considered as a raw sequence of bytes.

UNGREEDY

Inverts the “greediness” of the quantifiers so that they are not greedy by default, but become greedy if followed by “?”. It can also be set by a “(?U)” option setting within the pattern.