--- rxvt-unicode/src/perl/searchable-scrollback 2006/01/09 23:06:05 1.4 +++ rxvt-unicode/src/perl/searchable-scrollback 2012/09/04 22:41:12 1.30 @@ -2,10 +2,41 @@ # this extension implements scrollback buffer search +#:META:X_RESOURCE:%:string:activation hotkey keysym + +=head1 NAME + +searchable-scrollback - incremental scrollback search (enabled by default) + +=head1 DESCRIPTION + +Adds regex search functionality to the scrollback buffer, triggered +by a hotkey (default: C). While in search mode, normal terminal +input/output is suspended and a regex is displayed at the bottom of the +screen. + +Inputting characters appends them to the regex and continues incremental +search. C removes a character from the regex, C and C +search upwards/downwards in the scrollback buffer, C jumps to the +bottom. C leaves search mode and returns to the point where search +was started, while C or C stay at the current position and +additionally stores the first match in the current line into the primary +selection if the C modifier is active. + +The regex defaults to "(?i)", resulting in a case-insensitive search. To +get a case-sensitive search you can delete this prefix using C +or simply use an uppercase character which removes the "(?i)" prefix. + +See L for more info about perl regular expression syntax. + +=cut + sub on_init { my ($self) = @_; - my $hotkey = $self->{argv}[0] || "M-s"; + my $hotkey = $self->{argv}[0] + || $self->x_resource ("%") + || "M-s"; $self->parse_keysym ($hotkey, "perl:searchable-scrollback:start") or warn "unable to register '$hotkey' as scrollback search start hotkey\n"; @@ -13,12 +44,11 @@ () } -sub on_keyboard_command { +sub on_user_command { my ($self, $cmd) = @_; - if ($cmd eq "searchable-scrollback:start") { - $self->enter; - } + $cmd eq "searchable-scrollback:start" + and $self->enter; () } @@ -35,66 +65,72 @@ return if $self->{overlay}; - $self->{pty_ev_events} = $self->pty_ev_events (urxvt::EVENT_NONE); $self->{view_start} = $self->view_start; + $self->{pty_ev_events} = $self->pty_ev_events (urxvt::EV_NONE); + $self->{row} = $self->nrow - 1; + $self->{search} = "(?i)"; $self->enable ( key_press => \&key_press, + tt_write => \&tt_write, refresh_begin => \&refresh, refresh_end => \&refresh, ); + $self->{manpage_overlay} = $self->overlay (0, -2, $self->ncol, 1, urxvt::OVERLAY_RSTYLE, 0); + $self->{manpage_overlay}->set (0, 0, "scrollback search, see the ${urxvt::RXVTNAME}perl manpage for details"); + $self->idle; } sub leave { my ($self) = @_; - delete $self->{overlay}; - - $self->disable ("key_press", "refresh_begin", "refresh_end"); - + $self->disable ("key_press", "tt_write", "refresh_begin", "refresh_end"); $self->pty_ev_events ($self->{pty_ev_events}); - $self->want_refresh; + + delete $self->{manpage_overlay}; + delete $self->{overlay}; + delete $self->{history}; + delete $self->{search}; } sub idle { my ($self) = @_; - $self->msg ("scrollback search, escape=exit, enter=accept, /=start search, n=next, p=previous, G=bottom"); - - delete $self->{in_search}; + $self->msg ("(escape cancels) /$self->{search}█"); } sub search { - my ($self) = @_; - - my $row = -$self->view_start; + my ($self, $dir) = @_; delete $self->{found}; + my $row = $self->{row}; - no re 'eval'; # just to be sure - my $re = qr/$self->{search}/; + my $search = $self->special_encode ($self->{search}); - while ($row > -$self->nsaved) { - my $line = $self->line ($row) - or last; - - my $text = $line->t; - if ($text =~ /$re/g) { - do { - push @{ $self->{found} }, [$line->coord_of ($-[0]), $line->coord_of ($+[0])]; - } while $text =~ /$re/g; + no re 'eval'; # just to be sure + if (my $re = eval { qr/$search/ }) { + while ($self->nrow > $row && $row >= $self->top_row) { + my $line = $self->line ($row) + or last; + + my $text = $line->t; + if ($text =~ /$re/g) { + do { + push @{ $self->{found} }, [$line->coord_of ($-[0]), $line->coord_of ($+[0])]; + } while $text =~ /$re/g; + + $self->{row} = $row; + $self->view_start (List::Util::min 0, $row - ($self->nrow >> 1)); + $self->want_refresh; + last; + } - $self->view_start (-$row + ($self->nrow >> 1)); - last; + $row = $dir < 0 ? $line->beg - 1 : $line->end + 1; } - - $row = $line->beg - 1; } - $self->msg ("enter/type/backspace: /$self->{search}_" - . ($self->{found} ? "" : " (not found)")); $self->scr_bell unless $self->{found}; } @@ -103,8 +139,11 @@ return unless $self->{found}; - $self->scr_xor_span (@$_) - for @{ $self->{found} }; + my $xor = urxvt::RS_RVid | urxvt::RS_Blink; + for (@{ $self->{found} }) { + $self->scr_xor_span (@$_, $xor); + $xor = urxvt::RS_RVid; + } () } @@ -112,47 +151,51 @@ sub key_press { my ($self, $event, $keysym, $string) = @_; - if (exists $self->{in_search}) { - if ($keysym == 0xff0d || $keysym == 0xff8d) { - $self->idle; - } elsif ($keysym == 0xff1b) { - $self->view_start ($self->{in_search}); - $self->idle; - } elsif ($keysym == 0xff08) { - substr $self->{search}, -1, 1, ""; - - $self->search; - } elsif ($string ne "") { - $self->{search} .= $string; + delete $self->{manpage_overlay}; - $self->search; - } - } else { - if ($keysym == 0xff0d || $keysym == 0xff8d) { - # OK - $self->leave; - } elsif ($keysym == 0xff1b) { - $self->view_start ($self->{view_start}); - $self->leave; - } elsif ($keysym == 0xff52) { - $self->view_start ($self->view_start + 1); - } elsif ($keysym == 0xff54) { - $self->view_start ($self->view_start - 1); - } elsif ($string eq "/") { - $self->{in_search} = $self->view_start; - $self->search; - } elsif ($string eq "G") { - $self->view_start (0); - } elsif ($string eq "n") { - $self->search; - } elsif ($string eq "p") { - # TODO - } elsif ($string ne "") { - $self->scr_bell; + if ($keysym == 0xff0d || $keysym == 0xff8d) { # enter + if ($self->{found} && $event->{state} & urxvt::ShiftMask) { + my ($br, $bc, $er, $ec) = @{ $self->{found}[0] }; + $self->selection_beg ($br, $bc); + $self->selection_end ($er, $ec); + $self->selection_make ($event->{time}); } + $self->leave; + } elsif ($keysym == 0xff1b) { # escape + $self->view_start ($self->{view_start}); + $self->leave; + } elsif ($keysym == 0xff57) { # end + $self->{row} = $self->nrow - 1; + $self->view_start (0); + } elsif ($keysym == 0xff52) { # up + $self->{row}-- if $self->{row} > $self->top_row; + $self->search (-1); + } elsif ($keysym == 0xff54) { # down + $self->{row}++ if $self->{row} < $self->nrow; + $self->search (+1); + } elsif ($keysym == 0xff08) { # backspace + substr $self->{search}, -1, 1, ""; + $self->search; + $self->idle; + } elsif ($string !~ /[\x00-\x1f\x80-\xaf]/) { + return; # pass to tt_write } 1 } + +sub tt_write { + my ($self, $data) = @_; + + $self->{search} .= $self->locale_decode ($data); + + $self->{search} =~ s/^\(\?i\)// + if $self->{search} =~ /^\(.*[[:upper:]]/; + + $self->search (-1); + $self->idle; + + 1 +}