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.7 by sf-tpope, Tue Aug 30 20:02:32 2011 UTC vs.
Revision 1.14 by root, Sat May 17 13:34:35 2014 UTC

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
6#:META:X_RESOURCE:%.launcher:string:default launcher command
7#:META:X_RESOURCE:%.button:string:the button, yeah
8#:META:X_RESOURCE:%.pattern.:string:extra pattern to match
9#:META:X_RESOURCE:%.launcher.:string:custom launcher for pattern
10#:META:X_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<urlLauncher> 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 "perl:matcher:last" or
34"perl: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: perl:matcher:last
44 URxvt.keysym.M-Delete: perl: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
6my $url = 52my $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
16sub on_key_press { 62sub on_key_press {
17 my ($self, $event, $keysym, $octets) = @_; 63 my ($self, $event, $keysym, $octets) = @_;
… …
30 $self->matchlist(); 76 $self->matchlist();
31 77
32 $self->exec_async( $self->{launcher}, @args ); 78 $self->exec_async( $self->{launcher}, @args );
33} 79}
34 80
81# backwards compat
35sub on_user_command { 82sub on_user_command {
36 my ($self, $cmd) = @_; 83 my ($self, $cmd) = @_;
37 84
38 if($cmd =~ s/^matcher:list\b//) { 85 if ($cmd =~ s/^matcher:list\b//) {
39 $self->matchlist(); 86 $self->matchlist;
40 } else { 87 } else {
41 if($cmd =~ s/^matcher:last\b//) { 88 if ($cmd =~ s/^matcher:last\b//) {
42 $self->most_recent; 89 $self->most_recent;
43 }
44 # For backward compatibility
45 else {
46 if($cmd =~ s/^matcher\b//) { 90 } elsif ($cmd =~ s/^matcher\b//) {
91 # for backward compatibility
47 $self->most_recent; 92 $self->most_recent;
48 } 93 }
49 } 94 }
50 } 95
51 () 96 ()
52} 97}
53 98
54sub matchlist { 99sub matchlist {
55 my ($self) = @_; 100 my ($self) = @_;
56 if ( $self->{showing} ) { 101 if ( $self->{showing} ) {
57 $self->{url_overlay}->hide(); 102 $self->{url_overlay}->hide;
58 $self->{showing} = 0; 103 $self->{showing} = 0;
59 return; 104 return;
60 } 105 }
61 @{$self->{urls}} = (); 106 @{$self->{urls}} = ();
62 my $line; 107 my $line;
… …
122 } 167 }
123 () 168 ()
124} 169}
125 170
126sub my_resource { 171sub my_resource {
127 my $self = shift; 172 $_[0]->x_resource ("%.$_[1]")
128 $self->x_resource ("$self->{name}.$_[0]");
129} 173}
130 174
131# turn a rendition spec in the resource into a sub that implements it on $_ 175# turn a rendition spec in the resource into a sub that implements it on $_
132sub parse_rend { 176sub parse_rend {
133 my ($self, $str) = @_; 177 my ($self, $str) = @_;
… …
144} 188}
145 189
146sub on_start { 190sub on_start {
147 my ($self) = @_; 191 my ($self) = @_;
148 192
149 ($self->{name} = __PACKAGE__) =~ s/.*:://; 193 $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 194
155 $self->{urls} = []; 195 $self->{urls} = [];
156 $self->{showing} = 0; 196 $self->{showing} = 0;
157 $self->{button} = 2; 197 $self->{button} = 2;
158 $self->{state} = 0; 198 $self->{state} = 0;
159 if($self->{argv}[0] || $self->my_resource("button")) { 199 if($self->{argv}[0] || $self->my_resource ("button")) {
160 my @mods = split('', $self->{argv}[0] || $self->my_resource("button")); 200 my @mods = split '', $self->{argv}[0] || $self->my_resource ("button");
161 for my $mod (@mods) { 201 for my $mod (@mods) {
162 if($mod =~ /^\d+$/) { 202 if($mod =~ /^\d+$/) {
163 $self->{button} = $mod; 203 $self->{button} = $mod;
164 } elsif($mod eq "C") { 204 } elsif($mod eq "C") {
165 $self->{state} |= urxvt::ControlMask; 205 $self->{state} |= urxvt::ControlMask;
166 } elsif($mod eq "S") { 206 } elsif($mod eq "S") {
167 $self->{state} |= urxvt::ShiftMask; 207 $self->{state} |= urxvt::ShiftMask;
168 } elsif($mod eq "M") { 208 } elsif($mod eq "M") {
169 $self->{state} |= $self->ModMetaMask; 209 $self->{state} |= $self->ModMetaMask;
170 } elsif($mod ne "-" && $mod ne " ") { 210 } elsif($mod ne "-" && $mod ne " ") {
171 warn("$mod is invalid in $self->{name}<$self->{argv}[0]>\n"); 211 warn("$mod is invalid in $self->{_name}<$self->{argv}[0]>\n");
172 } 212 }
173 } 213 }
174 } 214 }
175 215
176 my @defaults = ($url); 216 my @defaults = ($url);
177 my @matchers; 217 my @matchers;
178 for (my $idx = 0; defined (my $res = $self->my_resource("pattern.$idx") || $defaults[$idx]); $idx++) { 218 for (my $idx = 0; defined (my $res = $self->my_resource ("pattern.$idx") || $defaults[$idx]); $idx++) {
179 $res = $self->locale_decode ($res); 219 $res = $self->locale_decode ($res);
180 utf8::encode $res; 220 utf8::encode $res;
181 my $launcher = $self->my_resource("launcher.$idx"); 221 my $launcher = $self->my_resource ("launcher.$idx");
182 $launcher =~ s/\$&|\$\{&\}/\${0}/g if ($launcher); 222 $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher;
183 my $rend = $self->parse_rend($self->my_resource("rend.$idx")); 223 my $rend = $self->parse_rend($self->my_resource ("rend.$idx"));
184 unshift @matchers, [qr($res)x,$launcher,$rend]; 224 unshift @matchers, [qr($res)x,$launcher,$rend];
185 } 225 }
186 $self->{matchers} = \@matchers; 226 $self->{matchers} = \@matchers;
187 227
188 () 228 ()

Diff Legend

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