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.9 by root, Sun Jun 10 13:58:05 2012 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.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:X_RESOURCE:%.launcher:string:default launcher command 7#:META:RESOURCE:%.launcher:string:default launcher command
7#:META:X_RESOURCE:%.button:string:the button, yeah 8#:META:RESOURCE:%.button:string:the mouse button used to activate a match
8#:META:X_RESOURCE:%.pattern.:string:extra pattern to match 9#:META:RESOURCE:%.pattern.:string:extra pattern to match
9#:META:X_RESOURCE:%.launcher.:string:custom launcher for pattern 10#:META:RESOURCE:%.launcher.:string:custom launcher for pattern
10#:META:X_RESOURCE:%.rend.:string:custom rednition 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
11 122
12my $url = 123my $url =
13 qr{ 124 qr{
14 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.) 125 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.)
15 [a-zA-Z0-9\-\@;\/?:&=%\$_.+!*\x27,~#]* 126 [\w\-\@;\/?:&=%\$.+!*\x27,~#$urxvt::NOCHAR]*
16 ( 127 (
17 \([a-zA-Z0-9\-\@;\/?:&=%\$_.+!*\x27,~#]*\)| # Allow a pair of matched parentheses 128 \([\w\-\@;\/?:&=%\$.+!*\x27,~#$urxvt::NOCHAR]*\)| # Allow a pair of matched parentheses
18 [a-zA-Z0-9\-\@;\/?:&=%\$_+*~] # exclude some trailing characters (heuristic) 129 [\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic)
19 )+ 130 )+
20 }x; 131 }x;
21 132
22sub on_key_press { 133sub matchlist_key_press {
23 my ($self, $event, $keysym, $octets) = @_; 134 my ($self, $event, $keysym, $octets) = @_;
24 135
25 if (! $self->{showing} ) { 136 delete $self->{overlay};
26 return; 137 $self->disable ("key_press");
27 }
28 138
29 my $i = ($keysym == 96 ? 0 : $keysym - 48); 139 my $i = ($keysym == 96 ? 0 : $keysym - 48);
30 if (($i > scalar(@{$self->{urls}})) || ($i < 0)) { 140 if ($i >= 0 && $i < @{ $self->{matches} }) {
31 $self->matchlist(); 141 my @exec = @{ $self->{matches}[$i] };
32 return; 142 $self->exec_async (@exec[5 .. $#exec]);
143 }
144
33 } 145 1
34
35 my @args = ($self->{urls}[ -$i-1 ]);
36 $self->matchlist();
37
38 $self->exec_async( $self->{launcher}, @args );
39} 146}
40 147
148# backwards compat
41sub on_user_command { 149sub on_user_command {
42 my ($self, $cmd) = @_; 150 my ($self, $cmd) = @_;
43 151
44 if($cmd =~ s/^matcher:list\b//) { 152 if ($cmd eq "matcher:list") {
45 $self->matchlist(); 153 $self->matchlist;
46 } else { 154 } elsif ($cmd eq "matcher:last") {
47 if($cmd =~ s/^matcher:last\b//) {
48 $self->most_recent; 155 $self->most_recent;
49 } 156 } elsif ($cmd eq "matcher:select") {
157 $self->select_enter;
158 } elsif ($cmd eq "matcher") {
50 # For backward compatibility 159 # for backward compatibility
51 else {
52 if($cmd =~ s/^matcher\b//) {
53 $self->most_recent; 160 $self->most_recent;
54 }
55 }
56 } 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;
175 }
176
57 () 177 ()
58} 178}
59 179
60sub matchlist { 180sub matchlist {
61 my ($self) = @_; 181 my ($self) = @_;
62 if ( $self->{showing} ) { 182
63 $self->{url_overlay}->hide(); 183 $self->{matches} = [];
64 $self->{showing} = 0; 184 my $row = $self->nrow - 1;
65 return; 185 while ($row >= 0 && @{ $self->{matches} } < 10) {
66 }
67 @{$self->{urls}} = ();
68 my $line;
69 for (my $i = 0; $i < $self->nrow; $i ++) {
70 $line = $self->line($i); 186 my $line = $self->line ($row);
71 next if ($line->beg != $i); 187 my @matches = $self->find_matches ($row);
72 for my $url ($self->get_urls_from_line($line->t)) { 188
73 if (scalar(@{$self->{urls}}) == 10) { 189 for (sort { $b->[0] <=> $a->[0] or $b->[1] <=> $a->[1] } @matches) {
74 shift @{$self->{urls}};
75 }
76 push @{$self->{urls}}, $url; 190 push @{ $self->{matches} }, $_;
191 last if @{ $self->{matches} } == 10;
77 } 192 }
193
194 $row = $line->beg - 1;
78 } 195 }
79 196
80 if (! scalar(@{$self->{urls}})) { 197 return unless @{ $self->{matches} };
81 return;
82 }
83 198
84 my $max = 0; 199 my $width = 0;
85 my $i = scalar( @{$self->{urls}} ) - 1 ;;
86 200
87 my @temp = ();
88
89 for my $url (@{$self->{urls}}) {
90 my $url = "$i-$url";
91 my $xpos = 0;
92
93 if ($self->ncol + (length $url) >= $self->ncol) {
94 $url = substr( $url, 0, $self->ncol );
95 }
96
97 push @temp, $url;
98
99 if( length $url > $max ) {
100 $max = length $url;
101 }
102
103 $i--;
104 }
105
106 @temp = reverse @temp;
107
108 $self->{url_overlay} = $self->overlay(0, 0, $max, scalar( @temp ), urxvt::OVERLAY_RSTYLE, 2);
109 my $i = 0; 201 my $i = 0;
110 for my $url (@temp) { 202 for my $match (@{ $self->{matches} }) {
111 $self->{url_overlay}->set( 0, $i, $url, [(urxvt::OVERLAY_RSTYLE) x length $url]); 203 my $text = $match->[4];
112 $self->{showing} = 1; 204 my $w = $self->strwidth ("$i-$text");
205
206 $width = $w if $w > $width;
113 $i++; 207 $i++;
114 } 208 }
115 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);
116} 222}
117 223
118sub most_recent { 224sub most_recent {
119 my ($self) = shift; 225 my ($self) = @_;
120 my $row = $self->nrow; 226 my $row = $self->nrow - 1;
121 my @exec; 227
122 while($row-- > $self->top_row) { 228 while ($row >= $self->top_row) {
229 my $line = $self->line ($row);
123 @exec = $self->command_for($row); 230 my @exec = $self->command_for ($row);
124 last if(@exec);
125 }
126 if(@exec) { 231 if (@exec) {
127 return $self->exec_async (@exec); 232 return $self->exec_async (@exec);
233 }
234
235 $row = $line->beg - 1;
128 } 236 }
237
129 () 238 ()
130} 239}
131 240
132sub my_resource { 241sub my_resource {
133 $_[0]->x_resource ("%.$_[1]") 242 $_[0]->x_resource ("%.$_[1]")
151sub on_start { 260sub on_start {
152 my ($self) = @_; 261 my ($self) = @_;
153 262
154 $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";
155 264
156 $self->{urls} = [];
157 $self->{showing} = 0;
158 $self->{button} = 2; 265 $self->{button} = 2;
159 $self->{state} = 0; 266 $self->{state} = 0;
160 if($self->{argv}[0] || $self->my_resource ("button")) { 267 if($self->{argv}[0] || $self->my_resource ("button")) {
161 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button"); 268 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button");
162 for my $mod (@mods) { 269 for my $mod (@mods) {
174 } 281 }
175 } 282 }
176 283
177 my @defaults = ($url); 284 my @defaults = ($url);
178 my @matchers; 285 my @matchers;
179 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++) {
180 $res = $self->locale_decode ($res);
181 utf8::encode $res;
182 my $launcher = $self->my_resource ("launcher.$idx"); 287 my $launcher = $self->my_resource ("launcher.$idx");
183 $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher; 288 $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher;
184 my $rend = $self->parse_rend($self->my_resource ("rend.$idx")); 289 my $rend = $self->parse_rend($self->my_resource ("rend.$idx"));
185 unshift @matchers, [qr($res)x,$launcher,$rend]; 290 unshift @matchers, [qr($res)x,$launcher,$rend];
186 } 291 }
187 $self->{matchers} = \@matchers; 292 $self->{matchers} = \@matchers;
188 293
189 () 294 ()
190} 295}
191 296
192sub get_urls_from_line {
193 my ($self, $line) = @_;
194 my @urls;
195 for my $matcher (@{$self->{matchers}}) {
196 while ($line =~ /$matcher->[0]/g) {
197 push @urls, substr( $line, $-[0], $+[0] - $-[0] );
198 }
199 }
200 return @urls;
201}
202
203sub on_line_update { 297sub on_line_update {
204 my ($self, $row) = @_; 298 my ($self, $row) = @_;
205 299
206 # fetch the line that has changed 300 # fetch the line that has changed
207 my $line = $self->line ($row); 301 my $line = $self->line ($row);
208 my $text = $line->t; 302 my $text = $line->t;
209 my $i = 0; 303 my $rend;
210 304
211 # find all urls (if any) 305 # find all urls (if any)
212 for my $matcher (@{$self->{matchers}}) { 306 for my $matcher (@{$self->{matchers}}) {
213 while ($text =~ /$matcher->[0]/g) { 307 while ($text =~ /$matcher->[0]/g) {
214 #print "$&\n"; 308 #print "$&\n";
215 my $rend = $line->r; 309 $rend ||= $line->r;
216 310
217 # mark all characters as underlined. we _must_ not toggle underline, 311 # mark all characters as underlined. we _must_ not toggle underline,
218 # as we might get called on an already-marked url. 312 # as we might get called on an already-marked url.
219 &{$matcher->[2]} 313 &{$matcher->[2]}
220 for @{$rend}[ $-[0] .. $+[0] - 1]; 314 for @{$rend}[$-[0] .. $+[0] - 1];
221
222 $line->r ($rend);
223 } 315 }
224 } 316 }
317
318 $line->r ($rend) if $rend;
225 319
226 () 320 ()
227} 321}
228 322
229sub valid_button { 323sub valid_button {
232 | urxvt::ShiftMask | urxvt::ControlMask; 326 | urxvt::ShiftMask | urxvt::ControlMask;
233 return ($event->{button} == $self->{button} && 327 return ($event->{button} == $self->{button} &&
234 ($event->{state} & $mask) == $self->{state}); 328 ($event->{state} & $mask) == $self->{state});
235} 329}
236 330
237sub command_for { 331sub find_matches {
238 my ($self, $row, $col) = @_; 332 my ($self, $row, $col) = @_;
239 my $line = $self->line ($row); 333 my $line = $self->line ($row);
240 my $text = $line->t; 334 my $text = $line->t;
335 my $off = $line->offset_of ($row, $col) if defined $col;
241 336
337 my @matches;
242 for my $matcher (@{$self->{matchers}}) { 338 for my $matcher (@{$self->{matchers}}) {
243 my $launcher = $matcher->[1] || $self->{launcher}; 339 my $launcher = $matcher->[1] || $self->{launcher};
244 while (($text =~ /$matcher->[0]/g)) { 340 while ($text =~ /$matcher->[0]/g) {
245 my $match = $&; 341 my $match = substr $text, $-[0], $+[0] - $-[0];
246 my @begin = @-; 342 my @begin = @-;
247 my @end = @+; 343 my @end = @+;
344 my @exec;
345
248 if (!defined($col) || ($-[0] <= $col && $+[0] >= $col)) { 346 if (!(defined $off) || ($-[0] <= $off && $+[0] >= $off)) {
249 if ($launcher !~ /\$/) { 347 if ($launcher !~ /\$/) {
250 return ($launcher,$match); 348 @exec = ($launcher, $match);
251 } else { 349 } else {
252 # 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...),
253 # but alas, m//g behaves differently in list context. 351 # but alas, m//g behaves differently in list context.
254 my @exec = map { s/\$(\d+)|\$\{(\d+)\}/ 352 @exec = map {
353 s{\$(\d+)|\$\{(\d+)\}}{
255 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 $_
256 /egx; $_ } split(/\s+/, $launcher); 357 } split /\s+/, $launcher;
257 return @exec;
258 } 358 }
359
360 push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ];
259 } 361 }
260 } 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];
261 } 375 }
262 376
263 () 377 ()
264} 378}
265 379
266sub on_button_press { 380sub on_button_press {
267 my ($self, $event) = @_; 381 my ($self, $event) = @_;
382
383 if (
268 if($self->valid_button($event) 384 $self->valid_button ($event)
269 && (my @exec = $self->command_for($event->{row},$event->{col}))) { 385 && (my @exec = $self->command_for ($event->{row}, $event->{col}))
386 ) {
270 $self->{row} = $event->{row}; 387 $self->{row} = $event->{row};
271 $self->{col} = $event->{col}; 388 $self->{col} = $event->{col};
272 $self->{cmd} = \@exec; 389 $self->{cmd} = \@exec;
273 return 1; 390 return 1;
274 } else { 391 } else {
287 my $col = delete $self->{col}; 404 my $col = delete $self->{col};
288 my $cmd = delete $self->{cmd}; 405 my $cmd = delete $self->{cmd};
289 406
290 return if !defined $row; 407 return if !defined $row;
291 408
292 if($row == $event->{row} && abs($col-$event->{col}) < 2 409 if (
410 $row == $event->{row}
411 && (abs $col-$event->{col}) < 2
293 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) { 412 && (join "\x00", @$cmd) eq (join "\x00", $self->command_for ($row, $col))
413 ) {
294 if($self->valid_button($event)) { 414 if ($self->valid_button ($event)) {
295
296 $self->exec_async (@$cmd); 415 $self->exec_async (@$cmd);
297
298 } 416 }
299 } 417 }
300 418
301 1; 419 1;
302} 420}
303 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,
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
539}
540
304# 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