| 1 |
#! perl |
| 2 |
|
| 3 |
# this extension implements scrollback buffer search |
| 4 |
|
| 5 |
#:META:RESOURCE:%:string:activation hotkey keysym |
| 6 |
|
| 7 |
=head1 NAME |
| 8 |
|
| 9 |
searchable-scrollback - incremental scrollback search |
| 10 |
|
| 11 |
=head1 DESCRIPTION |
| 12 |
|
| 13 |
Adds regex search functionality to the scrollback buffer, triggered by |
| 14 |
the C<searchable-scrollback:start> action (bound to C<M-s> by |
| 15 |
default). While in search mode, normal terminal input/output is |
| 16 |
suspended and a regex is displayed at the bottom of the screen. |
| 17 |
|
| 18 |
Inputting characters appends them to the regex and continues incremental |
| 19 |
search. In addition, the following bindings are recognized: |
| 20 |
|
| 21 |
=over |
| 22 |
|
| 23 |
=item C<BackSpace> |
| 24 |
|
| 25 |
Remove a character from the regex. |
| 26 |
|
| 27 |
=item C<Insert> |
| 28 |
|
| 29 |
Append the value of the PRIMARY selection to the regex. |
| 30 |
|
| 31 |
=item C<Up> |
| 32 |
|
| 33 |
Search for a match upwards. |
| 34 |
|
| 35 |
=item C<Down> |
| 36 |
|
| 37 |
Search for a match downwards. |
| 38 |
|
| 39 |
=item C<Prior> |
| 40 |
|
| 41 |
Scroll up. |
| 42 |
|
| 43 |
=item C<Next> |
| 44 |
|
| 45 |
Scroll down. |
| 46 |
|
| 47 |
=item C<End> |
| 48 |
|
| 49 |
Scroll to the bottom. |
| 50 |
|
| 51 |
=item C<Escape> |
| 52 |
|
| 53 |
Leave the mode and return to the point where search was started. |
| 54 |
|
| 55 |
=item C<Enter> or C<Return> |
| 56 |
|
| 57 |
Leave the mode maintaining the current position in the scrollback. |
| 58 |
Additionally, if the C<Shift> modifier is active, store the first |
| 59 |
match in the current line into the primary selection. |
| 60 |
|
| 61 |
=back |
| 62 |
|
| 63 |
The regex defaults to "(?i)", resulting in a case-insensitive search. To |
| 64 |
get a case-sensitive search you can delete this prefix using C<BackSpace> |
| 65 |
or simply use an uppercase character which removes the "(?i)" prefix. |
| 66 |
|
| 67 |
See L<perlre> for more info about perl regular expression syntax. |
| 68 |
|
| 69 |
=cut |
| 70 |
|
| 71 |
sub on_init { |
| 72 |
my ($self) = @_; |
| 73 |
|
| 74 |
# only for backwards compatibility |
| 75 |
my $hotkey = $self->{argv}[0] |
| 76 |
|| $self->x_resource ("%") |
| 77 |
|| "M-s"; |
| 78 |
|
| 79 |
$self->bind_action ($hotkey, "%:start") |
| 80 |
or warn "unable to register '$hotkey' as scrollback search start hotkey\n"; |
| 81 |
|
| 82 |
() |
| 83 |
} |
| 84 |
|
| 85 |
sub on_user_command { |
| 86 |
my ($self, $cmd) = @_; |
| 87 |
|
| 88 |
$cmd eq "searchable-scrollback:start" |
| 89 |
and $self->enter; |
| 90 |
|
| 91 |
() |
| 92 |
} |
| 93 |
|
| 94 |
sub on_action { |
| 95 |
my ($self, $action) = @_; |
| 96 |
|
| 97 |
$action eq "start" |
| 98 |
and $self->enter; |
| 99 |
|
| 100 |
() |
| 101 |
} |
| 102 |
|
| 103 |
sub msg { |
| 104 |
my ($self, $msg) = @_; |
| 105 |
|
| 106 |
$self->{overlay} = $self->overlay (0, -1, $self->ncol, 1, urxvt::OVERLAY_RSTYLE, 0); |
| 107 |
$self->{overlay}->set (0, 0, $self->special_encode ($msg)); |
| 108 |
} |
| 109 |
|
| 110 |
sub enter { |
| 111 |
my ($self) = @_; |
| 112 |
|
| 113 |
return if $self->{overlay}; |
| 114 |
|
| 115 |
$self->{view_start} = $self->view_start; |
| 116 |
$self->{pty_ev_events} = $self->pty_ev_events (urxvt::EV_NONE); |
| 117 |
$self->{row} = $self->nrow - 1; |
| 118 |
$self->{search} = "(?i)"; |
| 119 |
|
| 120 |
$self->enable ( |
| 121 |
key_press => \&key_press, |
| 122 |
tt_write => \&tt_write, |
| 123 |
refresh_begin => \&refresh, |
| 124 |
refresh_end => \&refresh, |
| 125 |
); |
| 126 |
|
| 127 |
$self->{manpage_overlay} = $self->overlay (0, -2, $self->ncol, 1, urxvt::OVERLAY_RSTYLE, 0); |
| 128 |
$self->{manpage_overlay}->set (0, 0, "scrollback search, see the ${urxvt::RXVTNAME}perl manpage for details"); |
| 129 |
|
| 130 |
$self->idle; |
| 131 |
} |
| 132 |
|
| 133 |
sub leave { |
| 134 |
my ($self) = @_; |
| 135 |
|
| 136 |
$self->disable ("key_press", "tt_write", "refresh_begin", "refresh_end"); |
| 137 |
$self->pty_ev_events ($self->{pty_ev_events}); |
| 138 |
|
| 139 |
delete $self->{manpage_overlay}; |
| 140 |
delete $self->{overlay}; |
| 141 |
delete $self->{search}; |
| 142 |
delete $self->{found}; |
| 143 |
} |
| 144 |
|
| 145 |
sub idle { |
| 146 |
my ($self) = @_; |
| 147 |
|
| 148 |
$self->msg ("(escape cancels) /$self->{search}█"); |
| 149 |
} |
| 150 |
|
| 151 |
sub search { |
| 152 |
my ($self, $dir, $row) = @_; |
| 153 |
|
| 154 |
my $search = $self->special_encode ($self->{search}); |
| 155 |
|
| 156 |
no re 'eval'; # just to be sure |
| 157 |
if (my $re = eval { qr/$search/ }) { |
| 158 |
while ($self->nrow > $row && $row >= $self->top_row) { |
| 159 |
my $line = $self->line ($row) |
| 160 |
or last; |
| 161 |
|
| 162 |
my $text = $line->t; |
| 163 |
if ($text =~ /$re/g) { |
| 164 |
delete $self->{found}; |
| 165 |
|
| 166 |
do { |
| 167 |
push @{ $self->{found} }, [$line->coord_of ($-[0]), $line->coord_of ($+[0])]; |
| 168 |
} while $text =~ /$re/g; |
| 169 |
|
| 170 |
$self->{row} = $row; |
| 171 |
$self->view_start ($row - ($self->nrow >> 1)); |
| 172 |
$self->want_refresh; |
| 173 |
return; |
| 174 |
} |
| 175 |
|
| 176 |
$row = $dir < 0 ? $line->beg - 1 : $line->end + 1; |
| 177 |
} |
| 178 |
} |
| 179 |
|
| 180 |
$self->scr_bell; |
| 181 |
} |
| 182 |
|
| 183 |
sub refresh { |
| 184 |
my ($self) = @_; |
| 185 |
|
| 186 |
return unless $self->{found}; |
| 187 |
|
| 188 |
my $xor = urxvt::RS_RVid | urxvt::RS_Blink; |
| 189 |
for (@{ $self->{found} }) { |
| 190 |
$self->scr_xor_span (@$_, $xor); |
| 191 |
$xor = urxvt::RS_RVid; |
| 192 |
} |
| 193 |
|
| 194 |
() |
| 195 |
} |
| 196 |
|
| 197 |
sub key_press { |
| 198 |
my ($self, $event, $keysym, $string) = @_; |
| 199 |
|
| 200 |
delete $self->{manpage_overlay}; |
| 201 |
|
| 202 |
if ($keysym == 0xff0d || $keysym == 0xff8d) { # enter |
| 203 |
if ($self->{found} && $event->{state} & urxvt::ShiftMask) { |
| 204 |
my ($br, $bc, $er, $ec) = @{ $self->{found}[0] }; |
| 205 |
$self->selection_beg ($br, $bc); |
| 206 |
$self->selection_end ($er, $ec); |
| 207 |
$self->selection_make ($event->{time}); |
| 208 |
} |
| 209 |
$self->leave; |
| 210 |
} elsif ($keysym == 0xff1b) { # escape |
| 211 |
$self->view_start ($self->{view_start}); |
| 212 |
$self->leave; |
| 213 |
} elsif ($keysym == 0xff57) { # end |
| 214 |
$self->{row} = $self->nrow - 1; |
| 215 |
$self->view_start (0); |
| 216 |
} elsif ($keysym == 0xff52) { # up |
| 217 |
my $line = $self->line ($self->{row}); |
| 218 |
$self->search (-1, $line->beg - 1) |
| 219 |
if $line->beg > $self->top_row; |
| 220 |
} elsif ($keysym == 0xff54) { # down |
| 221 |
my $line = $self->line ($self->{row}); |
| 222 |
$self->search (+1, $line->end + 1) |
| 223 |
if $line->end < $self->nrow; |
| 224 |
} elsif ($keysym == 0xff55) { # prior |
| 225 |
my $row = $self->view_start - ($self->nrow - 1); |
| 226 |
$self->view_start ($row); |
| 227 |
} elsif ($keysym == 0xff56) { # next |
| 228 |
my $row = $self->view_start + ($self->nrow - 1); |
| 229 |
$self->view_start ($row); |
| 230 |
} elsif ($keysym == 0xff63) { # insert |
| 231 |
$self->selection_request (urxvt::CurrentTime, 1); |
| 232 |
} elsif ($keysym == 0xff08) { # backspace |
| 233 |
substr $self->{search}, -1, 1, ""; |
| 234 |
$self->search (+1, $self->{row}); |
| 235 |
$self->idle; |
| 236 |
} elsif ($string !~ /[\x00-\x1f\x80-\xaf]/) { |
| 237 |
return; # pass to tt_write |
| 238 |
} |
| 239 |
|
| 240 |
1 |
| 241 |
} |
| 242 |
|
| 243 |
sub tt_write { |
| 244 |
my ($self, $data) = @_; |
| 245 |
|
| 246 |
$self->{search} .= $self->locale_decode ($data); |
| 247 |
$self->{search} =~ s/\e\[20[01]~//g; |
| 248 |
|
| 249 |
$self->{search} =~ s/^\(\?i\)// |
| 250 |
if $self->{search} =~ /^\(.*[[:upper:]]/; |
| 251 |
|
| 252 |
delete $self->{found}; |
| 253 |
$self->search (-1, $self->{row}); |
| 254 |
$self->idle; |
| 255 |
|
| 256 |
1 |
| 257 |
} |
| 258 |
|
| 259 |
|
