| 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 | |
|
|
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 | |
| 5 | sub on_init { |
34 | sub on_init { |
| 6 | my ($self) = @_; |
35 | my ($self) = @_; |
| 7 | |
36 | |
|
|
37 | # only for backwards compatibility |
| 8 | my $hotkey = $self->{argv}[0] || "M-s"; |
38 | my $hotkey = $self->{argv}[0] |
|
|
39 | || $self->x_resource ("%") |
|
|
40 | || "M-s"; |
| 9 | |
41 | |
| 10 | $self->parse_keysym ($hotkey, "perl:searchable-scrollback:start") |
42 | $self->bind_action ($hotkey, "%:start") |
| 11 | or warn "unable to register '$hotkey' as scrollback search start hotkey\n"; |
43 | or warn "unable to register '$hotkey' as scrollback search start hotkey\n"; |
| 12 | |
44 | |
| 13 | () |
45 | () |
| 14 | } |
46 | } |
| 15 | |
47 | |
| 16 | sub on_keyboard_command { |
48 | sub on_user_command { |
| 17 | my ($self, $cmd) = @_; |
49 | my ($self, $cmd) = @_; |
| 18 | |
50 | |
| 19 | $cmd eq "searchable-scrollback:start" |
51 | $cmd eq "searchable-scrollback:start" |
| 20 | and $self->enter; |
52 | and $self->enter; |
| 21 | |
53 | |
| 22 | () |
54 | () |
| 23 | } |
55 | } |
| 24 | |
56 | |
|
|
57 | sub on_action { |
|
|
58 | my ($self, $action) = @_; |
|
|
59 | |
|
|
60 | $action eq "start" |
|
|
61 | and $self->enter; |
|
|
62 | |
|
|
63 | () |
|
|
64 | } |
|
|
65 | |
| 25 | sub msg { |
66 | sub msg { |
| 26 | my ($self, $msg) = @_; |
67 | my ($self, $msg) = @_; |
| 27 | |
68 | |
| 28 | $self->{overlay} = $self->overlay (0, -1, $self->ncol, 1, urxvt::OVERLAY_RSTYLE, 0); |
69 | $self->{overlay} = $self->overlay (0, -1, $self->ncol, 1, urxvt::OVERLAY_RSTYLE, 0); |
| 29 | $self->{overlay}->set (0, 0, $self->special_encode ($msg)); |
70 | $self->{overlay}->set (0, 0, $self->special_encode ($msg)); |
| … | |
… | |
| 32 | sub enter { |
73 | sub enter { |
| 33 | my ($self) = @_; |
74 | my ($self) = @_; |
| 34 | |
75 | |
| 35 | return if $self->{overlay}; |
76 | return if $self->{overlay}; |
| 36 | |
77 | |
| 37 | $self->{history} = []; |
|
|
| 38 | $self->{view_start} = $self->view_start; |
78 | $self->{view_start} = $self->view_start; |
| 39 | $self->{pty_ev_events} = $self->pty_ev_events (urxvt::EVENT_NONE); |
79 | $self->{pty_ev_events} = $self->pty_ev_events (urxvt::EV_NONE); |
|
|
80 | $self->{row} = $self->nrow - 1; |
|
|
81 | $self->{search} = "(?i)"; |
| 40 | |
82 | |
| 41 | $self->enable ( |
83 | $self->enable ( |
| 42 | key_press => \&key_press, |
84 | key_press => \&key_press, |
| 43 | tt_write => \&tt_write, |
85 | tt_write => \&tt_write, |
| 44 | refresh_begin => \&refresh, |
86 | refresh_begin => \&refresh, |
| 45 | refresh_end => \&refresh, |
87 | refresh_end => \&refresh, |
| 46 | ); |
88 | ); |
| 47 | |
89 | |
| 48 | $self->{manpage_overlay} = $self->overlay (0, -2, $self->ncol, 1, urxvt::OVERLAY_RSTYLE, 0); |
90 | $self->{manpage_overlay} = $self->overlay (0, -2, $self->ncol, 1, urxvt::OVERLAY_RSTYLE, 0); |
| 49 | $self->{manpage_overlay}->set (0, 0, "scrollback search, see man ${urxvt::RXVTNAME}perl"); |
91 | $self->{manpage_overlay}->set (0, 0, "scrollback search, see the ${urxvt::RXVTNAME}perl manpage for details"); |
| 50 | |
92 | |
| 51 | $self->idle; |
93 | $self->idle; |
| 52 | } |
94 | } |
| 53 | |
95 | |
| 54 | sub leave { |
96 | sub leave { |
| … | |
… | |
| 57 | $self->disable ("key_press", "tt_write", "refresh_begin", "refresh_end"); |
99 | $self->disable ("key_press", "tt_write", "refresh_begin", "refresh_end"); |
| 58 | $self->pty_ev_events ($self->{pty_ev_events}); |
100 | $self->pty_ev_events ($self->{pty_ev_events}); |
| 59 | |
101 | |
| 60 | delete $self->{manpage_overlay}; |
102 | delete $self->{manpage_overlay}; |
| 61 | delete $self->{overlay}; |
103 | delete $self->{overlay}; |
|
|
104 | delete $self->{search}; |
| 62 | delete $self->{history}; |
105 | delete $self->{found}; |
| 63 | } |
106 | } |
| 64 | |
107 | |
| 65 | sub idle { |
108 | sub idle { |
| 66 | my ($self) = @_; |
109 | my ($self) = @_; |
| 67 | |
110 | |
| 68 | $self->msg ("escape=exit, enter=accept, /=start search, n=next, p=previous, G=bottom"); |
111 | $self->msg ("(escape cancels) /$self->{search}█"); |
| 69 | |
|
|
| 70 | delete $self->{in_search}; |
|
|
| 71 | } |
112 | } |
| 72 | |
113 | |
| 73 | sub search { |
114 | sub search { |
| 74 | my ($self, $offset) = @_; |
115 | my ($self, $dir, $row) = @_; |
| 75 | |
|
|
| 76 | my $row = -$self->view_start + ($self->nrow >> 1) + $offset; |
|
|
| 77 | |
|
|
| 78 | delete $self->{found}; |
|
|
| 79 | |
116 | |
| 80 | my $search = $self->special_encode ($self->{search}); |
117 | my $search = $self->special_encode ($self->{search}); |
| 81 | |
118 | |
| 82 | no re 'eval'; # just to be sure |
119 | no re 'eval'; # just to be sure |
| 83 | my $re = qr/$search/; |
120 | if (my $re = eval { qr/$search/ }) { |
| 84 | |
121 | while ($self->nrow > $row && $row >= $self->top_row) { |
| 85 | while ($row > -$self->nsaved) { |
|
|
| 86 | my $line = $self->line ($row) |
122 | my $line = $self->line ($row) |
| 87 | or last; |
123 | or last; |
| 88 | |
124 | |
| 89 | my $text = $line->t; |
125 | my $text = $line->t; |
| 90 | if ($text =~ /$re/g) { |
126 | if ($text =~ /$re/g) { |
|
|
127 | delete $self->{found}; |
|
|
128 | |
| 91 | do { |
129 | do { |
| 92 | push @{ $self->{found} }, [$line->coord_of ($-[0]), $line->coord_of ($+[0])]; |
130 | push @{ $self->{found} }, [$line->coord_of ($-[0]), $line->coord_of ($+[0])]; |
| 93 | } while $text =~ /$re/g; |
131 | } while $text =~ /$re/g; |
| 94 | |
132 | |
|
|
133 | $self->{row} = $row; |
| 95 | $self->view_start (-$row + ($self->nrow >> 1)); |
134 | $self->view_start (List::Util::min 0, $row - ($self->nrow >> 1)); |
|
|
135 | $self->want_refresh; |
|
|
136 | return; |
| 96 | last; |
137 | } |
|
|
138 | |
|
|
139 | $row = $dir < 0 ? $line->beg - 1 : $line->end + 1; |
| 97 | } |
140 | } |
| 98 | |
|
|
| 99 | $row = $line->beg - 1; |
|
|
| 100 | } |
141 | } |
| 101 | |
142 | |
| 102 | $self->msg ("enter/type/backspace: /$self->{search}_" |
143 | $self->scr_bell; |
| 103 | . ($self->{found} ? "" : " (not found)")); |
|
|
| 104 | $self->scr_bell unless $self->{found}; |
|
|
| 105 | } |
144 | } |
| 106 | |
145 | |
| 107 | sub refresh { |
146 | sub refresh { |
| 108 | my ($self) = @_; |
147 | my ($self) = @_; |
| 109 | |
148 | |
| 110 | return unless $self->{found}; |
149 | return unless $self->{found}; |
| 111 | |
150 | |
| 112 | $self->scr_xor_span (@$_, urxvt::SET_FGCOLOR (urxvt::RS_RVid, 15)) |
151 | my $xor = urxvt::RS_RVid | urxvt::RS_Blink; |
| 113 | for @{ $self->{found} }; |
152 | for (@{ $self->{found} }) { |
|
|
153 | $self->scr_xor_span (@$_, $xor); |
|
|
154 | $xor = urxvt::RS_RVid; |
|
|
155 | } |
| 114 | |
156 | |
| 115 | () |
157 | () |
| 116 | } |
158 | } |
| 117 | |
159 | |
| 118 | sub key_press { |
160 | sub key_press { |
| 119 | my ($self, $event, $keysym, $string) = @_; |
161 | my ($self, $event, $keysym, $string) = @_; |
| 120 | |
162 | |
| 121 | if (exists $self->{in_search}) { |
163 | delete $self->{manpage_overlay}; |
|
|
164 | |
| 122 | if ($keysym == 0xff0d || $keysym == 0xff8d) { |
165 | if ($keysym == 0xff0d || $keysym == 0xff8d) { # enter |
| 123 | $self->idle; |
166 | if ($self->{found} && $event->{state} & urxvt::ShiftMask) { |
| 124 | } elsif ($keysym == 0xff1b) { |
167 | my ($br, $bc, $er, $ec) = @{ $self->{found}[0] }; |
| 125 | $self->view_start ($self->{in_search}); |
168 | $self->selection_beg ($br, $bc); |
| 126 | $self->idle; |
169 | $self->selection_end ($er, $ec); |
| 127 | } elsif ($keysym == 0xff08) { |
170 | $self->selection_make ($event->{time}); |
| 128 | substr $self->{search}, -1, 1, ""; |
|
|
| 129 | $self->search; |
|
|
| 130 | } elsif ($string ne "") { |
|
|
| 131 | return; |
|
|
| 132 | } |
171 | } |
| 133 | |
|
|
| 134 | } else { |
|
|
| 135 | if ($keysym == 0xff0d || $keysym == 0xff8d) { |
|
|
| 136 | # TODO: set selection |
|
|
| 137 | $self->leave; |
172 | $self->leave; |
| 138 | } elsif ($keysym == 0xff1b) { |
173 | } elsif ($keysym == 0xff1b) { # escape |
| 139 | $self->view_start ($self->{view_start}); |
174 | $self->view_start ($self->{view_start}); |
| 140 | $self->leave; |
175 | $self->leave; |
| 141 | } elsif ($keysym == 0xff52) { |
176 | } elsif ($keysym == 0xff57) { # end |
| 142 | $self->view_start ($self->view_start + 1); |
177 | $self->{row} = $self->nrow - 1; |
| 143 | } elsif ($keysym == 0xff54) { |
|
|
| 144 | $self->view_start ($self->view_start - 1); |
|
|
| 145 | } elsif ($string eq "/") { |
|
|
| 146 | delete $self->{manpage_overlay}; |
|
|
| 147 | $self->{in_search} = $self->view_start; |
|
|
| 148 | $self->search; |
|
|
| 149 | } elsif ($string eq "G") { |
|
|
| 150 | $self->{history} = []; |
|
|
| 151 | $self->view_start (0); |
178 | $self->view_start (0); |
| 152 | } elsif ($string eq "n") { |
179 | } elsif ($keysym == 0xff52) { # up |
| 153 | if ($self->{found} && @{ $self->{found} }) { |
180 | my $line = $self->line ($self->{row}); |
| 154 | push @{ $self->{history} }, [$self->view_start, $self->{found}]; |
181 | $self->search (-1, $line->beg - 1) |
| 155 | $self->search (-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}); |
| 156 | $self->idle; |
190 | $self->idle; |
| 157 | } |
191 | } elsif ($string !~ /[\x00-\x1f\x80-\xaf]/) { |
| 158 | } elsif ($string eq "p" or $string eq "N") { |
192 | return; # pass to tt_write |
| 159 | if (my $prev = pop @{ $self->{history} }) { |
|
|
| 160 | $self->view_start ($prev->[0]); |
|
|
| 161 | $self->{found} = $prev->[1]; |
|
|
| 162 | $self->want_refresh; |
|
|
| 163 | } |
|
|
| 164 | } elsif ($string ne "") { |
|
|
| 165 | $self->scr_bell; |
|
|
| 166 | } |
|
|
| 167 | } |
193 | } |
| 168 | |
194 | |
| 169 | 1 |
195 | 1 |
| 170 | } |
196 | } |
| 171 | |
197 | |
| 172 | sub tt_write { |
198 | sub tt_write { |
| 173 | my ($self, $data) = @_; |
199 | my ($self, $data) = @_; |
| 174 | |
200 | |
| 175 | $self->{search} .= $self->locale_decode ($data); |
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}); |
| 176 | $self->search; |
208 | $self->idle; |
| 177 | |
209 | |
| 178 | 1 |
210 | 1 |
| 179 | } |
211 | } |
| 180 | |
212 | |
| 181 | |
213 | |
