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