glib/org.gtkkn.bindings.glib/PatternSpec

PatternSpec

class PatternSpec(val glibPatternSpecPointer: <Error class: unknown class><<Error class: unknown class>>) : ProxyInstance(source)

A GPatternSpec struct is the 'compiled' form of a glob-style pattern.

The func@GLib.pattern_match_simple and method@GLib.PatternSpec.match functions match a string against a pattern containing '' and '?' wildcards with similar semantics as the standard glob() function: '' matches an arbitrary, possibly empty, string, '?' matches an arbitrary character.

Note that in contrast to glob(), the '/' character can be matched by the wildcards, there are no '[]' character ranges and '*' and '?' can not be escaped to include them literally in a pattern.

When multiple strings must be matched against the same pattern, it is better to compile the pattern to a struct@GLib.PatternSpec using ctor@GLib.PatternSpec.new and use method@GLib.PatternSpec.match_string instead of func@GLib.pattern_match_simple. This avoids the overhead of repeated pattern compilation.

Constructors

PatternSpec

constructor(pattern: String)

Compiles a pattern to a #GPatternSpec.

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

Types

Companion

object Companion

Properties

glibPatternSpecPointer

val glibPatternSpecPointer: <Error class: unknown class><<Error class: unknown class>>

handle

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

Functions

addCleaner

open override fun addCleaner(cleaner: <Error class: unknown class>): Boolean

Registers a cleaner to be executed when this proxy object is garbage collected.

copy

fun copy(): PatternSpec

Copies @pspec in a new #GPatternSpec.

equal

fun equal(pspec2: PatternSpec): Boolean

Compares two compiled pattern specs and returns whether they will match the same set of strings.

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.

free

fun free()

Frees the memory allocated for the #GPatternSpec.

getSimpleNameWithHandle

open fun getSimpleNameWithHandle(): String

hashCode

open override fun hashCode(): Int

match

fun match(stringLength: <Error class: unknown class>, string: String, stringReversed: String? = null): Boolean

Matches a string against a compiled pattern. Passing the correct length of the string given is mandatory. The reversed string can be omitted by passing null, this is more efficient if the reversed version of the string to be matched is not at hand, as g_pattern_match() will only construct it if the compiled pattern requires reverse matches.

matchString

fun matchString(string: String): Boolean

Matches a string against a compiled pattern. If the string is to be matched against more than one pattern, consider using g_pattern_match() instead while supplying the reversed string.

removeCleaner

open override fun removeCleaner(cleaner: <Error class: unknown class>): Boolean

Removes a previously registered cleaner from this proxy object.