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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines