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.35 by sf-exg, Wed May 28 08:05:17 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 (
76 key_press => \&key_press,
77 tt_write => \&tt_write,
42 refresh_begin => sub { 78 refresh_begin => \&refresh,
43 warn "beg(@_)\n"; 79 refresh_end => \&refresh,
44 },
45 refresh_end => sub {
46 warn "end(@_)\n";
47 },
48 ); 80 );
49 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
50 $self->idle; 85 $self->idle;
51} 86}
52 87
53sub leave { 88sub leave {
54 my ($self) = @_; 89 my ($self) = @_;
55 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};
56 delete $self->{overlay}; 95 delete $self->{overlay};
57 96 delete $self->{search};
58 $self->disable ("refresh_begin", "refresh_end");
59
60 $self->pty_ev_events ($self->{pty_ev_events});
61 $self->want_refresh;
62} 97}
63 98
64sub idle { 99sub idle {
65 my ($self) = @_; 100 my ($self) = @_;
66 101
67 $self->msg ("scrollback search, escape=exit, enter=accept, /=start search, n=next, p=previous"); 102 $self->msg ("(escape cancels) /$self->{search}█");
68
69 delete $self->{in_search};
70} 103}
71 104
72sub search { 105sub search {
73 my ($self) = @_; 106 my ($self, $dir) = @_;
74
75 my $row = -$self->view_start;
76 107
77 delete $self->{found}; 108 delete $self->{found};
109 my $row = $self->{row};
110
111 my $search = $self->special_encode ($self->{search});
78 112
79 no re 'eval'; # just to be sure 113 no re 'eval'; # just to be sure
80 my $re = qr/$self->{search}/; 114 if (my $re = eval { qr/$search/ }) {
81 115 while ($self->nrow > $row && $row >= $self->top_row) {
82 while ($row > -$self->nsaved) {
83 my $line = $self->line ($row) 116 my $line = $self->line ($row)
84 or last; 117 or last;
85 118
86 my $text = $line->t; 119 my $text = $line->t;
87 if ($text =~ /$re/g) { 120 if ($text =~ /$re/g) {
88 do { 121 do {
89 push @{ $self->{found} }, [$line->coord_of ($-[0]), $line->coord_of ($+[1])]; 122 push @{ $self->{found} }, [$line->coord_of ($-[0]), $line->coord_of ($+[0])];
90 } while $text =~ /$re/g; 123 } while $text =~ /$re/g;
91 124
125 $self->{row} = $row;
92 $self->view_start (-$row + ($self->nrow >> 1)); 126 $self->view_start (List::Util::min 0, $row - ($self->nrow >> 1));
127 $self->want_refresh;
93 last; 128 last;
94 } 129 }
95 130
96 $row = $line->beg - 1; 131 $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 } 132 }
141 } 133 }
142 134
135 $self->scr_bell unless $self->{found};
136}
137
138sub refresh {
139 my ($self) = @_;
140
141 return unless $self->{found};
142
143 my $xor = urxvt::RS_RVid | urxvt::RS_Blink;
144 for (@{ $self->{found} }) {
145 $self->scr_xor_span (@$_, $xor);
146 $xor = urxvt::RS_RVid;
147 }
148
149 ()
150}
151
152sub key_press {
153 my ($self, $event, $keysym, $string) = @_;
154
155 delete $self->{manpage_overlay};
156
157 if ($keysym == 0xff0d || $keysym == 0xff8d) { # enter
158 if ($self->{found} && $event->{state} & urxvt::ShiftMask) {
159 my ($br, $bc, $er, $ec) = @{ $self->{found}[0] };
160 $self->selection_beg ($br, $bc);
161 $self->selection_end ($er, $ec);
162 $self->selection_make ($event->{time});
163 }
164 $self->leave;
165 } elsif ($keysym == 0xff1b) { # escape
166 $self->view_start ($self->{view_start});
167 $self->leave;
168 } elsif ($keysym == 0xff57) { # end
169 $self->{row} = $self->nrow - 1;
170 $self->view_start (0);
171 } elsif ($keysym == 0xff52) { # up
172 $self->{row}-- if $self->{row} > $self->top_row;
173 $self->search (-1);
174 } elsif ($keysym == 0xff54) { # down
175 $self->{row}++ if $self->{row} < $self->nrow;
176 $self->search (+1);
177 } elsif ($keysym == 0xff08) { # backspace
178 substr $self->{search}, -1, 1, "";
179 $self->search;
180 $self->idle;
181 } elsif ($string !~ /[\x00-\x1f\x80-\xaf]/) {
182 return; # pass to tt_write
183 }
184
143 1 185 1
144} 186}
145 187
188sub tt_write {
189 my ($self, $data) = @_;
146 190
191 $self->{search} .= $self->locale_decode ($data);
192
193 $self->{search} =~ s/^\(\?i\)//
194 if $self->{search} =~ /^\(.*[[:upper:]]/;
195
196 $self->search (-1);
197 $self->idle;
198
199 1
200}
201
202

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines