| 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 | |
| 14 | matcher - match strings in terminal output and change their rendition |
15 | matcher - match strings in terminal output and change their rendition |
| 15 | |
16 | |
| … | |
… | |
| 31 | |
32 | |
| 32 | It is possible to activate the most recently seen match or a list of matches |
33 | It is possible to activate the most recently seen match or a list of matches |
| 33 | from the keyboard. Simply bind a keysym to "matcher:last" or |
34 | from 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 | |
|
|
37 | The C<matcher:select> action enables a mode in which it is possible to |
|
|
38 | iterate over the matches using the keyboard and either activate them |
|
|
39 | or copy them to the clipboard. While the mode is active, normal terminal |
|
|
40 | input/output is suspended and the following bindings are recognized: |
|
|
41 | |
|
|
42 | =over |
|
|
43 | |
|
|
44 | =item C<Up> |
|
|
45 | |
|
|
46 | Search for a match upwards. |
|
|
47 | |
|
|
48 | =item C<Down> |
|
|
49 | |
|
|
50 | Search for a match downwards. |
|
|
51 | |
|
|
52 | =item C<Home> |
|
|
53 | |
|
|
54 | Jump to the topmost match. |
|
|
55 | |
|
|
56 | =item C<End> |
|
|
57 | |
|
|
58 | Jump to the bottommost match. |
|
|
59 | |
|
|
60 | =item C<Escape> |
|
|
61 | |
|
|
62 | Leave the mode and return to the point where search was started. |
|
|
63 | |
|
|
64 | =item C<Enter> |
|
|
65 | |
|
|
66 | Activate the current match. |
|
|
67 | |
|
|
68 | =item C<y> |
|
|
69 | |
|
|
70 | Copy the current match to the clipboard. |
|
|
71 | |
|
|
72 | =back |
|
|
73 | |
|
|
74 | It is also possible to cycle through the matches using a key |
|
|
75 | combination bound to the C<matcher:select> action. |
|
|
76 | |
| 36 | Example: load and use the matcher extension with defaults. |
77 | Example: load and use the matcher extension with defaults. |
| 37 | |
78 | |
| 38 | URxvt.perl-ext: default,matcher |
79 | URxvt.perl-ext: default,matcher |
| 39 | |
80 | |
| 40 | Example: use a custom configuration. |
81 | Example: use a custom configuration. |
| … | |
… | |
| 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 | |
|
|
93 | Urxvt stores all text as unicode, in a special encoding that uses |
|
|
94 | one character/code point per column. For various reasons, the regular |
|
|
95 | expressions are matched directly against this encoding, which means there are a few things |
|
|
96 | you need to keep in mind: |
|
|
97 | |
|
|
98 | =over |
|
|
99 | |
|
|
100 | =item X resources/command line arguments are locale-encoded |
|
|
101 | |
|
|
102 | The regexes taken from the command line or resources will be converted |
|
|
103 | from locale encoding to unicode. This can change the number of code points |
|
|
104 | per character. |
|
|
105 | |
|
|
106 | =item Wide characters are column-padded with C<$urxvt::NOCHAR> |
|
|
107 | |
|
|
108 | Wide characters (such as kanji and sometimes tabs) are padded with |
|
|
109 | a special character value (C<$urxvt::NOCHAR>). That means that |
|
|
110 | constructs such as C<\w> or C<.> will only match part of a character, as |
|
|
111 | C<$urxvt::NOCHAR> is not matched by C<\w> and both only match the first |
|
|
112 | "column" of a wide character. |
|
|
113 | |
|
|
114 | That means you have to incorporate C<$urxvt::NOCHAR> into parts of regexes |
|
|
115 | that may match wide characters. For example, to match C<\w+> you might |
|
|
116 | want 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 | |
| 52 | my $url = |
123 | my $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 | |
| 62 | sub matchlist_key_press { |
133 | sub matchlist_key_press { |
| … | |
… | |
| 76 | |
147 | |
| 77 | # backwards compat |
148 | # backwards compat |
| 78 | sub on_user_command { |
149 | sub on_user_command { |
| 79 | my ($self, $cmd) = @_; |
150 | my ($self, $cmd) = @_; |
| 80 | |
151 | |
| 81 | if ($cmd =~ s/^matcher:list\b//) { |
152 | if ($cmd eq "matcher:list") { |
| 82 | $self->matchlist; |
153 | $self->matchlist; |
| 83 | } else { |
154 | } elsif ($cmd eq "matcher:last") { |
| 84 | if ($cmd =~ s/^matcher:last\b//) { |
|
|
| 85 | $self->most_recent; |
155 | $self->most_recent; |
|
|
156 | } elsif ($cmd eq "matcher:select") { |
|
|
157 | $self->select_enter; |
| 86 | } elsif ($cmd =~ s/^matcher\b//) { |
158 | } elsif ($cmd eq "matcher") { |
| 87 | # for backward compatibility |
159 | # for backward compatibility |
| 88 | $self->most_recent; |
160 | $self->most_recent; |
| 89 | } |
|
|
| 90 | } |
161 | } |
| 91 | |
162 | |
| 92 | () |
163 | () |
| 93 | } |
164 | } |
| 94 | |
165 | |
| … | |
… | |
| 97 | |
168 | |
| 98 | if ($action eq "list") { |
169 | if ($action eq "list") { |
| 99 | $self->matchlist; |
170 | $self->matchlist; |
| 100 | } elsif ($action eq "last") { |
171 | } elsif ($action eq "last") { |
| 101 | $self->most_recent; |
172 | $self->most_recent; |
|
|
173 | } elsif ($action eq "select") { |
|
|
174 | $self->select_enter; |
| 102 | } |
175 | } |
| 103 | |
176 | |
| 104 | () |
177 | () |
| 105 | } |
178 | } |
| 106 | |
179 | |
| … | |
… | |
| 148 | $self->enable (key_press => \&matchlist_key_press); |
221 | $self->enable (key_press => \&matchlist_key_press); |
| 149 | } |
222 | } |
| 150 | |
223 | |
| 151 | sub most_recent { |
224 | sub most_recent { |
| 152 | my ($self) = shift; |
225 | my ($self) = shift; |
| 153 | my $row = $self->nrow; |
226 | my $row = $self->nrow - 1; |
| 154 | my @exec; |
227 | my @exec; |
| 155 | while($row-- > $self->top_row) { |
228 | while ($row >= $self->top_row) { |
|
|
229 | my $line = $self->line ($row); |
| 156 | @exec = $self->command_for($row); |
230 | @exec = $self->command_for($row); |
| 157 | last if(@exec); |
231 | last if(@exec); |
|
|
232 | |
|
|
233 | $row = $line->beg - 1; |
| 158 | } |
234 | } |
| 159 | if(@exec) { |
235 | if(@exec) { |
| 160 | return $self->exec_async (@exec); |
236 | return $self->exec_async (@exec); |
| 161 | } |
237 | } |
| 162 | () |
238 | () |
| … | |
… | |
| 205 | } |
281 | } |
| 206 | } |
282 | } |
| 207 | |
283 | |
| 208 | my @defaults = ($url); |
284 | my @defaults = ($url); |
| 209 | my @matchers; |
285 | my @matchers; |
| 210 | 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++) { |
| 211 | $res = $self->locale_decode ($res); |
|
|
| 212 | utf8::encode $res; |
|
|
| 213 | my $launcher = $self->my_resource ("launcher.$idx"); |
287 | my $launcher = $self->my_resource ("launcher.$idx"); |
| 214 | $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher; |
288 | $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher; |
| 215 | my $rend = $self->parse_rend($self->my_resource ("rend.$idx")); |
289 | my $rend = $self->parse_rend($self->my_resource ("rend.$idx")); |
| 216 | unshift @matchers, [qr($res)x,$launcher,$rend]; |
290 | unshift @matchers, [qr($res)x,$launcher,$rend]; |
| 217 | } |
291 | } |
| … | |
… | |
| 224 | my ($self, $row) = @_; |
298 | my ($self, $row) = @_; |
| 225 | |
299 | |
| 226 | # fetch the line that has changed |
300 | # fetch the line that has changed |
| 227 | my $line = $self->line ($row); |
301 | my $line = $self->line ($row); |
| 228 | my $text = $line->t; |
302 | my $text = $line->t; |
| 229 | my $i = 0; |
303 | my $rend; |
| 230 | |
304 | |
| 231 | # find all urls (if any) |
305 | # find all urls (if any) |
| 232 | for my $matcher (@{$self->{matchers}}) { |
306 | for my $matcher (@{$self->{matchers}}) { |
| 233 | while ($text =~ /$matcher->[0]/g) { |
307 | while ($text =~ /$matcher->[0]/g) { |
| 234 | #print "$&\n"; |
308 | #print "$&\n"; |
| 235 | my $rend = $line->r; |
309 | $rend ||= $line->r; |
| 236 | |
310 | |
| 237 | # mark all characters as underlined. we _must_ not toggle underline, |
311 | # mark all characters as underlined. we _must_ not toggle underline, |
| 238 | # as we might get called on an already-marked url. |
312 | # as we might get called on an already-marked url. |
| 239 | &{$matcher->[2]} |
313 | &{$matcher->[2]} |
| 240 | for @{$rend}[ $-[0] .. $+[0] - 1]; |
314 | for @{$rend}[$-[0] .. $+[0] - 1]; |
| 241 | |
|
|
| 242 | $line->r ($rend); |
|
|
| 243 | } |
315 | } |
| 244 | } |
316 | } |
|
|
317 | |
|
|
318 | $line->r ($rend) if $rend; |
| 245 | |
319 | |
| 246 | () |
320 | () |
| 247 | } |
321 | } |
| 248 | |
322 | |
| 249 | sub valid_button { |
323 | sub valid_button { |
| … | |
… | |
| 256 | |
330 | |
| 257 | sub find_matches { |
331 | sub find_matches { |
| 258 | my ($self, $row, $col) = @_; |
332 | my ($self, $row, $col) = @_; |
| 259 | my $line = $self->line ($row); |
333 | my $line = $self->line ($row); |
| 260 | my $text = $line->t; |
334 | my $text = $line->t; |
| 261 | my $off = $line->offset_of ($row, $col) if $col; |
335 | my $off = $line->offset_of ($row, $col) if defined $col; |
| 262 | |
336 | |
| 263 | my @matches; |
337 | my @matches; |
| 264 | for my $matcher (@{$self->{matchers}}) { |
338 | for my $matcher (@{$self->{matchers}}) { |
| 265 | my $launcher = $matcher->[1] || $self->{launcher}; |
339 | my $launcher = $matcher->[1] || $self->{launcher}; |
| 266 | while ($text =~ /$matcher->[0]/g) { |
340 | while ($text =~ /$matcher->[0]/g) { |
| … | |
… | |
| 336 | } |
410 | } |
| 337 | |
411 | |
| 338 | 1; |
412 | 1; |
| 339 | } |
413 | } |
| 340 | |
414 | |
|
|
415 | sub 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 | |
|
|
432 | sub 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 | |
|
|
443 | sub 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 | |
|
|
469 | sub 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 | |
|
|
480 | sub 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 | |
| 341 | # vim:set sw=3 sts=3 et: |
534 | # vim:set sw=3 sts=3 et: |
