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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines