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.4 by tpope, Sun Jun 10 23:42:36 2007 UTC vs.
Revision 1.25 by sf-exg, Fri Jun 13 21:49:19 2014 UTC

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
14matcher - match strings in terminal output and change their rendition
15
16=head1 DESCRIPTION
17
18Uses per-line display filtering (C<on_line_update>) to underline text
19matching a certain pattern and make it clickable. When clicked with the
20mouse button specified in the C<matcher.button> resource (default 2, or
21middle), the program specified in the C<matcher.launcher> resource
22(default, the C<url-launcher> resource, C<sensible-browser>) will be started
23with the matched text as first argument. The default configuration is
24suitable for matching URLs and launching a web browser, like the
25former "mark-urls" extension.
26
27The default pattern to match URLs can be overridden with the
28C<matcher.pattern.0> resource, and additional patterns can be specified
29with numbered patterns, in a manner similar to the "selection" extension.
30The launcher can also be overridden on a per-pattern basis.
31
32It 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
34"matcher:list" as seen in the example below.
35
36Example: load and use the matcher extension with defaults.
37
38 URxvt.perl-ext: default,matcher
39
40Example: 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
5my $url = 52my $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
62sub on_key_press {
63 my ($self, $event, $keysym, $octets) = @_;
64
65 return unless $self->{overlay};
66
67 delete $self->{overlay};
68
69 my $i = ($keysym == 96 ? 0 : $keysym - 48);
70 if ($i >= 0 && $i < @{ $self->{matches} }) {
71 my @exec = @{ $self->{matches}[$i] };
72 shift @exec;
73 $self->exec_async (@exec);
74 }
75
76 1
77}
78
79# backwards compat
15sub on_user_command { 80sub on_user_command {
16 my ($self, $cmd) = @_; 81 my ($self, $cmd) = @_;
82
17 if($cmd =~ s/^matcher\b//) { 83 if ($cmd =~ s/^matcher:list\b//) {
84 $self->matchlist;
85 } else {
86 if ($cmd =~ s/^matcher:last\b//) {
87 $self->most_recent;
88 } elsif ($cmd =~ s/^matcher\b//) {
89 # for backward compatibility
90 $self->most_recent;
91 }
92 }
93
94 ()
95}
96
97sub on_action {
98 my ($self, $action) = @_;
99
100 if ($action eq "list") {
101 $self->matchlist;
102 } elsif ($action eq "last") {
18 $self->most_recent; 103 $self->most_recent;
19 } 104 }
105
20 () 106 ()
107}
108
109sub matchlist {
110 my ($self) = @_;
111
112 @{ $self->{matches} } = ();
113 my $row = $self->nrow - 1;
114 while ($row >= 0 && @{ $self->{matches} } < 10) {
115 my $line = $self->line ($row);
116 my @matches = $self->find_matches ($row);
117
118 for (sort { $b->[0] <=> $a->[0] } @matches) {
119 shift @$_;
120 push @{ $self->{matches} }, $_;
121 last if @{ $self->{matches} } == 10;
122 }
123
124 $row = $line->beg - 1;
125 }
126
127 return unless @{ $self->{matches} };
128
129 my $width = 0;
130
131 my $i = 0;
132 for my $match (@{ $self->{matches} }) {
133 my $text = $match->[0];
134 my $w = $self->strwidth ("$i-$text");
135
136 $width = $w if $w > $width;
137 $i++;
138 }
139
140 $width = $self->ncol - 2 if $width > $self->ncol - 2;
141
142 $self->{overlay} = $self->overlay (0, 0, $width, scalar (@{ $self->{matches} }), urxvt::OVERLAY_RSTYLE, 2);
143 my $i = 0;
144 for my $match (@{ $self->{matches} }) {
145 my $text = $match->[0];
146
147 $self->{overlay}->set (0, $i, "$i-$text");
148 $i++;
149 }
150
21} 151}
22 152
23sub most_recent { 153sub most_recent {
24 my ($self) = shift; 154 my ($self) = shift;
25 my $row = $self->nrow; 155 my $row = $self->nrow;
26 my @exec; 156 my @exec;
27 while($row-- > $self->top_row) { 157 while($row-- > $self->top_row) {
28 #my $line = $self->line ($row);
29 #my $text = $line->t;
30 @exec = $self->command_for($row); 158 @exec = $self->command_for($row);
31 last if(@exec); 159 last if(@exec);
32 } 160 }
33 if(@exec) { 161 if(@exec) {
34 return $self->exec_async (@exec); 162 return $self->exec_async (@exec);
35 } 163 }
36 () 164 ()
37} 165}
38 166
39sub my_resource { 167sub my_resource {
40 my $self = shift; 168 $_[0]->x_resource ("%.$_[1]")
41 $self->x_resource ("$self->{name}.$_[0]");
42} 169}
43 170
44# turn a rendition spec in the resource into a sub that implements it on $_ 171# turn a rendition spec in the resource into a sub that implements it on $_
45sub parse_rend { 172sub parse_rend {
46 my ($self, $str) = @_; 173 my ($self, $str) = @_;
47 my ($mask, $fg, $bg, $failed) = $str ? urxvt::rend2mask($str) 174 my ($mask, $fg, $bg, $failed) = $str ? urxvt::rend2mask($str)
48 : (urxvt::RS_Uline, undef, undef, []); 175 : (urxvt::RS_Uline, undef, undef, []);
49 warn "Failed to parse rendition string: " . join(',', @$failed) if @$failed; 176 warn "Failed to parse rendition string: " . join(',', @$failed) if @$failed;
50 my @rend; 177 my @rend;
51 push @rend, sub { $_ |= $mask } if $mask; 178 push @rend, sub { $_ |= $mask } if $mask;
52 push @rend, sub { $_ = urxvt::SET_FGCOLOR($_, $fg) } if defined $fg; 179 push @rend, sub { $_ = urxvt::SET_FGCOLOR($_, $fg) } if defined $fg;
… …
57} 184}
58 185
59sub on_start { 186sub on_start {
60 my ($self) = @_; 187 my ($self) = @_;
61 188
62 ($self->{name} = __PACKAGE__) =~ s/.*:://; 189 $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 190
191 $self->{matches} = [];
68 $self->{button} = 2; 192 $self->{button} = 2;
69 $self->{state} = 0; 193 $self->{state} = 0;
70 if($self->{argv}[0] || $self->my_resource("button")) { 194 if($self->{argv}[0] || $self->my_resource ("button")) {
71 my @mods = split('', $self->{argv}[0] || $self->my_resource("button")); 195 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button");
72 for my $mod (@mods) { 196 for my $mod (@mods) {
73 if($mod =~ /^\d+$/) { 197 if($mod =~ /^\d+$/) {
74 $self->{button} = $mod; 198 $self->{button} = $mod;
75 } elsif($mod eq "C") { 199 } elsif($mod eq "C") {
76 $self->{state} |= urxvt::ControlMask; 200 $self->{state} |= urxvt::ControlMask;
77 } elsif($mod eq "S") { 201 } elsif($mod eq "S") {
78 $self->{state} |= urxvt::ShiftMask; 202 $self->{state} |= urxvt::ShiftMask;
79 } elsif($mod eq "M") { 203 } elsif($mod eq "M") {
80 $self->{state} |= $self->ModMetaMask; 204 $self->{state} |= $self->ModMetaMask;
81 } elsif($mod ne "-" && $mod ne " ") { 205 } elsif($mod ne "-" && $mod ne " ") {
82 warn("$mod is invalid in $self->{name}<$self->{argv}[0]>\n"); 206 warn("$mod is invalid in $self->{_name}<$self->{argv}[0]>\n");
83 } 207 }
84 } 208 }
85 } 209 }
86 210
87 my @defaults = ($url); 211 my @defaults = ($url);
88 my @matchers; 212 my @matchers;
89 for (my $idx = 0; defined (my $res = $self->my_resource("pattern.$idx") || $defaults[$idx]); $idx++) { 213 for (my $idx = 0; defined (my $res = $self->my_resource ("pattern.$idx") || $defaults[$idx]); $idx++) {
90 $res = $self->locale_decode ($res); 214 $res = $self->locale_decode ($res);
91 utf8::encode $res; 215 utf8::encode $res;
92 my $launcher = $self->my_resource("launcher.$idx"); 216 my $launcher = $self->my_resource ("launcher.$idx");
93 $launcher =~ s/\$&|\$\{&\}/\${0}/g if ($launcher); 217 $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher;
94 my $rend = $self->parse_rend($self->my_resource("rend.$idx")); 218 my $rend = $self->parse_rend($self->my_resource ("rend.$idx"));
95 unshift @matchers, [qr($res)x,$launcher,$rend]; 219 unshift @matchers, [qr($res)x,$launcher,$rend];
96 } 220 }
97 $self->{matchers} = \@matchers; 221 $self->{matchers} = \@matchers;
98 222
99 () 223 ()
… …
131 | urxvt::ShiftMask | urxvt::ControlMask; 255 | urxvt::ShiftMask | urxvt::ControlMask;
132 return ($event->{button} == $self->{button} && 256 return ($event->{button} == $self->{button} &&
133 ($event->{state} & $mask) == $self->{state}); 257 ($event->{state} & $mask) == $self->{state});
134} 258}
135 259
136sub command_for { 260sub find_matches {
137 my ($self, $row, $col) = @_; 261 my ($self, $row, $col) = @_;
138 my $line = $self->line ($row); 262 my $line = $self->line ($row);
139 my $text = $line->t; 263 my $text = $line->t;
264 my $off = $line->offset_of ($row, $col) if $col;
140 265
266 my @matches;
141 for my $matcher (@{$self->{matchers}}) { 267 for my $matcher (@{$self->{matchers}}) {
142 my $launcher = $matcher->[1] || $self->{launcher}; 268 my $launcher = $matcher->[1] || $self->{launcher};
143 while (($text =~ /$matcher->[0]/g)) { 269 while ($text =~ /$matcher->[0]/g) {
144 my $match = $&; 270 my $match = substr $text, $-[0], $+[0] - $-[0];
145 my @begin = @-; 271 my @begin = @-;
146 my @end = @+; 272 my @end = @+;
273 my @exec;
274
147 if (!defined($col) || ($-[0] <= $col && $+[0] >= $col)) { 275 if (!defined($off) || ($-[0] <= $off && $+[0] >= $off)) {
148 if ($launcher !~ /\$/) { 276 if ($launcher !~ /\$/) {
149 return ($launcher,$match); 277 @exec = ($launcher, $match);
150 } else { 278 } else {
151 # It'd be nice to just access a list like ($&,$1,$2...), 279 # It'd be nice to just access a list like ($&,$1,$2...),
152 # but alas, m//g behaves differently in list context. 280 # but alas, m//g behaves differently in list context.
153 my @exec = map { s/\$(\d+)|\$\{(\d+)\}/ 281 @exec = map { s/\$(\d+)|\$\{(\d+)\}/
154 substr($text,$begin[$1||$2],$end[$1||$2]-$begin[$1||$2]) 282 substr $text, $begin[$1 || $2], $end[$1 || $2] - $begin[$1 || $2]
155 /egx; $_ } split(/\s+/, $launcher); 283 /egx; $_ } split /\s+/, $launcher;
156 return @exec;
157 } 284 }
285
286 push @matches, [ $begin[0], $match, @exec ];
158 } 287 }
159 } 288 }
289 }
290
291 @matches;
292}
293
294sub command_for {
295 my ($self, $row, $col) = @_;
296
297 my @matches = $self->find_matches ($row, $col);
298 if (@matches) {
299 my @match = @{ $matches[0] };
300 return @match[2 .. $#match];
160 } 301 }
161 302
162 () 303 ()
163} 304}
164 305
165sub on_button_press { 306sub on_button_press {
166 my ($self, $event) = @_; 307 my ($self, $event) = @_;
167 if($self->valid_button($event)) { 308 if($self->valid_button($event)
309 && (my @exec = $self->command_for($event->{row},$event->{col}))) {
168 $self->{row} = $event->{row}; 310 $self->{row} = $event->{row};
169 $self->{col} = $event->{col}; 311 $self->{col} = $event->{col};
312 $self->{cmd} = \@exec;
313 return 1;
170 } else { 314 } else {
171 delete $self->{row}; 315 delete $self->{row};
172 delete $self->{col}; 316 delete $self->{col};
317 delete $self->{cmd};
173 } 318 }
174 319
175 () 320 ()
176} 321}
177 322
178sub on_button_release { 323sub on_button_release {
179 my ($self, $event) = @_; 324 my ($self, $event) = @_;
180 325
181 my $row = delete $self->{row}; 326 my $row = delete $self->{row};
182 my $col = delete $self->{col}; 327 my $col = delete $self->{col};
328 my $cmd = delete $self->{cmd};
183 329
330 return if !defined $row;
331
184 if(defined($row) && $row == $event->{row} && abs($col-$event->{col}) < 2) { 332 if($row == $event->{row} && abs($col-$event->{col}) < 2
333 && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) {
185 if($self->valid_button($event)) { 334 if($self->valid_button($event)) {
186 335
187 my @exec = $self->command_for($row,$col);
188 if(@exec) {
189 return $self->exec_async (@exec); 336 $self->exec_async (@$cmd);
337
190 } 338 }
191
192 }
193 } 339 }
194 340
195 () 341 1;
196} 342}
197 343
198# vim:set sw=3 sts=3 et: 344# vim:set sw=3 sts=3 et:

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines