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.29 by root, Sun Jun 10 17:31:53 2012 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: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
13Adds regex search functionality to the scrollback buffer, triggered
14by a hotkey (default: C<M-s>). While in search mode, normal terminal
15input/output is suspended and a regex is displayed at the bottom of the
16screen.
17
18Inputting characters appends them to the regex and continues incremental
19search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
20search upwards/downwards in the scrollback buffer, C<End> jumps to the
21bottom. C<Escape> leaves search mode and returns to the point where search
22was started, while C<Enter> or C<Return> stay at the current position and
23additionally stores the first match in the current line into the primary
24selection if the C<Shift> modifier is active.
25
26The regex defaults to "(?i)", resulting in a case-insensitive search. To
27get a case-sensitive search you can delete this prefix using C<BackSpace>
28or simply use an uppercase character which removes the "(?i)" prefix.
29
30See L<perlre> for more info about perl regular expression syntax.
31
32=cut
33
5sub on_init { 34sub on_init {
6 my ($self) = @_; 35 my ($self) = @_;
7 36
8 my $hotkey = $self->{argv}[0] || "M-s"; 37 my $hotkey = $self->{argv}[0]
38 || $self->x_resource ("%")
39 || "M-s";
9 40
10 $self->parse_keysym ($hotkey, "perl:searchable-scrollback:enter") 41 $self->parse_keysym ($hotkey, "perl:searchable-scrollback:start")
11 or warn "unable to register '$hotkey' as scrollback search enter hotkey\n"; 42 or warn "unable to register '$hotkey' as scrollback search start hotkey\n";
12 43
13 () 44 ()
14} 45}
15 46
16sub on_keyboard_command { 47sub on_user_command {
17 my ($self, $cmd) = @_; 48 my ($self, $cmd) = @_;
18 49
19 if ($cmd eq "searchable-scrollback:enter") { 50 $cmd eq "searchable-scrollback:start"
20 $self->enter; 51 and $self->enter;
21 }
22 52
23 () 53 ()
24} 54}
25 55
26sub msg { 56sub msg {
… …
33sub enter { 63sub enter {
34 my ($self) = @_; 64 my ($self) = @_;
35 65
36 return if $self->{overlay}; 66 return if $self->{overlay};
37 67
38 $self->{pty_ev_events} = $self->pty_ev_events (urxvt::EVENT_NONE);
39 $self->{view_start} = $self->view_start; 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)";
40 72
41 $self->enable ( 73 $self->enable (
74 key_press => \&key_press,
75 tt_write => \&tt_write,
42 refresh_begin => sub { 76 refresh_begin => \&refresh,
43 warn "beg(@_)\n"; 77 refresh_end => \&refresh,
44 },
45 refresh_end => sub {
46 warn "end(@_)\n";
47 },
48 ); 78 );
49 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
50 $self->idle; 83 $self->idle;
51} 84}
52 85
53sub leave { 86sub leave {
54 my ($self) = @_; 87 my ($self) = @_;
55 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};
56 delete $self->{overlay}; 93 delete $self->{overlay};
57 94 delete $self->{history};
58 $self->disable ("refresh_begin", "refresh_end"); 95 delete $self->{search};
59
60 $self->pty_ev_events ($self->{pty_ev_events});
61 $self->want_refresh;
62} 96}
63 97
64sub idle { 98sub idle {
65 my ($self) = @_; 99 my ($self) = @_;
66 100
67 $self->msg ("scrollback search, escape=exit, enter=accept, /=start search, n=next, p=previous"); 101 $self->msg ("(escape cancels) /$self->{search}█");
68
69 delete $self->{in_search};
70} 102}
71 103
72sub search { 104sub search {
73 my ($self) = @_; 105 my ($self, $dir) = @_;
74
75 my $row = -$self->view_start;
76 106
77 delete $self->{found}; 107 delete $self->{found};
108 my $row = $self->{row};
109
110 my $search = $self->special_encode ($self->{search});
78 111
79 no re 'eval'; # just to be sure 112 no re 'eval'; # just to be sure
80 my $re = qr/$self->{search}/; 113 if (my $re = eval { qr/$search/ }) {
81 114 while ($self->nrow > $row && $row >= $self->top_row) {
82 while ($row > -$self->nsaved) {
83 my $line = $self->line ($row) 115 my $line = $self->line ($row)
84 or last; 116 or last;
85 117
86 my $text = $line->t; 118 my $text = $line->t;
87 if ($text =~ /$re/g) { 119 if ($text =~ /$re/g) {
88 do { 120 do {
89 push @{ $self->{found} }, [$line->coord_of ($-[0]), $line->coord_of ($+[1])]; 121 push @{ $self->{found} }, [$line->coord_of ($-[0]), $line->coord_of ($+[0])];
90 } while $text =~ /$re/g; 122 } while $text =~ /$re/g;
91 123
124 $self->{row} = $row;
92 $self->view_start (-$row + ($self->nrow >> 1)); 125 $self->view_start (List::Util::min 0, $row - ($self->nrow >> 1));
126 $self->want_refresh;
93 last; 127 last;
94 } 128 }
95 129
96 $row = $line->beg - 1; 130 $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 } 131 }
141 } 132 }
142 133
134 $self->scr_bell unless $self->{found};
135}
136
137sub 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
151sub 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
143 1 184 1
144} 185}
145 186
187sub tt_write {
188 my ($self, $data) = @_;
146 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

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines