--- rxvt-unicode/src/urxvt.pm 2006/01/03 01:15:00 1.14 +++ rxvt-unicode/src/urxvt.pm 2006/01/03 21:08:39 1.25 @@ -1,3 +1,5 @@ +=encoding utf8 + =head1 NAME @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter @@ -24,14 +26,54 @@ 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. +scripts will be shared (but not enabled) for all terminals. + +=head2 Prepackaged Extensions + +This section describes the extensiosn delivered with this version. You can +find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. + +You can activate them like this: + + @@RXVT_NAME@@ -pe + +=over 4 + +=item selection + +Intelligent selection. This etxension tries to be more intelligent when the user +extends selections (double-click). + +It also offers the following bindable event: + +=over 4 + +=item rot13 + +Rot-13 the selection when activated. Used via keyboard trigger: + + URxvt.keysym.C-M-r: perl:selection:rot13 + +=back + +=item digital-clock + +Displays a digital clock using the built-in overlay. + +=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. + +=back =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 be accessed or modified). When objects are destroyed on the C++ side, the perl object hashes are @@ -41,8 +83,14 @@ =head2 Hooks -The following subroutines can be declared in loaded scripts, and will be called -whenever the relevant event happens. +The following subroutines can be declared in loaded scripts, and will be +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 methods on it, but +its not a real C object. Instead, the real C +object that is shared between all packages is stored in the C +member. All of them must return a boolean value. If it is true, then the event counts as being I, and the invocation of other hooks is skipped, @@ -85,6 +133,15 @@ 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 example extension. + =item on_focus_in $term Called whenever the window gets the keyboard focus, before urxvt does @@ -134,6 +191,17 @@ =back +=head2 Variables in the C Package + +=over 4 + +=item $urxvt::TERM + +The current terminal. Whenever a callback/Hook is bein executed, this +variable stores the current C object. + +=back + =head2 Functions in the C Package =over 4 @@ -157,13 +225,68 @@ 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. + +The following "macros" deal with changes in rendition sets. You should +never just create a bitset, you should always modify an existing one, +as they contain important information required for correct operation of +rxvt-unicode. + +=over 4 + +=item $rend = urxvt::DEFAULT_RSTYLE + +Returns the default rendition, as used when the terminal is starting up or +being reset. Useful as a base to start when creating renditions. + +=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 + +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. + +=item $foreground = urxvt::GET_BASEFG $rend + +=item $background = urxvt::GET_BASEBG $rend + +Return the foreground/background colour index, respectively. + +=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) + +=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) + +Replace the foreground/background colour in the rendition mask with the +specified one. + +=item $value = urxvt::GET_CUSTOM ($rend) + +Return the "custom" value: Every rendition has 5 bits for use by +extensions. They can be set and changed as you like and are initially +zero. + +=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) + +Change the custom value. + +=back + =cut package urxvt; use strict; +use Scalar::Util (); -our $term; +our $TERM; our @HOOKNAME; our $LIBDIR; @@ -198,7 +321,7 @@ 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; } @@ -232,13 +355,13 @@ # 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 (split /:/, $TERM->resource ("perl_ext")) { my @files = grep -f $_, map "$_/$ext", @dirs; if (@files) { @@ -249,7 +372,7 @@ } } elsif ($htype == 1) { # DESTROY - 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; @@ -257,20 +380,43 @@ } } - my $cb = $term->{_hook}[$htype] + my $cb = $TERM->{_hook}[$htype] or return; - verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")" + verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" if $verbosity >= 10; - while (my ($k, $v) = each %$cb) { - return 1 if $v->($term, @_); + keys %$cb; + + while (my ($pkg, $cb) = each %$cb) { + return 1 + if $cb->( + $TERM->{$pkg} ||= do { + my $proxy = bless { }, urxvt::term::proxy::; + Scalar::Util::weaken ($proxy->{term} = $TERM); + $proxy + }, + @_, + ); } 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 Class @@ -336,13 +482,14 @@ Return the current selection text and optionally replace it by C<$newtext>. -=item $term->scr_overlay ($x, $y, $text) - -Create a simple multi-line overlay box. See the next method for details. - -=cut +#=item $term->overlay ($x, $y, $text) +# +#Create a simple multi-line overlay box. See the next method for details. +# +#=cut sub urxvt::term::scr_overlay { +die; my ($self, $x, $y, $text) = @_; my @lines = split /\n/, $text; @@ -356,25 +503,40 @@ $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; } -=item $term->scr_overlay_new ($x, $y, $width, $height) +=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) Create a new (empty) overlay at the given position with the given -width/height. A border will be put around the box. If either C<$x> or -C<$y> is negative, then this is counted from the right/bottom side, -respectively. +width/height. C<$rstyle> defines the initial rendition style +(default: C). + +If C<$border> is C<2> (default), then a decorative border will be put +around the box. + +If either C<$x> or C<$y> is negative, then this is counted from the +right/bottom side, respectively. + +This method returns an urxvt::overlay object. The overlay will be visible +as long as the perl object is referenced. -=item $term->scr_overlay_off +The methods currently supported on C objects are: -Switch the overlay off again. +=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 $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) +=item $overlay->hide -Put a single character (specified numerically) at the given overlay -position. +If visible, hide the overlay, but do not destroy it. -=item $term->scr_overlay_set ($x, $y, $text) +=item $overlay->show -Write a string at the given position into the overlay. +If hidden, display the overlay again. + +=back =item $cellwidth = $term->strwidth $string @@ -425,11 +587,12 @@ 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 iindex in the rendition will +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 @@ -453,70 +616,150 @@ When setting rendition, the font mask will be ignored. -See the section on RENDITION, below. +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 -it is C<-1>, then the line is part of a multiple-row logical "line", which -means all characters are in use and it is continued on the next row. +Returns the number of screen cells that are in use ("the line +length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the +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 object that stores information +about the logical line that row C<$row_number> is part of. It supports the +following methods: -=item $text = $term->special_encode $string +=over 4 -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. +=item $text = $line->t -=item $string = $term->special_decode $text +Returns the full text of the line, similar to C -Converts rxvt-unicodes text reprsentation into a perl string. See -C<< $term->ROW_t >> for details. +=item $rend = $line->r -=back +Returns the full rendition array of the line, similar to C -=head2 RENDITION +=item $length = $line->l -Rendition bitsets contain information about colour, font, font styles and -similar information for each screen cell. +Returns the length of the line in cells, similar to C. -The following "macros" deal with changes in rendition sets. You should -never just create a bitset, you should always modify an existing one, -as they contain important information required for correct operation of -rxvt-unicode. +=item $rownum = $line->beg -=over 4 +=item $rownum = $line->end -=item $rend = urxvt::DEFAULT_RSTYLE +Return the row number of the first/last row of the line, respectively. -Returns the default rendition, as used when the terminal is starting up or -being reset. Useful as a base +=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. + +=item $string = $term->special_decode $text + +Converts rxvt-unicodes text reprsentation into a perl string. See +C<< $term->ROW_t >> for details. + +=back + =head2 The C Class This class implements timer watchers/events. Time is represented as a fractional number of seconds since the epoch. Example: - # create a digital clock display in upper right corner + $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); $term->{timer} = urxvt::timer ->new - ->start (urxvt::NOW) + ->interval (1) ->cb (sub { - my ($timer) = @_; - my $time = $timer->at; - $timer->start ($time + 1); - $self->scr_overlay (-1, 0, - POSIX::strftime "%H:%M:%S", localtime $time); - }); + $term->{overlay}->set (0, 0, + sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); + }); =over 4 =item $timer = new urxvt::timer -Create a new timer object in stopped state. +Create a new timer object in started state. It is scheduled to fire +immediately. =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) @@ -530,6 +773,12 @@ Set the time the event is generated to $tstamp. +=item $timer = $timer->interval ($interval) + +Normally (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.