--- rxvt-unicode/src/perl/matcher 2012/06/06 15:06:41 1.8 +++ rxvt-unicode/src/perl/matcher 2014/06/01 11:47:20 1.18 @@ -1,117 +1,155 @@ #! perl # Author: Tim Pope -# Bob Farrell +# Bob Farrell -#:META:X_RESOURCE:%.launcher:string:default launcher command -#:META:X_RESOURCE:%.button:string:the button, yeah -#:META:X_RESOURCE:%.pattern.:string:extra pattern to match -#:META:X_RESOURCE:%.launcher.:string:custom launcher for pattern -#:META:X_RESOURCE:%.rend.:string:custom rednition for pattern +#: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) to underline text +matching a certain pattern and make it clickable. When clicked with the +mouse button specified in the C resource (default 2, or +middle), the program specified in the C resource +(default, the C resource, C) 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 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\.) - [a-zA-Z0-9\-\@;\/?:&=%\$_.+!*\x27,~#]* + [\w\-\@;\/?:&=%\$.+!*\x27,~#]* ( - \([a-zA-Z0-9\-\@;\/?:&=%\$_.+!*\x27,~#]*\)| # Allow a pair of matched parentheses - [a-zA-Z0-9\-\@;\/?:&=%\$_+*~] # exclude some trailing characters (heuristic) + \([\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; - } + return unless $self->{overlay}; + + delete $self->{overlay}; my $i = ($keysym == 96 ? 0 : $keysym - 48); - if (($i > scalar(@{$self->{urls}})) || ($i < 0)) { - $self->matchlist(); - return; + if ($i >= 0 && $i < @{ $self->{matches} }) { + my @exec = @{ $self->{matches}[$i] }; + shift @exec; + $self->exec_async (@exec); } - my @args = ($self->{urls}[ -$i-1 ]); - $self->matchlist(); - - $self->exec_async( $self->{launcher}, @args ); + 1 } +# backwards compat sub on_user_command { my ($self, $cmd) = @_; - if($cmd =~ s/^matcher:list\b//) { - $self->matchlist(); + if ($cmd =~ s/^matcher:list\b//) { + $self->matchlist; } else { - if($cmd =~ s/^matcher:last\b//) { + if ($cmd =~ s/^matcher:last\b//) { $self->most_recent; - } - # For backward compatibility - else { - if($cmd =~ s/^matcher\b//) { + } 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++; - } + + @{ $self->{matches} } = (); + my $row = $self->nrow - 1; + while ($row >= 0 && @{ $self->{matches} } < 10) { + my $line = $self->line ($row); + my $text = $line->t; + + # FIXME: code duplicated from 'command_for' + for my $matcher (@{$self->{matchers}}) { + my $launcher = $matcher->[1] || $self->{launcher}; + while ($text =~ /$matcher->[0]/g) { + my $match = substr ($text, $-[0], $+[0] - $-[0]); + my @beg = @-; + my @end = @+; + my @exec; + + if ($launcher !~ /\$/) { + @exec = ($launcher, $match); + } else { + @exec = map { s/\$(\d+)|\$\{(\d+)\}/ + substr ($text, $beg[$1 || $2], $end[$1 || $2] - $beg[$1 || $2]) + /egx; $_ } split /\s+/, $launcher; + } + + push @{ $self->{matches} }, [ $match, @exec ]; + } + } + + $row = $line->beg - 1; + } + + return unless @{ $self->{matches} }; + + my $width = 0; + + my $i = 0; + for my $match (@{ $self->{matches} }) { + my $text = $match->[0]; + my $w = $self->strwidth ("$i-$text"); + + $width = $w if $w > $width; + $i++; + } + + $width = $self->ncol - 2 if $width > $self->ncol - 2; + + $self->{overlay} = $self->overlay (0, 0, $width, scalar (@{ $self->{matches} }), urxvt::OVERLAY_RSTYLE, 2); + my $i = 0; + for my $match (@{ $self->{matches} }) { + my $text = $match->[0]; + + $self->{overlay}->set (0, $i, "$i-$text"); + $i++; + } } @@ -130,8 +168,7 @@ } sub my_resource { - my $self = shift; - $self->x_resource ("$self->{name}.$_[0]"); + $_[0]->x_resource ("%.$_[1]") } # turn a rendition spec in the resource into a sub that implements it on $_ @@ -152,12 +189,9 @@ sub on_start { my ($self) = @_; - ($self->{name} = __PACKAGE__) =~ s/.*:://; - $self->{name} =~ tr/_/-/; $self->{launcher} = $self->my_resource ("launcher") || $self->x_resource("url-launcher") || "sensible-browser"; - $self->{urls} = []; - $self->{showing} = 0; + $self->{matches} = []; $self->{button} = 2; $self->{state} = 0; if($self->{argv}[0] || $self->my_resource ("button")) { @@ -172,7 +206,7 @@ } elsif($mod eq "M") { $self->{state} |= $self->ModMetaMask; } elsif($mod ne "-" && $mod ne " ") { - warn("$mod is invalid in $self->{name}<$self->{argv}[0]>\n"); + warn("$mod is invalid in $self->{_name}<$self->{argv}[0]>\n"); } } } @@ -192,17 +226,6 @@ () } -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) = @_; @@ -296,7 +319,7 @@ && join("\x00", @$cmd) eq join("\x00", $self->command_for($row,$col))) { if($self->valid_button($event)) { - $self->exec_async (@$cmd); + $self->exec_async (@$cmd); } }