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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.161 by ayin, Fri Nov 30 01:22:26 2007 UTC vs.
Revision 1.179 by root, Sat Dec 26 09:23:53 2009 UTC

 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] })
    };
 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 overlay-osc
+This extension implements some OSC commands to display timed popups on the
+screen - useful for status displays from within scripts. You have to read
+the sources for more info.
 =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
 similar-looking ascii character.
 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
 is that you cannot use blocking APIs, but the non-blocking variant should
 work.
 =cut
-our $VERSION = 1;
+our $VERSION = '5.23';
 $INC{"urxvt/anyevent.pm"} = 1; # mark us as there
 push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
 sub timer {
    my $cb = $arg{cb};
    urxvt::timer
       ->new
-      ->start (urxvt::NOW + $arg{after})
+      ->after ($arg{after}, $arg{interval})
-      ->cb (sub {
+      ->cb ($arg{interval} ? $cb : sub {
         $_[0]->stop; # need to cancel manually
         $cb->();
       })
 }
 sub io {
    my ($class, %arg) = @_;
    my $cb = $arg{cb};
+   my $fd = fileno $arg{fh};
+   defined $fd or $fd = $arg{fh};
    bless [$arg{fh}, urxvt::iow
              ->new
-             ->fd (fileno $arg{fh})
+             ->fd ($fd)
              ->events (($arg{poll} =~ /r/ ? 1 : 0)
                      | ($arg{poll} =~ /w/ ? 2 : 0))
              ->start
-             ->cb (sub {
+             ->cb ($cb)
-                $cb->(($_[1] & 1 ? 'r' : '')
-                    . ($_[1] & 2 ? 'w' : ''));
-             })],
-         urxvt::anyevent::
+         ], urxvt::anyevent::
+}
+sub idle {
+   my ($class, %arg) = @_;
+   my $cb = $arg{cb};
+   urxvt::iw
+      ->new
+      ->start
+      ->cb ($cb)
+}
+sub child {
+   my ($class, %arg) = @_;
+   my $cb = $arg{cb};
+   urxvt::pw
+      ->new
+      ->start ($arg{pid})
+      ->cb (sub {
+        $_[0]->stop; # need to cancel manually
+        $cb->($_[0]->rpid, $_[0]->rstatus);
+      })
 }
 sub DESTROY {
    $_[0][1]->stop;
-}
-sub condvar {
-   bless \my $flag, urxvt::anyevent::
-}
-sub broadcast {
-   ${$_[0]}++;
-}
-sub wait {
-   unless (${$_[0]}) {
-      Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
-   }
 }
 sub one_event {
    Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
 }
 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
+  italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
-  mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
+  modifier mouseWheelScrollPage name override_redirect pastableTabs path
-  perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
+  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) = @_;
 =item $timer = $timer->cb (sub { my ($timer) = @_; ... })
 Set the callback to be called when the timer triggers.
-=item $tstamp = $timer->at
-Return the time this watcher will fire next.
-=item $timer = $timer->set ($tstamp)
+=item $timer = $timer->set ($tstamp[, $interval])
-Set the time the event is generated to $tstamp.
+Set the time the event is generated to $tstamp (and optionally specifies a
+new $interval).
 =item $timer = $timer->interval ($interval)
-Normally (and when C<$interval> is C<0>), the timer will automatically
+By default (and when C<$interval> is C<0>), the timer will automatically
 stop after it has fired once. If C<$interval> is non-zero, then the timer
 is automatically rescheduled at the given intervals.
 =item $timer = $timer->start
 Start the timer.
-=item $timer = $timer->start ($tstamp)
+=item $timer = $timer->start ($tstamp[, $interval])
-Set the event trigger time to C<$tstamp> and start the timer.
+Set the event trigger time to C<$tstamp> and start the timer. Optionally
+also replaces the interval.
-=item $timer = $timer->after ($delay)
+=item $timer = $timer->after ($delay[, $interval])
 Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
 =item $timer = $timer->stop

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.161 by ayin, Fri Nov 30 01:22:26 2007 UTC vs. Revision 1.179 by root, Sat Dec 26 09:23:53 2009 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.161 by ayin, Fri Nov 30 01:22:26 2007 UTC vs.
Revision 1.179 by root, Sat Dec 26 09:23:53 2009 UTC