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