Besides the hyperlinks a client marks using OSC 8, terminal_image->auto_link
makes the terminal find links in plain text. Found links behave exactly
like OSC 8 links: they are drawn in terminal_image<-link_style,
highlighted in
terminal_image<-link_armed_style
while hovered, reported by terminal_image<-link
and activated through terminal_image<-link_message.
- Patterns are matched against logical lines: a line that is
wrapped because it does not fit the window is matched as a whole, so a
URL that wraps is a single link that covers all rows it is on. A match
does not cross a hard newline.
- Only the lines on the screen are matched, just before they are
painted. A line is matched again only if its text changed, so the cost
does not depend on the amount of output.
- The line holding the caret is not linked: it is still being written
or edited. Its links appear once the caret leaves it.
- Nothing is linked while an application uses the alternate screen (e
.g., vim
or less).
- Text the client marked using OSC 8 is never overruled. Neither is a
match of an earlier pattern: a match that overlaps or touches an
existing link is ignored.
- Logical lines longer than 256 rows are not linked.
The example below makes http(s) URLs links to themselves
and links
#1234 to the corresponding issue on GitHub. The URL pattern
does not include punctuation that ends a sentence. Note the double
backslash: the target is a quoted Prolog atom.
auto_link_demo :-
new(T, terminal_image(600, 300)),
send(T, auto_link,
regex('https?://[^[:space:]]*[^[:space:].,;:!?)]')),
send(T, auto_link, regex('#([0-9]+)'),
'https://github.com/SWI-Prolog/swipl-devel/issues/\\1'),
send(T, link_message, message(@prolog, www_open_url, @arg1)),
send(new(W, window('Links', size(600, 300))), display, T),
send(W, open),
send(T, insert, 'See https://www.swi-prolog.org or issue #1234.\r\n').
Epilog (library(epilog)) uses this to link URLs and File:Line
or
File:Line:Column locations such as those in compiler
messages. More patterns can be added through the multifile hook epilog:auto_link/2.
