split_simple


Description:

[ CCode ( array_length = false , array_null_terminated = true ) ]
public static string[] split_simple (string pattern, string str, RegexCompileFlags compile_options = 0, RegexMatchFlags match_options = 0)

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.

This function is equivalent to split but it does not require to compile the pattern with Regex, avoiding some lines of code when you need just to do a split without extracting substrings, capture counts, and so on.

If this function is to be called on the same pattern more than once, it's more efficient to compile the pattern once with Regex and then use split.

As a special case, the result of splitting the empty string "" is an empty vector, not a vector containing a single string. The reason for this special case is that being able to represent an empty vector is typically more useful than consistent handling of empty elements. If you do need to represent empty elements, you'll need to check for the empty string before calling this function.

A pattern that can match empty strings splits string into separate characters wherever it matches the empty string between characters. For example splitting "ab c" using as a separator "\s*", you will get "a", "b" and "c".

Example: Split simple:

public static int main (string[] args) {
// Output:
// ``my``
// ``splitted``
// ``string``
string[] lines = Regex.split_simple ("[ \t]+", "my splitted \t string");
foreach (string line in lines) {
print ("%s\n", line);
}
return 0;
}

valac --pkg glib-2.0 GLib.Regex.split_simple.vala

Parameters:

pattern

the regular expression

compile_options

compile options for the regular expression, or 0

match_options

match options, or 0

string

the string to scan for matches

Returns:

a null-terminated array of strings. Free it using strfreev