ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/perl/matcher
(Generate patch)

Comparing rxvt-unicode/src/perl/matcher (file contents):
Revision 1.26 by sf-exg, Fri Jun 13 21:57:16 2014 UTC vs.
Revision 1.41 by sf-exg, Sun May 28 10:40:41 2023 UTC

1#! perl 1#! perl
2 2
3# Author: Tim Pope <rxvt-unicodeNOSPAM@tpope.org> 3# Author: Tim Pope <rxvt-unicodeNOSPAM@tpope.org>
4# Bob Farrell <robertanthonyfarrell@gmail.com> 4# Bob Farrell <robertanthonyfarrell@gmail.com>
5# Emanuele Giaquinta
5 6
6#:META:RESOURCE:%.launcher:string:default launcher command 7#:META:RESOURCE:%.launcher:string:default launcher command
7#:META:RESOURCE:%.button:string:the button, yeah 8#:META:RESOURCE:%.button:string:the mouse button used to activate a match
8#:META:RESOURCE:%.pattern.:string:extra pattern to match 9#:META:RESOURCE:%.pattern.:string:extra pattern to match
9#:META:RESOURCE:%.launcher.:string:custom launcher for pattern 10#:META:RESOURCE:%.launcher.:string:custom launcher for pattern
10#:META:RESOURCE:%.rend.:string:custom rednition for pattern 11#:META:RESOURCE:%.rend.:string:custom rendition for pattern
11 12
12=head1 NAME 13=head1 NAME
13 14
14matcher - match strings in terminal output and change their rendition 15matcher - match strings in terminal output and change their rendition
15 16
18Uses per-line display filtering (C<on_line_update>) to underline text 19Uses per-line display filtering (C<on_line_update>) to underline text
19matching a certain pattern and make it clickable. When clicked with the 20matching a certain pattern and make it clickable. When clicked with the
20mouse button specified in the C<matcher.button> resource (default 2, or 21mouse button specified in the C<matcher.button> resource (default 2, or
21middle), the program specified in the C<matcher.launcher> resource 22middle), the program specified in the C<matcher.launcher> resource
22(default, the C<url-launcher> resource, C<sensible-browser>) will be started 23(default, the C<url-launcher> resource, C<sensible-browser>) will be started
23with the matched text as first argument. The default configuration is 24with the matched text as first argument. The default configuration is
24suitable for matching URLs and launching a web browser, like the 25suitable for matching URLs and launching a web browser, like the
25former "mark-urls" extension. 26former "mark-urls" extension.
26 27
27The default pattern to match URLs can be overridden with the 28The default pattern to match URLs can be overridden with the
28C<matcher.pattern.0> resource, and additional patterns can be specified 29C<matcher.pattern.0> resource, and additional patterns can be specified
29with numbered patterns, in a manner similar to the "selection" extension. 30with numbered patterns, in a manner similar to the "selection" extension.
30The launcher can also be overridden on a per-pattern basis. 31The launcher can also be overridden on a per-pattern basis.
31 32
32It is possible to activate the most recently seen match or a list of matches 33It is possible to activate the most recently seen match or a list of matches
33from the keyboard. Simply bind a keysym to "matcher:last" or 34from the keyboard. Simply bind a keysym to "matcher:last" or
34"matcher:list" as seen in the example below. 35"matcher:list" as seen in the example below.
36
37The C<matcher:select> action enables a mode in which it is possible to
38iterate over the matches using the keyboard and either activate them
39or copy them to the clipboard. While the mode is active, normal terminal
40input/output is suspended and the following bindings are recognized:
41
42=over
43
44=item C<Up>
45
46Search for a match upwards.
47
48=item C<Down>
49
50Search for a match downwards.
51
52=item C<Home>
53
54Jump to the topmost match.
55
56=item C<End>
57
58Jump to the bottommost match.
59
60=item C<Escape>
61
62Leave the mode and return to the point where search was started.
63
64=item C<Enter>
65
66Activate the current match.
67
68=item C<y>
69
70Copy the current match to the clipboard.
71
72=back
73
74It is also possible to cycle through the matches using a key
75combination bound to the C<matcher:select> action.
35 76
36Example: load and use the matcher extension with defaults. 77Example: load and use the matcher extension with defaults.
37 78
38 URxvt.perl-ext: default,matcher 79 URxvt.perl-ext: default,matcher
39 80
45 URxvt.matcher.button: 1 86 URxvt.matcher.button: 1
46 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] 87 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
47 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) 88 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
48 URxvt.matcher.launcher.2: gvim +$2 $1 89 URxvt.matcher.launcher.2: gvim +$2 $1
49 90
91=head2 Regex encoding/wide character matching
92
93Urxvt stores all text as unicode, in a special encoding that uses
94one character/code point per column. For various reasons, the regular
95expressions are matched directly against this encoding, which means there are a few things
96you need to keep in mind:
97
98=over
99
100=item X resources/command line arguments are locale-encoded
101
102The regexes taken from the command line or resources will be converted
103from locale encoding to unicode. This can change the number of code points
104per character.
105
106=item Wide characters are column-padded with C<$urxvt::NOCHAR>
107
108Wide characters (such as kanji and sometimes tabs) are padded with
109a special character value (C<$urxvt::NOCHAR>). That means that
110constructs such as C<\w> or C<.> will only match part of a character, as
111C<$urxvt::NOCHAR> is not matched by C<\w> and both only match the first
112"column" of a wide character.
113
114That means you have to incorporate C<$urxvt::NOCHAR> into parts of regexes
115that may match wide characters. For example, to match C<\w+> you might
116want to use C<[\w$urxvt::NOCHAR]+> instead, and to match a single character
117(C<.>) you might want to use C<.$urxvt::NOCHAR*> instead.
118
119=back
120
50=cut 121=cut
51 122
52my $url = 123my $url =
53 qr{ 124 qr{
54 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.) 125 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.)
55 [\w\-\@;\/?:&=%\$.+!*\x27,~#]* 126 [\w\-\@;\/?:&=%\$.+!*\x27,~#$urxvt::NOCHAR]*
56 ( 127 (
57 \([\w\-\@;\/?:&=%\$.+!*\x27,~#]*\)| # Allow a pair of matched parentheses 128 \([\w\-\@;\/?:&=%\$.+!*\x27,~#$urxvt::NOCHAR]*\)| # Allow a pair of matched parentheses
58 [\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic) 129 [\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic)
59 )+ 130 )+
60 }x; 131 }x;
61 132
62sub matchlist_key_press { 133sub matchlist_key_press {
76 147
77# backwards compat 148# backwards compat
78sub on_user_command { 149sub on_user_command {
79 my ($self, $cmd) = @_; 150 my ($self, $cmd) = @_;
80 151
81 if ($cmd =~ s/^matcher:list\b//) { 152 if ($cmd eq "matcher:list") {
82 $self->matchlist; 153 $self->matchlist;
83 } else { 154 } elsif ($cmd eq "matcher:last") {
84 if ($cmd =~ s/^matcher:last\b//) {
85 $self->most_recent; 155 $self->most_recent;
156 } elsif ($cmd eq "matcher:select") {
157 $self->select_enter;
86 } elsif ($cmd =~ s/^matcher\b//) { 158 } elsif ($cmd eq "matcher") {
87 # for backward compatibility 159 # for backward compatibility
88 $self->most_recent; 160 $self->most_recent;
89 }
90 } 161 }
91 162
92 () 163 ()
93} 164}
94 165
97 168
98 if ($action eq "list") { 169 if ($action eq "list") {
99 $self->matchlist; 170 $self->matchlist;
100 } elsif ($action eq "last") { 171 } elsif ($action eq "last") {
101 $self->most_recent; 172 $self->most_recent;
173 } elsif ($action eq "select") {
174 $self->select_enter;
102 } 175 }
103 176
104 () 177 ()
105} 178}
106 179
147 220
148 $self->enable (key_press => \&matchlist_key_press); 221 $self->enable (key_press => \&matchlist_key_press);
149} 222}
150 223
151sub most_recent { 224sub most_recent {
152 my ($self) = shift; 225 my ($self) = @_;
153 my $row = $self->nrow; 226 my $row = $self->nrow - 1;
154 my @exec; 227
155 while($row-- > $self->top_row) { 228 while ($row >= $self->top_row) {
229 my $line = $self->line ($row);
156 @exec = $self->command_for($row); 230 my @exec = $self->command_for ($row);
157 last if(@exec);
158 }
159 if(@exec) { 231 if (@exec) {
160 return $self->exec_async (@exec); 232 return $self->exec_async (@exec);
233 }
234
235 $row = $line->beg - 1;
161 } 236 }
237
162 () 238 ()
163} 239}
164 240
165sub my_resource { 241sub my_resource {
166 $_[0]->x_resource ("%.$_[1]") 242 $_[0]->x_resource ("%.$_[1]")
205 } 281 }
206 } 282 }
207 283
208 my @defaults = ($url); 284 my @defaults = ($url);
209 my @matchers; 285 my @matchers;
210 for (my $idx = 0; defined (my $res = $self->my_resource ("pattern.$idx") || $defaults[$idx]); $idx++) { 286 for (my $idx = 0; defined (my $res = $self->locale_decode ($self->my_resource ("pattern.$idx")) || $defaults[$idx]); $idx++) {
211 $res = $self->locale_decode ($res);
212 utf8::encode $res;
213 my $launcher = $self->my_resource ("launcher.$idx"); 287 my $launcher = $self->my_resource ("launcher.$idx");
214 $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher; 288 $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher;
215 my $rend = $self->parse_rend($self->my_resource ("rend.$idx")); 289 my $rend = $self->parse_rend($self->my_resource ("rend.$idx"));
216 unshift @matchers, [qr($res)x,$launcher,$rend]; 290 unshift @matchers, [qr($res)x,$launcher,$rend];
217 } 291 }
224 my ($self, $row) = @_; 298 my ($self, $row) = @_;
225 299
226 # fetch the line that has changed 300 # fetch the line that has changed
227 my $line = $self->line ($row); 301 my $line = $self->line ($row);
228 my $text = $line->t; 302 my $text = $line->t;
229 my $i = 0; 303 my $rend;
230 304
231 # find all urls (if any) 305 # find all urls (if any)
232 for my $matcher (@{$self->{matchers}}) { 306 for my $matcher (@{$self->{matchers}}) {
233 while ($text =~ /$matcher->[0]/g) { 307 while ($text =~ /$matcher->[0]/g) {
234 #print "$&\n"; 308 #print "$&\n";
235 my $rend = $line->r; 309 $rend ||= $line->r;
236 310
237 # mark all characters as underlined. we _must_ not toggle underline, 311 # mark all characters as underlined. we _must_ not toggle underline,
238 # as we might get called on an already-marked url. 312 # as we might get called on an already-marked url.
239 &{$matcher->[2]} 313 &{$matcher->[2]}
240 for @{$rend}[ $-[0] .. $+[0] - 1]; 314 for @{$rend}[$-[0] .. $+[0] - 1];
241
242 $line->r ($rend);
243 } 315 }
244 } 316 }
317
318 $line->r ($rend) if $rend;
245 319
246 () 320 ()
247} 321}
248 322
249sub valid_button { 323sub valid_button {
256 330
257sub find_matches { 331sub find_matches {
258 my ($self, $row, $col) = @_; 332 my ($self, $row, $col) = @_;
259 my $line = $self->line ($row); 333 my $line = $self->line ($row);
260 my $text = $line->t; 334 my $text = $line->t;
261 my $off = $line->offset_of ($row, $col) if $col; 335 my $off = $line->offset_of ($row, $col) if defined $col;
262 336
263 my @matches; 337 my @matches;
264 for my $matcher (@{$self->{matchers}}) { 338 for my $matcher (@{$self->{matchers}}) {
265 my $launcher = $matcher->[1] || $self->{launcher}; 339 my $launcher = $matcher->[1] || $self->{launcher};
266 while ($text =~ /$matcher->[0]/g) { 340 while ($text =~ /$matcher->[0]/g) {
267 my $match = substr $text, $-[0], $+[0] - $-[0]; 341 my $match = substr $text, $-[0], $+[0] - $-[0];
268 my @begin = @-; 342 my @begin = @-;
269 my @end = @+; 343 my @end = @+;
270 my @exec; 344 my @exec;
271 345
272 if (!defined($off) || ($-[0] <= $off && $+[0] >= $off)) { 346 if (!(defined $off) || ($-[0] <= $off && $+[0] >= $off)) {
273 if ($launcher !~ /\$/) { 347 if ($launcher !~ /\$/) {
274 @exec = ($launcher, $match); 348 @exec = ($launcher, $match);
275 } else { 349 } else {
276 # It'd be nice to just access a list like ($&,$1,$2...), 350 # It'd be nice to just access a list like ($&,$1,$2...),
277 # but alas, m//g behaves differently in list context. 351 # but alas, m//g behaves differently in list context.
278 @exec = map { s/\$(\d+)|\$\{(\d+)\}/ 352 @exec = map {
353 s{\$(\d+)|\$\{(\d+)\}}{
279 substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2] 354 substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2]
355 }egx;
356 $_
280 /egx; $_ } split /\s+/, $launcher; 357 } split /\s+/, $launcher;
281 } 358 }
282 359
283 push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ]; 360 push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ];
284 } 361 }
285 } 362 }
286 } 363 }
287 364
288 @matches; 365 @matches
289} 366}
290 367
291sub command_for { 368sub command_for {
292 my ($self, $row, $col) = @_; 369 my ($self, $row, $col) = @_;
293 370
300 () 377 ()
301} 378}
302 379
303sub on_button_press { 380sub on_button_press {
304 my ($self, $event) = @_; 381 my ($self, $event) = @_;
382
383 if (
305 if($self->valid_button($event) 384 $self->valid_button ($event)
306 && (my @exec = $self->command_for($event->{row},$event->{col}))) { 385 && (my @exec = $self->command_for ($event->{row}, $event->{col}))
386 ) {
307 $self->{row} = $event->{row}; 387 $self->{row} = $event->{row};
308 $self->{col} = $event->{col}; 388 $self->{col} = $event->{col};
309 $self->{cmd} = \@exec; 389 $self->{cmd} = \@exec;
310 return 1; 390 return 1;
311 } else { 391 } else {
324 my $col = delete $self->{col}; 404 my $col = delete $self->{col};
325 my $cmd = delete $self->{cmd}; 405 my $cmd = delete $self->{cmd};
326 406
327 return if !defined $row; 407 return if !defined $row;
328 408
329 if($row == $event->{row} && abs($col-$event->{col}) < 2 409 if (
410 $row == $event->{row}
411 && (abs $col-$event->{col}) < 2
330 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) { 412 && (join "\x00", @$cmd) eq (join "\x00", $self->command_for ($row, $col))
413 ) {
331 if($self->valid_button($event)) { 414 if ($self->valid_button ($event)) {
332
333 $self->exec_async (@$cmd); 415 $self->exec_async (@$cmd);
334
335 } 416 }
336 } 417 }
337 418
338 1; 419 1;
339} 420}
340 421
422sub select_enter {
423 my ($self) = @_;
424
425 $self->{view_start} = $self->view_start;
426 $self->{pty_ev_events} = $self->pty_ev_events (urxvt::EV_NONE);
427 $self->{cur_row} = $self->nrow - 1;
428
429 $self->enable (
430 key_press => \&select_key_press,
431 refresh_begin => \&select_refresh,
432 refresh_end => \&select_refresh,
433 );
434
435 $self->{overlay} = $self->overlay (0, -1, $self->ncol, 1, urxvt::OVERLAY_RSTYLE, 0);
436 $self->{overlay}->set (0, 0, "match-select");
437}
438
439sub select_leave {
440 my ($self) = @_;
441
442 $self->disable ("key_press", "refresh_begin", "refresh_end");
443 $self->pty_ev_events ($self->{pty_ev_events});
444
445 delete $self->{overlay};
446 delete $self->{matches};
447 delete $self->{id};
448}
449
450sub select_search {
451 my ($self, $dir, $row) = @_;
452
453 while ($self->nrow > $row && $row >= $self->top_row) {
454 my $line = $self->line ($row)
455 or last;
456
457 my @matches = $self->find_matches ($row);
458 if (@matches) {
459 @matches = sort { $a->[0] <=> $b->[0] or $a->[1] <=> $b->[1] } @matches;
460 $self->{matches} = \@matches;
461 $self->{cur_row} = $row;
462 $self->{id} = $dir < 0 ? @{ $self->{matches} } - 1 : 0;
463 $self->view_start ($row - ($self->nrow >> 1));
464 $self->want_refresh;
465 return 1;
466 }
467
468 $row = $dir < 0 ? $line->beg - 1 : $line->end + 1;
469 }
470
471 $self->scr_bell;
472
473 ()
474}
475
476sub select_refresh {
477 my ($self) = @_;
478
479 return unless $self->{matches};
480
481 my $cur = $self->{matches}[$self->{id}];
482 $self->scr_xor_span (@$cur[0 .. 3], urxvt::RS_RVid);
483
484 ()
485}
486
487sub select_key_press {
488 my ($self, $event, $keysym, $string) = @_;
489
490 if ($keysym == 0xff0d || $keysym == 0xff8d) { # enter
491 if ($self->{matches}) {
492 my @match = @{ $self->{matches}[$self->{id}] };
493 $self->exec_async (@match[5 .. $#match]);
494 }
495 $self->select_leave;
496 } elsif ($keysym == 0x79) { # y
497 if ($self->{matches}) {
498 $self->selection ($self->{matches}[$self->{id}][4], 1);
499 $self->selection_grab (urxvt::CurrentTime, 1);
500 }
501 $self->select_leave;
502 } elsif ($keysym == 0xff1b) { # escape
503 $self->view_start ($self->{view_start});
504 $self->select_leave;
505 } elsif ($keysym == 0xff50) { # home
506 $self->select_search (+1, $self->top_row)
507 } elsif ($keysym == 0xff57) { # end
508 $self->select_search (-1, $self->nrow - 1)
509 } elsif ($keysym == 0xff52) { # up
510 if ($self->{id} > 0) {
511 $self->{id}--;
512 $self->want_refresh;
513 } else {
514 my $line = $self->line ($self->{cur_row});
515 $self->select_search (-1, $line->beg - 1)
516 if $line->beg > $self->top_row;
517 }
518 } elsif ($keysym == 0xff54) { # down
519 if ($self->{id} < @{ $self->{matches} } - 1) {
520 $self->{id}++;
521 $self->want_refresh;
522 } else {
523 my $line = $self->line ($self->{cur_row});
524 $self->select_search (+1, $line->end + 1)
525 if $line->end < $self->nrow;
526 }
527 } elsif ($self->lookup_keysym ($keysym, $event->{state}) eq "matcher:select") {
528 if ($self->{id} > 0) {
529 $self->{id}--;
530 $self->want_refresh;
531 } else {
532 my $line = $self->line ($self->{cur_row});
533 $self->select_search (-1, $self->nrow - 1)
534 unless $self->select_search (-1, $line->beg - 1);
535 }
536 }
537
538 1
539}
540
341# vim:set sw=3 sts=3 et: 541# vim:set sw=3 sts=3 et:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines