urxvt Packageurxvt Packageurxvt::term Classurxvt::timer Classurxvt::iow Class+
rxvtperl - rxvt-unicode's embedded perl interpreter
* Put your scripts into /opt/rxvt/lib/urxvt/perl-ext/, they will be loaded automatically.
-* Each script will only be loaded once, even in urxvtd, and will be valid -globally.
-* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and -thus must be encoded as UTF-8.
++ # create a file grab_test in $HOME:
sub on_sel_grab {
warn "you selected ", $_[0]->selection;
()
}
- 1+ # start a rxvt using it: +
+ rxvt --perl-lib $HOME -pe grab_test
Everytime a terminal object gets created, scripts specified via the
+perl resource are loaded and associated with it.
Scripts are compiled in a 'use strict' and 'use utf8' environment, and +thus must be encoded as UTF-8.
+Each script will only ever be loaded once, even in rxvtd, where +scripts will be shared (but not enabled) for all terminals.
++
+This section describes the extensiosn delivered with this version. You can +find them in /opt/rxvt/lib/urxvt/perl/.
+You can activate them like this:
++ rxvt -pe <extensionname>+
It also offers the following bindable event:
++ URxvt.keysym.C-M-r: perl:selection:rot13+
+
+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 _ptr or
+_hook) are reserved for internal uses and 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.
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 urxvt::term methods on it, but
+its not a real urxvt::term object. Instead, the real urxvt::term
+object that is shared between all packages is stored in the term
+member.
All of them must return a boolean value. If it is true, then the event counts as being consumed, and the invocation of other hooks is skipped, and the relevant action might not be carried out by the C++ code.
@@ -114,6 +184,18 @@Returning a true value aborts selection grabbing. It will still be hilighted.
+See the selection example extension.
+on_refresh_begin.
perl:string action bound to it (see description of the keysym
+resource in the rxvt(1) manpage).
++
+urxvt Packageurxvt::term object.
+@@ -185,7 +286,7 @@
rxvt_warn witht eh given string which should not include a
+Calls rxvt_warn with the given string which should not include a
newline. The module also overwrites the warn builtin with a function
that calls this function.
+
+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.
+@@ -243,14 +399,14 @@ 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 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 utmpInhibit - visualBell + italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier + mouseWheelScrollPage name pastableTabs path perl_eval perl_ext + 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 + utmpInhibit visualBell
$newtext.
#=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;+
+ my $w = 0;
+ for (map $self->strwidth ($_), @lines) {
+ $w = $_ if $w < $_;
+ }
++ $self->scr_overlay_new ($x, $y, $w, scalar @lines); + $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; +}+
$rstyle defines the initial rendition style
+(default: OVERLAY_RSTYLE).
+If $border is 2 (default), then a decorative border will be put
+around the box.
If either $x or $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.
+The methods currently supported on urxvt::overlay objects are:
$term->ROW_t and $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.
+$x or
-$y is negative, then this is counted from the right/bottom side,
-respectively.
+If hidden, display the overlay again.
+$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 $term->locale_encode.
+-geometry, excluding any scrollback).
+0, which displays the normal terminal contents. Larger values scroll
+this many lines into the scrollback buffer.
+Used after changing terminal contents to display them.
+$row_number. Row 0
+is the topmost terminal line, row $term->$ncol-1 is the bottommost
+terminal line. The scrollback buffer starts at line -1 and extends to
+line -$term->nsaved. Nothing will be returned if a nonexistent line
+is requested.
+If $new_text is specified, it will replace characters in the current
+line, starting at column $start_col (default 0), which is useful
+to replace only parts of a line. The font index in the rendition will
+automatically be updated.
$text is in a special encoding: tabs and wide characters that use more
+than one cell when displayed are padded with urxvt::NOCHAR characters
+(chr 65535). Characters with combining characters and other characters
+that do not fit into the normal tetx encoding will be replaced with
+characters in the private use area.
You have to obey this encoding when changing text. The advantage is
+that substr and similar functions work on screen cells and not on
+characters.
The methods $term->special_encode and $term->special_decode
+can be used to convert normal strings into this encoding and vice versa.
$term->ROW_t, but returns an arrayref with rendition
+bitsets. Rendition bitsets contain information about colour, font, font
+styles and similar information. See also $term->ROW_t.
+When setting rendition, the font mask will be ignored.
+See the section on RENDITION, above.
+$term->ncol if the
+line is joined with the following one.
+urxvt::line object that stores information
+about the logical line that row $row_number is part of. It supports the
+following methods:
+ROW_t
+ROW_r
+ROW_l.
+$term->ROW_t for details.
+$term->ROW_t for details.
@@ -317,22 +698,20 @@
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]);
});
$interval is 0), the timer will automatically
+stop after it has fired once. If $interval is non-zero, then the timer
+is automatically rescheduled at the given intervals.
+