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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.115 by root, Fri Jan 20 15:57:21 2006 UTC vs.
Revision 1.132 by root, Mon Feb 6 05:40:15 2006 UTC

 the match. For example, the followign 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 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 C<@{ $term->{selection_popup_hook} }>, that is called whenever the
 popup is displayed.
 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.
+=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 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.
 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 Shift-Left and
+Clicking a button will activate that tab. Pressing B<Shift-Left> and
-Shift-Right will switch to the tab left or right of the current one.
+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
 the URL as first argument.
+=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 leats 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 automove-background
 This is basically a one-line extension that dynamically changes the background pixmap offset
 to the window position, in effect creating the same effect as pseudo transparency with
 a custom pixmap. No scaling is supported in this mode. Exmaple:
 =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
 Called at the very end of initialisation of a new terminal, just before
 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
+Called whenever something tries to destroy terminal, when the terminal is
-yet. If this hook returns true, then destruction is skipped, but this is
+still fully functional (not for long, though).
-rarely a good idea.
 =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
 =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_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
 Called wheneever 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
 =item on_button_press $term, $event
 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.
 our $LIBDIR;
 our $RESNAME;
 our $RESCLASS;
 our $RXVTNAME;
+our $NOCHAR = chr 0xffff;
 =head2 Variables in the C<urxvt> Package
 =over 4
 =item $urxvt::LIBDIR
 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).
 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;
       open my $fh, "<:raw", $path
          or die "$path: $!";
       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
          $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 (/^([^<]+)<(.*)>$/) {
             push @{ $ext_arg{$1} }, $2;
          } else {
       # 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
 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 $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 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
 C<0>, which displays the normal terminal contents. Lower values scroll
 this many lines into the scrollback buffer.
 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 tetx 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.
 =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.
 =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->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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.115 by root, Fri Jan 20 15:57:21 2006 UTC vs. Revision 1.132 by root, Mon Feb 6 05:40:15 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.115 by root, Fri Jan 20 15:57:21 2006 UTC vs.
Revision 1.132 by root, Mon Feb 6 05:40:15 2006 UTC