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.35 by sf-exg, Tue Mar 17 09:25:16 2015 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 $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) {
… …
249 my ($self, $row) = @_; 270 my ($self, $row) = @_;
250 271
251 # fetch the line that has changed 272 # fetch the line that has changed
252 my $line = $self->line ($row); 273 my $line = $self->line ($row);
253 my $text = $line->t; 274 my $text = $line->t;
254 my $i = 0; 275 my $rend;
255 276
256 # find all urls (if any) 277 # find all urls (if any)
257 for my $matcher (@{$self->{matchers}}) { 278 for my $matcher (@{$self->{matchers}}) {
258 while ($text =~ /$matcher->[0]/g) { 279 while ($text =~ /$matcher->[0]/g) {
259 #print "$&\n"; 280 #print "$&\n";
260 my $rend = $line->r; 281 $rend ||= $line->r;
261 282
262 # mark all characters as underlined. we _must_ not toggle underline, 283 # mark all characters as underlined. we _must_ not toggle underline,
263 # as we might get called on an already-marked url. 284 # as we might get called on an already-marked url.
264 &{$matcher->[2]} 285 &{$matcher->[2]}
265 for @{$rend}[ $-[0] .. $+[0] - 1]; 286 for @{$rend}[$-[0] .. $+[0] - 1];
266
267 $line->r ($rend);
268 } 287 }
269 } 288 }
289
290 $line->r ($rend) if $rend;
270 291
271 () 292 ()
272} 293}
273 294
274sub valid_button { 295sub valid_button {
… …
277 | urxvt::ShiftMask | urxvt::ControlMask; 298 | urxvt::ShiftMask | urxvt::ControlMask;
278 return ($event->{button} == $self->{button} && 299 return ($event->{button} == $self->{button} &&
279 ($event->{state} & $mask) == $self->{state}); 300 ($event->{state} & $mask) == $self->{state});
280} 301}
281 302
282sub command_for { 303sub find_matches {
283 my ($self, $row, $col) = @_; 304 my ($self, $row, $col) = @_;
284 my $line = $self->line ($row); 305 my $line = $self->line ($row);
285 my $text = $line->t; 306 my $text = $line->t;
307 my $off = $line->offset_of ($row, $col) if defined $col;
286 308
309 my @matches;
287 for my $matcher (@{$self->{matchers}}) { 310 for my $matcher (@{$self->{matchers}}) {
288 my $launcher = $matcher->[1] || $self->{launcher}; 311 my $launcher = $matcher->[1] || $self->{launcher};
289 while (($text =~ /$matcher->[0]/g)) { 312 while ($text =~ /$matcher->[0]/g) {
290 my $match = $&; 313 my $match = substr $text, $-[0], $+[0] - $-[0];
291 my @begin = @-; 314 my @begin = @-;
292 my @end = @+; 315 my @end = @+;
316 my @exec;
317
293 if (!defined($col) || ($-[0] <= $col && $+[0] >= $col)) { 318 if (!defined($off) || ($-[0] <= $off && $+[0] >= $off)) {
294 if ($launcher !~ /\$/) { 319 if ($launcher !~ /\$/) {
295 return ($launcher,$match); 320 @exec = ($launcher, $match);
296 } else { 321 } else {
297 # 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...),
298 # but alas, m//g behaves differently in list context. 323 # but alas, m//g behaves differently in list context.
299 my @exec = map { s/\$(\d+)|\$\{(\d+)\}/ 324 @exec = map { s/\$(\d+)|\$\{(\d+)\}/
300 substr($text,$begin[$1||$2],$end[$1||$2]-$begin[$1||$2]) 325 substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2]
301 /egx; $_ } split(/\s+/, $launcher); 326 /egx; $_ } split /\s+/, $launcher;
302 return @exec;
303 } 327 }
328
329 push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ];
304 } 330 }
305 } 331 }
332 }
333
334 @matches;
335}
336
337sub command_for {
338 my ($self, $row, $col) = @_;
339
340 my @matches = $self->find_matches ($row, $col);
341 if (@matches) {
342 my @match = @{ $matches[0] };
343 return @match[5 .. $#match];
306 } 344 }
307 345
308 () 346 ()
309} 347}
310 348
… …
344 } 382 }
345 383
346 1; 384 1;
347} 385}
348 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 (List::Util::min 0, $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
349# 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