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.2 by tpope, Tue Jan 9 16:18:56 2007 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.info> 3# Author: Tim Pope <rxvt-unicodeNOSPAM@tpope.org>
4# Bob Farrell <robertanthonyfarrell@gmail.com>
5
6#:META:RESOURCE:%.launcher:string:default launcher command
7#:META:RESOURCE:%.button:string:the button, yeah
8#:META:RESOURCE:%.pattern.:string:extra pattern to match
9#:META:RESOURCE:%.launcher.:string:custom launcher 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
4 88
5my $url = 89my $url =
6 qr{ 90 qr{
7 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.) 91 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.)
8 [a-zA-Z0-9\-\@;\/?:&=%\$_.+!*\x27,~#]* 92 [\w\-\@;\/?:&=%\$.+!*\x27,~#]*
9 ( 93 (
10 \([a-zA-Z0-9\-\@;\/?:&=%\$_.+!*\x27,~#]*\)| # Allow a pair of matched parentheses 94 \([\w\-\@;\/?:&=%\$.+!*\x27,~#]*\)| # Allow a pair of matched parentheses
11 [a-zA-Z0-9\-\@;\/?:&=%\$_+*~] # exclude some trailing characters (heuristic) 95 [\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic)
12 )+ 96 )+
13 }x; 97 }x;
14 98
99sub matchlist_key_press {
100 my ($self, $event, $keysym, $octets) = @_;
101
102 delete $self->{overlay};
103 $self->disable ("key_press");
104
105 my $i = ($keysym == 96 ? 0 : $keysym - 48);
106 if ($i >= 0 && $i < @{ $self->{matches} }) {
107 my @exec = @{ $self->{matches}[$i] };
108 $self->exec_async (@exec[5 .. $#exec]);
109 }
110
111 1
112}
113
114# backwards compat
15sub on_user_command { 115sub on_user_command {
16 my ($self, $cmd) = @_; 116 my ($self, $cmd) = @_;
117
17 if($cmd =~ s/^matcher\b//) { 118 if ($cmd =~ s/^matcher:list\b//) {
119 $self->matchlist;
120 } else {
121 if ($cmd =~ s/^matcher:last\b//) {
122 $self->most_recent;
123 } elsif ($cmd =~ s/^matcher\b//) {
124 # for backward compatibility
125 $self->most_recent;
126 }
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") {
18 $self->most_recent; 138 $self->most_recent;
139 } elsif ($action eq "select") {
140 $self->select_enter;
19 } 141 }
142
143 ()
144}
145
146sub matchlist {
147 my ($self) = @_;
148
149 $self->{matches} = [];
20 my $row = $self->nrow; 150 my $row = $self->nrow - 1;
151 while ($row >= 0 && @{ $self->{matches} } < 10) {
152 my $line = $self->line ($row);
153 my @matches = $self->find_matches ($row);
154
155 for (sort { $b->[0] <=> $a->[0] or $b->[1] <=> $a->[1] } @matches) {
156 push @{ $self->{matches} }, $_;
157 last if @{ $self->{matches} } == 10;
158 }
159
160 $row = $line->beg - 1;
161 }
162
163 return unless @{ $self->{matches} };
164
165 my $width = 0;
166
167 my $i = 0;
168 for my $match (@{ $self->{matches} }) {
169 my $text = $match->[4];
170 my $w = $self->strwidth ("$i-$text");
171
172 $width = $w if $w > $width;
173 $i++;
174 }
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);
188}
189
190sub most_recent {
191 my ($self) = shift;
192 my $row = $self->nrow - 1;
21 my @exec; 193 my @exec;
22 while($row-- > $self->top_row) { 194 while ($row >= $self->top_row) {
23 #my $line = $self->line ($row); 195 my $line = $self->line ($row);
24 #my $text = $line->t;
25 @exec = $self->command_for($row); 196 @exec = $self->command_for($row);
26 last if(@exec); 197 last if(@exec);
198
199 $row = $line->beg - 1;
27 } 200 }
28 if(@exec) { 201 if(@exec) {
29 return $self->exec_async (@exec); 202 return $self->exec_async (@exec);
30 } 203 }
31 () 204 ()
32} 205}
33 206
34sub most_recent {
35 my ($self) = shift;
36 ()
37}
38
39sub my_resource { 207sub my_resource {
40 my $self = shift; 208 $_[0]->x_resource ("%.$_[1]")
41 $self->x_resource("$self->{name}.$_[0]");
42} 209}
43 210
44# 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 $_
45sub parse_rend { 212sub parse_rend {
46 my ($self, $str) = @_; 213 my ($self, $str) = @_;
47 my ($mask, $fg, $bg, $failed) = $str ? urxvt::rend2mask($str) 214 my ($mask, $fg, $bg, $failed) = $str ? urxvt::rend2mask($str)
48 : (urxvt::RS_Uline, undef, undef, []); 215 : (urxvt::RS_Uline, undef, undef, []);
49 warn "Failed to parse rendition string: " . join(',', @$failed) if @$failed; 216 warn "Failed to parse rendition string: " . join(',', @$failed) if @$failed;
50 my @rend; 217 my @rend;
51 push @rend, sub { $_ |= $mask } if $mask; 218 push @rend, sub { $_ |= $mask } if $mask;
52 push @rend, sub { $_ = urxvt::SET_FGCOLOR($_, $fg) } if defined $fg; 219 push @rend, sub { $_ = urxvt::SET_FGCOLOR($_, $fg) } if defined $fg;
57} 224}
58 225
59sub on_start { 226sub on_start {
60 my ($self) = @_; 227 my ($self) = @_;
61 228
62 ($self->{name} = __PACKAGE__) =~ s/.*:://; 229 $self->{launcher} = $self->my_resource ("launcher") || $self->x_resource("url-launcher") || "sensible-browser";
63 $self->{name} =~ tr/_/-/;
64 $self->{launcher} = $self->my_resource("launcher") ||
65 $self->x_resource("urlLauncher") ||
66 "sensible-browser";
67 230
68 $self->{button} = 2; 231 $self->{button} = 2;
69 $self->{state} = 0; 232 $self->{state} = 0;
70 if($self->{argv}[0] || $self->my_resource("button")) { 233 if($self->{argv}[0] || $self->my_resource ("button")) {
71 my @mods = split('', $self->{argv}[0] || $self->my_resource("button")); 234 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button");
72 for my $mod (@mods) { 235 for my $mod (@mods) {
73 if($mod =~ /^\d+$/) { 236 if($mod =~ /^\d+$/) {
74 $self->{button} = $mod; 237 $self->{button} = $mod;
75 } elsif($mod eq "C") { 238 } elsif($mod eq "C") {
76 $self->{state} |= urxvt::ControlMask; 239 $self->{state} |= urxvt::ControlMask;
77 } elsif($mod eq "S") { 240 } elsif($mod eq "S") {
78 $self->{state} |= urxvt::ShiftMask; 241 $self->{state} |= urxvt::ShiftMask;
79 } elsif($mod eq "M") { 242 } elsif($mod eq "M") {
80 $self->{state} |= $self->ModMetaMask; 243 $self->{state} |= $self->ModMetaMask;
81 } elsif($mod ne "-" && $mod ne " ") { 244 } elsif($mod ne "-" && $mod ne " ") {
82 warn("$mod is invalid in $self->{name}<$self->{argv}[0]>\n"); 245 warn("$mod is invalid in $self->{_name}<$self->{argv}[0]>\n");
83 } 246 }
84 } 247 }
85 } 248 }
86 249
87 my @defaults = ($url); 250 my @defaults = ($url);
88 my @matchers; 251 my @matchers;
89 for (my $idx = 0; defined (my $res = $self->my_resource("pattern.$idx") || $defaults[$idx]); $idx++) { 252 for (my $idx = 0; defined (my $res = $self->my_resource ("pattern.$idx") || $defaults[$idx]); $idx++) {
90 $res = $self->locale_decode ($res); 253 $res = $self->locale_decode ($res);
91 utf8::encode $res; 254 utf8::encode $res;
92 my $launcher = $self->my_resource("launcher.$idx"); 255 my $launcher = $self->my_resource ("launcher.$idx");
93 $launcher =~ s/\$&|\$\{&\}/\${0}/g if ($launcher); 256 $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher;
94 my $rend = $self->parse_rend($self->my_resource("rend.$idx")); 257 my $rend = $self->parse_rend($self->my_resource ("rend.$idx"));
95 unshift @matchers, [qr($res)x,$launcher,$rend]; 258 unshift @matchers, [qr($res)x,$launcher,$rend];
96 } 259 }
97 $self->{matchers} = \@matchers; 260 $self->{matchers} = \@matchers;
98 261
99 () 262 ()
103 my ($self, $row) = @_; 266 my ($self, $row) = @_;
104 267
105 # fetch the line that has changed 268 # fetch the line that has changed
106 my $line = $self->line ($row); 269 my $line = $self->line ($row);
107 my $text = $line->t; 270 my $text = $line->t;
108 my $i = 0; 271 my $rend;
109 272
110 # find all urls (if any) 273 # find all urls (if any)
111 for my $matcher (@{$self->{matchers}}) { 274 for my $matcher (@{$self->{matchers}}) {
112 while ($text =~ /$matcher->[0]/g) { 275 while ($text =~ /$matcher->[0]/g) {
113 #print "$&\n"; 276 #print "$&\n";
114 my $rend = $line->r; 277 $rend ||= $line->r;
115 278
116 # mark all characters as underlined. we _must_ not toggle underline, 279 # mark all characters as underlined. we _must_ not toggle underline,
117 # as we might get called on an already-marked url. 280 # as we might get called on an already-marked url.
118 &{$matcher->[2]} 281 &{$matcher->[2]}
119 for @{$rend}[ $-[0] .. $+[0] - 1]; 282 for @{$rend}[$-[0] .. $+[0] - 1];
120
121 $line->r ($rend);
122 } 283 }
123 } 284 }
285
286 $line->r ($rend) if $rend;
124 287
125 () 288 ()
126} 289}
127 290
128sub valid_button { 291sub valid_button {
131 | urxvt::ShiftMask | urxvt::ControlMask; 294 | urxvt::ShiftMask | urxvt::ControlMask;
132 return ($event->{button} == $self->{button} && 295 return ($event->{button} == $self->{button} &&
133 ($event->{state} & $mask) == $self->{state}); 296 ($event->{state} & $mask) == $self->{state});
134} 297}
135 298
136sub command_for { 299sub find_matches {
137 my ($self, $row, $col) = @_; 300 my ($self, $row, $col) = @_;
138 my $line = $self->line ($row); 301 my $line = $self->line ($row);
139 my $text = $line->t; 302 my $text = $line->t;
303 my $off = $line->offset_of ($row, $col) if defined $col;
140 304
305 my @matches;
141 for my $matcher (@{$self->{matchers}}) { 306 for my $matcher (@{$self->{matchers}}) {
142 my $launcher = $matcher->[1] || $self->{launcher}; 307 my $launcher = $matcher->[1] || $self->{launcher};
143 while (($text =~ /$matcher->[0]/g)) { 308 while ($text =~ /$matcher->[0]/g) {
144 my $match = $&; 309 my $match = substr $text, $-[0], $+[0] - $-[0];
145 my @begin = @-; 310 my @begin = @-;
146 my @end = @+; 311 my @end = @+;
312 my @exec;
313
147 if (!defined($col) || ($-[0] <= $col && $+[0] >= $col)) { 314 if (!defined($off) || ($-[0] <= $off && $+[0] >= $off)) {
148 if ($launcher !~ /\$/) { 315 if ($launcher !~ /\$/) {
149 return ($launcher,$match); 316 @exec = ($launcher, $match);
150 } else { 317 } else {
151 # 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...),
152 # but alas, m//g behaves differently in list context. 319 # but alas, m//g behaves differently in list context.
153 my @exec = map { s/\$(\d+)|\$\{(\d+)\}/ 320 @exec = map { s/\$(\d+)|\$\{(\d+)\}/
154 substr($text,$begin[$1||$2],$end[$1||$2]-$begin[$1||$2]) 321 substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2]
155 /egx; $_ } split(/\s+/, $launcher); 322 /egx; $_ } split /\s+/, $launcher;
156 return @exec;
157 } 323 }
324
325 push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ];
158 } 326 }
159 } 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];
160 } 340 }
161 341
162 () 342 ()
163} 343}
164 344
165sub on_button_press { 345sub on_button_press {
166 my ($self, $event) = @_; 346 my ($self, $event) = @_;
167 if($self->valid_button($event)) { 347 if($self->valid_button($event)
348 && (my @exec = $self->command_for($event->{row},$event->{col}))) {
168 $self->{row} = $event->{row}; 349 $self->{row} = $event->{row};
169 $self->{col} = $event->{col}; 350 $self->{col} = $event->{col};
351 $self->{cmd} = \@exec;
352 return 1;
170 } else { 353 } else {
171 delete $self->{row}; 354 delete $self->{row};
172 delete $self->{col}; 355 delete $self->{col};
356 delete $self->{cmd};
173 } 357 }
174 358
175 () 359 ()
176} 360}
177 361
178sub on_button_release { 362sub on_button_release {
179 my ($self, $event) = @_; 363 my ($self, $event) = @_;
180 364
181 my $row = delete $self->{row}; 365 my $row = delete $self->{row};
182 my $col = delete $self->{col}; 366 my $col = delete $self->{col};
367 my $cmd = delete $self->{cmd};
183 368
369 return if !defined $row;
370
184 if(defined($row) && $row == $event->{row} && abs($col-$event->{col}) < 2) { 371 if($row == $event->{row} && abs($col-$event->{col}) < 2
372 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) {
185 if($self->valid_button($event)) { 373 if($self->valid_button($event)) {
186 374
187 my @exec = $self->command_for($row,$col);
188 if(@exec) {
189 return $self->exec_async (@exec); 375 $self->exec_async (@$cmd);
376
190 } 377 }
191
192 }
193 } 378 }
194 379
380 1;
381}
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,
195 () 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
196} 489}
197 490
198# 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