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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.146 by root, Thu Aug 17 21:56:11 2006 UTC vs.
Revision 1.174 by root, Sat May 30 08:47:07 2009 UTC

 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/>.
   @@RXVT_NAME@@ -pe <extensionname>
 Or by adding them to the resource for extensions loaded by default:
-  URxvt.perl-ext-common: default,automove-background,selection-autotransform
+  URxvt.perl-ext-common: default,selection-autotransform
 =over 4
 =item selection (enabled by default)
 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
+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}>:
+C<< $self->{myoption} >>:
    push @{ $self->{term}{option_popup_hook} }, sub {
       ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
    };
 Other extensions can extend this popup menu by pushing a code reference
 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 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 @{ $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.
 =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 (the this only works
+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
    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
+=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.
+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.
+Simply bind a keysym to "perl:matcher" as seen in the example below.
+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 leats for SCIM and
+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.:
 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 thats not using any desktop
+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 automove-background
+=item overlay-osc
-This is basically a very small extension that dynamically changes the
+This extension implements some OSC commands to display timed popups on the
-background pixmap offset to the window position, in effect creating the
+screen - useful for status displays from within scripts. You have to read
-same effect as pseudo transparency with a custom pixmap. No scaling is
+the sources for more info.
-supported in this mode. Example:
-   @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
 =item block-graphics-to-ascii
 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
 Displays a digital clock using the built-in overlay.
 =item remote-clipboard
 Somewhat of a misnomer, this extension adds two menu entries to the
-selection popup that allows one ti run external commands to store the
+selection popup that allows one to run external commands to store the
 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.
 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 macosx-pastebin and macosx-pastebin-native
+These two modules implement an extended clipboard for Mac OS X. They are
+used like this:
+   URxvt.perl-ext-common: default,macosx-clipboard
+   URxvt.keysym.M-c: perl:macosx-clipboard:copy
+   URxvt.keysym.M-v: perl:macosx-clipboard:paste
+The difference between them is that the native variant requires a
+perl from apple's devkit or so, and C<maxosx-pastebin> requires the
+C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
+simpler etc. etc.
 =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
 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
+=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
+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
+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, $string
+=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 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
    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 = ();
 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;
 sub enable {
 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
 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.
 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 C<$urxvt::NOCHAR> (chr 65535)
 characters. Characters with combining characters and other characters that
-do not fit into the normal tetx encoding will be replaced with characters
+do not fit into the normal text 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<substr> and similar functions work on screen cells and not on
 characters.
 =item @atoms = $term->XListProperties ($window)
 =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
-=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
+=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
 =item $term->XDeleteProperty ($window, $property)
 =item $window = $term->DefaultRootWindow
    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) = @_;
 =back
 =cut
 package urxvt::watcher;
-@urxvt::timer::ISA = __PACKAGE__;
-@urxvt::iow::ISA   = __PACKAGE__;
-@urxvt::pw::ISA    = __PACKAGE__;
-@urxvt::iw::ISA    = __PACKAGE__;
 =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 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.
                     ->new
                     ->start ($pid)
                     ->cb (sub {
                        my ($pw, $exit_status) = @_;
                        ...
                     });
 =over 4
 =item $pw = new urxvt::pw
  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.146 by root, Thu Aug 17 21:56:11 2006 UTC vs. Revision 1.174 by root, Sat May 30 08:47:07 2009 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.146 by root, Thu Aug 17 21:56:11 2006 UTC vs.
Revision 1.174 by root, Sat May 30 08:47:07 2009 UTC