1 | #! perl |
1 | #! perl |
2 | |
2 | |
3 | # this extension implements scrollback buffer search |
3 | # this extension implements scrollback buffer search |
4 | |
4 | |
5 | #:META:X_RESOURCE:%:string:activation hotkey keysym |
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 |
6 | |
34 | |
7 | sub on_init { |
35 | sub on_init { |
8 | my ($self) = @_; |
36 | my ($self) = @_; |
9 | |
37 | |
|
|
38 | # only for backwards compatibility |
10 | my $hotkey = $self->{argv}[0] |
39 | my $hotkey = $self->{argv}[0] |
11 | || $self->x_resource ("%") |
40 | || $self->x_resource ("%") |
12 | || "M-s"; |
41 | || return; |
13 | |
42 | |
14 | $self->parse_keysym ($hotkey, "perl:searchable-scrollback:start") |
43 | $self->bind_action ($hotkey, "searchable-scrollback:start") # ugh |
15 | 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"; |
16 | |
45 | |
17 | () |
46 | () |
18 | } |
47 | } |
19 | |
48 | |
20 | sub on_user_command { |
49 | sub on_action { |
21 | my ($self, $cmd) = @_; |
50 | my ($self, $action) = @_; |
22 | |
51 | |
23 | $cmd eq "searchable-scrollback:start" |
52 | $action eq "start" |
24 | and $self->enter; |
53 | and $self->enter; |
25 | |
54 | |
26 | () |
55 | () |
27 | } |
56 | } |
28 | |
57 | |
… | |
… | |
62 | $self->disable ("key_press", "tt_write", "refresh_begin", "refresh_end"); |
91 | $self->disable ("key_press", "tt_write", "refresh_begin", "refresh_end"); |
63 | $self->pty_ev_events ($self->{pty_ev_events}); |
92 | $self->pty_ev_events ($self->{pty_ev_events}); |
64 | |
93 | |
65 | delete $self->{manpage_overlay}; |
94 | delete $self->{manpage_overlay}; |
66 | delete $self->{overlay}; |
95 | delete $self->{overlay}; |
67 | delete $self->{history}; |
|
|
68 | delete $self->{search}; |
96 | delete $self->{search}; |
69 | } |
97 | } |
70 | |
98 | |
71 | sub idle { |
99 | sub idle { |
72 | my ($self) = @_; |
100 | my ($self) = @_; |
73 | |
101 | |
74 | $self->msg ("(escape cancels) /$self->{search}█"); |
102 | $self->msg ("(escape cancels) /$self->{search}█"); |
75 | } |
103 | } |
76 | |
104 | |
77 | sub search { |
105 | sub search { |
78 | my ($self, $dir) = @_; |
106 | my ($self, $dir, $row) = @_; |
79 | |
|
|
80 | delete $self->{found}; |
|
|
81 | my $row = $self->{row}; |
|
|
82 | |
107 | |
83 | my $search = $self->special_encode ($self->{search}); |
108 | my $search = $self->special_encode ($self->{search}); |
84 | |
109 | |
85 | no re 'eval'; # just to be sure |
110 | no re 'eval'; # just to be sure |
86 | if (my $re = eval { qr/$search/ }) { |
111 | if (my $re = eval { qr/$search/ }) { |
… | |
… | |
88 | my $line = $self->line ($row) |
113 | my $line = $self->line ($row) |
89 | or last; |
114 | or last; |
90 | |
115 | |
91 | my $text = $line->t; |
116 | my $text = $line->t; |
92 | if ($text =~ /$re/g) { |
117 | if ($text =~ /$re/g) { |
|
|
118 | delete $self->{found}; |
|
|
119 | |
93 | do { |
120 | do { |
94 | push @{ $self->{found} }, [$line->coord_of ($-[0]), $line->coord_of ($+[0])]; |
121 | push @{ $self->{found} }, [$line->coord_of ($-[0]), $line->coord_of ($+[0])]; |
95 | } while $text =~ /$re/g; |
122 | } while $text =~ /$re/g; |
96 | |
123 | |
97 | $self->{row} = $row; |
124 | $self->{row} = $row; |
98 | $self->view_start (List::Util::min 0, $row - ($self->nrow >> 1)); |
125 | $self->view_start (List::Util::min 0, $row - ($self->nrow >> 1)); |
99 | $self->want_refresh; |
126 | $self->want_refresh; |
100 | last; |
127 | return; |
101 | } |
128 | } |
102 | |
129 | |
103 | $row = $dir < 0 ? $line->beg - 1 : $line->end + 1; |
130 | $row = $dir < 0 ? $line->beg - 1 : $line->end + 1; |
104 | } |
131 | } |
105 | } |
132 | } |
106 | |
133 | |
107 | $self->scr_bell unless $self->{found}; |
134 | $self->scr_bell; |
108 | } |
135 | } |
109 | |
136 | |
110 | sub refresh { |
137 | sub refresh { |
111 | my ($self) = @_; |
138 | my ($self) = @_; |
112 | |
139 | |
… | |
… | |
139 | $self->leave; |
166 | $self->leave; |
140 | } elsif ($keysym == 0xff57) { # end |
167 | } elsif ($keysym == 0xff57) { # end |
141 | $self->{row} = $self->nrow - 1; |
168 | $self->{row} = $self->nrow - 1; |
142 | $self->view_start (0); |
169 | $self->view_start (0); |
143 | } elsif ($keysym == 0xff52) { # up |
170 | } elsif ($keysym == 0xff52) { # up |
144 | $self->{row}-- if $self->{row} > $self->top_row; |
171 | my $line = $self->line ($self->{row}); |
145 | $self->search (-1); |
172 | $self->search (-1, $line->beg - 1) |
|
|
173 | if $line->beg > $self->top_row; |
146 | } elsif ($keysym == 0xff54) { # down |
174 | } elsif ($keysym == 0xff54) { # down |
147 | $self->{row}++ if $self->{row} < $self->nrow; |
175 | my $line = $self->line ($self->{row}); |
148 | $self->search (+1); |
176 | $self->search (+1, $line->end + 1) |
|
|
177 | if $line->end < $self->nrow; |
149 | } elsif ($keysym == 0xff08) { # backspace |
178 | } elsif ($keysym == 0xff08) { # backspace |
150 | substr $self->{search}, -1, 1, ""; |
179 | substr $self->{search}, -1, 1, ""; |
151 | $self->search; |
180 | $self->search (+1, $self->{row}); |
152 | $self->idle; |
181 | $self->idle; |
153 | } elsif ($string !~ /[\x00-\x1f\x80-\xaf]/) { |
182 | } elsif ($string !~ /[\x00-\x1f\x80-\xaf]/) { |
154 | return; # pass to tt_write |
183 | return; # pass to tt_write |
155 | } |
184 | } |
156 | |
185 | |
… | |
… | |
163 | $self->{search} .= $self->locale_decode ($data); |
192 | $self->{search} .= $self->locale_decode ($data); |
164 | |
193 | |
165 | $self->{search} =~ s/^\(\?i\)// |
194 | $self->{search} =~ s/^\(\?i\)// |
166 | if $self->{search} =~ /^\(.*[[:upper:]]/; |
195 | if $self->{search} =~ /^\(.*[[:upper:]]/; |
167 | |
196 | |
|
|
197 | delete $self->{found}; |
168 | $self->search (-1); |
198 | $self->search (-1, $self->{row}); |
169 | $self->idle; |
199 | $self->idle; |
170 | |
200 | |
171 | 1 |
201 | 1 |
172 | } |
202 | } |
173 | |
203 | |