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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines