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.7 by sf-tpope, Tue Aug 30 20:02:32 2011 UTC vs.
Revision 1.34 by sf-exg, Tue Oct 14 09:00:43 2014 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
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 '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 4
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
74Example: load and use the matcher extension with defaults.
75
76 URxvt.perl-ext: default,matcher
77
78Example: use a custom configuration.
79
80 URxvt.url-launcher: sensible-browser
81 URxvt.keysym.C-Delete: matcher:last
82 URxvt.keysym.M-Delete: matcher:list
83 URxvt.matcher.button: 1
84 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
85 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
86 URxvt.matcher.launcher.2: gvim +$2 $1
87
88=cut
5 89
6my $url = 90my $url =
7 qr{ 91 qr{
8 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.) 92 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.)
9 [a-zA-Z0-9\-\@;\/?:&=%\$_.+!*\x27,~#]* 93 [\w\-\@;\/?:&=%\$.+!*\x27,~#]*
10 ( 94 (
11 \([a-zA-Z0-9\-\@;\/?:&=%\$_.+!*\x27,~#]*\)| # Allow a pair of matched parentheses 95 \([\w\-\@;\/?:&=%\$.+!*\x27,~#]*\)| # Allow a pair of matched parentheses
12 [a-zA-Z0-9\-\@;\/?:&=%\$_+*~] # exclude some trailing characters (heuristic) 96 [\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic)
13 )+ 97 )+
14 }x; 98 }x;
15 99
16sub on_key_press { 100sub matchlist_key_press {
17 my ($self, $event, $keysym, $octets) = @_; 101 my ($self, $event, $keysym, $octets) = @_;
18 102
19 if (! $self->{showing} ) { 103 delete $self->{overlay};
20 return; 104 $self->disable ("key_press");
21 }
22 105
23 my $i = ($keysym == 96 ? 0 : $keysym - 48); 106 my $i = ($keysym == 96 ? 0 : $keysym - 48);
24 if (($i > scalar(@{$self->{urls}})) || ($i < 0)) { 107 if ($i >= 0 && $i < @{ $self->{matches} }) {
25 $self->matchlist(); 108 my @exec = @{ $self->{matches}[$i] };
26 return; 109 $self->exec_async (@exec[5 .. $#exec]);
110 }
111
27 } 112 1
28
29 my @args = ($self->{urls}[ -$i-1 ]);
30 $self->matchlist();
31
32 $self->exec_async( $self->{launcher}, @args );
33} 113}
34 114
115# backwards compat
35sub on_user_command { 116sub on_user_command {
36 my ($self, $cmd) = @_; 117 my ($self, $cmd) = @_;
37 118
38 if($cmd =~ s/^matcher:list\b//) { 119 if ($cmd eq "matcher:list") {
39 $self->matchlist(); 120 $self->matchlist;
40 } else { 121 } elsif ($cmd eq "matcher:last") {
41 if($cmd =~ s/^matcher:last\b//) {
42 $self->most_recent; 122 $self->most_recent;
43 } 123 } elsif ($cmd eq "matcher:select") {
124 $self->select_enter;
125 } elsif ($cmd eq "matcher") {
44 # For backward compatibility 126 # for backward compatibility
45 else {
46 if($cmd =~ s/^matcher\b//) {
47 $self->most_recent; 127 $self->most_recent;
48 }
49 }
50 } 128 }
129
130 ()
131}
132
133sub on_action {
134 my ($self, $action) = @_;
135
136 if ($action eq "list") {
137 $self->matchlist;
138 } elsif ($action eq "last") {
139 $self->most_recent;
140 } elsif ($action eq "select") {
141 $self->select_enter;
142 }
143
51 () 144 ()
52} 145}
53 146
54sub matchlist { 147sub matchlist {
55 my ($self) = @_; 148 my ($self) = @_;
56 if ( $self->{showing} ) { 149
57 $self->{url_overlay}->hide(); 150 $self->{matches} = [];
58 $self->{showing} = 0; 151 my $row = $self->nrow - 1;
59 return; 152 while ($row >= 0 && @{ $self->{matches} } < 10) {
60 }
61 @{$self->{urls}} = ();
62 my $line;
63 for (my $i = 0; $i < $self->nrow; $i ++) {
64 $line = $self->line($i); 153 my $line = $self->line ($row);
65 next if ($line->beg != $i); 154 my @matches = $self->find_matches ($row);
66 for my $url ($self->get_urls_from_line($line->t)) { 155
67 if (scalar(@{$self->{urls}}) == 10) { 156 for (sort { $b->[0] <=> $a->[0] or $b->[1] <=> $a->[1] } @matches) {
68 shift @{$self->{urls}};
69 }
70 push @{$self->{urls}}, $url; 157 push @{ $self->{matches} }, $_;
158 last if @{ $self->{matches} } == 10;
71 } 159 }
160
161 $row = $line->beg - 1;
72 } 162 }
73 163
74 if (! scalar(@{$self->{urls}})) { 164 return unless @{ $self->{matches} };
75 return;
76 }
77 165
78 my $max = 0; 166 my $width = 0;
79 my $i = scalar( @{$self->{urls}} ) - 1 ;;
80 167
81 my @temp = ();
82
83 for my $url (@{$self->{urls}}) {
84 my $url = "$i-$url";
85 my $xpos = 0;
86
87 if ($self->ncol + (length $url) >= $self->ncol) {
88 $url = substr( $url, 0, $self->ncol );
89 }
90
91 push @temp, $url;
92
93 if( length $url > $max ) {
94 $max = length $url;
95 }
96
97 $i--;
98 }
99
100 @temp = reverse @temp;
101
102 $self->{url_overlay} = $self->overlay(0, 0, $max, scalar( @temp ), urxvt::OVERLAY_RSTYLE, 2);
103 my $i = 0; 168 my $i = 0;
104 for my $url (@temp) { 169 for my $match (@{ $self->{matches} }) {
105 $self->{url_overlay}->set( 0, $i, $url, [(urxvt::OVERLAY_RSTYLE) x length $url]); 170 my $text = $match->[4];
106 $self->{showing} = 1; 171 my $w = $self->strwidth ("$i-$text");
172
173 $width = $w if $w > $width;
107 $i++; 174 $i++;
108 } 175 }
109 176
177 $width = $self->ncol - 2 if $width > $self->ncol - 2;
178
179 $self->{overlay} = $self->overlay (0, 0, $width, scalar (@{ $self->{matches} }), urxvt::OVERLAY_RSTYLE, 2);
180 my $i = 0;
181 for my $match (@{ $self->{matches} }) {
182 my $text = $match->[4];
183
184 $self->{overlay}->set (0, $i, "$i-$text");
185 $i++;
186 }
187
188 $self->enable (key_press => \&matchlist_key_press);
110} 189}
111 190
112sub most_recent { 191sub most_recent {
113 my ($self) = shift; 192 my ($self) = shift;
114 my $row = $self->nrow; 193 my $row = $self->nrow - 1;
115 my @exec; 194 my @exec;
116 while($row-- > $self->top_row) { 195 while ($row >= $self->top_row) {
196 my $line = $self->line ($row);
117 @exec = $self->command_for($row); 197 @exec = $self->command_for($row);
118 last if(@exec); 198 last if(@exec);
199
200 $row = $line->beg - 1;
119 } 201 }
120 if(@exec) { 202 if(@exec) {
121 return $self->exec_async (@exec); 203 return $self->exec_async (@exec);
122 } 204 }
123 () 205 ()
124} 206}
125 207
126sub my_resource { 208sub my_resource {
127 my $self = shift; 209 $_[0]->x_resource ("%.$_[1]")
128 $self->x_resource ("$self->{name}.$_[0]");
129} 210}
130 211
131# turn a rendition spec in the resource into a sub that implements it on $_ 212# turn a rendition spec in the resource into a sub that implements it on $_
132sub parse_rend { 213sub parse_rend {
133 my ($self, $str) = @_; 214 my ($self, $str) = @_;
… …
144} 225}
145 226
146sub on_start { 227sub on_start {
147 my ($self) = @_; 228 my ($self) = @_;
148 229
149 ($self->{name} = __PACKAGE__) =~ s/.*:://; 230 $self->{launcher} = $self->my_resource ("launcher") || $self->x_resource("url-launcher") || "sensible-browser";
150 $self->{name} =~ tr/_/-/;
151 $self->{launcher} = $self->my_resource("launcher") ||
152 $self->x_resource("urlLauncher") ||
153 "sensible-browser";
154 231
155 $self->{urls} = [];
156 $self->{showing} = 0;
157 $self->{button} = 2; 232 $self->{button} = 2;
158 $self->{state} = 0; 233 $self->{state} = 0;
159 if($self->{argv}[0] || $self->my_resource("button")) { 234 if($self->{argv}[0] || $self->my_resource ("button")) {
160 my @mods = split('', $self->{argv}[0] || $self->my_resource("button")); 235 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button");
161 for my $mod (@mods) { 236 for my $mod (@mods) {
162 if($mod =~ /^\d+$/) { 237 if($mod =~ /^\d+$/) {
163 $self->{button} = $mod; 238 $self->{button} = $mod;
164 } elsif($mod eq "C") { 239 } elsif($mod eq "C") {
165 $self->{state} |= urxvt::ControlMask; 240 $self->{state} |= urxvt::ControlMask;
166 } elsif($mod eq "S") { 241 } elsif($mod eq "S") {
167 $self->{state} |= urxvt::ShiftMask; 242 $self->{state} |= urxvt::ShiftMask;
168 } elsif($mod eq "M") { 243 } elsif($mod eq "M") {
169 $self->{state} |= $self->ModMetaMask; 244 $self->{state} |= $self->ModMetaMask;
170 } elsif($mod ne "-" && $mod ne " ") { 245 } elsif($mod ne "-" && $mod ne " ") {
171 warn("$mod is invalid in $self->{name}<$self->{argv}[0]>\n"); 246 warn("$mod is invalid in $self->{_name}<$self->{argv}[0]>\n");
172 } 247 }
173 } 248 }
174 } 249 }
175 250
176 my @defaults = ($url); 251 my @defaults = ($url);
177 my @matchers; 252 my @matchers;
178 for (my $idx = 0; defined (my $res = $self->my_resource("pattern.$idx") || $defaults[$idx]); $idx++) { 253 for (my $idx = 0; defined (my $res = $self->my_resource ("pattern.$idx") || $defaults[$idx]); $idx++) {
179 $res = $self->locale_decode ($res); 254 $res = $self->locale_decode ($res);
180 utf8::encode $res; 255 utf8::encode $res;
181 my $launcher = $self->my_resource("launcher.$idx"); 256 my $launcher = $self->my_resource ("launcher.$idx");
182 $launcher =~ s/\$&|\$\{&\}/\${0}/g if ($launcher); 257 $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher;
183 my $rend = $self->parse_rend($self->my_resource("rend.$idx")); 258 my $rend = $self->parse_rend($self->my_resource ("rend.$idx"));
184 unshift @matchers, [qr($res)x,$launcher,$rend]; 259 unshift @matchers, [qr($res)x,$launcher,$rend];
185 } 260 }
186 $self->{matchers} = \@matchers; 261 $self->{matchers} = \@matchers;
187 262
188 () 263 ()
189}
190
191sub get_urls_from_line {
192 my ($self, $line) = @_;
193 my @urls;
194 for my $matcher (@{$self->{matchers}}) {
195 while ($line =~ /$matcher->[0]/g) {
196 push @urls, substr( $line, $-[0], $+[0] - $-[0] );
197 }
198 }
199 return @urls;
200} 264}
201 265
202sub on_line_update { 266sub on_line_update {
203 my ($self, $row) = @_; 267 my ($self, $row) = @_;
204 268
205 # fetch the line that has changed 269 # fetch the line that has changed
206 my $line = $self->line ($row); 270 my $line = $self->line ($row);
207 my $text = $line->t; 271 my $text = $line->t;
208 my $i = 0; 272 my $rend;
209 273
210 # find all urls (if any) 274 # find all urls (if any)
211 for my $matcher (@{$self->{matchers}}) { 275 for my $matcher (@{$self->{matchers}}) {
212 while ($text =~ /$matcher->[0]/g) { 276 while ($text =~ /$matcher->[0]/g) {
213 #print "$&\n"; 277 #print "$&\n";
214 my $rend = $line->r; 278 $rend ||= $line->r;
215 279
216 # mark all characters as underlined. we _must_ not toggle underline, 280 # mark all characters as underlined. we _must_ not toggle underline,
217 # as we might get called on an already-marked url. 281 # as we might get called on an already-marked url.
218 &{$matcher->[2]} 282 &{$matcher->[2]}
219 for @{$rend}[ $-[0] .. $+[0] - 1]; 283 for @{$rend}[$-[0] .. $+[0] - 1];
220
221 $line->r ($rend);
222 } 284 }
223 } 285 }
286
287 $line->r ($rend) if $rend;
224 288
225 () 289 ()
226} 290}
227 291
228sub valid_button { 292sub valid_button {
… …
231 | urxvt::ShiftMask | urxvt::ControlMask; 295 | urxvt::ShiftMask | urxvt::ControlMask;
232 return ($event->{button} == $self->{button} && 296 return ($event->{button} == $self->{button} &&
233 ($event->{state} & $mask) == $self->{state}); 297 ($event->{state} & $mask) == $self->{state});
234} 298}
235 299
236sub command_for { 300sub find_matches {
237 my ($self, $row, $col) = @_; 301 my ($self, $row, $col) = @_;
238 my $line = $self->line ($row); 302 my $line = $self->line ($row);
239 my $text = $line->t; 303 my $text = $line->t;
304 my $off = $line->offset_of ($row, $col) if defined $col;
240 305
306 my @matches;
241 for my $matcher (@{$self->{matchers}}) { 307 for my $matcher (@{$self->{matchers}}) {
242 my $launcher = $matcher->[1] || $self->{launcher}; 308 my $launcher = $matcher->[1] || $self->{launcher};
243 while (($text =~ /$matcher->[0]/g)) { 309 while ($text =~ /$matcher->[0]/g) {
244 my $match = $&; 310 my $match = substr $text, $-[0], $+[0] - $-[0];
245 my @begin = @-; 311 my @begin = @-;
246 my @end = @+; 312 my @end = @+;
313 my @exec;
314
247 if (!defined($col) || ($-[0] <= $col && $+[0] >= $col)) { 315 if (!defined($off) || ($-[0] <= $off && $+[0] >= $off)) {
248 if ($launcher !~ /\$/) { 316 if ($launcher !~ /\$/) {
249 return ($launcher,$match); 317 @exec = ($launcher, $match);
250 } else { 318 } else {
251 # It'd be nice to just access a list like ($&,$1,$2...), 319 # It'd be nice to just access a list like ($&,$1,$2...),
252 # but alas, m//g behaves differently in list context. 320 # but alas, m//g behaves differently in list context.
253 my @exec = map { s/\$(\d+)|\$\{(\d+)\}/ 321 @exec = map { s/\$(\d+)|\$\{(\d+)\}/
254 substr($text,$begin[$1||$2],$end[$1||$2]-$begin[$1||$2]) 322 substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2]
255 /egx; $_ } split(/\s+/, $launcher); 323 /egx; $_ } split /\s+/, $launcher;
256 return @exec;
257 } 324 }
325
326 push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ];
258 } 327 }
259 } 328 }
329 }
330
331 @matches;
332}
333
334sub command_for {
335 my ($self, $row, $col) = @_;
336
337 my @matches = $self->find_matches ($row, $col);
338 if (@matches) {
339 my @match = @{ $matches[0] };
340 return @match[5 .. $#match];
260 } 341 }
261 342
262 () 343 ()
263} 344}
264 345
… …
290 371
291 if($row == $event->{row} && abs($col-$event->{col}) < 2 372 if($row == $event->{row} && abs($col-$event->{col}) < 2
292 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) { 373 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) {
293 if($self->valid_button($event)) { 374 if($self->valid_button($event)) {
294 375
295 $self->exec_async (@$cmd); 376 $self->exec_async (@$cmd);
296 377
297 } 378 }
298 } 379 }
299 380
300 1; 381 1;
301} 382}
302 383
384sub select_enter {
385 my ($self) = @_;
386
387 $self->{view_start} = $self->view_start;
388 $self->{pty_ev_events} = $self->pty_ev_events (urxvt::EV_NONE);
389 $self->{cur_row} = $self->nrow - 1;
390
391 $self->enable (
392 key_press => \&select_key_press,
393 refresh_begin => \&select_refresh,
394 refresh_end => \&select_refresh,
395 );
396
397 $self->{overlay} = $self->overlay (0, -1, $self->ncol, 1, urxvt::OVERLAY_RSTYLE, 0);
398 $self->{overlay}->set (0, 0, "match-select");
399}
400
401sub select_leave {
402 my ($self) = @_;
403
404 $self->disable ("key_press", "refresh_begin", "refresh_end");
405 $self->pty_ev_events ($self->{pty_ev_events});
406
407 delete $self->{overlay};
408 delete $self->{matches};
409 delete $self->{id};
410}
411
412sub select_search {
413 my ($self, $dir, $row) = @_;
414
415 while ($self->nrow > $row && $row >= $self->top_row) {
416 my $line = $self->line ($row)
417 or last;
418
419 my @matches = $self->find_matches ($row);
420 if (@matches) {
421 @matches = sort { $a->[0] <=> $b->[0] or $a->[1] <=> $b->[1] } @matches;
422 $self->{matches} = \@matches;
423 $self->{cur_row} = $row;
424 $self->{id} = $dir < 0 ? @{ $self->{matches} } - 1 : 0;
425 $self->view_start (List::Util::min 0, $row - ($self->nrow >> 1));
426 $self->want_refresh;
427 return;
428 }
429
430 $row = $dir < 0 ? $line->beg - 1 : $line->end + 1;
431 }
432
433 $self->scr_bell;
434}
435
436sub select_refresh {
437 my ($self) = @_;
438
439 return unless $self->{matches};
440
441 my $cur = $self->{matches}[$self->{id}];
442 $self->scr_xor_span (@$cur[0 .. 3], urxvt::RS_RVid);
443
444 ()
445}
446
447sub select_key_press {
448 my ($self, $event, $keysym, $string) = @_;
449
450 if ($keysym == 0xff0d || $keysym == 0xff8d) { # enter
451 if ($self->{matches}) {
452 my @match = @{ $self->{matches}[$self->{id}] };
453 $self->exec_async (@match[5 .. $#match]);
454 }
455 $self->select_leave;
456 } elsif ($keysym == 0x79) { # y
457 if ($self->{matches}) {
458 $self->selection ($self->{matches}[$self->{id}][4], 1);
459 $self->selection_grab (urxvt::CurrentTime, 1);
460 }
461 $self->select_leave;
462 } elsif ($keysym == 0xff1b) { # escape
463 $self->view_start ($self->{view_start});
464 $self->select_leave;
465 } elsif ($keysym == 0xff50) { # home
466 $self->select_search (+1, $self->top_row)
467 } elsif ($keysym == 0xff57) { # end
468 $self->select_search (-1, $self->nrow - 1)
469 } elsif ($keysym == 0xff52) { # up
470 if ($self->{id} > 0) {
471 $self->{id}--;
472 $self->want_refresh;
473 } else {
474 my $line = $self->line ($self->{cur_row});
475 $self->select_search (-1, $line->beg - 1)
476 if $line->beg > $self->top_row;
477 }
478 } elsif ($keysym == 0xff54) { # down
479 if ($self->{id} < @{ $self->{matches} } - 1) {
480 $self->{id}++;
481 $self->want_refresh;
482 } else {
483 my $line = $self->line ($self->{cur_row});
484 $self->select_search (+1, $line->end + 1)
485 if $line->end < $self->nrow;
486 }
487 }
488
489 1
490}
491
303# vim:set sw=3 sts=3 et: 492# vim:set sw=3 sts=3 et:

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines