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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines