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.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 11
12=head1 NAME 12=head1 NAME
13 13
14matcher - match strings in terminal output and change their rendition 14matcher - match strings in terminal output and change their rendition
15 15
17 17
18Uses per-line display filtering (C<on_line_update>) to underline text 18Uses per-line display filtering (C<on_line_update>) to underline text
19matching a certain pattern and make it clickable. When clicked with the 19matching a certain pattern and make it clickable. When clicked with the
20mouse button specified in the C<matcher.button> resource (default 2, or 20mouse button specified in the C<matcher.button> resource (default 2, or
21middle), the program specified in the C<matcher.launcher> resource 21middle), the program specified in the C<matcher.launcher> resource
22(default, the C<urlLauncher> resource, C<sensible-browser>) will be started 22(default, the C<url-launcher> resource, C<sensible-browser>) will be started
23with the matched text as first argument. The default configuration is 23with the matched text as first argument. The default configuration is
24suitable for matching URLs and launching a web browser, like the 24suitable for matching URLs and launching a web browser, like the
25former "mark-urls" extension. 25former "mark-urls" extension.
26 26
27The default pattern to match URLs can be overridden with the 27The default pattern to match URLs can be overridden with the
28C<matcher.pattern.0> resource, and additional patterns can be specified 28C<matcher.pattern.0> resource, and additional patterns can be specified
29with numbered patterns, in a manner similar to the "selection" extension. 29with numbered patterns, in a manner similar to the "selection" extension.
30The launcher can also be overridden on a per-pattern basis. 30The launcher can also be overridden on a per-pattern basis.
31 31
32It is possible to activate the most recently seen match or a list of matches 32It 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 33from the keyboard. Simply bind a keysym to "matcher:last" or
34"perl:matcher:list" as seen in the example below. 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
35 72
36Example: load and use the matcher extension with defaults. 73Example: load and use the matcher extension with defaults.
37 74
38 URxvt.perl-ext: default,matcher 75 URxvt.perl-ext: default,matcher
39 76
40Example: use a custom configuration. 77Example: use a custom configuration.
41 78
42 URxvt.url-launcher: sensible-browser 79 URxvt.url-launcher: sensible-browser
43 URxvt.keysym.C-Delete: perl:matcher:last 80 URxvt.keysym.C-Delete: matcher:last
44 URxvt.keysym.M-Delete: perl:matcher:list 81 URxvt.keysym.M-Delete: matcher:list
45 URxvt.matcher.button: 1 82 URxvt.matcher.button: 1
46 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] 83 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
47 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) 84 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
48 URxvt.matcher.launcher.2: gvim +$2 $1 85 URxvt.matcher.launcher.2: gvim +$2 $1
49 86
57 \([\w\-\@;\/?:&=%\$.+!*\x27,~#]*\)| # Allow a pair of matched parentheses 94 \([\w\-\@;\/?:&=%\$.+!*\x27,~#]*\)| # Allow a pair of matched parentheses
58 [\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic) 95 [\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic)
59 )+ 96 )+
60 }x; 97 }x;
61 98
62sub on_key_press { 99sub matchlist_key_press {
63 my ($self, $event, $keysym, $octets) = @_; 100 my ($self, $event, $keysym, $octets) = @_;
64 101
65 if (! $self->{showing} ) { 102 delete $self->{overlay};
66 return; 103 $self->disable ("key_press");
67 }
68 104
69 my $i = ($keysym == 96 ? 0 : $keysym - 48); 105 my $i = ($keysym == 96 ? 0 : $keysym - 48);
70 if (($i > scalar(@{$self->{urls}})) || ($i < 0)) { 106 if ($i >= 0 && $i < @{ $self->{matches} }) {
71 $self->matchlist(); 107 my @exec = @{ $self->{matches}[$i] };
72 return; 108 $self->exec_async (@exec[5 .. $#exec]);
109 }
110
73 } 111 1
74
75 my @args = ($self->{urls}[ -$i-1 ]);
76 $self->matchlist();
77
78 $self->exec_async( $self->{launcher}, @args );
79} 112}
80 113
81# backwards compat 114# backwards compat
82sub on_user_command { 115sub on_user_command {
83 my ($self, $cmd) = @_; 116 my ($self, $cmd) = @_;
94 } 127 }
95 128
96 () 129 ()
97} 130}
98 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;
141 }
142
143 ()
144}
145
99sub matchlist { 146sub matchlist {
100 my ($self) = @_; 147 my ($self) = @_;
101 if ( $self->{showing} ) { 148
102 $self->{url_overlay}->hide; 149 $self->{matches} = [];
103 $self->{showing} = 0; 150 my $row = $self->nrow - 1;
104 return; 151 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); 152 my $line = $self->line ($row);
110 next if ($line->beg != $i); 153 my @matches = $self->find_matches ($row);
111 for my $url ($self->get_urls_from_line($line->t)) { 154
112 if (scalar(@{$self->{urls}}) == 10) { 155 for (sort { $b->[0] <=> $a->[0] or $b->[1] <=> $a->[1] } @matches) {
113 shift @{$self->{urls}};
114 }
115 push @{$self->{urls}}, $url; 156 push @{ $self->{matches} }, $_;
157 last if @{ $self->{matches} } == 10;
116 } 158 }
159
160 $row = $line->beg - 1;
117 } 161 }
118 162
119 if (! scalar(@{$self->{urls}})) { 163 return unless @{ $self->{matches} };
120 return;
121 }
122 164
123 my $max = 0; 165 my $width = 0;
124 my $i = scalar( @{$self->{urls}} ) - 1 ;;
125 166
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; 167 my $i = 0;
149 for my $url (@temp) { 168 for my $match (@{ $self->{matches} }) {
150 $self->{url_overlay}->set( 0, $i, $url, [(urxvt::OVERLAY_RSTYLE) x length $url]); 169 my $text = $match->[4];
151 $self->{showing} = 1; 170 my $w = $self->strwidth ("$i-$text");
171
172 $width = $w if $w > $width;
152 $i++; 173 $i++;
153 } 174 }
154 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);
155} 188}
156 189
157sub most_recent { 190sub most_recent {
158 my ($self) = shift; 191 my ($self) = shift;
159 my $row = $self->nrow; 192 my $row = $self->nrow - 1;
160 my @exec; 193 my @exec;
161 while($row-- > $self->top_row) { 194 while ($row >= $self->top_row) {
195 my $line = $self->line ($row);
162 @exec = $self->command_for($row); 196 @exec = $self->command_for($row);
163 last if(@exec); 197 last if(@exec);
198
199 $row = $line->beg - 1;
164 } 200 }
165 if(@exec) { 201 if(@exec) {
166 return $self->exec_async (@exec); 202 return $self->exec_async (@exec);
167 } 203 }
168 () 204 ()
190sub on_start { 226sub on_start {
191 my ($self) = @_; 227 my ($self) = @_;
192 228
193 $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";
194 230
195 $self->{urls} = [];
196 $self->{showing} = 0;
197 $self->{button} = 2; 231 $self->{button} = 2;
198 $self->{state} = 0; 232 $self->{state} = 0;
199 if($self->{argv}[0] || $self->my_resource ("button")) { 233 if($self->{argv}[0] || $self->my_resource ("button")) {
200 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button"); 234 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button");
201 for my $mod (@mods) { 235 for my $mod (@mods) {
226 $self->{matchers} = \@matchers; 260 $self->{matchers} = \@matchers;
227 261
228 () 262 ()
229} 263}
230 264
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 { 265sub on_line_update {
243 my ($self, $row) = @_; 266 my ($self, $row) = @_;
244 267
245 # fetch the line that has changed 268 # fetch the line that has changed
246 my $line = $self->line ($row); 269 my $line = $self->line ($row);
247 my $text = $line->t; 270 my $text = $line->t;
248 my $i = 0; 271 my $rend;
249 272
250 # find all urls (if any) 273 # find all urls (if any)
251 for my $matcher (@{$self->{matchers}}) { 274 for my $matcher (@{$self->{matchers}}) {
252 while ($text =~ /$matcher->[0]/g) { 275 while ($text =~ /$matcher->[0]/g) {
253 #print "$&\n"; 276 #print "$&\n";
254 my $rend = $line->r; 277 $rend ||= $line->r;
255 278
256 # mark all characters as underlined. we _must_ not toggle underline, 279 # mark all characters as underlined. we _must_ not toggle underline,
257 # as we might get called on an already-marked url. 280 # as we might get called on an already-marked url.
258 &{$matcher->[2]} 281 &{$matcher->[2]}
259 for @{$rend}[ $-[0] .. $+[0] - 1]; 282 for @{$rend}[$-[0] .. $+[0] - 1];
260
261 $line->r ($rend);
262 } 283 }
263 } 284 }
285
286 $line->r ($rend) if $rend;
264 287
265 () 288 ()
266} 289}
267 290
268sub valid_button { 291sub valid_button {
271 | urxvt::ShiftMask | urxvt::ControlMask; 294 | urxvt::ShiftMask | urxvt::ControlMask;
272 return ($event->{button} == $self->{button} && 295 return ($event->{button} == $self->{button} &&
273 ($event->{state} & $mask) == $self->{state}); 296 ($event->{state} & $mask) == $self->{state});
274} 297}
275 298
276sub command_for { 299sub find_matches {
277 my ($self, $row, $col) = @_; 300 my ($self, $row, $col) = @_;
278 my $line = $self->line ($row); 301 my $line = $self->line ($row);
279 my $text = $line->t; 302 my $text = $line->t;
303 my $off = $line->offset_of ($row, $col) if defined $col;
280 304
305 my @matches;
281 for my $matcher (@{$self->{matchers}}) { 306 for my $matcher (@{$self->{matchers}}) {
282 my $launcher = $matcher->[1] || $self->{launcher}; 307 my $launcher = $matcher->[1] || $self->{launcher};
283 while (($text =~ /$matcher->[0]/g)) { 308 while ($text =~ /$matcher->[0]/g) {
284 my $match = $&; 309 my $match = substr $text, $-[0], $+[0] - $-[0];
285 my @begin = @-; 310 my @begin = @-;
286 my @end = @+; 311 my @end = @+;
312 my @exec;
313
287 if (!defined($col) || ($-[0] <= $col && $+[0] >= $col)) { 314 if (!defined($off) || ($-[0] <= $off && $+[0] >= $off)) {
288 if ($launcher !~ /\$/) { 315 if ($launcher !~ /\$/) {
289 return ($launcher,$match); 316 @exec = ($launcher, $match);
290 } else { 317 } else {
291 # 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...),
292 # but alas, m//g behaves differently in list context. 319 # but alas, m//g behaves differently in list context.
293 my @exec = map { s/\$(\d+)|\$\{(\d+)\}/ 320 @exec = map { s/\$(\d+)|\$\{(\d+)\}/
294 substr($text,$begin[$1||$2],$end[$1||$2]-$begin[$1||$2]) 321 substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2]
295 /egx; $_ } split(/\s+/, $launcher); 322 /egx; $_ } split /\s+/, $launcher;
296 return @exec;
297 } 323 }
324
325 push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ];
298 } 326 }
299 } 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];
300 } 340 }
301 341
302 () 342 ()
303} 343}
304 344
330 370
331 if($row == $event->{row} && abs($col-$event->{col}) < 2 371 if($row == $event->{row} && abs($col-$event->{col}) < 2
332 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) { 372 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) {
333 if($self->valid_button($event)) { 373 if($self->valid_button($event)) {
334 374
335 $self->exec_async (@$cmd); 375 $self->exec_async (@$cmd);
336 376
337 } 377 }
338 } 378 }
339 379
340 1; 380 1;
341} 381}
342 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
343# 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