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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines