urxvt Packageurxvt Packageurxvt::term Classurxvt::anyevent Classurxvt::term Classurxvt::popup Classurxvt::timer Classurxvt::iow Class+
rxvtperl - rxvt-unicode's embedded perl interpreter
@@ -61,26 +65,31 @@
Everytime a terminal object gets created, scripts specified via the
-perl resource are loaded and associated with it.
Everytime a terminal object gets created, extension 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.
+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>
--quoting-style=shell.
+It also offers the following bindable event:
on_line_update) to underline urls.
@@ -113,17 +143,48 @@
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
+_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.
+Argument names also often indicate the type of a parameter. Here are some +hints on what they mean:
+
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 extension files, 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. It is, however, blessed intot he package of the extension script,
+so for all practical purposes you can treat an extension script as a class.
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.
@@ -133,7 +194,10 @@Returning a true value aborts selection grabbing. It will still be hilighted.
-See the selection example extension.
program(s) running in the urxvt window send output.
+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.).
+$term->scr_add_lines yourself. Please note that this
+might be very slow, however, as your hook is called for all text being
+output.
+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.
+perl:string action bound to it (see description of the keysym
resource in the rxvt(1) manpage).
The event is a hash with most values as named by Xlib (see the XEvent
+manpage), with the additional members row and col, which are the row
+and column under the mouse cursor.
on_key_press additionally receives the string rxvt-unicode would
+output, if any, in locale-specific encoding.
subwindow.
++
+urxvt Packageurxvt::term
+object, whenever a callback/hook is executing.
+
urxvt Packagesystem $binfile, arg.... Croaks (and probably outputs an error message)
+if the new instance couldn't be created. Returns undef if the new
+instance didn't initialise perl, and the terminal object otherwise. The
+init and start hooks will be called during the call.
++
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.
++
+urxvt::anyevent ClassThe sole purpose of this class is to deliver an interface to the
+AnyEvent module - any module using it will work inside urxvt without
+further work. The only exception is that you cannot wait on condition
+variables, but non-blocking condvar use is ok. What this means is that you
+cannot use blocking APIs, but the non-blocking variant should work.
+
urxvt::term Class$optval is enabled, and
+optionally change it. All option values are stored by name in the hash
+%urxvt::OPTION. Options not enabled in this binary are not in the hash.
+Here is a a likely non-exhaustive list of option names, please see the +source file /src/optinc.h to see the actual list:
++ borderLess console cursorBlink cursorUnderline hold iconic insecure + intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage + pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating + scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer + secondaryScreen secondaryScroll skipBuiltinGlyphs transparent + tripleclickwords utmpInhibit visualBell+
Here is a a likely non-exhaustive list of resource names, not all of which -are supported in every build, please see the source to see the actual -list:
+are supported in every build, please see the source file /src/rsinc.h +to see the actual list:@@ -305,7 +584,7 @@ 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 @@ -314,6 +593,20 @@ 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 { +# 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; +#}
$x or
-$y is negative, then this is counted from the right/bottom side,
-respectively.
+width/height. $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.
urxvt::popup object that implements a popup menu. The
+$event must be the event causing the menu to pop up (a button event,
+currently).
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
+on_add_lines hook, though.
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.
+$term->locale_encode.
-geometry, excluding any scrollback).
+Return the window id of the terminal window.
$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.
+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 iindex in the rendition will
+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
+
$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
@@ -460,7 +850,7 @@
characters.
The methods $term->special_encode and $term->special_decode
+
The methods $term->special_encode and $term->special_decode
can be used to convert normal strings into this encoding and vice versa.
When setting rendition, the font mask will be ignored.
See the section on RENDITION, below.
+See the section on RENDITION, above.
-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 $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.
+-
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.
-urxvt::popup Class
urxvt::timer ClassThis 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.
+This variable controls the verbosity level of the perl extension. Higher numbers indicate more verbose output.
- +