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.113 by root, Fri Jan 20 10:27:08 2006 UTC vs.
Revision 1.125 by root, Sun Jan 22 20:39:47 2006 UTC

91 91
92=item selection-popup (enabled by default) 92=item selection-popup (enabled by default)
93 93
94Binds a popup menu to Ctrl-Button3 that lets you convert the selection 94Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95text into various other formats/action (such as uri unescaping, perl 95text into various other formats/action (such as uri unescaping, perl
96evalution, web-browser starting etc.), depending on content. 96evaluation, web-browser starting etc.), depending on content.
97 97
98Other extensions can extend this popup menu by pushing a code reference 98Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the 99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100popup is displayed. 100popup is displayed.
101 101
127bottom. C<Escape> leaves search mode and returns to the point where search 127bottom. 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 128was 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 129additionally stores the first match in the current line into the primary
130selection. 130selection.
131 131
132=item readline (enabled by default)
133
134A support package that tries to make editing with readline easier. At the
135moment, it reacts to clicking with the left mouse button by trying to
136move the text cursor to this position. It does so by generating as many
137cursor-left or cursor-right keypresses as required (the this only works
138for programs that correctly support wide characters).
139
140To avoid too many false positives, this is only done when:
141
142=over 4
143
144=item - the tty is in ICANON state.
145
146=item - the text cursor is visible.
147
148=item - the primary screen is currently being displayed.
149
150=item - the mouse is on the same (multi-row-) line as the text cursor.
151
152=back
153
154The normal selection mechanism isn't disabled, so quick successive clicks
155might interfere with selection creation in harmless ways.
156
132=item selection-autotransform 157=item selection-autotransform
133 158
134This selection allows you to do automatic transforms on a selection 159This selection allows you to do automatic transforms on a selection
135whenever a selection is made. 160whenever a selection is made.
136 161
161 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ 186 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162 187
163The first line tells the selection code to treat the unchanging part of 188The first line tells the selection code to treat the unchanging part of
164every error message as a selection pattern, and the second line transforms 189every error message as a selection pattern, and the second line transforms
165the message into vi commands to load the file. 190the message into vi commands to load the file.
191
192=item tabbed
193
194This transforms the terminal into a tabbar with additional terminals, that
195is, it implements what is commonly refered to as "tabbed terminal". The topmost line
196displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
197button per tab.
198
199Clicking a button will activate that tab. Pressing B<Shift-Left> and
200B<Shift-Right> will switch to the tab left or right of the current one,
201while B<Shift-Down> creates a new tab.
166 202
167=item mark-urls 203=item mark-urls
168 204
169Uses per-line display filtering (C<on_line_update>) to underline urls and 205Uses per-line display filtering (C<on_line_update>) to underline urls and
170make them clickable. When middle-clicked, the program specified in the 206make them clickable. When middle-clicked, the program specified in the
465Called wheneever the window loses keyboard focus, before rxvt-unicode does 501Called wheneever the window loses keyboard focus, before rxvt-unicode does
466focus out processing. 502focus out processing.
467 503
468=item on_configure_notify $term, $event 504=item on_configure_notify $term, $event
469 505
506=item on_property_notify $term, $event
507
470=item on_key_press $term, $event, $keysym, $octets 508=item on_key_press $term, $event, $keysym, $octets
471 509
472=item on_key_release $term, $event, $keysym 510=item on_key_release $term, $event, $keysym
473 511
474=item on_button_press $term, $event 512=item on_button_press $term, $event
483 521
484Called whenever the corresponding X event is received for the terminal If 522Called whenever the corresponding X event is received for the terminal If
485the hook returns true, then the even will be ignored by rxvt-unicode. 523the hook returns true, then the even will be ignored by rxvt-unicode.
486 524
487The event is a hash with most values as named by Xlib (see the XEvent 525The event is a hash with most values as named by Xlib (see the XEvent
488manpage), with the additional members C<row> and C<col>, which are the row 526manpage), with the additional members C<row> and C<col>, which are the
489and column under the mouse cursor. 527(real, not screen-based) row and column under the mouse cursor.
490 528
491C<on_key_press> additionally receives the string rxvt-unicode would 529C<on_key_press> additionally receives the string rxvt-unicode would
492output, if any, in locale-specific encoding. 530output, if any, in locale-specific encoding.
493 531
494subwindow. 532subwindow.
533
534=item on_client_message $term, $event
535
536=item on_wm_protocols $term, $event
537
538=item on_wm_delete_window $term, $event
539
540Called when various types of ClientMessage events are received (all with
541format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
495 542
496=back 543=back
497 544
498=cut 545=cut
499 546
515 562
516our $LIBDIR; 563our $LIBDIR;
517our $RESNAME; 564our $RESNAME;
518our $RESCLASS; 565our $RESCLASS;
519our $RXVTNAME; 566our $RXVTNAME;
567
568our $NOCHAR = chr 0xffff;
520 569
521=head2 Variables in the C<urxvt> Package 570=head2 Variables in the C<urxvt> Package
522 571
523=over 4 572=over 4
524 573
671 unless $msg =~ /\n$/; 720 unless $msg =~ /\n$/;
672 urxvt::warn ($msg); 721 urxvt::warn ($msg);
673 }; 722 };
674} 723}
675 724
725no warnings 'utf8';
726
676my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 727my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
677 728
678sub verbose { 729sub verbose {
679 my ($level, $msg) = @_; 730 my ($level, $msg) = @_;
680 warn "$msg\n" if $level <= $verbosity; 731 warn "$msg\n" if $level <= $verbosity;
696 747
697 open my $fh, "<:raw", $path 748 open my $fh, "<:raw", $path
698 or die "$path: $!"; 749 or die "$path: $!";
699 750
700 my $source = 751 my $source =
701 "package $pkg; use strict; use utf8;\n" 752 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
702 . "#line 1 \"$path\"\n{\n" 753 . "#line 1 \"$path\"\n{\n"
703 . (do { local $/; <$fh> }) 754 . (do { local $/; <$fh> })
704 . "\n};\n1"; 755 . "\n};\n1";
705 756
706 eval $source 757 eval $source
731 $TERM->register_package ($_) for @pkg; 782 $TERM->register_package ($_) for @pkg;
732 } 783 }
733 784
734 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 785 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
735 if ($_ eq "default") { 786 if ($_ eq "default") {
736 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 787 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
737 } elsif (/^-(.*)$/) { 788 } elsif (/^-(.*)$/) {
738 delete $ext_arg{$1}; 789 delete $ext_arg{$1};
739 } elsif (/^([^<]+)<(.*)>$/) { 790 } elsif (/^([^<]+)<(.*)>$/) {
740 push @{ $ext_arg{$1} }, $2; 791 push @{ $ext_arg{$1} }, $2;
741 } else { 792 } else {
1238 1289
1239Normally its not a good idea to use this function, as programs might be 1290Normally its not a good idea to use this function, as programs might be
1240confused by changes in cursor position or scrolling. Its useful inside a 1291confused by changes in cursor position or scrolling. Its useful inside a
1241C<on_add_lines> hook, though. 1292C<on_add_lines> hook, though.
1242 1293
1294=item $term->scr_change_screen ($screen)
1295
1296Switch to given screen - 0 primary, 1 secondary.
1297
1243=item $term->cmd_parse ($octets) 1298=item $term->cmd_parse ($octets)
1244 1299
1245Similar to C<scr_add_lines>, but the argument must be in the 1300Similar to C<scr_add_lines>, but the argument must be in the
1246locale-specific encoding of the terminal and can contain command sequences 1301locale-specific encoding of the terminal and can contain command sequences
1247(escape codes) that will be interpreted. 1302(escape codes) that will be interpreted.
1256 1311
1257Replaces the event mask of the pty watcher by the given event mask. Can 1312Replaces the event mask of the pty watcher by the given event mask. Can
1258be used to suppress input and output handling to the pty/tty. See the 1313be used to suppress input and output handling to the pty/tty. See the
1259description of C<< urxvt::timer->events >>. Make sure to always restore 1314description of C<< urxvt::timer->events >>. Make sure to always restore
1260the previous value. 1315the previous value.
1316
1317=item $fd = $term->pty_fd
1318
1319Returns the master file descriptor for the pty in use, or C<-1> if no pty
1320is used.
1261 1321
1262=item $windowid = $term->parent 1322=item $windowid = $term->parent
1263 1323
1264Return the window id of the toplevel window. 1324Return the window id of the toplevel window.
1265 1325
1330=item $modifiermask = $term->ModNumLockMask 1390=item $modifiermask = $term->ModNumLockMask
1331 1391
1332Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1392Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1333AltGr), the meta key (often Alt) and the num lock key, if applicable. 1393AltGr), the meta key (often Alt) and the num lock key, if applicable.
1334 1394
1395=item $screen = $term->current_screen
1396
1397Returns the currently displayed screen (0 primary, 1 secondary).
1398
1399=item $cursor_is_hidden = $term->hidden_cursor
1400
1401Returns wether the cursor is currently hidden or not.
1402
1335=item $view_start = $term->view_start ([$newvalue]) 1403=item $view_start = $term->view_start ([$newvalue])
1336 1404
1337Returns the row number of the topmost displayed line. Maximum value is 1405Returns the row number of the topmost displayed line. Maximum value is
1338C<0>, which displays the normal terminal contents. Lower values scroll 1406C<0>, which displays the normal terminal contents. Lower values scroll
1339this many lines into the scrollback buffer. 1407this many lines into the scrollback buffer.
1358line, starting at column C<$start_col> (default C<0>), which is useful 1426line, starting at column C<$start_col> (default C<0>), which is useful
1359to replace only parts of a line. The font index in the rendition will 1427to replace only parts of a line. The font index in the rendition will
1360automatically be updated. 1428automatically be updated.
1361 1429
1362C<$text> is in a special encoding: tabs and wide characters that use more 1430C<$text> is in a special encoding: tabs and wide characters that use more
1363than one cell when displayed are padded with urxvt::NOCHAR characters 1431than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1364(C<chr 65535>). Characters with combining characters and other characters 1432characters. Characters with combining characters and other characters that
1365that do not fit into the normal tetx encoding will be replaced with 1433do not fit into the normal tetx encoding will be replaced with characters
1366characters in the private use area. 1434in the private use area.
1367 1435
1368You have to obey this encoding when changing text. The advantage is 1436You have to obey this encoding when changing text. The advantage is
1369that C<substr> and similar functions work on screen cells and not on 1437that C<substr> and similar functions work on screen cells and not on
1370characters. 1438characters.
1371 1439
1545=item $term->ungrab 1613=item $term->ungrab
1546 1614
1547Calls XUngrab for the most recent grab. Is called automatically on 1615Calls XUngrab for the most recent grab. Is called automatically on
1548evaluation errors, as it is better to lose the grab in the error case as 1616evaluation errors, as it is better to lose the grab in the error case as
1549the session. 1617the session.
1618
1619=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1620
1621=item $atom_name = $term->XGetAtomName ($atom)
1622
1623=item @atoms = $term->XListProperties ($window)
1624
1625=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1626
1627=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1628
1629=item $term->XDeleteProperty ($window, $property)
1630
1631=item $window = $term->DefaultRootWindow
1632
1633=item $term->XReparentWindow ($window, $parent, [$x, $y])
1634
1635=item $term->XMapWindow ($window)
1636
1637=item $term->XUnmapWindow ($window)
1638
1639=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1640
1641=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1642
1643=item $term->XChangeInput ($window, $add_events[, $del_events])
1644
1645Various X or X-related functions. The C<$term> object only serves as
1646the source of the display, otherwise those functions map more-or-less
1647directory onto the X functions of the same name.
1550 1648
1551=back 1649=back
1552 1650
1553=cut 1651=cut
1554 1652
1790 1888
1791Stop watching for events on the given filehandle. 1889Stop watching for events on the given filehandle.
1792 1890
1793=back 1891=back
1794 1892
1893=head2 The C<urxvt::iw> Class
1894
1895This class implements idle watchers, that get called automatically when
1896the process is idle. They should return as fast as possible, after doing
1897some useful work.
1898
1899=over 4
1900
1901=item $iw = new urxvt::iw
1902
1903Create a new idle watcher object in stopped state.
1904
1905=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
1906
1907Set the callback to be called when the watcher triggers.
1908
1909=item $timer = $timer->start
1910
1911Start the watcher.
1912
1913=item $timer = $timer->stop
1914
1915Stop the watcher.
1916
1917=back
1918
1919=head2 The C<urxvt::pw> Class
1920
1921This class implements process watchers. They create an event whenever a
1922process exits, after which they stop automatically.
1923
1924 my $pid = fork;
1925 ...
1926 $term->{pw} = urxvt::pw
1927 ->new
1928 ->start ($pid)
1929 ->cb (sub {
1930 my ($pw, $exit_status) = @_;
1931 ...
1932 });
1933
1934=over 4
1935
1936=item $pw = new urxvt::pw
1937
1938Create a new process watcher in stopped state.
1939
1940=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
1941
1942Set the callback to be called when the timer triggers.
1943
1944=item $pw = $timer->start ($pid)
1945
1946Tells the wqtcher to start watching for process C<$pid>.
1947
1948=item $pw = $pw->stop
1949
1950Stop the watcher.
1951
1952=back
1953
1795=head1 ENVIRONMENT 1954=head1 ENVIRONMENT
1796 1955
1797=head2 URXVT_PERL_VERBOSITY 1956=head2 URXVT_PERL_VERBOSITY
1798 1957
1799This variable controls the verbosity level of the perl extension. Higher 1958This variable controls the verbosity level of the perl extension. Higher

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines