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.8 by root, Wed Jun 6 15:06:41 2012 UTC vs.
Revision 1.33 by sf-exg, Mon Oct 13 19:39:42 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 5
6#:META:X_RESOURCE:%.launcher:string:default launcher command 6#:META:RESOURCE:%.launcher:string:default launcher command
7#:META:X_RESOURCE:%.button:string:the button, yeah 7#:META:RESOURCE:%.button:string:the button, yeah
8#:META:X_RESOURCE:%.pattern.:string:extra pattern to match 8#:META:RESOURCE:%.pattern.:string:extra pattern to match
9#:META:X_RESOURCE:%.launcher.:string:custom launcher for pattern 9#:META:RESOURCE:%.launcher.:string:custom launcher for pattern
10#:META:X_RESOURCE:%.rend.:string:custom rednition for pattern 10#:META:RESOURCE:%.rend.:string:custom rendition for pattern
11
12=head1 NAME
13
14matcher - match strings in terminal output and change their rendition
15
16=head1 DESCRIPTION
17
18Uses per-line display filtering (C<on_line_update>) to underline text
19matching a certain pattern and make it clickable. When clicked with the
20mouse button specified in the C<matcher.button> resource (default 2, or
21middle), the program specified in the C<matcher.launcher> resource
22(default, the C<url-launcher> resource, C<sensible-browser>) will be started
23with the matched text as first argument. The default configuration is
24suitable for matching URLs and launching a web browser, like the
25former "mark-urls" extension.
26
27The default pattern to match URLs can be overridden with the
28C<matcher.pattern.0> resource, and additional patterns can be specified
29with numbered patterns, in a manner similar to the "selection" extension.
30The launcher can also be overridden on a per-pattern basis.
31
32It 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
34"matcher:list" as seen in the example below.
35
36The 'matcher:select' action enables a mode in which it is possible to
37iterate over the matches using the keyboard and either activate them
38or copy them to the clipboard. While the mode is active, normal terminal
39input/output is suspended and the following bindings are recognized:
40
41=over 4
42
43=item C<Up>
44
45Search for a match upwards.
46
47=item C<Down>
48
49Search for a match downwards.
50
51=item C<Home>
52
53Jump to the topmost match.
54
55=item C<End>
56
57Jump to the bottommost match.
58
59=item C<Escape>
60
61Leave the mode and return to the point where search was started.
62
63=item C<Enter>
64
65Activate the current match.
66
67=item C<y>
68
69Copy the current match to the clipboard.
70
71=back
72
73Example: load and use the matcher extension with defaults.
74
75 URxvt.perl-ext: default,matcher
76
77Example: use a custom configuration.
78
79 URxvt.url-launcher: sensible-browser
80 URxvt.keysym.C-Delete: matcher:last
81 URxvt.keysym.M-Delete: matcher:list
82 URxvt.matcher.button: 1
83 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
84 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
85 URxvt.matcher.launcher.2: gvim +$2 $1
86
87=cut
11 88
12my $url = 89my $url =
13 qr{ 90 qr{
14 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.) 91 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.)
15 [a-zA-Z0-9\-\@;\/?:&=%\$_.+!*\x27,~#]* 92 [\w\-\@;\/?:&=%\$.+!*\x27,~#]*
16 ( 93 (
17 \([a-zA-Z0-9\-\@;\/?:&=%\$_.+!*\x27,~#]*\)| # Allow a pair of matched parentheses 94 \([\w\-\@;\/?:&=%\$.+!*\x27,~#]*\)| # Allow a pair of matched parentheses
18 [a-zA-Z0-9\-\@;\/?:&=%\$_+*~] # exclude some trailing characters (heuristic) 95 [\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic)
19 )+ 96 )+
20 }x; 97 }x;
21 98
22sub on_key_press { 99sub matchlist_key_press {
23 my ($self, $event, $keysym, $octets) = @_; 100 my ($self, $event, $keysym, $octets) = @_;
24 101
25 if (! $self->{showing} ) { 102 delete $self->{overlay};
26 return; 103 $self->disable ("key_press");
27 }
28 104
29 my $i = ($keysym == 96 ? 0 : $keysym - 48); 105 my $i = ($keysym == 96 ? 0 : $keysym - 48);
30 if (($i > scalar(@{$self->{urls}})) || ($i < 0)) { 106 if ($i >= 0 && $i < @{ $self->{matches} }) {
31 $self->matchlist(); 107 my @exec = @{ $self->{matches}[$i] };
32 return; 108 $self->exec_async (@exec[5 .. $#exec]);
109 }
110
33 } 111 1
34
35 my @args = ($self->{urls}[ -$i-1 ]);
36 $self->matchlist();
37
38 $self->exec_async( $self->{launcher}, @args );
39} 112}
40 113
114# backwards compat
41sub on_user_command { 115sub on_user_command {
42 my ($self, $cmd) = @_; 116 my ($self, $cmd) = @_;
43 117
44 if($cmd =~ s/^matcher:list\b//) { 118 if ($cmd =~ s/^matcher:list\b//) {
45 $self->matchlist(); 119 $self->matchlist;
46 } else { 120 } else {
47 if($cmd =~ s/^matcher:last\b//) { 121 if ($cmd =~ s/^matcher:last\b//) {
48 $self->most_recent; 122 $self->most_recent;
49 }
50 # For backward compatibility
51 else {
52 if($cmd =~ s/^matcher\b//) { 123 } elsif ($cmd =~ s/^matcher\b//) {
124 # for backward compatibility
53 $self->most_recent; 125 $self->most_recent;
54 } 126 }
55 } 127 }
128
129 ()
130}
131
132sub on_action {
133 my ($self, $action) = @_;
134
135 if ($action eq "list") {
136 $self->matchlist;
137 } elsif ($action eq "last") {
138 $self->most_recent;
139 } elsif ($action eq "select") {
140 $self->select_enter;
56 } 141 }
142
57 () 143 ()
58} 144}
59 145
60sub matchlist { 146sub matchlist {
61 my ($self) = @_; 147 my ($self) = @_;
62 if ( $self->{showing} ) { 148
63 $self->{url_overlay}->hide(); 149 $self->{matches} = [];
64 $self->{showing} = 0; 150 my $row = $self->nrow - 1;
65 return; 151 while ($row >= 0 && @{ $self->{matches} } < 10) {
66 }
67 @{$self->{urls}} = ();
68 my $line;
69 for (my $i = 0; $i < $self->nrow; $i ++) {
70 $line = $self->line($i); 152 my $line = $self->line ($row);
71 next if ($line->beg != $i); 153 my @matches = $self->find_matches ($row);
72 for my $url ($self->get_urls_from_line($line->t)) { 154
73 if (scalar(@{$self->{urls}}) == 10) { 155 for (sort { $b->[0] <=> $a->[0] or $b->[1] <=> $a->[1] } @matches) {
74 shift @{$self->{urls}};
75 }
76 push @{$self->{urls}}, $url; 156 push @{ $self->{matches} }, $_;
157 last if @{ $self->{matches} } == 10;
77 } 158 }
159
160 $row = $line->beg - 1;
78 } 161 }
79 162
80 if (! scalar(@{$self->{urls}})) { 163 return unless @{ $self->{matches} };
81 return;
82 }
83 164
84 my $max = 0; 165 my $width = 0;
85 my $i = scalar( @{$self->{urls}} ) - 1 ;;
86 166
87 my @temp = ();
88
89 for my $url (@{$self->{urls}}) {
90 my $url = "$i-$url";
91 my $xpos = 0;
92
93 if ($self->ncol + (length $url) >= $self->ncol) {
94 $url = substr( $url, 0, $self->ncol );
95 }
96
97 push @temp, $url;
98
99 if( length $url > $max ) {
100 $max = length $url;
101 }
102
103 $i--;
104 }
105
106 @temp = reverse @temp;
107
108 $self->{url_overlay} = $self->overlay(0, 0, $max, scalar( @temp ), urxvt::OVERLAY_RSTYLE, 2);
109 my $i = 0; 167 my $i = 0;
110 for my $url (@temp) { 168 for my $match (@{ $self->{matches} }) {
111 $self->{url_overlay}->set( 0, $i, $url, [(urxvt::OVERLAY_RSTYLE) x length $url]); 169 my $text = $match->[4];
112 $self->{showing} = 1; 170 my $w = $self->strwidth ("$i-$text");
171
172 $width = $w if $w > $width;
113 $i++; 173 $i++;
114 } 174 }
115 175
176 $width = $self->ncol - 2 if $width > $self->ncol - 2;
177
178 $self->{overlay} = $self->overlay (0, 0, $width, scalar (@{ $self->{matches} }), urxvt::OVERLAY_RSTYLE, 2);
179 my $i = 0;
180 for my $match (@{ $self->{matches} }) {
181 my $text = $match->[4];
182
183 $self->{overlay}->set (0, $i, "$i-$text");
184 $i++;
185 }
186
187 $self->enable (key_press => \&matchlist_key_press);
116} 188}
117 189
118sub most_recent { 190sub most_recent {
119 my ($self) = shift; 191 my ($self) = shift;
120 my $row = $self->nrow; 192 my $row = $self->nrow - 1;
121 my @exec; 193 my @exec;
122 while($row-- > $self->top_row) { 194 while ($row >= $self->top_row) {
195 my $line = $self->line ($row);
123 @exec = $self->command_for($row); 196 @exec = $self->command_for($row);
124 last if(@exec); 197 last if(@exec);
198
199 $row = $line->beg - 1;
125 } 200 }
126 if(@exec) { 201 if(@exec) {
127 return $self->exec_async (@exec); 202 return $self->exec_async (@exec);
128 } 203 }
129 () 204 ()
130} 205}
131 206
132sub my_resource { 207sub my_resource {
133 my $self = shift; 208 $_[0]->x_resource ("%.$_[1]")
134 $self->x_resource ("$self->{name}.$_[0]");
135} 209}
136 210
137# turn a rendition spec in the resource into a sub that implements it on $_ 211# turn a rendition spec in the resource into a sub that implements it on $_
138sub parse_rend { 212sub parse_rend {
139 my ($self, $str) = @_; 213 my ($self, $str) = @_;
150} 224}
151 225
152sub on_start { 226sub on_start {
153 my ($self) = @_; 227 my ($self) = @_;
154 228
155 ($self->{name} = __PACKAGE__) =~ s/.*:://;
156 $self->{name} =~ tr/_/-/;
157 $self->{launcher} = $self->my_resource ("launcher") || $self->x_resource("url-launcher") || "sensible-browser"; 229 $self->{launcher} = $self->my_resource ("launcher") || $self->x_resource("url-launcher") || "sensible-browser";
158 230
159 $self->{urls} = [];
160 $self->{showing} = 0;
161 $self->{button} = 2; 231 $self->{button} = 2;
162 $self->{state} = 0; 232 $self->{state} = 0;
163 if($self->{argv}[0] || $self->my_resource ("button")) { 233 if($self->{argv}[0] || $self->my_resource ("button")) {
164 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button"); 234 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button");
165 for my $mod (@mods) { 235 for my $mod (@mods) {
170 } elsif($mod eq "S") { 240 } elsif($mod eq "S") {
171 $self->{state} |= urxvt::ShiftMask; 241 $self->{state} |= urxvt::ShiftMask;
172 } elsif($mod eq "M") { 242 } elsif($mod eq "M") {
173 $self->{state} |= $self->ModMetaMask; 243 $self->{state} |= $self->ModMetaMask;
174 } elsif($mod ne "-" && $mod ne " ") { 244 } elsif($mod ne "-" && $mod ne " ") {
175 warn("$mod is invalid in $self->{name}<$self->{argv}[0]>\n"); 245 warn("$mod is invalid in $self->{_name}<$self->{argv}[0]>\n");
176 } 246 }
177 } 247 }
178 } 248 }
179 249
180 my @defaults = ($url); 250 my @defaults = ($url);
190 $self->{matchers} = \@matchers; 260 $self->{matchers} = \@matchers;
191 261
192 () 262 ()
193} 263}
194 264
195sub get_urls_from_line {
196 my ($self, $line) = @_;
197 my @urls;
198 for my $matcher (@{$self->{matchers}}) {
199 while ($line =~ /$matcher->[0]/g) {
200 push @urls, substr( $line, $-[0], $+[0] - $-[0] );
201 }
202 }
203 return @urls;
204}
205
206sub on_line_update { 265sub on_line_update {
207 my ($self, $row) = @_; 266 my ($self, $row) = @_;
208 267
209 # fetch the line that has changed 268 # fetch the line that has changed
210 my $line = $self->line ($row); 269 my $line = $self->line ($row);
211 my $text = $line->t; 270 my $text = $line->t;
212 my $i = 0; 271 my $rend;
213 272
214 # find all urls (if any) 273 # find all urls (if any)
215 for my $matcher (@{$self->{matchers}}) { 274 for my $matcher (@{$self->{matchers}}) {
216 while ($text =~ /$matcher->[0]/g) { 275 while ($text =~ /$matcher->[0]/g) {
217 #print "$&\n"; 276 #print "$&\n";
218 my $rend = $line->r; 277 $rend ||= $line->r;
219 278
220 # mark all characters as underlined. we _must_ not toggle underline, 279 # mark all characters as underlined. we _must_ not toggle underline,
221 # as we might get called on an already-marked url. 280 # as we might get called on an already-marked url.
222 &{$matcher->[2]} 281 &{$matcher->[2]}
223 for @{$rend}[ $-[0] .. $+[0] - 1]; 282 for @{$rend}[$-[0] .. $+[0] - 1];
224
225 $line->r ($rend);
226 } 283 }
227 } 284 }
285
286 $line->r ($rend) if $rend;
228 287
229 () 288 ()
230} 289}
231 290
232sub valid_button { 291sub valid_button {
235 | urxvt::ShiftMask | urxvt::ControlMask; 294 | urxvt::ShiftMask | urxvt::ControlMask;
236 return ($event->{button} == $self->{button} && 295 return ($event->{button} == $self->{button} &&
237 ($event->{state} & $mask) == $self->{state}); 296 ($event->{state} & $mask) == $self->{state});
238} 297}
239 298
240sub command_for { 299sub find_matches {
241 my ($self, $row, $col) = @_; 300 my ($self, $row, $col) = @_;
242 my $line = $self->line ($row); 301 my $line = $self->line ($row);
243 my $text = $line->t; 302 my $text = $line->t;
303 my $off = $line->offset_of ($row, $col) if defined $col;
244 304
305 my @matches;
245 for my $matcher (@{$self->{matchers}}) { 306 for my $matcher (@{$self->{matchers}}) {
246 my $launcher = $matcher->[1] || $self->{launcher}; 307 my $launcher = $matcher->[1] || $self->{launcher};
247 while (($text =~ /$matcher->[0]/g)) { 308 while ($text =~ /$matcher->[0]/g) {
248 my $match = $&; 309 my $match = substr $text, $-[0], $+[0] - $-[0];
249 my @begin = @-; 310 my @begin = @-;
250 my @end = @+; 311 my @end = @+;
312 my @exec;
313
251 if (!defined($col) || ($-[0] <= $col && $+[0] >= $col)) { 314 if (!defined($off) || ($-[0] <= $off && $+[0] >= $off)) {
252 if ($launcher !~ /\$/) { 315 if ($launcher !~ /\$/) {
253 return ($launcher,$match); 316 @exec = ($launcher, $match);
254 } else { 317 } else {
255 # It'd be nice to just access a list like ($&,$1,$2...), 318 # It'd be nice to just access a list like ($&,$1,$2...),
256 # but alas, m//g behaves differently in list context. 319 # but alas, m//g behaves differently in list context.
257 my @exec = map { s/\$(\d+)|\$\{(\d+)\}/ 320 @exec = map { s/\$(\d+)|\$\{(\d+)\}/
258 substr($text,$begin[$1||$2],$end[$1||$2]-$begin[$1||$2]) 321 substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2]
259 /egx; $_ } split(/\s+/, $launcher); 322 /egx; $_ } split /\s+/, $launcher;
260 return @exec;
261 } 323 }
324
325 push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ];
262 } 326 }
263 } 327 }
328 }
329
330 @matches;
331}
332
333sub command_for {
334 my ($self, $row, $col) = @_;
335
336 my @matches = $self->find_matches ($row, $col);
337 if (@matches) {
338 my @match = @{ $matches[0] };
339 return @match[5 .. $#match];
264 } 340 }
265 341
266 () 342 ()
267} 343}
268 344
294 370
295 if($row == $event->{row} && abs($col-$event->{col}) < 2 371 if($row == $event->{row} && abs($col-$event->{col}) < 2
296 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) { 372 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) {
297 if($self->valid_button($event)) { 373 if($self->valid_button($event)) {
298 374
299 $self->exec_async (@$cmd); 375 $self->exec_async (@$cmd);
300 376
301 } 377 }
302 } 378 }
303 379
304 1; 380 1;
305} 381}
306 382
383sub select_enter {
384 my ($self) = @_;
385
386 $self->{view_start} = $self->view_start;
387 $self->{pty_ev_events} = $self->pty_ev_events (urxvt::EV_NONE);
388 $self->{cur_row} = $self->nrow - 1;
389
390 $self->enable (
391 key_press => \&select_key_press,
392 refresh_begin => \&select_refresh,
393 refresh_end => \&select_refresh,
394 );
395
396 $self->{overlay} = $self->overlay (0, -1, $self->ncol, 1, urxvt::OVERLAY_RSTYLE, 0);
397 $self->{overlay}->set (0, 0, "match-select");
398}
399
400sub select_leave {
401 my ($self) = @_;
402
403 $self->disable ("key_press", "refresh_begin", "refresh_end");
404 $self->pty_ev_events ($self->{pty_ev_events});
405
406 delete $self->{overlay};
407 delete $self->{matches};
408 delete $self->{id};
409}
410
411sub select_search {
412 my ($self, $dir, $row) = @_;
413
414 while ($self->nrow > $row && $row >= $self->top_row) {
415 my $line = $self->line ($row)
416 or last;
417
418 my @matches = $self->find_matches ($row);
419 if (@matches) {
420 @matches = sort { $a->[0] <=> $b->[0] or $a->[1] <=> $b->[1] } @matches;
421 $self->{matches} = \@matches;
422 $self->{cur_row} = $row;
423 $self->{id} = $dir < 0 ? @{ $self->{matches} } - 1 : 0;
424 $self->view_start (List::Util::min 0, $row - ($self->nrow >> 1));
425 $self->want_refresh;
426 return;
427 }
428
429 $row = $dir < 0 ? $line->beg - 1 : $line->end + 1;
430 }
431
432 $self->scr_bell;
433}
434
435sub select_refresh {
436 my ($self) = @_;
437
438 return unless $self->{matches};
439
440 my $cur = $self->{matches}[$self->{id}];
441 $self->scr_xor_span (@$cur[0 .. 3], urxvt::RS_RVid);
442
443 ()
444}
445
446sub select_key_press {
447 my ($self, $event, $keysym, $string) = @_;
448
449 if ($keysym == 0xff0d || $keysym == 0xff8d) { # enter
450 if ($self->{matches}) {
451 my @match = @{ $self->{matches}[$self->{id}] };
452 $self->exec_async (@match[5 .. $#match]);
453 }
454 $self->select_leave;
455 } elsif ($keysym == 0x79) { # y
456 if ($self->{matches}) {
457 $self->selection ($self->{matches}[$self->{id}][4], 1);
458 $self->selection_grab (urxvt::CurrentTime, 1);
459 }
460 $self->select_leave;
461 } elsif ($keysym == 0xff1b) { # escape
462 $self->view_start ($self->{view_start});
463 $self->select_leave;
464 } elsif ($keysym == 0xff50) { # home
465 $self->select_search (+1, $self->top_row)
466 } elsif ($keysym == 0xff57) { # end
467 $self->select_search (-1, $self->nrow - 1)
468 } elsif ($keysym == 0xff52) { # up
469 if ($self->{id} > 0) {
470 $self->{id}--;
471 $self->want_refresh;
472 } else {
473 my $line = $self->line ($self->{cur_row});
474 $self->select_search (-1, $line->beg - 1)
475 if $line->beg > $self->top_row;
476 }
477 } elsif ($keysym == 0xff54) { # down
478 if ($self->{id} < @{ $self->{matches} } - 1) {
479 $self->{id}++;
480 $self->want_refresh;
481 } else {
482 my $line = $self->line ($self->{cur_row});
483 $self->select_search (+1, $line->end + 1)
484 if $line->end < $self->nrow;
485 }
486 }
487
488 1
489}
490
307# vim:set sw=3 sts=3 et: 491# vim:set sw=3 sts=3 et:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines