ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/perl/searchable-scrollback
(Generate patch)

Comparing rxvt-unicode/src/perl/searchable-scrollback (file contents):
Revision 1.1 by root, Mon Jan 9 22:41:41 2006 UTC vs.
Revision 1.44 by sf-exg, Tue Oct 24 20:12:08 2017 UTC

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
9searchable-scrollback - incremental scrollback search (enabled by default)
10
11=head1 DESCRIPTION
12
13Adds regex search functionality to the scrollback buffer, triggered by
14the C<searchable-scrollback:start> action (bound to C<M-s> by
15default). While in search mode, normal terminal input/output is
16suspended and a regex is displayed at the bottom of the screen.
17
18Inputting characters appends them to the regex and continues incremental
19search. In addition, the following bindings are recognized:
20
21=over 4
22
23=item C<BackSpace>
24
25Remove a character from the regex.
26
27=item C<Insert>
28
29Append the value of the PRIMARY selection to the regex.
30
31=item C<Up>
32
33Search for a match upwards.
34
35=item C<Down>
36
37Search for a match downwards.
38
39=item C<Prior>
40
41Scroll up.
42
43=item C<Next>
44
45Scroll down.
46
47=item C<End>
48
49Scroll to the bottom.
50
51=item C<Escape>
52
53Leave the mode and return to the point where search was started.
54
55=item C<Enter> or C<Return>
56
57Leave the mode maintaining the current position in the scrollback.
58Additionally, if the C<Shift> modifier is active, store the first
59match in the current line into the primary selection.
60
61=back
62
63The regex defaults to "(?i)", resulting in a case-insensitive search. To
64get a case-sensitive search you can delete this prefix using C<BackSpace>
65or simply use an uppercase character which removes the "(?i)" prefix.
66
67See L<perlre> for more info about perl regular expression syntax.
68
69=cut
70
5sub on_init { 71sub on_init {
6 my ($self) = @_; 72 my ($self) = @_;
7 73
74 # only for backwards compatibility
8 my $hotkey = $self->{argv}[0] || "M-s"; 75 my $hotkey = $self->{argv}[0]
76 || $self->x_resource ("%")
77 || "M-s";
9 78
10 $self->parse_keysym ($hotkey, "perl:searchable-scrollback:enter") 79 $self->bind_action ($hotkey, "%:start")
11 or warn "unable to register '$hotkey' as scrollback search enter hotkey\n"; 80 or warn "unable to register '$hotkey' as scrollback search start hotkey\n";
12 81
13 () 82 ()
14} 83}
15 84
16sub on_keyboard_command { 85sub on_user_command {
17 my ($self, $cmd) = @_; 86 my ($self, $cmd) = @_;
18 87
19 if ($cmd eq "searchable-scrollback:enter") { 88 $cmd eq "searchable-scrollback:start"
20 $self->enter; 89 and $self->enter;
21 } 90
91 ()
92}
93
94sub on_action {
95 my ($self, $action) = @_;
96
97 $action eq "start"
98 and $self->enter;
22 99
23 () 100 ()
24} 101}
25 102
26sub msg { 103sub msg {
33sub enter { 110sub enter {
34 my ($self) = @_; 111 my ($self) = @_;
35 112
36 return if $self->{overlay}; 113 return if $self->{overlay};
37 114
38 $self->{pty_ev_events} = $self->pty_ev_events (urxvt::EVENT_NONE);
39 $self->{view_start} = $self->view_start; 115 $self->{view_start} = $self->view_start;
116 $self->{pty_ev_events} = $self->pty_ev_events (urxvt::EV_NONE);
117 $self->{row} = $self->nrow - 1;
118 $self->{search} = "(?i)";
40 119
41 $self->enable ( 120 $self->enable (
121 key_press => \&key_press,
122 tt_write => \&tt_write,
42 refresh_begin => sub { 123 refresh_begin => \&refresh,
43 warn "beg(@_)\n"; 124 refresh_end => \&refresh,
44 },
45 refresh_end => sub {
46 warn "end(@_)\n";
47 },
48 ); 125 );
49 126
127 $self->{manpage_overlay} = $self->overlay (0, -2, $self->ncol, 1, urxvt::OVERLAY_RSTYLE, 0);
128 $self->{manpage_overlay}->set (0, 0, "scrollback search, see the ${urxvt::RXVTNAME}perl manpage for details");
129
50 $self->idle; 130 $self->idle;
51} 131}
52 132
53sub leave { 133sub leave {
54 my ($self) = @_; 134 my ($self) = @_;
55 135
136 $self->disable ("key_press", "tt_write", "refresh_begin", "refresh_end");
137 $self->pty_ev_events ($self->{pty_ev_events});
138
139 delete $self->{manpage_overlay};
56 delete $self->{overlay}; 140 delete $self->{overlay};
57 141 delete $self->{search};
58 $self->disable ("refresh_begin", "refresh_end"); 142 delete $self->{found};
59
60 $self->pty_ev_events ($self->{pty_ev_events});
61 $self->want_refresh;
62} 143}
63 144
64sub idle { 145sub idle {
65 my ($self) = @_; 146 my ($self) = @_;
66 147
67 $self->msg ("scrollback search, escape=exit, enter=accept, /=start search, n=next, p=previous"); 148 $self->msg ("(escape cancels) /$self->{search}█");
68
69 delete $self->{in_search};
70} 149}
71 150
72sub search { 151sub search {
73 my ($self) = @_; 152 my ($self, $dir, $row) = @_;
74 153
75 my $row = -$self->view_start; 154 my $search = $self->special_encode ($self->{search});
76
77 delete $self->{found};
78 155
79 no re 'eval'; # just to be sure 156 no re 'eval'; # just to be sure
80 my $re = qr/$self->{search}/; 157 if (my $re = eval { qr/$search/ }) {
81 158 while ($self->nrow > $row && $row >= $self->top_row) {
82 while ($row > -$self->nsaved) {
83 my $line = $self->line ($row) 159 my $line = $self->line ($row)
84 or last; 160 or last;
85 161
86 my $text = $line->t; 162 my $text = $line->t;
87 if ($text =~ /$re/g) { 163 if ($text =~ /$re/g) {
164 delete $self->{found};
165
88 do { 166 do {
89 push @{ $self->{found} }, [$line->coord_of ($-[0]), $line->coord_of ($+[1])]; 167 push @{ $self->{found} }, [$line->coord_of ($-[0]), $line->coord_of ($+[0])];
90 } while $text =~ /$re/g; 168 } while $text =~ /$re/g;
91 169
170 $self->{row} = $row;
92 $self->view_start (-$row + ($self->nrow >> 1)); 171 $self->view_start (List::Util::min 0, $row - ($self->nrow >> 1));
93 last; 172 $self->want_refresh;
173 return;
94 } 174 }
95 175
96 $row = $line->beg - 1; 176 $row = $dir < 0 ? $line->beg - 1 : $line->end + 1;
97 }
98
99 $self->msg ("enter/type/backspace: /$self->{search}_"
100 . ($self->{found} ? " (not found)" : ""));
101 $self->scr_bell unless $self->{found};
102}
103
104sub on_key_press {
105 my ($self, $event, $keysym, $string) = @_;
106
107 $self->{overlay}
108 or return;
109
110 if (exists $self->{in_search}) {
111 if ($keysym == 0xff0d || $keysym == 0xff8d) {
112 delete $self->{in_search};
113 } elsif ($keysym == 0xff1b) {
114 $self->view_start (delete $self->{in_search});
115 } elsif ($keysym == 0xff08) {
116 substr $self->{search}, -1, 1, "";
117 } elsif ($string ne "") {
118 $self->{search} .= $string;
119 }
120
121 $self->search;
122 } else {
123 if ($keysym == 0xff0d || $keysym == 0xff8d) {
124 # OK
125 $self->leave;
126 } elsif ($keysym == 0xff1b) {
127 $self->view_start ($self->{view_start});
128 $self->leave;
129 } elsif ($keysym == 0xff52) {
130 $self->view_start ($self->view_start + 1);
131 } elsif ($keysym == 0xff54) {
132 $self->view_start ($self->view_start - 1);
133 } elsif ($string eq "/") {
134 $self->{in_search} = $self->view_start;
135 $self->search;
136 } elsif ($string eq "n") {
137 } elsif ($string eq "p") {
138 } elsif ($string ne "") {
139 $self->scr_bell;
140 } 177 }
141 } 178 }
142 179
180 $self->scr_bell;
181}
182
183sub refresh {
184 my ($self) = @_;
185
186 return unless $self->{found};
187
188 my $xor = urxvt::RS_RVid | urxvt::RS_Blink;
189 for (@{ $self->{found} }) {
190 $self->scr_xor_span (@$_, $xor);
191 $xor = urxvt::RS_RVid;
192 }
193
194 ()
195}
196
197sub key_press {
198 my ($self, $event, $keysym, $string) = @_;
199
200 delete $self->{manpage_overlay};
201
202 if ($keysym == 0xff0d || $keysym == 0xff8d) { # enter
203 if ($self->{found} && $event->{state} & urxvt::ShiftMask) {
204 my ($br, $bc, $er, $ec) = @{ $self->{found}[0] };
205 $self->selection_beg ($br, $bc);
206 $self->selection_end ($er, $ec);
207 $self->selection_make ($event->{time});
208 }
209 $self->leave;
210 } elsif ($keysym == 0xff1b) { # escape
211 $self->view_start ($self->{view_start});
212 $self->leave;
213 } elsif ($keysym == 0xff57) { # end
214 $self->{row} = $self->nrow - 1;
215 $self->view_start (0);
216 } elsif ($keysym == 0xff52) { # up
217 my $line = $self->line ($self->{row});
218 $self->search (-1, $line->beg - 1)
219 if $line->beg > $self->top_row;
220 } elsif ($keysym == 0xff54) { # down
221 my $line = $self->line ($self->{row});
222 $self->search (+1, $line->end + 1)
223 if $line->end < $self->nrow;
224 } elsif ($keysym == 0xff55) { # prior
225 my $row = $self->view_start - ($self->nrow - 1);
226 $self->view_start (List::Util::min 0, $row);
227 } elsif ($keysym == 0xff56) { # next
228 my $row = $self->view_start + ($self->nrow - 1);
229 $self->view_start (List::Util::min 0, $row);
230 } elsif ($keysym == 0xff63) { # insert
231 $self->selection_request (urxvt::CurrentTime, 1);
232 } elsif ($keysym == 0xff08) { # backspace
233 substr $self->{search}, -1, 1, "";
234 $self->search (+1, $self->{row});
235 $self->idle;
236 } elsif ($string !~ /[\x00-\x1f\x80-\xaf]/) {
237 return; # pass to tt_write
238 }
239
143 1 240 1
144} 241}
145 242
243sub tt_write {
244 my ($self, $data) = @_;
146 245
246 $self->{search} .= $self->locale_decode ($data);
247
248 $self->{search} =~ s/^\(\?i\)//
249 if $self->{search} =~ /^\(.*[[:upper:]]/;
250
251 delete $self->{found};
252 $self->search (-1, $self->{row});
253 $self->idle;
254
255 1
256}
257
258

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines