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.1 by root, Sat Nov 11 20:06:34 2006 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.info> 3# Author: Tim Pope <rxvt-unicodeNOSPAM@tpope.org>
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
4 89
5my $url = 90my $url =
6 qr{ 91 qr{
7 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.)[ab-zA-Z0-9\-\@;\/?:&=%\$_.+!*\x27(),~#]+ 92 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.)
93 [\w\-\@;\/?:&=%\$.+!*\x27,~#]*
94 (
95 \([\w\-\@;\/?:&=%\$.+!*\x27,~#]*\)| # Allow a pair of matched parentheses
8 [ab-zA-Z0-9\-\@;\/?:&=%\$_+*()~] # exclude some trailing characters (heuristic) 96 [\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic)
97 )+
9 }x; 98 }x;
10 99
100sub matchlist_key_press {
101 my ($self, $event, $keysym, $octets) = @_;
102
103 delete $self->{overlay};
104 $self->disable ("key_press");
105
106 my $i = ($keysym == 96 ? 0 : $keysym - 48);
107 if ($i >= 0 && $i < @{ $self->{matches} }) {
108 my @exec = @{ $self->{matches}[$i] };
109 $self->exec_async (@exec[5 .. $#exec]);
110 }
111
112 1
113}
114
115# backwards compat
116sub on_user_command {
117 my ($self, $cmd) = @_;
118
119 if ($cmd eq "matcher:list") {
120 $self->matchlist;
121 } elsif ($cmd eq "matcher:last") {
122 $self->most_recent;
123 } elsif ($cmd eq "matcher:select") {
124 $self->select_enter;
125 } elsif ($cmd eq "matcher") {
126 # for backward compatibility
127 $self->most_recent;
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
144 ()
145}
146
147sub matchlist {
148 my ($self) = @_;
149
150 $self->{matches} = [];
151 my $row = $self->nrow - 1;
152 while ($row >= 0 && @{ $self->{matches} } < 10) {
153 my $line = $self->line ($row);
154 my @matches = $self->find_matches ($row);
155
156 for (sort { $b->[0] <=> $a->[0] or $b->[1] <=> $a->[1] } @matches) {
157 push @{ $self->{matches} }, $_;
158 last if @{ $self->{matches} } == 10;
159 }
160
161 $row = $line->beg - 1;
162 }
163
164 return unless @{ $self->{matches} };
165
166 my $width = 0;
167
168 my $i = 0;
169 for my $match (@{ $self->{matches} }) {
170 my $text = $match->[4];
171 my $w = $self->strwidth ("$i-$text");
172
173 $width = $w if $w > $width;
174 $i++;
175 }
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);
189}
190
191sub most_recent {
192 my ($self) = shift;
193 my $row = $self->nrow - 1;
194 my @exec;
195 while ($row >= $self->top_row) {
196 my $line = $self->line ($row);
197 @exec = $self->command_for($row);
198 last if(@exec);
199
200 $row = $line->beg - 1;
201 }
202 if(@exec) {
203 return $self->exec_async (@exec);
204 }
205 ()
206}
207
11sub my_resource { 208sub my_resource {
12 my $self = shift; 209 $_[0]->x_resource ("%.$_[1]")
13 $self->x_resource("$self->{name}.$_[0]"); 210}
211
212# turn a rendition spec in the resource into a sub that implements it on $_
213sub parse_rend {
214 my ($self, $str) = @_;
215 my ($mask, $fg, $bg, $failed) = $str ? urxvt::rend2mask($str)
216 : (urxvt::RS_Uline, undef, undef, []);
217 warn "Failed to parse rendition string: " . join(',', @$failed) if @$failed;
218 my @rend;
219 push @rend, sub { $_ |= $mask } if $mask;
220 push @rend, sub { $_ = urxvt::SET_FGCOLOR($_, $fg) } if defined $fg;
221 push @rend, sub { $_ = urxvt::SET_BGCOLOR($_, $bg) } if defined $bg;
222 sub {
223 for my $s ( @rend ) { &$s };
224 }
14} 225}
15 226
16sub on_start { 227sub on_start {
17 my ($self) = @_; 228 my ($self) = @_;
18 229
19 ($self->{name} = __PACKAGE__) =~ s/.*:://; 230 $self->{launcher} = $self->my_resource ("launcher") || $self->x_resource("url-launcher") || "sensible-browser";
20 $self->{name} =~ tr/_/-/;
21 $self->{launcher} = $self->my_resource("launcher") ||
22 $self->x_resource("urlLauncher") ||
23 "sensible-browser";
24 231
25 $self->{button} = 2; 232 $self->{button} = 2;
26 $self->{state} = 0; 233 $self->{state} = 0;
27 if($self->{argv}[0] || $self->my_resource("button")) { 234 if($self->{argv}[0] || $self->my_resource ("button")) {
28 my @mods = split('', $self->{argv}[0] || $self->my_resource("button")); 235 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button");
29 for my $mod (@mods) { 236 for my $mod (@mods) {
30 if($mod =~ /^\d+$/) { 237 if($mod =~ /^\d+$/) {
31 $self->{button} = $mod; 238 $self->{button} = $mod;
32 } elsif($mod eq "C") { 239 } elsif($mod eq "C") {
33 $self->{state} |= urxvt::ControlMask; 240 $self->{state} |= urxvt::ControlMask;
34 } elsif($mod eq "S") { 241 } elsif($mod eq "S") {
35 $self->{state} |= urxvt::ShiftMask; 242 $self->{state} |= urxvt::ShiftMask;
36 } elsif($mod eq "M") { 243 } elsif($mod eq "M") {
37 $self->{state} |= $self->ModMetaMask; 244 $self->{state} |= $self->ModMetaMask;
38 } elsif($mod ne "-" && $mod ne " ") { 245 } elsif($mod ne "-" && $mod ne " ") {
39 warn("$mod is invalid in $self->{name}<$self->{argv}[0]>\n"); 246 warn("$mod is invalid in $self->{_name}<$self->{argv}[0]>\n");
40 } 247 }
41 } 248 }
42 } 249 }
43 250
44 my @defaults = ($url); 251 my @defaults = ($url);
45 my @matchers; 252 my @matchers;
46 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++) {
47 $res = $self->locale_decode ($res); 254 $res = $self->locale_decode ($res);
48 utf8::encode $res; 255 utf8::encode $res;
49 my $launcher = $self->my_resource("launcher.$idx"); 256 my $launcher = $self->my_resource ("launcher.$idx");
50 $launcher =~ s/\$&|\$\{&\}/\${0}/g if ($launcher); 257 $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher;
258 my $rend = $self->parse_rend($self->my_resource ("rend.$idx"));
51 push @matchers, [qr($res)x,$launcher]; 259 unshift @matchers, [qr($res)x,$launcher,$rend];
52 } 260 }
53 $self->{matchers} = \@matchers; 261 $self->{matchers} = \@matchers;
54 262
55 () 263 ()
56} 264}
… …
59 my ($self, $row) = @_; 267 my ($self, $row) = @_;
60 268
61 # fetch the line that has changed 269 # fetch the line that has changed
62 my $line = $self->line ($row); 270 my $line = $self->line ($row);
63 my $text = $line->t; 271 my $text = $line->t;
64 my $i = 0; 272 my $rend;
65 273
66 # find all urls (if any) 274 # find all urls (if any)
67 for my $matcher (@{$self->{matchers}}) { 275 for my $matcher (@{$self->{matchers}}) {
68 while ($text =~ /$matcher->[0]/g) { 276 while ($text =~ /$matcher->[0]/g) {
277 #print "$&\n";
69 my $rend = $line->r; 278 $rend ||= $line->r;
70 279
71 # mark all characters as underlined. we _must_ not toggle underline, 280 # mark all characters as underlined. we _must_ not toggle underline,
72 # as we might get called on an already-marked url. 281 # as we might get called on an already-marked url.
73 $_ |= urxvt::RS_Uline 282 &{$matcher->[2]}
74 for @{$rend}[ $-[0] .. $+[0] - 1]; 283 for @{$rend}[$-[0] .. $+[0] - 1];
75
76 $line->r ($rend);
77 } 284 }
78 } 285 }
286
287 $line->r ($rend) if $rend;
79 288
80 () 289 ()
81} 290}
82 291
83sub valid_button { 292sub valid_button {
… …
86 | urxvt::ShiftMask | urxvt::ControlMask; 295 | urxvt::ShiftMask | urxvt::ControlMask;
87 return ($event->{button} == $self->{button} && 296 return ($event->{button} == $self->{button} &&
88 ($event->{state} & $mask) == $self->{state}); 297 ($event->{state} & $mask) == $self->{state});
89} 298}
90 299
91sub command_for { 300sub find_matches {
92 my ($self, $row, $col) = @_; 301 my ($self, $row, $col) = @_;
93 my $line = $self->line ($row); 302 my $line = $self->line ($row);
94 my $text = $line->t; 303 my $text = $line->t;
304 my $off = $line->offset_of ($row, $col) if defined $col;
95 305
306 my @matches;
96 for my $matcher (@{$self->{matchers}}) { 307 for my $matcher (@{$self->{matchers}}) {
97 my $launcher = $matcher->[1] || $self->{launcher}; 308 my $launcher = $matcher->[1] || $self->{launcher};
98 while (($text =~ /$matcher->[0]/g)) { 309 while ($text =~ /$matcher->[0]/g) {
99 my $match = $&; 310 my $match = substr $text, $-[0], $+[0] - $-[0];
100 my @begin = @-; 311 my @begin = @-;
101 my @end = @+; 312 my @end = @+;
313 my @exec;
314
102 if ($-[0] <= $col && $+[0] >= $col) { 315 if (!defined($off) || ($-[0] <= $off && $+[0] >= $off)) {
103 if ($launcher !~ /\$/) { 316 if ($launcher !~ /\$/) {
104 return ($launcher,$match); 317 @exec = ($launcher, $match);
105 } else { 318 } else {
106 # 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...),
107 # but alas, m//g behaves differently in list context. 320 # but alas, m//g behaves differently in list context.
108 my @exec = map { s/\$(\d+)|\$\{(\d+)\}/ 321 @exec = map { s/\$(\d+)|\$\{(\d+)\}/
109 substr($text,$begin[$1||$2],$end[$1||$2]-$begin[$1||$2]) 322 substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2]
110 /egx; $_ } split(/\s+/, $launcher); 323 /egx; $_ } split /\s+/, $launcher;
111 return @exec;
112 } 324 }
325
326 push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ];
113 } 327 }
114 } 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];
115 } 341 }
116 342
117 () 343 ()
118} 344}
119 345
120sub on_button_press { 346sub on_button_press {
121 my ($self, $event) = @_; 347 my ($self, $event) = @_;
122 if($self->valid_button($event)) { 348 if($self->valid_button($event)
349 && (my @exec = $self->command_for($event->{row},$event->{col}))) {
123 $self->{row} = $event->{row}; 350 $self->{row} = $event->{row};
124 $self->{col} = $event->{col}; 351 $self->{col} = $event->{col};
352 $self->{cmd} = \@exec;
353 return 1;
125 } else { 354 } else {
126 delete $self->{row}; 355 delete $self->{row};
127 delete $self->{col}; 356 delete $self->{col};
357 delete $self->{cmd};
128 } 358 }
129 359
130 () 360 ()
131} 361}
132 362
133sub on_button_release { 363sub on_button_release {
134 my ($self, $event) = @_; 364 my ($self, $event) = @_;
135 365
136 my $row = delete $self->{row}; 366 my $row = delete $self->{row};
137 my $col = delete $self->{col}; 367 my $col = delete $self->{col};
368 my $cmd = delete $self->{cmd};
138 369
370 return if !defined $row;
371
139 if(defined($row) && $row == $event->{row} && abs($col-$event->{col}) < 2) { 372 if($row == $event->{row} && abs($col-$event->{col}) < 2
373 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) {
140 if($self->valid_button($event)) { 374 if($self->valid_button($event)) {
141 375
142 my @exec = $self->command_for($row,$col);
143 if(@exec) {
144 return $self->exec_async (@exec); 376 $self->exec_async (@$cmd);
377
145 } 378 }
146
147 }
148 } 379 }
149 380
381 1;
382}
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,
150 () 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
151} 490}
152 491
153# 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