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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.20 by root, Tue Jan 3 04:18:47 2006 UTC vs.
Revision 1.31 by root, Wed Jan 4 19:39:46 2006 UTC

 =over 4
 =item selection
-Miscellaneous selection modifications.
+Intelligent selection. This extension tries to be more intelligent when
+the user extends selections (double-click). Right now, it tries to select
+urls and complete shell-quoted arguments, which is very convenient, too,
+if your F<ls> supports C<--quoting-style=shell>.
+It also offers the following bindable event:
 =over 4
 =item rot13
 =head2 General API Considerations
 All objects (such as terminals, time watchers etc.) are typical
 reference-to-hash objects. The hash can be used to store anything you
 like. All members starting with an underscore (such as C<_ptr> or
-C<_hook>) are reserved for internal uses and must not be accessed or
+C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
 modified).
 When objects are destroyed on the C++ side, the perl object hashes are
 emptied, so its best to store related objects such as time watchers and
 the like inside the terminal object so they get destroyed as soon as the
 terminal is destroyed.
 =head2 Hooks
-The following subroutines can be declared in loaded scripts, and will be called
+The following subroutines can be declared in loaded scripts, and will be
-whenever the relevant event happens.
+called whenever the relevant event happens.
+The first argument passed to them is an object private to each terminal
+and extension package.  You can call all C<urxvt::term> methods on it, but
+its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
+object that is shared between all packages is stored in the C<term>
+member.
 All of them must return a boolean value. If it is true, then the event
 counts as being I<consumed>, and the invocation of other hooks is skipped,
 and the relevant action might not be carried out by the C++ code.
 requested from the server.  The selection text can be queried and changed
 by calling C<< $term->selection >>.
 Returning a true value aborts selection grabbing. It will still be hilighted.
+=item on_sel_extend $term
+Called whenever the user tries to extend the selection (e.g. with a double
+click) and is either supposed to return false (normal operation), or
+should extend the selection itelf and return true to suppress the built-in
+processing.
+See the F<selection> example extension.
 =item on_focus_in $term
 Called whenever the window gets the keyboard focus, before urxvt does
 focus in processing.
 number of lines that will be in the scrollback buffer.
 =item on_tty_activity $term *NYI*
 Called whenever the program(s) running in the urxvt window send output.
+=item on_osc_seq $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
+it from commands for other extensions, and this might be enforced in the
+future.
+Be careful not ever to trust (in a security sense) the data you receive,
+as its source can not easily be controleld (e-mail content, messages from
+other users on the same system etc.).
 =item on_refresh_begin $term
 Called just before the screen gets redrawn. Can be used for overlay
 or similar effects by modify terminal contents in refresh_begin, and
 C<perl:string> action bound to it (see description of the B<keysym>
 resource in the @@RXVT_NAME@@(1) manpage).
 =back
+=head2 Variables in the C<urxvt> Package
+=over 4
+=item $urxvt::TERM
+The current terminal. Whenever a callback/Hook is bein executed, this
+variable stores the current C<urxvt::term> object.
+=back
 =head2 Functions in the C<urxvt> Package
 =over 4
 =item urxvt::fatal $errormessage
 correct place, e.g. on stderr of the connecting urxvtc client.
 =item $time = urxvt::NOW
 Returns the "current time" (as per the event loop).
+=back
 =head2 RENDITION
 Rendition bitsets contain information about colour, font, font styles and
 similar information for each screen cell.
 =cut
 package urxvt;
 use strict;
+use Scalar::Util ();
-our $term;
+our $TERM;
 our @HOOKNAME;
 our $LIBDIR;
 BEGIN {
    urxvt->bootstrap;
       my $name = $HOOKNAME[$htype];
       my $ref = $pkg->can ("on_" . lc $name)
          or next;
-      $term->{_hook}[$htype]{$ref*1} = $ref;
+      $TERM->{_hook}[$htype]{$pkg} = $ref;
       $hook_count[$htype]++
          or set_should_invoke $htype, 1;
    }
 }
       $pkg
    }
 }
+our $retval; # return value for urxvt
 # called by the rxvt core
 sub invoke {
-   local $term = shift;
+   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")), "$LIBDIR/perl");
-      for my $ext (split /:/, $term->resource ("perl_ext")) {
+      for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
          my @files = grep -f $_, map "$_/$ext", @dirs;
          if (@files) {
             register_package script_package $files[0];
          } else {
             warn "perl extension '$ext' not found in perl library search path\n";
          }
       }
+   }
+   $retval = undef;
+   if (my $cb = $TERM->{_hook}[$htype]) {
+      verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
+         if $verbosity >= 10;
+      keys %$cb;
+      while (my ($pkg, $cb) = each %$cb) {
+         $retval = $cb->(
+            $TERM->{_pkg}{$pkg} ||= do {
+               my $proxy = bless { }, urxvt::term::proxy::;
+               Scalar::Util::weaken ($proxy->{term} = $TERM);
+               $proxy
+            },
+            @_,
+         ) and last;
+      }
+   }
-   } elsif ($htype == 1) { # DESTROY
+   if ($htype == 1) { # DESTROY
+      # remove hooks if unused
-      if (my $hook = $term->{_hook}) {
+      if (my $hook = $TERM->{_hook}) {
          for my $htype (0..$#$hook) {
             $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
                or set_should_invoke $htype, 0;
          }
       }
+      # clear package objects
+      %$_ = () for values %{ $TERM->{_pkg} };
+      # clear package
+      %$TERM = ();
    }
-   my $cb = $term->{_hook}[$htype]
+   $retval
-      or return;
-   verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
-      if $verbosity >= 10;
-   while (my ($k, $v) = each %$cb) {
-      return 1 if $v->($term, @_);
-   }
-   0
 }
-=back
+sub urxvt::term::proxy::AUTOLOAD {
+   $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
+      or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
+   eval qq{
+      sub $urxvt::term::proxy::AUTOLOAD {
+         my \$proxy = shift;
+         \$proxy->{term}->$1 (\@_)
+      }
+      1
+   } or die "FATAL: unable to compile method forwarder: $@";
+   goto &$urxvt::term::proxy::AUTOLOAD;
+}
 =head2 The C<urxvt::term> Class
 =over 4
   answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
   borderLess 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 menu meta8 modifier
-  mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
+  mouseWheelScrollPage name 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 transparent transparent_all tripleclickwords
 right/bottom side, respectively.
 This method returns an urxvt::overlay object. The overlay will be visible
 as long as the perl object is referenced.
-Currently, the only method on the C<urxvt::overlay> object is C<set>:
+The methods currently supported on C<urxvt::overlay> objects are:
+=over 4
 =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.
+=item $overlay->hide
+If visible, hide the overlay, but do not destroy it.
+=item $overlay->show
+If hidden, display the overlay again.
+=back
 =item $cellwidth = $term->strwidth $string
 Returns the number of screen-cells this string would need. Correctly
 accounts for wide and combining characters.
 =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>
 is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
 terminal line. The scrollback buffer starts at line C<-1> and extends to
-line C<< -$term->nsaved >>.
+line C<< -$term->nsaved >>. 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.
 See the section on RENDITION, above.
 =item $length = $term->ROW_l ($row_number[, $new_length])
-Returns the number of screen cells that are in use ("the line length"). If
+Returns the number of screen cells that are in use ("the line
-it is C<-1>, then the line is part of a multiple-row logical "line", which
+length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
-means all characters are in use and it is continued on the next row.
+line is joined with the following one.
+=item $bool = $term->is_longer ($row_number)
+Returns true if the row is part of a multiple-row logical "line" (i.e.
+joined with the following row), which means all characters are in use
+and it is continued on the next row (and possibly a continuation of the
+previous row(s)).
+=item $line = $term->line ($row_number)
+Create and return a new C<urxvt::line> object that stores information
+about the logical line that row C<$row_number> is part of. It supports the
+following methods:
+=over 4
+=item $text = $line->t
+Returns the full text of the line, similar to C<ROW_t>
+=item $rend = $line->r
+Returns the full rendition array of the line, similar to C<ROW_r>
+=item $length = $line->l
+Returns the length of the line in cells, similar to C<ROW_l>.
+=item $rownum = $line->beg
+=item $rownum = $line->end
+Return the row number of the first/last row of the line, respectively.
+=item $offset = $line->offset_of ($row, $col)
+Returns the character offset of the given row|col pair within the logical
+line.
+=item ($row, $col) = $line->coord_of ($offset)
+Translates a string offset into terminal coordinates again.
+=back
+=cut
+sub urxvt::term::line {
+   my ($self, $row) = @_;
+   my $maxrow = $self->nrow - 1;
+   my ($beg, $end) = ($row, $row);
+   --$beg while $self->ROW_is_longer ($beg - 1);
+   ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
+   bless {
+      term => $self,
+      beg  => $beg,
+      end  => $end,
+      len  => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
+   }, urxvt::line::
+}
+sub urxvt::line::t {
+   my ($self) = @_;
+   substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
+          0, $self->{len}
+}
+sub urxvt::line::r {
+   my ($self) = @_;
+   my $rend = [
+      map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
+   ];
+   $#$rend = $self->{len} - 1;
+   $rend
+}
+sub urxvt::line::beg { $_[0]{beg} }
+sub urxvt::line::end { $_[0]{end} }
+sub urxvt::line::l   { $_[0]{len} }
+sub urxvt::line::offset_of {
+   my ($self, $row, $col) = @_;
+   ($row - $self->{beg}) * $self->{term}->ncol + $col
+}
+sub urxvt::line::coord_of {
+   my ($self, $offset) = @_;
+   use integer;
+   (
+      $offset / $self->{term}->ncol + $self->{beg},
+      $offset % $self->{term}->ncol
+   )
+}
+=item ($row, $col) = $line->coord_of ($offset)
 =item $text = $term->special_encode $string
 Converts a perl string into the special encoding used by rxvt-unicode,
 where one character corresponds to one screen cell. See
 C<< $term->ROW_t >> for details.
 This variable controls the verbosity level of the perl extension. Higher
 numbers indicate more verbose output.
 =over 4
-=item 0 - only fatal messages
+=item =0 - only fatal messages
-=item 3 - script loading and management
+=item =3 - script loading and management
-=item 10 - all events received
+=item =10 - all events received
 =back
 =head1 AUTHOR

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.20 by root, Tue Jan 3 04:18:47 2006 UTC vs. Revision 1.31 by root, Wed Jan 4 19:39:46 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.20 by root, Tue Jan 3 04:18:47 2006 UTC vs.
Revision 1.31 by root, Wed Jan 4 19:39:46 2006 UTC