| 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 | |
5 | |
| 6 | #:META:X_RESOURCE:%.launcher:string:default launcher command |
6 | #:META:RESOURCE:%.launcher:string:default launcher command |
| 7 | #:META:X_RESOURCE:%.button:string:the button, yeah |
7 | #:META:RESOURCE:%.button:string:the button, yeah |
| 8 | #:META:X_RESOURCE:%.pattern.:string:extra pattern to match |
8 | #:META:RESOURCE:%.pattern.:string:extra pattern to match |
| 9 | #:META:X_RESOURCE:%.launcher.:string:custom launcher for pattern |
9 | #:META:RESOURCE:%.launcher.:string:custom launcher for pattern |
| 10 | #:META:X_RESOURCE:%.rend.:string:custom rednition for pattern |
10 | #:META:RESOURCE:%.rend.:string:custom rendition for pattern |
| 11 | |
11 | |
| 12 | =head1 NAME |
12 | =head1 NAME |
| 13 | |
13 | |
| 14 | matcher - match strings in terminal output and change their rendition |
14 | matcher - match strings in terminal output and change their rendition |
| 15 | |
15 | |
| 16 | =head1 DESCRPTION |
16 | =head1 DESCRIPTION |
| 17 | |
17 | |
| 18 | Uses per-line display filtering (C<on_line_update>) to underline text |
18 | Uses per-line display filtering (C<on_line_update>) to underline text |
| 19 | matching a certain pattern and make it clickable. When clicked with the |
19 | matching a certain pattern and make it clickable. When clicked with the |
| 20 | mouse button specified in the C<matcher.button> resource (default 2, or |
20 | mouse button specified in the C<matcher.button> resource (default 2, or |
| 21 | middle), the program specified in the C<matcher.launcher> resource |
21 | middle), the program specified in the C<matcher.launcher> resource |
| 22 | (default, the C<urlLauncher> resource, C<sensible-browser>) will be started |
22 | (default, the C<url-launcher> resource, C<sensible-browser>) will be started |
| 23 | with the matched text as first argument. The default configuration is |
23 | with the matched text as first argument. The default configuration is |
| 24 | suitable for matching URLs and launching a web browser, like the |
24 | suitable for matching URLs and launching a web browser, like the |
| 25 | former "mark-urls" extension. |
25 | former "mark-urls" extension. |
| 26 | |
26 | |
| 27 | The default pattern to match URLs can be overridden with the |
27 | The default pattern to match URLs can be overridden with the |
| 28 | C<matcher.pattern.0> resource, and additional patterns can be specified |
28 | C<matcher.pattern.0> resource, and additional patterns can be specified |
| 29 | with numbered patterns, in a manner similar to the "selection" extension. |
29 | with numbered patterns, in a manner similar to the "selection" extension. |
| 30 | The launcher can also be overridden on a per-pattern basis. |
30 | The launcher can also be overridden on a per-pattern basis. |
| 31 | |
31 | |
| 32 | It is possible to activate the most recently seen match or a list of matches |
32 | It is possible to activate the most recently seen match or a list of matches |
| 33 | from the keyboard. Simply bind a keysym to "perl:matcher:last" or |
33 | from the keyboard. Simply bind a keysym to "matcher:last" or |
| 34 | "perl:matcher:list" as seen in the example below. |
34 | "matcher:list" as seen in the example below. |
| 35 | |
35 | |
| 36 | Example configuration: |
36 | Example: load and use the matcher extension with defaults. |
| 37 | |
37 | |
| 38 | URxvt.perl-ext: default,matcher |
38 | URxvt.perl-ext: default,matcher |
|
|
39 | |
|
|
40 | Example: use a custom configuration. |
|
|
41 | |
| 39 | URxvt.url-launcher: sensible-browser |
42 | URxvt.url-launcher: sensible-browser |
| 40 | URxvt.keysym.C-Delete: perl:matcher:last |
43 | URxvt.keysym.C-Delete: matcher:last |
| 41 | URxvt.keysym.M-Delete: perl:matcher:list |
44 | URxvt.keysym.M-Delete: matcher:list |
| 42 | URxvt.matcher.button: 1 |
45 | URxvt.matcher.button: 1 |
| 43 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
46 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
| 44 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
47 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
| 45 | URxvt.matcher.launcher.2: gvim +$2 $1 |
48 | URxvt.matcher.launcher.2: gvim +$2 $1 |
| 46 | |
49 | |
| 47 | =cut |
50 | =cut |
| 48 | |
51 | |
| 49 | my $url = |
52 | my $url = |
| 50 | qr{ |
53 | qr{ |
| 51 | (?:https?://|ftp://|news://|mailto:|file://|\bwww\.) |
54 | (?:https?://|ftp://|news://|mailto:|file://|\bwww\.) |
| 52 | [a-zA-Z0-9\-\@;\/?:&=%\$_.+!*\x27,~#]* |
55 | [\w\-\@;\/?:&=%\$.+!*\x27,~#]* |
| 53 | ( |
56 | ( |
| 54 | \([a-zA-Z0-9\-\@;\/?:&=%\$_.+!*\x27,~#]*\)| # Allow a pair of matched parentheses |
57 | \([\w\-\@;\/?:&=%\$.+!*\x27,~#]*\)| # Allow a pair of matched parentheses |
| 55 | [a-zA-Z0-9\-\@;\/?:&=%\$_+*~] # exclude some trailing characters (heuristic) |
58 | [\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic) |
| 56 | )+ |
59 | )+ |
| 57 | }x; |
60 | }x; |
| 58 | |
61 | |
| 59 | sub on_key_press { |
62 | sub matchlist_key_press { |
| 60 | my ($self, $event, $keysym, $octets) = @_; |
63 | my ($self, $event, $keysym, $octets) = @_; |
| 61 | |
64 | |
| 62 | if (! $self->{showing} ) { |
65 | delete $self->{overlay}; |
| 63 | return; |
66 | $self->disable ("key_press"); |
| 64 | } |
|
|
| 65 | |
67 | |
| 66 | my $i = ($keysym == 96 ? 0 : $keysym - 48); |
68 | my $i = ($keysym == 96 ? 0 : $keysym - 48); |
| 67 | if (($i > scalar(@{$self->{urls}})) || ($i < 0)) { |
69 | if ($i >= 0 && $i < @{ $self->{matches} }) { |
| 68 | $self->matchlist(); |
70 | my @exec = @{ $self->{matches}[$i] }; |
| 69 | return; |
71 | $self->exec_async (@exec[5 .. $#exec]); |
|
|
72 | } |
|
|
73 | |
| 70 | } |
74 | 1 |
| 71 | |
|
|
| 72 | my @args = ($self->{urls}[ -$i-1 ]); |
|
|
| 73 | $self->matchlist(); |
|
|
| 74 | |
|
|
| 75 | $self->exec_async( $self->{launcher}, @args ); |
|
|
| 76 | } |
75 | } |
| 77 | |
76 | |
|
|
77 | # backwards compat |
| 78 | sub on_user_command { |
78 | sub on_user_command { |
| 79 | my ($self, $cmd) = @_; |
79 | my ($self, $cmd) = @_; |
| 80 | |
80 | |
| 81 | if($cmd =~ s/^matcher:list\b//) { |
81 | if ($cmd =~ s/^matcher:list\b//) { |
| 82 | $self->matchlist(); |
82 | $self->matchlist; |
| 83 | } else { |
83 | } else { |
| 84 | if($cmd =~ s/^matcher:last\b//) { |
84 | if ($cmd =~ s/^matcher:last\b//) { |
| 85 | $self->most_recent; |
85 | $self->most_recent; |
| 86 | } |
|
|
| 87 | # For backward compatibility |
|
|
| 88 | else { |
|
|
| 89 | if($cmd =~ s/^matcher\b//) { |
86 | } elsif ($cmd =~ s/^matcher\b//) { |
|
|
87 | # for backward compatibility |
| 90 | $self->most_recent; |
88 | $self->most_recent; |
| 91 | } |
89 | } |
| 92 | } |
90 | } |
|
|
91 | |
|
|
92 | () |
|
|
93 | } |
|
|
94 | |
|
|
95 | sub on_action { |
|
|
96 | my ($self, $action) = @_; |
|
|
97 | |
|
|
98 | if ($action eq "list") { |
|
|
99 | $self->matchlist; |
|
|
100 | } elsif ($action eq "last") { |
|
|
101 | $self->most_recent; |
| 93 | } |
102 | } |
|
|
103 | |
| 94 | () |
104 | () |
| 95 | } |
105 | } |
| 96 | |
106 | |
| 97 | sub matchlist { |
107 | sub matchlist { |
| 98 | my ($self) = @_; |
108 | my ($self) = @_; |
| 99 | if ( $self->{showing} ) { |
109 | |
| 100 | $self->{url_overlay}->hide(); |
110 | $self->{matches} = []; |
| 101 | $self->{showing} = 0; |
111 | my $row = $self->nrow - 1; |
| 102 | return; |
112 | while ($row >= 0 && @{ $self->{matches} } < 10) { |
| 103 | } |
|
|
| 104 | @{$self->{urls}} = (); |
|
|
| 105 | my $line; |
|
|
| 106 | for (my $i = 0; $i < $self->nrow; $i ++) { |
|
|
| 107 | $line = $self->line($i); |
113 | my $line = $self->line ($row); |
| 108 | next if ($line->beg != $i); |
114 | my @matches = $self->find_matches ($row); |
| 109 | for my $url ($self->get_urls_from_line($line->t)) { |
115 | |
| 110 | if (scalar(@{$self->{urls}}) == 10) { |
116 | for (sort { $b->[0] <=> $a->[0] or $b->[1] <=> $a->[1] } @matches) { |
| 111 | shift @{$self->{urls}}; |
|
|
| 112 | } |
|
|
| 113 | push @{$self->{urls}}, $url; |
117 | push @{ $self->{matches} }, $_; |
|
|
118 | last if @{ $self->{matches} } == 10; |
| 114 | } |
119 | } |
|
|
120 | |
|
|
121 | $row = $line->beg - 1; |
| 115 | } |
122 | } |
| 116 | |
123 | |
| 117 | if (! scalar(@{$self->{urls}})) { |
124 | return unless @{ $self->{matches} }; |
| 118 | return; |
|
|
| 119 | } |
|
|
| 120 | |
125 | |
| 121 | my $max = 0; |
126 | my $width = 0; |
| 122 | my $i = scalar( @{$self->{urls}} ) - 1 ;; |
|
|
| 123 | |
127 | |
| 124 | my @temp = (); |
|
|
| 125 | |
|
|
| 126 | for my $url (@{$self->{urls}}) { |
|
|
| 127 | my $url = "$i-$url"; |
|
|
| 128 | my $xpos = 0; |
|
|
| 129 | |
|
|
| 130 | if ($self->ncol + (length $url) >= $self->ncol) { |
|
|
| 131 | $url = substr( $url, 0, $self->ncol ); |
|
|
| 132 | } |
|
|
| 133 | |
|
|
| 134 | push @temp, $url; |
|
|
| 135 | |
|
|
| 136 | if( length $url > $max ) { |
|
|
| 137 | $max = length $url; |
|
|
| 138 | } |
|
|
| 139 | |
|
|
| 140 | $i--; |
|
|
| 141 | } |
|
|
| 142 | |
|
|
| 143 | @temp = reverse @temp; |
|
|
| 144 | |
|
|
| 145 | $self->{url_overlay} = $self->overlay(0, 0, $max, scalar( @temp ), urxvt::OVERLAY_RSTYLE, 2); |
|
|
| 146 | my $i = 0; |
128 | my $i = 0; |
| 147 | for my $url (@temp) { |
129 | for my $match (@{ $self->{matches} }) { |
| 148 | $self->{url_overlay}->set( 0, $i, $url, [(urxvt::OVERLAY_RSTYLE) x length $url]); |
130 | my $text = $match->[4]; |
| 149 | $self->{showing} = 1; |
131 | my $w = $self->strwidth ("$i-$text"); |
|
|
132 | |
|
|
133 | $width = $w if $w > $width; |
| 150 | $i++; |
134 | $i++; |
| 151 | } |
135 | } |
| 152 | |
136 | |
|
|
137 | $width = $self->ncol - 2 if $width > $self->ncol - 2; |
|
|
138 | |
|
|
139 | $self->{overlay} = $self->overlay (0, 0, $width, scalar (@{ $self->{matches} }), urxvt::OVERLAY_RSTYLE, 2); |
|
|
140 | my $i = 0; |
|
|
141 | for my $match (@{ $self->{matches} }) { |
|
|
142 | my $text = $match->[4]; |
|
|
143 | |
|
|
144 | $self->{overlay}->set (0, $i, "$i-$text"); |
|
|
145 | $i++; |
|
|
146 | } |
|
|
147 | |
|
|
148 | $self->enable (key_press => \&matchlist_key_press); |
| 153 | } |
149 | } |
| 154 | |
150 | |
| 155 | sub most_recent { |
151 | sub most_recent { |
| 156 | my ($self) = shift; |
152 | my ($self) = shift; |
| 157 | my $row = $self->nrow; |
153 | my $row = $self->nrow; |
| … | |
… | |
| 188 | sub on_start { |
184 | sub on_start { |
| 189 | my ($self) = @_; |
185 | my ($self) = @_; |
| 190 | |
186 | |
| 191 | $self->{launcher} = $self->my_resource ("launcher") || $self->x_resource("url-launcher") || "sensible-browser"; |
187 | $self->{launcher} = $self->my_resource ("launcher") || $self->x_resource("url-launcher") || "sensible-browser"; |
| 192 | |
188 | |
| 193 | $self->{urls} = []; |
|
|
| 194 | $self->{showing} = 0; |
|
|
| 195 | $self->{button} = 2; |
189 | $self->{button} = 2; |
| 196 | $self->{state} = 0; |
190 | $self->{state} = 0; |
| 197 | if($self->{argv}[0] || $self->my_resource ("button")) { |
191 | if($self->{argv}[0] || $self->my_resource ("button")) { |
| 198 | my @mods = split '', $self->{argv}[0] || $self->my_resource ("button"); |
192 | my @mods = split '', $self->{argv}[0] || $self->my_resource ("button"); |
| 199 | for my $mod (@mods) { |
193 | for my $mod (@mods) { |
| … | |
… | |
| 224 | $self->{matchers} = \@matchers; |
218 | $self->{matchers} = \@matchers; |
| 225 | |
219 | |
| 226 | () |
220 | () |
| 227 | } |
221 | } |
| 228 | |
222 | |
| 229 | sub get_urls_from_line { |
|
|
| 230 | my ($self, $line) = @_; |
|
|
| 231 | my @urls; |
|
|
| 232 | for my $matcher (@{$self->{matchers}}) { |
|
|
| 233 | while ($line =~ /$matcher->[0]/g) { |
|
|
| 234 | push @urls, substr( $line, $-[0], $+[0] - $-[0] ); |
|
|
| 235 | } |
|
|
| 236 | } |
|
|
| 237 | return @urls; |
|
|
| 238 | } |
|
|
| 239 | |
|
|
| 240 | sub on_line_update { |
223 | sub on_line_update { |
| 241 | my ($self, $row) = @_; |
224 | my ($self, $row) = @_; |
| 242 | |
225 | |
| 243 | # fetch the line that has changed |
226 | # fetch the line that has changed |
| 244 | my $line = $self->line ($row); |
227 | my $line = $self->line ($row); |
| 245 | my $text = $line->t; |
228 | my $text = $line->t; |
| 246 | my $i = 0; |
|
|
| 247 | |
229 | |
| 248 | # find all urls (if any) |
230 | # find all urls (if any) |
| 249 | for my $matcher (@{$self->{matchers}}) { |
231 | for my $matcher (@{$self->{matchers}}) { |
| 250 | while ($text =~ /$matcher->[0]/g) { |
232 | while ($text =~ /$matcher->[0]/g) { |
| 251 | #print "$&\n"; |
233 | #print "$&\n"; |
| … | |
… | |
| 269 | | urxvt::ShiftMask | urxvt::ControlMask; |
251 | | urxvt::ShiftMask | urxvt::ControlMask; |
| 270 | return ($event->{button} == $self->{button} && |
252 | return ($event->{button} == $self->{button} && |
| 271 | ($event->{state} & $mask) == $self->{state}); |
253 | ($event->{state} & $mask) == $self->{state}); |
| 272 | } |
254 | } |
| 273 | |
255 | |
| 274 | sub command_for { |
256 | sub find_matches { |
| 275 | my ($self, $row, $col) = @_; |
257 | my ($self, $row, $col) = @_; |
| 276 | my $line = $self->line ($row); |
258 | my $line = $self->line ($row); |
| 277 | my $text = $line->t; |
259 | my $text = $line->t; |
|
|
260 | my $off = $line->offset_of ($row, $col) if defined $col; |
| 278 | |
261 | |
|
|
262 | my @matches; |
| 279 | for my $matcher (@{$self->{matchers}}) { |
263 | for my $matcher (@{$self->{matchers}}) { |
| 280 | my $launcher = $matcher->[1] || $self->{launcher}; |
264 | my $launcher = $matcher->[1] || $self->{launcher}; |
| 281 | while (($text =~ /$matcher->[0]/g)) { |
265 | while ($text =~ /$matcher->[0]/g) { |
| 282 | my $match = $&; |
266 | my $match = substr $text, $-[0], $+[0] - $-[0]; |
| 283 | my @begin = @-; |
267 | my @begin = @-; |
| 284 | my @end = @+; |
268 | my @end = @+; |
|
|
269 | my @exec; |
|
|
270 | |
| 285 | if (!defined($col) || ($-[0] <= $col && $+[0] >= $col)) { |
271 | if (!defined($off) || ($-[0] <= $off && $+[0] >= $off)) { |
| 286 | if ($launcher !~ /\$/) { |
272 | if ($launcher !~ /\$/) { |
| 287 | return ($launcher,$match); |
273 | @exec = ($launcher, $match); |
| 288 | } else { |
274 | } else { |
| 289 | # It'd be nice to just access a list like ($&,$1,$2...), |
275 | # It'd be nice to just access a list like ($&,$1,$2...), |
| 290 | # but alas, m//g behaves differently in list context. |
276 | # but alas, m//g behaves differently in list context. |
| 291 | my @exec = map { s/\$(\d+)|\$\{(\d+)\}/ |
277 | @exec = map { s/\$(\d+)|\$\{(\d+)\}/ |
| 292 | substr($text,$begin[$1||$2],$end[$1||$2]-$begin[$1||$2]) |
278 | substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2] |
| 293 | /egx; $_ } split(/\s+/, $launcher); |
279 | /egx; $_ } split /\s+/, $launcher; |
| 294 | return @exec; |
|
|
| 295 | } |
280 | } |
|
|
281 | |
|
|
282 | push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ]; |
| 296 | } |
283 | } |
| 297 | } |
284 | } |
|
|
285 | } |
|
|
286 | |
|
|
287 | @matches; |
|
|
288 | } |
|
|
289 | |
|
|
290 | sub command_for { |
|
|
291 | my ($self, $row, $col) = @_; |
|
|
292 | |
|
|
293 | my @matches = $self->find_matches ($row, $col); |
|
|
294 | if (@matches) { |
|
|
295 | my @match = @{ $matches[0] }; |
|
|
296 | return @match[5 .. $#match]; |
| 298 | } |
297 | } |
| 299 | |
298 | |
| 300 | () |
299 | () |
| 301 | } |
300 | } |
| 302 | |
301 | |
| … | |
… | |
| 328 | |
327 | |
| 329 | if($row == $event->{row} && abs($col-$event->{col}) < 2 |
328 | if($row == $event->{row} && abs($col-$event->{col}) < 2 |
| 330 | && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) { |
329 | && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) { |
| 331 | if($self->valid_button($event)) { |
330 | if($self->valid_button($event)) { |
| 332 | |
331 | |
| 333 | $self->exec_async (@$cmd); |
332 | $self->exec_async (@$cmd); |
| 334 | |
333 | |
| 335 | } |
334 | } |
| 336 | } |
335 | } |
| 337 | |
336 | |
| 338 | 1; |
337 | 1; |
