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> |
|
|
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 rednition 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 |
4 | |
51 | |
5 | my $url = |
52 | my $url = |
6 | qr{ |
53 | qr{ |
7 | (?:https?://|ftp://|news://|mailto:|file://|\bwww\.) |
54 | (?:https?://|ftp://|news://|mailto:|file://|\bwww\.) |
8 | [a-zA-Z0-9\-\@;\/?:&=%\$_.+!*\x27,~#]* |
55 | [\w\-\@;\/?:&=%\$.+!*\x27,~#]* |
9 | ( |
56 | ( |
10 | \([a-zA-Z0-9\-\@;\/?:&=%\$_.+!*\x27,~#]*\)| # Allow a pair of matched parentheses |
57 | \([\w\-\@;\/?:&=%\$.+!*\x27,~#]*\)| # Allow a pair of matched parentheses |
11 | [a-zA-Z0-9\-\@;\/?:&=%\$_+*~] # exclude some trailing characters (heuristic) |
58 | [\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic) |
12 | )+ |
59 | )+ |
13 | }x; |
60 | }x; |
14 | |
61 | |
|
|
62 | sub matchlist_key_press { |
|
|
63 | my ($self, $event, $keysym, $octets) = @_; |
|
|
64 | |
|
|
65 | delete $self->{overlay}; |
|
|
66 | $self->disable ("key_press"); |
|
|
67 | |
|
|
68 | my $i = ($keysym == 96 ? 0 : $keysym - 48); |
|
|
69 | if ($i >= 0 && $i < @{ $self->{matches} }) { |
|
|
70 | my @exec = @{ $self->{matches}[$i] }; |
|
|
71 | $self->exec_async (@exec[5 .. $#exec]); |
|
|
72 | } |
|
|
73 | |
|
|
74 | 1 |
|
|
75 | } |
|
|
76 | |
|
|
77 | # backwards compat |
15 | sub on_user_command { |
78 | sub on_user_command { |
16 | my ($self, $cmd) = @_; |
79 | my ($self, $cmd) = @_; |
|
|
80 | |
17 | if($cmd =~ s/^matcher\b//) { |
81 | if ($cmd =~ s/^matcher:list\b//) { |
|
|
82 | $self->matchlist; |
|
|
83 | } else { |
|
|
84 | if ($cmd =~ s/^matcher:last\b//) { |
|
|
85 | $self->most_recent; |
|
|
86 | } elsif ($cmd =~ s/^matcher\b//) { |
|
|
87 | # for backward compatibility |
|
|
88 | $self->most_recent; |
|
|
89 | } |
|
|
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") { |
18 | $self->most_recent; |
101 | $self->most_recent; |
19 | } |
102 | } |
|
|
103 | |
|
|
104 | () |
|
|
105 | } |
|
|
106 | |
|
|
107 | sub matchlist { |
|
|
108 | my ($self) = @_; |
|
|
109 | |
|
|
110 | $self->{matches} = []; |
|
|
111 | my $row = $self->nrow - 1; |
|
|
112 | while ($row >= 0 && @{ $self->{matches} } < 10) { |
|
|
113 | my $line = $self->line ($row); |
|
|
114 | my @matches = $self->find_matches ($row); |
|
|
115 | |
|
|
116 | for (sort { $b->[0] <=> $a->[0] or $b->[1] <=> $a->[1] } @matches) { |
|
|
117 | push @{ $self->{matches} }, $_; |
|
|
118 | last if @{ $self->{matches} } == 10; |
|
|
119 | } |
|
|
120 | |
|
|
121 | $row = $line->beg - 1; |
|
|
122 | } |
|
|
123 | |
|
|
124 | return unless @{ $self->{matches} }; |
|
|
125 | |
|
|
126 | my $width = 0; |
|
|
127 | |
|
|
128 | my $i = 0; |
|
|
129 | for my $match (@{ $self->{matches} }) { |
|
|
130 | my $text = $match->[4]; |
|
|
131 | my $w = $self->strwidth ("$i-$text"); |
|
|
132 | |
|
|
133 | $width = $w if $w > $width; |
|
|
134 | $i++; |
|
|
135 | } |
|
|
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); |
|
|
149 | } |
|
|
150 | |
|
|
151 | sub most_recent { |
|
|
152 | my ($self) = shift; |
20 | my $row = $self->nrow; |
153 | my $row = $self->nrow; |
21 | my @exec; |
154 | my @exec; |
22 | while($row-- > $self->top_row) { |
155 | while($row-- > $self->top_row) { |
23 | #my $line = $self->line ($row); |
|
|
24 | #my $text = $line->t; |
|
|
25 | @exec = $self->command_for($row); |
156 | @exec = $self->command_for($row); |
26 | last if(@exec); |
157 | last if(@exec); |
27 | } |
158 | } |
28 | if(@exec) { |
159 | if(@exec) { |
29 | return $self->exec_async (@exec); |
160 | return $self->exec_async (@exec); |
30 | } |
161 | } |
31 | () |
162 | () |
32 | } |
163 | } |
33 | |
164 | |
34 | sub most_recent { |
|
|
35 | my ($self) = shift; |
|
|
36 | () |
|
|
37 | } |
|
|
38 | |
|
|
39 | sub my_resource { |
165 | sub my_resource { |
40 | my $self = shift; |
166 | $_[0]->x_resource ("%.$_[1]") |
41 | $self->x_resource("$self->{name}.$_[0]"); |
|
|
42 | } |
167 | } |
43 | |
168 | |
44 | # 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 $_ |
45 | sub parse_rend { |
170 | sub parse_rend { |
46 | my ($self, $str) = @_; |
171 | my ($self, $str) = @_; |
47 | my ($mask, $fg, $bg, $failed) = $str ? urxvt::rend2mask($str) |
172 | my ($mask, $fg, $bg, $failed) = $str ? urxvt::rend2mask($str) |
48 | : (urxvt::RS_Uline, undef, undef, []); |
173 | : (urxvt::RS_Uline, undef, undef, []); |
49 | warn "Failed to parse rendition string: " . join(',', @$failed) if @$failed; |
174 | warn "Failed to parse rendition string: " . join(',', @$failed) if @$failed; |
50 | my @rend; |
175 | my @rend; |
51 | push @rend, sub { $_ |= $mask } if $mask; |
176 | push @rend, sub { $_ |= $mask } if $mask; |
52 | push @rend, sub { $_ = urxvt::SET_FGCOLOR($_, $fg) } if defined $fg; |
177 | push @rend, sub { $_ = urxvt::SET_FGCOLOR($_, $fg) } if defined $fg; |
… | |
… | |
57 | } |
182 | } |
58 | |
183 | |
59 | sub on_start { |
184 | sub on_start { |
60 | my ($self) = @_; |
185 | my ($self) = @_; |
61 | |
186 | |
62 | ($self->{name} = __PACKAGE__) =~ s/.*:://; |
187 | $self->{launcher} = $self->my_resource ("launcher") || $self->x_resource("url-launcher") || "sensible-browser"; |
63 | $self->{name} =~ tr/_/-/; |
|
|
64 | $self->{launcher} = $self->my_resource("launcher") || |
|
|
65 | $self->x_resource("urlLauncher") || |
|
|
66 | "sensible-browser"; |
|
|
67 | |
188 | |
68 | $self->{button} = 2; |
189 | $self->{button} = 2; |
69 | $self->{state} = 0; |
190 | $self->{state} = 0; |
70 | if($self->{argv}[0] || $self->my_resource("button")) { |
191 | if($self->{argv}[0] || $self->my_resource ("button")) { |
71 | my @mods = split('', $self->{argv}[0] || $self->my_resource("button")); |
192 | my @mods = split '', $self->{argv}[0] || $self->my_resource ("button"); |
72 | for my $mod (@mods) { |
193 | for my $mod (@mods) { |
73 | if($mod =~ /^\d+$/) { |
194 | if($mod =~ /^\d+$/) { |
74 | $self->{button} = $mod; |
195 | $self->{button} = $mod; |
75 | } elsif($mod eq "C") { |
196 | } elsif($mod eq "C") { |
76 | $self->{state} |= urxvt::ControlMask; |
197 | $self->{state} |= urxvt::ControlMask; |
77 | } elsif($mod eq "S") { |
198 | } elsif($mod eq "S") { |
78 | $self->{state} |= urxvt::ShiftMask; |
199 | $self->{state} |= urxvt::ShiftMask; |
79 | } elsif($mod eq "M") { |
200 | } elsif($mod eq "M") { |
80 | $self->{state} |= $self->ModMetaMask; |
201 | $self->{state} |= $self->ModMetaMask; |
81 | } elsif($mod ne "-" && $mod ne " ") { |
202 | } elsif($mod ne "-" && $mod ne " ") { |
82 | warn("$mod is invalid in $self->{name}<$self->{argv}[0]>\n"); |
203 | warn("$mod is invalid in $self->{_name}<$self->{argv}[0]>\n"); |
83 | } |
204 | } |
84 | } |
205 | } |
85 | } |
206 | } |
86 | |
207 | |
87 | my @defaults = ($url); |
208 | my @defaults = ($url); |
88 | my @matchers; |
209 | my @matchers; |
89 | 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++) { |
90 | $res = $self->locale_decode ($res); |
211 | $res = $self->locale_decode ($res); |
91 | utf8::encode $res; |
212 | utf8::encode $res; |
92 | my $launcher = $self->my_resource("launcher.$idx"); |
213 | my $launcher = $self->my_resource ("launcher.$idx"); |
93 | $launcher =~ s/\$&|\$\{&\}/\${0}/g if ($launcher); |
214 | $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher; |
94 | my $rend = $self->parse_rend($self->my_resource("rend.$idx")); |
215 | my $rend = $self->parse_rend($self->my_resource ("rend.$idx")); |
95 | unshift @matchers, [qr($res)x,$launcher,$rend]; |
216 | unshift @matchers, [qr($res)x,$launcher,$rend]; |
96 | } |
217 | } |
97 | $self->{matchers} = \@matchers; |
218 | $self->{matchers} = \@matchers; |
98 | |
219 | |
99 | () |
220 | () |
… | |
… | |
131 | | urxvt::ShiftMask | urxvt::ControlMask; |
252 | | urxvt::ShiftMask | urxvt::ControlMask; |
132 | return ($event->{button} == $self->{button} && |
253 | return ($event->{button} == $self->{button} && |
133 | ($event->{state} & $mask) == $self->{state}); |
254 | ($event->{state} & $mask) == $self->{state}); |
134 | } |
255 | } |
135 | |
256 | |
136 | sub command_for { |
257 | sub find_matches { |
137 | my ($self, $row, $col) = @_; |
258 | my ($self, $row, $col) = @_; |
138 | my $line = $self->line ($row); |
259 | my $line = $self->line ($row); |
139 | my $text = $line->t; |
260 | my $text = $line->t; |
|
|
261 | my $off = $line->offset_of ($row, $col) if $col; |
140 | |
262 | |
|
|
263 | my @matches; |
141 | for my $matcher (@{$self->{matchers}}) { |
264 | for my $matcher (@{$self->{matchers}}) { |
142 | my $launcher = $matcher->[1] || $self->{launcher}; |
265 | my $launcher = $matcher->[1] || $self->{launcher}; |
143 | while (($text =~ /$matcher->[0]/g)) { |
266 | while ($text =~ /$matcher->[0]/g) { |
144 | my $match = $&; |
267 | my $match = substr $text, $-[0], $+[0] - $-[0]; |
145 | my @begin = @-; |
268 | my @begin = @-; |
146 | my @end = @+; |
269 | my @end = @+; |
|
|
270 | my @exec; |
|
|
271 | |
147 | if (!defined($col) || ($-[0] <= $col && $+[0] >= $col)) { |
272 | if (!defined($off) || ($-[0] <= $off && $+[0] >= $off)) { |
148 | if ($launcher !~ /\$/) { |
273 | if ($launcher !~ /\$/) { |
149 | return ($launcher,$match); |
274 | @exec = ($launcher, $match); |
150 | } else { |
275 | } else { |
151 | # It'd be nice to just access a list like ($&,$1,$2...), |
276 | # It'd be nice to just access a list like ($&,$1,$2...), |
152 | # but alas, m//g behaves differently in list context. |
277 | # but alas, m//g behaves differently in list context. |
153 | my @exec = map { s/\$(\d+)|\$\{(\d+)\}/ |
278 | @exec = map { s/\$(\d+)|\$\{(\d+)\}/ |
154 | substr($text,$begin[$1||$2],$end[$1||$2]-$begin[$1||$2]) |
279 | substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2] |
155 | /egx; $_ } split(/\s+/, $launcher); |
280 | /egx; $_ } split /\s+/, $launcher; |
156 | return @exec; |
|
|
157 | } |
281 | } |
|
|
282 | |
|
|
283 | push @matches, [ $line->coord_of ($begin[0]), $line->coord_of ($end[0]), $match, @exec ]; |
158 | } |
284 | } |
159 | } |
285 | } |
|
|
286 | } |
|
|
287 | |
|
|
288 | @matches; |
|
|
289 | } |
|
|
290 | |
|
|
291 | sub command_for { |
|
|
292 | my ($self, $row, $col) = @_; |
|
|
293 | |
|
|
294 | my @matches = $self->find_matches ($row, $col); |
|
|
295 | if (@matches) { |
|
|
296 | my @match = @{ $matches[0] }; |
|
|
297 | return @match[5 .. $#match]; |
160 | } |
298 | } |
161 | |
299 | |
162 | () |
300 | () |
163 | } |
301 | } |
164 | |
302 | |
165 | sub on_button_press { |
303 | sub on_button_press { |
166 | my ($self, $event) = @_; |
304 | my ($self, $event) = @_; |
167 | if($self->valid_button($event)) { |
305 | if($self->valid_button($event) |
|
|
306 | && (my @exec = $self->command_for($event->{row},$event->{col}))) { |
168 | $self->{row} = $event->{row}; |
307 | $self->{row} = $event->{row}; |
169 | $self->{col} = $event->{col}; |
308 | $self->{col} = $event->{col}; |
|
|
309 | $self->{cmd} = \@exec; |
|
|
310 | return 1; |
170 | } else { |
311 | } else { |
171 | delete $self->{row}; |
312 | delete $self->{row}; |
172 | delete $self->{col}; |
313 | delete $self->{col}; |
|
|
314 | delete $self->{cmd}; |
173 | } |
315 | } |
174 | |
316 | |
175 | () |
317 | () |
176 | } |
318 | } |
177 | |
319 | |
178 | sub on_button_release { |
320 | sub on_button_release { |
179 | my ($self, $event) = @_; |
321 | my ($self, $event) = @_; |
180 | |
322 | |
181 | my $row = delete $self->{row}; |
323 | my $row = delete $self->{row}; |
182 | my $col = delete $self->{col}; |
324 | my $col = delete $self->{col}; |
|
|
325 | my $cmd = delete $self->{cmd}; |
183 | |
326 | |
|
|
327 | return if !defined $row; |
|
|
328 | |
184 | if(defined($row) && $row == $event->{row} && abs($col-$event->{col}) < 2) { |
329 | if($row == $event->{row} && abs($col-$event->{col}) < 2 |
|
|
330 | && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) { |
185 | if($self->valid_button($event)) { |
331 | if($self->valid_button($event)) { |
186 | |
332 | |
187 | my @exec = $self->command_for($row,$col); |
|
|
188 | if(@exec) { |
|
|
189 | return $self->exec_async (@exec); |
333 | $self->exec_async (@$cmd); |
|
|
334 | |
190 | } |
335 | } |
191 | |
|
|
192 | } |
|
|
193 | } |
336 | } |
194 | |
337 | |
195 | () |
338 | 1; |
196 | } |
339 | } |
197 | |
340 | |
198 | # vim:set sw=3 sts=3 et: |
341 | # vim:set sw=3 sts=3 et: |