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.33 by sf-exg, Mon Oct 13 19:39:42 2014 UTC vs.
Revision 1.40 by root, Fri Dec 9 05:06:46 2022 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 rendition for pattern 11#:META:RESOURCE:%.rend.:string:custom rendition for pattern
11 12
12=head1 NAME 13=head1 NAME
18Uses per-line display filtering (C<on_line_update>) to underline text 19Uses per-line display filtering (C<on_line_update>) to underline text
19matching a certain pattern and make it clickable. When clicked with the 20matching a certain pattern and make it clickable. When clicked with the
20mouse button specified in the C<matcher.button> resource (default 2, or 21mouse button specified in the C<matcher.button> resource (default 2, or
21middle), the program specified in the C<matcher.launcher> resource 22middle), the program specified in the C<matcher.launcher> resource
22(default, the C<url-launcher> resource, C<sensible-browser>) will be started 23(default, the C<url-launcher> resource, C<sensible-browser>) will be started
23with the matched text as first argument. The default configuration is 24with the matched text as first argument. The default configuration is
24suitable for matching URLs and launching a web browser, like the 25suitable for matching URLs and launching a web browser, like the
25former "mark-urls" extension. 26former "mark-urls" extension.
26 27
27The default pattern to match URLs can be overridden with the 28The default pattern to match URLs can be overridden with the
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 "matcher:last" or 34from the keyboard. Simply bind a keysym to "matcher:last" or
34"matcher:list" as seen in the example below. 35"matcher:list" as seen in the example below.
35 36
36The 'matcher:select' action enables a mode in which it is possible to 37The C<matcher:select> action enables a mode in which it is possible to
37iterate over the matches using the keyboard and either activate them 38iterate over the matches using the keyboard and either activate them
38or copy them to the clipboard. While the mode is active, normal terminal 39or copy them to the clipboard. While the mode is active, normal terminal
39input/output is suspended and the following bindings are recognized: 40input/output is suspended and the following bindings are recognized:
40 41
41=over 4 42=over
42 43
43=item C<Up> 44=item C<Up>
44 45
45Search for a match upwards. 46Search for a match upwards.
46 47
67=item C<y> 68=item C<y>
68 69
69Copy the current match to the clipboard. 70Copy the current match to the clipboard.
70 71
71=back 72=back
73
74It is also possible to cycle through the matches using a key
75combination bound to the C<matcher:select> action.
72 76
73Example: load and use the matcher extension with defaults. 77Example: load and use the matcher extension with defaults.
74 78
75 URxvt.perl-ext: default,matcher 79 URxvt.perl-ext: default,matcher
76 80
82 URxvt.matcher.button: 1 86 URxvt.matcher.button: 1
83 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] 87 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
84 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) 88 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
85 URxvt.matcher.launcher.2: gvim +$2 $1 89 URxvt.matcher.launcher.2: gvim +$2 $1
86 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
87=cut 121=cut
88 122
89my $url = 123my $url =
90 qr{ 124 qr{
91 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.) 125 (?:https?://|ftp://|news://|mailto:|file://|\bwww\.)
92 [\w\-\@;\/?:&=%\$.+!*\x27,~#]* 126 [\w\-\@;\/?:&=%\$.+!*\x27,~#$urxvt::NOCHAR]*
93 ( 127 (
94 \([\w\-\@;\/?:&=%\$.+!*\x27,~#]*\)| # Allow a pair of matched parentheses 128 \([\w\-\@;\/?:&=%\$.+!*\x27,~#$urxvt::NOCHAR]*\)| # Allow a pair of matched parentheses
95 [\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic) 129 [\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic)
96 )+ 130 )+
97 }x; 131 }x;
98 132
99sub matchlist_key_press { 133sub matchlist_key_press {
113 147
114# backwards compat 148# backwards compat
115sub on_user_command { 149sub on_user_command {
116 my ($self, $cmd) = @_; 150 my ($self, $cmd) = @_;
117 151
118 if ($cmd =~ s/^matcher:list\b//) { 152 if ($cmd eq "matcher:list") {
119 $self->matchlist; 153 $self->matchlist;
120 } else { 154 } elsif ($cmd eq "matcher:last") {
121 if ($cmd =~ s/^matcher:last\b//) {
122 $self->most_recent; 155 $self->most_recent;
156 } elsif ($cmd eq "matcher:select") {
157 $self->select_enter;
123 } elsif ($cmd =~ s/^matcher\b//) { 158 } elsif ($cmd eq "matcher") {
124 # for backward compatibility 159 # for backward compatibility
125 $self->most_recent; 160 $self->most_recent;
126 }
127 } 161 }
128 162
129 () 163 ()
130} 164}
131 165
189 223
190sub most_recent { 224sub most_recent {
191 my ($self) = shift; 225 my ($self) = shift;
192 my $row = $self->nrow - 1; 226 my $row = $self->nrow - 1;
193 my @exec; 227 my @exec;
228
194 while ($row >= $self->top_row) { 229 while ($row >= $self->top_row) {
195 my $line = $self->line ($row); 230 my $line = $self->line ($row);
196 @exec = $self->command_for($row); 231 @exec = $self->command_for ($row);
197 last if(@exec); 232 last if @exec;
198 233
199 $row = $line->beg - 1; 234 $row = $line->beg - 1;
200 } 235 }
236
201 if(@exec) { 237 if (@exec) {
202 return $self->exec_async (@exec); 238 return $self->exec_async (@exec);
203 } 239 }
240
204 () 241 ()
205} 242}
206 243
207sub my_resource { 244sub my_resource {
208 $_[0]->x_resource ("%.$_[1]") 245 $_[0]->x_resource ("%.$_[1]")
247 } 284 }
248 } 285 }
249 286
250 my @defaults = ($url); 287 my @defaults = ($url);
251 my @matchers; 288 my @matchers;
252 for (my $idx = 0; defined (my $res = $self->my_resource ("pattern.$idx") || $defaults[$idx]); $idx++) { 289 for (my $idx = 0; defined (my $res = $self->locale_decode ($self->my_resource ("pattern.$idx")) || $defaults[$idx]); $idx++) {
253 $res = $self->locale_decode ($res);
254 utf8::encode $res;
255 my $launcher = $self->my_resource ("launcher.$idx"); 290 my $launcher = $self->my_resource ("launcher.$idx");
256 $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher; 291 $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher;
257 my $rend = $self->parse_rend($self->my_resource ("rend.$idx")); 292 my $rend = $self->parse_rend($self->my_resource ("rend.$idx"));
258 unshift @matchers, [qr($res)x,$launcher,$rend]; 293 unshift @matchers, [qr($res)x,$launcher,$rend];
259 } 294 }
309 my $match = substr $text, $-[0], $+[0] - $-[0]; 344 my $match = substr $text, $-[0], $+[0] - $-[0];
310 my @begin = @-; 345 my @begin = @-;
311 my @end = @+; 346 my @end = @+;
312 my @exec; 347 my @exec;
313 348
314 if (!defined($off) || ($-[0] <= $off && $+[0] >= $off)) { 349 if (!(defined $off) || ($-[0] <= $off && $+[0] >= $off)) {
315 if ($launcher !~ /\$/) { 350 if ($launcher !~ /\$/) {
316 @exec = ($launcher, $match); 351 @exec = ($launcher, $match);
317 } else { 352 } else {
318 # It'd be nice to just access a list like ($&,$1,$2...), 353 # It'd be nice to just access a list like ($&,$1,$2...),
319 # but alas, m//g behaves differently in list context. 354 # but alas, m//g behaves differently in list context.
320 @exec = map { s/\$(\d+)|\$\{(\d+)\}/ 355 @exec = map {
356 s{\$(\d+)|\$\{(\d+)\}}{
321 substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2] 357 substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2]
358 }egx;
359 $_
322 /egx; $_ } split /\s+/, $launcher; 360 } split /\s+/, $launcher;
323 } 361 }
324 362
325 push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ]; 363 push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ];
326 } 364 }
327 } 365 }
328 } 366 }
329 367
330 @matches; 368 @matches
331} 369}
332 370
333sub command_for { 371sub command_for {
334 my ($self, $row, $col) = @_; 372 my ($self, $row, $col) = @_;
335 373
342 () 380 ()
343} 381}
344 382
345sub on_button_press { 383sub on_button_press {
346 my ($self, $event) = @_; 384 my ($self, $event) = @_;
385
386 if (
347 if($self->valid_button($event) 387 $self->valid_button ($event)
348 && (my @exec = $self->command_for($event->{row},$event->{col}))) { 388 && (my @exec = $self->command_for ($event->{row}, $event->{col}))
389 ) {
349 $self->{row} = $event->{row}; 390 $self->{row} = $event->{row};
350 $self->{col} = $event->{col}; 391 $self->{col} = $event->{col};
351 $self->{cmd} = \@exec; 392 $self->{cmd} = \@exec;
352 return 1; 393 return 1;
353 } else { 394 } else {
366 my $col = delete $self->{col}; 407 my $col = delete $self->{col};
367 my $cmd = delete $self->{cmd}; 408 my $cmd = delete $self->{cmd};
368 409
369 return if !defined $row; 410 return if !defined $row;
370 411
371 if($row == $event->{row} && abs($col-$event->{col}) < 2 412 if (
413 $row == $event->{row}
414 && (abs $col-$event->{col}) < 2
372 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) { 415 && (join "\x00", @$cmd) eq (join "\x00", $self->command_for ($row, $col))
416 ) {
373 if($self->valid_button($event)) { 417 if ($self->valid_button ($event)) {
374
375 $self->exec_async (@$cmd); 418 $self->exec_async (@$cmd);
376
377 } 419 }
378 } 420 }
379 421
380 1; 422 1;
381} 423}
419 if (@matches) { 461 if (@matches) {
420 @matches = sort { $a->[0] <=> $b->[0] or $a->[1] <=> $b->[1] } @matches; 462 @matches = sort { $a->[0] <=> $b->[0] or $a->[1] <=> $b->[1] } @matches;
421 $self->{matches} = \@matches; 463 $self->{matches} = \@matches;
422 $self->{cur_row} = $row; 464 $self->{cur_row} = $row;
423 $self->{id} = $dir < 0 ? @{ $self->{matches} } - 1 : 0; 465 $self->{id} = $dir < 0 ? @{ $self->{matches} } - 1 : 0;
424 $self->view_start (List::Util::min 0, $row - ($self->nrow >> 1)); 466 $self->view_start ($row - ($self->nrow >> 1));
425 $self->want_refresh; 467 $self->want_refresh;
426 return; 468 return 1;
427 } 469 }
428 470
429 $row = $dir < 0 ? $line->beg - 1 : $line->end + 1; 471 $row = $dir < 0 ? $line->beg - 1 : $line->end + 1;
430 } 472 }
431 473
432 $self->scr_bell; 474 $self->scr_bell;
475
476 ()
433} 477}
434 478
435sub select_refresh { 479sub select_refresh {
436 my ($self) = @_; 480 my ($self) = @_;
437 481
481 } else { 525 } else {
482 my $line = $self->line ($self->{cur_row}); 526 my $line = $self->line ($self->{cur_row});
483 $self->select_search (+1, $line->end + 1) 527 $self->select_search (+1, $line->end + 1)
484 if $line->end < $self->nrow; 528 if $line->end < $self->nrow;
485 } 529 }
530 } elsif ($self->lookup_keysym ($keysym, $event->{state}) eq "matcher:select") {
531 if ($self->{id} > 0) {
532 $self->{id}--;
533 $self->want_refresh;
534 } else {
535 my $line = $self->line ($self->{cur_row});
536 $self->select_search (-1, $self->nrow - 1)
537 unless $self->select_search (-1, $line->beg - 1);
538 }
486 } 539 }
487 540
488 1 541 1
489} 542}
490 543

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines