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.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
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
338Called 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
339trying to map (display) the toplevel and returning to the mainloop. 371trying to map (display) the toplevel and returning to the mainloop.
340 372
341=item on_destroy $term 373=item on_destroy $term
342 374
343Called whenever something tries to destroy terminal, before doing anything 375Called whenever something tries to destroy terminal, when the terminal is
344yet. If this hook returns true, then destruction is skipped, but this is 376still fully functional (not for long, though).
345rarely a good idea.
346 377
347=item on_reset $term 378=item on_reset $term
348 379
349Called 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
350control 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
537 568
538our $LIBDIR; 569our $LIBDIR;
539our $RESNAME; 570our $RESNAME;
540our $RESCLASS; 571our $RESCLASS;
541our $RXVTNAME; 572our $RXVTNAME;
573
574our $NOCHAR = chr 0xffff;
542 575
543=head2 Variables in the C<urxvt> Package 576=head2 Variables in the C<urxvt> Package
544 577
545=over 4 578=over 4
546 579
693 unless $msg =~ /\n$/; 726 unless $msg =~ /\n$/;
694 urxvt::warn ($msg); 727 urxvt::warn ($msg);
695 }; 728 };
696} 729}
697 730
731no warnings 'utf8';
732
698my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 733my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
699 734
700sub verbose { 735sub verbose {
701 my ($level, $msg) = @_; 736 my ($level, $msg) = @_;
702 warn "$msg\n" if $level <= $verbosity; 737 warn "$msg\n" if $level <= $verbosity;
718 753
719 open my $fh, "<:raw", $path 754 open my $fh, "<:raw", $path
720 or die "$path: $!"; 755 or die "$path: $!";
721 756
722 my $source = 757 my $source =
723 "package $pkg; use strict; use utf8;\n" 758 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
724 . "#line 1 \"$path\"\n{\n" 759 . "#line 1 \"$path\"\n{\n"
725 . (do { local $/; <$fh> }) 760 . (do { local $/; <$fh> })
726 . "\n};\n1"; 761 . "\n};\n1";
727 762
728 eval $source 763 eval $source
753 $TERM->register_package ($_) for @pkg; 788 $TERM->register_package ($_) for @pkg;
754 } 789 }
755 790
756 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 791 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
757 if ($_ eq "default") { 792 if ($_ eq "default") {
758 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 793 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
759 } elsif (/^-(.*)$/) { 794 } elsif (/^-(.*)$/) {
760 delete $ext_arg{$1}; 795 delete $ext_arg{$1};
761 } elsif (/^([^<]+)<(.*)>$/) { 796 } elsif (/^([^<]+)<(.*)>$/) {
762 push @{ $ext_arg{$1} }, $2; 797 push @{ $ext_arg{$1} }, $2;
763 } else { 798 } else {
1260 1295
1261Normally its not a good idea to use this function, as programs might be 1296Normally 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 1297confused by changes in cursor position or scrolling. Its useful inside a
1263C<on_add_lines> hook, though. 1298C<on_add_lines> hook, though.
1264 1299
1300=item $term->scr_change_screen ($screen)
1301
1302Switch to given screen - 0 primary, 1 secondary.
1303
1265=item $term->cmd_parse ($octets) 1304=item $term->cmd_parse ($octets)
1266 1305
1267Similar to C<scr_add_lines>, but the argument must be in the 1306Similar to C<scr_add_lines>, but the argument must be in the
1268locale-specific encoding of the terminal and can contain command sequences 1307locale-specific encoding of the terminal and can contain command sequences
1269(escape codes) that will be interpreted. 1308(escape codes) that will be interpreted.
1278 1317
1279Replaces 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
1280be 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
1281description of C<< urxvt::timer->events >>. Make sure to always restore 1320description of C<< urxvt::timer->events >>. Make sure to always restore
1282the previous value. 1321the previous value.
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.
1283 1327
1284=item $windowid = $term->parent 1328=item $windowid = $term->parent
1285 1329
1286Return the window id of the toplevel window. 1330Return the window id of the toplevel window.
1287 1331
1352=item $modifiermask = $term->ModNumLockMask 1396=item $modifiermask = $term->ModNumLockMask
1353 1397
1354Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1398Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1355AltGr), the meta key (often Alt) and the num lock key, if applicable. 1399AltGr), the meta key (often Alt) and the num lock key, if applicable.
1356 1400
1401=item $screen = $term->current_screen
1402
1403Returns the currently displayed screen (0 primary, 1 secondary).
1404
1405=item $cursor_is_hidden = $term->hidden_cursor
1406
1407Returns wether the cursor is currently hidden or not.
1408
1357=item $view_start = $term->view_start ([$newvalue]) 1409=item $view_start = $term->view_start ([$newvalue])
1358 1410
1359Returns the row number of the topmost displayed line. Maximum value is 1411Returns the row number of the topmost displayed line. Maximum value is
1360C<0>, which displays the normal terminal contents. Lower values scroll 1412C<0>, which displays the normal terminal contents. Lower values scroll
1361this many lines into the scrollback buffer. 1413this many lines into the scrollback buffer.
1380line, 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
1381to 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
1382automatically be updated. 1434automatically be updated.
1383 1435
1384C<$text> is in a special encoding: tabs and wide characters that use more 1436C<$text> is in a special encoding: tabs and wide characters that use more
1385than one cell when displayed are padded with urxvt::NOCHAR characters 1437than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1386(C<chr 65535>). Characters with combining characters and other characters 1438characters. Characters with combining characters and other characters that
1387that do not fit into the normal tetx encoding will be replaced with 1439do not fit into the normal tetx encoding will be replaced with characters
1388characters in the private use area. 1440in the private use area.
1389 1441
1390You have to obey this encoding when changing text. The advantage is 1442You have to obey this encoding when changing text. The advantage is
1391that C<substr> and similar functions work on screen cells and not on 1443that C<substr> and similar functions work on screen cells and not on
1392characters. 1444characters.
1393 1445

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines