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.4 by root, Mon Jan 9 23:06:05 2006 UTC vs.
Revision 1.30 by root, Tue Sep 4 22:41:12 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
9searchable-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:start") 41 $self->parse_keysym ($hotkey, "perl:searchable-scrollback:start")
11 or warn "unable to register '$hotkey' as scrollback search start 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:start") { 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 (
42 key_press => \&key_press, 74 key_press => \&key_press,
75 tt_write => \&tt_write,
43 refresh_begin => \&refresh, 76 refresh_begin => \&refresh,
44 refresh_end => \&refresh, 77 refresh_end => \&refresh,
45 ); 78 );
46 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
47 $self->idle; 83 $self->idle;
48} 84}
49 85
50sub leave { 86sub leave {
51 my ($self) = @_; 87 my ($self) = @_;
52 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};
53 delete $self->{overlay}; 93 delete $self->{overlay};
54 94 delete $self->{history};
55 $self->disable ("key_press", "refresh_begin", "refresh_end"); 95 delete $self->{search};
56
57 $self->pty_ev_events ($self->{pty_ev_events});
58 $self->want_refresh;
59} 96}
60 97
61sub idle { 98sub idle {
62 my ($self) = @_; 99 my ($self) = @_;
63 100
64 $self->msg ("scrollback search, escape=exit, enter=accept, /=start search, n=next, p=previous, G=bottom"); 101 $self->msg ("(escape cancels) /$self->{search}█");
65
66 delete $self->{in_search};
67} 102}
68 103
69sub search { 104sub search {
70 my ($self) = @_; 105 my ($self, $dir) = @_;
71
72 my $row = -$self->view_start;
73 106
74 delete $self->{found}; 107 delete $self->{found};
108 my $row = $self->{row};
109
110 my $search = $self->special_encode ($self->{search});
75 111
76 no re 'eval'; # just to be sure 112 no re 'eval'; # just to be sure
77 my $re = qr/$self->{search}/; 113 if (my $re = eval { qr/$search/ }) {
78 114 while ($self->nrow > $row && $row >= $self->top_row) {
79 while ($row > -$self->nsaved) {
80 my $line = $self->line ($row) 115 my $line = $self->line ($row)
81 or last; 116 or last;
82 117
83 my $text = $line->t; 118 my $text = $line->t;
84 if ($text =~ /$re/g) { 119 if ($text =~ /$re/g) {
85 do { 120 do {
86 push @{ $self->{found} }, [$line->coord_of ($-[0]), $line->coord_of ($+[0])]; 121 push @{ $self->{found} }, [$line->coord_of ($-[0]), $line->coord_of ($+[0])];
87 } while $text =~ /$re/g; 122 } while $text =~ /$re/g;
88 123
124 $self->{row} = $row;
89 $self->view_start (-$row + ($self->nrow >> 1)); 125 $self->view_start (List::Util::min 0, $row - ($self->nrow >> 1));
126 $self->want_refresh;
90 last; 127 last;
128 }
129
130 $row = $dir < 0 ? $line->beg - 1 : $line->end + 1;
91 } 131 }
92
93 $row = $line->beg - 1;
94 } 132 }
95 133
96 $self->msg ("enter/type/backspace: /$self->{search}_"
97 . ($self->{found} ? "" : " (not found)"));
98 $self->scr_bell unless $self->{found}; 134 $self->scr_bell unless $self->{found};
99} 135}
100 136
101sub refresh { 137sub refresh {
102 my ($self) = @_; 138 my ($self) = @_;
103 139
104 return unless $self->{found}; 140 return unless $self->{found};
105 141
106 $self->scr_xor_span (@$_) 142 my $xor = urxvt::RS_RVid | urxvt::RS_Blink;
107 for @{ $self->{found} }; 143 for (@{ $self->{found} }) {
144 $self->scr_xor_span (@$_, $xor);
145 $xor = urxvt::RS_RVid;
146 }
108 147
109 () 148 ()
110} 149}
111 150
112sub key_press { 151sub key_press {
113 my ($self, $event, $keysym, $string) = @_; 152 my ($self, $event, $keysym, $string) = @_;
114 153
115 if (exists $self->{in_search}) { 154 delete $self->{manpage_overlay};
155
116 if ($keysym == 0xff0d || $keysym == 0xff8d) { 156 if ($keysym == 0xff0d || $keysym == 0xff8d) { # enter
117 $self->idle; 157 if ($self->{found} && $event->{state} & urxvt::ShiftMask) {
118 } elsif ($keysym == 0xff1b) { 158 my ($br, $bc, $er, $ec) = @{ $self->{found}[0] };
119 $self->view_start ($self->{in_search}); 159 $self->selection_beg ($br, $bc);
120 $self->idle; 160 $self->selection_end ($er, $ec);
121 } elsif ($keysym == 0xff08) { 161 $self->selection_make ($event->{time});
122 substr $self->{search}, -1, 1, "";
123
124 $self->search;
125 } elsif ($string ne "") {
126 $self->{search} .= $string;
127
128 $self->search;
129 } 162 }
130 } else {
131 if ($keysym == 0xff0d || $keysym == 0xff8d) {
132 # OK
133 $self->leave; 163 $self->leave;
134 } elsif ($keysym == 0xff1b) { 164 } elsif ($keysym == 0xff1b) { # escape
135 $self->view_start ($self->{view_start}); 165 $self->view_start ($self->{view_start});
136 $self->leave; 166 $self->leave;
137 } elsif ($keysym == 0xff52) { 167 } elsif ($keysym == 0xff57) { # end
138 $self->view_start ($self->view_start + 1); 168 $self->{row} = $self->nrow - 1;
139 } elsif ($keysym == 0xff54) {
140 $self->view_start ($self->view_start - 1);
141 } elsif ($string eq "/") {
142 $self->{in_search} = $self->view_start;
143 $self->search;
144 } elsif ($string eq "G") {
145 $self->view_start (0); 169 $self->view_start (0);
146 } elsif ($string eq "n") { 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, "";
147 $self->search; 178 $self->search;
148 } elsif ($string eq "p") { 179 $self->idle;
149 # TODO 180 } elsif ($string !~ /[\x00-\x1f\x80-\xaf]/) {
150 } elsif ($string ne "") { 181 return; # pass to tt_write
151 $self->scr_bell;
152 }
153 } 182 }
154 183
155 1 184 1
156} 185}
157 186
187sub tt_write {
188 my ($self, $data) = @_;
158 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