GI.GLib.Structs.Regex

The g_regex_*() functions implement regular expression pattern matching using syntax and semantics similar to Perl regular expression.

Some functions accept a start_position argument, setting it differs from just passing over a shortened string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern that begins with any kind of lookbehind assertion. For example, consider the pattern "BissB" which finds occurrences of "iss" in the middle of words. ("B" matches only if the current position in the subject is not a word boundary.) When applied to the string Mississipi from the fourth byte, namely "issipi", it does not match, because "B" is always false at the start of the subject, which is deemed to be a word boundary. However, if the entire string is passed , but with start_position set to 4, it finds the second occurrence of "iss" because it is able to look behind the starting point to discover that it is preceded by a letter.

Note that, unless you set the #G_REGEX_RAW flag, all the strings passed to these functions must be encoded in UTF-8. The lengths and the positions inside the strings are in bytes and not in characters, so, for instance, "xc3xa0" (i.e. "à") is two bytes long but it is treated as a single character. If you set #G_REGEX_RAW the strings can be non-valid UTF-8 strings and a byte is treated as a character, so "xc3xa0" is two bytes and two characters long.

When matching a pattern, "n" matches only against a "n" character in the string, and "r" matches only a "r" character. To match any newline sequence use "R". This particular group matches either the two-character sequence CR + LF ("rn"), or one of the single characters LF (linefeed, U+000A, "n"), VT vertical tab, U+000B, "v"), FF (formfeed, U+000C, "f"), CR (carriage return, U+000D, "r"), NEL (next line, U+0085), LS (line separator, U+2028), or PS (paragraph separator, U+2029).

The behaviour of the dot, circumflex, and dollar metacharacters are affected by newline characters, the default is to recognize any newline character (the same characters recognized by "R"). This can be changed with G_REGEX_NEWLINE_LF and #G_REGEX_NEWLINE_CRLF compile options, and with #G_REGEX_MATCH_NEWLINE_ANY, G_REGEX_MATCH_NEWLINE_LF and #G_REGEX_MATCH_NEWLINE_CRLF match options. These settings are also relevant when compiling a pattern if #G_REGEX_EXTENDED is set, and an unescaped "#" outside a character class is encountered. This indicates a comment that lasts until after the next newline.

When setting the %G_REGEX_JAVASCRIPT_COMPAT flag, pattern syntax and pattern matching is changed to be compatible with the way that regular expressions work in JavaScript. More precisely, a lonely ']' character in the pattern is a syntax error; the '\x' escape only allows 0 to 2 hexadecimal digits, and you must use the '\u' escape sequence with 4 hex digits to specify a unicode codepoint instead of '\x' or 'x{....}'. If '\x' or '\u' are not followed by the specified number of hex digits, they match x and u literally; also '\U' always matches U instead of being an error in the pattern. Finally, pattern matching is modified so that back references to an unset subpattern group produces a match with the empty string instead of an error. See pcreapi(3) for more information.

Creating and manipulating the same #GRegex structure from different threads is not a problem as #GRegex does not modify its internal state between creation and destruction, on the other hand #GMatchInfo is not threadsafe.

The regular expressions low-level functionalities are obtained through the excellent [PCRE](http:/www.pcre.org) library written by Philip Hazel.

Exported types

newtype Regex

Constructors

Regex (ManagedPtr Regex)

Instances

BoxedObject Regex

Methods

boxedType :: Regex -> IO GType

((~) * info (ResolveRegexMethod t Regex), MethodInfo * info Regex p) => IsLabel t (Regex -> p)

Methods

fromLabel :: Proxy# Symbol t -> Regex -> p

((~) * info (ResolveRegexMethod t Regex), MethodInfo * info Regex p) => IsLabelProxy t (Regex -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Regex -> p

HasAttributeList * Regex

((~) * signature (m ()), MonadIO m) => MethodInfo * RegexUnrefMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexUnrefMethodInfo Regex -> signature -> s

((~) * signature ([Text] -> Int32 -> [RegexMatchFlags] -> Int32 -> m [Text]), MonadIO m) => MethodInfo * RegexSplitFullMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexSplitFullMethodInfo Regex -> signature -> s

((~) * signature (Text -> [RegexMatchFlags] -> m [Text]), MonadIO m) => MethodInfo * RegexSplitMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexSplitMethodInfo Regex -> signature -> s

((~) * signature ([Text] -> Int32 -> Text -> [RegexMatchFlags] -> m Text), MonadIO m) => MethodInfo * RegexReplaceLiteralMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexReplaceLiteralMethodInfo Regex -> signature -> s

((~) * signature ([Text] -> Int32 -> Text -> [RegexMatchFlags] -> m Text), MonadIO m) => MethodInfo * RegexReplaceMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexReplaceMethodInfo Regex -> signature -> s

((~) * signature (m Regex), MonadIO m) => MethodInfo * RegexRefMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexRefMethodInfo Regex -> signature -> s

((~) * signature ([Text] -> Int32 -> [RegexMatchFlags] -> m MatchInfo), MonadIO m) => MethodInfo * RegexMatchFullMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexMatchFullMethodInfo Regex -> signature -> s

((~) * signature ([Text] -> Int32 -> [RegexMatchFlags] -> m MatchInfo), MonadIO m) => MethodInfo * RegexMatchAllFullMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexMatchAllFullMethodInfo Regex -> signature -> s

((~) * signature (Text -> [RegexMatchFlags] -> m (Bool, MatchInfo)), MonadIO m) => MethodInfo * RegexMatchAllMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexMatchAllMethodInfo Regex -> signature -> s

((~) * signature (Text -> [RegexMatchFlags] -> m (Bool, MatchInfo)), MonadIO m) => MethodInfo * RegexMatchMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexMatchMethodInfo Regex -> signature -> s

((~) * signature (Text -> m Int32), MonadIO m) => MethodInfo * RegexGetStringNumberMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexGetStringNumberMethodInfo Regex -> signature -> s

((~) * signature (m Text), MonadIO m) => MethodInfo * RegexGetPatternMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexGetPatternMethodInfo Regex -> signature -> s

((~) * signature (m Int32), MonadIO m) => MethodInfo * RegexGetMaxLookbehindMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexGetMaxLookbehindMethodInfo Regex -> signature -> s

((~) * signature (m Int32), MonadIO m) => MethodInfo * RegexGetMaxBackrefMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexGetMaxBackrefMethodInfo Regex -> signature -> s

((~) * signature (m [RegexMatchFlags]), MonadIO m) => MethodInfo * RegexGetMatchFlagsMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexGetMatchFlagsMethodInfo Regex -> signature -> s

((~) * signature (m Bool), MonadIO m) => MethodInfo * RegexGetHasCrOrLfMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexGetHasCrOrLfMethodInfo Regex -> signature -> s

((~) * signature (m [RegexCompileFlags]), MonadIO m) => MethodInfo * RegexGetCompileFlagsMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexGetCompileFlagsMethodInfo Regex -> signature -> s

((~) * signature (m Int32), MonadIO m) => MethodInfo * RegexGetCaptureCountMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexGetCaptureCountMethodInfo Regex -> signature -> s

type AttributeList Regex

type AttributeList Regex

noRegex :: Maybe Regex

Methods

checkReplacement

regexCheckReplacement :: MonadIO m => Text -> m Bool

errorQuark

regexErrorQuark :: MonadIO m => m Word32

escapeNul

regexEscapeNul :: MonadIO m => Text -> Int32 -> m Text

escapeString

regexEscapeString :: MonadIO m => [Text] -> m Text

getCaptureCount

data RegexGetCaptureCountMethodInfo

Instances

((~) * signature (m Int32), MonadIO m) => MethodInfo * RegexGetCaptureCountMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexGetCaptureCountMethodInfo Regex -> signature -> s

regexGetCaptureCount :: MonadIO m => Regex -> m Int32

getCompileFlags

data RegexGetCompileFlagsMethodInfo

Instances

((~) * signature (m [RegexCompileFlags]), MonadIO m) => MethodInfo * RegexGetCompileFlagsMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexGetCompileFlagsMethodInfo Regex -> signature -> s

regexGetCompileFlags :: MonadIO m => Regex -> m [RegexCompileFlags]

getHasCrOrLf

data RegexGetHasCrOrLfMethodInfo

Instances

((~) * signature (m Bool), MonadIO m) => MethodInfo * RegexGetHasCrOrLfMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexGetHasCrOrLfMethodInfo Regex -> signature -> s

regexGetHasCrOrLf :: MonadIO m => Regex -> m Bool

getMatchFlags

data RegexGetMatchFlagsMethodInfo

Instances

((~) * signature (m [RegexMatchFlags]), MonadIO m) => MethodInfo * RegexGetMatchFlagsMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexGetMatchFlagsMethodInfo Regex -> signature -> s

regexGetMatchFlags :: MonadIO m => Regex -> m [RegexMatchFlags]

getMaxBackref

data RegexGetMaxBackrefMethodInfo

Instances

((~) * signature (m Int32), MonadIO m) => MethodInfo * RegexGetMaxBackrefMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexGetMaxBackrefMethodInfo Regex -> signature -> s

regexGetMaxBackref :: MonadIO m => Regex -> m Int32

getMaxLookbehind

data RegexGetMaxLookbehindMethodInfo

Instances

((~) * signature (m Int32), MonadIO m) => MethodInfo * RegexGetMaxLookbehindMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexGetMaxLookbehindMethodInfo Regex -> signature -> s

regexGetMaxLookbehind :: MonadIO m => Regex -> m Int32

getPattern

data RegexGetPatternMethodInfo

Instances

((~) * signature (m Text), MonadIO m) => MethodInfo * RegexGetPatternMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexGetPatternMethodInfo Regex -> signature -> s

regexGetPattern :: MonadIO m => Regex -> m Text

getStringNumber

data RegexGetStringNumberMethodInfo

Instances

((~) * signature (Text -> m Int32), MonadIO m) => MethodInfo * RegexGetStringNumberMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexGetStringNumberMethodInfo Regex -> signature -> s

regexGetStringNumber :: MonadIO m => Regex -> Text -> m Int32

match

data RegexMatchMethodInfo

Instances

((~) * signature (Text -> [RegexMatchFlags] -> m (Bool, MatchInfo)), MonadIO m) => MethodInfo * RegexMatchMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexMatchMethodInfo Regex -> signature -> s

regexMatch :: MonadIO m => Regex -> Text -> [RegexMatchFlags] -> m (Bool, MatchInfo)

matchAll

data RegexMatchAllMethodInfo

Instances

((~) * signature (Text -> [RegexMatchFlags] -> m (Bool, MatchInfo)), MonadIO m) => MethodInfo * RegexMatchAllMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexMatchAllMethodInfo Regex -> signature -> s

regexMatchAll :: MonadIO m => Regex -> Text -> [RegexMatchFlags] -> m (Bool, MatchInfo)

matchAllFull

data RegexMatchAllFullMethodInfo

Instances

((~) * signature ([Text] -> Int32 -> [RegexMatchFlags] -> m MatchInfo), MonadIO m) => MethodInfo * RegexMatchAllFullMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexMatchAllFullMethodInfo Regex -> signature -> s

regexMatchAllFull :: MonadIO m => Regex -> [Text] -> Int32 -> [RegexMatchFlags] -> m MatchInfo

matchFull

data RegexMatchFullMethodInfo

Instances

((~) * signature ([Text] -> Int32 -> [RegexMatchFlags] -> m MatchInfo), MonadIO m) => MethodInfo * RegexMatchFullMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexMatchFullMethodInfo Regex -> signature -> s

regexMatchFull :: MonadIO m => Regex -> [Text] -> Int32 -> [RegexMatchFlags] -> m MatchInfo

matchSimple

regexMatchSimple :: MonadIO m => Text -> Text -> [RegexCompileFlags] -> [RegexMatchFlags] -> m Bool

new

regexNew :: MonadIO m => Text -> [RegexCompileFlags] -> [RegexMatchFlags] -> m (Maybe Regex)

ref

data RegexRefMethodInfo

Instances

((~) * signature (m Regex), MonadIO m) => MethodInfo * RegexRefMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexRefMethodInfo Regex -> signature -> s

regexRef :: MonadIO m => Regex -> m Regex

replace

data RegexReplaceMethodInfo

Instances

((~) * signature ([Text] -> Int32 -> Text -> [RegexMatchFlags] -> m Text), MonadIO m) => MethodInfo * RegexReplaceMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexReplaceMethodInfo Regex -> signature -> s

regexReplace :: MonadIO m => Regex -> [Text] -> Int32 -> Text -> [RegexMatchFlags] -> m Text

replaceLiteral

data RegexReplaceLiteralMethodInfo

Instances

((~) * signature ([Text] -> Int32 -> Text -> [RegexMatchFlags] -> m Text), MonadIO m) => MethodInfo * RegexReplaceLiteralMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexReplaceLiteralMethodInfo Regex -> signature -> s

regexReplaceLiteral :: MonadIO m => Regex -> [Text] -> Int32 -> Text -> [RegexMatchFlags] -> m Text

split

data RegexSplitMethodInfo

Instances

((~) * signature (Text -> [RegexMatchFlags] -> m [Text]), MonadIO m) => MethodInfo * RegexSplitMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexSplitMethodInfo Regex -> signature -> s

regexSplit :: MonadIO m => Regex -> Text -> [RegexMatchFlags] -> m [Text]

splitFull

data RegexSplitFullMethodInfo

Instances

((~) * signature ([Text] -> Int32 -> [RegexMatchFlags] -> Int32 -> m [Text]), MonadIO m) => MethodInfo * RegexSplitFullMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexSplitFullMethodInfo Regex -> signature -> s

regexSplitFull :: MonadIO m => Regex -> [Text] -> Int32 -> [RegexMatchFlags] -> Int32 -> m [Text]

splitSimple

regexSplitSimple :: MonadIO m => Text -> Text -> [RegexCompileFlags] -> [RegexMatchFlags] -> m [Text]

unref

data RegexUnrefMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * RegexUnrefMethodInfo Regex signature

Methods

overloadedMethod :: MethodProxy RegexUnrefMethodInfo Regex -> signature -> s

regexUnref :: MonadIO m => Regex -> m ()