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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines