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.21 by sf-exg, Thu Jun 12 12:13:52 2014 UTC vs.
Revision 1.36 by sf-exg, Wed Jul 14 12:39: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
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 "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.
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 4
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
57 \([\w\-\@;\/?:&=%\$.+!*\x27,~#]*\)| # Allow a pair of matched parentheses 98 \([\w\-\@;\/?:&=%\$.+!*\x27,~#]*\)| # 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 @matches = $self->find_matches ($row, 0); 157 my @matches = $self->find_matches ($row);
117 158
118 for (sort { $b->[0] <=> $a->[0] } @matches) { 159 for (sort { $b->[0] <=> $a->[0] or $b->[1] <=> $a->[1] } @matches) {
119 shift @$_;
120 push @{ $self->{matches} }, $_; 160 push @{ $self->{matches} }, $_;
121 last if @{ $self->{matches} } == 10; 161 last if @{ $self->{matches} } == 10;
122 } 162 }
123 163
124 $row = $line->beg - 1; 164 $row = $line->beg - 1;
128 168
129 my $width = 0; 169 my $width = 0;
130 170
131 my $i = 0; 171 my $i = 0;
132 for my $match (@{ $self->{matches} }) { 172 for my $match (@{ $self->{matches} }) {
133 my $text = $match->[0]; 173 my $text = $match->[4];
134 my $w = $self->strwidth ("$i-$text"); 174 my $w = $self->strwidth ("$i-$text");
135 175
136 $width = $w if $w > $width; 176 $width = $w if $w > $width;
137 $i++; 177 $i++;
138 } 178 }
140 $width = $self->ncol - 2 if $width > $self->ncol - 2; 180 $width = $self->ncol - 2 if $width > $self->ncol - 2;
141 181
142 $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);
143 my $i = 0; 183 my $i = 0;
144 for my $match (@{ $self->{matches} }) { 184 for my $match (@{ $self->{matches} }) {
145 my $text = $match->[0]; 185 my $text = $match->[4];
146 186
147 $self->{overlay}->set (0, $i, "$i-$text"); 187 $self->{overlay}->set (0, $i, "$i-$text");
148 $i++; 188 $i++;
149 } 189 }
150 190
191 $self->enable (key_press => \&matchlist_key_press);
151} 192}
152 193
153sub most_recent { 194sub most_recent {
154 my ($self) = shift; 195 my ($self) = shift;
155 my $row = $self->nrow; 196 my $row = $self->nrow - 1;
156 my @exec; 197 my @exec;
157 while($row-- > $self->top_row) { 198 while ($row >= $self->top_row) {
199 my $line = $self->line ($row);
158 @exec = $self->command_for($row); 200 @exec = $self->command_for($row);
159 last if(@exec); 201 last if(@exec);
202
203 $row = $line->beg - 1;
160 } 204 }
161 if(@exec) { 205 if(@exec) {
162 return $self->exec_async (@exec); 206 return $self->exec_async (@exec);
163 } 207 }
164 () 208 ()
186sub on_start { 230sub on_start {
187 my ($self) = @_; 231 my ($self) = @_;
188 232
189 $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";
190 234
191 $self->{matches} = [];
192 $self->{button} = 2; 235 $self->{button} = 2;
193 $self->{state} = 0; 236 $self->{state} = 0;
194 if($self->{argv}[0] || $self->my_resource ("button")) { 237 if($self->{argv}[0] || $self->my_resource ("button")) {
195 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button"); 238 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button");
196 for my $mod (@mods) { 239 for my $mod (@mods) {
227 my ($self, $row) = @_; 270 my ($self, $row) = @_;
228 271
229 # fetch the line that has changed 272 # fetch the line that has changed
230 my $line = $self->line ($row); 273 my $line = $self->line ($row);
231 my $text = $line->t; 274 my $text = $line->t;
232 my $i = 0; 275 my $rend;
233 276
234 # find all urls (if any) 277 # find all urls (if any)
235 for my $matcher (@{$self->{matchers}}) { 278 for my $matcher (@{$self->{matchers}}) {
236 while ($text =~ /$matcher->[0]/g) { 279 while ($text =~ /$matcher->[0]/g) {
237 #print "$&\n"; 280 #print "$&\n";
238 my $rend = $line->r; 281 $rend ||= $line->r;
239 282
240 # mark all characters as underlined. we _must_ not toggle underline, 283 # mark all characters as underlined. we _must_ not toggle underline,
241 # as we might get called on an already-marked url. 284 # as we might get called on an already-marked url.
242 &{$matcher->[2]} 285 &{$matcher->[2]}
243 for @{$rend}[ $-[0] .. $+[0] - 1]; 286 for @{$rend}[$-[0] .. $+[0] - 1];
244
245 $line->r ($rend);
246 } 287 }
247 } 288 }
289
290 $line->r ($rend) if $rend;
248 291
249 () 292 ()
250} 293}
251 294
252sub valid_button { 295sub valid_button {
259 302
260sub find_matches { 303sub find_matches {
261 my ($self, $row, $col) = @_; 304 my ($self, $row, $col) = @_;
262 my $line = $self->line ($row); 305 my $line = $self->line ($row);
263 my $text = $line->t; 306 my $text = $line->t;
307 my $off = $line->offset_of ($row, $col) if defined $col;
264 308
265 my @matches; 309 my @matches;
266 for my $matcher (@{$self->{matchers}}) { 310 for my $matcher (@{$self->{matchers}}) {
267 my $launcher = $matcher->[1] || $self->{launcher}; 311 my $launcher = $matcher->[1] || $self->{launcher};
268 while (($text =~ /$matcher->[0]/g)) { 312 while ($text =~ /$matcher->[0]/g) {
269 my $match = substr $text, $-[0], $+[0] - $-[0]; 313 my $match = substr $text, $-[0], $+[0] - $-[0];
270 my @begin = @-; 314 my @begin = @-;
271 my @end = @+; 315 my @end = @+;
272 my @exec; 316 my @exec;
273 317
274 if (!defined($col) || ($-[0] <= $col && $+[0] >= $col)) { 318 if (!defined($off) || ($-[0] <= $off && $+[0] >= $off)) {
275 if ($launcher !~ /\$/) { 319 if ($launcher !~ /\$/) {
276 @exec = ($launcher, $match); 320 @exec = ($launcher, $match);
277 } else { 321 } else {
278 # 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...),
279 # but alas, m//g behaves differently in list context. 323 # but alas, m//g behaves differently in list context.
280 @exec = map { s/\$(\d+)|\$\{(\d+)\}/ 324 @exec = map { s/\$(\d+)|\$\{(\d+)\}/
281 substr($text,$begin[$1||$2],$end[$1||$2]-$begin[$1||$2]) 325 substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2]
282 /egx; $_ } split(/\s+/, $launcher); 326 /egx; $_ } split /\s+/, $launcher;
283 } 327 }
284 328
285 push @matches, [ $begin[0], $match, @exec ]; 329 push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ];
286 } 330 }
287 } 331 }
288 } 332 }
289 333
290 @matches; 334 @matches;
294 my ($self, $row, $col) = @_; 338 my ($self, $row, $col) = @_;
295 339
296 my @matches = $self->find_matches ($row, $col); 340 my @matches = $self->find_matches ($row, $col);
297 if (@matches) { 341 if (@matches) {
298 my @match = @{ $matches[0] }; 342 my @match = @{ $matches[0] };
299 return @match[2 .. $#match]; 343 return @match[5 .. $#match];
300 } 344 }
301 345
302 () 346 ()
303} 347}
304 348
338 } 382 }
339 383
340 1; 384 1;
341} 385}
342 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
343# 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