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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.128 by root, Wed Jan 25 00:57:57 2006 UTC vs.
Revision 1.139 by root, Sat Jul 1 19:04:43 2006 UTC

 =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.
+It's 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
 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
+onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
-popup is displayed.
+popup is being displayed.
 It's 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.
 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
 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
+A support package that tries to make editing with readline easier. At
-moment, it reacts to clicking with the left mouse button by trying to
+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 (the this only works
 for programs that correctly support wide characters).
 To avoid too many false positives, this is only done when:
 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 mark-urls
 Uses per-line display filtering (C<on_line_update>) to underline urls and
 make them clickable. When middle-clicked, the program specified in the
 resource C<urlLauncher> (default C<x-www-browser>) will be started with
 =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 ti 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/%
+=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
 hooks. So extensions can use their C<$self> object without having to think
 about other extensions, with the exception of methods and members that
 begin with an underscore character C<_>: these are reserved for internal
 use.
 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, $op, $args
+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 $term, $string
+=item on_osc_seq_perl $term, $string
 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
 =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 the 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 calculcated, 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
 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
+wether 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).
 =item urxvt::CurrentTime
 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
          } 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) {
-         my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
+         my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
          $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])
 }
 # urxvt::term::extension
 package urxvt::term::extension;
 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
 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 $string = $term->special_decode $text
 Converts rxvt-unicodes text reprsentation 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.
    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,

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.128 by root, Wed Jan 25 00:57:57 2006 UTC vs. Revision 1.139 by root, Sat Jul 1 19:04:43 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.128 by root, Wed Jan 25 00:57:57 2006 UTC vs.
Revision 1.139 by root, Sat Jul 1 19:04:43 2006 UTC