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.20 by sf-exg, Thu Jun 12 06:03:49 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
… …
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 "matcher:last" or 34from the keyboard. Simply bind a keysym to "matcher:last" or
34"matcher:list" as seen in the example below. 35"matcher:list" as seen in the example below.
35 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
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.
… …
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 return unless $self->{overlay};
66
67 delete $self->{overlay}; 106 delete $self->{overlay};
107 $self->disable ("key_press");
68 108
69 my $i = ($keysym == 96 ? 0 : $keysym - 48); 109 my $i = ($keysym == 96 ? 0 : $keysym - 48);
70 if ($i >= 0 && $i < @{ $self->{matches} }) { 110 if ($i >= 0 && $i < @{ $self->{matches} }) {
71 my @exec = @{ $self->{matches}[$i] }; 111 my @exec = @{ $self->{matches}[$i] };
72 shift @exec;
73 $self->exec_async (@exec); 112 $self->exec_async (@exec[5 .. $#exec]);
74 } 113 }
75 114
76 1 115 1
77} 116}
78 117
79# backwards compat 118# backwards compat
80sub on_user_command { 119sub on_user_command {
81 my ($self, $cmd) = @_; 120 my ($self, $cmd) = @_;
82 121
83 if ($cmd =~ s/^matcher:list\b//) { 122 if ($cmd eq "matcher:list") {
84 $self->matchlist; 123 $self->matchlist;
85 } else { 124 } elsif ($cmd eq "matcher:last") {
86 if ($cmd =~ s/^matcher:last\b//) {
87 $self->most_recent; 125 $self->most_recent;
126 } elsif ($cmd eq "matcher:select") {
127 $self->select_enter;
88 } elsif ($cmd =~ s/^matcher\b//) { 128 } elsif ($cmd eq "matcher") {
89 # for backward compatibility 129 # for backward compatibility
90 $self->most_recent; 130 $self->most_recent;
91 }
92 } 131 }
93 132
94 () 133 ()
95} 134}
96 135
… …
99 138
100 if ($action eq "list") { 139 if ($action eq "list") {
101 $self->matchlist; 140 $self->matchlist;
102 } elsif ($action eq "last") { 141 } elsif ($action eq "last") {
103 $self->most_recent; 142 $self->most_recent;
143 } elsif ($action eq "select") {
144 $self->select_enter;
104 } 145 }
105 146
106 () 147 ()
107} 148}
108 149
109sub matchlist { 150sub matchlist {
110 my ($self) = @_; 151 my ($self) = @_;
111 152
112 @{ $self->{matches} } = (); 153 $self->{matches} = [];
113 my $row = $self->nrow - 1; 154 my $row = $self->nrow - 1;
114 while ($row >= 0 && @{ $self->{matches} } < 10) { 155 while ($row >= 0 && @{ $self->{matches} } < 10) {
115 my $line = $self->line ($row); 156 my $line = $self->line ($row);
116 my $text = $line->t; 157 my @matches = $self->find_matches ($row);
117 158
118 # FIXME: code duplicated from 'command_for'
119 my @matches;
120 for my $matcher (@{$self->{matchers}}) {
121 my $launcher = $matcher->[1] || $self->{launcher};
122 while ($text =~ /$matcher->[0]/g) {
123 my $match = substr ($text, $-[0], $+[0] - $-[0]);
124 my @beg = @-;
125 my @end = @+;
126 my @exec;
127
128 if ($launcher !~ /\$/) {
129 @exec = ($launcher, $match);
130 } else {
131 @exec = map { s/\$(\d+)|\$\{(\d+)\}/
132 substr ($text, $beg[$1 || $2], $end[$1 || $2] - $beg[$1 || $2])
133 /egx; $_ } split /\s+/, $launcher;
134 }
135
136 push @matches, [ $beg[0], $match, @exec ];
137 }
138 }
139
140 for (sort { $b->[0] <=> $a->[0] } @matches) { 159 for (sort { $b->[0] <=> $a->[0] or $b->[1] <=> $a->[1] } @matches) {
141 shift @$_;
142 push @{ $self->{matches} }, $_; 160 push @{ $self->{matches} }, $_;
143 last if @{ $self->{matches} } == 10; 161 last if @{ $self->{matches} } == 10;
144 } 162 }
145 163
146 $row = $line->beg - 1; 164 $row = $line->beg - 1;
… …
150 168
151 my $width = 0; 169 my $width = 0;
152 170
153 my $i = 0; 171 my $i = 0;
154 for my $match (@{ $self->{matches} }) { 172 for my $match (@{ $self->{matches} }) {
155 my $text = $match->[0]; 173 my $text = $match->[4];
156 my $w = $self->strwidth ("$i-$text"); 174 my $w = $self->strwidth ("$i-$text");
157 175
158 $width = $w if $w > $width; 176 $width = $w if $w > $width;
159 $i++; 177 $i++;
160 } 178 }
… …
162 $width = $self->ncol - 2 if $width > $self->ncol - 2; 180 $width = $self->ncol - 2 if $width > $self->ncol - 2;
163 181
164 $self->{overlay} = $self->overlay (0, 0, $width, scalar (@{ $self->{matches} }), urxvt::OVERLAY_RSTYLE, 2); 182 $self->{overlay} = $self->overlay (0, 0, $width, scalar (@{ $self->{matches} }), urxvt::OVERLAY_RSTYLE, 2);
165 my $i = 0; 183 my $i = 0;
166 for my $match (@{ $self->{matches} }) { 184 for my $match (@{ $self->{matches} }) {
167 my $text = $match->[0]; 185 my $text = $match->[4];
168 186
169 $self->{overlay}->set (0, $i, "$i-$text"); 187 $self->{overlay}->set (0, $i, "$i-$text");
170 $i++; 188 $i++;
171 } 189 }
172 190
191 $self->enable (key_press => \&matchlist_key_press);
173} 192}
174 193
175sub most_recent { 194sub most_recent {
176 my ($self) = shift; 195 my ($self) = shift;
177 my $row = $self->nrow; 196 my $row = $self->nrow - 1;
178 my @exec; 197 my @exec;
179 while($row-- > $self->top_row) { 198 while ($row >= $self->top_row) {
199 my $line = $self->line ($row);
180 @exec = $self->command_for($row); 200 @exec = $self->command_for($row);
181 last if(@exec); 201 last if(@exec);
202
203 $row = $line->beg - 1;
182 } 204 }
183 if(@exec) { 205 if(@exec) {
184 return $self->exec_async (@exec); 206 return $self->exec_async (@exec);
185 } 207 }
186 () 208 ()
… …
208sub on_start { 230sub on_start {
209 my ($self) = @_; 231 my ($self) = @_;
210 232
211 $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";
212 234
213 $self->{matches} = [];
214 $self->{button} = 2; 235 $self->{button} = 2;
215 $self->{state} = 0; 236 $self->{state} = 0;
216 if($self->{argv}[0] || $self->my_resource ("button")) { 237 if($self->{argv}[0] || $self->my_resource ("button")) {
217 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button"); 238 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button");
218 for my $mod (@mods) { 239 for my $mod (@mods) {
… …
230 } 251 }
231 } 252 }
232 253
233 my @defaults = ($url); 254 my @defaults = ($url);
234 my @matchers; 255 my @matchers;
235 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++) {
236 $res = $self->locale_decode ($res);
237 utf8::encode $res;
238 my $launcher = $self->my_resource ("launcher.$idx"); 257 my $launcher = $self->my_resource ("launcher.$idx");
239 $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher; 258 $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher;
240 my $rend = $self->parse_rend($self->my_resource ("rend.$idx")); 259 my $rend = $self->parse_rend($self->my_resource ("rend.$idx"));
241 unshift @matchers, [qr($res)x,$launcher,$rend]; 260 unshift @matchers, [qr($res)x,$launcher,$rend];
242 } 261 }
… …
249 my ($self, $row) = @_; 268 my ($self, $row) = @_;
250 269
251 # fetch the line that has changed 270 # fetch the line that has changed
252 my $line = $self->line ($row); 271 my $line = $self->line ($row);
253 my $text = $line->t; 272 my $text = $line->t;
254 my $i = 0; 273 my $rend;
255 274
256 # find all urls (if any) 275 # find all urls (if any)
257 for my $matcher (@{$self->{matchers}}) { 276 for my $matcher (@{$self->{matchers}}) {
258 while ($text =~ /$matcher->[0]/g) { 277 while ($text =~ /$matcher->[0]/g) {
259 #print "$&\n"; 278 #print "$&\n";
260 my $rend = $line->r; 279 $rend ||= $line->r;
261 280
262 # mark all characters as underlined. we _must_ not toggle underline, 281 # mark all characters as underlined. we _must_ not toggle underline,
263 # as we might get called on an already-marked url. 282 # as we might get called on an already-marked url.
264 &{$matcher->[2]} 283 &{$matcher->[2]}
265 for @{$rend}[ $-[0] .. $+[0] - 1]; 284 for @{$rend}[$-[0] .. $+[0] - 1];
266
267 $line->r ($rend);
268 } 285 }
269 } 286 }
287
288 $line->r ($rend) if $rend;
270 289
271 () 290 ()
272} 291}
273 292
274sub valid_button { 293sub valid_button {
… …
277 | urxvt::ShiftMask | urxvt::ControlMask; 296 | urxvt::ShiftMask | urxvt::ControlMask;
278 return ($event->{button} == $self->{button} && 297 return ($event->{button} == $self->{button} &&
279 ($event->{state} & $mask) == $self->{state}); 298 ($event->{state} & $mask) == $self->{state});
280} 299}
281 300
282sub command_for { 301sub find_matches {
283 my ($self, $row, $col) = @_; 302 my ($self, $row, $col) = @_;
284 my $line = $self->line ($row); 303 my $line = $self->line ($row);
285 my $text = $line->t; 304 my $text = $line->t;
305 my $off = $line->offset_of ($row, $col) if defined $col;
286 306
307 my @matches;
287 for my $matcher (@{$self->{matchers}}) { 308 for my $matcher (@{$self->{matchers}}) {
288 my $launcher = $matcher->[1] || $self->{launcher}; 309 my $launcher = $matcher->[1] || $self->{launcher};
289 while (($text =~ /$matcher->[0]/g)) { 310 while ($text =~ /$matcher->[0]/g) {
290 my $match = $&; 311 my $match = substr $text, $-[0], $+[0] - $-[0];
291 my @begin = @-; 312 my @begin = @-;
292 my @end = @+; 313 my @end = @+;
314 my @exec;
315
293 if (!defined($col) || ($-[0] <= $col && $+[0] >= $col)) { 316 if (!defined($off) || ($-[0] <= $off && $+[0] >= $off)) {
294 if ($launcher !~ /\$/) { 317 if ($launcher !~ /\$/) {
295 return ($launcher,$match); 318 @exec = ($launcher, $match);
296 } else { 319 } else {
297 # 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...),
298 # but alas, m//g behaves differently in list context. 321 # but alas, m//g behaves differently in list context.
299 my @exec = map { s/\$(\d+)|\$\{(\d+)\}/ 322 @exec = map { s/\$(\d+)|\$\{(\d+)\}/
300 substr($text,$begin[$1||$2],$end[$1||$2]-$begin[$1||$2]) 323 substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2]
301 /egx; $_ } split(/\s+/, $launcher); 324 /egx; $_ } split /\s+/, $launcher;
302 return @exec;
303 } 325 }
326
327 push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ];
304 } 328 }
305 } 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];
306 } 342 }
307 343
308 () 344 ()
309} 345}
310 346
… …
344 } 380 }
345 381
346 1; 382 1;
347} 383}
348 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
349# 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