--- rxvt-unicode/src/urxvt.pm 2006/01/19 21:02:06 1.112 +++ rxvt-unicode/src/urxvt.pm 2006/01/21 14:49:18 1.123 @@ -93,7 +93,7 @@ Binds a popup menu to Ctrl-Button3 that lets you convert the selection text into various other formats/action (such as uri unescaping, perl -evalution, web-browser starting etc.), depending on content. +evaluation, web-browser starting etc.), depending on content. Other extensions can extend this popup menu by pushing a code reference onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the @@ -129,6 +129,29 @@ additionally stores the first match in the current line into the primary selection. +=item readline (enabled by default) + +A support package that tries to make editing with readline easier. At the +moment, it reacts to clicking with the left mouse button by trying to +move the text cursor to this position. It does so by generating as many +cursor-left or cursor-right keypresses as required (the this only works +for programs that correctly support wide characters). + +To avoid too many false positives, this is only done when: + +=over 4 + +=item - the mouse is on the same (multi-row-) line as the text cursor. + +=item - the primary screen is currently being displayed. + +=item - the text cursor is visible. + +=back + +The normal selection mechanism isn't disabled, so quick successive clicks +might interfere with selection creation in harmless ways. + =item selection-autotransform This selection allows you to do automatic transforms on a selection @@ -164,6 +187,17 @@ every error message as a selection pattern, and the second line transforms the message into vi commands to load the file. +=item tabbed + +This transforms the terminal into a tabbar with additional terminals, that +is, it implements what is commonly refered to as "tabbed terminal". The topmost line +displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one +button per tab. + +Clicking a button will activate that tab. Pressing B and +B will switch to the tab left or right of the current one, +while B creates a new tab. + =item mark-urls Uses per-line display filtering (C) to underline urls and @@ -325,7 +359,13 @@ =item on_start $term Called at the very end of initialisation of a new terminal, just before -returning to the mainloop. +trying to map (display) the toplevel and returning to the mainloop. + +=item on_destroy $term + +Called whenever something tries to destroy terminal, before doing anything +yet. If this hook returns true, then destruction is skipped, but this is +rarely a good idea. =item on_reset $term @@ -461,6 +501,8 @@ =item on_configure_notify $term, $event +=item on_property_notify $term, $event + =item on_key_press $term, $event, $keysym, $octets =item on_key_release $term, $event, $keysym @@ -479,14 +521,23 @@ the hook returns true, then the even will be ignored by rxvt-unicode. The event is a hash with most values as named by Xlib (see the XEvent -manpage), with the additional members C and C, which are the row -and column under the mouse cursor. +manpage), with the additional members C and C, which are the +(real, not screen-based) row and column under the mouse cursor. C additionally receives the string rxvt-unicode would output, if any, in locale-specific encoding. subwindow. +=item on_client_message $term, $event + +=item on_wm_protocols $term, $event + +=item on_wm_delete_window $term, $event + +Called when various types of ClientMessage events are received (all with +format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). + =back =cut @@ -501,6 +552,8 @@ our $VERSION = 1; our $TERM; +our @TERM_INIT; +our @TERM_EXT; our @HOOKNAME; our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; our %OPTION; @@ -510,6 +563,8 @@ our $RESCLASS; our $RXVTNAME; +our $NOCHAR = chr 0xfffe; + =head2 Variables in the C Package =over 4 @@ -532,6 +587,22 @@ The current terminal. This variable stores the current C object, whenever a callback/hook is executing. +=item @urxvt::TERM_INIT + +All coderefs in this array will be called as methods of the next newly +created C object (during the C phase). The array +gets cleared before the codereferences that were in it are being executed, +so coderefs can push themselves onto it again if they so desire. + +This complements to the perl-eval commandline option, but gets executed +first. + +=item @urxvt::TERM_EXT + +Works similar to C<@TERM_INIT>, but contains perl package/class names, which +get registered as normal extensions after calling the hooks in C<@TERM_INIT> +but before other extensions. Gets cleared just like C<@TERM_INIT>. + =back =head2 Functions in the C Package @@ -662,8 +733,6 @@ sub extension_package($) { my ($path) = @_; - no strict 'refs'; - $extension_pkg{$path} ||= do { $path =~ /([^\/\\]+)$/; my $pkg = $1; @@ -675,8 +744,6 @@ open my $fh, "<:raw", $path or die "$path: $!"; - @{"$pkg\::ISA"} = urxvt::term::extension::; - my $source = "package $pkg; use strict; use utf8;\n" . "#line 1 \"$path\"\n{\n" @@ -702,9 +769,18 @@ my %ext_arg; - for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { + { + my @init = @TERM_INIT; + @TERM_INIT = (); + $_->($TERM) for @init; + my @pkg = @TERM_EXT; + @TERM_EXT = (); + $TERM->register_package ($_) for @pkg; + } + + for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { if ($_ eq "default") { - $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); + $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); } elsif (/^-(.*)$/) { delete $ext_arg{$1}; } elsif (/^([^<]+)<(.*)>$/) { @@ -737,7 +813,8 @@ keys %$cb; while (my ($pkg, $cb) = each %$cb) { - $retval ||= eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; + my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; + $retval ||= $retval_; if ($@) { $TERM->ungrab; # better to lose the grab than the session @@ -906,6 +983,12 @@ sub register_package { my ($self, $pkg, $argv) = @_; + no strict 'refs'; + + urxvt::verbose 6, "register package $pkg to $self"; + + @{"$pkg\::ISA"} = urxvt::term::extension::; + my $proxy = bless { _pkg => $pkg, argv => $argv, @@ -1204,6 +1287,10 @@ confused by changes in cursor position or scrolling. Its useful inside a C hook, though. +=item $term->scr_change_screen ($screen) + +Switch to given screen - 0 primary, 1 secondary. + =item $term->cmd_parse ($octets) Similar to C, but the argument must be in the @@ -1296,6 +1383,14 @@ Return the modifier masks corresponding to the "ISO Level 3 Shift" (often AltGr), the meta key (often Alt) and the num lock key, if applicable. +=item $screen = $term->current_screen + +Returns the currently displayed screen (0 primary, 1 secondary). + +=item $cursor_is_hidden = $term->hidden_cursor + +Returns wether the cursor is currently hidden or not. + =item $view_start = $term->view_start ([$newvalue]) Returns the row number of the topmost displayed line. Maximum value is @@ -1323,11 +1418,11 @@ to replace only parts of a line. The font index in the rendition will automatically be updated. -C<$text> is in a special encoding: tabs and wide characters that use more -than one cell when displayed are padded with urxvt::NOCHAR characters -(C). Characters with combining characters and other characters -that do not fit into the normal tetx encoding will be replaced with -characters in the private use area. +C<$text> is in a special encoding: tabs and wide characters that use +more than one cell when displayed are padded with C<$urxvt::NOCHAR> +characters. Characters with combining characters and other characters that +do not fit into the normal tetx encoding will be replaced with characters +in the private use area. You have to obey this encoding when changing text. The advantage is that C and similar functions work on screen cells and not on @@ -1512,6 +1607,36 @@ evaluation errors, as it is better to lose the grab in the error case as the session. +=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) + +=item $atom_name = $term->XGetAtomName ($atom) + +=item @atoms = $term->XListProperties ($window) + +=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) + +=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) + +=item $term->XDeleteProperty ($window, $property) + +=item $window = $term->DefaultRootWindow + +=item $term->XReparentWindow ($window, $parent, [$x, $y]) + +=item $term->XMapWindow ($window) + +=item $term->XUnmapWindow ($window) + +=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) + +=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) + +=item $term->XChangeInput ($window, $add_events[, $del_events]) + +Various X or X-related functions. The C<$term> object only serves as +the source of the display, otherwise those functions map more-or-less +directory onto the X functions of the same name. + =back =cut @@ -1641,6 +1766,15 @@ =back +=cut + +package urxvt::watcher; + +@urxvt::timer::ISA = __PACKAGE__; +@urxvt::iow::ISA = __PACKAGE__; +@urxvt::pw::ISA = __PACKAGE__; +@urxvt::iw::ISA = __PACKAGE__; + =head2 The C Class This class implements timer watchers/events. Time is represented as a @@ -1747,6 +1881,67 @@ =back +=head2 The C Class + +This class implements idle watchers, that get called automatically when +the process is idle. They should return as fast as possible, after doing +some useful work. + +=over 4 + +=item $iw = new urxvt::iw + +Create a new idle watcher object in stopped state. + +=item $iw = $iw->cb (sub { my ($iw) = @_; ... }) + +Set the callback to be called when the watcher triggers. + +=item $timer = $timer->start + +Start the watcher. + +=item $timer = $timer->stop + +Stop the watcher. + +=back + +=head2 The C Class + +This class implements process watchers. They create an event whenever a +process exits, after which they stop automatically. + + my $pid = fork; + ... + $term->{pw} = urxvt::pw + ->new + ->start ($pid) + ->cb (sub { + my ($pw, $exit_status) = @_; + ... + }); + +=over 4 + +=item $pw = new urxvt::pw + +Create a new process watcher in stopped state. + +=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) + +Set the callback to be called when the timer triggers. + +=item $pw = $timer->start ($pid) + +Tells the wqtcher to start watching for process C<$pid>. + +=item $pw = $pw->stop + +Stop the watcher. + +=back + =head1 ENVIRONMENT =head2 URXVT_PERL_VERBOSITY