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.1 by root, Sat Nov 11 20:06:34 2006 UTC vs.
Revision 1.36 by sf-exg, Wed Jul 14 12:39:57 2021 UTC

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

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines