1 | #! perl |
1 | #! perl |
2 | |
2 | |
3 | # this extension implements scrollback buffer search |
3 | # this extension implements scrollback buffer search |
4 | |
4 | |
|
|
5 | #:META:RESOURCE:%:string:activation hotkey keysym |
|
|
6 | #:META:BINDING:M-s:start |
|
|
7 | |
|
|
8 | =head1 NAME |
|
|
9 | |
|
|
10 | searchable-scrollback - incremental scrollback search (enabled by default) |
|
|
11 | |
|
|
12 | =head1 DESCRIPTION |
|
|
13 | |
|
|
14 | Adds regex search functionality to the scrollback buffer, triggered by |
|
|
15 | the C<searchable-scrollback:start> action (bound to C<M-s> by |
|
|
16 | default). While in search mode, normal terminal input/output is |
|
|
17 | suspended and a regex is displayed at the bottom of the screen. |
|
|
18 | |
|
|
19 | Inputting characters appends them to the regex and continues incremental |
|
|
20 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
|
|
21 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
|
|
22 | bottom. C<Escape> leaves search mode and returns to the point where search |
|
|
23 | was started, while C<Enter> or C<Return> stay at the current position and |
|
|
24 | additionally stores the first match in the current line into the primary |
|
|
25 | selection if the C<Shift> modifier is active. |
|
|
26 | |
|
|
27 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
|
|
28 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
|
|
29 | or simply use an uppercase character which removes the "(?i)" prefix. |
|
|
30 | |
|
|
31 | See L<perlre> for more info about perl regular expression syntax. |
|
|
32 | |
|
|
33 | =cut |
|
|
34 | |
5 | sub on_init { |
35 | sub on_init { |
6 | my ($self) = @_; |
36 | my ($self) = @_; |
7 | |
37 | |
|
|
38 | # only for backwards compatibility |
8 | my $hotkey = $self->{argv}[0] |
39 | my $hotkey = $self->{argv}[0] |
9 | || $self->x_resource ("searchable-scrollback") |
40 | || $self->x_resource ("%") |
10 | || "M-s"; |
41 | || return; |
11 | |
42 | |
12 | $self->parse_keysym ($hotkey, "perl:searchable-scrollback:start") |
43 | $self->bind_action ($hotkey, "searchable-scrollback:start") # ugh |
13 | or warn "unable to register '$hotkey' as scrollback search start hotkey\n"; |
44 | or warn "unable to register '$hotkey' as scrollback search start hotkey\n"; |
14 | |
45 | |
15 | () |
46 | () |
16 | } |
47 | } |
17 | |
48 | |
18 | sub on_user_command { |
49 | sub on_user_command { |
19 | my ($self, $cmd) = @_; |
50 | my ($self, $cmd) = @_; |
20 | |
51 | |
21 | $cmd eq "searchable-scrollback:start" |
52 | $cmd eq "searchable-scrollback:start" |
|
|
53 | and $self->enter; |
|
|
54 | |
|
|
55 | () |
|
|
56 | } |
|
|
57 | |
|
|
58 | sub on_action { |
|
|
59 | my ($self, $action) = @_; |
|
|
60 | |
|
|
61 | $action eq "start" |
22 | and $self->enter; |
62 | and $self->enter; |
23 | |
63 | |
24 | () |
64 | () |
25 | } |
65 | } |
26 | |
66 | |
… | |
… | |
60 | $self->disable ("key_press", "tt_write", "refresh_begin", "refresh_end"); |
100 | $self->disable ("key_press", "tt_write", "refresh_begin", "refresh_end"); |
61 | $self->pty_ev_events ($self->{pty_ev_events}); |
101 | $self->pty_ev_events ($self->{pty_ev_events}); |
62 | |
102 | |
63 | delete $self->{manpage_overlay}; |
103 | delete $self->{manpage_overlay}; |
64 | delete $self->{overlay}; |
104 | delete $self->{overlay}; |
65 | delete $self->{history}; |
|
|
66 | delete $self->{search}; |
105 | delete $self->{search}; |
|
|
106 | delete $self->{found}; |
67 | } |
107 | } |
68 | |
108 | |
69 | sub idle { |
109 | sub idle { |
70 | my ($self) = @_; |
110 | my ($self) = @_; |
71 | |
111 | |
72 | $self->msg ("(escape cancels) /$self->{search}█"); |
112 | $self->msg ("(escape cancels) /$self->{search}█"); |
73 | } |
113 | } |
74 | |
114 | |
75 | sub search { |
115 | sub search { |
76 | my ($self, $dir) = @_; |
116 | my ($self, $dir, $row) = @_; |
77 | |
|
|
78 | delete $self->{found}; |
|
|
79 | my $row = $self->{row}; |
|
|
80 | |
117 | |
81 | my $search = $self->special_encode ($self->{search}); |
118 | my $search = $self->special_encode ($self->{search}); |
82 | |
119 | |
83 | no re 'eval'; # just to be sure |
120 | no re 'eval'; # just to be sure |
84 | if (my $re = eval { qr/$search/ }) { |
121 | if (my $re = eval { qr/$search/ }) { |
… | |
… | |
86 | my $line = $self->line ($row) |
123 | my $line = $self->line ($row) |
87 | or last; |
124 | or last; |
88 | |
125 | |
89 | my $text = $line->t; |
126 | my $text = $line->t; |
90 | if ($text =~ /$re/g) { |
127 | if ($text =~ /$re/g) { |
|
|
128 | delete $self->{found}; |
|
|
129 | |
91 | do { |
130 | do { |
92 | push @{ $self->{found} }, [$line->coord_of ($-[0]), $line->coord_of ($+[0])]; |
131 | push @{ $self->{found} }, [$line->coord_of ($-[0]), $line->coord_of ($+[0])]; |
93 | } while $text =~ /$re/g; |
132 | } while $text =~ /$re/g; |
94 | |
133 | |
95 | $self->{row} = $row; |
134 | $self->{row} = $row; |
96 | $self->view_start (List::Util::min 0, $row - ($self->nrow >> 1)); |
135 | $self->view_start (List::Util::min 0, $row - ($self->nrow >> 1)); |
97 | $self->want_refresh; |
136 | $self->want_refresh; |
98 | last; |
137 | return; |
99 | } |
138 | } |
100 | |
139 | |
101 | $row = $dir < 0 ? $line->beg - 1 : $line->end + 1; |
140 | $row = $dir < 0 ? $line->beg - 1 : $line->end + 1; |
102 | } |
141 | } |
103 | } |
142 | } |
104 | |
143 | |
105 | $self->scr_bell unless $self->{found}; |
144 | $self->scr_bell; |
106 | } |
145 | } |
107 | |
146 | |
108 | sub refresh { |
147 | sub refresh { |
109 | my ($self) = @_; |
148 | my ($self) = @_; |
110 | |
149 | |
… | |
… | |
137 | $self->leave; |
176 | $self->leave; |
138 | } elsif ($keysym == 0xff57) { # end |
177 | } elsif ($keysym == 0xff57) { # end |
139 | $self->{row} = $self->nrow - 1; |
178 | $self->{row} = $self->nrow - 1; |
140 | $self->view_start (0); |
179 | $self->view_start (0); |
141 | } elsif ($keysym == 0xff52) { # up |
180 | } elsif ($keysym == 0xff52) { # up |
142 | $self->{row}-- if $self->{row} > $self->top_row; |
181 | my $line = $self->line ($self->{row}); |
143 | $self->search (-1); |
182 | $self->search (-1, $line->beg - 1) |
|
|
183 | if $line->beg > $self->top_row; |
144 | } elsif ($keysym == 0xff54) { # down |
184 | } elsif ($keysym == 0xff54) { # down |
145 | $self->{row}++ if $self->{row} < $self->nrow; |
185 | my $line = $self->line ($self->{row}); |
146 | $self->search (+1); |
186 | $self->search (+1, $line->end + 1) |
|
|
187 | if $line->end < $self->nrow; |
147 | } elsif ($keysym == 0xff08) { # backspace |
188 | } elsif ($keysym == 0xff08) { # backspace |
148 | substr $self->{search}, -1, 1, ""; |
189 | substr $self->{search}, -1, 1, ""; |
149 | $self->search; |
190 | $self->search (+1, $self->{row}); |
150 | $self->idle; |
191 | $self->idle; |
151 | } elsif ($string !~ /[\x00-\x1f\x80-\xaf]/) { |
192 | } elsif ($string !~ /[\x00-\x1f\x80-\xaf]/) { |
152 | return; # pass to tt_write |
193 | return; # pass to tt_write |
153 | } |
194 | } |
154 | |
195 | |
… | |
… | |
161 | $self->{search} .= $self->locale_decode ($data); |
202 | $self->{search} .= $self->locale_decode ($data); |
162 | |
203 | |
163 | $self->{search} =~ s/^\(\?i\)// |
204 | $self->{search} =~ s/^\(\?i\)// |
164 | if $self->{search} =~ /^\(.*[[:upper:]]/; |
205 | if $self->{search} =~ /^\(.*[[:upper:]]/; |
165 | |
206 | |
|
|
207 | delete $self->{found}; |
166 | $self->search (-1); |
208 | $self->search (-1, $self->{row}); |
167 | $self->idle; |
209 | $self->idle; |
168 | |
210 | |
169 | 1 |
211 | 1 |
170 | } |
212 | } |
171 | |
213 | |