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.18 by sf-exg, Sun Jun 1 11:47:20 2014 UTC vs.
Revision 1.39 by root, Sun Nov 21 19:33:32 2021 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# Emanuele Giaquinta
5 6
6#:META:RESOURCE:%.launcher:string:default launcher command 7#:META:RESOURCE:%.launcher:string:default launcher command
7#:META:RESOURCE:%.button:string:the button, yeah 8#:META:RESOURCE:%.button:string:the mouse button used to activate a match
8#:META:RESOURCE:%.pattern.:string:extra pattern to match 9#:META:RESOURCE:%.pattern.:string:extra pattern to match
9#:META:RESOURCE:%.launcher.:string:custom launcher for pattern 10#:META:RESOURCE:%.launcher.:string:custom launcher for pattern
10#:META:RESOURCE:%.rend.:string:custom rednition for pattern 11#:META:RESOURCE:%.rend.:string:custom rendition for pattern
11 12
12=head1 NAME 13=head1 NAME
13 14
14matcher - match strings in terminal output and change their rendition 15matcher - match strings in terminal output and change their rendition
15 16
… …
28C<matcher.pattern.0> resource, and additional patterns can be specified 29C<matcher.pattern.0> resource, and additional patterns can be specified
29with numbered patterns, in a manner similar to the "selection" extension. 30with numbered patterns, in a manner similar to the "selection" extension.
30The launcher can also be overridden on a per-pattern basis. 31The launcher can also be overridden on a per-pattern basis.
31 32
32It is possible to activate the most recently seen match or a list of matches 33It 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 34from the keyboard. Simply bind a keysym to "matcher:last" or
34"perl:matcher:list" as seen in the example below. 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.
35 76
36Example: load and use the matcher extension with defaults. 77Example: load and use the matcher extension with defaults.
37 78
38 URxvt.perl-ext: default,matcher 79 URxvt.perl-ext: default,matcher
39 80
40Example: use a custom configuration. 81Example: use a custom configuration.
41 82
42 URxvt.url-launcher: sensible-browser 83 URxvt.url-launcher: sensible-browser
43 URxvt.keysym.C-Delete: perl:matcher:last 84 URxvt.keysym.C-Delete: matcher:last
44 URxvt.keysym.M-Delete: perl:matcher:list 85 URxvt.keysym.M-Delete: matcher:list
45 URxvt.matcher.button: 1 86 URxvt.matcher.button: 1
46 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] 87 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
47 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) 88 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
48 URxvt.matcher.launcher.2: gvim +$2 $1 89 URxvt.matcher.launcher.2: gvim +$2 $1
49 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
50=cut 121=cut
51 122
52my $url = 123my $url =
53 qr{ 124 qr{
54 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.) 125 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.)
55 [\w\-\@;\/?:&=%\$.+!*\x27,~#]* 126 [\w\-\@;\/?:&=%\$.+!*\x27,~#$urxvt::NOCHAR]*
56 ( 127 (
57 \([\w\-\@;\/?:&=%\$.+!*\x27,~#]*\)| # Allow a pair of matched parentheses 128 \([\w\-\@;\/?:&=%\$.+!*\x27,~#$urxvt::NOCHAR]*\)| # Allow a pair of matched parentheses
58 [\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic) 129 [\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic)
59 )+ 130 )+
60 }x; 131 }x;
61 132
62sub on_key_press { 133sub matchlist_key_press {
63 my ($self, $event, $keysym, $octets) = @_; 134 my ($self, $event, $keysym, $octets) = @_;
64 135
65 return unless $self->{overlay};
66
67 delete $self->{overlay}; 136 delete $self->{overlay};
137 $self->disable ("key_press");
68 138
69 my $i = ($keysym == 96 ? 0 : $keysym - 48); 139 my $i = ($keysym == 96 ? 0 : $keysym - 48);
70 if ($i >= 0 && $i < @{ $self->{matches} }) { 140 if ($i >= 0 && $i < @{ $self->{matches} }) {
71 my @exec = @{ $self->{matches}[$i] }; 141 my @exec = @{ $self->{matches}[$i] };
72 shift @exec;
73 $self->exec_async (@exec); 142 $self->exec_async (@exec[5 .. $#exec]);
74 } 143 }
75 144
76 1 145 1
77} 146}
78 147
79# backwards compat 148# backwards compat
80sub on_user_command { 149sub on_user_command {
81 my ($self, $cmd) = @_; 150 my ($self, $cmd) = @_;
82 151
83 if ($cmd =~ s/^matcher:list\b//) { 152 if ($cmd eq "matcher:list") {
84 $self->matchlist; 153 $self->matchlist;
85 } else { 154 } elsif ($cmd eq "matcher:last") {
86 if ($cmd =~ s/^matcher:last\b//) {
87 $self->most_recent; 155 $self->most_recent;
156 } elsif ($cmd eq "matcher:select") {
157 $self->select_enter;
88 } elsif ($cmd =~ s/^matcher\b//) { 158 } elsif ($cmd eq "matcher") {
89 # for backward compatibility 159 # for backward compatibility
90 $self->most_recent; 160 $self->most_recent;
91 } 161 }
162
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;
92 } 175 }
93 176
94 () 177 ()
95} 178}
96 179
97sub matchlist { 180sub matchlist {
98 my ($self) = @_; 181 my ($self) = @_;
99 182
100 @{ $self->{matches} } = (); 183 $self->{matches} = [];
101 my $row = $self->nrow - 1; 184 my $row = $self->nrow - 1;
102 while ($row >= 0 && @{ $self->{matches} } < 10) { 185 while ($row >= 0 && @{ $self->{matches} } < 10) {
103 my $line = $self->line ($row); 186 my $line = $self->line ($row);
104 my $text = $line->t; 187 my @matches = $self->find_matches ($row);
105 188
106 # FIXME: code duplicated from 'command_for' 189 for (sort { $b->[0] <=> $a->[0] or $b->[1] <=> $a->[1] } @matches) {
107 for my $matcher (@{$self->{matchers}}) { 190 push @{ $self->{matches} }, $_;
108 my $launcher = $matcher->[1] || $self->{launcher}; 191 last if @{ $self->{matches} } == 10;
109 while ($text =~ /$matcher->[0]/g) {
110 my $match = substr ($text, $-[0], $+[0] - $-[0]);
111 my @beg = @-;
112 my @end = @+;
113 my @exec;
114
115 if ($launcher !~ /\$/) {
116 @exec = ($launcher, $match);
117 } else {
118 @exec = map { s/\$(\d+)|\$\{(\d+)\}/
119 substr ($text, $beg[$1 || $2], $end[$1 || $2] - $beg[$1 || $2])
120 /egx; $_ } split /\s+/, $launcher;
121 }
122
123 push @{ $self->{matches} }, [ $match, @exec ];
124 }
125 } 192 }
126 193
127 $row = $line->beg - 1; 194 $row = $line->beg - 1;
128 } 195 }
129 196
… …
131 198
132 my $width = 0; 199 my $width = 0;
133 200
134 my $i = 0; 201 my $i = 0;
135 for my $match (@{ $self->{matches} }) { 202 for my $match (@{ $self->{matches} }) {
136 my $text = $match->[0]; 203 my $text = $match->[4];
137 my $w = $self->strwidth ("$i-$text"); 204 my $w = $self->strwidth ("$i-$text");
138 205
139 $width = $w if $w > $width; 206 $width = $w if $w > $width;
140 $i++; 207 $i++;
141 } 208 }
… …
143 $width = $self->ncol - 2 if $width > $self->ncol - 2; 210 $width = $self->ncol - 2 if $width > $self->ncol - 2;
144 211
145 $self->{overlay} = $self->overlay (0, 0, $width, scalar (@{ $self->{matches} }), urxvt::OVERLAY_RSTYLE, 2); 212 $self->{overlay} = $self->overlay (0, 0, $width, scalar (@{ $self->{matches} }), urxvt::OVERLAY_RSTYLE, 2);
146 my $i = 0; 213 my $i = 0;
147 for my $match (@{ $self->{matches} }) { 214 for my $match (@{ $self->{matches} }) {
148 my $text = $match->[0]; 215 my $text = $match->[4];
149 216
150 $self->{overlay}->set (0, $i, "$i-$text"); 217 $self->{overlay}->set (0, $i, "$i-$text");
151 $i++; 218 $i++;
152 } 219 }
153 220
221 $self->enable (key_press => \&matchlist_key_press);
154} 222}
155 223
156sub most_recent { 224sub most_recent {
157 my ($self) = shift; 225 my ($self) = shift;
158 my $row = $self->nrow; 226 my $row = $self->nrow - 1;
159 my @exec; 227 my @exec;
160 while($row-- > $self->top_row) { 228 while ($row >= $self->top_row) {
229 my $line = $self->line ($row);
161 @exec = $self->command_for($row); 230 @exec = $self->command_for($row);
162 last if(@exec); 231 last if(@exec);
232
233 $row = $line->beg - 1;
163 } 234 }
164 if(@exec) { 235 if(@exec) {
165 return $self->exec_async (@exec); 236 return $self->exec_async (@exec);
166 } 237 }
167 () 238 ()
… …
189sub on_start { 260sub on_start {
190 my ($self) = @_; 261 my ($self) = @_;
191 262
192 $self->{launcher} = $self->my_resource ("launcher") || $self->x_resource("url-launcher") || "sensible-browser"; 263 $self->{launcher} = $self->my_resource ("launcher") || $self->x_resource("url-launcher") || "sensible-browser";
193 264
194 $self->{matches} = [];
195 $self->{button} = 2; 265 $self->{button} = 2;
196 $self->{state} = 0; 266 $self->{state} = 0;
197 if($self->{argv}[0] || $self->my_resource ("button")) { 267 if($self->{argv}[0] || $self->my_resource ("button")) {
198 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button"); 268 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button");
199 for my $mod (@mods) { 269 for my $mod (@mods) {
… …
211 } 281 }
212 } 282 }
213 283
214 my @defaults = ($url); 284 my @defaults = ($url);
215 my @matchers; 285 my @matchers;
216 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++) {
217 $res = $self->locale_decode ($res);
218 utf8::encode $res;
219 my $launcher = $self->my_resource ("launcher.$idx"); 287 my $launcher = $self->my_resource ("launcher.$idx");
220 $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher; 288 $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher;
221 my $rend = $self->parse_rend($self->my_resource ("rend.$idx")); 289 my $rend = $self->parse_rend($self->my_resource ("rend.$idx"));
222 unshift @matchers, [qr($res)x,$launcher,$rend]; 290 unshift @matchers, [qr($res)x,$launcher,$rend];
223 } 291 }
… …
230 my ($self, $row) = @_; 298 my ($self, $row) = @_;
231 299
232 # fetch the line that has changed 300 # fetch the line that has changed
233 my $line = $self->line ($row); 301 my $line = $self->line ($row);
234 my $text = $line->t; 302 my $text = $line->t;
235 my $i = 0; 303 my $rend;
236 304
237 # find all urls (if any) 305 # find all urls (if any)
238 for my $matcher (@{$self->{matchers}}) { 306 for my $matcher (@{$self->{matchers}}) {
239 while ($text =~ /$matcher->[0]/g) { 307 while ($text =~ /$matcher->[0]/g) {
240 #print "$&\n"; 308 #print "$&\n";
241 my $rend = $line->r; 309 $rend ||= $line->r;
242 310
243 # mark all characters as underlined. we _must_ not toggle underline, 311 # mark all characters as underlined. we _must_ not toggle underline,
244 # as we might get called on an already-marked url. 312 # as we might get called on an already-marked url.
245 &{$matcher->[2]} 313 &{$matcher->[2]}
246 for @{$rend}[ $-[0] .. $+[0] - 1]; 314 for @{$rend}[$-[0] .. $+[0] - 1];
247
248 $line->r ($rend);
249 } 315 }
250 } 316 }
317
318 $line->r ($rend) if $rend;
251 319
252 () 320 ()
253} 321}
254 322
255sub valid_button { 323sub valid_button {
… …
258 | urxvt::ShiftMask | urxvt::ControlMask; 326 | urxvt::ShiftMask | urxvt::ControlMask;
259 return ($event->{button} == $self->{button} && 327 return ($event->{button} == $self->{button} &&
260 ($event->{state} & $mask) == $self->{state}); 328 ($event->{state} & $mask) == $self->{state});
261} 329}
262 330
263sub command_for { 331sub find_matches {
264 my ($self, $row, $col) = @_; 332 my ($self, $row, $col) = @_;
265 my $line = $self->line ($row); 333 my $line = $self->line ($row);
266 my $text = $line->t; 334 my $text = $line->t;
335 my $off = $line->offset_of ($row, $col) if defined $col;
267 336
337 my @matches;
268 for my $matcher (@{$self->{matchers}}) { 338 for my $matcher (@{$self->{matchers}}) {
269 my $launcher = $matcher->[1] || $self->{launcher}; 339 my $launcher = $matcher->[1] || $self->{launcher};
270 while (($text =~ /$matcher->[0]/g)) { 340 while ($text =~ /$matcher->[0]/g) {
271 my $match = $&; 341 my $match = substr $text, $-[0], $+[0] - $-[0];
272 my @begin = @-; 342 my @begin = @-;
273 my @end = @+; 343 my @end = @+;
344 my @exec;
345
274 if (!defined($col) || ($-[0] <= $col && $+[0] >= $col)) { 346 if (!defined($off) || ($-[0] <= $off && $+[0] >= $off)) {
275 if ($launcher !~ /\$/) { 347 if ($launcher !~ /\$/) {
276 return ($launcher,$match); 348 @exec = ($launcher, $match);
277 } else { 349 } else {
278 # 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...),
279 # but alas, m//g behaves differently in list context. 351 # but alas, m//g behaves differently in list context.
280 my @exec = map { s/\$(\d+)|\$\{(\d+)\}/ 352 @exec = map { s/\$(\d+)|\$\{(\d+)\}/
281 substr($text,$begin[$1||$2],$end[$1||$2]-$begin[$1||$2]) 353 substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2]
282 /egx; $_ } split(/\s+/, $launcher); 354 /egx; $_ } split /\s+/, $launcher;
283 return @exec;
284 } 355 }
356
357 push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ];
285 } 358 }
286 } 359 }
360 }
361
362 @matches;
363}
364
365sub command_for {
366 my ($self, $row, $col) = @_;
367
368 my @matches = $self->find_matches ($row, $col);
369 if (@matches) {
370 my @match = @{ $matches[0] };
371 return @match[5 .. $#match];
287 } 372 }
288 373
289 () 374 ()
290} 375}
291 376
… …
325 } 410 }
326 411
327 1; 412 1;
328} 413}
329 414
415sub select_enter {
416 my ($self) = @_;
417
418 $self->{view_start} = $self->view_start;
419 $self->{pty_ev_events} = $self->pty_ev_events (urxvt::EV_NONE);
420 $self->{cur_row} = $self->nrow - 1;
421
422 $self->enable (
423 key_press => \&select_key_press,
424 refresh_begin => \&select_refresh,
425 refresh_end => \&select_refresh,
426 );
427
428 $self->{overlay} = $self->overlay (0, -1, $self->ncol, 1, urxvt::OVERLAY_RSTYLE, 0);
429 $self->{overlay}->set (0, 0, "match-select");
430}
431
432sub select_leave {
433 my ($self) = @_;
434
435 $self->disable ("key_press", "refresh_begin", "refresh_end");
436 $self->pty_ev_events ($self->{pty_ev_events});
437
438 delete $self->{overlay};
439 delete $self->{matches};
440 delete $self->{id};
441}
442
443sub select_search {
444 my ($self, $dir, $row) = @_;
445
446 while ($self->nrow > $row && $row >= $self->top_row) {
447 my $line = $self->line ($row)
448 or last;
449
450 my @matches = $self->find_matches ($row);
451 if (@matches) {
452 @matches = sort { $a->[0] <=> $b->[0] or $a->[1] <=> $b->[1] } @matches;
453 $self->{matches} = \@matches;
454 $self->{cur_row} = $row;
455 $self->{id} = $dir < 0 ? @{ $self->{matches} } - 1 : 0;
456 $self->view_start ($row - ($self->nrow >> 1));
457 $self->want_refresh;
458 return 1;
459 }
460
461 $row = $dir < 0 ? $line->beg - 1 : $line->end + 1;
462 }
463
464 $self->scr_bell;
465
466 ()
467}
468
469sub select_refresh {
470 my ($self) = @_;
471
472 return unless $self->{matches};
473
474 my $cur = $self->{matches}[$self->{id}];
475 $self->scr_xor_span (@$cur[0 .. 3], urxvt::RS_RVid);
476
477 ()
478}
479
480sub select_key_press {
481 my ($self, $event, $keysym, $string) = @_;
482
483 if ($keysym == 0xff0d || $keysym == 0xff8d) { # enter
484 if ($self->{matches}) {
485 my @match = @{ $self->{matches}[$self->{id}] };
486 $self->exec_async (@match[5 .. $#match]);
487 }
488 $self->select_leave;
489 } elsif ($keysym == 0x79) { # y
490 if ($self->{matches}) {
491 $self->selection ($self->{matches}[$self->{id}][4], 1);
492 $self->selection_grab (urxvt::CurrentTime, 1);
493 }
494 $self->select_leave;
495 } elsif ($keysym == 0xff1b) { # escape
496 $self->view_start ($self->{view_start});
497 $self->select_leave;
498 } elsif ($keysym == 0xff50) { # home
499 $self->select_search (+1, $self->top_row)
500 } elsif ($keysym == 0xff57) { # end
501 $self->select_search (-1, $self->nrow - 1)
502 } elsif ($keysym == 0xff52) { # up
503 if ($self->{id} > 0) {
504 $self->{id}--;
505 $self->want_refresh;
506 } else {
507 my $line = $self->line ($self->{cur_row});
508 $self->select_search (-1, $line->beg - 1)
509 if $line->beg > $self->top_row;
510 }
511 } elsif ($keysym == 0xff54) { # down
512 if ($self->{id} < @{ $self->{matches} } - 1) {
513 $self->{id}++;
514 $self->want_refresh;
515 } else {
516 my $line = $self->line ($self->{cur_row});
517 $self->select_search (+1, $line->end + 1)
518 if $line->end < $self->nrow;
519 }
520 } elsif ($self->lookup_keysym ($keysym, $event->{state}) eq "matcher:select") {
521 if ($self->{id} > 0) {
522 $self->{id}--;
523 $self->want_refresh;
524 } else {
525 my $line = $self->line ($self->{cur_row});
526 $self->select_search (-1, $self->nrow - 1)
527 unless $self->select_search (-1, $line->beg - 1);
528 }
529 }
530
531 1
532}
533
330# vim:set sw=3 sts=3 et: 534# vim:set sw=3 sts=3 et:

Diff Legend

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