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.14 by root, Sat May 17 13:34:35 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: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
14matcher - match strings in terminal output and change their rendition 15matcher - match strings in terminal output and change their rendition
15 16
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.
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
40Example: use a custom configuration. 78Example: use a custom configuration.
41 79
42 URxvt.url-launcher: sensible-browser 80 URxvt.url-launcher: sensible-browser
43 URxvt.keysym.C-Delete: perl:matcher:last 81 URxvt.keysym.C-Delete: matcher:last
44 URxvt.keysym.M-Delete: perl:matcher:list 82 URxvt.keysym.M-Delete: matcher:list
45 URxvt.matcher.button: 1 83 URxvt.matcher.button: 1
46 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] 84 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
47 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) 85 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
48 URxvt.matcher.launcher.2: gvim +$2 $1 86 URxvt.matcher.launcher.2: gvim +$2 $1
49 87
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 if (! $self->{showing} ) { 103 delete $self->{overlay};
66 return; 104 $self->disable ("key_press");
67 }
68 105
69 my $i = ($keysym == 96 ? 0 : $keysym - 48); 106 my $i = ($keysym == 96 ? 0 : $keysym - 48);
70 if (($i > scalar(@{$self->{urls}})) || ($i < 0)) { 107 if ($i >= 0 && $i < @{ $self->{matches} }) {
71 $self->matchlist(); 108 my @exec = @{ $self->{matches}[$i] };
72 return; 109 $self->exec_async (@exec[5 .. $#exec]);
110 }
111
73 } 112 1
74
75 my @args = ($self->{urls}[ -$i-1 ]);
76 $self->matchlist();
77
78 $self->exec_async( $self->{launcher}, @args );
79} 113}
80 114
81# backwards compat 115# backwards compat
82sub on_user_command { 116sub on_user_command {
83 my ($self, $cmd) = @_; 117 my ($self, $cmd) = @_;
84 118
85 if ($cmd =~ s/^matcher:list\b//) { 119 if ($cmd eq "matcher:list") {
86 $self->matchlist; 120 $self->matchlist;
87 } else { 121 } elsif ($cmd eq "matcher:last") {
88 if ($cmd =~ s/^matcher:last\b//) {
89 $self->most_recent; 122 $self->most_recent;
123 } elsif ($cmd eq "matcher:select") {
124 $self->select_enter;
90 } elsif ($cmd =~ s/^matcher\b//) { 125 } elsif ($cmd eq "matcher") {
91 # for backward compatibility 126 # for backward compatibility
92 $self->most_recent; 127 $self->most_recent;
93 } 128 }
129
130 ()
131}
132
133sub on_action {
134 my ($self, $action) = @_;
135
136 if ($action eq "list") {
137 $self->matchlist;
138 } elsif ($action eq "last") {
139 $self->most_recent;
140 } elsif ($action eq "select") {
141 $self->select_enter;
94 } 142 }
95 143
96 () 144 ()
97} 145}
98 146
99sub matchlist { 147sub matchlist {
100 my ($self) = @_; 148 my ($self) = @_;
101 if ( $self->{showing} ) { 149
102 $self->{url_overlay}->hide; 150 $self->{matches} = [];
103 $self->{showing} = 0; 151 my $row = $self->nrow - 1;
104 return; 152 while ($row >= 0 && @{ $self->{matches} } < 10) {
105 }
106 @{$self->{urls}} = ();
107 my $line;
108 for (my $i = 0; $i < $self->nrow; $i ++) {
109 $line = $self->line($i); 153 my $line = $self->line ($row);
110 next if ($line->beg != $i); 154 my @matches = $self->find_matches ($row);
111 for my $url ($self->get_urls_from_line($line->t)) { 155
112 if (scalar(@{$self->{urls}}) == 10) { 156 for (sort { $b->[0] <=> $a->[0] or $b->[1] <=> $a->[1] } @matches) {
113 shift @{$self->{urls}};
114 }
115 push @{$self->{urls}}, $url; 157 push @{ $self->{matches} }, $_;
158 last if @{ $self->{matches} } == 10;
116 } 159 }
160
161 $row = $line->beg - 1;
117 } 162 }
118 163
119 if (! scalar(@{$self->{urls}})) { 164 return unless @{ $self->{matches} };
120 return;
121 }
122 165
123 my $max = 0; 166 my $width = 0;
124 my $i = scalar( @{$self->{urls}} ) - 1 ;;
125 167
126 my @temp = ();
127
128 for my $url (@{$self->{urls}}) {
129 my $url = "$i-$url";
130 my $xpos = 0;
131
132 if ($self->ncol + (length $url) >= $self->ncol) {
133 $url = substr( $url, 0, $self->ncol );
134 }
135
136 push @temp, $url;
137
138 if( length $url > $max ) {
139 $max = length $url;
140 }
141
142 $i--;
143 }
144
145 @temp = reverse @temp;
146
147 $self->{url_overlay} = $self->overlay(0, 0, $max, scalar( @temp ), urxvt::OVERLAY_RSTYLE, 2);
148 my $i = 0; 168 my $i = 0;
149 for my $url (@temp) { 169 for my $match (@{ $self->{matches} }) {
150 $self->{url_overlay}->set( 0, $i, $url, [(urxvt::OVERLAY_RSTYLE) x length $url]); 170 my $text = $match->[4];
151 $self->{showing} = 1; 171 my $w = $self->strwidth ("$i-$text");
172
173 $width = $w if $w > $width;
152 $i++; 174 $i++;
153 } 175 }
154 176
177 $width = $self->ncol - 2 if $width > $self->ncol - 2;
178
179 $self->{overlay} = $self->overlay (0, 0, $width, scalar (@{ $self->{matches} }), urxvt::OVERLAY_RSTYLE, 2);
180 my $i = 0;
181 for my $match (@{ $self->{matches} }) {
182 my $text = $match->[4];
183
184 $self->{overlay}->set (0, $i, "$i-$text");
185 $i++;
186 }
187
188 $self->enable (key_press => \&matchlist_key_press);
155} 189}
156 190
157sub most_recent { 191sub most_recent {
158 my ($self) = shift; 192 my ($self) = shift;
159 my $row = $self->nrow; 193 my $row = $self->nrow - 1;
160 my @exec; 194 my @exec;
161 while($row-- > $self->top_row) { 195 while ($row >= $self->top_row) {
196 my $line = $self->line ($row);
162 @exec = $self->command_for($row); 197 @exec = $self->command_for($row);
163 last if(@exec); 198 last if(@exec);
199
200 $row = $line->beg - 1;
164 } 201 }
165 if(@exec) { 202 if(@exec) {
166 return $self->exec_async (@exec); 203 return $self->exec_async (@exec);
167 } 204 }
168 () 205 ()
190sub on_start { 227sub on_start {
191 my ($self) = @_; 228 my ($self) = @_;
192 229
193 $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";
194 231
195 $self->{urls} = [];
196 $self->{showing} = 0;
197 $self->{button} = 2; 232 $self->{button} = 2;
198 $self->{state} = 0; 233 $self->{state} = 0;
199 if($self->{argv}[0] || $self->my_resource ("button")) { 234 if($self->{argv}[0] || $self->my_resource ("button")) {
200 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button"); 235 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button");
201 for my $mod (@mods) { 236 for my $mod (@mods) {
226 $self->{matchers} = \@matchers; 261 $self->{matchers} = \@matchers;
227 262
228 () 263 ()
229} 264}
230 265
231sub get_urls_from_line {
232 my ($self, $line) = @_;
233 my @urls;
234 for my $matcher (@{$self->{matchers}}) {
235 while ($line =~ /$matcher->[0]/g) {
236 push @urls, substr( $line, $-[0], $+[0] - $-[0] );
237 }
238 }
239 return @urls;
240}
241
242sub on_line_update { 266sub on_line_update {
243 my ($self, $row) = @_; 267 my ($self, $row) = @_;
244 268
245 # fetch the line that has changed 269 # fetch the line that has changed
246 my $line = $self->line ($row); 270 my $line = $self->line ($row);
247 my $text = $line->t; 271 my $text = $line->t;
248 my $i = 0; 272 my $rend;
249 273
250 # find all urls (if any) 274 # find all urls (if any)
251 for my $matcher (@{$self->{matchers}}) { 275 for my $matcher (@{$self->{matchers}}) {
252 while ($text =~ /$matcher->[0]/g) { 276 while ($text =~ /$matcher->[0]/g) {
253 #print "$&\n"; 277 #print "$&\n";
254 my $rend = $line->r; 278 $rend ||= $line->r;
255 279
256 # mark all characters as underlined. we _must_ not toggle underline, 280 # mark all characters as underlined. we _must_ not toggle underline,
257 # as we might get called on an already-marked url. 281 # as we might get called on an already-marked url.
258 &{$matcher->[2]} 282 &{$matcher->[2]}
259 for @{$rend}[ $-[0] .. $+[0] - 1]; 283 for @{$rend}[$-[0] .. $+[0] - 1];
260
261 $line->r ($rend);
262 } 284 }
263 } 285 }
286
287 $line->r ($rend) if $rend;
264 288
265 () 289 ()
266} 290}
267 291
268sub valid_button { 292sub valid_button {
271 | urxvt::ShiftMask | urxvt::ControlMask; 295 | urxvt::ShiftMask | urxvt::ControlMask;
272 return ($event->{button} == $self->{button} && 296 return ($event->{button} == $self->{button} &&
273 ($event->{state} & $mask) == $self->{state}); 297 ($event->{state} & $mask) == $self->{state});
274} 298}
275 299
276sub command_for { 300sub find_matches {
277 my ($self, $row, $col) = @_; 301 my ($self, $row, $col) = @_;
278 my $line = $self->line ($row); 302 my $line = $self->line ($row);
279 my $text = $line->t; 303 my $text = $line->t;
304 my $off = $line->offset_of ($row, $col) if defined $col;
280 305
306 my @matches;
281 for my $matcher (@{$self->{matchers}}) { 307 for my $matcher (@{$self->{matchers}}) {
282 my $launcher = $matcher->[1] || $self->{launcher}; 308 my $launcher = $matcher->[1] || $self->{launcher};
283 while (($text =~ /$matcher->[0]/g)) { 309 while ($text =~ /$matcher->[0]/g) {
284 my $match = $&; 310 my $match = substr $text, $-[0], $+[0] - $-[0];
285 my @begin = @-; 311 my @begin = @-;
286 my @end = @+; 312 my @end = @+;
313 my @exec;
314
287 if (!defined($col) || ($-[0] <= $col && $+[0] >= $col)) { 315 if (!defined($off) || ($-[0] <= $off && $+[0] >= $off)) {
288 if ($launcher !~ /\$/) { 316 if ($launcher !~ /\$/) {
289 return ($launcher,$match); 317 @exec = ($launcher, $match);
290 } else { 318 } else {
291 # 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...),
292 # but alas, m//g behaves differently in list context. 320 # but alas, m//g behaves differently in list context.
293 my @exec = map { s/\$(\d+)|\$\{(\d+)\}/ 321 @exec = map { s/\$(\d+)|\$\{(\d+)\}/
294 substr($text,$begin[$1||$2],$end[$1||$2]-$begin[$1||$2]) 322 substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2]
295 /egx; $_ } split(/\s+/, $launcher); 323 /egx; $_ } split /\s+/, $launcher;
296 return @exec;
297 } 324 }
325
326 push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ];
298 } 327 }
299 } 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];
300 } 341 }
301 342
302 () 343 ()
303} 344}
304 345
330 371
331 if($row == $event->{row} && abs($col-$event->{col}) < 2 372 if($row == $event->{row} && abs($col-$event->{col}) < 2
332 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) { 373 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) {
333 if($self->valid_button($event)) { 374 if($self->valid_button($event)) {
334 375
335 $self->exec_async (@$cmd); 376 $self->exec_async (@$cmd);
336 377
337 } 378 }
338 } 379 }
339 380
340 1; 381 1;
341} 382}
342 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
343# 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