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