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.34 by sf-exg, Tue Oct 14 09:00:43 2014 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 '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
35 73
36Example: load and use the matcher extension with defaults. 74Example: load and use the matcher extension with defaults.
37 75
38 URxvt.perl-ext: default,matcher 76 URxvt.perl-ext: default,matcher
39 77
57 \([\w\-\@;\/?:&=%\$.+!*\x27,~#]*\)| # Allow a pair of matched parentheses 95 \([\w\-\@;\/?:&=%\$.+!*\x27,~#]*\)| # Allow a pair of matched parentheses
58 [\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic) 96 [\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic)
59 )+ 97 )+
60 }x; 98 }x;
61 99
62sub on_key_press { 100sub matchlist_key_press {
63 my ($self, $event, $keysym, $octets) = @_; 101 my ($self, $event, $keysym, $octets) = @_;
64 102
65 return unless $self->{overlay};
66
67 delete $self->{overlay}; 103 delete $self->{overlay};
104 $self->disable ("key_press");
68 105
69 my $i = ($keysym == 96 ? 0 : $keysym - 48); 106 my $i = ($keysym == 96 ? 0 : $keysym - 48);
70 if ($i >= 0 && $i < @{ $self->{matches} }) { 107 if ($i >= 0 && $i < @{ $self->{matches} }) {
71 my @exec = @{ $self->{matches}[$i] }; 108 my @exec = @{ $self->{matches}[$i] };
72 shift @exec;
73 $self->exec_async (@exec); 109 $self->exec_async (@exec[5 .. $#exec]);
74 } 110 }
75 111
76 1 112 1
77} 113}
78 114
79# backwards compat 115# backwards compat
80sub on_user_command { 116sub on_user_command {
81 my ($self, $cmd) = @_; 117 my ($self, $cmd) = @_;
82 118
83 if ($cmd =~ s/^matcher:list\b//) { 119 if ($cmd eq "matcher:list") {
84 $self->matchlist; 120 $self->matchlist;
85 } else { 121 } elsif ($cmd eq "matcher:last") {
86 if ($cmd =~ s/^matcher:last\b//) {
87 $self->most_recent; 122 $self->most_recent;
123 } elsif ($cmd eq "matcher:select") {
124 $self->select_enter;
88 } elsif ($cmd =~ s/^matcher\b//) { 125 } elsif ($cmd eq "matcher") {
89 # for backward compatibility 126 # for backward compatibility
90 $self->most_recent; 127 $self->most_recent;
91 }
92 } 128 }
93 129
94 () 130 ()
95} 131}
96 132
99 135
100 if ($action eq "list") { 136 if ($action eq "list") {
101 $self->matchlist; 137 $self->matchlist;
102 } elsif ($action eq "last") { 138 } elsif ($action eq "last") {
103 $self->most_recent; 139 $self->most_recent;
140 } elsif ($action eq "select") {
141 $self->select_enter;
104 } 142 }
105 143
106 () 144 ()
107} 145}
108 146
109sub matchlist { 147sub matchlist {
110 my ($self) = @_; 148 my ($self) = @_;
111 149
112 @{ $self->{matches} } = (); 150 $self->{matches} = [];
113 my $row = $self->nrow - 1; 151 my $row = $self->nrow - 1;
114 while ($row >= 0 && @{ $self->{matches} } < 10) { 152 while ($row >= 0 && @{ $self->{matches} } < 10) {
115 my $line = $self->line ($row); 153 my $line = $self->line ($row);
116 my $text = $line->t; 154 my @matches = $self->find_matches ($row);
117 155
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) { 156 for (sort { $b->[0] <=> $a->[0] or $b->[1] <=> $a->[1] } @matches) {
141 shift @$_;
142 push @{ $self->{matches} }, $_; 157 push @{ $self->{matches} }, $_;
143 last if @{ $self->{matches} } == 10; 158 last if @{ $self->{matches} } == 10;
144 } 159 }
145 160
146 $row = $line->beg - 1; 161 $row = $line->beg - 1;
150 165
151 my $width = 0; 166 my $width = 0;
152 167
153 my $i = 0; 168 my $i = 0;
154 for my $match (@{ $self->{matches} }) { 169 for my $match (@{ $self->{matches} }) {
155 my $text = $match->[0]; 170 my $text = $match->[4];
156 my $w = $self->strwidth ("$i-$text"); 171 my $w = $self->strwidth ("$i-$text");
157 172
158 $width = $w if $w > $width; 173 $width = $w if $w > $width;
159 $i++; 174 $i++;
160 } 175 }
162 $width = $self->ncol - 2 if $width > $self->ncol - 2; 177 $width = $self->ncol - 2 if $width > $self->ncol - 2;
163 178
164 $self->{overlay} = $self->overlay (0, 0, $width, scalar (@{ $self->{matches} }), urxvt::OVERLAY_RSTYLE, 2); 179 $self->{overlay} = $self->overlay (0, 0, $width, scalar (@{ $self->{matches} }), urxvt::OVERLAY_RSTYLE, 2);
165 my $i = 0; 180 my $i = 0;
166 for my $match (@{ $self->{matches} }) { 181 for my $match (@{ $self->{matches} }) {
167 my $text = $match->[0]; 182 my $text = $match->[4];
168 183
169 $self->{overlay}->set (0, $i, "$i-$text"); 184 $self->{overlay}->set (0, $i, "$i-$text");
170 $i++; 185 $i++;
171 } 186 }
172 187
188 $self->enable (key_press => \&matchlist_key_press);
173} 189}
174 190
175sub most_recent { 191sub most_recent {
176 my ($self) = shift; 192 my ($self) = shift;
177 my $row = $self->nrow; 193 my $row = $self->nrow - 1;
178 my @exec; 194 my @exec;
179 while($row-- > $self->top_row) { 195 while ($row >= $self->top_row) {
196 my $line = $self->line ($row);
180 @exec = $self->command_for($row); 197 @exec = $self->command_for($row);
181 last if(@exec); 198 last if(@exec);
199
200 $row = $line->beg - 1;
182 } 201 }
183 if(@exec) { 202 if(@exec) {
184 return $self->exec_async (@exec); 203 return $self->exec_async (@exec);
185 } 204 }
186 () 205 ()
208sub on_start { 227sub on_start {
209 my ($self) = @_; 228 my ($self) = @_;
210 229
211 $self->{launcher} = $self->my_resource ("launcher") || $self->x_resource("url-launcher") || "sensible-browser"; 230 $self->{launcher} = $self->my_resource ("launcher") || $self->x_resource("url-launcher") || "sensible-browser";
212 231
213 $self->{matches} = [];
214 $self->{button} = 2; 232 $self->{button} = 2;
215 $self->{state} = 0; 233 $self->{state} = 0;
216 if($self->{argv}[0] || $self->my_resource ("button")) { 234 if($self->{argv}[0] || $self->my_resource ("button")) {
217 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button"); 235 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button");
218 for my $mod (@mods) { 236 for my $mod (@mods) {
249 my ($self, $row) = @_; 267 my ($self, $row) = @_;
250 268
251 # fetch the line that has changed 269 # fetch the line that has changed
252 my $line = $self->line ($row); 270 my $line = $self->line ($row);
253 my $text = $line->t; 271 my $text = $line->t;
254 my $i = 0; 272 my $rend;
255 273
256 # find all urls (if any) 274 # find all urls (if any)
257 for my $matcher (@{$self->{matchers}}) { 275 for my $matcher (@{$self->{matchers}}) {
258 while ($text =~ /$matcher->[0]/g) { 276 while ($text =~ /$matcher->[0]/g) {
259 #print "$&\n"; 277 #print "$&\n";
260 my $rend = $line->r; 278 $rend ||= $line->r;
261 279
262 # mark all characters as underlined. we _must_ not toggle underline, 280 # mark all characters as underlined. we _must_ not toggle underline,
263 # as we might get called on an already-marked url. 281 # as we might get called on an already-marked url.
264 &{$matcher->[2]} 282 &{$matcher->[2]}
265 for @{$rend}[ $-[0] .. $+[0] - 1]; 283 for @{$rend}[$-[0] .. $+[0] - 1];
266
267 $line->r ($rend);
268 } 284 }
269 } 285 }
286
287 $line->r ($rend) if $rend;
270 288
271 () 289 ()
272} 290}
273 291
274sub valid_button { 292sub valid_button {
277 | urxvt::ShiftMask | urxvt::ControlMask; 295 | urxvt::ShiftMask | urxvt::ControlMask;
278 return ($event->{button} == $self->{button} && 296 return ($event->{button} == $self->{button} &&
279 ($event->{state} & $mask) == $self->{state}); 297 ($event->{state} & $mask) == $self->{state});
280} 298}
281 299
282sub command_for { 300sub find_matches {
283 my ($self, $row, $col) = @_; 301 my ($self, $row, $col) = @_;
284 my $line = $self->line ($row); 302 my $line = $self->line ($row);
285 my $text = $line->t; 303 my $text = $line->t;
304 my $off = $line->offset_of ($row, $col) if defined $col;
286 305
306 my @matches;
287 for my $matcher (@{$self->{matchers}}) { 307 for my $matcher (@{$self->{matchers}}) {
288 my $launcher = $matcher->[1] || $self->{launcher}; 308 my $launcher = $matcher->[1] || $self->{launcher};
289 while (($text =~ /$matcher->[0]/g)) { 309 while ($text =~ /$matcher->[0]/g) {
290 my $match = $&; 310 my $match = substr $text, $-[0], $+[0] - $-[0];
291 my @begin = @-; 311 my @begin = @-;
292 my @end = @+; 312 my @end = @+;
313 my @exec;
314
293 if (!defined($col) || ($-[0] <= $col && $+[0] >= $col)) { 315 if (!defined($off) || ($-[0] <= $off && $+[0] >= $off)) {
294 if ($launcher !~ /\$/) { 316 if ($launcher !~ /\$/) {
295 return ($launcher,$match); 317 @exec = ($launcher, $match);
296 } else { 318 } else {
297 # It'd be nice to just access a list like ($&,$1,$2...), 319 # It'd be nice to just access a list like ($&,$1,$2...),
298 # but alas, m//g behaves differently in list context. 320 # but alas, m//g behaves differently in list context.
299 my @exec = map { s/\$(\d+)|\$\{(\d+)\}/ 321 @exec = map { s/\$(\d+)|\$\{(\d+)\}/
300 substr($text,$begin[$1||$2],$end[$1||$2]-$begin[$1||$2]) 322 substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2]
301 /egx; $_ } split(/\s+/, $launcher); 323 /egx; $_ } split /\s+/, $launcher;
302 return @exec;
303 } 324 }
325
326 push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ];
304 } 327 }
305 } 328 }
329 }
330
331 @matches;
332}
333
334sub command_for {
335 my ($self, $row, $col) = @_;
336
337 my @matches = $self->find_matches ($row, $col);
338 if (@matches) {
339 my @match = @{ $matches[0] };
340 return @match[5 .. $#match];
306 } 341 }
307 342
308 () 343 ()
309} 344}
310 345
344 } 379 }
345 380
346 1; 381 1;
347} 382}
348 383
384sub select_enter {
385 my ($self) = @_;
386
387 $self->{view_start} = $self->view_start;
388 $self->{pty_ev_events} = $self->pty_ev_events (urxvt::EV_NONE);
389 $self->{cur_row} = $self->nrow - 1;
390
391 $self->enable (
392 key_press => \&select_key_press,
393 refresh_begin => \&select_refresh,
394 refresh_end => \&select_refresh,
395 );
396
397 $self->{overlay} = $self->overlay (0, -1, $self->ncol, 1, urxvt::OVERLAY_RSTYLE, 0);
398 $self->{overlay}->set (0, 0, "match-select");
399}
400
401sub select_leave {
402 my ($self) = @_;
403
404 $self->disable ("key_press", "refresh_begin", "refresh_end");
405 $self->pty_ev_events ($self->{pty_ev_events});
406
407 delete $self->{overlay};
408 delete $self->{matches};
409 delete $self->{id};
410}
411
412sub select_search {
413 my ($self, $dir, $row) = @_;
414
415 while ($self->nrow > $row && $row >= $self->top_row) {
416 my $line = $self->line ($row)
417 or last;
418
419 my @matches = $self->find_matches ($row);
420 if (@matches) {
421 @matches = sort { $a->[0] <=> $b->[0] or $a->[1] <=> $b->[1] } @matches;
422 $self->{matches} = \@matches;
423 $self->{cur_row} = $row;
424 $self->{id} = $dir < 0 ? @{ $self->{matches} } - 1 : 0;
425 $self->view_start (List::Util::min 0, $row - ($self->nrow >> 1));
426 $self->want_refresh;
427 return;
428 }
429
430 $row = $dir < 0 ? $line->beg - 1 : $line->end + 1;
431 }
432
433 $self->scr_bell;
434}
435
436sub select_refresh {
437 my ($self) = @_;
438
439 return unless $self->{matches};
440
441 my $cur = $self->{matches}[$self->{id}];
442 $self->scr_xor_span (@$cur[0 .. 3], urxvt::RS_RVid);
443
444 ()
445}
446
447sub select_key_press {
448 my ($self, $event, $keysym, $string) = @_;
449
450 if ($keysym == 0xff0d || $keysym == 0xff8d) { # enter
451 if ($self->{matches}) {
452 my @match = @{ $self->{matches}[$self->{id}] };
453 $self->exec_async (@match[5 .. $#match]);
454 }
455 $self->select_leave;
456 } elsif ($keysym == 0x79) { # y
457 if ($self->{matches}) {
458 $self->selection ($self->{matches}[$self->{id}][4], 1);
459 $self->selection_grab (urxvt::CurrentTime, 1);
460 }
461 $self->select_leave;
462 } elsif ($keysym == 0xff1b) { # escape
463 $self->view_start ($self->{view_start});
464 $self->select_leave;
465 } elsif ($keysym == 0xff50) { # home
466 $self->select_search (+1, $self->top_row)
467 } elsif ($keysym == 0xff57) { # end
468 $self->select_search (-1, $self->nrow - 1)
469 } elsif ($keysym == 0xff52) { # up
470 if ($self->{id} > 0) {
471 $self->{id}--;
472 $self->want_refresh;
473 } else {
474 my $line = $self->line ($self->{cur_row});
475 $self->select_search (-1, $line->beg - 1)
476 if $line->beg > $self->top_row;
477 }
478 } elsif ($keysym == 0xff54) { # down
479 if ($self->{id} < @{ $self->{matches} } - 1) {
480 $self->{id}++;
481 $self->want_refresh;
482 } else {
483 my $line = $self->line ($self->{cur_row});
484 $self->select_search (+1, $line->end + 1)
485 if $line->end < $self->nrow;
486 }
487 }
488
489 1
490}
491
349# vim:set sw=3 sts=3 et: 492# vim:set sw=3 sts=3 et:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines