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.31 by sf-exg, Sun Jun 22 07:51:21 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;
128 } 200 }
129 () 201 ()
130} 202}
131 203
132sub my_resource { 204sub my_resource {
133 my $self = shift; 205 $_[0]->x_resource ("%.$_[1]")
134 $self->x_resource ("$self->{name}.$_[0]");
135} 206}
136 207
137# turn a rendition spec in the resource into a sub that implements it on $_ 208# turn a rendition spec in the resource into a sub that implements it on $_
138sub parse_rend { 209sub parse_rend {
139 my ($self, $str) = @_; 210 my ($self, $str) = @_;
150} 221}
151 222
152sub on_start { 223sub on_start {
153 my ($self) = @_; 224 my ($self) = @_;
154 225
155 ($self->{name} = __PACKAGE__) =~ s/.*:://;
156 $self->{name} =~ tr/_/-/;
157 $self->{launcher} = $self->my_resource ("launcher") || $self->x_resource("url-launcher") || "sensible-browser"; 226 $self->{launcher} = $self->my_resource ("launcher") || $self->x_resource("url-launcher") || "sensible-browser";
158 227
159 $self->{urls} = [];
160 $self->{showing} = 0;
161 $self->{button} = 2; 228 $self->{button} = 2;
162 $self->{state} = 0; 229 $self->{state} = 0;
163 if($self->{argv}[0] || $self->my_resource ("button")) { 230 if($self->{argv}[0] || $self->my_resource ("button")) {
164 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button"); 231 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button");
165 for my $mod (@mods) { 232 for my $mod (@mods) {
170 } elsif($mod eq "S") { 237 } elsif($mod eq "S") {
171 $self->{state} |= urxvt::ShiftMask; 238 $self->{state} |= urxvt::ShiftMask;
172 } elsif($mod eq "M") { 239 } elsif($mod eq "M") {
173 $self->{state} |= $self->ModMetaMask; 240 $self->{state} |= $self->ModMetaMask;
174 } elsif($mod ne "-" && $mod ne " ") { 241 } elsif($mod ne "-" && $mod ne " ") {
175 warn("$mod is invalid in $self->{name}<$self->{argv}[0]>\n"); 242 warn("$mod is invalid in $self->{_name}<$self->{argv}[0]>\n");
176 } 243 }
177 } 244 }
178 } 245 }
179 246
180 my @defaults = ($url); 247 my @defaults = ($url);
190 $self->{matchers} = \@matchers; 257 $self->{matchers} = \@matchers;
191 258
192 () 259 ()
193} 260}
194 261
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 { 262sub on_line_update {
207 my ($self, $row) = @_; 263 my ($self, $row) = @_;
208 264
209 # fetch the line that has changed 265 # fetch the line that has changed
210 my $line = $self->line ($row); 266 my $line = $self->line ($row);
211 my $text = $line->t; 267 my $text = $line->t;
212 my $i = 0;
213 268
214 # find all urls (if any) 269 # find all urls (if any)
215 for my $matcher (@{$self->{matchers}}) { 270 for my $matcher (@{$self->{matchers}}) {
216 while ($text =~ /$matcher->[0]/g) { 271 while ($text =~ /$matcher->[0]/g) {
217 #print "$&\n"; 272 #print "$&\n";
218 my $rend = $line->r; 273 my $rend = $line->r;
219 274
220 # mark all characters as underlined. we _must_ not toggle underline, 275 # mark all characters as underlined. we _must_ not toggle underline,
221 # as we might get called on an already-marked url. 276 # as we might get called on an already-marked url.
222 &{$matcher->[2]} 277 &{$matcher->[2]}
223 for @{$rend}[ $-[0] .. $+[0] - 1]; 278 for @{$rend}[$-[0] .. $+[0] - 1];
224 279
225 $line->r ($rend); 280 $line->r ($rend);
226 } 281 }
227 } 282 }
228 283
235 | urxvt::ShiftMask | urxvt::ControlMask; 290 | urxvt::ShiftMask | urxvt::ControlMask;
236 return ($event->{button} == $self->{button} && 291 return ($event->{button} == $self->{button} &&
237 ($event->{state} & $mask) == $self->{state}); 292 ($event->{state} & $mask) == $self->{state});
238} 293}
239 294
240sub command_for { 295sub find_matches {
241 my ($self, $row, $col) = @_; 296 my ($self, $row, $col) = @_;
242 my $line = $self->line ($row); 297 my $line = $self->line ($row);
243 my $text = $line->t; 298 my $text = $line->t;
299 my $off = $line->offset_of ($row, $col) if defined $col;
244 300
301 my @matches;
245 for my $matcher (@{$self->{matchers}}) { 302 for my $matcher (@{$self->{matchers}}) {
246 my $launcher = $matcher->[1] || $self->{launcher}; 303 my $launcher = $matcher->[1] || $self->{launcher};
247 while (($text =~ /$matcher->[0]/g)) { 304 while ($text =~ /$matcher->[0]/g) {
248 my $match = $&; 305 my $match = substr $text, $-[0], $+[0] - $-[0];
249 my @begin = @-; 306 my @begin = @-;
250 my @end = @+; 307 my @end = @+;
308 my @exec;
309
251 if (!defined($col) || ($-[0] <= $col && $+[0] >= $col)) { 310 if (!defined($off) || ($-[0] <= $off && $+[0] >= $off)) {
252 if ($launcher !~ /\$/) { 311 if ($launcher !~ /\$/) {
253 return ($launcher,$match); 312 @exec = ($launcher, $match);
254 } else { 313 } else {
255 # It'd be nice to just access a list like ($&,$1,$2...), 314 # It'd be nice to just access a list like ($&,$1,$2...),
256 # but alas, m//g behaves differently in list context. 315 # but alas, m//g behaves differently in list context.
257 my @exec = map { s/\$(\d+)|\$\{(\d+)\}/ 316 @exec = map { s/\$(\d+)|\$\{(\d+)\}/
258 substr($text,$begin[$1||$2],$end[$1||$2]-$begin[$1||$2]) 317 substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2]
259 /egx; $_ } split(/\s+/, $launcher); 318 /egx; $_ } split /\s+/, $launcher;
260 return @exec;
261 } 319 }
320
321 push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ];
262 } 322 }
263 } 323 }
324 }
325
326 @matches;
327}
328
329sub command_for {
330 my ($self, $row, $col) = @_;
331
332 my @matches = $self->find_matches ($row, $col);
333 if (@matches) {
334 my @match = @{ $matches[0] };
335 return @match[5 .. $#match];
264 } 336 }
265 337
266 () 338 ()
267} 339}
268 340
294 366
295 if($row == $event->{row} && abs($col-$event->{col}) < 2 367 if($row == $event->{row} && abs($col-$event->{col}) < 2
296 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) { 368 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) {
297 if($self->valid_button($event)) { 369 if($self->valid_button($event)) {
298 370
299 $self->exec_async (@$cmd); 371 $self->exec_async (@$cmd);
300 372
301 } 373 }
302 } 374 }
303 375
304 1; 376 1;
305} 377}
306 378
379sub select_enter {
380 my ($self) = @_;
381
382 $self->{view_start} = $self->view_start;
383 $self->{pty_ev_events} = $self->pty_ev_events (urxvt::EV_NONE);
384 $self->{cur_row} = $self->nrow - 1;
385
386 $self->enable (
387 key_press => \&select_key_press,
388 refresh_begin => \&select_refresh,
389 refresh_end => \&select_refresh,
390 );
391
392 $self->{overlay} = $self->overlay (0, -1, $self->ncol, 1, urxvt::OVERLAY_RSTYLE, 0);
393 $self->{overlay}->set (0, 0, "match-select");
394}
395
396sub select_leave {
397 my ($self) = @_;
398
399 $self->disable ("key_press", "refresh_begin", "refresh_end");
400 $self->pty_ev_events ($self->{pty_ev_events});
401
402 delete $self->{overlay};
403 delete $self->{matches};
404 delete $self->{id};
405}
406
407sub select_search {
408 my ($self, $dir, $row) = @_;
409
410 while ($self->nrow > $row && $row >= $self->top_row) {
411 my $line = $self->line ($row)
412 or last;
413
414 my @matches = $self->find_matches ($row);
415 if (@matches) {
416 @matches = sort { $a->[0] <=> $b->[0] or $a->[1] <=> $b->[1] } @matches;
417 $self->{matches} = \@matches;
418 $self->{cur_row} = $row;
419 $self->{id} = $dir < 0 ? @{ $self->{matches} } - 1 : 0;
420 $self->view_start (List::Util::min 0, $row - ($self->nrow >> 1));
421 $self->want_refresh;
422 return;
423 }
424
425 $row = $dir < 0 ? $line->beg - 1 : $line->end + 1;
426 }
427
428 $self->scr_bell;
429}
430
431sub select_refresh {
432 my ($self) = @_;
433
434 return unless $self->{matches};
435
436 my $cur = $self->{matches}[$self->{id}];
437 $self->scr_xor_span (@$cur[0 .. 3], urxvt::RS_RVid);
438
439 ()
440}
441
442sub select_key_press {
443 my ($self, $event, $keysym, $string) = @_;
444
445 if ($keysym == 0xff0d || $keysym == 0xff8d) { # enter
446 if ($self->{matches}) {
447 my @match = @{ $self->{matches}[$self->{id}] };
448 $self->exec_async (@match[5 .. $#match]);
449 }
450 $self->select_leave;
451 } elsif ($keysym == 0x79) { # y
452 if ($self->{matches}) {
453 $self->selection ($self->{matches}[$self->{id}][4], 1);
454 $self->selection_grab (urxvt::CurrentTime, 1);
455 }
456 $self->select_leave;
457 } elsif ($keysym == 0xff1b) { # escape
458 $self->view_start ($self->{view_start});
459 $self->select_leave;
460 } elsif ($keysym == 0xff50) { # home
461 $self->select_search (+1, $self->top_row)
462 } elsif ($keysym == 0xff57) { # end
463 $self->select_search (-1, $self->nrow - 1)
464 } elsif ($keysym == 0xff52) { # up
465 if ($self->{id} > 0) {
466 $self->{id}--;
467 $self->want_refresh;
468 } else {
469 my $line = $self->line ($self->{cur_row});
470 $self->select_search (-1, $line->beg - 1)
471 if $line->beg > $self->top_row;
472 }
473 } elsif ($keysym == 0xff54) { # down
474 if ($self->{id} < @{ $self->{matches} } - 1) {
475 $self->{id}++;
476 $self->want_refresh;
477 } else {
478 my $line = $self->line ($self->{cur_row});
479 $self->select_search (+1, $line->end + 1)
480 if $line->end < $self->nrow;
481 }
482 }
483
484 1
485}
486
307# vim:set sw=3 sts=3 et: 487# vim:set sw=3 sts=3 et:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines