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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines