glib/org.gtkkn.bindings.glib/Regex

Regex

class Regex(val glibRegexPointer: <Error class: unknown class><<Error class: unknown class>>) : ProxyInstance

A GRegex is the "compiled" form of a regular expression pattern.

GRegex implements regular expression pattern matching using syntax and semantics similar to Perl regular expression. See the man:pcrepattern(3) for the syntax definition.

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 "\Biss\B" 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

Since

2.14

Constructors

Regex

constructor(glibRegexPointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

glibRegexPointer

val glibRegexPointer: <Error class: unknown class><<Error class: unknown class>>

handle

open override val handle: <Error class: unknown class>

Functions

equals

open operator override fun equals(other: Any?): Boolean

Compare two proxy instances for equality. This will compare both the type of the instances, and their memory addresses.

getCaptureCount

fun getCaptureCount(): <Error class: unknown class>

Returns the number of capturing subpatterns in the pattern.

getCompileFlags

fun getCompileFlags(): RegexCompileFlags

Returns the compile options that @regex was created with.

getHasCrOrLf

fun getHasCrOrLf(): Boolean

Checks whether the pattern contains explicit CR or LF references.

getMatchFlags

fun getMatchFlags(): RegexMatchFlags

Returns the match options that @regex was created with.

getMaxBackref

fun getMaxBackref(): <Error class: unknown class>

Returns the number of the highest back reference in the pattern, or 0 if the pattern does not contain back references.

getMaxLookbehind

fun getMaxLookbehind(): <Error class: unknown class>

Gets the number of characters in the longest lookbehind assertion in the pattern. This information is useful when doing multi-segment matching using the partial matching facilities.

getPattern

fun getPattern(): String

Gets the pattern string associated with @regex, i.e. a copy of the string passed to g_regex_new().

getStringNumber

fun getStringNumber(name: String): <Error class: unknown class>

Retrieves the number of the subexpression named @name.

hashCode

open override fun hashCode(): Int

ref

fun ref(): Regex

Increases reference count of @regex by 1.

split

fun split(string: String, matchOptions: RegexMatchFlags): List<String>

Breaks the string on the pattern, and returns an array of the tokens. If the pattern contains capturing parentheses, then the text for each of the substrings will also be returned. If the pattern does not match anywhere in the string, then the whole string is returned as the first token.

unref

fun unref()

Decreases reference count of @regex by 1. When reference count drops to zero, it frees all the memory associated with the regex structure.