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.9 by root, Sun Jun 10 13:58:05 2012 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
5 6
6#:META:X_RESOURCE:%.launcher:string:default launcher command 7#:META:RESOURCE:%.launcher:string:default launcher command
7#:META:X_RESOURCE:%.button:string:the button, yeah 8#:META:RESOURCE:%.button:string:the mouse button used to activate a match
8#:META:X_RESOURCE:%.pattern.:string:extra pattern to match 9#:META:RESOURCE:%.pattern.:string:extra pattern to match
9#:META:X_RESOURCE:%.launcher.:string:custom launcher for pattern 10#:META:RESOURCE:%.launcher.:string:custom launcher for pattern
10#:META:X_RESOURCE:%.rend.:string:custom rednition 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
11 89
12my $url = 90my $url =
13 qr{ 91 qr{
14 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.) 92 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.)
15 [a-zA-Z0-9\-\@;\/?:&=%\$_.+!*\x27,~#]* 93 [\w\-\@;\/?:&=%\$.+!*\x27,~#]*
16 ( 94 (
17 \([a-zA-Z0-9\-\@;\/?:&=%\$_.+!*\x27,~#]*\)| # Allow a pair of matched parentheses 95 \([\w\-\@;\/?:&=%\$.+!*\x27,~#]*\)| # Allow a pair of matched parentheses
18 [a-zA-Z0-9\-\@;\/?:&=%\$_+*~] # exclude some trailing characters (heuristic) 96 [\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic)
19 )+ 97 )+
20 }x; 98 }x;
21 99
22sub on_key_press { 100sub matchlist_key_press {
23 my ($self, $event, $keysym, $octets) = @_; 101 my ($self, $event, $keysym, $octets) = @_;
24 102
25 if (! $self->{showing} ) { 103 delete $self->{overlay};
26 return; 104 $self->disable ("key_press");
27 }
28 105
29 my $i = ($keysym == 96 ? 0 : $keysym - 48); 106 my $i = ($keysym == 96 ? 0 : $keysym - 48);
30 if (($i > scalar(@{$self->{urls}})) || ($i < 0)) { 107 if ($i >= 0 && $i < @{ $self->{matches} }) {
31 $self->matchlist(); 108 my @exec = @{ $self->{matches}[$i] };
32 return; 109 $self->exec_async (@exec[5 .. $#exec]);
110 }
111
33 } 112 1
34
35 my @args = ($self->{urls}[ -$i-1 ]);
36 $self->matchlist();
37
38 $self->exec_async( $self->{launcher}, @args );
39} 113}
40 114
115# backwards compat
41sub on_user_command { 116sub on_user_command {
42 my ($self, $cmd) = @_; 117 my ($self, $cmd) = @_;
43 118
44 if($cmd =~ s/^matcher:list\b//) { 119 if ($cmd eq "matcher:list") {
45 $self->matchlist(); 120 $self->matchlist;
46 } else { 121 } elsif ($cmd eq "matcher:last") {
47 if($cmd =~ s/^matcher:last\b//) {
48 $self->most_recent; 122 $self->most_recent;
49 } 123 } elsif ($cmd eq "matcher:select") {
124 $self->select_enter;
125 } elsif ($cmd eq "matcher") {
50 # For backward compatibility 126 # for backward compatibility
51 else {
52 if($cmd =~ s/^matcher\b//) {
53 $self->most_recent; 127 $self->most_recent;
54 }
55 }
56 } 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
57 () 144 ()
58} 145}
59 146
60sub matchlist { 147sub matchlist {
61 my ($self) = @_; 148 my ($self) = @_;
62 if ( $self->{showing} ) { 149
63 $self->{url_overlay}->hide(); 150 $self->{matches} = [];
64 $self->{showing} = 0; 151 my $row = $self->nrow - 1;
65 return; 152 while ($row >= 0 && @{ $self->{matches} } < 10) {
66 }
67 @{$self->{urls}} = ();
68 my $line;
69 for (my $i = 0; $i < $self->nrow; $i ++) {
70 $line = $self->line($i); 153 my $line = $self->line ($row);
71 next if ($line->beg != $i); 154 my @matches = $self->find_matches ($row);
72 for my $url ($self->get_urls_from_line($line->t)) { 155
73 if (scalar(@{$self->{urls}}) == 10) { 156 for (sort { $b->[0] <=> $a->[0] or $b->[1] <=> $a->[1] } @matches) {
74 shift @{$self->{urls}};
75 }
76 push @{$self->{urls}}, $url; 157 push @{ $self->{matches} }, $_;
158 last if @{ $self->{matches} } == 10;
77 } 159 }
160
161 $row = $line->beg - 1;
78 } 162 }
79 163
80 if (! scalar(@{$self->{urls}})) { 164 return unless @{ $self->{matches} };
81 return;
82 }
83 165
84 my $max = 0; 166 my $width = 0;
85 my $i = scalar( @{$self->{urls}} ) - 1 ;;
86 167
87 my @temp = ();
88
89 for my $url (@{$self->{urls}}) {
90 my $url = "$i-$url";
91 my $xpos = 0;
92
93 if ($self->ncol + (length $url) >= $self->ncol) {
94 $url = substr( $url, 0, $self->ncol );
95 }
96
97 push @temp, $url;
98
99 if( length $url > $max ) {
100 $max = length $url;
101 }
102
103 $i--;
104 }
105
106 @temp = reverse @temp;
107
108 $self->{url_overlay} = $self->overlay(0, 0, $max, scalar( @temp ), urxvt::OVERLAY_RSTYLE, 2);
109 my $i = 0; 168 my $i = 0;
110 for my $url (@temp) { 169 for my $match (@{ $self->{matches} }) {
111 $self->{url_overlay}->set( 0, $i, $url, [(urxvt::OVERLAY_RSTYLE) x length $url]); 170 my $text = $match->[4];
112 $self->{showing} = 1; 171 my $w = $self->strwidth ("$i-$text");
172
173 $width = $w if $w > $width;
113 $i++; 174 $i++;
114 } 175 }
115 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);
116} 189}
117 190
118sub most_recent { 191sub most_recent {
119 my ($self) = shift; 192 my ($self) = shift;
120 my $row = $self->nrow; 193 my $row = $self->nrow - 1;
121 my @exec; 194 my @exec;
122 while($row-- > $self->top_row) { 195 while ($row >= $self->top_row) {
196 my $line = $self->line ($row);
123 @exec = $self->command_for($row); 197 @exec = $self->command_for($row);
124 last if(@exec); 198 last if(@exec);
199
200 $row = $line->beg - 1;
125 } 201 }
126 if(@exec) { 202 if(@exec) {
127 return $self->exec_async (@exec); 203 return $self->exec_async (@exec);
128 } 204 }
129 () 205 ()
151sub on_start { 227sub on_start {
152 my ($self) = @_; 228 my ($self) = @_;
153 229
154 $self->{launcher} = $self->my_resource ("launcher") || $self->x_resource("url-launcher") || "sensible-browser"; 230 $self->{launcher} = $self->my_resource ("launcher") || $self->x_resource("url-launcher") || "sensible-browser";
155 231
156 $self->{urls} = [];
157 $self->{showing} = 0;
158 $self->{button} = 2; 232 $self->{button} = 2;
159 $self->{state} = 0; 233 $self->{state} = 0;
160 if($self->{argv}[0] || $self->my_resource ("button")) { 234 if($self->{argv}[0] || $self->my_resource ("button")) {
161 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button"); 235 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button");
162 for my $mod (@mods) { 236 for my $mod (@mods) {
187 $self->{matchers} = \@matchers; 261 $self->{matchers} = \@matchers;
188 262
189 () 263 ()
190} 264}
191 265
192sub get_urls_from_line {
193 my ($self, $line) = @_;
194 my @urls;
195 for my $matcher (@{$self->{matchers}}) {
196 while ($line =~ /$matcher->[0]/g) {
197 push @urls, substr( $line, $-[0], $+[0] - $-[0] );
198 }
199 }
200 return @urls;
201}
202
203sub on_line_update { 266sub on_line_update {
204 my ($self, $row) = @_; 267 my ($self, $row) = @_;
205 268
206 # fetch the line that has changed 269 # fetch the line that has changed
207 my $line = $self->line ($row); 270 my $line = $self->line ($row);
208 my $text = $line->t; 271 my $text = $line->t;
209 my $i = 0; 272 my $rend;
210 273
211 # find all urls (if any) 274 # find all urls (if any)
212 for my $matcher (@{$self->{matchers}}) { 275 for my $matcher (@{$self->{matchers}}) {
213 while ($text =~ /$matcher->[0]/g) { 276 while ($text =~ /$matcher->[0]/g) {
214 #print "$&\n"; 277 #print "$&\n";
215 my $rend = $line->r; 278 $rend ||= $line->r;
216 279
217 # mark all characters as underlined. we _must_ not toggle underline, 280 # mark all characters as underlined. we _must_ not toggle underline,
218 # as we might get called on an already-marked url. 281 # as we might get called on an already-marked url.
219 &{$matcher->[2]} 282 &{$matcher->[2]}
220 for @{$rend}[ $-[0] .. $+[0] - 1]; 283 for @{$rend}[$-[0] .. $+[0] - 1];
221
222 $line->r ($rend);
223 } 284 }
224 } 285 }
286
287 $line->r ($rend) if $rend;
225 288
226 () 289 ()
227} 290}
228 291
229sub valid_button { 292sub valid_button {
232 | urxvt::ShiftMask | urxvt::ControlMask; 295 | urxvt::ShiftMask | urxvt::ControlMask;
233 return ($event->{button} == $self->{button} && 296 return ($event->{button} == $self->{button} &&
234 ($event->{state} & $mask) == $self->{state}); 297 ($event->{state} & $mask) == $self->{state});
235} 298}
236 299
237sub command_for { 300sub find_matches {
238 my ($self, $row, $col) = @_; 301 my ($self, $row, $col) = @_;
239 my $line = $self->line ($row); 302 my $line = $self->line ($row);
240 my $text = $line->t; 303 my $text = $line->t;
304 my $off = $line->offset_of ($row, $col) if defined $col;
241 305
306 my @matches;
242 for my $matcher (@{$self->{matchers}}) { 307 for my $matcher (@{$self->{matchers}}) {
243 my $launcher = $matcher->[1] || $self->{launcher}; 308 my $launcher = $matcher->[1] || $self->{launcher};
244 while (($text =~ /$matcher->[0]/g)) { 309 while ($text =~ /$matcher->[0]/g) {
245 my $match = $&; 310 my $match = substr $text, $-[0], $+[0] - $-[0];
246 my @begin = @-; 311 my @begin = @-;
247 my @end = @+; 312 my @end = @+;
313 my @exec;
314
248 if (!defined($col) || ($-[0] <= $col && $+[0] >= $col)) { 315 if (!defined($off) || ($-[0] <= $off && $+[0] >= $off)) {
249 if ($launcher !~ /\$/) { 316 if ($launcher !~ /\$/) {
250 return ($launcher,$match); 317 @exec = ($launcher, $match);
251 } else { 318 } else {
252 # 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...),
253 # but alas, m//g behaves differently in list context. 320 # but alas, m//g behaves differently in list context.
254 my @exec = map { s/\$(\d+)|\$\{(\d+)\}/ 321 @exec = map { s/\$(\d+)|\$\{(\d+)\}/
255 substr($text,$begin[$1||$2],$end[$1||$2]-$begin[$1||$2]) 322 substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2]
256 /egx; $_ } split(/\s+/, $launcher); 323 /egx; $_ } split /\s+/, $launcher;
257 return @exec;
258 } 324 }
325
326 push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ];
259 } 327 }
260 } 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];
261 } 341 }
262 342
263 () 343 ()
264} 344}
265 345
291 371
292 if($row == $event->{row} && abs($col-$event->{col}) < 2 372 if($row == $event->{row} && abs($col-$event->{col}) < 2
293 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) { 373 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) {
294 if($self->valid_button($event)) { 374 if($self->valid_button($event)) {
295 375
296 $self->exec_async (@$cmd); 376 $self->exec_async (@$cmd);
297 377
298 } 378 }
299 } 379 }
300 380
301 1; 381 1;
302} 382}
303 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
304# 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