Valadoc | Vala | Tutorial | API-References | Markup

match_full


Description:

public bool match_full (string str, ssize_t string_len = -1, int start_position = 0, RegexMatchFlags match_options = 0, out MatchInfo match_info = null) throws RegexError

Scans for a match in string for the pattern in regex.

The match_options are combined with the match options specified when the regex structure was created, letting you have more flexibility in reusing GRegex structures.

Setting start_position 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, such as "\b".

A GMatchInfo structure, used to get information on the match, is stored in match_info if not NULL. Note that if match_info is not NULL then it is created even if the function returns FALSE, i.e. you must free it regardless if regular expression actually matched.

string is not copied and is used in GMatchInfo internally. If you use any GMatchInfo method (except g_match_info_free()) after freeing or modifying string then the behaviour is undefined.

To retrieve all the non-overlapping matches of the pattern in string you can use g_match_info_next().


static void
print_uppercase_words (const gchar *string)
{
// Print all uppercase-only words.
GRegex *regex;
GMatchInfo *match_info;
GError *error = NULL;

regex = g_regex_new ("[A-Z]+", 0, 0, NULL);
g_regex_match_full (regex, string, -1, 0, 0, &match_info, &error);
while (g_match_info_matches (match_info))
{
gchar *word = g_match_info_fetch (match_info, 0);
g_print ("Found: %s\n", word);
g_free (word);
g_match_info_next (match_info, &error);
}
g_match_info_free (match_info);
g_regex_unref (regex);
if (error != NULL)
{
g_printerr ("Error while matching: %s\n", error->message);
g_error_free (error);
}
}

Parameters:

regex a GRegex structure from g_regex_new()
string the string to scan for matches. [array length=string_len]
string_len the length of string, or -1 if string is nul-terminated
start_position starting index of the string to match
match_options match options
match_info pointer to location where to store the GMatchInfo, or NULL if you do not need it. [out][allow-none]
error location to store the error occuring, or NULL to ignore errors

Returns:

TRUE is the string matched, FALSE otherwise