Package org.gnome.glib

Class MatchInfo

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.glib.MatchInfo

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class MatchInfo
extends ProxyInstance

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

Constructor Summary

Constructors

Constructor	Description
MatchInfo(MemorySegment address)	Create a MatchInfo proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
String	expandReferences(String stringToExpand)	Returns a new string containing the text in stringToExpand with references and escape sequences expanded.
String	fetch(int matchNum)	Retrieves the text matching the matchNum'th capturing parentheses.
String[]	fetchAll()	Bundles up pointers to each of the matching substrings from a match and stores them in an array of gchar pointers.
String	fetchNamed(String name)	Retrieves the text matching the capturing parentheses named name.
boolean	fetchNamedPos(String name, @Nullable Out<Integer> startPos, @Nullable Out<Integer> endPos)	Retrieves the position in bytes of the capturing parentheses named name.
boolean	fetchPos(int matchNum, @Nullable Out<Integer> startPos, @Nullable Out<Integer> endPos)	Retrieves the position in bytes of the matchNum'th capturing parentheses.
void	free()	If this MatchInfo is not null, calls g_match_info_unref(); otherwise does nothing.
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.
Regex	getRegex()	Returns GRegex object used in this MatchInfo.
String	getString()	Returns the string searched with this MatchInfo.
static Type	getType()	Get the GType of the MatchInfo class
boolean	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.
boolean	matches()	Returns whether the previous match operation succeeded.
boolean	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 this MatchInfo.
MatchInfo	ref()	Increases reference count of this MatchInfo by 1.
void	unref()	Decreases reference count of this MatchInfo by 1.

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MatchInfo

public MatchInfo(MemorySegment address)

Create a MatchInfo proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the MatchInfo class

Returns:

the GType

expandReferences

public String expandReferences(String stringToExpand)
                        throws GErrorException

Returns a new string containing the text in stringToExpand 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().

The stringToExpand must be UTF-8 encoded even if RegexCompileFlags.RAW was passed to g_regex_new().

The backreferences are extracted from the string passed to the match function, so you cannot call this function after freeing the string.

this MatchInfo may be null in which case stringToExpand must not contain references. For instance "foo\\n" does not refer to an actual pattern and '\\n' merely will be replaced with \\n character, while to expand "\\0" (whole match) one needs the result of a match. Use g_regex_check_replacement() to find out whether stringToExpand contains references.

Parameters:

stringToExpand - the string to expand

Returns:

the expanded string, or null if an error occurred

Throws:

GErrorException - see GError

fetch

public String fetch(int matchNum)

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

If matchNum is a valid sub pattern but it didn't match anything (e.g. sub pattern 1, matching "b" against "(a)?b") then an empty string is returned.

If the match was obtained using the DFA algorithm, that is using g_regex_match_all() or g_regex_match_all_full(), the retrieved string is not that of a set of parentheses but that of a matched substring. Substrings are matched in reverse order of length, so 0 is the longest match.

The string is fetched from the string passed to the match function, so you cannot call this function after freeing the string.

Parameters:

matchNum - number of the sub expression

Returns:

The matched substring, or null if an error occurred. You have to free the string yourself

fetchAll

public 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.

If a sub pattern didn't match anything (e.g. sub pattern 1, matching "b" against "(a)?b") then an empty string is inserted.

If the last match was obtained using the DFA algorithm, that is using g_regex_match_all() or g_regex_match_all_full(), the retrieved strings are not that matched by sets of parentheses but that of the matched substring. Substrings are matched in reverse order of length, so the first one is the longest match.

The strings are fetched from the string passed to the match function, so you cannot call this function after freeing the string.

Returns:

a null-terminated array of gchar * pointers. It must be freed using g_strfreev(). If the previous match failed null is returned

fetchNamed

public String fetchNamed(String name)

Retrieves the text matching the capturing parentheses named name.

If name is a valid sub pattern name but it didn't match anything (e.g. sub pattern "X", matching "b" against "(?P<X>a)?b") then an empty string is returned.

The string is fetched from the string passed to the match function, so you cannot call this function after freeing the string.

Parameters:

name - name of the subexpression

Returns:

The matched substring, or null if an error occurred. You have to free the string yourself

fetchNamedPos

public boolean fetchNamedPos(String name,
 @Nullable
 @Nullable Out<Integer> startPos,
 @Nullable
 @Nullable Out<Integer> endPos)

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

If name is a valid sub pattern name but it didn't match anything (e.g. sub pattern "X", matching "b" against "(?P<X>a)?b") then startPos and endPos are set to -1 and true is returned.

Parameters:

name - name of the subexpression

startPos - pointer to location where to store the start position, or null

endPos - pointer to location where to store the end position, or null

Returns:

true if the position was fetched, false otherwise. If the position cannot be fetched, startPos and endPos are left unchanged.

fetchPos

public boolean fetchPos(int matchNum,
 @Nullable
 @Nullable Out<Integer> startPos,
 @Nullable
 @Nullable Out<Integer> endPos)

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

If matchNum is a valid sub pattern but it didn't match anything (e.g. sub pattern 1, matching "b" against "(a)?b") then startPos and endPos are set to -1 and true is returned.

If the match was obtained using the DFA algorithm, that is using g_regex_match_all() or g_regex_match_all_full(), the retrieved position is not that of a set of parentheses but that of a matched substring. Substrings are matched in reverse order of length, so 0 is the longest match.

Parameters:

matchNum - number of the sub expression

startPos - pointer to location where to store the start position, or null

endPos - pointer to location where to store the end position, or null

Returns:

true if the position was fetched, false otherwise. If the position cannot be fetched, startPos and endPos are left unchanged

free

public void free()

If this MatchInfo is not null, calls g_match_info_unref(); otherwise does nothing.

getMatchCount

public 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.

If the last match was obtained using the DFA algorithm, that is using g_regex_match_all() or g_regex_match_all_full(), the retrieved count is not that of the number of capturing parentheses but that of the number of matched substrings.

Returns:

Number of matched substrings, or -1 if an error occurred

getRegex

public Regex getRegex()

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

Returns:

GRegex object used in this MatchInfo

getString

public String getString()

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

Returns:

the string searched with this MatchInfo

isPartialMatch

public boolean 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.

Consider, for example, an application where a human is required to type in data for a field with specific formatting requirements. An example might be a date in the form ddmmmyy, defined by the pattern "^\\d?\\d(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\\d\\d$". If the application sees the user’s keystrokes one by one, and can check that what has been typed so far is potentially valid, it is able to raise an error as soon as a mistake is made.

GRegex supports the concept of partial matching by means of the RegexMatchFlags.PARTIAL_SOFT and RegexMatchFlags.PARTIAL_HARD flags. When they are used, the return code for g_regex_match() or g_regex_match_full() is, as usual, true for a complete match, false otherwise. But, when these functions return false, you can check if the match was partial calling g_match_info_is_partial_match().

The difference between RegexMatchFlags.PARTIAL_SOFT and RegexMatchFlags.PARTIAL_HARD is that when a partial match is encountered with RegexMatchFlags.PARTIAL_SOFT, matching continues to search for a possible complete match, while with RegexMatchFlags.PARTIAL_HARD matching stops at the partial match. When both RegexMatchFlags.PARTIAL_SOFT and RegexMatchFlags.PARTIAL_HARD are set, the latter takes precedence.

There were formerly some restrictions on the pattern for partial matching. The restrictions no longer apply.

See pcrepartial(3) for more information on partial matching.

Returns:

true if the match was partial, false otherwise

matches

public boolean matches()

Returns whether the previous match operation succeeded.

Returns:

true if the previous match operation succeeded, false otherwise

next

public boolean next()
             throws GErrorException

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

The match is done on the string passed to the match function, so you cannot free it before calling this function.

Returns:

true is the string matched, false otherwise

Throws:

GErrorException - see GError

ref

public MatchInfo ref()

Increases reference count of this MatchInfo by 1.

Returns:

this MatchInfo

unref

public void unref()

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