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.1 by root, Sat Nov 11 20:06:34 2006 UTC vs.
Revision 1.39 by root, Sun Nov 21 19:33:32 2021 UTC

1#! perl 1#! perl
2 2
3# Author: Tim Pope <rxvt-unicodeNOSPAM@tpope.info> 3# Author: Tim Pope <rxvt-unicodeNOSPAM@tpope.org>
4# Bob Farrell <robertanthonyfarrell@gmail.com>
5# Emanuele Giaquinta
6
7#:META:RESOURCE:%.launcher:string:default launcher command
8#:META:RESOURCE:%.button:string:the mouse button used to activate a match
9#:META:RESOURCE:%.pattern.:string:extra pattern to match
10#:META:RESOURCE:%.launcher.:string:custom launcher for pattern
11#:META:RESOURCE:%.rend.:string:custom rendition for pattern
12
13=head1 NAME
14
15matcher - match strings in terminal output and change their rendition
16
17=head1 DESCRIPTION
18
19Uses per-line display filtering (C<on_line_update>) to underline text
20matching a certain pattern and make it clickable. When clicked with the
21mouse button specified in the C<matcher.button> resource (default 2, or
22middle), the program specified in the C<matcher.launcher> resource
23(default, the C<url-launcher> resource, C<sensible-browser>) will be started
24with the matched text as first argument. The default configuration is
25suitable for matching URLs and launching a web browser, like the
26former "mark-urls" extension.
27
28The default pattern to match URLs can be overridden with the
29C<matcher.pattern.0> resource, and additional patterns can be specified
30with numbered patterns, in a manner similar to the "selection" extension.
31The launcher can also be overridden on a per-pattern basis.
32
33It is possible to activate the most recently seen match or a list of matches
34from the keyboard. Simply bind a keysym to "matcher:last" or
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.
76
77Example: load and use the matcher extension with defaults.
78
79 URxvt.perl-ext: default,matcher
80
81Example: use a custom configuration.
82
83 URxvt.url-launcher: sensible-browser
84 URxvt.keysym.C-Delete: matcher:last
85 URxvt.keysym.M-Delete: matcher:list
86 URxvt.matcher.button: 1
87 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
88 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
89 URxvt.matcher.launcher.2: gvim +$2 $1
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
121=cut
4 122
5my $url = 123my $url =
6 qr{ 124 qr{
7 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.)[ab-zA-Z0-9\-\@;\/?:&=%\$_.+!*\x27(),~#]+ 125 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.)
126 [\w\-\@;\/?:&=%\$.+!*\x27,~#$urxvt::NOCHAR]*
127 (
128 \([\w\-\@;\/?:&=%\$.+!*\x27,~#$urxvt::NOCHAR]*\)| # Allow a pair of matched parentheses
8 [ab-zA-Z0-9\-\@;\/?:&=%\$_+*()~] # exclude some trailing characters (heuristic) 129 [\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic)
130 )+
9 }x; 131 }x;
10 132
133sub matchlist_key_press {
134 my ($self, $event, $keysym, $octets) = @_;
135
136 delete $self->{overlay};
137 $self->disable ("key_press");
138
139 my $i = ($keysym == 96 ? 0 : $keysym - 48);
140 if ($i >= 0 && $i < @{ $self->{matches} }) {
141 my @exec = @{ $self->{matches}[$i] };
142 $self->exec_async (@exec[5 .. $#exec]);
143 }
144
145 1
146}
147
148# backwards compat
149sub on_user_command {
150 my ($self, $cmd) = @_;
151
152 if ($cmd eq "matcher:list") {
153 $self->matchlist;
154 } elsif ($cmd eq "matcher:last") {
155 $self->most_recent;
156 } elsif ($cmd eq "matcher:select") {
157 $self->select_enter;
158 } elsif ($cmd eq "matcher") {
159 # for backward compatibility
160 $self->most_recent;
161 }
162
163 ()
164}
165
166sub on_action {
167 my ($self, $action) = @_;
168
169 if ($action eq "list") {
170 $self->matchlist;
171 } elsif ($action eq "last") {
172 $self->most_recent;
173 } elsif ($action eq "select") {
174 $self->select_enter;
175 }
176
177 ()
178}
179
180sub matchlist {
181 my ($self) = @_;
182
183 $self->{matches} = [];
184 my $row = $self->nrow - 1;
185 while ($row >= 0 && @{ $self->{matches} } < 10) {
186 my $line = $self->line ($row);
187 my @matches = $self->find_matches ($row);
188
189 for (sort { $b->[0] <=> $a->[0] or $b->[1] <=> $a->[1] } @matches) {
190 push @{ $self->{matches} }, $_;
191 last if @{ $self->{matches} } == 10;
192 }
193
194 $row = $line->beg - 1;
195 }
196
197 return unless @{ $self->{matches} };
198
199 my $width = 0;
200
201 my $i = 0;
202 for my $match (@{ $self->{matches} }) {
203 my $text = $match->[4];
204 my $w = $self->strwidth ("$i-$text");
205
206 $width = $w if $w > $width;
207 $i++;
208 }
209
210 $width = $self->ncol - 2 if $width > $self->ncol - 2;
211
212 $self->{overlay} = $self->overlay (0, 0, $width, scalar (@{ $self->{matches} }), urxvt::OVERLAY_RSTYLE, 2);
213 my $i = 0;
214 for my $match (@{ $self->{matches} }) {
215 my $text = $match->[4];
216
217 $self->{overlay}->set (0, $i, "$i-$text");
218 $i++;
219 }
220
221 $self->enable (key_press => \&matchlist_key_press);
222}
223
224sub most_recent {
225 my ($self) = shift;
226 my $row = $self->nrow - 1;
227 my @exec;
228 while ($row >= $self->top_row) {
229 my $line = $self->line ($row);
230 @exec = $self->command_for($row);
231 last if(@exec);
232
233 $row = $line->beg - 1;
234 }
235 if(@exec) {
236 return $self->exec_async (@exec);
237 }
238 ()
239}
240
11sub my_resource { 241sub my_resource {
12 my $self = shift; 242 $_[0]->x_resource ("%.$_[1]")
13 $self->x_resource("$self->{name}.$_[0]"); 243}
244
245# turn a rendition spec in the resource into a sub that implements it on $_
246sub parse_rend {
247 my ($self, $str) = @_;
248 my ($mask, $fg, $bg, $failed) = $str ? urxvt::rend2mask($str)
249 : (urxvt::RS_Uline, undef, undef, []);
250 warn "Failed to parse rendition string: " . join(',', @$failed) if @$failed;
251 my @rend;
252 push @rend, sub { $_ |= $mask } if $mask;
253 push @rend, sub { $_ = urxvt::SET_FGCOLOR($_, $fg) } if defined $fg;
254 push @rend, sub { $_ = urxvt::SET_BGCOLOR($_, $bg) } if defined $bg;
255 sub {
256 for my $s ( @rend ) { &$s };
257 }
14} 258}
15 259
16sub on_start { 260sub on_start {
17 my ($self) = @_; 261 my ($self) = @_;
18 262
19 ($self->{name} = __PACKAGE__) =~ s/.*:://; 263 $self->{launcher} = $self->my_resource ("launcher") || $self->x_resource("url-launcher") || "sensible-browser";
20 $self->{name} =~ tr/_/-/;
21 $self->{launcher} = $self->my_resource("launcher") ||
22 $self->x_resource("urlLauncher") ||
23 "sensible-browser";
24 264
25 $self->{button} = 2; 265 $self->{button} = 2;
26 $self->{state} = 0; 266 $self->{state} = 0;
27 if($self->{argv}[0] || $self->my_resource("button")) { 267 if($self->{argv}[0] || $self->my_resource ("button")) {
28 my @mods = split('', $self->{argv}[0] || $self->my_resource("button")); 268 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button");
29 for my $mod (@mods) { 269 for my $mod (@mods) {
30 if($mod =~ /^\d+$/) { 270 if($mod =~ /^\d+$/) {
31 $self->{button} = $mod; 271 $self->{button} = $mod;
32 } elsif($mod eq "C") { 272 } elsif($mod eq "C") {
33 $self->{state} |= urxvt::ControlMask; 273 $self->{state} |= urxvt::ControlMask;
34 } elsif($mod eq "S") { 274 } elsif($mod eq "S") {
35 $self->{state} |= urxvt::ShiftMask; 275 $self->{state} |= urxvt::ShiftMask;
36 } elsif($mod eq "M") { 276 } elsif($mod eq "M") {
37 $self->{state} |= $self->ModMetaMask; 277 $self->{state} |= $self->ModMetaMask;
38 } elsif($mod ne "-" && $mod ne " ") { 278 } elsif($mod ne "-" && $mod ne " ") {
39 warn("$mod is invalid in $self->{name}<$self->{argv}[0]>\n"); 279 warn("$mod is invalid in $self->{_name}<$self->{argv}[0]>\n");
40 } 280 }
41 } 281 }
42 } 282 }
43 283
44 my @defaults = ($url); 284 my @defaults = ($url);
45 my @matchers; 285 my @matchers;
46 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++) {
47 $res = $self->locale_decode ($res);
48 utf8::encode $res;
49 my $launcher = $self->my_resource("launcher.$idx"); 287 my $launcher = $self->my_resource ("launcher.$idx");
50 $launcher =~ s/\$&|\$\{&\}/\${0}/g if ($launcher); 288 $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher;
289 my $rend = $self->parse_rend($self->my_resource ("rend.$idx"));
51 push @matchers, [qr($res)x,$launcher]; 290 unshift @matchers, [qr($res)x,$launcher,$rend];
52 } 291 }
53 $self->{matchers} = \@matchers; 292 $self->{matchers} = \@matchers;
54 293
55 () 294 ()
56} 295}
59 my ($self, $row) = @_; 298 my ($self, $row) = @_;
60 299
61 # fetch the line that has changed 300 # fetch the line that has changed
62 my $line = $self->line ($row); 301 my $line = $self->line ($row);
63 my $text = $line->t; 302 my $text = $line->t;
64 my $i = 0; 303 my $rend;
65 304
66 # find all urls (if any) 305 # find all urls (if any)
67 for my $matcher (@{$self->{matchers}}) { 306 for my $matcher (@{$self->{matchers}}) {
68 while ($text =~ /$matcher->[0]/g) { 307 while ($text =~ /$matcher->[0]/g) {
308 #print "$&\n";
69 my $rend = $line->r; 309 $rend ||= $line->r;
70 310
71 # mark all characters as underlined. we _must_ not toggle underline, 311 # mark all characters as underlined. we _must_ not toggle underline,
72 # as we might get called on an already-marked url. 312 # as we might get called on an already-marked url.
73 $_ |= urxvt::RS_Uline 313 &{$matcher->[2]}
74 for @{$rend}[ $-[0] .. $+[0] - 1]; 314 for @{$rend}[$-[0] .. $+[0] - 1];
75
76 $line->r ($rend);
77 } 315 }
78 } 316 }
317
318 $line->r ($rend) if $rend;
79 319
80 () 320 ()
81} 321}
82 322
83sub valid_button { 323sub valid_button {
86 | urxvt::ShiftMask | urxvt::ControlMask; 326 | urxvt::ShiftMask | urxvt::ControlMask;
87 return ($event->{button} == $self->{button} && 327 return ($event->{button} == $self->{button} &&
88 ($event->{state} & $mask) == $self->{state}); 328 ($event->{state} & $mask) == $self->{state});
89} 329}
90 330
91sub command_for { 331sub find_matches {
92 my ($self, $row, $col) = @_; 332 my ($self, $row, $col) = @_;
93 my $line = $self->line ($row); 333 my $line = $self->line ($row);
94 my $text = $line->t; 334 my $text = $line->t;
335 my $off = $line->offset_of ($row, $col) if defined $col;
95 336
337 my @matches;
96 for my $matcher (@{$self->{matchers}}) { 338 for my $matcher (@{$self->{matchers}}) {
97 my $launcher = $matcher->[1] || $self->{launcher}; 339 my $launcher = $matcher->[1] || $self->{launcher};
98 while (($text =~ /$matcher->[0]/g)) { 340 while ($text =~ /$matcher->[0]/g) {
99 my $match = $&; 341 my $match = substr $text, $-[0], $+[0] - $-[0];
100 my @begin = @-; 342 my @begin = @-;
101 my @end = @+; 343 my @end = @+;
344 my @exec;
345
102 if ($-[0] <= $col && $+[0] >= $col) { 346 if (!defined($off) || ($-[0] <= $off && $+[0] >= $off)) {
103 if ($launcher !~ /\$/) { 347 if ($launcher !~ /\$/) {
104 return ($launcher,$match); 348 @exec = ($launcher, $match);
105 } else { 349 } else {
106 # 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...),
107 # but alas, m//g behaves differently in list context. 351 # but alas, m//g behaves differently in list context.
108 my @exec = map { s/\$(\d+)|\$\{(\d+)\}/ 352 @exec = map { s/\$(\d+)|\$\{(\d+)\}/
109 substr($text,$begin[$1||$2],$end[$1||$2]-$begin[$1||$2]) 353 substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2]
110 /egx; $_ } split(/\s+/, $launcher); 354 /egx; $_ } split /\s+/, $launcher;
111 return @exec;
112 } 355 }
356
357 push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ];
113 } 358 }
114 } 359 }
360 }
361
362 @matches;
363}
364
365sub command_for {
366 my ($self, $row, $col) = @_;
367
368 my @matches = $self->find_matches ($row, $col);
369 if (@matches) {
370 my @match = @{ $matches[0] };
371 return @match[5 .. $#match];
115 } 372 }
116 373
117 () 374 ()
118} 375}
119 376
120sub on_button_press { 377sub on_button_press {
121 my ($self, $event) = @_; 378 my ($self, $event) = @_;
122 if($self->valid_button($event)) { 379 if($self->valid_button($event)
380 && (my @exec = $self->command_for($event->{row},$event->{col}))) {
123 $self->{row} = $event->{row}; 381 $self->{row} = $event->{row};
124 $self->{col} = $event->{col}; 382 $self->{col} = $event->{col};
383 $self->{cmd} = \@exec;
384 return 1;
125 } else { 385 } else {
126 delete $self->{row}; 386 delete $self->{row};
127 delete $self->{col}; 387 delete $self->{col};
388 delete $self->{cmd};
128 } 389 }
129 390
130 () 391 ()
131} 392}
132 393
133sub on_button_release { 394sub on_button_release {
134 my ($self, $event) = @_; 395 my ($self, $event) = @_;
135 396
136 my $row = delete $self->{row}; 397 my $row = delete $self->{row};
137 my $col = delete $self->{col}; 398 my $col = delete $self->{col};
399 my $cmd = delete $self->{cmd};
138 400
401 return if !defined $row;
402
139 if(defined($row) && $row == $event->{row} && abs($col-$event->{col}) < 2) { 403 if($row == $event->{row} && abs($col-$event->{col}) < 2
404 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) {
140 if($self->valid_button($event)) { 405 if($self->valid_button($event)) {
141 406
142 my @exec = $self->command_for($row,$col);
143 if(@exec) {
144 return $self->exec_async (@exec); 407 $self->exec_async (@$cmd);
408
145 } 409 }
146
147 }
148 } 410 }
149 411
412 1;
413}
414
415sub select_enter {
416 my ($self) = @_;
417
418 $self->{view_start} = $self->view_start;
419 $self->{pty_ev_events} = $self->pty_ev_events (urxvt::EV_NONE);
420 $self->{cur_row} = $self->nrow - 1;
421
422 $self->enable (
423 key_press => \&select_key_press,
424 refresh_begin => \&select_refresh,
425 refresh_end => \&select_refresh,
150 () 426 );
427
428 $self->{overlay} = $self->overlay (0, -1, $self->ncol, 1, urxvt::OVERLAY_RSTYLE, 0);
429 $self->{overlay}->set (0, 0, "match-select");
430}
431
432sub select_leave {
433 my ($self) = @_;
434
435 $self->disable ("key_press", "refresh_begin", "refresh_end");
436 $self->pty_ev_events ($self->{pty_ev_events});
437
438 delete $self->{overlay};
439 delete $self->{matches};
440 delete $self->{id};
441}
442
443sub select_search {
444 my ($self, $dir, $row) = @_;
445
446 while ($self->nrow > $row && $row >= $self->top_row) {
447 my $line = $self->line ($row)
448 or last;
449
450 my @matches = $self->find_matches ($row);
451 if (@matches) {
452 @matches = sort { $a->[0] <=> $b->[0] or $a->[1] <=> $b->[1] } @matches;
453 $self->{matches} = \@matches;
454 $self->{cur_row} = $row;
455 $self->{id} = $dir < 0 ? @{ $self->{matches} } - 1 : 0;
456 $self->view_start ($row - ($self->nrow >> 1));
457 $self->want_refresh;
458 return 1;
459 }
460
461 $row = $dir < 0 ? $line->beg - 1 : $line->end + 1;
462 }
463
464 $self->scr_bell;
465
466 ()
467}
468
469sub select_refresh {
470 my ($self) = @_;
471
472 return unless $self->{matches};
473
474 my $cur = $self->{matches}[$self->{id}];
475 $self->scr_xor_span (@$cur[0 .. 3], urxvt::RS_RVid);
476
477 ()
478}
479
480sub select_key_press {
481 my ($self, $event, $keysym, $string) = @_;
482
483 if ($keysym == 0xff0d || $keysym == 0xff8d) { # enter
484 if ($self->{matches}) {
485 my @match = @{ $self->{matches}[$self->{id}] };
486 $self->exec_async (@match[5 .. $#match]);
487 }
488 $self->select_leave;
489 } elsif ($keysym == 0x79) { # y
490 if ($self->{matches}) {
491 $self->selection ($self->{matches}[$self->{id}][4], 1);
492 $self->selection_grab (urxvt::CurrentTime, 1);
493 }
494 $self->select_leave;
495 } elsif ($keysym == 0xff1b) { # escape
496 $self->view_start ($self->{view_start});
497 $self->select_leave;
498 } elsif ($keysym == 0xff50) { # home
499 $self->select_search (+1, $self->top_row)
500 } elsif ($keysym == 0xff57) { # end
501 $self->select_search (-1, $self->nrow - 1)
502 } elsif ($keysym == 0xff52) { # up
503 if ($self->{id} > 0) {
504 $self->{id}--;
505 $self->want_refresh;
506 } else {
507 my $line = $self->line ($self->{cur_row});
508 $self->select_search (-1, $line->beg - 1)
509 if $line->beg > $self->top_row;
510 }
511 } elsif ($keysym == 0xff54) { # down
512 if ($self->{id} < @{ $self->{matches} } - 1) {
513 $self->{id}++;
514 $self->want_refresh;
515 } else {
516 my $line = $self->line ($self->{cur_row});
517 $self->select_search (+1, $line->end + 1)
518 if $line->end < $self->nrow;
519 }
520 } elsif ($self->lookup_keysym ($keysym, $event->{state}) eq "matcher:select") {
521 if ($self->{id} > 0) {
522 $self->{id}--;
523 $self->want_refresh;
524 } else {
525 my $line = $self->line ($self->{cur_row});
526 $self->select_search (-1, $self->nrow - 1)
527 unless $self->select_search (-1, $line->beg - 1);
528 }
529 }
530
531 1
151} 532}
152 533
153# vim:set sw=3 sts=3 et: 534# vim:set sw=3 sts=3 et:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines