[ViewVC] Diff of: cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.108 by root, Thu Jan 19 09:47:15 2006 UTC vs.
Revision 1.172 by root, Fri Oct 10 00:21:15 2008 UTC

    @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
 =head1 DESCRIPTION
-Everytime a terminal object gets created, extension scripts specified via
+Every time a terminal object gets created, extension scripts specified via
 the C<perl> resource are loaded and associated with it.
 Scripts are compiled in a 'use strict' and 'use utf8' environment, and
 thus must be encoded as UTF-8.
 Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
 scripts will be shared (but not enabled) for all terminals.
+You can disable the embedded perl interpreter by setting both "perl-ext"
+and "perl-ext-common" resources to the empty string.
 =head1 PREPACKAGED EXTENSIONS
 This section describes the extensions delivered with this release. You can
 find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
 You can activate them like this:
   @@RXVT_NAME@@ -pe <extensionname>
+Or by adding them to the resource for extensions loaded by default:
+  URxvt.perl-ext-common: default,selection-autotransform
 =over 4
 =item selection (enabled by default)
    URxvt.selection.pattern-1: perl-regex
    ...
 The index number (0, 1...) must not have any holes, and each regex must
 contain at least one pair of capturing parentheses, which will be used for
-the match. For example, the followign adds a regex that matches everything
+the match. For example, the following adds a regex that matches everything
 between two vertical bars:
    URxvt.selection.pattern-0: \\|([^|]+)\\|
+Another example: Programs I use often output "absolute path: " at the
+beginning of a line when they process multiple files. The following
+pattern matches the filename (note, there is a single space at the very
+end):
+   URxvt.selection.pattern-0: ^(/[^:]+):\
 You can look at the source of the selection extension to see more
 interesting uses, such as parsing a line from beginning to end.
 This extension also offers following bindable keyboard commands:
 =item option-popup (enabled by default)
 Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
 runtime.
+Other extensions can extend this popup menu by pushing a code reference
+onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
+popup is being displayed.
+Its sole argument is the popup menu, which can be modified.  It should
+either return nothing or a string, the initial boolean value and a code
+reference. The string will be used as button text and the code reference
+will be called when the toggle changes, with the new boolean value as
+first argument.
+The following will add an entry C<myoption> that changes
+C<< $self->{myoption} >>:
+   push @{ $self->{term}{option_popup_hook} }, sub {
+      ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
+   };
 =item selection-popup (enabled by default)
 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
+Other extensions can extend this popup menu by pushing a code reference
-C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.
+onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
+popup is being displayed.
-It's sole argument is the popup menu, which can be modified. The selection
+Its sole argument is the popup menu, which can be modified. The selection
-is in C<$_>, which can be used to decide wether to add something or not.
+is in C<$_>, which can be used to decide whether to add something or not.
 It should either return nothing or a string and a code reference. The
 string will be used as button text and the code reference will be called
 when the button gets activated and should transform C<$_>.
 The following will add an entry C<a to b> that transforms all C<a>s in
 the selection to C<b>s, but only if the selection currently contains any
 C<a>s:
-   push urxvt::ext::selection_popup::hook, sub {
+   push @{ $self->{term}{selection_popup_hook} }, sub {
-      /a/ ? ("a to be" => sub { s/a/b/g }
+      /a/ ? ("a to b" => sub { s/a/b/g }
           : ()
    };
 =item searchable-scrollback<hotkey> (enabled by default)
 search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
 search upwards/downwards in the scrollback buffer, C<End> jumps to the
 bottom. C<Escape> leaves search mode and returns to the point where search
 was started, while C<Enter> or C<Return> stay at the current position and
 additionally stores the first match in the current line into the primary
-selection.
+selection if the C<Shift> modifier is active.
+The regex defaults to "(?i)", resulting in a case-insensitive search. To
+get a case-sensitive search you can delete this prefix using C<BackSpace>
+or simply use an uppercase character which removes the "(?i)" prefix.
+See L<perlre> for more info about perl regular expression syntax.
+=item readline (enabled by default)
+A support package that tries to make editing with readline easier. At
+the moment, it reacts to clicking shift-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 (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 tty is in ICANON state.
+=item - the text cursor is visible.
+=item - the primary screen is currently being displayed.
+=item - the mouse is on the same (multi-row-) line as the text cursor.
+=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
 whenever a selection is made.
 The first line tells the selection code to treat the unchanging part of
 every error message as a selection pattern, and the second line transforms
 the message into vi commands to load the file.
-=item mark-urls
+=item tabbed
+This transforms the terminal into a tabbar with additional terminals, that
+is, it implements what is commonly referred 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<Shift-Left> and
+B<Shift-Right> will switch to the tab left or right of the current one,
+while B<Shift-Down> creates a new tab.
+The tabbar itself can be configured similarly to a normal terminal, but
+with a resource class of C<URxvt.tabbed>. In addition, it supports the
+following four resources (shown with defaults):
+   URxvt.tabbed.tabbar-fg: <colour-index, default 3>
+   URxvt.tabbed.tabbar-bg: <colour-index, default 0>
+   URxvt.tabbed.tab-fg:    <colour-index, default 0>
+   URxvt.tabbed.tab-bg:    <colour-index, default 1>
+See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
+indices.
+=item matcher
-Uses per-line display filtering (C<on_line_update>) to underline urls and
+Uses per-line display filtering (C<on_line_update>) to underline text
-make them clickable. When middle-clicked, the program specified in the
+matching a certain pattern and make it clickable. When clicked with the
-resource C<urlLauncher> (default C<x-www-browser>) will be started with
+mouse button specified in the C<matcher.button> resource (default 2, or
-the URL as first argument.
+middle), the program specified in the C<matcher.launcher> resource
+(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
+with the matched text as first argument.  The default configuration is
+suitable for matching URLs and launching a web browser, like the
+former "mark-urls" extension.
-=item automove-background
+The default pattern to match URLs can be overridden with the
+C<matcher.pattern.0> resource, and additional patterns can be specified
+with numbered patterns, in a manner similar to the "selection" extension.
+The launcher can also be overridden on a per-pattern basis.
-This is basically a one-line extension that dynamically changes the background pixmap offset
+It is possible to activate the most recently seen match from the keyboard.
-to the window position, in effect creating the same effect as pseudo transparency with
+Simply bind a keysym to "perl:matcher" as seen in the example below.
-a custom pixmap. No scaling is supported in this mode. Exmaple:
-   @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
+Example configuration:
+    URxvt.perl-ext:           default,matcher
+    URxvt.urlLauncher:        sensible-browser
+    URxvt.keysym.C-Delete:    perl:matcher
+    URxvt.matcher.button:     1
+    URxvt.matcher.pattern.1:  \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
+    URxvt.matcher.pattern.2:  \\B(/\\S+?):(\\d+)(?=:|$)
+    URxvt.matcher.launcher.2: gvim +$2 $1
+=item xim-onthespot
+This (experimental) perl extension implements OnTheSpot editing. It does
+not work perfectly, and some input methods don't seem to work well with
+OnTheSpot editing in general, but it seems to work at least for SCIM and
+kinput2.
+You enable it by specifying this extension and a preedit style of
+C<OnTheSpot>, i.e.:
+   @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
+=item kuake<hotkey>
+A very primitive quake-console-like extension. It was inspired by a
+description of how the programs C<kuake> and C<yakuake> work: Whenever the
+user presses a global accelerator key (by default C<F10>), the terminal
+will show or hide itself. Another press of the accelerator key will hide
+or show it again.
+Initially, the window will not be shown when using this extension.
+This is useful if you need a single terminal that is not using any desktop
+space most of the time but is quickly available at the press of a key.
+The accelerator key is grabbed regardless of any modifiers, so this
+extension will actually grab a physical key just for this function.
+If you want a quake-like animation, tell your window manager to do so
+(fvwm can do it).
 =item block-graphics-to-ascii
-A not very useful example of filtering all text output to the terminal,
+A not very useful example of filtering all text output to the terminal
 by replacing all line-drawing characters (U+2500 .. U+259F) by a
 similar-looking ascii character.
 =item digital-clock
 Displays a digital clock using the built-in overlay.
-=item example-refresh-hooks
+=item remote-clipboard
-Displays a very simple digital clock in the upper right corner of the
+Somewhat of a misnomer, this extension adds two menu entries to the
-window. Illustrates overwriting the refresh callbacks to create your own
+selection popup that allows one to run external commands to store the
-overlays or changes.
+selection somewhere and fetch it again.
+We use it to implement a "distributed selection mechanism", which just
+means that one command uploads the file to a remote server, and another
+reads it.
+The commands can be set using the C<URxvt.remote-selection.store> and
+C<URxvt.remote-selection.fetch> resources. The first should read the
+selection to store from STDIN (always in UTF-8), the second should provide
+the selection data on STDOUT (also in UTF-8).
+The defaults (which are likely useless to you) use rsh and cat:
+   URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
+   URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
 =item selection-pastebin
 This is a little rarely useful extension that Uploads the selection as
 textfile to a remote site (or does other things). (The implementation is
 After a successful upload the selection will be replaced by the text given
 in the C<selection-pastebin-url> resource (again, the % is the placeholder
 for the filename):
    URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
+I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
+the double C</> characters as comment start. Use C<\057\057> instead,
+which works regardless of wether xrdb is used to parse the resource file
+or not.
+=item example-refresh-hooks
+Displays a very simple digital clock in the upper right corner of the
+window. Illustrates overwriting the refresh callbacks to create your own
+overlays or changes.
 =back
 =head1 API DOCUMENTATION
 =back
 =head2 Extension Objects
-Very perl extension is a perl class. A separate perl object is created
+Every perl extension is a perl class. A separate perl object is created
-for each terminal and each extension and passed as the first parameter to
+for each terminal, and each terminal has its own set of extenion objects,
-hooks. So extensions can use their C<$self> object without having to think
+which are passed as the first parameter to hooks. So extensions can use
-about other extensions, with the exception of methods and members that
+their C<$self> object without having to think about clashes with other
+extensions or other terminals, with the exception of methods and members
-begin with an underscore character C<_>: these are reserved for internal
+that begin with an underscore character C<_>: these are reserved for
-use.
+internal use.
 Although it isn't a C<urxvt::term> object, you can call all methods of the
 C<urxvt::term> class on this object.
 It has the following methods and data members:
 =head2 Hooks
 The following subroutines can be declared in extension files, and will be
 called whenever the relevant event happens.
-The first argument passed to them is an extension oject as described in
+The first argument passed to them is an extension object as described in
 the in the C<Extension Objects> section.
-B<All> of these hooks must return a boolean value. If it is true, then the
+B<All> of these hooks must return a boolean value. If any of the called
-event counts as being I<consumed>, and the invocation of other hooks is
+hooks returns true, then the event counts as being I<consumed>, and the
-skipped, and the relevant action might not be carried out by the C++ code.
+relevant action might not be carried out by the C++ code.
 I<< When in doubt, return a false value (preferably C<()>). >>
 =over 4
 =item on_init $term
 Called after a new terminal object has been initialized, but before
 windows are created or the command gets run. Most methods are unsafe to
 call or deliver senseless data, as terminal size and other characteristics
-have not yet been determined. You can safely query and change resources,
+have not yet been determined. You can safely query and change resources
-though.
+and options, though. For many purposes the C<on_start> hook is a better
+place.
+=item on_start $term
+Called at the very end of initialisation of a new terminal, just before
+trying to map (display) the toplevel and returning to the main loop.
+=item on_destroy $term
+Called whenever something tries to destroy terminal, when the terminal is
+still fully functional (not for long, though).
 =item on_reset $term
 Called after the screen is "reset" for any reason, such as resizing or
 control sequences. Here is where you can react on changes to size-related
 variables.
-=item on_start $term
-Called at the very end of initialisation of a new terminal, just before
-returning to the mainloop.
 =item on_child_start $term, $pid
 Called just after the child process has been C<fork>ed.
 =item on_child_exit $term, $status
 Called whenever a selection has been copied, but before the selection is
 requested from the server.  The selection text can be queried and changed
 by calling C<< $term->selection >>.
-Returning a true value aborts selection grabbing. It will still be hilighted.
+Returning a true value aborts selection grabbing. It will still be highlighted.
 =item on_sel_extend $term
 Called whenever the user tries to extend the selection (e.g. with a double
 click) and is either supposed to return false (normal operation), or
-should extend the selection itelf and return true to suppress the built-in
+should extend the selection itself and return true to suppress the built-in
 processing. This can happen multiple times, as long as the callback
 returns true, it will be called on every further click by the user and is
 supposed to enlarge the selection more and more, if possible.
 See the F<selection> example extension.
 =item on_view_change $term, $offset
-Called whenever the view offset changes, i..e the user or program
+Called whenever the view offset changes, i.e. the user or program
 scrolls. Offset C<0> means display the normal terminal, positive values
 show this many lines of scrollback.
 =item on_scroll_back $term, $lines, $saved
 It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
 $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
 number of lines that will be in the scrollback buffer.
-=item on_osc_seq $term, $string
+=item on_osc_seq $term, $op, $args, $resp
+Called on every OSC sequence and can be used to suppress it or modify its
+behaviour. The default should be to return an empty list. A true value
+suppresses execution of the request completely. Make sure you don't get
+confused by recursive invocations when you output an OSC sequence within
+this callback.
+C<on_osc_seq_perl> should be used for new behaviour.
+=item on_osc_seq_perl $term, $args, $resp
 Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
 operating system command) is processed. Cursor position and other state
 information is up-to-date when this happens. For interoperability, the
-string should start with the extension name and a colon, to distinguish
+string should start with the extension name (sans -osc) and a semicolon,
-it from commands for other extensions, and this might be enforced in the
+to distinguish it from commands for other extensions, and this might be
-future.
+enforced in the future.
+For example, C<overlay-osc> uses this:
+   sub on_osc_seq_perl {
+      my ($self, $osc, $resp) = @_;
+      return unless $osc =~ s/^overlay;//;
+      ... process remaining $osc string
+   }
 Be careful not ever to trust (in a security sense) the data you receive,
-as its source can not easily be controleld (e-mail content, messages from
+as its source can not easily be controlled (e-mail content, messages from
 other users on the same system etc.).
+For responses, C<$resp> contains the end-of-args separator used by the
+sender.
 =item on_add_lines $term, $string
 Called whenever text is about to be output, with the text as argument. You
 can filter/change and output the text yourself by returning a true value
 later with the already-modified line (e.g. if unrelated parts change), so
 you cannot just toggle rendition bits, but only set them.
 =item on_refresh_begin $term
-Called just before the screen gets redrawn. Can be used for overlay
+Called just before the screen gets redrawn. Can be used for overlay or
-or similar effects by modify terminal contents in refresh_begin, and
+similar effects by modifying the terminal contents in refresh_begin, and
 restoring them in refresh_end. The built-in overlay and selection display
 code is run after this hook, and takes precedence.
 =item on_refresh_end $term
 Called just after the screen gets redrawn. See C<on_refresh_begin>.
-=item on_keyboard_command $term, $string
+=item on_user_command $term, $string
-Called whenever the user presses a key combination that has a
+Called whenever a user-configured event is being activated (e.g. via
-C<perl:string> action bound to it (see description of the B<keysym>
+a C<perl:string> action bound to a key, see description of the B<keysym>
 resource in the @@RXVT_NAME@@(1) manpage).
+The event is simply the action string. This interface is assumed to change
+slightly in the future.
+=item on_resize_all_windows $tern, $new_width, $new_height
+Called just after the new window size has been calculated, but before
+windows are actually being resized or hints are being set. If this hook
+returns TRUE, setting of the window hints is being skipped.
 =item on_x_event $term, $event
 Called on every X event received on the vt window (and possibly other
 windows). Should only be used as a last resort. Most event structure
 members are not passed.
+=item on_root_event $term, $event
+Like C<on_x_event>, but is called for events on the root window.
 =item on_focus_in $term
 Called whenever the window gets the keyboard focus, before rxvt-unicode
 does focus in processing.
 =item on_focus_out $term
-Called wheneever the window loses keyboard focus, before rxvt-unicode does
+Called whenever the window loses keyboard focus, before rxvt-unicode does
 focus out processing.
 =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
 Called whenever the corresponding X event is received for the terminal If
 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<row> and C<col>, which are the row
+manpage), with the additional members C<row> and C<col>, which are the
-and column under the mouse cursor.
+(real, not screen-based) row and column under the mouse cursor.
 C<on_key_press> 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
 use Scalar::Util ();
 use List::Util ();
 our $VERSION = 1;
 our $TERM;
+our @TERM_INIT;
+our @TERM_EXT;
 our @HOOKNAME;
 our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
 our %OPTION;
 our $LIBDIR;
 our $RESNAME;
 our $RESCLASS;
 our $RXVTNAME;
+our $NOCHAR = chr 0xffff;
 =head2 Variables in the C<urxvt> Package
 =over 4
 =item $urxvt::LIBDIR
 =item $urxvt::TERM
 The current terminal. This variable stores the current C<urxvt::term>
 object, whenever a callback/hook is executing.
+=item @urxvt::TERM_INIT
+All code references in this array will be called as methods of the next newly
+created C<urxvt::term> object (during the C<on_init> phase). The array
+gets cleared before the code references that were in it are being executed,
+so references can push themselves onto it again if they so desire.
+This complements to the perl-eval command line 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<urxvt> Package
 Using this function has the advantage that its output ends up in the
 correct place, e.g. on stderr of the connecting urxvtc client.
 Messages have a size limit of 1023 bytes currently.
+=item @terms = urxvt::termlist
+Returns all urxvt::term objects that exist in this process, regardless of
+whether they are started, being destroyed etc., so be careful. Only term
+objects that have perl extensions attached will be returned (because there
+is no urxvt::term objet associated with others).
 =item $time = urxvt::NOW
 Returns the "current time" (as per the event loop).
 Return the foreground/background colour index, respectively.
 =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
 =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
+=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
 Replace the foreground/background colour in the rendition mask with the
 specified one.
 =item $value = urxvt::GET_CUSTOM $rend
          unless $msg =~ /\n$/;
       urxvt::warn ($msg);
    };
 }
+no warnings 'utf8';
 my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
 sub verbose {
    my ($level, $msg) = @_;
    warn "$msg\n" if $level <= $verbosity;
 my %extension_pkg;
 # load a single script into its own package, once only
 sub extension_package($) {
    my ($path) = @_;
-   no strict 'refs';
    $extension_pkg{$path} ||= do {
       $path =~ /([^\/\\]+)$/;
       my $pkg = $1;
       $pkg =~ s/[^[:word:]]/_/g;
       verbose 3, "loading extension '$path' into package '$pkg'";
       open my $fh, "<:raw", $path
          or die "$path: $!";
-      @{"$pkg\::ISA"} = urxvt::term::extension::;
       my $source =
-         "package $pkg; use strict; use utf8;\n"
+         "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
          . "#line 1 \"$path\"\n{\n"
          . (do { local $/; <$fh> })
          . "\n};\n1";
       eval $source
    local $TERM = shift;
    my $htype = shift;
    if ($htype == 0) { # INIT
       my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
       my %ext_arg;
+      {
+         my @init = @TERM_INIT;
+         @TERM_INIT = ();
+         $_->($TERM) for @init;
+         my @pkg = @TERM_EXT;
+         @TERM_EXT = ();
+         $TERM->register_package ($_) for @pkg;
+      }
-      for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
+      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 (/^([^<]+)<(.*)>$/) {
             push @{ $ext_arg{$1} }, $2;
          } else {
             $ext_arg{$_} ||= [];
          }
       }
-      while (my ($ext, $argv) = each %ext_arg) {
+      for my $ext (sort keys %ext_arg) {
          my @files = grep -f $_, map "$_/$ext", @dirs;
          if (@files) {
-            $TERM->register_package (extension_package $files[0], $argv);
+            $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
          } else {
             warn "perl extension '$ext' not found in perl library search path\n";
          }
       }
    if (my $cb = $TERM->{_hook}[$htype]) {
       verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
          if $verbosity >= 10;
-      keys %$cb;
+      for my $pkg (keys %$cb) {
-      while (my ($pkg, $cb) = each %$cb) {
-         $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
+         my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
-            and last;
+         $retval ||= $retval_;
          if ($@) {
             $TERM->ungrab; # better to lose the grab than the session
             warn $@;
          }
       # clear package
       %$TERM = ();
    }
    $retval
+}
+sub SET_COLOR($$$) {
+   SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
+}
+sub rend2mask {
+   no strict 'refs';
+   my ($str, $mask) = (@_, 0);
+   my %color = ( fg => undef, bg => undef );
+   my @failed;
+   for my $spec ( split /\s+/, $str ) {
+      if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
+         $color{lc($1)} = $2;
+      } else {
+         my $neg = $spec =~ s/^[-^]//;
+         unless ( exists &{"RS_$spec"} ) {
+            push @failed, $spec;
+            next;
+         }
+         my $cur = &{"RS_$spec"};
+         if ( $neg ) {
+            $mask &= ~$cur;
+         } else {
+            $mask |= $cur;
+         }
+      }
+   }
+   ($mask, @color{qw(fg bg)}, \@failed)
 }
 # urxvt::term::extension
 package urxvt::term::extension;
 is that you cannot use blocking APIs, but the non-blocking variant should
 work.
 =cut
-our $VERSION = 1;
+our $VERSION = '3.4';
 $INC{"urxvt/anyevent.pm"} = 1; # mark us as there
 push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
 sub timer {
 sub DESTROY {
    $_[0][1]->stop;
 }
-sub condvar {
+sub one_event {
-   bless \my $flag, urxvt::anyevent::condvar::
-}
-sub urxvt::anyevent::condvar::broadcast {
-   ${$_[0]}++;
-}
-sub urxvt::anyevent::condvar::wait {
-   unless (${$_[0]}) {
-      Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
+   Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
-   }
 }
 package urxvt::term;
 =head2 The C<urxvt::term> Class
 # find on_xxx subs in the package and register them
 # as hooks
 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,
    }, $pkg;
 hash which defines the environment of the new terminal.
 Croaks (and probably outputs an error message) if the new instance
 couldn't be created.  Returns C<undef> if the new instance didn't
 initialise perl, and the terminal object otherwise. The C<init> and
-C<start> hooks will be called during this call.
+C<start> hooks will be called before this call returns, and are free to
+refer to global data (which is race free).
 =cut
 sub new {
    my ($class, $env, @args) = @_;
+   $env  or Carp::croak "environment hash missing in call to urxvt::term->new";
+   @args or Carp::croak "name argument missing in call to urxvt::term->new";
-   _new ([ map "$_=$env->{$_}", keys %$env ], @args);
+   _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
 }
 =item $term->destroy
 Destroy the terminal object (close the window, free resources
 Returns true if the option specified by C<$optval> is enabled, and
 optionally change it. All option values are stored by name in the hash
 C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
-Here is a a likely non-exhaustive list of option names, please see the
+Here is a likely non-exhaustive list of option names, please see the
 source file F</src/optinc.h> to see the actual list:
  borderLess console cursorBlink cursorUnderline hold iconic insecure
  intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
  override-redirect pastableTabs pointerBlank reverseVideo scrollBar
 likely change).
 Please note that resource strings will currently only be freed when the
 terminal is destroyed, so changing options frequently will eat memory.
-Here is a a likely non-exhaustive list of resource names, not all of which
+Here is a likely non-exhaustive list of resource names, not all of which
 are supported in every build, please see the source file F</src/rsinc.h>
 to see the actual list:
   answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
-  borderLess color cursorBlink cursorUnderline cutchars delete_key
+  borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
   display_name embed ext_bwidth fade font geometry hold iconName
   imFont imLocale inputMethod insecure int_bwidth intensityStyles
   italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
   mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
   perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
   preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
   scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
   scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
-  secondaryScreen secondaryScroll selectstyle shade term_name title
+  secondaryScreen secondaryScroll shade term_name title
   transient_for transparent transparent_all tripleclickwords utmpInhibit
   visualBell
 =cut
 sub resource($$;$) {
    my ($self, $name) = (shift, shift);
    unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
-   &urxvt::term::_resource
+   goto &urxvt::term::_resource
 }
 =item $value = $term->x_resource ($pattern)
 Returns the X-Resource for the given pattern, excluding the program or
 The methods currently supported on C<urxvt::overlay> objects are:
 =over 4
-=item $overlay->set ($x, $y, $text, $rend)
+=item $overlay->set ($x, $y, $text[, $rend])
 Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
 text in rxvt-unicode's special encoding and an array of rendition values
 at a specific position inside the overlay.
+If C<$rend> is missing, then the rendition will not be changed.
 =item $overlay->hide
 If visible, hide the overlay, but do not destroy it.
 Normally its not a good idea to use this function, as programs might be
 confused by changes in cursor position or scrolling. Its useful inside a
 C<on_add_lines> hook, though.
+=item $term->scr_change_screen ($screen)
+Switch to given screen - 0 primary, 1 secondary.
 =item $term->cmd_parse ($octets)
 Similar to C<scr_add_lines>, but the argument must be in the
 locale-specific encoding of the terminal and can contain command sequences
 (escape codes) that will be interpreted.
 Replaces the event mask of the pty watcher by the given event mask. Can
 be used to suppress input and output handling to the pty/tty. See the
 description of C<< urxvt::timer->events >>. Make sure to always restore
 the previous value.
+=item $fd = $term->pty_fd
+Returns the master file descriptor for the pty in use, or C<-1> if no pty
+is used.
 =item $windowid = $term->parent
 Return the window id of the toplevel window.
 =item $windowid = $term->vt
 Adds the specified events to the vt event mask. Useful e.g. when you want
 to receive pointer events all the times:
    $term->vt_emask_add (urxvt::PointerMotionMask);
+=item $term->focus_in
+=item $term->focus_out
+=item $term->key_press ($state, $keycode[, $time])
+=item $term->key_release ($state, $keycode[, $time])
+Deliver various fake events to to terminal.
 =item $window_width = $term->width
 =item $window_height = $term->height
 =item $font_width = $term->fwidth
 =item $env = $term->env
 Returns a copy of the environment in effect for the terminal as a hashref
 similar to C<\%ENV>.
+=item @envv = $term->envv
+Returns the environment as array of strings of the form C<VAR=VALUE>.
+=item @argv = $term->argv
+Return the argument vector as this terminal, similar to @ARGV, but
+includes the program name as first element.
 =cut
 sub env {
-   if (my $env = $_[0]->_env) {
-      +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
+   +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
-   } else {
-      +{ %ENV }
-   }
 }
 =item $modifiermask = $term->ModLevel3Mask
 =item $modifiermask = $term->ModMetaMask
 =item $modifiermask = $term->ModNumLockMask
 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 whether 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
 C<0>, which displays the normal terminal contents. Lower values scroll
 Used after changing terminal contents to display them.
 =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
-Returns the text of the entire row with number C<$row_number>. Row C<0>
+Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
-is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
+is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
-terminal line. The scrollback buffer starts at line C<-1> and extends to
-line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
+terminal line. Nothing will be returned if a nonexistent line
 is requested.
 If C<$new_text> is specified, it will replace characters in the current
 line, starting at column C<$start_col> (default C<0>), which is useful
 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
+than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
-(C<chr 65535>). Characters with combining characters and other characters
+characters. Characters with combining characters and other characters that
-that do not fit into the normal tetx encoding will be replaced with
+do not fit into the normal text encoding will be replaced with characters
-characters in the private use area.
+in the private use area.
 You have to obey this encoding when changing text. The advantage is
 that C<substr> and similar functions work on screen cells and not on
 characters.
 where one character corresponds to one screen cell. See
 C<< $term->ROW_t >> for details.
 =item $string = $term->special_decode $text
-Converts rxvt-unicodes text reprsentation into a perl string. See
+Converts rxvt-unicodes text representation into a perl string. See
 C<< $term->ROW_t >> for details.
-=item $success = $term->grab_button ($button, $modifiermask)
+=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
+=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
-Registers a synchronous button grab. See the XGrabButton manpage.
+Register/unregister a synchronous button grab. See the XGrabButton
+manpage.
 =item $success = $term->grab ($eventtime[, $sync])
 Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
-synchronous (C<$sync> is true). Also remembers the grab timestampe.
+synchronous (C<$sync> is true). Also remembers the grab timestamp.
 =item $term->allow_events_async
 Calls XAllowEvents with AsyncBoth for the most recent grab.
 =item $term->ungrab
 Calls XUngrab for the most recent grab. Is called automatically on
 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->XChangeProperty ($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
    my ($self, $text, $cb) = @_;
    $self->add_item ({ type => "button", text => $text, activate => $cb});
 }
-=item $popup->add_toggle ($text, $cb, $initial_value)
+=item $popup->add_toggle ($text, $initial_value, $cb)
-Adds a toggle/checkbox item to the popup. Teh callback gets called
+Adds a toggle/checkbox item to the popup. The callback gets called
-whenever it gets toggled, with a boolean indicating its value as its first
+whenever it gets toggled, with a boolean indicating its new value as its
-argument.
+first argument.
 =cut
 sub add_toggle {
-   my ($self, $text, $cb, $value) = @_;
+   my ($self, $text, $value, $cb) = @_;
    my $item; $item = {
       type => "button",
       text => "  $text",
       value => $value,
    my $env = $self->{term}->env;
    # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
    delete $env->{LC_ALL};
    $env->{LC_CTYPE} = $self->{term}->locale;
-   urxvt::term->new ($env, "popup",
+   my $term = urxvt::term->new (
+      $env, "popup",
-                     "--perl-lib" => "", "--perl-ext-common" => "",
+      "--perl-lib" => "", "--perl-ext-common" => "",
-                     "-pty-fd" => -1, "-sl" => 0,
+      "-pty-fd" => -1, "-sl" => 0,
-                     "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
+      "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
-                     "--transient-for" => $self->{term}->parent,
+      "--transient-for" => $self->{term}->parent,
-                     "-display" => $self->{term}->display_id,
+      "-display" => $self->{term}->display_id,
-                     "-pe" => "urxvt-popup")
+      "-pe" => "urxvt-popup",
-      or die "unable to create popup window\n";
+   ) or die "unable to create popup window\n";
+   unless (delete $term->{urxvt_popup_init_done}) {
+      $term->ungrab;
+      $term->destroy;
+      die "unable to initialise popup window\n";
+   }
 }
 sub DESTROY {
    my ($self) = @_;
    delete $self->{term}{_destroy}{$self};
    $self->{term}->ungrab;
 }
 =back
+=cut
+package urxvt::watcher;
 =head2 The C<urxvt::timer> Class
 This class implements timer watchers/events. Time is represented as a
 fractional number of seconds since the epoch. Example:
                     ->new
                     ->interval (1)
                     ->cb (sub {
                        $term->{overlay}->set (0, 0,
                           sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
                     });
 =over 4
 =item $timer = new urxvt::timer
   $term->{socket} = ...
   $term->{iow} = urxvt::iow
                  ->new
                  ->fd (fileno $term->{socket})
-                 ->events (urxvt::EVENT_READ)
+                 ->events (urxvt::EV_READ)
                  ->start
                  ->cb (sub {
                    my ($iow, $revents) = @_;
                    # $revents must be 1 here, no need to check
                    sysread $term->{socket}, my $buf, 8192
 Set the callback to be called when io events are triggered. C<$reventmask>
 is a bitset as described in the C<events> method.
 =item $iow = $iow->fd ($fd)
-Set the filedescriptor (not handle) to watch.
+Set the file descriptor (not handle) to watch.
 =item $iow = $iow->events ($eventmask)
 Set the event mask to watch. The only allowed values are
-C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
+C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
-together, or C<urxvt::EVENT_NONE>.
+together, or C<urxvt::EV_NONE>.
 =item $iow = $iow->start
 Start watching for requested events on the given handle.
 =item $iow = $iow->stop
-Stop watching for events on the given filehandle.
+Stop watching for events on the given file handle.
+=back
+=head2 The C<urxvt::iw> 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<urxvt::pw> 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 watcher to start watching for process C<$pid>.
+=item $pw = $pw->stop
+Stop the watcher.
 =back
 =head1 ENVIRONMENT
 =item >= 3 - script loading and management
 =item >=10 - all called hooks
-=item >=11 - hook reutrn values
+=item >=11 - hook return values
 =back
 =head1 AUTHOR
  http://software.schmorp.de/pkg/rxvt-unicode
 =cut
 1
+# vim: sw=3:

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.108 by root, Thu Jan 19 09:47:15 2006 UTC vs. Revision 1.172 by root, Fri Oct 10 00:21:15 2008 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.108 by root, Thu Jan 19 09:47:15 2006 UTC vs.
Revision 1.172 by root, Fri Oct 10 00:21:15 2008 UTC