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 (enabled by default) |
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. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
20 |
search upwards/downwards in the scrollback buffer, C<End> jumps to the |
21 |
bottom. C<Escape> leaves search mode and returns to the point where search |
22 |
was started, while C<Enter> or C<Return> stay at the current position and |
23 |
additionally stores the first match in the current line into the primary |
24 |
selection if the C<Shift> modifier is active. |
25 |
|
26 |
The regex defaults to "(?i)", resulting in a case-insensitive search. To |
27 |
get a case-sensitive search you can delete this prefix using C<BackSpace> |
28 |
or simply use an uppercase character which removes the "(?i)" prefix. |
29 |
|
30 |
See L<perlre> for more info about perl regular expression syntax. |
31 |
|
32 |
=cut |
33 |
|
34 |
sub on_init { |
35 |
my ($self) = @_; |
36 |
|
37 |
# only for backwards compatibility |
38 |
my $hotkey = $self->{argv}[0] |
39 |
|| $self->x_resource ("%") |
40 |
|| "M-s"; |
41 |
|
42 |
$self->bind_action ($hotkey, "%:start") |
43 |
or warn "unable to register '$hotkey' as scrollback search start hotkey\n"; |
44 |
|
45 |
() |
46 |
} |
47 |
|
48 |
sub on_user_command { |
49 |
my ($self, $cmd) = @_; |
50 |
|
51 |
$cmd eq "searchable-scrollback:start" |
52 |
and $self->enter; |
53 |
|
54 |
() |
55 |
} |
56 |
|
57 |
sub on_action { |
58 |
my ($self, $action) = @_; |
59 |
|
60 |
$action eq "start" |
61 |
and $self->enter; |
62 |
|
63 |
() |
64 |
} |
65 |
|
66 |
sub msg { |
67 |
my ($self, $msg) = @_; |
68 |
|
69 |
$self->{overlay} = $self->overlay (0, -1, $self->ncol, 1, urxvt::OVERLAY_RSTYLE, 0); |
70 |
$self->{overlay}->set (0, 0, $self->special_encode ($msg)); |
71 |
} |
72 |
|
73 |
sub enter { |
74 |
my ($self) = @_; |
75 |
|
76 |
return if $self->{overlay}; |
77 |
|
78 |
$self->{view_start} = $self->view_start; |
79 |
$self->{pty_ev_events} = $self->pty_ev_events (urxvt::EV_NONE); |
80 |
$self->{row} = $self->nrow - 1; |
81 |
$self->{search} = "(?i)"; |
82 |
|
83 |
$self->enable ( |
84 |
key_press => \&key_press, |
85 |
tt_write => \&tt_write, |
86 |
refresh_begin => \&refresh, |
87 |
refresh_end => \&refresh, |
88 |
); |
89 |
|
90 |
$self->{manpage_overlay} = $self->overlay (0, -2, $self->ncol, 1, urxvt::OVERLAY_RSTYLE, 0); |
91 |
$self->{manpage_overlay}->set (0, 0, "scrollback search, see the ${urxvt::RXVTNAME}perl manpage for details"); |
92 |
|
93 |
$self->idle; |
94 |
} |
95 |
|
96 |
sub leave { |
97 |
my ($self) = @_; |
98 |
|
99 |
$self->disable ("key_press", "tt_write", "refresh_begin", "refresh_end"); |
100 |
$self->pty_ev_events ($self->{pty_ev_events}); |
101 |
|
102 |
delete $self->{manpage_overlay}; |
103 |
delete $self->{overlay}; |
104 |
delete $self->{search}; |
105 |
delete $self->{found}; |
106 |
} |
107 |
|
108 |
sub idle { |
109 |
my ($self) = @_; |
110 |
|
111 |
$self->msg ("(escape cancels) /$self->{search}█"); |
112 |
} |
113 |
|
114 |
sub search { |
115 |
my ($self, $dir, $row) = @_; |
116 |
|
117 |
my $search = $self->special_encode ($self->{search}); |
118 |
|
119 |
no re 'eval'; # just to be sure |
120 |
if (my $re = eval { qr/$search/ }) { |
121 |
while ($self->nrow > $row && $row >= $self->top_row) { |
122 |
my $line = $self->line ($row) |
123 |
or last; |
124 |
|
125 |
my $text = $line->t; |
126 |
if ($text =~ /$re/g) { |
127 |
delete $self->{found}; |
128 |
|
129 |
do { |
130 |
push @{ $self->{found} }, [$line->coord_of ($-[0]), $line->coord_of ($+[0])]; |
131 |
} while $text =~ /$re/g; |
132 |
|
133 |
$self->{row} = $row; |
134 |
$self->view_start (List::Util::min 0, $row - ($self->nrow >> 1)); |
135 |
$self->want_refresh; |
136 |
return; |
137 |
} |
138 |
|
139 |
$row = $dir < 0 ? $line->beg - 1 : $line->end + 1; |
140 |
} |
141 |
} |
142 |
|
143 |
$self->scr_bell; |
144 |
} |
145 |
|
146 |
sub refresh { |
147 |
my ($self) = @_; |
148 |
|
149 |
return unless $self->{found}; |
150 |
|
151 |
my $xor = urxvt::RS_RVid | urxvt::RS_Blink; |
152 |
for (@{ $self->{found} }) { |
153 |
$self->scr_xor_span (@$_, $xor); |
154 |
$xor = urxvt::RS_RVid; |
155 |
} |
156 |
|
157 |
() |
158 |
} |
159 |
|
160 |
sub key_press { |
161 |
my ($self, $event, $keysym, $string) = @_; |
162 |
|
163 |
delete $self->{manpage_overlay}; |
164 |
|
165 |
if ($keysym == 0xff0d || $keysym == 0xff8d) { # enter |
166 |
if ($self->{found} && $event->{state} & urxvt::ShiftMask) { |
167 |
my ($br, $bc, $er, $ec) = @{ $self->{found}[0] }; |
168 |
$self->selection_beg ($br, $bc); |
169 |
$self->selection_end ($er, $ec); |
170 |
$self->selection_make ($event->{time}); |
171 |
} |
172 |
$self->leave; |
173 |
} elsif ($keysym == 0xff1b) { # escape |
174 |
$self->view_start ($self->{view_start}); |
175 |
$self->leave; |
176 |
} elsif ($keysym == 0xff57) { # end |
177 |
$self->{row} = $self->nrow - 1; |
178 |
$self->view_start (0); |
179 |
} elsif ($keysym == 0xff52) { # up |
180 |
my $line = $self->line ($self->{row}); |
181 |
$self->search (-1, $line->beg - 1) |
182 |
if $line->beg > $self->top_row; |
183 |
} elsif ($keysym == 0xff54) { # down |
184 |
my $line = $self->line ($self->{row}); |
185 |
$self->search (+1, $line->end + 1) |
186 |
if $line->end < $self->nrow; |
187 |
} elsif ($keysym == 0xff08) { # backspace |
188 |
substr $self->{search}, -1, 1, ""; |
189 |
$self->search (+1, $self->{row}); |
190 |
$self->idle; |
191 |
} elsif ($string !~ /[\x00-\x1f\x80-\xaf]/) { |
192 |
return; # pass to tt_write |
193 |
} |
194 |
|
195 |
1 |
196 |
} |
197 |
|
198 |
sub tt_write { |
199 |
my ($self, $data) = @_; |
200 |
|
201 |
$self->{search} .= $self->locale_decode ($data); |
202 |
|
203 |
$self->{search} =~ s/^\(\?i\)// |
204 |
if $self->{search} =~ /^\(.*[[:upper:]]/; |
205 |
|
206 |
delete $self->{found}; |
207 |
$self->search (-1, $self->{row}); |
208 |
$self->idle; |
209 |
|
210 |
1 |
211 |
} |
212 |
|
213 |
|