ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC vs.
Revision 1.127 by root, Wed Jan 25 00:42:21 2006 UTC

66contain at least one pair of capturing parentheses, which will be used for 66contain at least one pair of capturing parentheses, which will be used for
67the match. For example, the followign adds a regex that matches everything 67the match. For example, the followign adds a regex that matches everything
68between two vertical bars: 68between two vertical bars:
69 69
70 URxvt.selection.pattern-0: \\|([^|]+)\\| 70 URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72Another example: Programs I use often output "absolute path: " at the
73beginning of a line when they process multiple files. The following
74pattern matches the filename (note, there is a single space at the very
75end):
76
77 URxvt.selection.pattern-0: ^(/[^:]+):\
71 78
72You can look at the source of the selection extension to see more 79You can look at the source of the selection extension to see more
73interesting uses, such as parsing a line from beginning to end. 80interesting uses, such as parsing a line from beginning to end.
74 81
75This extension also offers following bindable keyboard commands: 82This extension also offers following bindable keyboard commands:
127bottom. C<Escape> leaves search mode and returns to the point where search 134bottom. C<Escape> leaves search mode and returns to the point where search
128was started, while C<Enter> or C<Return> stay at the current position and 135was started, while C<Enter> or C<Return> stay at the current position and
129additionally stores the first match in the current line into the primary 136additionally stores the first match in the current line into the primary
130selection. 137selection.
131 138
132=item selection-autotransform 139=item readline (enabled by default)
133
134This selection allows you to do automatic transforms on a selection
135whenever a selection is made.
136
137It works by specifying perl snippets (most useful is a single C<s///>
138operator) that modify C<$_> as resources:
139
140 URxvt.selection-autotransform.0: transform
141 URxvt.selection-autotransform.1: transform
142 ...
143
144For example, the following will transform selections of the form
145C<filename:number>, often seen in compiler messages, into C<vi +$filename
146$word>:
147
148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
149
150And this example matches the same,but replaces it with vi-commands you can
151paste directly into your (vi :) editor:
152
153 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
154
155Of course, this can be modified to suit your needs and your editor :)
156
157To expand the example above to typical perl error messages ("XXX at
158FILENAME line YYY."), you need a slightly more elaborate solution:
159
160 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
161 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162
163The first line tells the selection code to treat the unchanging part of
164every error message as a selection pattern, and the second line transforms
165the message into vi commands to load the file.
166
167=item readline
168 140
169A support package that tries to make editing with readline easier. At the 141A support package that tries to make editing with readline easier. At the
170moment, it reacts to clicking with the left mouse button by trying to 142moment, it reacts to clicking with the left mouse button by trying to
171move the text cursor to this position. It does so by generating as many 143move the text cursor to this position. It does so by generating as many
172cursor-left or cursor-right keypresses as required (the this only works 144cursor-left or cursor-right keypresses as required (the this only works
173for programs that correctly support wide characters). 145for programs that correctly support wide characters).
174 146
175It only works when clicking into the same line (possibly extended over 147To avoid too many false positives, this is only done when:
176multiple rows) as the text cursor and on the primary screen, to reduce the 148
177risk of misinterpreting. The normal selection isn't disabled, so quick 149=over 4
150
151=item - the tty is in ICANON state.
152
153=item - the text cursor is visible.
154
155=item - the primary screen is currently being displayed.
156
157=item - the mouse is on the same (multi-row-) line as the text cursor.
158
159=back
160
161The normal selection mechanism isn't disabled, so quick successive clicks
178successive clicks might interfere with selection creation in harmless 162might interfere with selection creation in harmless ways.
179ways. 163
164=item selection-autotransform
165
166This selection allows you to do automatic transforms on a selection
167whenever a selection is made.
168
169It works by specifying perl snippets (most useful is a single C<s///>
170operator) that modify C<$_> as resources:
171
172 URxvt.selection-autotransform.0: transform
173 URxvt.selection-autotransform.1: transform
174 ...
175
176For example, the following will transform selections of the form
177C<filename:number>, often seen in compiler messages, into C<vi +$filename
178$word>:
179
180 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
181
182And this example matches the same,but replaces it with vi-commands you can
183paste directly into your (vi :) editor:
184
185 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
186
187Of course, this can be modified to suit your needs and your editor :)
188
189To expand the example above to typical perl error messages ("XXX at
190FILENAME line YYY."), you need a slightly more elaborate solution:
191
192 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
193 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
194
195The first line tells the selection code to treat the unchanging part of
196every error message as a selection pattern, and the second line transforms
197the message into vi commands to load the file.
180 198
181=item tabbed 199=item tabbed
182 200
183This transforms the terminal into a tabbar with additional terminals, that 201This transforms the terminal into a tabbar with additional terminals, that
184is, it implements what is commonly refered to as "tabbed terminal". The topmost line 202is, it implements what is commonly refered to as "tabbed terminal". The topmost line
352Called at the very end of initialisation of a new terminal, just before 370Called at the very end of initialisation of a new terminal, just before
353trying to map (display) the toplevel and returning to the mainloop. 371trying to map (display) the toplevel and returning to the mainloop.
354 372
355=item on_destroy $term 373=item on_destroy $term
356 374
357Called whenever something tries to destroy terminal, before doing anything 375Called whenever something tries to destroy terminal, when the terminal is
358yet. If this hook returns true, then destruction is skipped, but this is 376still fully functional (not for long, though).
359rarely a good idea.
360 377
361=item on_reset $term 378=item on_reset $term
362 379
363Called after the screen is "reset" for any reason, such as resizing or 380Called after the screen is "reset" for any reason, such as resizing or
364control sequences. Here is where you can react on changes to size-related 381control sequences. Here is where you can react on changes to size-related
552our $LIBDIR; 569our $LIBDIR;
553our $RESNAME; 570our $RESNAME;
554our $RESCLASS; 571our $RESCLASS;
555our $RXVTNAME; 572our $RXVTNAME;
556 573
557our $NOCHAR = chr 0xfffe; 574our $NOCHAR = chr 0xffff;
558 575
559=head2 Variables in the C<urxvt> Package 576=head2 Variables in the C<urxvt> Package
560 577
561=over 4 578=over 4
562 579
709 unless $msg =~ /\n$/; 726 unless $msg =~ /\n$/;
710 urxvt::warn ($msg); 727 urxvt::warn ($msg);
711 }; 728 };
712} 729}
713 730
731no warnings 'utf8';
732
714my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 733my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
715 734
716sub verbose { 735sub verbose {
717 my ($level, $msg) = @_; 736 my ($level, $msg) = @_;
718 warn "$msg\n" if $level <= $verbosity; 737 warn "$msg\n" if $level <= $verbosity;
734 753
735 open my $fh, "<:raw", $path 754 open my $fh, "<:raw", $path
736 or die "$path: $!"; 755 or die "$path: $!";
737 756
738 my $source = 757 my $source =
739 "package $pkg; use strict; use utf8;\n" 758 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
740 . "#line 1 \"$path\"\n{\n" 759 . "#line 1 \"$path\"\n{\n"
741 . (do { local $/; <$fh> }) 760 . (do { local $/; <$fh> })
742 . "\n};\n1"; 761 . "\n};\n1";
743 762
744 eval $source 763 eval $source
769 $TERM->register_package ($_) for @pkg; 788 $TERM->register_package ($_) for @pkg;
770 } 789 }
771 790
772 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 791 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
773 if ($_ eq "default") { 792 if ($_ eq "default") {
774 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 793 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
775 } elsif (/^-(.*)$/) { 794 } elsif (/^-(.*)$/) {
776 delete $ext_arg{$1}; 795 delete $ext_arg{$1};
777 } elsif (/^([^<]+)<(.*)>$/) { 796 } elsif (/^([^<]+)<(.*)>$/) {
778 push @{ $ext_arg{$1} }, $2; 797 push @{ $ext_arg{$1} }, $2;
779 } else { 798 } else {
1299Replaces the event mask of the pty watcher by the given event mask. Can 1318Replaces the event mask of the pty watcher by the given event mask. Can
1300be used to suppress input and output handling to the pty/tty. See the 1319be used to suppress input and output handling to the pty/tty. See the
1301description of C<< urxvt::timer->events >>. Make sure to always restore 1320description of C<< urxvt::timer->events >>. Make sure to always restore
1302the previous value. 1321the previous value.
1303 1322
1323=item $fd = $term->pty_fd
1324
1325Returns the master file descriptor for the pty in use, or C<-1> if no pty
1326is used.
1327
1304=item $windowid = $term->parent 1328=item $windowid = $term->parent
1305 1329
1306Return the window id of the toplevel window. 1330Return the window id of the toplevel window.
1307 1331
1308=item $windowid = $term->vt 1332=item $windowid = $term->vt
1376 1400
1377=item $screen = $term->current_screen 1401=item $screen = $term->current_screen
1378 1402
1379Returns the currently displayed screen (0 primary, 1 secondary). 1403Returns the currently displayed screen (0 primary, 1 secondary).
1380 1404
1405=item $cursor_is_hidden = $term->hidden_cursor
1406
1407Returns wether the cursor is currently hidden or not.
1408
1381=item $view_start = $term->view_start ([$newvalue]) 1409=item $view_start = $term->view_start ([$newvalue])
1382 1410
1383Returns the row number of the topmost displayed line. Maximum value is 1411Returns the row number of the topmost displayed line. Maximum value is
1384C<0>, which displays the normal terminal contents. Lower values scroll 1412C<0>, which displays the normal terminal contents. Lower values scroll
1385this many lines into the scrollback buffer. 1413this many lines into the scrollback buffer.
1403If C<$new_text> is specified, it will replace characters in the current 1431If C<$new_text> is specified, it will replace characters in the current
1404line, starting at column C<$start_col> (default C<0>), which is useful 1432line, starting at column C<$start_col> (default C<0>), which is useful
1405to replace only parts of a line. The font index in the rendition will 1433to replace only parts of a line. The font index in the rendition will
1406automatically be updated. 1434automatically be updated.
1407 1435
1408C<$text> is in a special encoding: tabs and wide characters that use 1436C<$text> is in a special encoding: tabs and wide characters that use more
1409more than one cell when displayed are padded with C<$urxvt::NOCHAR> 1437than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1410characters. Characters with combining characters and other characters that 1438characters. Characters with combining characters and other characters that
1411do not fit into the normal tetx encoding will be replaced with characters 1439do not fit into the normal tetx encoding will be replaced with characters
1412in the private use area. 1440in the private use area.
1413 1441
1414You have to obey this encoding when changing text. The advantage is 1442You have to obey this encoding when changing text. The advantage is

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines