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.16 by sf-exg, Wed May 28 17:01:32 2014 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:RESOURCE:%.launcher:string:default launcher command 7#:META:RESOURCE:%.launcher:string:default launcher command
7#:META:RESOURCE:%.button:string:the button, yeah 8#:META:RESOURCE:%.button:string:the mouse button used to activate a match
8#:META:RESOURCE:%.pattern.:string:extra pattern to match 9#:META:RESOURCE:%.pattern.:string:extra pattern to match
9#:META:RESOURCE:%.launcher.:string:custom launcher for pattern 10#:META:RESOURCE:%.launcher.:string:custom launcher for pattern
10#:META:RESOURCE:%.rend.:string:custom rednition for pattern 11#:META:RESOURCE:%.rend.:string:custom rendition for pattern
11 12
12=head1 NAME 13=head1 NAME
13 14
14matcher - match strings in terminal output and change their rendition 15matcher - match strings in terminal output and change their rendition
15 16
28C<matcher.pattern.0> resource, and additional patterns can be specified 29C<matcher.pattern.0> resource, and additional patterns can be specified
29with numbered patterns, in a manner similar to the "selection" extension. 30with numbered patterns, in a manner similar to the "selection" extension.
30The launcher can also be overridden on a per-pattern basis. 31The launcher can also be overridden on a per-pattern basis.
31 32
32It is possible to activate the most recently seen match or a list of matches 33It is possible to activate the most recently seen match or a list of matches
33from the keyboard. Simply bind a keysym to "perl:matcher:last" or 34from the keyboard. Simply bind a keysym to "matcher:last" or
34"perl:matcher:list" as seen in the example below. 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.
35 76
36Example: load and use the matcher extension with defaults. 77Example: load and use the matcher extension with defaults.
37 78
38 URxvt.perl-ext: default,matcher 79 URxvt.perl-ext: default,matcher
39 80
40Example: use a custom configuration. 81Example: use a custom configuration.
41 82
42 URxvt.url-launcher: sensible-browser 83 URxvt.url-launcher: sensible-browser
43 URxvt.keysym.C-Delete: perl:matcher:last 84 URxvt.keysym.C-Delete: matcher:last
44 URxvt.keysym.M-Delete: perl:matcher:list 85 URxvt.keysym.M-Delete: matcher:list
45 URxvt.matcher.button: 1 86 URxvt.matcher.button: 1
46 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] 87 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
47 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) 88 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
48 URxvt.matcher.launcher.2: gvim +$2 $1 89 URxvt.matcher.launcher.2: gvim +$2 $1
49 90
50=cut 91=cut
51 92
52my $url = 93my $url =
53 qr{ 94 qr{
54 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.) 95 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.)
55 [\w\-\@;\/?:&=%\$.+!*\x27,~#]* 96 [\w\-\@;\/?:&=%\$.+!*\x27,~#$urxvt::NOCHAR]*
56 ( 97 (
57 \([\w\-\@;\/?:&=%\$.+!*\x27,~#]*\)| # Allow a pair of matched parentheses 98 \([\w\-\@;\/?:&=%\$.+!*\x27,~#$urxvt::NOCHAR]*\)| # Allow a pair of matched parentheses
58 [\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic) 99 [\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic)
59 )+ 100 )+
60 }x; 101 }x;
61 102
62sub on_key_press { 103sub matchlist_key_press {
63 my ($self, $event, $keysym, $octets) = @_; 104 my ($self, $event, $keysym, $octets) = @_;
64 105
65 if (! $self->{showing} ) { 106 delete $self->{overlay};
66 return; 107 $self->disable ("key_press");
67 }
68 108
69 my $i = ($keysym == 96 ? 0 : $keysym - 48); 109 my $i = ($keysym == 96 ? 0 : $keysym - 48);
70 if (($i > scalar(@{$self->{urls}})) || ($i < 0)) { 110 if ($i >= 0 && $i < @{ $self->{matches} }) {
71 $self->matchlist(); 111 my @exec = @{ $self->{matches}[$i] };
72 return; 112 $self->exec_async (@exec[5 .. $#exec]);
113 }
114
73 } 115 1
74
75 my @args = ($self->{urls}[ -$i-1 ]);
76 $self->matchlist();
77
78 $self->exec_async( $self->{launcher}, @args );
79} 116}
80 117
81# backwards compat 118# backwards compat
82sub on_user_command { 119sub on_user_command {
83 my ($self, $cmd) = @_; 120 my ($self, $cmd) = @_;
84 121
85 if ($cmd =~ s/^matcher:list\b//) { 122 if ($cmd eq "matcher:list") {
86 $self->matchlist; 123 $self->matchlist;
87 } else { 124 } elsif ($cmd eq "matcher:last") {
88 if ($cmd =~ s/^matcher:last\b//) {
89 $self->most_recent; 125 $self->most_recent;
126 } elsif ($cmd eq "matcher:select") {
127 $self->select_enter;
90 } elsif ($cmd =~ s/^matcher\b//) { 128 } elsif ($cmd eq "matcher") {
91 # for backward compatibility 129 # for backward compatibility
92 $self->most_recent; 130 $self->most_recent;
93 } 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;
94 } 145 }
95 146
96 () 147 ()
97} 148}
98 149
99sub matchlist { 150sub matchlist {
100 my ($self) = @_; 151 my ($self) = @_;
101 if ( $self->{showing} ) { 152
102 $self->{url_overlay}->hide; 153 $self->{matches} = [];
103 $self->{showing} = 0; 154 my $row = $self->nrow - 1;
104 return; 155 while ($row >= 0 && @{ $self->{matches} } < 10) {
105 }
106 @{$self->{urls}} = ();
107 my $line;
108 for (my $i = 0; $i < $self->nrow; $i ++) {
109 $line = $self->line($i); 156 my $line = $self->line ($row);
110 next if ($line->beg != $i); 157 my @matches = $self->find_matches ($row);
111 for my $url ($self->get_urls_from_line($line->t)) { 158
112 if (scalar(@{$self->{urls}}) == 10) { 159 for (sort { $b->[0] <=> $a->[0] or $b->[1] <=> $a->[1] } @matches) {
113 shift @{$self->{urls}};
114 }
115 push @{$self->{urls}}, $url; 160 push @{ $self->{matches} }, $_;
161 last if @{ $self->{matches} } == 10;
116 } 162 }
163
164 $row = $line->beg - 1;
117 } 165 }
118 166
119 if (! scalar(@{$self->{urls}})) { 167 return unless @{ $self->{matches} };
120 return;
121 }
122 168
123 my $max = 0; 169 my $width = 0;
124 my $i = scalar( @{$self->{urls}} ) - 1 ;;
125 170
126 my @temp = ();
127
128 for my $url (@{$self->{urls}}) {
129 my $url = "$i-$url";
130 my $xpos = 0;
131
132 if ($self->ncol + (length $url) >= $self->ncol) {
133 $url = substr( $url, 0, $self->ncol );
134 }
135
136 push @temp, $url;
137
138 if( length $url > $max ) {
139 $max = length $url;
140 }
141
142 $i--;
143 }
144
145 @temp = reverse @temp;
146
147 $self->{url_overlay} = $self->overlay(0, 0, $max, scalar( @temp ), urxvt::OVERLAY_RSTYLE, 2);
148 my $i = 0; 171 my $i = 0;
149 for my $url (@temp) { 172 for my $match (@{ $self->{matches} }) {
150 $self->{url_overlay}->set( 0, $i, $url, [(urxvt::OVERLAY_RSTYLE) x length $url]); 173 my $text = $match->[4];
151 $self->{showing} = 1; 174 my $w = $self->strwidth ("$i-$text");
175
176 $width = $w if $w > $width;
152 $i++; 177 $i++;
153 } 178 }
154 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);
155} 192}
156 193
157sub most_recent { 194sub most_recent {
158 my ($self) = shift; 195 my ($self) = shift;
159 my $row = $self->nrow; 196 my $row = $self->nrow - 1;
160 my @exec; 197 my @exec;
161 while($row-- > $self->top_row) { 198 while ($row >= $self->top_row) {
199 my $line = $self->line ($row);
162 @exec = $self->command_for($row); 200 @exec = $self->command_for($row);
163 last if(@exec); 201 last if(@exec);
202
203 $row = $line->beg - 1;
164 } 204 }
165 if(@exec) { 205 if(@exec) {
166 return $self->exec_async (@exec); 206 return $self->exec_async (@exec);
167 } 207 }
168 () 208 ()
190sub on_start { 230sub on_start {
191 my ($self) = @_; 231 my ($self) = @_;
192 232
193 $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";
194 234
195 $self->{urls} = [];
196 $self->{showing} = 0;
197 $self->{button} = 2; 235 $self->{button} = 2;
198 $self->{state} = 0; 236 $self->{state} = 0;
199 if($self->{argv}[0] || $self->my_resource ("button")) { 237 if($self->{argv}[0] || $self->my_resource ("button")) {
200 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button"); 238 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button");
201 for my $mod (@mods) { 239 for my $mod (@mods) {
213 } 251 }
214 } 252 }
215 253
216 my @defaults = ($url); 254 my @defaults = ($url);
217 my @matchers; 255 my @matchers;
218 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++) {
219 $res = $self->locale_decode ($res);
220 utf8::encode $res;
221 my $launcher = $self->my_resource ("launcher.$idx"); 257 my $launcher = $self->my_resource ("launcher.$idx");
222 $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher; 258 $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher;
223 my $rend = $self->parse_rend($self->my_resource ("rend.$idx")); 259 my $rend = $self->parse_rend($self->my_resource ("rend.$idx"));
224 unshift @matchers, [qr($res)x,$launcher,$rend]; 260 unshift @matchers, [qr($res)x,$launcher,$rend];
225 } 261 }
226 $self->{matchers} = \@matchers; 262 $self->{matchers} = \@matchers;
227 263
228 () 264 ()
229} 265}
230 266
231sub get_urls_from_line {
232 my ($self, $line) = @_;
233 my @urls;
234 for my $matcher (@{$self->{matchers}}) {
235 while ($line =~ /$matcher->[0]/g) {
236 push @urls, substr( $line, $-[0], $+[0] - $-[0] );
237 }
238 }
239 return @urls;
240}
241
242sub on_line_update { 267sub on_line_update {
243 my ($self, $row) = @_; 268 my ($self, $row) = @_;
244 269
245 # fetch the line that has changed 270 # fetch the line that has changed
246 my $line = $self->line ($row); 271 my $line = $self->line ($row);
247 my $text = $line->t; 272 my $text = $line->t;
248 my $i = 0; 273 my $rend;
249 274
250 # find all urls (if any) 275 # find all urls (if any)
251 for my $matcher (@{$self->{matchers}}) { 276 for my $matcher (@{$self->{matchers}}) {
252 while ($text =~ /$matcher->[0]/g) { 277 while ($text =~ /$matcher->[0]/g) {
253 #print "$&\n"; 278 #print "$&\n";
254 my $rend = $line->r; 279 $rend ||= $line->r;
255 280
256 # mark all characters as underlined. we _must_ not toggle underline, 281 # mark all characters as underlined. we _must_ not toggle underline,
257 # as we might get called on an already-marked url. 282 # as we might get called on an already-marked url.
258 &{$matcher->[2]} 283 &{$matcher->[2]}
259 for @{$rend}[ $-[0] .. $+[0] - 1]; 284 for @{$rend}[$-[0] .. $+[0] - 1];
260
261 $line->r ($rend);
262 } 285 }
263 } 286 }
287
288 $line->r ($rend) if $rend;
264 289
265 () 290 ()
266} 291}
267 292
268sub valid_button { 293sub valid_button {
271 | urxvt::ShiftMask | urxvt::ControlMask; 296 | urxvt::ShiftMask | urxvt::ControlMask;
272 return ($event->{button} == $self->{button} && 297 return ($event->{button} == $self->{button} &&
273 ($event->{state} & $mask) == $self->{state}); 298 ($event->{state} & $mask) == $self->{state});
274} 299}
275 300
276sub command_for { 301sub find_matches {
277 my ($self, $row, $col) = @_; 302 my ($self, $row, $col) = @_;
278 my $line = $self->line ($row); 303 my $line = $self->line ($row);
279 my $text = $line->t; 304 my $text = $line->t;
305 my $off = $line->offset_of ($row, $col) if defined $col;
280 306
307 my @matches;
281 for my $matcher (@{$self->{matchers}}) { 308 for my $matcher (@{$self->{matchers}}) {
282 my $launcher = $matcher->[1] || $self->{launcher}; 309 my $launcher = $matcher->[1] || $self->{launcher};
283 while (($text =~ /$matcher->[0]/g)) { 310 while ($text =~ /$matcher->[0]/g) {
284 my $match = $&; 311 my $match = substr $text, $-[0], $+[0] - $-[0];
285 my @begin = @-; 312 my @begin = @-;
286 my @end = @+; 313 my @end = @+;
314 my @exec;
315
287 if (!defined($col) || ($-[0] <= $col && $+[0] >= $col)) { 316 if (!defined($off) || ($-[0] <= $off && $+[0] >= $off)) {
288 if ($launcher !~ /\$/) { 317 if ($launcher !~ /\$/) {
289 return ($launcher,$match); 318 @exec = ($launcher, $match);
290 } else { 319 } else {
291 # 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...),
292 # but alas, m//g behaves differently in list context. 321 # but alas, m//g behaves differently in list context.
293 my @exec = map { s/\$(\d+)|\$\{(\d+)\}/ 322 @exec = map { s/\$(\d+)|\$\{(\d+)\}/
294 substr($text,$begin[$1||$2],$end[$1||$2]-$begin[$1||$2]) 323 substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2]
295 /egx; $_ } split(/\s+/, $launcher); 324 /egx; $_ } split /\s+/, $launcher;
296 return @exec;
297 } 325 }
326
327 push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ];
298 } 328 }
299 } 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];
300 } 342 }
301 343
302 () 344 ()
303} 345}
304 346
330 372
331 if($row == $event->{row} && abs($col-$event->{col}) < 2 373 if($row == $event->{row} && abs($col-$event->{col}) < 2
332 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) { 374 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) {
333 if($self->valid_button($event)) { 375 if($self->valid_button($event)) {
334 376
335 $self->exec_async (@$cmd); 377 $self->exec_async (@$cmd);
336 378
337 } 379 }
338 } 380 }
339 381
340 1; 382 1;
341} 383}
342 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
343# 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