1 |
#! perl |
2 |
|
3 |
# this extension implements scrollback buffer search |
4 |
|
5 |
#:META:X_RESOURCE:%:string:activation hotkey keysym |
6 |
|
7 |
=head1 NAME |
8 |
|
9 |
searchable-scrollback<hotkey> - incremental scrollback search (enabled by default) |
10 |
|
11 |
=head1 DESCRIPTION |
12 |
|
13 |
Adds regex search functionality to the scrollback buffer, triggered |
14 |
by a hotkey (default: C<M-s>). While in search mode, normal terminal |
15 |
input/output is suspended and a regex is displayed at the bottom of the |
16 |
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 |
my $hotkey = $self->{argv}[0] |
38 |
|| $self->x_resource ("%") |
39 |
|| "M-s"; |
40 |
|
41 |
$self->parse_keysym ($hotkey, "perl:searchable-scrollback:start") |
42 |
or warn "unable to register '$hotkey' as scrollback search start hotkey\n"; |
43 |
|
44 |
() |
45 |
} |
46 |
|
47 |
sub on_user_command { |
48 |
my ($self, $cmd) = @_; |
49 |
|
50 |
$cmd eq "searchable-scrollback:start" |
51 |
and $self->enter; |
52 |
|
53 |
() |
54 |
} |
55 |
|
56 |
sub msg { |
57 |
my ($self, $msg) = @_; |
58 |
|
59 |
$self->{overlay} = $self->overlay (0, -1, $self->ncol, 1, urxvt::OVERLAY_RSTYLE, 0); |
60 |
$self->{overlay}->set (0, 0, $self->special_encode ($msg)); |
61 |
} |
62 |
|
63 |
sub enter { |
64 |
my ($self) = @_; |
65 |
|
66 |
return if $self->{overlay}; |
67 |
|
68 |
$self->{view_start} = $self->view_start; |
69 |
$self->{pty_ev_events} = $self->pty_ev_events (urxvt::EV_NONE); |
70 |
$self->{row} = $self->nrow - 1; |
71 |
$self->{search} = "(?i)"; |
72 |
|
73 |
$self->enable ( |
74 |
key_press => \&key_press, |
75 |
tt_write => \&tt_write, |
76 |
refresh_begin => \&refresh, |
77 |
refresh_end => \&refresh, |
78 |
); |
79 |
|
80 |
$self->{manpage_overlay} = $self->overlay (0, -2, $self->ncol, 1, urxvt::OVERLAY_RSTYLE, 0); |
81 |
$self->{manpage_overlay}->set (0, 0, "scrollback search, see the ${urxvt::RXVTNAME}perl manpage for details"); |
82 |
|
83 |
$self->idle; |
84 |
} |
85 |
|
86 |
sub leave { |
87 |
my ($self) = @_; |
88 |
|
89 |
$self->disable ("key_press", "tt_write", "refresh_begin", "refresh_end"); |
90 |
$self->pty_ev_events ($self->{pty_ev_events}); |
91 |
|
92 |
delete $self->{manpage_overlay}; |
93 |
delete $self->{overlay}; |
94 |
delete $self->{history}; |
95 |
delete $self->{search}; |
96 |
} |
97 |
|
98 |
sub idle { |
99 |
my ($self) = @_; |
100 |
|
101 |
$self->msg ("(escape cancels) /$self->{search}█"); |
102 |
} |
103 |
|
104 |
sub search { |
105 |
my ($self, $dir) = @_; |
106 |
|
107 |
delete $self->{found}; |
108 |
my $row = $self->{row}; |
109 |
|
110 |
my $search = $self->special_encode ($self->{search}); |
111 |
|
112 |
no re 'eval'; # just to be sure |
113 |
if (my $re = eval { qr/$search/ }) { |
114 |
while ($self->nrow > $row && $row >= $self->top_row) { |
115 |
my $line = $self->line ($row) |
116 |
or last; |
117 |
|
118 |
my $text = $line->t; |
119 |
if ($text =~ /$re/g) { |
120 |
do { |
121 |
push @{ $self->{found} }, [$line->coord_of ($-[0]), $line->coord_of ($+[0])]; |
122 |
} while $text =~ /$re/g; |
123 |
|
124 |
$self->{row} = $row; |
125 |
$self->view_start (List::Util::min 0, $row - ($self->nrow >> 1)); |
126 |
$self->want_refresh; |
127 |
last; |
128 |
} |
129 |
|
130 |
$row = $dir < 0 ? $line->beg - 1 : $line->end + 1; |
131 |
} |
132 |
} |
133 |
|
134 |
$self->scr_bell unless $self->{found}; |
135 |
} |
136 |
|
137 |
sub refresh { |
138 |
my ($self) = @_; |
139 |
|
140 |
return unless $self->{found}; |
141 |
|
142 |
my $xor = urxvt::RS_RVid | urxvt::RS_Blink; |
143 |
for (@{ $self->{found} }) { |
144 |
$self->scr_xor_span (@$_, $xor); |
145 |
$xor = urxvt::RS_RVid; |
146 |
} |
147 |
|
148 |
() |
149 |
} |
150 |
|
151 |
sub key_press { |
152 |
my ($self, $event, $keysym, $string) = @_; |
153 |
|
154 |
delete $self->{manpage_overlay}; |
155 |
|
156 |
if ($keysym == 0xff0d || $keysym == 0xff8d) { # enter |
157 |
if ($self->{found} && $event->{state} & urxvt::ShiftMask) { |
158 |
my ($br, $bc, $er, $ec) = @{ $self->{found}[0] }; |
159 |
$self->selection_beg ($br, $bc); |
160 |
$self->selection_end ($er, $ec); |
161 |
$self->selection_make ($event->{time}); |
162 |
} |
163 |
$self->leave; |
164 |
} elsif ($keysym == 0xff1b) { # escape |
165 |
$self->view_start ($self->{view_start}); |
166 |
$self->leave; |
167 |
} elsif ($keysym == 0xff57) { # end |
168 |
$self->{row} = $self->nrow - 1; |
169 |
$self->view_start (0); |
170 |
} elsif ($keysym == 0xff52) { # up |
171 |
$self->{row}-- if $self->{row} > $self->top_row; |
172 |
$self->search (-1); |
173 |
} elsif ($keysym == 0xff54) { # down |
174 |
$self->{row}++ if $self->{row} < $self->nrow; |
175 |
$self->search (+1); |
176 |
} elsif ($keysym == 0xff08) { # backspace |
177 |
substr $self->{search}, -1, 1, ""; |
178 |
$self->search; |
179 |
$self->idle; |
180 |
} elsif ($string !~ /[\x00-\x1f\x80-\xaf]/) { |
181 |
return; # pass to tt_write |
182 |
} |
183 |
|
184 |
1 |
185 |
} |
186 |
|
187 |
sub tt_write { |
188 |
my ($self, $data) = @_; |
189 |
|
190 |
$self->{search} .= $self->locale_decode ($data); |
191 |
|
192 |
$self->{search} =~ s/^\(\?i\)// |
193 |
if $self->{search} =~ /^\(.*[[:upper:]]/; |
194 |
|
195 |
$self->search (-1); |
196 |
$self->idle; |
197 |
|
198 |
1 |
199 |
} |
200 |
|
201 |
|