--- rxvt-unicode/src/urxvt.pm 2006/01/03 01:45:03 1.17 +++ rxvt-unicode/src/urxvt.pm 2006/01/03 19:42:53 1.23 @@ -41,7 +41,10 @@ =item selection -Miscellaneous selection modifications. +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 @@ -55,14 +58,14 @@ =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. -=item simple-overlay-clock - -Displays a digital clock using the built-in overlay (colorful, useless). - =back =head2 General API Considerations @@ -70,7 +73,7 @@ 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 @@ -80,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, @@ -124,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 @@ -173,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 @@ -196,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; @@ -237,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; } @@ -271,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) { @@ -288,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; @@ -296,20 +380,41 @@ } } - 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, @_); + 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 { + unshift \@_, shift->{term}; + goto &urxvt::term::$1; + } + 1 + } or die "FATAL: unable to compile method forwarder: $@"; + + goto &$urxvt::term::proxy::AUTOLOAD; +} =head2 The C Class @@ -375,13 +480,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; @@ -395,25 +501,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. -=item $term->scr_overlay_off +If either C<$x> or C<$y> is negative, then this is counted from the +right/bottom side, respectively. -Switch the overlay off again. +This method returns an urxvt::overlay object. The overlay will be visible +as long as the perl object is referenced. + +The methods currently supported on C objects are: + +=over 4 -=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) +=item $overlay->set ($x, $y, $text, $rend) -Put a single character (specified numerically) at the given overlay -position. +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 ($x, $y, $text) +=item $overlay->hide -Write a string at the given position into the overlay. +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 @@ -468,7 +589,7 @@ 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 @@ -492,7 +613,7 @@ 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]) @@ -513,49 +634,26 @@ =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 - -=back - -=cut - =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) = @_; ... }) @@ -569,6 +667,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.