[ViewVC] Annotation of: cvs/rxvt-unicode/src/perl/matcher

#! perl

# Author: Tim Pope <rxvt-unicodeNOSPAM@tpope.org>
#         Bob Farrell <robertanthonyfarrell@gmail.com>

#:META:RESOURCE:%.launcher:string:default launcher command
#:META:RESOURCE:%.button:string:the button, yeah
#:META:RESOURCE:%.pattern.:string:extra pattern to match
#:META:RESOURCE:%.launcher.:string:custom launcher for pattern
#:META:RESOURCE:%.rend.:string:custom rednition for pattern

=head1 NAME

matcher - match strings in terminal output and change their rendition

=head1 DESCRIPTION

Uses per-line display filtering (C<on_line_update>) to underline text
matching a certain pattern and make it clickable. When clicked with the
mouse button specified in the C<matcher.button> resource (default 2, or
middle), the program specified in the C<matcher.launcher> resource
(default, the C<url-launcher> resource, C<sensible-browser>) will be started
with the matched text as first argument.  The default configuration is
suitable for matching URLs and launching a web browser, like the
former "mark-urls" extension.

The default pattern to match URLs can be overridden with the
C<matcher.pattern.0> resource, and additional patterns can be specified
with numbered patterns, in a manner similar to the "selection" extension.
The launcher can also be overridden on a per-pattern basis.

It is possible to activate the most recently seen match or a list of matches
from the keyboard.  Simply bind a keysym to "perl:matcher:last" or
"perl:matcher:list" as seen in the example below.

Example: load and use the matcher extension with defaults.

    URxvt.perl-ext:           default,matcher

Example: use a custom configuration.

    URxvt.url-launcher:       sensible-browser
    URxvt.keysym.C-Delete:    perl:matcher:last
    URxvt.keysym.M-Delete:    perl:matcher:list
    URxvt.matcher.button:     1
    URxvt.matcher.pattern.1:  \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
    URxvt.matcher.pattern.2:  \\B(/\\S+?):(\\d+)(?=:|$)
    URxvt.matcher.launcher.2: gvim +$2 $1

=cut

my $url =
   qr{
      (?:https?://|ftp://|news://|mailto:|file://|\bwww\.)
      [\w\-\@;\/?:&=%\$.+!*\x27,~#]*
      (
         \([\w\-\@;\/?:&=%\$.+!*\x27,~#]*\)| # Allow a pair of matched parentheses
         [\w\-\@;\/?:&=%\$+*~]  # exclude some trailing characters (heuristic)
      )+
   }x;

sub on_key_press {
   my ($self, $event, $keysym, $octets) = @_;

   if (! $self->{showing} ) {
      return;
   }

   my $i = ($keysym == 96 ? 0 : $keysym - 48);
   if (($i > scalar(@{$self->{urls}})) || ($i < 0)) {
      $self->matchlist();
      return;
   }

   my @args = ($self->{urls}[ -$i-1 ]);
   $self->matchlist();

   $self->exec_async( $self->{launcher}, @args );
}

# backwards compat
sub on_user_command {
   my ($self, $cmd) = @_;

   if ($cmd =~ s/^matcher:list\b//) {
      $self->matchlist;
   } else {
      if ($cmd =~ s/^matcher:last\b//) {
         $self->most_recent;
      } elsif ($cmd =~ s/^matcher\b//) {
         # for backward compatibility
         $self->most_recent;
      }
   }

   ()
}

sub matchlist {
   my ($self) = @_;
   if ( $self->{showing} ) {
     $self->{url_overlay}->hide;
     $self->{showing} = 0;
     return;
   }
  @{$self->{urls}} = ();
  my $line;
  for (my $i = 0; $i < $self->nrow; $i ++) {
     $line = $self->line($i);
     next if ($line->beg != $i);
     for my $url ($self->get_urls_from_line($line->t)) {
        if (scalar(@{$self->{urls}}) == 10) {
            shift @{$self->{urls}};
        }
        push @{$self->{urls}}, $url;
     }
  }

  if (! scalar(@{$self->{urls}})) {
    return;
  }

  my $max = 0;
  my $i = scalar( @{$self->{urls}} ) - 1 ;;

  my @temp = ();

  for my $url (@{$self->{urls}}) {
     my $url = "$i-$url";
     my $xpos = 0;

     if ($self->ncol + (length $url) >= $self->ncol) {
        $url = substr( $url, 0, $self->ncol );
     }

     push @temp, $url;

     if( length $url > $max ) {
        $max = length $url;
     }

     $i--;
  }

  @temp = reverse @temp;

  $self->{url_overlay} = $self->overlay(0, 0, $max, scalar( @temp ), urxvt::OVERLAY_RSTYLE, 2);
  my $i = 0;
  for my $url (@temp) {
     $self->{url_overlay}->set( 0, $i, $url, [(urxvt::OVERLAY_RSTYLE) x length $url]);
        $self->{showing} = 1;
     $i++;
  }

}

sub most_recent {
   my ($self) = shift;
   my $row = $self->nrow;
   my @exec;
   while($row-- > $self->top_row) {
      @exec = $self->command_for($row);
      last if(@exec);
   }
   if(@exec) {
      return $self->exec_async (@exec);
   }
   ()
}

sub my_resource {
   $_[0]->x_resource ("%.$_[1]")
}

# turn a rendition spec in the resource into a sub that implements it on $_
sub parse_rend {
   my ($self, $str) = @_;
   my ($mask, $fg, $bg, $failed) = $str ? urxvt::rend2mask($str)
                                        : (urxvt::RS_Uline, undef, undef, []);
   warn "Failed to parse rendition string: " . join(',', @$failed) if @$failed;
   my @rend;
   push @rend, sub { $_ |= $mask } if $mask;
   push @rend, sub { $_ = urxvt::SET_FGCOLOR($_, $fg) } if defined $fg;
   push @rend, sub { $_ = urxvt::SET_BGCOLOR($_, $bg) } if defined $bg;
   sub {
      for my $s ( @rend ) { &$s };
   }
}

sub on_start {
   my ($self) = @_;

   $self->{launcher} = $self->my_resource ("launcher") || $self->x_resource("url-launcher") || "sensible-browser";

   $self->{urls} = [];
   $self->{showing} = 0;
   $self->{button}  = 2;
   $self->{state}   = 0;
   if($self->{argv}[0] || $self->my_resource ("button")) {
      my @mods = split '', $self->{argv}[0] || $self->my_resource ("button");
      for my $mod (@mods) {
         if($mod =~ /^\d+$/) {
            $self->{button} = $mod;
         } elsif($mod eq "C") {
            $self->{state} |= urxvt::ControlMask;
         } elsif($mod eq "S") {
            $self->{state} |= urxvt::ShiftMask;
         } elsif($mod eq "M") {
            $self->{state} |= $self->ModMetaMask;
         } elsif($mod ne "-" && $mod ne " ") {
            warn("$mod is invalid in $self->{_name}<$self->{argv}[0]>\n");
         }
      }
   }

   my @defaults = ($url);
   my @matchers;
   for (my $idx = 0; defined (my $res = $self->my_resource ("pattern.$idx") || $defaults[$idx]); $idx++) {
      $res = $self->locale_decode ($res);
      utf8::encode $res;
      my $launcher = $self->my_resource ("launcher.$idx");
      $launcher =~ s/\$&|\$\{&\}/\${0}/g if $launcher;
      my $rend = $self->parse_rend($self->my_resource ("rend.$idx"));
      unshift @matchers, [qr($res)x,$launcher,$rend];
   }
   $self->{matchers} = \@matchers;

   ()
}

sub get_urls_from_line {
   my ($self, $line) = @_;
   my @urls;
   for my $matcher (@{$self->{matchers}}) {
     while ($line =~ /$matcher->[0]/g) {
        push @urls, substr( $line, $-[0], $+[0] - $-[0] );
     }
   }
   return @urls;
}

sub on_line_update {
   my ($self, $row) = @_;

   # fetch the line that has changed
   my $line = $self->line ($row);
   my $text = $line->t;
   my $i = 0;

   # find all urls (if any)
   for my $matcher (@{$self->{matchers}}) {
      while ($text =~ /$matcher->[0]/g) {
         #print "$&\n";
         my $rend = $line->r;

         # mark all characters as underlined. we _must_ not toggle underline,
         # as we might get called on an already-marked url.
         &{$matcher->[2]}
         for @{$rend}[ $-[0] .. $+[0] - 1];

         $line->r ($rend);
      }
   }

   ()
}

sub valid_button {
   my ($self, $event) = @_;
   my $mask = $self->ModLevel3Mask | $self->ModMetaMask
   | urxvt::ShiftMask | urxvt::ControlMask;
   return ($event->{button} == $self->{button} &&
      ($event->{state} & $mask) == $self->{state});
}

sub command_for {
   my ($self, $row, $col) = @_;
   my $line = $self->line ($row);
   my $text = $line->t;

   for my $matcher (@{$self->{matchers}}) {
      my $launcher = $matcher->[1] || $self->{launcher};
      while (($text =~ /$matcher->[0]/g)) {
         my $match = $&;
         my @begin = @-;
         my @end = @+;
         if (!defined($col) || ($-[0] <= $col && $+[0] >= $col)) {
            if ($launcher !~ /\$/) {
               return ($launcher,$match);
            } else {
               # It'd be nice to just access a list like ($&,$1,$2...),
               # but alas, m//g behaves differently in list context.
               my @exec = map { s/\$(\d+)|\$\{(\d+)\}/
                  substr($text,$begin[$1||$2],$end[$1||$2]-$begin[$1||$2])
                  /egx; $_ } split(/\s+/, $launcher);
               return @exec;
            }
         }
      }
   }

   ()
}

sub on_button_press {
   my ($self, $event) = @_;
   if($self->valid_button($event)
      && (my @exec = $self->command_for($event->{row},$event->{col}))) {
      $self->{row} = $event->{row};
      $self->{col} = $event->{col};
      $self->{cmd} = \@exec;
      return 1;
   } else {
      delete $self->{row};
      delete $self->{col};
      delete $self->{cmd};
   }

   ()
}

sub on_button_release {
   my ($self, $event) = @_;

   my $row = delete $self->{row};
   my $col = delete $self->{col};
   my $cmd = delete $self->{cmd};

   return if !defined $row;

   if($row == $event->{row} && abs($col-$event->{col}) < 2
      && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) {
      if($self->valid_button($event)) {

         $self->exec_async (@$cmd);

      }
   }

   1;
}

# vim:set sw=3 sts=3 et:
Revision:	1.16
Committed:	Wed May 28 17:01:32 2014 UTC (9 years, 11 months ago) by sf-exg
Branch:	MAIN
Changes since 1.15:	+1 -1 lines
Log Message:	Doc fix.
#	User	Rev	Content
1	root	1.1	#! perl
2
3	sf-tpope	1.7	# Author: Tim Pope <rxvt-unicodeNOSPAM@tpope.org>
4	root	1.14	# Bob Farrell <robertanthonyfarrell@gmail.com>
5	root	1.1
6	root	1.15	#: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	root	1.8
12	root	1.10	=head1 NAME
13
14	root	1.13	matcher - match strings in terminal output and change their rendition
15	root	1.10
16	root	1.11	=head1 DESCRIPTION
17	root	1.10
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	sf-exg	1.16	(default, the C<url-launcher> resource, C<sensible-browser>) will be started
23	root	1.10	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 "perl:matcher:last" or
34			"perl:matcher:list" as seen in the example below.
35
36	root	1.14	Example: load and use the matcher extension with defaults.
37	root	1.10
38			URxvt.perl-ext: default,matcher
39	root	1.14
40			Example: use a custom configuration.
41
42	root	1.10	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
51
52	root	1.1	my $url =
53			qr{
54	tpope	1.2	(?:https?://\|ftp://\|news://\|mailto:\|file://\|\bwww\.)
55	sf-tpope	1.12	[\w\-\@;\/?:&=%\$.+!\x27,~#]
56	tpope	1.2	(
57	sf-tpope	1.12	\([\w\-\@;\/?:&=%\$.+!\x27,~#]\)\| # Allow a pair of matched parentheses
58			[\w\-\@;\/?:&=%\$+*~] # exclude some trailing characters (heuristic)
59	tpope	1.2	)+
60	root	1.1	}x;
61
62	sf-tpope	1.6	sub on_key_press {
63			my ($self, $event, $keysym, $octets) = @_;
64
65			if (! $self->{showing} ) {
66			return;
67			}
68
69			my $i = ($keysym == 96 ? 0 : $keysym - 48);
70			if (($i > scalar(@{$self->{urls}})) \|\| ($i < 0)) {
71			$self->matchlist();
72			return;
73			}
74
75			my @args = ($self->{urls}[ -$i-1 ]);
76			$self->matchlist();
77
78			$self->exec_async( $self->{launcher}, @args );
79			}
80
81	root	1.14	# backwards compat
82	tpope	1.4	sub on_user_command {
83			my ($self, $cmd) = @_;
84	sf-tpope	1.6
85	root	1.14	if ($cmd =~ s/^matcher:list\b//) {
86			$self->matchlist;
87	sf-tpope	1.6	} else {
88	root	1.14	if ($cmd =~ s/^matcher:last\b//) {
89	sf-tpope	1.6	$self->most_recent;
90	root	1.14	} elsif ($cmd =~ s/^matcher\b//) {
91			# for backward compatibility
92	sf-tpope	1.6	$self->most_recent;
93			}
94	tpope	1.4	}
95	root	1.14
96	tpope	1.4	()
97			}
98
99	sf-tpope	1.6	sub matchlist {
100			my ($self) = @_;
101			if ( $self->{showing} ) {
102	root	1.14	$self->{url_overlay}->hide;
103	sf-tpope	1.6	$self->{showing} = 0;
104			return;
105			}
106			@{$self->{urls}} = ();
107			my $line;
108			for (my $i = 0; $i < $self->nrow; $i ++) {
109			$line = $self->line($i);
110			next if ($line->beg != $i);
111			for my $url ($self->get_urls_from_line($line->t)) {
112			if (scalar(@{$self->{urls}}) == 10) {
113			shift @{$self->{urls}};
114			}
115			push @{$self->{urls}}, $url;
116			}
117			}
118
119			if (! scalar(@{$self->{urls}})) {
120			return;
121			}
122
123			my $max = 0;
124			my $i = scalar( @{$self->{urls}} ) - 1 ;;
125
126			my @temp = ();
127
128			for my $url (@{$self->{urls}}) {
129			my $url = "$i-$url";
130			my $xpos = 0;
131
132			if ($self->ncol + (length $url) >= $self->ncol) {
133			$url = substr( $url, 0, $self->ncol );
134			}
135
136			push @temp, $url;
137
138			if( length $url > $max ) {
139			$max = length $url;
140			}
141
142			$i--;
143			}
144
145			@temp = reverse @temp;
146
147			$self->{url_overlay} = $self->overlay(0, 0, $max, scalar( @temp ), urxvt::OVERLAY_RSTYLE, 2);
148			my $i = 0;
149			for my $url (@temp) {
150			$self->{url_overlay}->set( 0, $i, $url, [(urxvt::OVERLAY_RSTYLE) x length $url]);
151			$self->{showing} = 1;
152			$i++;
153			}
154
155			}
156
157	tpope	1.4	sub most_recent {
158			my ($self) = shift;
159			my $row = $self->nrow;
160			my @exec;
161			while($row-- > $self->top_row) {
162			@exec = $self->command_for($row);
163			last if(@exec);
164			}
165			if(@exec) {
166			return $self->exec_async (@exec);
167			}
168			()
169			}
170	tpope	1.2
171	root	1.1	sub my_resource {
172	root	1.9	$_[0]->x_resource ("%.$_[1]")
173	root	1.1	}
174
175	tpope	1.2	# turn a rendition spec in the resource into a sub that implements it on $_
176			sub parse_rend {
177			my ($self, $str) = @_;
178	sf-tpope	1.6	my ($mask, $fg, $bg, $failed) = $str ? urxvt::rend2mask($str)
179	tpope	1.2	: (urxvt::RS_Uline, undef, undef, []);
180			warn "Failed to parse rendition string: " . join(',', @$failed) if @$failed;
181			my @rend;
182			push @rend, sub { $_ \|= $mask } if $mask;
183			push @rend, sub { $_ = urxvt::SET_FGCOLOR($_, $fg) } if defined $fg;
184			push @rend, sub { $_ = urxvt::SET_BGCOLOR($_, $bg) } if defined $bg;
185			sub {
186			for my $s ( @rend ) { &$s };
187			}
188			}
189
190	root	1.1	sub on_start {
191			my ($self) = @_;
192
193	root	1.8	$self->{launcher} = $self->my_resource ("launcher") \|\| $self->x_resource("url-launcher") \|\| "sensible-browser";
194	root	1.1
195	sf-tpope	1.6	$self->{urls} = [];
196			$self->{showing} = 0;
197	root	1.1	$self->{button} = 2;
198			$self->{state} = 0;
199	root	1.8	if($self->{argv}[0] \|\| $self->my_resource ("button")) {
200			my @mods = split '', $self->{argv}[0] \|\| $self->my_resource ("button");
201	root	1.1	for my $mod (@mods) {
202			if($mod =~ /^\d+$/) {
203			$self->{button} = $mod;
204			} elsif($mod eq "C") {
205			$self->{state} \|= urxvt::ControlMask;
206			} elsif($mod eq "S") {
207			$self->{state} \|= urxvt::ShiftMask;
208			} elsif($mod eq "M") {
209			$self->{state} \|= $self->ModMetaMask;
210			} elsif($mod ne "-" && $mod ne " ") {
211	root	1.9	warn("$mod is invalid in $self->{_name}<$self->{argv}[0]>\n");
212	root	1.1	}
213			}
214			}
215
216			my @defaults = ($url);
217			my @matchers;
218	root	1.8	for (my $idx = 0; defined (my $res = $self->my_resource ("pattern.$idx") \|\| $defaults[$idx]); $idx++) {
219	root	1.1	$res = $self->locale_decode ($res);
220			utf8::encode $res;
221	root	1.8	my $launcher = $self->my_resource ("launcher.$idx");
222			$launcher =~ s/\$&\|\$\{&\}/\${0}/g if $launcher;
223			my $rend = $self->parse_rend($self->my_resource ("rend.$idx"));
224	tpope	1.2	unshift @matchers, [qr($res)x,$launcher,$rend];
225	root	1.1	}
226			$self->{matchers} = \@matchers;
227
228			()
229			}
230
231	sf-tpope	1.6	sub get_urls_from_line {
232			my ($self, $line) = @_;
233			my @urls;
234			for my $matcher (@{$self->{matchers}}) {
235			while ($line =~ /$matcher->[0]/g) {
236			push @urls, substr( $line, $-[0], $+[0] - $-[0] );
237			}
238			}
239			return @urls;
240			}
241
242	root	1.1	sub on_line_update {
243			my ($self, $row) = @_;
244
245			# fetch the line that has changed
246			my $line = $self->line ($row);
247			my $text = $line->t;
248			my $i = 0;
249
250			# find all urls (if any)
251			for my $matcher (@{$self->{matchers}}) {
252			while ($text =~ /$matcher->[0]/g) {
253	tpope	1.2	#print "$&\n";
254	root	1.1	my $rend = $line->r;
255
256			# mark all characters as underlined. we _must_ not toggle underline,
257			# as we might get called on an already-marked url.
258	tpope	1.2	&{$matcher->[2]}
259	root	1.1	for @{$rend}[ $-[0] .. $+[0] - 1];
260
261			$line->r ($rend);
262			}
263			}
264
265			()
266			}
267
268			sub valid_button {
269			my ($self, $event) = @_;
270			my $mask = $self->ModLevel3Mask \| $self->ModMetaMask
271			\| urxvt::ShiftMask \| urxvt::ControlMask;
272			return ($event->{button} == $self->{button} &&
273			($event->{state} & $mask) == $self->{state});
274			}
275
276			sub command_for {
277			my ($self, $row, $col) = @_;
278			my $line = $self->line ($row);
279			my $text = $line->t;
280
281			for my $matcher (@{$self->{matchers}}) {
282			my $launcher = $matcher->[1] \|\| $self->{launcher};
283			while (($text =~ /$matcher->[0]/g)) {
284			my $match = $&;
285			my @begin = @-;
286			my @end = @+;
287	tpope	1.2	if (!defined($col) \|\| ($-[0] <= $col && $+[0] >= $col)) {
288	root	1.1	if ($launcher !~ /\$/) {
289			return ($launcher,$match);
290			} else {
291			# It'd be nice to just access a list like ($&,$1,$2...),
292			# but alas, m//g behaves differently in list context.
293			my @exec = map { s/\$(\d+)\|\$\{(\d+)\}/
294			substr($text,$begin[$1\|\|$2],$end[$1\|\|$2]-$begin[$1\|\|$2])
295			/egx; $_ } split(/\s+/, $launcher);
296			return @exec;
297			}
298			}
299			}
300			}
301
302			()
303			}
304
305			sub on_button_press {
306			my ($self, $event) = @_;
307	sf-tpope	1.5	if($self->valid_button($event)
308			&& (my @exec = $self->command_for($event->{row},$event->{col}))) {
309	root	1.1	$self->{row} = $event->{row};
310			$self->{col} = $event->{col};
311	sf-tpope	1.5	$self->{cmd} = \@exec;
312			return 1;
313	root	1.1	} else {
314			delete $self->{row};
315			delete $self->{col};
316	sf-tpope	1.5	delete $self->{cmd};
317	root	1.1	}
318
319			()
320			}
321
322			sub on_button_release {
323			my ($self, $event) = @_;
324
325			my $row = delete $self->{row};
326			my $col = delete $self->{col};
327	sf-tpope	1.5	my $cmd = delete $self->{cmd};
328	root	1.1
329	sf-tpope	1.5	return if !defined $row;
330
331			if($row == $event->{row} && abs($col-$event->{col}) < 2
332			&& join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) {
333	root	1.1	if($self->valid_button($event)) {
334
335	sf-tpope	1.5	$self->exec_async (@$cmd);
336	root	1.1
337			}
338			}
339
340	sf-tpope	1.5	1;
341	root	1.1	}
342
343			# vim:set sw=3 sts=3 et: