MatchInfo

A GMatchInfo is an opaque struct used to return information about matches.

Constructors

this
this(GMatchInfo* gMatchInfo, bool ownedRef)

Sets our main struct and passes it to the parent class.

Destructor

~this
~this()
Undocumented in source.

Members

Functions

doref
MatchInfo doref()

Increases reference count of @match_info by 1.

expandReferences
string expandReferences(string stringToExpand)

Returns a new string containing the text in @string_to_expand with references and escape sequences expanded. References refer to the last match done with @string against @regex and have the same syntax used by g_regex_replace().

fetch
string fetch(int matchNum)

Retrieves the text matching the @match_num'th capturing parentheses. 0 is the full text of the match, 1 is the first paren set, 2 the second, and so on.

fetchAll
string[] fetchAll()

Bundles up pointers to each of the matching substrings from a match and stores them in an array of gchar pointers. The first element in the returned array is the match number 0, i.e. the entire matched text.

fetchNamed
string fetchNamed(string name)

Retrieves the text matching the capturing parentheses named @name.

fetchNamedPos
bool fetchNamedPos(string name, int startPos, int endPos)

Retrieves the position in bytes of the capturing parentheses named @name.

fetchPos
bool fetchPos(int matchNum, int startPos, int endPos)

Retrieves the position in bytes of the @match_num'th capturing parentheses. 0 is the full text of the match, 1 is the first paren set, 2 the second, and so on.

free
void free()

If @match_info is not %NULL, calls g_match_info_unref(); otherwise does nothing.

getMatchCount
int getMatchCount()

Retrieves the number of matched substrings (including substring 0, that is the whole matched text), so 1 is returned if the pattern has no substrings in it and 0 is returned if the match failed.

getMatchInfoStruct
GMatchInfo* getMatchInfoStruct(bool transferOwnership)

Get the main Gtk struct

getRegex
Regex getRegex()

Returns #GRegex object used in @match_info. It belongs to Glib and must not be freed. Use g_regex_ref() if you need to keep it after you free @match_info object.

getString
string getString()

Returns the string searched with @match_info. This is the string passed to g_regex_match() or g_regex_replace() so you may not free it before calling this function.

getStruct
void* getStruct()

the main Gtk struct as a void*

isPartialMatch
bool isPartialMatch()

Usually if the string passed to g_regex_match*() matches as far as it goes, but is too short to match the entire pattern, %FALSE is returned. There are circumstances where it might be helpful to distinguish this case from other cases in which there is no match.

matches
bool matches()

Returns whether the previous match operation succeeded.

next
bool next()

Scans for the next match using the same parameters of the previous call to g_regex_match_full() or g_regex_match() that returned @match_info.

unref
void unref()

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

Variables

gMatchInfo
GMatchInfo* gMatchInfo;

the main Gtk struct

ownedRef
bool ownedRef;
Undocumented in source.

Meta