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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.182 by sf-exg, Wed Feb 17 08:27:56 2010 UTC vs.
Revision 1.205 by root, Tue Jun 5 19:32:29 2012 UTC

 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.
-It is possible to activate the most recently seen match from the keyboard.
+It is possible to activate the most recently seen match or a list of matches
+from the keyboard.  Simply bind a keysym to "perl:matcher:last" or
-Simply bind a keysym to "perl:matcher" as seen in the example below.
+"perl:matcher:list" as seen in the example below.
 Example configuration:
     URxvt.perl-ext:           default,matcher
     URxvt.urlLauncher:        sensible-browser
-    URxvt.keysym.C-Delete:    perl:matcher
+    URxvt.keysym.C-Delete:    perl:matcher:last
+    URxvt.keysym.M-Delete:    perl:matcher:list
     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
    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
+which works regardless of whether xrdb is used to parse the resource file
 or not.
 =item macosx-clipboard and macosx-clipboard-native
 These two modules implement an extended clipboard for Mac OS X. They are
 =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.
+=item confirm-paste
+Displays a confirmation dialog when a paste containing at least a full
+line is detected.
+=item bell-command
+Runs the command specified by the C<URxvt.bell-command> resource when
+a bell event occurs. For example, the following pops up a notification
+bubble with the text "Beep, Beep" using notify-send:
+   URxvt.bell-command: notify-send "Beep, Beep"
 =back
 =head1 API DOCUMENTATION
 =item $octets
 Either binary data or - more common - a text string encoded in a
 locale-specific way.
+=item $keysym
+an integer that is a valid X11 keysym code. You can convert a string
+into a keysym and viceversa by using C<XStringToKeysym> and
+C<XKeysymToString>.
 =back
 =head2 Extension Objects
 Every perl extension is a perl class. A separate perl object is created
-for each terminal, and each terminal has its own set of extenion objects,
+for each terminal, and each terminal has its own set of extension objects,
 which are passed as the first parameter to hooks. So extensions can use
 their C<$self> object without having to think about clashes with other
 extensions or other terminals, with the exception of methods and members
 that begin with an underscore character C<_>: these are reserved for
 internal use.
 =item on_tt_write $term, $octets
 Called whenever some data is written to the tty/pty and can be used to
 suppress or filter tty input.
+=item on_tt_paste $term, $octets
+Called whenever text is about to be pasted, with the text as argument. You
+can filter/change and paste the text yourself by returning a true value
+and calling C<< $term->tt_paste >> yourself. C<$octets> is
+locale-encoded.
 =item on_line_update $term, $row
 Called whenever a line was updated or changed. Can be used to filter
 screen output (e.g. underline urls or other useless stuff). Only lines
 that are being shown will be filtered, and, due to performance reasons,
 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_register_command $term, $keysym, $modifiermask, $string
+Called after parsing a keysym resource but before registering the
+associated binding. If this hook returns TRUE the binding is not
+registered. It can be used to modify a binding by calling
+C<register_command>.
-=item on_resize_all_windows $tern, $new_width, $new_height
+=item on_resize_all_windows $term, $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.
 =over 4
 =item urxvt::fatal $errormessage
-Fatally aborts execution with the given error message. Avoid at all
+Fatally aborts execution with the given error message (which should
-costs! The only time this is acceptable is when the terminal process
+include a trailing newline). Avoid at all costs! The only time this
-starts up.
+is acceptable (and useful) is in the init hook, where it prevents the
+terminal from starting up.
 =item urxvt::warn $string
-Calls C<rxvt_warn> with the given string which should not include a
+Calls C<rxvt_warn> with the given string which should include a trailing
 newline. The module also overwrites the C<warn> builtin with a function
 that calls this function.
 Using this function has the advantage that its output ends up in the
 correct place, e.g. on stderr of the connecting urxvtc client.
 =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).
+is no urxvt::term object associated with others).
 =item $time = urxvt::NOW
 Returns the "current time" (as per the event loop).
 =item $rend = urxvt::OVERLAY_RSTYLE
 Return the rendition mask used for overlays by default.
-=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
+=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
+urxvt::RS_RVid, urxvt::RS_Uline
 Return the bit that enabled bold, italic, blink, reverse-video and
 underline, respectively. To enable such a style, just logically OR it into
 the bitset.
 sub invoke {
    local $TERM = shift;
    my $htype = shift;
    if ($htype == 0) { # INIT
-      my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
+      my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
       my %ext_arg;
       {
          my @init = @TERM_INIT;
    while (my ($name, $cb) = each %hook) {
       my $htype = $HOOKTYPE{uc $name};
       defined $htype
          or Carp::croak "unsupported hook type '$name'";
-      $self->set_should_invoke ($htype, +1)
+      $self->modify_should_invoke_count ($htype, +1)
          unless exists $self->{term}{_hook}[$htype]{$pkg};
       $self->{term}{_hook}[$htype]{$pkg} = $cb;
    }
 }
    for my $name (@hook) {
       my $htype = $HOOKTYPE{uc $name};
       defined $htype
          or Carp::croak "unsupported hook type '$name'";
-      $self->set_should_invoke ($htype, -1)
+      $self->modify_should_invoke_count ($htype, -1)
          if delete $self->{term}{_hook}[$htype]{$pkg};
    }
 }
 our $AUTOLOAD;
 sub DESTROY {
    $_[0][1]->stop;
 }
+# only needed for AnyEvent < 6 compatibility
 sub one_event {
    Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
 }
 package urxvt::term;
 C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
 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
+ borderLess buffered console cursorBlink cursorUnderline hold iconic
- intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
+ insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
- override-redirect pastableTabs pointerBlank reverseVideo scrollBar
+ mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
- scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
+ pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
- scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
+ scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
- transparent tripleclickwords utmpInhibit visualBell
+ secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
+ urgentOnBell utmpInhibit visualBell
 =item $value = $term->resource ($name[, $newval])
 Returns the current resource value associated with a given name and
 optionally sets a new value. Setting values is most useful in the C<init>
 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
+  answerbackstring backgroundPixmap backspace_key blendtype blurradius
-  borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
+  boldFont boldItalicFont borderLess buffered chdir color cursorBlink
-  display_name embed ext_bwidth fade font geometry hold iconName
+  cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
-  imFont imLocale inputMethod insecure int_bwidth intensityStyles
+  fade font geometry hold iconName iconfile imFont imLocale inputMethod
-  italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
+  insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
+  jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
-  modifier mouseWheelScrollPage name override_redirect pastableTabs path
+  mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
-  perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
+  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 shade term_name title
+  secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
-  transient_for transparent transparent_all tripleclickwords utmpInhibit
+  term_name title transient_for transparent tripleclickwords urgentOnBell
-  visualBell
+  utmpInhibit visualBell
 =cut
 sub resource($$;$) {
    my ($self, $name) = (shift, shift);
 This method should only be called during the C<on_start> hook, as there is
 only one resource database per display, and later invocations might return
 the wrong resources.
-=item $success = $term->parse_keysym ($keysym_spec, $command_string)
+=item $success = $term->parse_keysym ($key, $octets)
-Adds a keymap translation exactly as specified via a resource. See the
+Adds a key binding exactly as specified via a resource. See the
 C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
+=item $term->register_command ($keysym, $modifiermask, $string)
+Adds a key binding. This is a lower level api compared to
+C<parse_keysym>, as it expects a parsed key description, and can be
+used only inside either the C<on_init> hook, to add a binding, or the
+C<on_register_command> hook, to modify a parsed binding.
 =item $rend = $term->rstyle ([$new_rstyle])
 Return and optionally change the current rendition. Text that is output by
 the terminal application will use this style.
 =item $term->selection_make ($eventtime[, $rectangular])
 Tries to make a selection as set by C<selection_beg> and
 C<selection_end>. If C<$rectangular> is true (default: false), a
-rectangular selection will be made. This is the prefered function to make
+rectangular selection will be made. This is the preferred function to make
 a selection.
-=item $success = $term->selection_grab ($eventtime)
+=item $success = $term->selection_grab ($eventtime[, $clipboard])
-Try to request the primary selection text from the server (for example, as
+Try to acquire ownership of the primary (clipboard if C<$clipboard> is
+true) selection from the server. The corresponding text can be set
-set by the next method). No visual feedback will be given. This function
+with the next method. No visual feedback will be given. This function
 is mostly useful from within C<on_sel_grab> hooks.
-=item $oldtext = $term->selection ([$newtext])
+=item $oldtext = $term->selection ([$newtext, $clipboard])
-Return the current selection text and optionally replace it by C<$newtext>.
+Return the current selection (clipboard if C<$clipboard> is true) text
+and optionally replace it by C<$newtext>.
+=item $term->selection_clear ([$clipboard])
+Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
 =item $term->overlay_simple ($x, $y, $text)
 Create a simple multi-line overlay box. See the next method for details.
 locale-specific encoding of the terminal and can contain command sequences
 (escape codes) that will be interpreted.
 =item $term->tt_write ($octets)
-Write the octets given in C<$data> to the tty (i.e. as program input). To
+Write the octets given in C<$octets> to the tty (i.e. as program input). To
 pass characters instead of octets, you should convert your strings first
 to the locale-specific encoding using C<< $term->locale_encode >>.
+=item $term->tt_paste ($octets)
+Write the octets given in C<$octets> to the tty as a paste, converting NL to
+CR and bracketing the data with control sequences if bracketed paste mode
+is set.
 =item $old_events = $term->pty_ev_events ([$new_events])
 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
 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->set_urgency ($set)
+Enable/disable the urgency hint on the toplevel window.
 =item $term->focus_in
 =item $term->focus_out
 =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])
+=item $keysym = $term->XStringToKeysym ($string)
+=item $string = $term->XKeysymToString ($keysym)
 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
 directly onto the X functions of the same name.
 =back
 =head1 AUTHOR
- Marc Lehmann <pcg@goof.com>
+ Marc Lehmann <schmorp@schmorp.de>
  http://software.schmorp.de/pkg/rxvt-unicode
 =cut
 1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.182 by sf-exg, Wed Feb 17 08:27:56 2010 UTC vs. Revision 1.205 by root, Tue Jun 5 19:32:29 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.182 by sf-exg, Wed Feb 17 08:27:56 2010 UTC vs.
Revision 1.205 by root, Tue Jun 5 19:32:29 2012 UTC