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