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.16 by sf-exg, Wed May 28 17:01:32 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 if (! $self->{showing} ) { 136 delete $self->{overlay};
66 return; 137 $self->disable ("key_press");
67 }
68 138
69 my $i = ($keysym == 96 ? 0 : $keysym - 48); 139 my $i = ($keysym == 96 ? 0 : $keysym - 48);
70 if (($i > scalar(@{$self->{urls}})) || ($i < 0)) { 140 if ($i >= 0 && $i < @{ $self->{matches} }) {
71 $self->matchlist(); 141 my @exec = @{ $self->{matches}[$i] };
72 return; 142 $self->exec_async (@exec[5 .. $#exec]);
143 }
144
73 } 145 1
74
75 my @args = ($self->{urls}[ -$i-1 ]);
76 $self->matchlist();
77
78 $self->exec_async( $self->{launcher}, @args );
79} 146}
80 147
81# backwards compat 148# backwards compat
82sub on_user_command { 149sub on_user_command {
83 my ($self, $cmd) = @_; 150 my ($self, $cmd) = @_;
84 151
85 if ($cmd =~ s/^matcher:list\b//) { 152 if ($cmd eq "matcher:list") {
86 $self->matchlist; 153 $self->matchlist;
87 } else { 154 } elsif ($cmd eq "matcher:last") {
88 if ($cmd =~ s/^matcher:last\b//) {
89 $self->most_recent; 155 $self->most_recent;
156 } elsif ($cmd eq "matcher:select") {
157 $self->select_enter;
90 } elsif ($cmd =~ s/^matcher\b//) { 158 } elsif ($cmd eq "matcher") {
91 # for backward compatibility 159 # for backward compatibility
92 $self->most_recent; 160 $self->most_recent;
93 } 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;
94 } 175 }
95 176
96 () 177 ()
97} 178}
98 179
99sub matchlist { 180sub matchlist {
100 my ($self) = @_; 181 my ($self) = @_;
101 if ( $self->{showing} ) { 182
102 $self->{url_overlay}->hide; 183 $self->{matches} = [];
103 $self->{showing} = 0; 184 my $row = $self->nrow - 1;
104 return; 185 while ($row >= 0 && @{ $self->{matches} } < 10) {
105 }
106 @{$self->{urls}} = ();
107 my $line;
108 for (my $i = 0; $i < $self->nrow; $i ++) {
109 $line = $self->line($i); 186 my $line = $self->line ($row);
110 next if ($line->beg != $i); 187 my @matches = $self->find_matches ($row);
111 for my $url ($self->get_urls_from_line($line->t)) { 188
112 if (scalar(@{$self->{urls}}) == 10) { 189 for (sort { $b->[0] <=> $a->[0] or $b->[1] <=> $a->[1] } @matches) {
113 shift @{$self->{urls}};
114 }
115 push @{$self->{urls}}, $url; 190 push @{ $self->{matches} }, $_;
191 last if @{ $self->{matches} } == 10;
116 } 192 }
193
194 $row = $line->beg - 1;
117 } 195 }
118 196
119 if (! scalar(@{$self->{urls}})) { 197 return unless @{ $self->{matches} };
120 return;
121 }
122 198
123 my $max = 0; 199 my $width = 0;
124 my $i = scalar( @{$self->{urls}} ) - 1 ;;
125 200
126 my @temp = ();
127
128 for my $url (@{$self->{urls}}) {
129 my $url = "$i-$url";
130 my $xpos = 0;
131
132 if ($self->ncol + (length $url) >= $self->ncol) {
133 $url = substr( $url, 0, $self->ncol );
134 }
135
136 push @temp, $url;
137
138 if( length $url > $max ) {
139 $max = length $url;
140 }
141
142 $i--;
143 }
144
145 @temp = reverse @temp;
146
147 $self->{url_overlay} = $self->overlay(0, 0, $max, scalar( @temp ), urxvt::OVERLAY_RSTYLE, 2);
148 my $i = 0; 201 my $i = 0;
149 for my $url (@temp) { 202 for my $match (@{ $self->{matches} }) {
150 $self->{url_overlay}->set( 0, $i, $url, [(urxvt::OVERLAY_RSTYLE) x length $url]); 203 my $text = $match->[4];
151 $self->{showing} = 1; 204 my $w = $self->strwidth ("$i-$text");
205
206 $width = $w if $w > $width;
152 $i++; 207 $i++;
153 } 208 }
154 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);
155} 222}
156 223
157sub most_recent { 224sub most_recent {
158 my ($self) = shift; 225 my ($self) = shift;
159 my $row = $self->nrow; 226 my $row = $self->nrow - 1;
160 my @exec; 227 my @exec;
161 while($row-- > $self->top_row) { 228 while ($row >= $self->top_row) {
229 my $line = $self->line ($row);
162 @exec = $self->command_for($row); 230 @exec = $self->command_for($row);
163 last if(@exec); 231 last if(@exec);
232
233 $row = $line->beg - 1;
164 } 234 }
165 if(@exec) { 235 if(@exec) {
166 return $self->exec_async (@exec); 236 return $self->exec_async (@exec);
167 } 237 }
168 () 238 ()
190sub on_start { 260sub on_start {
191 my ($self) = @_; 261 my ($self) = @_;
192 262
193 $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";
194 264
195 $self->{urls} = [];
196 $self->{showing} = 0;
197 $self->{button} = 2; 265 $self->{button} = 2;
198 $self->{state} = 0; 266 $self->{state} = 0;
199 if($self->{argv}[0] || $self->my_resource ("button")) { 267 if($self->{argv}[0] || $self->my_resource ("button")) {
200 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button"); 268 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button");
201 for my $mod (@mods) { 269 for my $mod (@mods) {
213 } 281 }
214 } 282 }
215 283
216 my @defaults = ($url); 284 my @defaults = ($url);
217 my @matchers; 285 my @matchers;
218 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++) {
219 $res = $self->locale_decode ($res);
220 utf8::encode $res;
221 my $launcher = $self->my_resource ("launcher.$idx"); 287 my $launcher = $self->my_resource ("launcher.$idx");
222 $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher; 288 $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher;
223 my $rend = $self->parse_rend($self->my_resource ("rend.$idx")); 289 my $rend = $self->parse_rend($self->my_resource ("rend.$idx"));
224 unshift @matchers, [qr($res)x,$launcher,$rend]; 290 unshift @matchers, [qr($res)x,$launcher,$rend];
225 } 291 }
226 $self->{matchers} = \@matchers; 292 $self->{matchers} = \@matchers;
227 293
228 () 294 ()
229} 295}
230 296
231sub get_urls_from_line {
232 my ($self, $line) = @_;
233 my @urls;
234 for my $matcher (@{$self->{matchers}}) {
235 while ($line =~ /$matcher->[0]/g) {
236 push @urls, substr( $line, $-[0], $+[0] - $-[0] );
237 }
238 }
239 return @urls;
240}
241
242sub on_line_update { 297sub on_line_update {
243 my ($self, $row) = @_; 298 my ($self, $row) = @_;
244 299
245 # fetch the line that has changed 300 # fetch the line that has changed
246 my $line = $self->line ($row); 301 my $line = $self->line ($row);
247 my $text = $line->t; 302 my $text = $line->t;
248 my $i = 0; 303 my $rend;
249 304
250 # find all urls (if any) 305 # find all urls (if any)
251 for my $matcher (@{$self->{matchers}}) { 306 for my $matcher (@{$self->{matchers}}) {
252 while ($text =~ /$matcher->[0]/g) { 307 while ($text =~ /$matcher->[0]/g) {
253 #print "$&\n"; 308 #print "$&\n";
254 my $rend = $line->r; 309 $rend ||= $line->r;
255 310
256 # mark all characters as underlined. we _must_ not toggle underline, 311 # mark all characters as underlined. we _must_ not toggle underline,
257 # as we might get called on an already-marked url. 312 # as we might get called on an already-marked url.
258 &{$matcher->[2]} 313 &{$matcher->[2]}
259 for @{$rend}[ $-[0] .. $+[0] - 1]; 314 for @{$rend}[$-[0] .. $+[0] - 1];
260
261 $line->r ($rend);
262 } 315 }
263 } 316 }
317
318 $line->r ($rend) if $rend;
264 319
265 () 320 ()
266} 321}
267 322
268sub valid_button { 323sub valid_button {
271 | urxvt::ShiftMask | urxvt::ControlMask; 326 | urxvt::ShiftMask | urxvt::ControlMask;
272 return ($event->{button} == $self->{button} && 327 return ($event->{button} == $self->{button} &&
273 ($event->{state} & $mask) == $self->{state}); 328 ($event->{state} & $mask) == $self->{state});
274} 329}
275 330
276sub command_for { 331sub find_matches {
277 my ($self, $row, $col) = @_; 332 my ($self, $row, $col) = @_;
278 my $line = $self->line ($row); 333 my $line = $self->line ($row);
279 my $text = $line->t; 334 my $text = $line->t;
335 my $off = $line->offset_of ($row, $col) if defined $col;
280 336
337 my @matches;
281 for my $matcher (@{$self->{matchers}}) { 338 for my $matcher (@{$self->{matchers}}) {
282 my $launcher = $matcher->[1] || $self->{launcher}; 339 my $launcher = $matcher->[1] || $self->{launcher};
283 while (($text =~ /$matcher->[0]/g)) { 340 while ($text =~ /$matcher->[0]/g) {
284 my $match = $&; 341 my $match = substr $text, $-[0], $+[0] - $-[0];
285 my @begin = @-; 342 my @begin = @-;
286 my @end = @+; 343 my @end = @+;
344 my @exec;
345
287 if (!defined($col) || ($-[0] <= $col && $+[0] >= $col)) { 346 if (!defined($off) || ($-[0] <= $off && $+[0] >= $off)) {
288 if ($launcher !~ /\$/) { 347 if ($launcher !~ /\$/) {
289 return ($launcher,$match); 348 @exec = ($launcher, $match);
290 } else { 349 } else {
291 # 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...),
292 # but alas, m//g behaves differently in list context. 351 # but alas, m//g behaves differently in list context.
293 my @exec = map { s/\$(\d+)|\$\{(\d+)\}/ 352 @exec = map { s/\$(\d+)|\$\{(\d+)\}/
294 substr($text,$begin[$1||$2],$end[$1||$2]-$begin[$1||$2]) 353 substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2]
295 /egx; $_ } split(/\s+/, $launcher); 354 /egx; $_ } split /\s+/, $launcher;
296 return @exec;
297 } 355 }
356
357 push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ];
298 } 358 }
299 } 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];
300 } 372 }
301 373
302 () 374 ()
303} 375}
304 376
330 402
331 if($row == $event->{row} && abs($col-$event->{col}) < 2 403 if($row == $event->{row} && abs($col-$event->{col}) < 2
332 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) { 404 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) {
333 if($self->valid_button($event)) { 405 if($self->valid_button($event)) {
334 406
335 $self->exec_async (@$cmd); 407 $self->exec_async (@$cmd);
336 408
337 } 409 }
338 } 410 }
339 411
340 1; 412 1;
341} 413}
342 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
343# 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