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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.33 by root, Thu Jan 5 01:04:10 2006 UTC vs.
Revision 1.38 by root, Fri Jan 6 03:43:12 2006 UTC

 =item digital-clock
 Displays a digital clock using the built-in overlay.
+=item mark-urls
+Uses per-line filtering (C<on_line_update>) to underline urls.
 =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 mark-urls
+=item example-filter-input
 A not very useful example of filtering all text output to the terminal, by
 underlining all urls that matches a certain regex (i.e. some urls :). It
 is not very useful because urls that are output in multiple steps (e.g.
 when typing them) do not get marked.
 =over 4
 =item on_init $term
 Called after a new terminal object has been initialized, but before
-windows are created or the command gets run.
+windows are created or the command gets run. Most methods are unsafe to
+call or deliver senseless data, as terminal size and other characteristics
+have not yet been determined. You can safely query and change resources,
+though.
 =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
 can filter/change and output the text yourself by returning a true value
 and calling C<< $term->scr_add_lines >> yourself. Please note that this
 might be very slow, however, as your hook is called for B<all> text being
 output.
+=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,
+not always immediately.
+The row number is always the topmost row of the line if the line spans
+multiple rows.
+Please note that, if you change the line, then the hook might get called
+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
 or similar effects by modify terminal contents in refresh_begin, and
 restoring them in refresh_end. The built-in overlay and selection display
 Called whenever the user presses a key combination that has a
 C<perl:string> action bound to it (see description of the B<keysym>
 resource in the @@RXVT_NAME@@(1) manpage).
+=item on_key_press $term, $event, $octets
+=item on_key_release $term, $event
+=item on_button_press $term, $event
+=item on_button_release $term, $event
+=item on_motion_notify $term, $event
+Called whenever the corresponding X event is received for the terminal
+(see the XEvent manpage) If the hook returns true, then the even will be
+ignored by rxvt-unicode.
+C<on_key_press> additionally receives the string rxvt-unicode would
+output, if any, in locale-specific encoding.
+subwindow.
 =back
 =head2 Variables in the C<urxvt> Package
 =over 4
 =back
 =head2 Functions in the C<urxvt> Package
 =over 4
+=item $term = new urxvt [arg...]
+Creates a new terminal, very similar as if you had started it with
+C<system $binfile, arg...>. 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 the call.
 =item urxvt::fatal $errormessage
 Fatally aborts execution with the given error message. Avoid at all
 costs! The only time this is acceptable is when the terminal process
 }
 =head2 The C<urxvt::term> Class
 =over 4
+=item $term->destroy
+Destroy the terminal object (close the window, free resources etc.).
 =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>
 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->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.
 =item $term->tt_write ($octets)
 Write the octets given in C<$data> 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 >>.
 about the logical line that row C<$row_number> is part of. It supports the
 following methods:
 =over 4
-=item $text = $line->t
+=item $text = $line->t ([$new_text])
-Returns the full text of the line, similar to C<ROW_t>
+Returns or replaces the full text of the line, similar to C<ROW_t>
-=item $rend = $line->r
+=item $rend = $line->r ([$new_rend])
-Returns the full rendition array of the line, similar to C<ROW_r>
+Returns or replaces 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>.
    bless {
       term => $self,
       beg  => $beg,
       end  => $end,
+      ncol => $self->ncol,
       len  => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
    }, urxvt::line::
 }
 sub urxvt::line::t {
    my ($self) = @_;
+   if (@_ > 1)
+     {
+       $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
+          for $self->{beg} .. $self->{end};
+     }
+   defined wantarray &&
-   substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
+      substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
-          0, $self->{len}
+             0, $self->{len}
 }
 sub urxvt::line::r {
    my ($self) = @_;
+   if (@_ > 1)
+     {
+       $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
+          for $self->{beg} .. $self->{end};
+     }
+   if (defined wantarray) {
-   my $rend = [
+      my $rend = [
-      map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
+         map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
-   ];
+      ];
-   $#$rend = $self->{len} - 1;
+      $#$rend = $self->{len} - 1;
-   $rend
+      return $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
+   ($row - $self->{beg}) * $self->{ncol} + $col
 }
 sub urxvt::line::coord_of {
    my ($self, $offset) = @_;
    use integer;
    (
-      $offset / $self->{term}->ncol + $self->{beg},
+      $offset / $self->{ncol} + $self->{beg},
-      $offset % $self->{term}->ncol
+      $offset % $self->{ncol}
    )
 }
 =item ($row, $col) = $line->coord_of ($offset)
 =item $text = $term->special_encode $string

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.33 by root, Thu Jan 5 01:04:10 2006 UTC vs. Revision 1.38 by root, Fri Jan 6 03:43:12 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.33 by root, Thu Jan 5 01:04:10 2006 UTC vs.
Revision 1.38 by root, Fri Jan 6 03:43:12 2006 UTC