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.127 by root, Wed Jan 25 00:42:21 2006 UTC

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 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: ^(/[^:]+):\
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:
76 83
91 98
92=item selection-popup (enabled by default) 99=item selection-popup (enabled by default)
93 100
94Binds a popup menu to Ctrl-Button3 that lets you convert the selection 101Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95text into various other formats/action (such as uri unescaping, perl 102text into various other formats/action (such as uri unescaping, perl
96evalution, web-browser starting etc.), depending on content. 103evaluation, web-browser starting etc.), depending on content.
97 104
98Other extensions can extend this popup menu by pushing a code reference 105Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the 106onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100popup is displayed. 107popup is displayed.
101 108
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
161 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ 193 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162 194
163The first line tells the selection code to treat the unchanging part of 195The first line tells the selection code to treat the unchanging part of
164every error message as a selection pattern, and the second line transforms 196every error message as a selection pattern, and the second line transforms
165the message into vi commands to load the file. 197the message into vi commands to load the file.
198
199=item tabbed
200
201This transforms the terminal into a tabbar with additional terminals, that
202is, it implements what is commonly refered to as "tabbed terminal". The topmost line
203displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
204button per tab.
205
206Clicking a button will activate that tab. Pressing B<Shift-Left> and
207B<Shift-Right> will switch to the tab left or right of the current one,
208while B<Shift-Down> creates a new tab.
166 209
167=item mark-urls 210=item mark-urls
168 211
169Uses 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
170make them clickable. When middle-clicked, the program specified in the 213make them clickable. When middle-clicked, the program specified in the
327Called 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
328trying to map (display) the toplevel and returning to the mainloop. 371trying to map (display) the toplevel and returning to the mainloop.
329 372
330=item on_destroy $term 373=item on_destroy $term
331 374
332Called whenever something tries to destroy terminal, before doing anything 375Called whenever something tries to destroy terminal, when the terminal is
333yet. If this hook returns true, then destruction is skipped, but this is 376still fully functional (not for long, though).
334rarely a good idea.
335 377
336=item on_reset $term 378=item on_reset $term
337 379
338Called 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
339control 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
465Called wheneever the window loses keyboard focus, before rxvt-unicode does 507Called wheneever the window loses keyboard focus, before rxvt-unicode does
466focus out processing. 508focus out processing.
467 509
468=item on_configure_notify $term, $event 510=item on_configure_notify $term, $event
469 511
512=item on_property_notify $term, $event
513
470=item on_key_press $term, $event, $keysym, $octets 514=item on_key_press $term, $event, $keysym, $octets
471 515
472=item on_key_release $term, $event, $keysym 516=item on_key_release $term, $event, $keysym
473 517
474=item on_button_press $term, $event 518=item on_button_press $term, $event
483 527
484Called whenever the corresponding X event is received for the terminal If 528Called whenever the corresponding X event is received for the terminal If
485the hook returns true, then the even will be ignored by rxvt-unicode. 529the hook returns true, then the even will be ignored by rxvt-unicode.
486 530
487The event is a hash with most values as named by Xlib (see the XEvent 531The 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 532manpage), with the additional members C<row> and C<col>, which are the
489and column under the mouse cursor. 533(real, not screen-based) row and column under the mouse cursor.
490 534
491C<on_key_press> additionally receives the string rxvt-unicode would 535C<on_key_press> additionally receives the string rxvt-unicode would
492output, if any, in locale-specific encoding. 536output, if any, in locale-specific encoding.
493 537
494subwindow. 538subwindow.
539
540=item on_client_message $term, $event
541
542=item on_wm_protocols $term, $event
543
544=item on_wm_delete_window $term, $event
545
546Called when various types of ClientMessage events are received (all with
547format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
495 548
496=back 549=back
497 550
498=cut 551=cut
499 552
515 568
516our $LIBDIR; 569our $LIBDIR;
517our $RESNAME; 570our $RESNAME;
518our $RESCLASS; 571our $RESCLASS;
519our $RXVTNAME; 572our $RXVTNAME;
573
574our $NOCHAR = chr 0xffff;
520 575
521=head2 Variables in the C<urxvt> Package 576=head2 Variables in the C<urxvt> Package
522 577
523=over 4 578=over 4
524 579
671 unless $msg =~ /\n$/; 726 unless $msg =~ /\n$/;
672 urxvt::warn ($msg); 727 urxvt::warn ($msg);
673 }; 728 };
674} 729}
675 730
731no warnings 'utf8';
732
676my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 733my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
677 734
678sub verbose { 735sub verbose {
679 my ($level, $msg) = @_; 736 my ($level, $msg) = @_;
680 warn "$msg\n" if $level <= $verbosity; 737 warn "$msg\n" if $level <= $verbosity;
696 753
697 open my $fh, "<:raw", $path 754 open my $fh, "<:raw", $path
698 or die "$path: $!"; 755 or die "$path: $!";
699 756
700 my $source = 757 my $source =
701 "package $pkg; use strict; use utf8;\n" 758 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
702 . "#line 1 \"$path\"\n{\n" 759 . "#line 1 \"$path\"\n{\n"
703 . (do { local $/; <$fh> }) 760 . (do { local $/; <$fh> })
704 . "\n};\n1"; 761 . "\n};\n1";
705 762
706 eval $source 763 eval $source
731 $TERM->register_package ($_) for @pkg; 788 $TERM->register_package ($_) for @pkg;
732 } 789 }
733 790
734 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 791 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
735 if ($_ eq "default") { 792 if ($_ eq "default") {
736 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 793 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
737 } elsif (/^-(.*)$/) { 794 } elsif (/^-(.*)$/) {
738 delete $ext_arg{$1}; 795 delete $ext_arg{$1};
739 } elsif (/^([^<]+)<(.*)>$/) { 796 } elsif (/^([^<]+)<(.*)>$/) {
740 push @{ $ext_arg{$1} }, $2; 797 push @{ $ext_arg{$1} }, $2;
741 } else { 798 } else {
1238 1295
1239Normally 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
1240confused by changes in cursor position or scrolling. Its useful inside a 1297confused by changes in cursor position or scrolling. Its useful inside a
1241C<on_add_lines> hook, though. 1298C<on_add_lines> hook, though.
1242 1299
1300=item $term->scr_change_screen ($screen)
1301
1302Switch to given screen - 0 primary, 1 secondary.
1303
1243=item $term->cmd_parse ($octets) 1304=item $term->cmd_parse ($octets)
1244 1305
1245Similar 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
1246locale-specific encoding of the terminal and can contain command sequences 1307locale-specific encoding of the terminal and can contain command sequences
1247(escape codes) that will be interpreted. 1308(escape codes) that will be interpreted.
1256 1317
1257Replaces 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
1258be 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
1259description of C<< urxvt::timer->events >>. Make sure to always restore 1320description of C<< urxvt::timer->events >>. Make sure to always restore
1260the 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.
1261 1327
1262=item $windowid = $term->parent 1328=item $windowid = $term->parent
1263 1329
1264Return the window id of the toplevel window. 1330Return the window id of the toplevel window.
1265 1331
1330=item $modifiermask = $term->ModNumLockMask 1396=item $modifiermask = $term->ModNumLockMask
1331 1397
1332Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1398Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1333AltGr), 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.
1334 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
1335=item $view_start = $term->view_start ([$newvalue]) 1409=item $view_start = $term->view_start ([$newvalue])
1336 1410
1337Returns the row number of the topmost displayed line. Maximum value is 1411Returns the row number of the topmost displayed line. Maximum value is
1338C<0>, which displays the normal terminal contents. Lower values scroll 1412C<0>, which displays the normal terminal contents. Lower values scroll
1339this many lines into the scrollback buffer. 1413this many lines into the scrollback buffer.
1358line, 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
1359to 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
1360automatically be updated. 1434automatically be updated.
1361 1435
1362C<$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
1363than one cell when displayed are padded with urxvt::NOCHAR characters 1437than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1364(C<chr 65535>). Characters with combining characters and other characters 1438characters. Characters with combining characters and other characters that
1365that 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
1366characters in the private use area. 1440in the private use area.
1367 1441
1368You have to obey this encoding when changing text. The advantage is 1442You have to obey this encoding when changing text. The advantage is
1369that 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
1370characters. 1444characters.
1371 1445
1545=item $term->ungrab 1619=item $term->ungrab
1546 1620
1547Calls XUngrab for the most recent grab. Is called automatically on 1621Calls 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 1622evaluation errors, as it is better to lose the grab in the error case as
1549the session. 1623the session.
1624
1625=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1626
1627=item $atom_name = $term->XGetAtomName ($atom)
1628
1629=item @atoms = $term->XListProperties ($window)
1630
1631=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1632
1633=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1634
1635=item $term->XDeleteProperty ($window, $property)
1636
1637=item $window = $term->DefaultRootWindow
1638
1639=item $term->XReparentWindow ($window, $parent, [$x, $y])
1640
1641=item $term->XMapWindow ($window)
1642
1643=item $term->XUnmapWindow ($window)
1644
1645=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1646
1647=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1648
1649=item $term->XChangeInput ($window, $add_events[, $del_events])
1650
1651Various X or X-related functions. The C<$term> object only serves as
1652the source of the display, otherwise those functions map more-or-less
1653directory onto the X functions of the same name.
1550 1654
1551=back 1655=back
1552 1656
1553=cut 1657=cut
1554 1658
1790 1894
1791Stop watching for events on the given filehandle. 1895Stop watching for events on the given filehandle.
1792 1896
1793=back 1897=back
1794 1898
1899=head2 The C<urxvt::iw> Class
1900
1901This class implements idle watchers, that get called automatically when
1902the process is idle. They should return as fast as possible, after doing
1903some useful work.
1904
1905=over 4
1906
1907=item $iw = new urxvt::iw
1908
1909Create a new idle watcher object in stopped state.
1910
1911=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
1912
1913Set the callback to be called when the watcher triggers.
1914
1915=item $timer = $timer->start
1916
1917Start the watcher.
1918
1919=item $timer = $timer->stop
1920
1921Stop the watcher.
1922
1923=back
1924
1925=head2 The C<urxvt::pw> Class
1926
1927This class implements process watchers. They create an event whenever a
1928process exits, after which they stop automatically.
1929
1930 my $pid = fork;
1931 ...
1932 $term->{pw} = urxvt::pw
1933 ->new
1934 ->start ($pid)
1935 ->cb (sub {
1936 my ($pw, $exit_status) = @_;
1937 ...
1938 });
1939
1940=over 4
1941
1942=item $pw = new urxvt::pw
1943
1944Create a new process watcher in stopped state.
1945
1946=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
1947
1948Set the callback to be called when the timer triggers.
1949
1950=item $pw = $timer->start ($pid)
1951
1952Tells the wqtcher to start watching for process C<$pid>.
1953
1954=item $pw = $pw->stop
1955
1956Stop the watcher.
1957
1958=back
1959
1795=head1 ENVIRONMENT 1960=head1 ENVIRONMENT
1796 1961
1797=head2 URXVT_PERL_VERBOSITY 1962=head2 URXVT_PERL_VERBOSITY
1798 1963
1799This variable controls the verbosity level of the perl extension. Higher 1964This variable controls the verbosity level of the perl extension. Higher

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines