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.120 by root, Fri Jan 20 22:05:41 2006 UTC vs.
Revision 1.129 by root, Wed Jan 25 15:11:31 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
139=item readline (enabled by default)
140
141A support package that tries to make editing with readline easier. At the
142moment, it reacts to clicking with the left mouse button by trying to
143move the text cursor to this position. It does so by generating as many
144cursor-left or cursor-right keypresses as required (the this only works
145for programs that correctly support wide characters).
146
147To avoid too many false positives, this is only done when:
148
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
162might interfere with selection creation in harmless ways.
163
132=item selection-autotransform 164=item selection-autotransform
133 165
134This selection allows you to do automatic transforms on a selection 166This selection allows you to do automatic transforms on a selection
135whenever a selection is made. 167whenever a selection is made.
136 168
180Uses per-line display filtering (C<on_line_update>) to underline urls and 212Uses per-line display filtering (C<on_line_update>) to underline urls and
181make them clickable. When middle-clicked, the program specified in the 213make them clickable. When middle-clicked, the program specified in the
182resource C<urlLauncher> (default C<x-www-browser>) will be started with 214resource C<urlLauncher> (default C<x-www-browser>) will be started with
183the URL as first argument. 215the URL as first argument.
184 216
217=item xim-onthespot
218
219This (experimental) perl extension implements OnTheSpot editing. It does
220not work perfectly, and some input methods don't seem to work well with
221OnTheSpot editing in general, but it seems to work at leats for SCIM and
222kinput2.
223
224You enable it by specifying this extension and a preedit style of
225C<OnTheSpot>, i.e.:
226
227 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
228
185=item automove-background 229=item automove-background
186 230
187This is basically a one-line extension that dynamically changes the background pixmap offset 231This is basically a one-line extension that dynamically changes the background pixmap offset
188to the window position, in effect creating the same effect as pseudo transparency with 232to the window position, in effect creating the same effect as pseudo transparency with
189a custom pixmap. No scaling is supported in this mode. Exmaple: 233a custom pixmap. No scaling is supported in this mode. Exmaple:
198 242
199=item digital-clock 243=item digital-clock
200 244
201Displays a digital clock using the built-in overlay. 245Displays a digital clock using the built-in overlay.
202 246
203=item example-refresh-hooks 247=item remote-selection
204 248
205Displays a very simple digital clock in the upper right corner of the 249Somewhat of a misnomer, this extension adds two menu entries to the
206window. Illustrates overwriting the refresh callbacks to create your own 250selection popup that allows one ti run external commands to store the
207overlays or changes. 251selection somewhere and fetch it again.
252
253We use it to implement a "distributed selection mechanism", which just
254means that one command uploads the file to a remote server, and another
255reads it.
256
257The commands can be set using the C<URxvt.remote-selection.store> and
258C<URxvt.remote-selection.fetch> resources. The first should read the
259selection to store from STDIN (always in UTF-8), the second should provide
260the selection data on STDOUT (also in UTF-8).
261
262The defaults (which are likely useless to you) use rsh and cat:
263
264 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
265 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
208 266
209=item selection-pastebin 267=item selection-pastebin
210 268
211This is a little rarely useful extension that Uploads the selection as 269This is a little rarely useful extension that Uploads the selection as
212textfile to a remote site (or does other things). (The implementation is 270textfile to a remote site (or does other things). (The implementation is
232After a successful upload the selection will be replaced by the text given 290After a successful upload the selection will be replaced by the text given
233in the C<selection-pastebin-url> resource (again, the % is the placeholder 291in the C<selection-pastebin-url> resource (again, the % is the placeholder
234for the filename): 292for the filename):
235 293
236 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 294 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
295
296=item example-refresh-hooks
297
298Displays a very simple digital clock in the upper right corner of the
299window. Illustrates overwriting the refresh callbacks to create your own
300overlays or changes.
237 301
238=back 302=back
239 303
240=head1 API DOCUMENTATION 304=head1 API DOCUMENTATION
241 305
338Called at the very end of initialisation of a new terminal, just before 402Called at the very end of initialisation of a new terminal, just before
339trying to map (display) the toplevel and returning to the mainloop. 403trying to map (display) the toplevel and returning to the mainloop.
340 404
341=item on_destroy $term 405=item on_destroy $term
342 406
343Called whenever something tries to destroy terminal, before doing anything 407Called whenever something tries to destroy terminal, when the terminal is
344yet. If this hook returns true, then destruction is skipped, but this is 408still fully functional (not for long, though).
345rarely a good idea.
346 409
347=item on_reset $term 410=item on_reset $term
348 411
349Called after the screen is "reset" for any reason, such as resizing or 412Called after the screen is "reset" for any reason, such as resizing or
350control sequences. Here is where you can react on changes to size-related 413control sequences. Here is where you can react on changes to size-related
537 600
538our $LIBDIR; 601our $LIBDIR;
539our $RESNAME; 602our $RESNAME;
540our $RESCLASS; 603our $RESCLASS;
541our $RXVTNAME; 604our $RXVTNAME;
605
606our $NOCHAR = chr 0xffff;
542 607
543=head2 Variables in the C<urxvt> Package 608=head2 Variables in the C<urxvt> Package
544 609
545=over 4 610=over 4
546 611
693 unless $msg =~ /\n$/; 758 unless $msg =~ /\n$/;
694 urxvt::warn ($msg); 759 urxvt::warn ($msg);
695 }; 760 };
696} 761}
697 762
763no warnings 'utf8';
764
698my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 765my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
699 766
700sub verbose { 767sub verbose {
701 my ($level, $msg) = @_; 768 my ($level, $msg) = @_;
702 warn "$msg\n" if $level <= $verbosity; 769 warn "$msg\n" if $level <= $verbosity;
718 785
719 open my $fh, "<:raw", $path 786 open my $fh, "<:raw", $path
720 or die "$path: $!"; 787 or die "$path: $!";
721 788
722 my $source = 789 my $source =
723 "package $pkg; use strict; use utf8;\n" 790 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
724 . "#line 1 \"$path\"\n{\n" 791 . "#line 1 \"$path\"\n{\n"
725 . (do { local $/; <$fh> }) 792 . (do { local $/; <$fh> })
726 . "\n};\n1"; 793 . "\n};\n1";
727 794
728 eval $source 795 eval $source
753 $TERM->register_package ($_) for @pkg; 820 $TERM->register_package ($_) for @pkg;
754 } 821 }
755 822
756 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 823 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
757 if ($_ eq "default") { 824 if ($_ eq "default") {
758 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 825 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
759 } elsif (/^-(.*)$/) { 826 } elsif (/^-(.*)$/) {
760 delete $ext_arg{$1}; 827 delete $ext_arg{$1};
761 } elsif (/^([^<]+)<(.*)>$/) { 828 } elsif (/^([^<]+)<(.*)>$/) {
762 push @{ $ext_arg{$1} }, $2; 829 push @{ $ext_arg{$1} }, $2;
763 } else { 830 } else {
1260 1327
1261Normally its not a good idea to use this function, as programs might be 1328Normally its not a good idea to use this function, as programs might be
1262confused by changes in cursor position or scrolling. Its useful inside a 1329confused by changes in cursor position or scrolling. Its useful inside a
1263C<on_add_lines> hook, though. 1330C<on_add_lines> hook, though.
1264 1331
1332=item $term->scr_change_screen ($screen)
1333
1334Switch to given screen - 0 primary, 1 secondary.
1335
1265=item $term->cmd_parse ($octets) 1336=item $term->cmd_parse ($octets)
1266 1337
1267Similar to C<scr_add_lines>, but the argument must be in the 1338Similar to C<scr_add_lines>, but the argument must be in the
1268locale-specific encoding of the terminal and can contain command sequences 1339locale-specific encoding of the terminal and can contain command sequences
1269(escape codes) that will be interpreted. 1340(escape codes) that will be interpreted.
1278 1349
1279Replaces the event mask of the pty watcher by the given event mask. Can 1350Replaces the event mask of the pty watcher by the given event mask. Can
1280be used to suppress input and output handling to the pty/tty. See the 1351be used to suppress input and output handling to the pty/tty. See the
1281description of C<< urxvt::timer->events >>. Make sure to always restore 1352description of C<< urxvt::timer->events >>. Make sure to always restore
1282the previous value. 1353the previous value.
1354
1355=item $fd = $term->pty_fd
1356
1357Returns the master file descriptor for the pty in use, or C<-1> if no pty
1358is used.
1283 1359
1284=item $windowid = $term->parent 1360=item $windowid = $term->parent
1285 1361
1286Return the window id of the toplevel window. 1362Return the window id of the toplevel window.
1287 1363
1352=item $modifiermask = $term->ModNumLockMask 1428=item $modifiermask = $term->ModNumLockMask
1353 1429
1354Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1430Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1355AltGr), the meta key (often Alt) and the num lock key, if applicable. 1431AltGr), the meta key (often Alt) and the num lock key, if applicable.
1356 1432
1433=item $screen = $term->current_screen
1434
1435Returns the currently displayed screen (0 primary, 1 secondary).
1436
1437=item $cursor_is_hidden = $term->hidden_cursor
1438
1439Returns wether the cursor is currently hidden or not.
1440
1357=item $view_start = $term->view_start ([$newvalue]) 1441=item $view_start = $term->view_start ([$newvalue])
1358 1442
1359Returns the row number of the topmost displayed line. Maximum value is 1443Returns the row number of the topmost displayed line. Maximum value is
1360C<0>, which displays the normal terminal contents. Lower values scroll 1444C<0>, which displays the normal terminal contents. Lower values scroll
1361this many lines into the scrollback buffer. 1445this many lines into the scrollback buffer.
1380line, starting at column C<$start_col> (default C<0>), which is useful 1464line, starting at column C<$start_col> (default C<0>), which is useful
1381to replace only parts of a line. The font index in the rendition will 1465to replace only parts of a line. The font index in the rendition will
1382automatically be updated. 1466automatically be updated.
1383 1467
1384C<$text> is in a special encoding: tabs and wide characters that use more 1468C<$text> is in a special encoding: tabs and wide characters that use more
1385than one cell when displayed are padded with urxvt::NOCHAR characters 1469than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1386(C<chr 65535>). Characters with combining characters and other characters 1470characters. Characters with combining characters and other characters that
1387that do not fit into the normal tetx encoding will be replaced with 1471do not fit into the normal tetx encoding will be replaced with characters
1388characters in the private use area. 1472in the private use area.
1389 1473
1390You have to obey this encoding when changing text. The advantage is 1474You have to obey this encoding when changing text. The advantage is
1391that C<substr> and similar functions work on screen cells and not on 1475that C<substr> and similar functions work on screen cells and not on
1392characters. 1476characters.
1393 1477

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines