1.132.5 Get methods

regex <-match: in=char_array|text_buffer|fragment, start=[int], end=[int] -> length=int

Match the regular expression's regex<-pattern with the given object. The match starts at start (default 0) and should not pass end (default end of the object matched). The regex<-match variant returns the number of characters matched. For both methods, regex<-register_start, regex<-register_value, etc. may be used afterwards.

See also regex->search and regex->match.

regex <-quote: pattern=char_array -> quoted=string

Given some string that may contain regex special characters, return a string in which all these characters are properly escaped. May be used to build a pattern from a plain text. Example:

?- get(regex(''), quote, '^hello*', S),
   get(S, value, T).

S = @27463123
T = '\^hello\*'

regex <-register_end: register=[0..9] -> index=int

0-based index of the end of the match or the end of some register. 0 refers to the entire match; the numbers 1 to 9 to register values.

See also

regex->search

regex <-register_start: register=[0..9] -> index=int

0-based index of the start of the match or the end of some register. 0 refers to the entire match; the numbers 1 to 9 to register values.

See also

regex->search

regex <-register_value: in=object, register=[0..9], type=[type] -> register=any

New string holding the text of the entire match or one of the registers 1 to 9.

See also

regex->search

regex <-registers: -> registers=int

Number of registers in the pattern.

regex <-search: in=char_array|text_buffer|fragment, start=[int], end=[int] -> start=int

Search for the expression in a char_array (name or string) or a text_buffer. The two integers specify the range to search in as [start, end). This method succeeds if a match is found and fails otherwise. After a successful search, regex<-register_start, regex<-register_end and regex<-register_value may be used to get information on the location of the match.

If end is smaller than start, the search is executed backwards. The regex<-search variant returns the regex<-register_start.

Inherits description from: regex->search